问题标签 [swagger-3.0]

我目前正在编写 swagger 3.0 文档并使用 reDoc 为其呈现漂亮的 UI。我的文档中有一些场景，基于以前的属性枚举，我想显示不同的模式对象属性。可悲的是，我无法弄清楚如何在我的文档中正确地将它们连接在一起。到目前为止，我有以下测试端点：

test1.json 看起来像这样：

像这样的 test2.json：

期望的结果是基于枚举（reDoc 示例中的下拉菜单）在两个“测试”json 之间切换。为了得到这个结果，我缺少什么？您可以在特征部分（第一个 gif）下看到判别器结果的示例

我的服务器应用程序json以以下格式发送响应

additional-info可以是成功消息（例如“操作成功”）、错误消息（例如“操作失败”）或字符串格式的对象（例如{user-name: manu}.

我创建swagger了上述对象的定义如下：

然后我尝试在 API 中使用上述定义，如下所示

我的问题是目前，ServerFailureResponse或者ServerSuccessResponse不知道additional-info会包含什么。我想重新设计 API 定义，以便其中包含的内容additional-info也变得清晰。有没有办法我可以做到？在代码中，我仍然想additional-info用作包装器。我只希望在 中Swagger，每个响应的内容additional-info都很清楚。

我正在尝试使用openapiversion定义我的 API 3.0.0。我生成了以下 YAML 文件：

当我将这些行复制/粘贴到Swagger Editor中时，它给了我duplicated mapping key在线错误19；它用于description参数部分Content-Type。

我研究过openapi 文档，但我的 YAML 文件没有发现任何问题。

当我使用 Swagger 为我的 API 提供动力时，我会遵循其中一个指导，并且我总是将 MVC 注入放在像这样的Swagger注入之前。

我的一个朋友问我为什么应用该命令而不是在 MVC 之前先处理 Swagger 相关行。我发现我无法向他解释，也无法激发它（除了非常尴尬的井......就是这样......）。这告诉我，我应该深入研究一下这个问题。

据我所知，简短的谷歌搜索没有发现任何相关性，所以我在这里问。

我正在尝试将 Swagger 添加到我的项目中。收到的错误如下。

无法使用服务容器中的服务和默认值来实例化“Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator”类型的构造函数。

由于我没有更改 Swagger 二进制文件本身的任何内容，因此只安装了Swashbuckle.AspNetCore和Swashbuckle.AspNetCore.Swagger包（均在 4.0.1 版中），我假设它与配置有关。按照这里的建议，我设置了如下所示的配置。

我不确定我是否缺少一个包，如果我拥有的其中一个是错误的版本，或者我提供的设置配置是否不够。

我正在尝试为一些 REST API 调用创建一个招摇的文档。API 调用之一中的 POST 方法接受多部分表单数据内容，其中第一部分作为二进制文件数据，第二部分作为 json 实例。我正在寻找一种方法，允许访问 swagger ui 的用户仅为多部分表单数据内容的第一部分输入 Content-Disposition 标头和 Content-Range 标头的值。我试图在编码对象中使用标题对象但它并没有在 swagger-ui 中产生任何变化。我期望在请求正文中获取标头的参数字段，例如参数列表给出的请求标头参数。也许我错过了一些东西。如果这不是正确的方法，还有其他方法可以让我做到这一点吗？提前致谢。

这是带有请求正文的 swagger.json 的一部分：

预期结果：请求正文中每个标头的参数字段。

实际结果：swagger ui 中没有出现这样的参数字段。

这就是在 OpenApi https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md中完成编码对象示例的方式

我正在尝试使用 swagger-php 来实现相同的目标。我不知道的是如何传入encodings对属性@OA\MediaType进行编码，因为默认情况下被编码为testmultipart/form-dataapplication/json

前任：

他们在这里有一些例子：

https://github.com/zircote/swagger-php/tree/master/Examples

但我没有找到任何关于编码的例子

在这里，该字段定义为 https://github.com/zircote/swagger-php/blob/master/src/Annotations/MediaType.php

我试过encoding={"recommended"={"contentType"="multipart/form-data"}}了，但没用。

我的 API 目前正在使用 Basic Authentication with api_xxxinstead ofusername和api_xxyinstead of password，对于这种情况我们有任何特定的模式吗？

一切都完全一样，我只想更改 UI 上的用户名和密码标签。

以下功能描述如下：

我有一个特定状态代码的架构，我想在多个响应中使用它。对于相同的状态代码，我们可以有多个错误消息，并且每个响应可能不同。

ErrorCode: type: object properties: error_code: type: integer description: error code message: type: string example: No Authorization description: type: string example: "You aren't allowed"

我想为每个响应提供多个示例。例如： examples: 1: error_code: 1 message: random 1 description: description 1 2: error_code: 2 message: random msg 2 description: description 2

我正在使用swagger openapi 规范 3.0从我的界面生成 swagger。我有一个接受请求正文的删除方法。但根据RFC7231，DELETE不接受任何请求正文。Swagger-request body也这么说。但我的 API 旨在接受 DELETE 操作中的请求正文。在创建 swagger 以使 DELETE 操作接受请求正文方面是否有任何解决方法。目前我从大摇大摆的一代中得到的错误是，