问题标签 [flask-apispec]

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 投票
0 回答
36 浏览

flask-restful - 带有 flask_apispec = 对象数组的 Swagger 文档

所以我的 flask_apispec 文档器有一个烦人的问题。

我希望我的 api 的帖子正文接收到这个

注意:作为批量输入的平面数组是我想要的。

在 swagger.json 中它看起来像这样:(我想通过 flask_restful 和 flask_apispec 自动记录来实现)

但我似乎无法做到这一点....使用下面的代码(见屏幕底部)我显然得到了这个:

大摇大摆我不想要

目前的代码是:

0 投票
0 回答
233 浏览

python - Swagger 不渲染嵌套的可选对象(使用 flask 和 apispec)

我正在使用带有flask 1.1.2、apispec 5.1.1、marshmallow 数据类8.3.2 和flask_apispec 0.11.0 的python 3.8。基本代码如下所示: 我有一个对象(项目)的 marshamlow 数据类,该对象(项目)包含一个可选对象(所有者)。然后,对于我的最终端点,我需要发送这些项目的列表。

下面是一个最小的工作示例,一个端点获取具有可选所有者的项目,一个端点获取项目列表(具有可选所有者)。项目端点的 swagger 文档显示了所有者及其特征。投资组合的端点无法正确呈现 swagger 文档,并且仅显示所有者的空括号。我不知道这是否是 a)按预期工作(我只是不应该嵌套对象),b)apispec 的渲染问题或 c)由 flask_apispec 引起的(swagger.json)组合问题,并且会感谢任何人指出我为什么它不起作用的方向。

我尝试过使用 OpenApi 2.0 和 3.0 标准,但两者都遇到了同样的问题。对于值得验证的内容和实际的 API 行为似乎按预期工作,这只是一个招摇的问题

最小代码示例:

swagger 文档为 v1/item 正确呈现: 项目端点的大摇大摆输出

但是所有者在投资组合的描述中是空的大括号: 投资组合端点的招摇输出

为 swagger 文档生成的 json 文件(openapi 3.0):

0 投票
0 回答
17 浏览

swagger - 是否可以使用 apispec 跟踪内部/私人文档?

我正在使用 Flask 服务器并正在考虑使用 apispec 对其进行记录。问题是一些函数有内部注释或私人信息,例如开发者电子邮件、TODO 注释等。

是否可以将这些与 apispec 的 yaml 一起干净地包含在函数文档字符串中?

下面是一个玩具示例:

0 投票
0 回答
18 浏览

python - 如何在 flask_restful 中访问反序列化和验证对象的值

我正在使用 flask_restful python 模块来构建我的第一个 rest API。我创建了 AwesomeRequestSchema 类,在其中设置了必填字段api_type。use_kwargs 验证请求对象。

我想知道是否有一种方法可以访问反序列化和验证对象的值,例如kwargs.api_type

我会很感激任何帮助!谢谢!

0 投票
1 回答
156 浏览

python-3.x - flask_apispec 库使 Flask 应用程序在使用 use_kwargs 装饰器时崩溃

我正在使用 flask_restful、flask_apispec 和 marshmallow 在 Python 3.8 中构建一个 Restful API。当我启用use_kwargs装饰器时,我的应用程序正在使用 POSTTypeError: post() takes 1 positional argument but 2 were given

我将不胜感激解决此错误的任何帮助。

谢谢!

0 投票
0 回答
23 浏览

javascript - 如何使用谷歌地图在 Angular Web 应用程序的谷歌地图上显示服务城市名称(数据库中的城市名称表)

我有一个 Angular 的 Web 应用程序,而且我有一组城市名称数据,我想在谷歌地图上标记或标记每个城市名称。我无法理解如何做到这一点。并且如果新城市被添加到我的城市集合中,新城市通过调用 API 立即开始显示在地图上。在这里我是新的和新鲜的,请帮助我