@ApiModelProperty怎么设置文档会看不见这个属性
时间: 2023-10-17 20:00:29 浏览: 105
在使用 `@ApiModelProperty` 注解时,可以通过设置 `hidden` 属性来控制文档中是否显示该属性。将 `hidden` 属性设置为 `true`,可以使该属性在生成的文档中不可见。
以下是一个示例代码,展示如何使用 `@ApiModelProperty` 注解来隐藏属性:
```java
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
@ApiModel(description = "用户信息")
public class User {
@ApiModelProperty(value = "用户ID", hidden = true)
private Long id;
@ApiModelProperty(value = "用户名")
private String username;
// 省略其他属性和方法
}
```
在上述代码中,我们定义了一个名为 `User` 的类,并在类上使用 `@ApiModel` 注解来提供关于该类的描述信息。
对于属性 `id`,我们使用 `@ApiModelProperty` 注解,并将 `hidden` 属性设置为 `true`。这意味着在生成的文档中,该属性将不可见。
而对于属性 `username`,我们没有设置 `hidden` 属性,默认情况下该属性会在文档中显示。
请注意,要使 `@ApiModelProperty(hidden = true)` 生效,需要确保你的项目中已经正确配置了 Swagger 相关的依赖和配置。具体的配置方式可能因使用的 Swagger 版本和框架而有所不同。
阅读全文