ApiModelPropertyアノテーションの使用方法

まず、@ApiModelPropertyについてですが、これはpropertiesモジュールにデータを追加して操作するためのswaggerアノテーションで、その中の共通プロパティは次のとおりです。

1.値()

Source: String value() default "";

引数は String 型で、このプロパティの簡単な説明として機能する。

2.名前()

Source code: String name() default "";

引数はString型で、プロパティ名をオーバーライドできるようにするためのものです。

3. allowableValues()

Source: String allowableValues() default "";

パラメータタイプはStringで、このパラメータストレージの長さを制限する役割を果たします。

4.アクセス()

Source: String access() default "";

引数の型はStringで、APIドキュメントからプロパティをフィルタリングできるようにするために使用されます。

5.ノート()

Source: String notes() default "";

パラメータはString型で、フィールドのノートとして機能します。

6. dataType()

Source: String dataType() default "";

引数の型はStringで、引数のデータ型として機能する。

7.必須()

Source: boolean required() default false;

パラメータの種類はStringで、パラメータがNULLになるかどうかを指定します、デフォルトはfalseです

8.ポジション()

Source: int position() default 0;

int型の引数で、モデル内のプロパティの順序を明示的に指定できるようにします。

9. hidden()

Source: boolean hidden() default false;

パラメータはbooleanタイプで、Swaggerモデル定義でモデルプロパティを隠せるようにするためのものです。

10.例()

Source: String example() default "";

引数はString型で、プロパティの値の例となる。

11. readOnly()

Source: boolean readOnly() default false;

パラメータは boolean 型で、プロパティを読み取り専用に指定するためのもので、デフォルトは false です。

12.リファレンス()

Source: String reference() default "";

引数は String 型で、対応する型定義への参照を指定する役割を果たし、指定された他のデータ名を上書きする。

13. allowEmptyValue()

Source: boolean allowEmptyValue() default false;

引数は、NULL値を渡すことを許可または禁止するブール値で、デフォルトはfalseです。

例

  @ApiModelProperty(value = "primary",name = "id",
  	  allowableValues = "32",
      access = "1",
      notes = "user's id",
      dataType = "int",
      required = false,
      position = 1,
      hidden = true,
      example = "1",
      readOnly = false,
      reference = "id",
      allowEmptyValue = false)
  @TableId(value = "id",type = IdType.AUTO)
  private int id;