使用 Swagger 呈现 OpenAPI 规范的 Sphinx 插件
项目描述
狮身人面像的 Swagger 插件
这是一个方便的插件，可以将Swagger和Sphinx结合在一起。
它能够使用托管 OpenAPI 规范的自定义配置生成一个或多个招摇的 HTML 页面。
安装
赶紧跑pip install swagger-plugin-for-sphinx
用法
首先，将插件添加到扩展列表：
extensions = ["swagger_plugin_for_sphinx.plugin"]
然后添加swagger的主要配置：
swagger_present_uri = ""
swagger_bundle_uri = ""
swagger_css_uri = ""
作为最后一步，如下定义 swagger 配置：
swagger = [
{
"name": "Service API",
"page": "openapi",
"options": {
"url": "openapi.yaml",
},
}
]
列表中的每一项都会生成一个新的 swagger HTML 页面。是nameHTML 页面名称，page定义不带扩展名的文件名。这需要包含在 TOC 中。然后options用于此处SwaggerUIBundle定义的。请不要指定，因为它在 HTML 页面中是硬编码的。dom_id
在 sphinx 构建中，会创建一个 HTML 页面并将其放入_static构建的目录中。
如果规范以文件的形式提供，不要忘记复制它（例如，将其放入html_static_path.
要使警告静音，只需将一个与源文件夹toctree contains reference to nonexisting document同名的虚拟文件放入。page
构建和发布
该项目poetry用作依赖管理和构建工具。要发布新版本，请执行以下步骤：
- 更新中的版本
pyproject.toml - 在变更日志中添加一个条目
- 推送新标签喜欢
vX.X.X触发发布
支持、反馈、贡献
该项目通过GitHub 问题向功能请求/建议、错误报告等开放。我们鼓励并始终欢迎贡献和反馈。有关如何贡献、项目结构以及其他贡献信息的更多信息，请参阅我们的贡献指南。
行为守则
作为成员、贡献者和领导者，我们承诺让每个人参与我们的社区成为一种无骚扰的体验。通过参与本项目，您同意始终遵守其行为准则。
许可
版权所有 2022 SAP SE 或 SAP 附属公司和 swagger-plugin-for-sphinx 贡献者。请参阅我们的许可以获取版权和许可信息。可通过 REUSE 工具获得包括第三方组件及其许可/版权信息在内的详细信息。
swagger_plugin_for_sphinx -1.2.0-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | fbaa7bacba5f3d8050adee9180b8df135368c6951e592060f7788922630f78d2 |
|
| MD5 | fbf3c7382071db07496ab028cef9bedc |
|
| 布莱克2-256 | 9735454e48519aa4f6ebe082c5d45046471d1a3a44bd3f5cb8436bf3837c4b93 |