Python Pyramid 应用程序的 Swagger 文档

Question

我有一个旧的 python 金字塔 Web 应用程序，我只想为其创建一个 API 文档（特别是 Swagger 或 OpenAPI3）。有没有一种方法可以做到这一点，而无需自己编写整个 swagger YAML 架构。有没有一个库可以自动扫描应用程序中的所有

@view_config

路线，然后为其生成文档。

在 spring 或 spring-boot 中也有类似的事情，其中 swagger schema/spec 是根据代码自动生成的。对于 python 金字塔应用程序是否有类似的操作。

PS。该应用程序使用 Poetry 作为依赖管理器。

Answer 1

据我所知，Pyramid 还没有 OpenAPI-sec 生成解决方案。

pyramid_openapi

读取 Yaml 文件并为您生成视图绑定，而不是与您在问题中要求的相反。

我的猜测是，最好的解决方案是从 FastAPI 中提取一些代码并将其集成到您的 Pyramid 应用程序中。

Answer 2

您可以尝试来自 https://github.com/Pylons/pyramid_openapi3的pyramid_openapi3。