问题标签 [openapi]

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 回答
1813 浏览

swagger - 大摇大摆地创建部分

我正在写一个招摇规范,我有三个独立的端点。如何在我的文档中将它们分开?我想明确区分示例:用户、帖子和其他。所以每个人都会有一个 CRUD 描述并显示在 swagger UI 中,它看起来像:

0 投票
1 回答
683 浏览

swagger - swagger 参数 - 标题覆盖架构中根对象的 XML 对象

在 swagger ui 中,这个例子是

对于嵌套对象,它可以正常工作(使用来自 XML 对象的标签名称,而不是来自该对象的标题)。对于结果模式根对象也可以。

仅在 body 参数中的根对象的问题。

0 投票
1 回答
7076 浏览

jmeter - Swagger Codegen JMeter 测试数据模板

我正在从 swagger 定义中生成 Jmeter 的 jmx 文件,生成的 JMX 和测试数据 CSV 似乎毫无用处,它没有关于 API 预期的参数信息,没有响应映射信息的 http 状态代码等。

您可以使用任何定义文件来重现此内容:

  1. 转到http://editor.swagger.io/#/
  2. 从文件菜单中打开任何示例
  3. 从生成客户端菜单中,单击 Jmeter

我期望的是一个具有整个 API 框架的 JMX,这样 QA 人员就不必担心这一点,而只关注测试。

我为其他语言/工具制作的所有客户端都足够好,除了 Jmeter,我在这里做错了吗?

0 投票
1 回答
3937 浏览

rest - What does it mean for a REST API to have a `required` response property?

Learning about REST APIs and am following https://apihandyman.io/writing-openapi-swagger-specification-tutorial-part-2-the-basics/.

The API can receive two parameters: username and bla, but only username is required by using the required keyword. This makes sense to me.

The API will return firstname, lastname, and username, but only username is required by using the required keyword. This does not make sense to me. Does the lack of the required keyword indicate that the other two might sometimes not be required? What influences whether they are or are not?

0 投票
2 回答
23636 浏览

rest - 使用 Swagger 将数组指定为参数

如何将数组指定为参数?例如,可以给 /persons 的帖子提供字符串 username、firstname 和 lastname以及数组 myArray

0 投票
1 回答
800 浏览

rest - Swagger 的 allOf 显示为未定义

我采用了https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#models-with-composition中的 allOf 示例,并将它们应用于参数模式和响应模式。但是,我的 allOf 参数和响应显示为未定义。当只使用 Pet 而不是 Cat 时,它可以正常工作。请让我知道如何使用 Swagger 的 allOf

在此处输入图像描述

在此处输入图像描述

0 投票
2 回答
29423 浏览

swagger - 多态性中的“鉴别器”,OpenAPI 2.0 (Swagger 2.0)

引用OpenAPI 2.0, Schema ObjectSwagger 2.0, Schema Objectdiscriminator字段定义为:

添加对多态性的支持。鉴别器是用于区分继承此模式的其他模式的模式属性名称。使用的属性名称必须在此模式中定义,并且必须在required属性列表中。使用时,该值必须是此模式的名称或任何继承它的模式。

我的困惑/问题:

  • 对我来说,它在继承或多态中究竟扮演什么角色是模棱两可的。有人可以discriminator用一个工作示例来解释它究竟做了什么,如果我们不使用它会怎样?任何错误、警告或任何依赖于它进行某些操作的工具?
  • 是不是swagger-editor不支持discriminator,而其他一些工具中使用了这个字段?

到目前为止我已经尝试过:

  • 我尝试使用swagger-editor和同一文档中的示例(也在下面提到)来玩弄这个属性,看看我是否能看到它的任何特殊行为。我更改了属性,删除了它,并将Dog模型扩展到更深一层,并在新的子模型上尝试了相同的方法,但我在swagger-editor的预览中没有看到任何变化。
  • 我尝试在线搜索,特别是stackoverflow问题,但没有找到任何相关信息。

我用来做实验的示例代码:

0 投票
1 回答
417 浏览

python - OpenApi Cdiscount GetProduct 不适用于 EAN

以下 python 代码应返回有关 Cdiscount.com 上产品的信息,例如价格、URL 等...

但结果只是:

我尝试了其他 EAN 代码,但结果始终相同。我知道这些 EAN 代码存在于 Cdiscount 上。这是一个错误还是我做错了什么?

我想添加标签 [cdiscount] 但不能。也许其他人可以做到这一点。

0 投票
0 回答
6063 浏览

swagger-2.0 - 如何定义适用于所有路径的全局参数?

我想让account参数应用于所有路径,没有任何例外。有没有办法用 Swagger 2 做到这一点?我不想account为每个路径应用参数。

0 投票
1 回答
314 浏览

php - 使用 Swagger/OpenAPI 规范指定要作为 GET 参数发送的数组

以下招摇定义:

将生成以下 URL,而服务器只会收到fields等于column3.

如何更改它以使其在参数中发送一个数组?例如: