问题标签 [flasgger]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
1188 浏览

python - 使用 Swagger 在同一 def 中的 HTTP 方法的语法

我是 SwaggerUI 的新手。在我的 python 代码中,我有一个名为“work”的 API,它支持 POST、PUT 和 DELETE HTTP 方法。

现在我想为它创建 Swagger 文档。我正在使用以下代码:

但是,它似乎不起作用。

我尝试浏览以下文档链接,但没有太大帮助 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathsObject

你能帮帮我吗?

每个 HTTP 方法请求的参数都不同,我还希望在我的 HTTP UI 中为每个方法指定不同的描述。

编辑

将此添加到 index.yml 文件中。

对python代码进行了上述更改。

但是http://127.0.0.1:5000/apidocs/#!/default/什么也没显示。

0 投票
1 回答
1316 浏览

python - Flasgger - 上传文件

我正在开发一个需要通过 flasgger UI 上传文件的项目。我根据 Swagger 文档修改了我的 conf,但似乎没有用。下面是我的conf。请告知错误。

0 投票
1 回答
901 浏览

python - flagsger 自动验证 (validation=True)

我想向社区寻求有关在 python (v3) 上使用 flasgger 的帮助目前我正在将 flasgger 与 Flask-Restplus 一起使用(尽管 flask-resplus 确实有它自己的 Swagger,但我更喜欢使用 flasgger)。无论如何,我的问题是在@swag_from 中打开“validation=True”时。这是我的代码片段。

Python代码:

招摇(json)

问题是如果只使用@swag_from(v1swag["cancels_post"]),一切正常(验证除外)。我的意思是 Post 交易成功完成。

如果我将其设置为 @swag_from(v1swag["cancels_post"], validation=True) 我得到...

我也试过

但是得到了这些

您能否对我面临的这个问题有所了解。我仍然找不到可以帮助我解决问题的链接。

提前谢谢大家。

0 投票
1 回答
611 浏览

validation - 招摇:如何验证formData

到目前为止,如果参数来自"in": "body"或者预期的输入是json 格式,我可以进行招摇验证。但是,我找不到如何验证作为formData输入的简单字符串

下面是我的招摇脚本(json格式)

我删除了架构,因为它似乎只适用于“in”:“body”

我一直在网上搜索,但似乎找不到光。虽然我仍然会搜索......任何提示将不胜感激。

非常感谢您提前。

0 投票
1 回答
3548 浏览

python - 当我的函数中有多个 http 方法(GET、POST)时,如何使用 flasgger 编写 API 文档?

我正在使用flasgger 编写我的API 文档,我的一个函数同时具有GET 和POST 方法。问题是flasgger 无法区分GET 和POST 方法。我只为 post 方法编写了代码,但它也将该代码与 GET 方法相关联

我附上了显示我编写的代码的图像,您可以看到我在这里编写的代码仅适用于 POST 方法,但它也将其与 GET 方法相关联,如第二张图片所示。

在此处输入图像描述

此图显示了 GET 和 POST 方法的招摇 UI。正如您所看到的,对于 GET 方法,它显示的结果与 POST 方法的结果相同,即使我没有为 GET 方法编写任何内容。

在此处输入图像描述

我想使用 docstring 的方式将 swagger 集成到我的代码中,我该怎么办?

0 投票
2 回答
1962 浏览

authentication - 如何调整flasgger以便在发送请求时使用基本身份验证

我尝试将 flasgger 用于我的简单 RESTful API。API 需要身份验证/授权,并使用基本身份验证来执行任何查询。

swagger.io中有关于基本身份验证的非常好的文档 但是如何在flassger 中实现这些设置我尝试使用模板将 securityDefinitions 设置为 swaggler,但尝试尚未成功。

UPD。可能问题还没有解决。Flasgger 不支持基本身份验证 #103

0 投票
1 回答
154 浏览

python - Python 进入 Debian 包:没有名为错误的模块

遵循从 Flassger 支持的 Python 文件构建 Debian 包的指南。

运行构建时出现错误:

ImportError:没有名为 swagger_spec_validator.util 的模块

这意味着,那test.py没有看到swagger_spec_validator

似乎根本没有与 Swagger 相关的 Debian 软件包。应该包含在文件中的swagger_spec_validator某处吗?debian/control

0 投票
1 回答
1256 浏览

python - Python Flask Flasgger (Swagger) webargs - HTTP PUT 正文中的字符串列表

我使用flask、flasgger(由yml文件定义的swagger)和webargs创建了一个python web API:


put_community_sets.yml:


作为测试,我运行我的烧瓶应用程序并发送 HTTP PUT-

标头 = 内容类型,应用程序/json

正文 = [“test1”、“test2”、“test3”]

我得到:422 Unprocessable Entity 该请求格式正确,但由于语义错误而无法遵循。

我猜测 yml 文件中的 swagger 定义、@use_kwargs 参数或我的测试 PUT 有问题。

0 投票
1 回答
2511 浏览

python - 对 Swagger 进行排序标签

嗨,我正在使用 flasgger/swagger,但我想知道是否有可以按字母顺序对所有标签进行排序的功能?对,我不明白我的标签的顺序。它既不是字母也不是数字。样品订单是这样的

所以基本上用户、公司和房间都是 Swagger 标签。我想把它安排在Company应该首先出现的位置,然后是Room然后是User。有没有办法在 swagger 2.0 中实现这一点

更新:我希望它在网络浏览器显示中进行排序。简而言之,我们如何查看所有这些标签的排序顺序

0 投票
1 回答
2633 浏览

python - Flasgger AttributeError: 'NoneType' object has no attribute 'get'?

When I try to access http://localhost:8000/apidocs/index.html I get the following error:

This is my flask application:

I don't understand the error, I tried adding GET next to POST above in my code did not solve the problem. I am not sure if the error is even from my code? Any suggestions?