当前位置:  开发笔记 > 编程语言 > 正文

如何在使用蓝图的Flask应用程序中使用Flasgger?

如何解决《如何在使用蓝图的Flask应用程序中使用Flasgger?》经验,为你挑选了0个好方法。

我正在使用Flasgger将Swagger UI添加到我的Python Flask应用程序中。互联网上最常见的示例是使用以下命令的基本Flask样式@app.route

from flasgger.utils import swag_from

@app.route('/api/')
@swag_from('path/to/external_file.yml')
def get(username):
    return jsonify({'username': username})

这样可行。

但是,在我的应用程序中,我没有使用@app.route装饰器来定义端点。我正在使用烧瓶蓝图。如下所示:

from flask import Flask, Blueprint
from flask_restful import Api, Resource
from flasgger.utils import swag_from
...

class TestResourceClass(Resource):

      @swag_from('docs_test_get.yml', endpoint='test')   
      def get() :
         print "This is the get method for GET /1.0/myapi/test endpoint"

app = Flask(__name__)
my_api_blueprint = Blueprint('my_api', __name__)
my_api = Api(my_api_blueprint)

app.register_blueprint(my_api_blueprint, url_prefix='/1.0/myapi/')

my_api.add_resource(TestResourceClass, '/test/'
                        endpoint='test',
                        methods=['GET', 'POST', 'PUT', 'PATCH', 'DELETE'])
....

如上所示,我@swag_fromTestResourceClass.get()绑定到GET方法端点的方法上使用了装饰器。test 在这两个地方,我也有endpoint = 匹配。

但是我在Swagger UI上什么都没有得到,它全是空白。该docs_test_get.yml文件确实包含有效的Yaml标记以定义swagger规范。

我想念什么?如何使Flasgger Swagger UI与基于Flask Blueprint的设置一起使用?

推荐阅读
kikokikolove
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有