python - 从没有注释的 Python 代码生成 Swagger 规范

Question

我正在寻找一种方法来根据 Python 服务的定义生成 Swagger 规范(JSON 和 Swagger-UI)。我找到了很多选项(通常是基于 Flask 的)，但它们都使用了注释，我无法从代码中正确处理这些注释，例如在一个循环中定义 10 个具有不同路由的等价服务(在此示例中可以对处理程序进行 currified，首先调用函数来获取它)。

没有注释有没有办法做到这一点？我想通过使用与该 API 方法的实现和文档对应的值调用函数(或方法，或类的构造函数)来生成 API 及其文档中的方法。

Answer 1

我建议调查 apispec .

apispec 是一个可插入的 API 规范生成器。

目前支持 OpenAPI 2.0 规范(f.k.a. Swagger 2.0)

apispec

from apispec import APISpec

spec = APISpec(
    title='Gisty',
    version='1.0.0',
    info=dict(description='A minimal gist API')
)

spec.definition('Gist', properties={
    'id': {'type': 'integer', 'format': 'int64'},
    'content': {'type': 'string'},
})

spec.add_path(
    path='/gist/{gist_id}',
    operations=dict(
        get=dict(
            responses={
                '200': {
                    'schema': {'$ref': '#/definitions/Gist'}
                }
            }
        )
    )
)