Swaggerでの@ApiModelPropertyの使い方は何ですか?

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注釈の情報に基づいてモデルの属性情報を表示することができます。

bannerAds