python - 如何将应用程序包装端点添加到 Restplus API 文档？

Question

我有一个 Flask REST API。我用healthcheck.EnvironmentDump以便轻松转储我的服务运行的环境。是否可以将端点添加到 Restplus 生成的 Swagger 文档中？

示例

需求.txt

flask
flask-restplus
gitpython
healthcheck

应用程序.py

#!/usr/bin/env python

"""Simple Flask/Swagger/REST-API example."""

from flask import Flask
from flask_restplus import Resource, Api
from healthcheck import EnvironmentDump

app = Flask(__name__)
api = Api(app, doc='/doc')

# wrap the flask app and give a environment url
# TODO: Add this to API
envdump = EnvironmentDump(app, "/environment")


@api.route('/version')
class VersionAPI(Resource):
    def get(self):
        import git
        repo = git.Repo(search_parent_directories=True)
        sha = repo.head.object.hexsha
        return sha


@api.route('/health')
class HealthAPI(Resource):
    def get(self):
        import datetime
        return datetime.datetime.now().isoformat()

if __name__ == "__main__":
    app.run(host='0.0.0.0')

Answer 1

EnvironmentDump 和 HealthCheck 将为端点安装各自的处理程序，因此将无法访问您定义的资源中的 get() 实例。话虽这么说，提供 stub 资源足以使其显示在 Flask-RESTPlus 生成的 Swagger 文档中:

health = HealthCheck(app, '/healthcheck')

@api.route('/healthcheck')
class HealthCheckResource(Resource):
    def get(self):
        pass