问题标签 [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 回答
291 浏览

flask - Flasgger:参数未显示和架构

我最近开始学习 Swagger 的 APi 文档。但是,当我转到 localhost:5000/apidocs 时,我看到了我添加的 API,但即使我在 yml 文件中描述了参数,所有 API 都没有参数。我在互联网上找不到任何相关的东西。

这是我的 YML 代码:

这就是我如何将招摇添加到 api @swag_from('pathto/swagger.yml')

同样,我还有一个疑问。我们在 yml 规范文件中定义模式。我想知道这些模式到底代表什么,是否有必要使用它们?

附件是 APIdocs 页面的截图在此处输入图像描述

0 投票
0 回答
183 浏览

python - 在 Spyder 中导入 Flasgger:ModuleNotFoundError: No module named 'flasgger'

Flasgger使用 Anaconda 提示符安装。

尝试将其导入 Spyder 时,我得到ModuleNotFoundError

这里有什么错误?我认为安装没问题Flasgger...但是导入失败。

0 投票
0 回答
195 浏览

python - Flasgger:Swagger 应用程序 - http://127.0.0.1:5000/apidocs/ - 获取错误INTERNAL SERVER ERROR /apispec_1.json

我在 Spyder 中创建了一个 Flasgger/Swagger 应用程序并返回:

当试图通过我的谷歌 Chrome 浏览器访问这个应用程序时,http://127.0.0.1:5000/apidocs/我得到了这个错误:

我必须在这里改变什么?

0 投票
0 回答
114 浏览

python - 使用 Flask 未显示 Swagger 的登录窗口

我有一个使用 Flask 设置的 REST API,其中包含一些 API 文档。

文档在代码本身中,我使用 Flasgger 来运行 API 文档接口。

问题是,在尝试使用 URL 访问 API 时,https://<server_address>/apidocs/index.html没有显示登录框。我只是Authentication required在我的浏览器窗口中得到结果。

浏览器窗口

我期待这样的窗口:

登录窗口

我没有在远程服务器上获得。我可以完美地登录本地主机,但不能登录我的远程服务器。

由于某种原因,远程服务器没有给我那个登录窗口。我尝试过同时使用 HTTP 和 HTTPS,因为在某处提到该协议也很重要。

库版本:

  • 烧瓶大摇大摆== 0.2.14
  • flasgger==0.9.5
  • pytest-flask==0.15.0

提前致谢。

0 投票
1 回答
276 浏览

python - 如何在 flasgger 中同时拥有棉花糖定义和多版本规范?

我将使用 Flasgger 和 APISpec 从棉花糖模式中加载初始定义。除此之外,我还想拥有多个版本的 API 文档。这是我的代码:

我还尝试在蓝图的每条路线中使用此装饰器以 .yaml 格式加载 API 文档:

但是当我使用 APISpec 模板时,规范路由不再起作用了!它不会过滤文档,只是将所有文档(v0 和 v1)一起加载!我的代码有问题还是我的解决方案完全错误?

0 投票
0 回答
325 浏览

flask - 使用 OpenAPI3 文档字符串中的 Flasgger 验证 POST 请求正文

我有一个 Flask API,我用 OpenAPI3 文档字符串注释了每个端点。我现在想使用 Flasgger 的自动验证,但我不知道如何告诉 Flasgger 我想根据我在 requestBody 中定义的模式来验证请求。这是我尝试过的:

查看 Swagger UI 页面时收到的错误消息是:

事实上,flasgger 生成的 apispec json 中的定义对象是空的。我想要验证的架构可以在paths/api/apikey/post/requestBody.

0 投票
1 回答
129 浏览

javascript - Flasgger / Swagger - apidocs 适用于 localhost 但不适用于 Openshift(您需要启用 JavaScript 才能运行此应用程序)

我正在运行 Python Flask 服务器。一位同事添加了 Flasgger/Swagger 支持,我可以使用成功显示 API

同样,我可以得到API的json版本

相同的代码部署在 Openshift 项目中,并使用 Traefik 将外部请求路由到 Python Flask 服务器

Traefik 关闭“apidocs”和“api_documentation.json”并将其直接路由到 Python Flask 服务器

我在 Chrome 浏览器调试器(F12 - 网络)中看到的 swagger-ui-bundle.js 响应是“您需要启用 JavaScript 才能运行此应用程序”。

为什么这在localhost版本的 Chrome 中有效,但在访问部署在Openshift上的服务器时无效?两者都是从同一个 Chrome 窗口访问的——只是不同的标签。

这是 localhost 版本的 apidocs 请求的 Headers 内容

这是 Openshift 版本的 apidocs 请求的 Headers 内容

0 投票
0 回答
26 浏览

python - 如何防止flasgger请求中的重定向?

我在 cmd 中检查以下代码 - 它没有重定向到另一个 url。

但是当我在浏览器中单击时Execute-它的捕获重定向和输出不正确。如何禁止重定向?

0 投票
0 回答
180 浏览

python - 在 swagger(flasgger) 中的 API 调用期间加密密码文本

我正在使用flasgger 为flask 中的API 生成swagger UI。

我有一个http://localhost:5000/api/token返回令牌的 API 端点,如果给出正确的用户名和密码,一切都很好,唯一的问题是密码以明文形式发送,我想在通过 swagger 发布时加密密码并在烧瓶中解密。

在此处输入图像描述

生成的卷曲是

如何在 swagger 或 flasgger 中加密密码值。我在下面尝试过,但没有看到任何变化。

提前致谢!

0 投票
0 回答
19 浏览

flask - 不能大摇大摆地树立榜样

我正在使用swagger,并且我有以下端点参数文档:

问题是当我尝试查看 url 中的架构时,没有显示示例

在此处输入图像描述

为什么 swagger 没有在 201 响应中显示示例?

谢谢