问题标签 [openapi]

我正在使用 Swagger 来记录我的 REST 服务。我的一项服务需要上传 CSV 文件。parameters我在 JSON API 定义的部分中添加了以下内容：

现在我在 Swagger UI 页面上看到了文件上传选项。但是当我选择一个文件并单击“试用”时，我收到以下错误：

NS_ERROR_XPC_BAD_OP_ON_WN_PROTO：对 jquery-1.8.0.min.js 中 WrappedNative 原型对象的非法操作（第 2 行）

该页面正在不断处理，我没有得到任何回应。

有什么想法可能是错的吗？

有没有办法在模型部分定义 HashMap 或 Generic Object 类型？我有一个返回产品的 REST 服务，这些产品可以有不同的选项。options 属性基本上是一个 HashMap，其中 id 是选项名称，其值是选项值。

我正在通过手动而不是自动生成来准备我的 API 文档。我有应该发送到所有 API 的标头，但不知道是否可以为整个 API 全局定义参数？

其中一些标头是静态的，一些必须在调用 API 时设置，但它们在所有 API 中都是相同的，我不想复制和粘贴每个 API 和每个方法的参数，因为这不会未来可维护。

我通过 API 定义看到了静态标头，但没有单个文档说明如何设置或使用它们。

这可能吗？

我在 Swagger 中有一系列这样的参数

必须填写一个参数，但不管哪个参数，其他的可以留空。有没有办法在 Swagger 中表示这一点？

我很难弄清楚如何在 OpenAPI 2.0 中嵌套模型。

目前我有：

我尝试了许多其他方法：

以上似乎都不起作用。

但是，使用数组可以正常工作：

我正在使用具有端点的 swagger 中的 API 规范：

我也想为此端点定义一个替代拼写（授权）。这可能吗？还是我需要为每个拼写定义单独的路线？

假设我有一个像limit. 这个在所有地方都被使用，如果我需要更新它，必须到处更改它是一件痛苦的事情：

我可以使用 $ref 在其他地方定义它并使其可重用吗？我看到这张票表明有人想要更改或改进功能，但我不知道它今天是否已经存在？

有谁知道如何在 OpenAPI 2.0 定义中定义可能的“枚举”值，以便它们显示在 Swagger UI 的“模型”选项卡中？此处的示例：httpsstatus ://petstore.swagger.io/#!/pet/addPet 具有该属性的枚举选项。如何在 OpenAPI 2.0 中定义这样的枚举？

我有一个使用 Swagger 的 Java 项目。它在生成 swagger.json 方面做得很好，但是它将所有输出字段列为可选，我需要其中一些是必需的。这对我的代码来说不是问题，因为我可以添加 @ApiModelProperty 注释并指定它是否是必需的。

问题在于来自 3rd 方 jar 的对象。我不能去注释那个代码。如何在 3rd 方代码上创建 @ApiModelProperty 的等效功能？

我有一个使用以下 JSON 请求正文的 POST 请求。如何使用 OpenAPI (Swagger) 描述此请求正文？

到目前为止，我尝试了以下方法，但我坚持定义 body schema。

我想将输入正文内联定义为文档示例。