个人中心
gpt4 book ai didi

namespaces - flask restplus : unable to get flask_swagger_ui to work in conjunction with namespaces

转载 作者：行者123 更新时间：2023-12-04 17:05:24 24 4
gpt4 key购买 nike

我们有一个大 flask_restplus已使用一年左右的应用程序。我们现在想使用 flask_swagger_ui在此应用程序中工作，为应用程序的一部分提供一些静态生成的 swagger 文档。
我们的 flask_restplus -based 应用程序已经在使用命名空间，但 flask_swagger_ui我发现的文档似乎表明我们必须通过它的 get_swaggerui_blueprint 使用蓝图。方法，以服务于这种招摇。但是，当我们这样做时，flask_restplus应用程序无法识别与此蓝图关联的 URL。我们想知道这是否可能是由于同一应用程序中命名空间和蓝图之间的某种不需要的交互......或者可能只是因为我们做错了什么......？
这是我认为是我们代码的相关片段......

app = flask.Flask(__name__)
api = flask_restplus.Api(
  app,
  version='1.0',
  title='Test Application',
  description='Test Application',
  doc='/docs/'
)

ns     = api.namespace('server', description='Main server', path='/server')
utilns = api.namespace('util',   description='Util',        path='/util')

SWAGGER_URL = '/swagger'
API_URL = 'http://petstore.swagger.io/v2/swagger.json' # just for testing

swaggerui_blueprint = get_swaggerui_blueprint(
    SWAGGER_URL,
    API_URL,
    config={
        'app_name': "Test application"
    },
)
app.register_blueprint(swaggerui_blueprint)

# Set up endpoints under the namespaces defined above,
# and do some more initialization.

app.run()
但是，如果我们尝试像这样访问我们的应用程序， http://our.domain.name:PORT/swagger/dist ，它失败如下...... 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 FINAL//EN">
<title>405 Method Not Available</title>
<h1>Method Not Allowed</h1>
<p>This method is not allowed for the requested URL.</p>
如果我们省略“dist”，我们会得到同样的错误，如下所示: http://our.domain.name:PORT/swagger .
如果我们引用静态 swagger.json，这也会失败。文件而不是 petshop URL。
所有其他命名空间定义的端点都可以正常工作。
谁能看到我们做错了什么？
非常感谢您提前。

最佳答案

我偶然发现了解决方案。在 flask_restplus , 任何蓝图和 @app.route定义必须出现在 flask_restplus.Api 之前实例化。我在任何文档中都找不到这个，我是从一个讨论中得到的，这个讨论涉及一个遇到并最终解决这个问题的人。所以，这确实是 flask_restplus 中蓝图和命名空间之间的奇怪且看似未记录的交互。 .
另外，我发现 url_prefix=SWAGGER_URL需要传递给app.register_blueprint连同蓝图变量本身。
一旦我开始执行以下操作，我的 swagger 查询就开始起作用了:

app = flask.Flask(__name__)

# Any @app.route and blueprint definitions must
# appear before the flask_restplus.Api
# instantiation.

SWAGGER_URL = '/swagger'
# Use the following API_URL just for testing ...
API_URL = 'http://petstore.swagger.io/v2/swagger.json'
swaggerui_blueprint = get_swaggerui_blueprint(
    SWAGGER_URL,
    API_URL,
    config={
        'app_name': "Test application"
    },
)
app.register_blueprint(
    swaggerui_blueprint,
    url_prefix=SWAGGER_URL
)

# OK. Now we can instantiate flask_restplus.API

api = flask_restplus.Api(
    app,
    version='1.0',
    title='Test Application',
    description='Test Application',
    doc='/docs/'
)

ns     = api.namespace(
             'server', 
             description='Main server',
             path='/server'
         )
utilns = api.namespace(
             'util',
             description='Util',
             path='/util'
         )

# Set up endpoints under the namespaces defined above,
# and do some more initialization. And then ...

app.run()

关于namespaces - flask restplus : unable to get flask_swagger_ui to work in conjunction with namespaces，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/67427339/

24 4 0
文章推荐： php - 声明和使用 PHP 命名空间
文章推荐： c++ - 我如何使用 cout << myclass
文章推荐： networking - 无法在 ubuntu 18.04 上运行多个 dnsmasq dhcp 服务器
文章推荐： c# - 如何将我的页面与 C# View 子文件夹中的 xmls 连接
行者123
个人简介

我是一名优秀的程序员,十分优秀！

滴滴打车优惠券免费领取
滴滴打车优惠券
全站热门文章
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com