Swagger中的@ApiModelProperty注解用于描述模型屬性的信息,包括屬性名稱、數據類型、示例值、默認值、是否必需等。
具體用法如下:
示例代碼如下:
public class User {
@ApiModelProperty(value = "用戶ID", dataType = "Long", example = "1")
private Long id;
@ApiModelProperty(value = "用戶名", dataType = "String", required = true)
private String username;
@ApiModelProperty(value = "密碼", dataType = "String")
private String password;
// getters and setters
}
在上面的示例中,@ApiModelProperty注解分別用于描述User類的id、username和password屬性。通過value屬性指定屬性的名稱,dataType屬性指定屬性的數據類型,example屬性指定屬性的示例值,required屬性指定屬性是否必需,默認為false。
這樣,在生成Swagger文檔時,就可以根據@ApiModelProperty注解的信息來展示模型屬性的相關信息。