带Flask Restplus、API和多个蓝图的Swager

Question

我正在使用Flask和Flask-Restplus构建一个非常复杂的微服务。
它将有许多endpoint，因此我将每个endpoint组织到一个单独的蓝图中。

• 目前，我正在努力使用Flask-Restplus和API，使用多个蓝图和swagger。
• 我希望能够将蓝图的所有endpoint都放入内置的 API 中，但这似乎不起作用。
• 我可以通过邮递员访问我的endpoint，但 swagger-UI 没有显示任何内容。 :(

下面的示例代码和目录结构应该给你一个提示，让你了解我的想法：

.
├── endpoints
│   ├── endpointa.py
│   ├── endpointb.py
│   ├── endpointc.py
│   └── __init__.py
├── __init__.py
└── run.py

我的主要init.py是这样的：

from flask import Flask, Blueprint, logging, jsonify, request, Response
from flask_restplus import Resource, Api   


# create app and api
app = Flask(__name__)
api_prefix  = '/api/v1/'

# register Blueprints
from endpoints.endpointa import endpointa_api
app.register_blueprint(endpointa_api, url_prefix=api_prefix)

from endpoints.endpointb import endpointb_api
app.register_blueprint(endpointb_api, url_prefix=api_prefix)

from endpoints.endpointc import endpointc_api
app.register_blueprint(endpointc_api, url_prefix=api_prefix)


api = Api(app,
          version='1',
          title='Test Service REST-API',
          description='A REST-API for the Test Service, implemented in python')


if __name__ == '__main__':
    app.run(debug=True, host="0.0.0.0", port=5060)

endpointa.py相应的蓝图：

from os import environ
import json, ast, syslog
import requests
import gc
from flask import Flask, Blueprint, logging, jsonify, request, Response
from flask_restplus import Resource, Api

endpointa_api = Blueprint('endpointa_api', __name__)

@endpointa_api.route('testa', methods=['GET'])
def testa():
    ...


@endpointa_api.route('testa/<string:testa_id>', methods=['GET', 'POST'])
def testa_id():
    ...

再一次：

我可以通过邮递员访问我的endpoint，但swagger-UI没有显示任何内容：

通常情况下，我会使用类似于

api.add_resource(TestClass, api_prefix + 'test')

但这似乎无法通过多个蓝图来实现。

有人能给我演示一下如何用api添加/注册这些蓝图(endpointa_api，endpointb_api和endpointc_api)吗？

Answer 1

使用Flask-Restplus有两种可能的解决方案:

• 使用Flask-ResPlus命名空间
• 将您的蓝图转换为Flask-ResPlusApis

您可以在文档中阅读两者：https://flask-restplus.readthedocs.io/en/stable/scaling.html

命名空间

Flask-RESTPlus提供了一种使用与Flask的蓝图几乎相同的模式的方法。主要思想是把你的应用程序分成可重用的名称空间。

from flask_restplus import Api

from .namespace1 import api as ns1
from .namespace2 import api as ns2
# ...
from .namespaceX import api as nsX

api = Api(
    title='My Title',
    version='1.0',
    description='A description',
    # All API metadatas
)

api.add_namespace(ns1)
api.add_namespace(ns2)
# ...
api.add_namespace(nsX)

蓝图Apis

下面是如何将 API 链接到蓝图的示例。

from flask import Blueprint
from flask_restplus import Api

blueprint = Blueprint('api', __name__)
api = Api(blueprint)
# ...

使用蓝图将允许您在应用程序中的任何url前缀和/或子域上安装API:

from flask import Flask
from apis import blueprint as api

app = Flask(__name__)
app.register_blueprint(api, url_prefix='/api/1')
app.run(debug=True)