溫馨提示×

Swagger中apimodelproperty的用法是什么

小億
330
2024-02-02 09:21:33
欄目: 編程語言

Swagger中的@ApiModelProperty注解用于描述模型屬性的信息,包括屬性名稱、數據類型、示例值、默認值、是否必需等。

具體用法如下:

  1. 在模型類的屬性上使用@ApiModelProperty注解,指定屬性的描述信息。
  2. 通過value屬性指定屬性的名稱。
  3. 通過dataType屬性指定屬性的數據類型。
  4. 通過example屬性指定屬性的示例值。
  5. 通過required屬性指定屬性是否必需,默認為false。
  6. 通過defaultValue屬性指定屬性的默認值。

示例代碼如下:

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注解的信息來展示模型屬性的相關信息。

0
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女