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

python - Python (Flask + Swagger) Flasgger 抛出 404 错误

我正在尝试使用 swagger ui 作为前端来查询我的烧瓶应用程序。我正在使用Flasgger我尝试了一个玩具示例,如下所示

当我尝试查询端点时http://localhost:7005/hello。我得到了“Hello World”的结果。

如果我尝试查询http://localhost:7005/apidocs/这向我显示了基本 UI在此处输入图像描述


但是,当我尝试查询端点根时。招摇的用户界面不显示。它给我一个 404 错误

关于问题的任何指示?

0 投票
1 回答
329 浏览

python-3.x - 在 python3 异常中构建 Flasgger/Swagger API

我正在 python 中构建一个 Flasgger/Swagger API。当我将值输入参数并执行代码时,我看到以下错误。我还分享了异常图像。

ValueError:输入包含 NaN、无穷大或对于 dtype('float32') 来说太大的值

Flasgger 本地主机图像 异常图像

0 投票
2 回答
490 浏览

wso2 - Flasgger Swagger 文件的 WSO2 API 发布错误 - 架构/属性是意外的

我使用 Python+Flask 和 Flasgger 创建了一个应用程序来创建招摇页面。Swagger 正在正确生成并且工作正常。

我正在使用 WSO2 (v2.5.0) API 管理器并尝试使用 Swagger URL(由上述应用生成)添加新的 API。

在导入 Swagger 的 json 文件时;架构或对象或属性标签(存在于 Swagger 的 json 文件中),它们都没有被 WSO2 识别,这使我的 API 在 WSO2 中发布失败

下面是我招摇的 json 文件

尝试在 WSO2 API 发布者中发布时出现错误片段

下面是我写了swagger定义的python代码

有没有其他方法可以为 Python+Flask 应用程序生成适当的招摇,该应用程序使用 json 格式的请求正文,并且 api 成功发布到 WSO2

0 投票
1 回答
644 浏览

swagger - Flasgger POST 路由中的文件上传选择器

在 Flasgger 中,我正在尝试为接受上传文件的路由创建文档。但是,尽管遵守规范,但我无法在 Flasgger UI 中显示文件选择器。

我正在使用最新的(截至今天)flasgger==0.9.1运行 OpenAPI 3 规范(如"openapi": '3.0.0'),我在 Swagger-UI 中看到了这个提交,它为 POST 文件请求启用了文件选择器。

我知道以前有人问过类似的问题,但没有一个与 OAS 版本 3 相关。

我的代码片段如下:

我在 Flasgger UI 中只得到一个空块输入。即使 Swagger-UI 支持,Flasgger 是否可能不支持它(我认为它是建立在它之上的)?还是语法错误?

0 投票
1 回答
498 浏览

swagger - 在 python 中使用 Flasgger 无法加载 API 定义错误

在此处输入图像描述

我正在使用 python 中的 Flasgger 和 Flask 为我的机器学习模型创建一个 API。

运行我的 API 文件后,我收到以下错误“无法加载 API 文档。获取错误内部服务器错误/apispex_1.json

下面是我的代码:

0 投票
1 回答
488 浏览

python-3.x - Flask/Flasgger - 如果设置了 `endpoint` 参数,文档不会出现

我有一个蓝图,我为其编写了 OpenAPI 文档。没有端点定义,它工作得很好,但它没有端点定义。

工作代码:

不工作(注意我如何在参数中定义端点):

你有工作代码,你为什么要问?

对我来说,用例是当我只有一个函数的多端点时,我必须yml为每个文档定义多个文件。

0 投票
1 回答
2001 浏览

python-3.x - Flasgger:如何在一个 yaml 文件中编写多个端点的描述?

我在 Flask 中创建了几个端点,并为每个端点创建了 yml 文件。因此,例如,我有 10 个端点和 10 个小 yaml 文件。使用起来不是很舒服,所以我想把所有的描述放到 1 个 yml 文件中。我试过这个:应用脚本:

我的app.yml

但这会引发错误:

错误获取错误内部服务器错误 /apispec_1.json

这意味着我的yml文件有问题。如何正确书写?


我在 github 上发现了这样的问题: https ://github.com/rochacbruno/flasgger/issues/264

0 投票
2 回答
1468 浏览

python-3.x - 在 flasgger 中包含外部 yml 文件

我想使用 json 远程引用创建一个单独的 definitions.yml 文件,这样我就可以在多个 YML 文件之间共享定义。

我们按照https://azimi.me/2015/07/16/split-swagger-into-smaller-files.html中的说明将定义部分移动到单独的文件中。最小的 YML 文件如下所示:

api.yml:

定义.yml

一些文件.py

命令

预期的 localhost:5000/apidocs 结果将具有用于 GET 的完整 API,其中 User 定义为模型。实际结果显示找不到'#/definitions/User',模型丢失。

flasgger 支持这个吗?

0 投票
1 回答
1652 浏览

flask - 如何在 Flasgger 中注册 Swagger 端点

目前使用 Swagger/Flasgger/Flask 来记录应用程序中的 API/路由。

要获取用于同一功能的两条路线的文档,我需要根据Flasgger 文档做两件事:

  1. 添加@swag_from指向包含规范的文件的声明。
  2. @main.route@swag_from相同的endpointkwarg。

当我执行第 1 步时,我开始在 Swagger 输出中看到规范信息:

但是,一旦我添加了endpointmethodskwargs,我的输出就会丢失规范:

不确定文档的去向。Flasgger 的蓝图示例没有展示如何在单个函数上使用多个路由来实现这一点。

0 投票
1 回答
3251 浏览

python - 如何让 Flasgger 针对 template_file 自动验证 flask-restful 资源端点?

TLDR;我希望实现
的目标:由于可以选择在 中加载通用/应用程序范围的模式,如实例化时flasgger的参数所定义,当使用通用 json时,如何自动验证发送到具有关联类的端点的所有数据架构文件?template_fileSwaggerflask-restful Resource


我目前正在设计一个 API,并且遇到了这样一种情况:当我从 json 模板文件定义我的整个架构并使用烧瓶休息的资源类时,API 调用中提供的数据未经过验证。

使用有效负载发布到/product预期的 501 响应。但是,使用无效负载发布也会导致 501 响应。

预期有效载荷:

验证失败的有效负载:

以下是该Resource课程的片段以及我的flasgger配置方式

下面是Swagger.json文件的内容

我最初@swag_from('myfile.yml', validation=True)在每个函数上使用单独的函数和装饰器,但为了 OOP 最佳实践,我想使用类来表示各自的端点。

我想,因为template_file当我实例化Swagger端点将根据该文件中的定义进行验证时加载了 json,但由于某种原因(或者我做错了什么),情况似乎并非如此。

谁能提供一些关于如何根据template_file定义验证类的所有端点的见解?甚至可以在项目的当前状态下完成Flasgger还是缺少该功能?

注释:
1. 我在Flasgger github repo 上创建了一个问题,这就是我之后密切反映这篇文章的内容。但是,由于现在回购非常无人居住,我觉得我更有可能在这里得到答案。 2.我不想使用Marshmallow 模式,我希望能够在第一次实例化时从 json 文件加载我的 swagger 模式并应用它(根据 json 文件中的所有适用的路由验证)作为一个整体到所有路线。
FlasggerDefinitions