Django REST Swagger可用于生成静态HTML文档吗?

时间:2016-07-22 13:57:34

标签: django documentation django-rest-framework swagger python-sphinx

我正在开发一个新的Django REST Framework项目,我正在使用Django REST Swagger提供开箱即用的漂亮文档。但是,我想分享这个文档而无需启动升级机或类似的东西。我只想生成类似静态sphinx的文档,而不需要花哨的客户端功能。我不需要能够实际访问API端点。我只想要一个用户友好的描述存在什么端点,他们接受/返回什么等。

这是否可以使用Django REST Swagger?如果没有,是否有任何工具可以做到这一点?或者我只需要手动编写sphinx文档吗?

1 个答案:

答案 0 :(得分:-1)

Django REST Swagger允许您使用swagger-ui生成文档。您可以按example作为起点。

以下是使用swagger-ui的文档示例:http://petstore.swagger.io/