python - 在没有 Django REST 框架的情况下将 Swagger 文档添加到 Django

Question

我正在处理一个 Django 项目，需要在不使用 Django rest-framework 库的情况下构建 API。
我很难找到解决办法，因为大多数可用的库已经绑定(bind)到 Django rest-framework pip 库。
有人可以指出我使用 swagger 文档的自我记录 API 的示例、库或资源吗？
至少支持 Python 3.7

Answer 1

您可以使用 APISpec ( https://pypi.org/project/apispec/ ) 生成 API 文档
APISpec 支持 OpenAPI 和 marshmallow，可以在普通 python 中实现，不依赖于 Django 框架
您可以通过以下方式使用 Doc String 指定文档的内容，

@app.route("/random")
def random_pet():
    """A cute furry animal endpoint.
    ---
    get:
      description: Get a random pet
      security:
        - ApiKeyAuth: []
      responses:
        200:
          content:
            application/json:
              schema: PetSchema
    """
    pet = get_random_pet()
    return PetSchema().dump(pet)

文档: https://apispec.readthedocs.io/en/latest/
有几种方法可以在不使用 Django REST Framework 的情况下构建 api，一些替代方法包括:
快速 API - https://fastapi.tiangolo.com/
flask - https://flask.palletsprojects.com/en/2.0.x/
樱桃- https://docs.cherrypy.dev/en/latest/