【问题标题】:springfox ApiModelProperty position sorting not workingspringfox ApiModelProperty 位置排序不起作用
【发布时间】:2020-12-16 09:15:44
【问题描述】:

在我的 Spring Boot 应用程序中,我无法使用在 @ApiModel 注释类上正确排序的字段来管理我的招摇 JSON。

首先,我将 springfox 库导入到我的 pom.xml 中:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>

其次,我创建了 SwaggerConfig.java:

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket swaggerSpringMvcPlugin() {
        return new Docket(DocumentationType.SWAGGER_2)  
                  .select()                                  
                  .apis(RequestHandlerSelectors.basePackage("my.package.to.enable.swagger.doc"))           
                  .paths(PathSelectors.any())       
                  .build()
                  .host("http://localhost:8080");
    }
}

第三,我创建了由@ApiModel注释的PersonDTO:

@ApiModel(value = "Person", description = "Person entity definition")
public class PersonDTO {

    @ApiModelProperty(value="Entity unique ID", position=0)
    public Long id;

    @ApiModelProperty(value="Person's number, useful to provide a convenient way to quickly communicate a person's reference", position=1)
    public Integer number;
    
    @ApiModelProperty(value="Person's first name", position=2)
    public String firstName;
    
    @ApiModelProperty(value="Person's last name", position=3)
    public String lastName;
    
}

然后,当我在 url http://localhost:[port]/[servlet-context-path]/v2/api-docs 请求 Json 输出时,似乎位置顺序不起作用:

"definitions": {
    "Person": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string",
          "description": "Person's first name"
        },
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "Entity unique ID"
        },
        "lastName": {
          "type": "string",
          "description": "Person's last name"
        },
        "number": {
          "type": "integer",
          "format": "int32",
          "description": "Person's number, useful to provide a convenient way to quickly communicate a person's reference"
        }
      },
      "title": "Person",
      "description": "Person entity definition"
    }
}

【问题讨论】:

    标签: java spring-boot swagger springfox


    【解决方案1】:

    目前在 3.0.0 中已损坏,请参阅 https://github.com/springfox/springfox/issues/3391

    【讨论】:

      【解决方案2】:

      使用@RequestBody 在控制器方法中起作用

      【讨论】:

      • 对我来说,无论是否在控制器方法中使用@RequestBody,它仍然无法正常工作
      猜你喜欢
      • 2020-05-07
      • 2018-05-03
      • 2019-04-04
      • 1970-01-01
      • 2020-03-27
      • 2018-07-08
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多