Package org.iplass.mtp.command.annotation.webapi

Annotation Interface WebApiResultAttribute

public @interface WebApiResultAttribute
結果属性アノテーション

WebApiResultAttribute のアノテーション指定です。

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    レスポンス属性名

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>
    dataType
    レスポンスデータ型

  • Element Details

    • name

      String name
      レスポンス属性名

      必須の設定項目です。
      RequestContext.setAttribute(String, Object) で設定したキーに一致する値を、レスポンスの属性として設定します。

      Returns:
      レスポンス属性名

    • dataType

      Class<?> dataType
      レスポンスデータ型

      任意の設定項目です。設定値は WebAPI の動作に影響はありません。
      設定することで、OpenAPI 出力時にデータ型を指定することが可能となります。

      Returns:
      レスポンスデータ型
      Default:
      java.lang.Void.class