パッケージ org.iplass.mtp.command.annotation.webapi

注釈インタフェース WebApiResultAttribute

public @interface WebApiResultAttribute

結果属性アノテーション

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

必須要素の概要

必須要素

修飾子とタイプ	必須要素	説明
String	name	レスポンス属性名

任意要素の概要

任意要素

修飾子とタイプ	任意要素	説明
Class<?>	dataType	レスポンスデータ型

要素の詳細

name

String name

レスポンス属性名

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

戻り値:

レスポンス属性名

dataType

Class<?> dataType

レスポンスデータ型

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

戻り値:

レスポンスデータ型

デフォルト:

java.lang.Void.class