Annotation Interface WebApi
WebAPIの定義。
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionboolean
Deprecated.String[]
許可するリクエストボディのContentType。デフォルト未指定(=すべて許可)。
accepts指定より、allowRequestContentTypesの指定による制限が優先されます。
例えば、 accepts指定によりJSON形式の処理が有効化されている場合において、 allowRequestContentTypesに"application/json"が含まれない場合は、 JSON形式によるリクエストは処理されません。long
cacheControlType=CACHEを指定した場合の WebAPIキャッシュのmax-age(秒)を指定します。 デフォルト値は-1でこの場合はmax-ageは未指定となります。
注意:max-age未指定の場合、FF、Chromeでは実際はキャッシュが利用されませんWebAPIのキャッシュ種別(Cache-Controlヘッダの制御)を設定します。 デフォルトは、UNSPECIFIED(未指定)です。boolean
long
multipart/form-dataの際のファイルの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。 1つのファイルに対する最大サイズなので、複数のファイルの合計サイズを制限したい場合は、 maxRequestBodySizeを設定します。long
リクエストボディの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。boolean
String[]
OpenAPI 定義OpenAPI ファイルタイプOpenAPI バージョンboolean
boolean
boolean
Deprecated.privileged()
を使用してください。boolean
boolean
WebAPIの結果に関する属性を設定します。String[]
Deprecated, for removal: This API element is subject to removal in a future version.responseResults()
を利用してください。本メソッドは大きなバージョンアップの際に削除する予定です。boolean
スタブレスポンスを返却するかどうか。スタブコンテンツ。スタブデフォルトコンテンツ。boolean
boolean
このAction処理をSessionにて同期化するか否か。デフォルトfalse。TokenCheck設定
-
Element Details
-
id
String id- Default:
"##default"
-
name
String name -
displayName
String displayName- Default:
"##default"
-
description
String description- Default:
"##default"
-
cacheControlType
CacheControlType cacheControlTypeWebAPIのキャッシュ種別(Cache-Controlヘッダの制御)を設定します。 デフォルトは、UNSPECIFIED(未指定)です。- Returns:
- WebAPIのキャッシュ種別
- Default:
UNSPECIFIED
-
cacheControlMaxAge
long cacheControlMaxAgecacheControlType=CACHEを指定した場合の WebAPIキャッシュのmax-age(秒)を指定します。 デフォルト値は-1でこの場合はmax-ageは未指定となります。
注意:max-age未指定の場合、FF、Chromeでは実際はキャッシュが利用されません- Parameters:
cacheControlMaxAge
-
- Default:
-1L
-
checkXRequestedWithHeader
boolean checkXRequestedWithHeader- Default:
true
-
privilaged
Deprecated.privileged()
を使用してください。- Default:
false
-
privileged
boolean privileged- Default:
false
-
publicWebApi
boolean publicWebApi- Default:
false
-
overwritable
boolean overwritable- Default:
true
-
permissionSharable
boolean permissionSharable- Default:
false
-
accessControlAllowOrign
Deprecated.accessControlAllowOrigin()
を使用してください。- Default:
""
-
accessControlAllowOrigin
String accessControlAllowOrigin- Default:
""
-
accessControlAllowCredentials
boolean accessControlAllowCredentials- Default:
false
-
needTrustedAuthenticate
boolean needTrustedAuthenticate- Default:
false
-
paramMapping
WebApiParamMapping[] paramMapping- Default:
{}
-
command
CommandConfig command- Default:
@org.iplass.mtp.command.annotation.CommandConfig
-
accepts
RequestType[] accepts- Default:
{}
-
methods
MethodType[] methods- Default:
{}
-
allowRequestContentTypes
String[] allowRequestContentTypes許可するリクエストボディのContentType。デフォルト未指定(=すべて許可)。
accepts指定より、allowRequestContentTypesの指定による制限が優先されます。
例えば、 accepts指定によりJSON形式の処理が有効化されている場合において、 allowRequestContentTypesに"application/json"が含まれない場合は、 JSON形式によるリクエストは処理されません。- Default:
{}
-
maxRequestBodySize
long maxRequestBodySizeリクエストボディの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。- Returns:
- Default:
-9223372036854775808L
-
maxFileSize
long maxFileSizemultipart/form-dataの際のファイルの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。 1つのファイルに対する最大サイズなので、複数のファイルの合計サイズを制限したい場合は、 maxRequestBodySizeを設定します。- Returns:
- Default:
-9223372036854775808L
-
state
StateType state- Default:
STATEFUL
-
supportBearerToken
boolean supportBearerToken- Default:
false
-
oauthScopes
String[] oauthScopes- Default:
{}
-
results
Deprecated, for removal: This API element is subject to removal in a future version.responseResults()
を利用してください。本メソッドは大きなバージョンアップの際に削除する予定です。- Default:
{"result"}
-
responseResults
WebApiResultAttribute[] responseResultsWebAPIの結果に関する属性を設定します。- Returns:
- WebAPIの結果に関する属性
- Default:
{@org.iplass.mtp.command.annotation.webapi.WebApiResultAttribute(name="result")}
-
restJson
RestJson restJson- Default:
@org.iplass.mtp.command.annotation.webapi.RestJson(parameterName="")
-
restXml
RestXml restXml- Default:
@org.iplass.mtp.command.annotation.webapi.RestXml(parameterName="")
-
tokenCheck
WebApiTokenCheck tokenCheckTokenCheck設定
デフォルトではTokenチェックは実行されません。- Default:
@org.iplass.mtp.command.annotation.webapi.WebApiTokenCheck(executeCheck=false)
-
synchronizeOnSession
boolean synchronizeOnSessionこのAction処理をSessionにて同期化するか否か。デフォルトfalse。- Returns:
- Default:
false
-
responseType
String responseType- Default:
""
-
returnStubResponse
boolean returnStubResponseスタブレスポンスを返却するかどうか。true を設定するとスタブレスポンスを返却します。デフォルトの設定値は false です。
スタブレスポンスを返却する場合は、stubDefaultContent()
/stubContents()
を設定してください。注意事項
プロパティに true を設定すると、常にスタブレスポンスを返却することになります。
スタブレスポンスは、WebAPIの実装を行わずに、WebAPIの仕様を確認するために利用されます。
そのため、本プロパティは通常は false に設定されていることを想定しています。
- Returns:
- スタブレスポンスを返却するか。
- Default:
false
-
stubDefaultContent
String stubDefaultContentスタブデフォルトコンテンツ。スタブレスポンスのデフォルト値を設定します。レスポンスには本設定値がそのまま指定されます。
ここに設定する値は、responseType()
で指定された content-type に対応する値を設定してください。
stubContents()
でコンテンツタイプに対応する値を取得できない場合のデフォルト値として動作します。- Returns:
- スタブデフォルトコンテンツ
- Default:
""
-
stubContents
WebApiStubContent[] stubContentsスタブコンテンツ。スタブレスポンスを返却する場合に、コンテンツタイプに応じたスタブレスポンスを設定します。
- Returns:
- スタブコンテンツ
- Default:
{}
-
openApiVersion
String openApiVersionOpenAPI バージョン設定可能な値は
OpenApiVersion
で定義されている seriesVersion の値です(3.0, 3.1 など)。- Returns:
- OpenAPI バージョン
- Default:
""
-
openApiFileType
String openApiFileTypeOpenAPI ファイルタイプ設定可能な値は
OpenApiFileType
で定義されている列挙値の文字列です(JSON, YAML など)。- Returns:
- OpenAPI バージョン
- Default:
""
-
openApi
String openApiOpenAPI 定義- Returns:
- OpenAPI 定義
- Default:
""
-
accessControlAllowOrigin()
を使用してください。