将swagger json文件转换为sphinx中的表
sphinxcontrib-swaggersphinx的Python项目详细描述
一个sphinx扩展,用于记录夸张的api。
pip install sphinxcontrib-swaggersphinx
要求
- python>;=3.3
安装
此软件包可以使用pip安装:
pip install sphinxcontrib-swaggersphinx
用法
在狮身人面像中包含此扩展名conf.py:
extensions=['sphinxcontrib.swaggersphinx']
然后,您可以在.rst文件中使用它来包含夸张的文档:
..swaggersphinx:: /path/to/swagger.json
您可以包括本地文件(相对于.rst)、本地文件(完整路径)或URL:
..swaggersphinx:: /full/path/swagger.json ..swaggersphinx:: relative/swagger.json ..swaggersphinx:: http://localhost/api/swagger.json