问题标签 [swagger-3.0]

简单的问题：如何编写 OpenAPI 规范。接受具有未定义名称的可选参数（即参数名称可以是任何随机字符串）？

例子：

我花了几个小时搜索如何在 Java 中使用 swagger codegen 生成 OAS 规范 yaml 文件，但我放弃了。我想在 Java 源代码中提供所有 API 规范数据作为代码注释。通过 maven 公开它会很棒。

AFAIK 我应该使用swagger-codegen-maven-plugin，但我无法让它扫描源代码以生成 OAS yaml 或 JSON 文件。

我会很欣赏 pom.xml 的片段，其中包含有效的 codegen 插件配置。

也许我应该回到之前的 Swagger，因为这个用例在 2.x 中是直接处理的。现在我对 3.x 方法感到沮丧。

VSCode 中是否有 php-swagger 注释插件？我最近写了注解，但是缩进不是自动的或者关键字不能自动完成时有一些不便。

或者有人用这个插件推荐另一个ide吗？

我需要在我的 Spring Boot API 中支持 swagger 2 和 3。

我已经使用 docket 对象创建了 swagger 2，并且为 swagger 3 添加了 maven 依赖项springdoc-openapi-ui。能够检查 swagger 2 和 3 文档。

如何仅禁用/启用 swagger 3 或 swagger 2？我的意思是如何禁用 swagger 3 配置？

我没有 swagger 3 配置类来启用/禁用使用@profile. 只需添加springdoc-openapi-uimaven 依赖 swagger 3 即可。

使用可重用枚举时创建文档的问题我的 yaml 文件如下所示

，当我编译它时，它会正确创建 java 类，但是，不是创建文档，只是给了我：

国家 - 该特定方案仅显示任何内容。对于其他方案，显示枚举选项等。你能帮我解决这个问题吗？这是大摇大摆的问题还是我在某个地方弄错了。swagger 网站中的示例和我的代码遵循相同的规则：https ://swagger.io/docs/specification/data-models/enums/ 。我在这里也发布了类似的问题：https ://community.smartbear.com/t5/SwaggerHub/Issue-with-creating-a-documentation-when-using-re-usable-enums/mp/191938

PS我以为问题是由于特殊字符而出现的，但事实并非如此。我试过没有那个特定的枚举条目，而且我还有另一种类似的方式可重用枚举，它的行为方式相同。

是否可以定义一个不能包含 null 的数组？

我正在使用 Open API 3.0 将其编译为 Java

例如为此

我认为 [null] 或 ["abc",null] 无效

提前致谢

我有一个用 PHP 编写的 REST API 服务提供者。我在 Postman 中成功测试了它，它在那里正常工作。

现在我要为其准备 API 文档，并且我正在使用 Swagger UI 3。我正确设置了它，我可以使用顶部的Authorize按钮处理 Authorization。

成功登录后，我希望端点设置和使用相应的承载令牌。但这不会发生，当我尝试任何端点时，REST 服务器抱怨缺少授权标头。我测试了网络流量，没有令牌和 HTTP 请求一起出现。

我的问题是，在使用顶部的授权按钮成功登录后，如何在 Swagger UI 的标头中发送 Bearer 令牌？我应该采取任何步骤/流程来将端点请求与令牌一起提供吗？

https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/

据此，使用springdoc openapi依赖项应该拉入swagger3

我在用

swaggerui 页面查找以 404 结尾的 swagger-resources

MyErrorController.handleError:30 - ErrorController {timestamp=Wed Dec 11 13:56:37 CST 2019, status=404, error=Not Found, message=No message available, path=/swagger-resources}

我在依赖项中看到了这些

假设我有一个 yml 文件example.yml，如下所示：

现在的模型Profile：

我想要做的是，当我使用 生成模型时example.yml，Profile不应再次生成该类，并且 ExampleResponse 类应该得到正确的导入。

一种方法是systemProperties在除. 这适用于小型模式并且不能有效地扩大规模。我正在寻找一种更好的方法来做到这一点。modelssystemPropertiesProfile

该示例取自https://github.com/swagger-api/swagger-ui/issues/4070

我正在尝试使用 Swagger 记录具有对象数组参数的 API POST 调用。但是当我尝试在 Swagger UI 中对其进行测试时，似乎explode: true在encoding:filters. 这是我的代码：

如果我用作参数，例如

然后 Swagger UI 生成一个调用（如果我为了更好的可读性而省略了 URL 编码）：

我怎样才能让它生产

反而？

“编码对象”的OpenAPI 3.0.2 文档指出explode“如果请求正文媒体类型不是 application/x-www-form-urlencoded，则应忽略属性”。但我们在这里使用 application/x-www-form-urlencoded。还是文档有误，应该说明“当前对象的内容类型”而不是“请求正文媒体类型”？但是，我会假设得到一个真正的数组作为参数值，即

如果重要：我使用的是 Swagger UI 版本 3.24.3。