APIkit REST エラー処理リファレンス
フローの一部で問題が発生すると、エラーの種類を含むメッセージが表示されます。
APIkit for REST エラーの種類
APIkit for REST では、次のエラーの種類が定義されています。
| エラーの種類 | 説明 |
|---|---|
APIKIT:BAD_REQUEST |
Bad request (不正な要求) |
APIKIT:NOT_FOUND |
Resource not found (リソースが見つかりません) |
APIKIT:METHOD_NOT_ALLOWED |
Method not allowed (メソッドが許可されていません) |
APIKIT:NOT_ACCEPTABLE |
Not acceptable (使用できません) |
APIKIT:UNSUPPORTED_MEDIA_TYPE |
Unsupported media type (サポートされていないメディアタイプ) |
APIKIT:NOT_IMPLEMENTED |
Not Implemented (実装されていません) |
APIkit for REST エラー処理
APIkit スキャフォルダーは、最も広く使用されている HTTP 状況コードの応答に基づいてエラー処理コードを生成します。これらのコードは、次に説明されているエラーの種類とメッセージにマップされます。
| 状況コード | エラーの種類 | 応答メッセージ |
|---|---|---|
400 |
APIKIT:BAD_REQUEST |
Bad request (不正な要求) |
404 |
APIKIT:NOT_FOUND |
Resource not found (リソースが見つかりません) |
405 |
APIKIT:METHOD_NOT_ALLOWED |
Method not allowed (メソッドが許可されていません) |
406 |
APIKIT:NOT_ACCEPTABLE |
Not acceptable (使用できません) |
415 |
APIKIT:UNSUPPORTED_MEDIA_TYPE |
Unsupported media type (サポートされていないメディアタイプ) |
501 |
APIKIT:NOT_IMPLEMENTED |
Not Implemented (実装されていません) |
APIkit for REST のエラーの例
次のコードは、HTTP 400 応答のエラーハンドラーを示しています。これを使用して、独自のカスタム状況コードとメッセージを作成できます。
...
<on-error-propagate type="APIKIT:BAD_REQUEST" doc:name="On Error Propagate">
<ee:transform xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
<ee:message>
<ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{message: "Bad request"}]]></ee:set-payload>
</ee:message>
<ee:variables>
<ee:set-variable variableName="httpStatus">400</ee:set-variable>
</ee:variables>
</ee:transform>
</on-error-propagate>
...メインフローは、HTTP 状況コードと、明確で分かりやすい言語で表現された関連メッセージの組み合わせを含む HTTP エラー応答を送信します。この例では、message: "Bad request" です。