【问题标题】:Can Django REST Swagger be used to generate static HTML documentation? [closed]Django REST Swagger 可以用来生成静态 HTML 文档吗? [关闭]
【发布时间】:2016-11-26 11:14:36
【问题描述】:

我正在开发一个新的 Django REST 框架项目,并且我正在使用 Django REST Swagger 来提供开箱即用的精美文档。但是,我想共享此文档,而不必启动登台机器或类似的东西。我只想生成类似 sphinx 的静态文档,而不需要花哨的客户端功能。我不需要能够实际访问 API 端点。我只想对存在哪些端点、它们接受/返回什么等进行用户友好的描述。

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

【问题讨论】:

  • 万一,你找到什么了吗?
  • @LB40 不幸的是我什么也没找到。我感觉社区有点想推动这种更复杂的文档类型,并且没有太多意愿来实施我所描述的内容。但这只是我的印象。我不再从事这个项目,所以我不太清楚目前的情况。

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


【解决方案1】:

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

这里是一个使用 swagger-ui 的文档示例:http://petstore.swagger.io/

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2017-05-14
    • 2021-08-12
    • 1970-01-01
    相关资源
    最近更新 更多