从swagger到sphinx http域的转换器。
sphinxcontrib-swagger2sphinx的Python项目详细描述
Swagger是一个用json或yaml编写restapi文档的开放规范。 尽管它不完美,但事实上它是许多api开发人员的标准。
此扩展允许您将swagger.json文件呈现为sphinx文档。 它对paths使用HTTP domain指令,对definitions使用词汇表。
警告
此扩展是为特定项目创建的,因此仅 保证与这个特殊的项目合作!很有可能 您必须为项目修改swagger-api.rst。
用法
安装延长件:
$ pip install sphinxcontrib-swagger2sphinx
将swagger-api.rst的内容复制到所需的文件中 你的大摇大摆的文件呈现。
将扩展名添加到您的conf.py:
extensions = [ 'sphinxcontrib.swagger2sphinx', ... ]
在conf.py中指定您的swagger文件的路径。可能是本地的 路径或URL:
swagger2sphinx_swagger_location="swagger.json"# swagger2sphinx_swagger_location = "http://example.com/swagger.json"
推荐信
感谢eric holscher写了关于扩展的an excellent blog post 狮身人面像和金贾2模板。