如何从RequestBody - Swagger中排除字段

在Swagger中排除RequestBody中的某些字段，可以通过多种方式实现，主要涉及到注解的使用。以下是一些常用的方法和步骤：

基础概念

RequestBody: 在HTTP请求中，RequestBody用于发送JSON或其他格式的数据到服务器。 Swagger: 一个用于设计、构建、记录和使用RESTful web服务的工具集。

类型与应用场景

类型: 主要使用注解来控制字段的显示。
应用场景: 当API有多个版本，或者某些字段只在特定条件下使用时。

解决方法

使用`@ApiModelProperty`注解

可以在实体类的字段上使用@ApiModelProperty注解，并设置hidden=true来隐藏该字段。

import io.swagger.annotations.ApiModelProperty;

public class User {
    @ApiModelProperty(hidden = true)
    private String password;

    private String username;

    // getters and setters
}

使用`@JsonIgnore`注解

如果使用的是Jackson库来处理JSON，可以使用@JsonIgnore注解来忽略某个字段。

import com.fasterxml.jackson.annotation.JsonIgnore;

public class User {
    @JsonIgnore
    private String password;

    private String username;

    // getters and setters
}

使用Docket配置

在Swagger配置类中，可以通过ignoredParameterTypes方法来忽略整个类的字段。

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .ignoredParameterTypes(User.class); // 忽略User类的所有字段
    }
}