问题标签 [oas3]

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

swagger - 如何将多个示例添加到 Swagger 模式?

我将 Swagger 与 OAS3 一起使用,因为我需要anyOf支持。我有一个 API 调用可以采用两种可能的模式之一,一个account或一个address. 该模式在 Swagger 中运行良好:它显示并验证。但该example值仅显示第一个模式。我根据文档创建了一个examples数组,但我不知道在哪里添加它:

我应该在哪里添加examples数组,还是有更好的方法向用户显示 UI 中的 2 个可能的模式?

0 投票
0 回答
193 浏览

swagger - 如何在 OpenAPI/Swagger v3 中指定多部分表单字段是可选的?

我想概述一个多部分表单请求正文,其中一些字段是必需的,而其他字段是可选的。通常,在 OAS 模式对象中,所有未明确标记的属性required: true都默认为可选。但是,在概述requestBody带有multipart/form-data内容的内容时,这似乎被搁置了,并且所有字段都是必需的。

我尝试了多种方法来指定必填字段和可选字段。尝试使用required: false.

OAS3 规格:

预期:详细信息 amultipart/form-data requestBody包含一些必填字段和一些可选字段。

在上面的代码示例中,foo应该是必需文件,而bar应该是可选文件。

0 投票
0 回答
97 浏览

json - 生成的 swagger json 中的 fastify openapi3 中没有引用 $id

我正在使用 fastify (3.20.1) 和 fastify-swagger(4.8.4) 从我的模式中生成 openapi swagger doc。

但是,生成的 openAPI 3.0.3 swagger 中没有显示我作为 $ref 的 $id 引用。

例如,为了演示,我有以下架构:

在生成的 JSON 中,我看到了这个:

结果,在我的 swagger-oas UI 中,我收到了这个错误,并且没有任何响应模型出现。

在此处输入图像描述

在此处输入图像描述

我正在寻找的是一种干净的方式,以便引用在 OAS3 中正常工作,并且我生成的 swagger-oas JSON 是干净的。

任何帮助如何使它正确将不胜感激。

谢谢, 普拉迪普

0 投票
0 回答
32 浏览

openapi - OpenApi:如何在响应中定义 cookie?

OpenApi 允许在请求参数中定义 cookie。但是对于响应,我能找到的只是自定义标头(信号一般存在 Set-Cookie,但没有关于特定 cookie 的线索)或滚动自定义扩展(这也是非常有限的,例如缺少类型和description)。

如何定义响应cookie?

0 投票
0 回答
140 浏览

maven - 如何使用 openapi-tools/swagger-maven-plugin 在 swagger 中生成安全方案

我需要在 maven 构建阶段生成招摇,为此我使用openapi-tools/swagger-maven-plugin

问题在于安全定义。

该插件的文档非常有限,我猜我无法使用正确的语法。这就是我正在做的

下面是我的 myApp.json 文件

0 投票
0 回答
44 浏览

wso2 - OAS3 - 请求正文的内部对象内容类型

是否可以在 OAS3 中为请求正文的内部对象设置内容类型,并在调用调用时将其显示在 swagger UI 生成的 curl 命令中?这是 OAS3 中支持的功能吗?下面给出一个例子。记者是内部对象。

以下是在 wso2am-2.2.0 商店门户中生成的 curl 命令。

0 投票
0 回答
34 浏览

java - 当成功响应媒体类型为 image/png 时,失败响应缺少 Swagger 响应正文

我使用 Swagger OAS3 并尝试在应该返回图像的端点失败时显示详细的错误消息。当我将成功响应的 MIME 类型设置为image/png时,如果抛出错误,则不会出现 *Response 正文。如果我将其更改为application/json,它会出现,但我们期望的实际成功响应是图像,而不是 json。所以我不确定这是否是正确的方法!

响应正文未出现错误

如果我在成功响应中添加两种 MIME 类型,并在执行前选择 json,它会再次出现。但它从不响应我为失败响应添加的 MIME 类型。

这是不可能的还是我做错了?非常感谢任何帮助。

(如果我删除所有 MIME 类型,则会出现响应正文,但默认格式为 html,我无法将其更改为 JSON,除非如上所述指定对 json 的成功响应的 MIME 类型。)