跳转到主要内容

OpenAPI(原名Swagger)Sphinx规范渲染器

项目描述

sphinxcontrib-openapi 是一个用于从 Sphinx 生成API文档的 OpenAPI(原名Swagger)规范扩展。它依赖于 sphinxcontrib-httpdomain,该扩展提供了一个HTTP域用于描述RESTful HTTP API,因此我们不需要重新发明轮子。

$ python3 -m pip install sphinxcontrib-openapi

使用

sphinxcontrib-openapi 添加到Sphinx的 conf.py 中的 extensions 列表

extensions = [
   ...
   'sphinxcontrib.openapi',
]

并自由使用 openapi 指令来渲染OpenAPI规范

.. openapi:: path/to/openapi.yml

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码发行版

sphinxcontrib-openapi-0.8.4.tar.gz (71.8 kB 查看哈希值)

上传时间 源代码

构建发行版

sphinxcontrib_openapi-0.8.4-py3-none-any.whl (34.5 kB 查看哈希值)

上传时间 Python 3

由以下组织支持