1. Homepage
  2. APIkit (4.x)
  3. APIkit for REST

  4. モジュールリファレンス

APIkit for REST Module リファレンス

連動関係、名前空間、スキーマ、および APIkit for REST に関するその他の情報についての基礎を学びます。

APIkit for REST 連動関係情報

<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-apikit-module</artifactId>
  <version>LATEST_VERSION</version> (1)
  <classifier>mule-plugin</classifier>
</dependency>
1 LATEST_VERSION​ を入手するには、 APIkit リリースノート​を確認してください。

APIkit for REST の設定と操作

要素名 説明 必須

apikit:config

APIkit 設定。

はい

apikit:console

API Console URL を定義する api-console フロー内の ​http:listener​ 要素の ​config-ref​ のプロパティ。

いいえ

apikit:router

フロー要素内でネストされた REST ルーティングメッセージプロセッサー。

はい

apikit:config の属性

apikit:config​ 属性は ​NonBlankString​ 型です。

属性名 必須 説明

outboundHeadersMapName

いいえ

応答ヘッダーを含むマップの名前。

httpStatusVarName

いいえ

応答の HTTP 状況コードを保存する変数の名前。

keepRamlBaseUri

いいえ

同等の ​keepApiBaseUri​ 属性の別名。

この属性は、バージョン APIkit 1.2.0 で非推奨になりました。APIkit 1.1.x との互換性を提供するために含まれています。
API 実装では、​keepRamlBaseUri​ の代わりに ​keepApiBaseUri​ を使用します。

name

はい

apikit:router​ などの他の要素が参照する設定名。

raml

はい

同等の ​api​ 属性の別名。

この属性は、バージョン APIkit 1.2.0 で非推奨になりました。APIkit 1.1.x との互換性を提供するために含まれています。
API 実装では、​raml​ の代わりに ​api​ を使用します。

parser

いいえ

要求の検証に使用されるパーサー。

APIkit 1.2.0 以降で有効な属性。

可能な値:

  • AUTO

    APIkit ルーター​は AMF を使用して開始されます。エラーがある場合は、RAML パーサーを使用して開始されます。

  • AMF

    APIkit ルーター​は AMF を使用して API を読み取り、受信要求を検証します。

  • RAML

    APIkit ルーター​は AMF を使用して開始され、エラーがある場合は RAML パーサーを使用して開始されます。

デフォルト値: AUTO。

api

いいえ

ルート API ファイルの場所。

この属性は、APIkit 1.2.0 以降で有効です。

api​ 属性には、​src/main/resources/api​ の下位にあるファイルへの相対パス、または ​API Sync​ リソースパスの任意の URL を使用できます。

keepApiBaseUri

いいえ

APIkit 1.2.0 以降で有効な属性。

false​ に設定すると、API の RAML 定義内の ​baseUri​ が書き換えられます。
true​ に設定すると、​baseUri​ 項目は書き換えられません。

リバースプロキシの背後で APIkit を使用し、​keepRamlBaseUri​ を ​true​ に設定する場合は、​API Console​ を使用してプロキシの URL を​baseUri​ プロパティに設定します。

apikit:router の属性

属性名 必須 説明

disableValidations

いいえ

要求の検証を無効にします。

headerStrictValidation

いいえ

要求ヘッダーが RAML ファイルで定義されているか、既知のヘッダーのセットに属していることを検証します。

queryParamsStrictValidation

いいえ

要求クエリパラメーターが RAML ファイルで定義されていることを検証します。

APIkit for REST の名前空間とスキーマ

xmlns:apikit="http://www.mulesoft.org/schema/mule/mule-apikit"
xsi:schemaLocation="http://www.mulesoft.org/schema/mule/mule-apikit http://www.mulesoft.org/schema/mule/mule-apikit/current/mule-apikit.xsd"

APIkit for REST のシステムプロパティ

システムプロパティ デフォルト 説明 Since (以降)

mule.xml.expandExternalEntities

false

パーサーが XML 外部エンティティを展開できるようにします。攻撃を防ぐため、デフォルト値は ​false​ です。

1.3.7

mule.xml.expandInternalEntities

false

パーサーが XML 内部エンティティを展開できるようにします。攻撃を防ぐため、デフォルト値は ​false​ です。

1.3.7

apikit.console.disabled

false

コンソールを無効にします。

1.3.7

apikit.console.stream.amf.model

true

AMF パーサーモデルをコンソールにストリーミングします。

1.5.0

raml.json_schema.fail_on_warning

false

RAML パーサーが設定されるときに、ペイロードの検証中に ​warning​ があると失敗します。

1.1.15

yagi.json_duplicate_keys_detection

true

RAML パーサーが設定されるときに、重複する JSON オブジェクト項目名がないことを確認します。

1.1.15

yagi.json_block_unsafe_polymorphic_base_types

true

RAML パーサーが設定されるときに、安全でないベース種別の使用をブロックします。

1.5.0

mule.apikit.parser

AUTO

パーサー種別を上書きします。可能な値:

  • AMF

  • RAML

  • AUTO

1.3.7

apikit.multipart.size.limit

268435456

受信したマルチパートペイロードが制限 (バイト単位) を超えた場合に ​InvalidFormParameterException​ をスローすることで、検証されるマルチパートペイロードのサイズを制限します。

1.8.0

fullDomain

localhost

コンソールの URL を上書きします。

1.1.15