java - 将对象转换为多查询参数Swagger

标签 java spring-boot swagger springdoc-openapi-ui

我正在尝试使用对象的查询参数生成 swagger 文档,但我不确定 springdoc-openapi 是否可以。我知道这可以通过 io.springfox 实现。

我想要的是创建一个对象,将所有字段添加到该对象,然后将这些字段作为单独的查询参数显示在 swagger 文档中。

例如测试用例:

  1. 测试用例 1
    对于以下代码:
    enter image description here
    生成以下 swagger 文档:
    enter image description here

  2. 测试用例 2: 对于以下代码:
    enter image description here
    生成以下 swagger 文档:
    enter image description here

在这两种情况下,服务都可以按照查询参数的预期工作。我想要的是让测试用例 2 中的代码从测试用例 1 生成相同的文档。我知道这对于 springfox 是可能的,但我不知道如何在 springdoc-openapi 中做到这一点。

最佳答案

要实现此目的,您需要使用 @ParameterObject 注释来修饰 TestCase 类:

@ParameterObject
public class TestCase {
    @Parameter
    String field1;
    @Parameter
    String field2;
    @Parameter
    String field1;
}

关于java - 将对象转换为多查询参数Swagger,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/74139134/

相关文章:

java - Swagger 的 Spring MVC 项目

java - 返回第三方响应对象 - com.fasterxml.jackson.databind.JsonMappingException

java - 为什么非宽松的 SimpleDateFormat 用字母解析日期?

java - Android TCP 连接到 C 服务器 : String transferred is noisy

java - 为什么是 "javax.net.ssl.SSLHandshakeException"?

java - Swagger如何正确生成自定义异常类?

java - 从 Java 中的另一个 ArrayList 中的 ArrayList 获取项目?(董事会想要获取某个位置内的玩家)

java - 如何在 Android 中使用 runnable 循环

mysql - Hibernate:如何通过 jpa.hibernate.ddl-auto 选项创建和执行 sql 过程

java - 如何使用嵌入式 Tomcat 8 和 Spring 引导将子域转换为路径