More than 5 years have passed since last update.

APIConnect 入力チェック-基本編

Last updated at 2019-06-09Posted at 2019-06-09

はじめ

IBM API Connectでは、事前定義したスキーマベースの入力チェックが可能です。
しかし、マニュアル等には具体的にどのようなチェックが可能なのかは明記されていません。

そこで今回は、この入力チェック機能の基本的な使い方をご紹介します。

なお、今回作成するAPI定義は、以下からダウンロードできます。
https://github.com/yo24/APIC-Validate

IBM CloudのAPI Connectサービス(2019年6月時点)を利用します。

API Connectの入力チェックを行うためには、スキーマ定義が必要です。
まずは、設計タブの「定義」で、スキーマを定義します。

まずは定義を新規追加します。名前は下図の通りとしていますが、任意でOKです。

次に、プロパティーを追加し、スキーマ内の項目を定義します。
本記事では、以下のように定義してみました。

次に、先ほど作成したスキーマ定義を、APIのメソッド+パスに紐付けます。
まずは、パスの定義から行います。
今回は、パスに「/」、メソッドに「POST」を設定しています。

次に、メソッド(例ではPOST)を選択し、パラメーターを追加します。
今回、JSONデータを送信したいので、場所は「本文(分かりづらいですがHTTP Bodyと思えばOK)」、タイプに先の手順で追加したスキーマ定義を指定します。

次に、アセンブル(API動作)を定義します。
妥当性検査ポリシーを配置し、ポリシーの「定義」で、先に作成したスキーマ定義を選択します。

アセンブルのテスト機能を有効にします(操作方法が分からない場合はここを参照してください)。
次に、操作(POST /)を選択すると、リクエストデータの入力項目が現れます。

ここで、生成を選択すると、スキーマ定義で入力した「例」に沿って、データを生成してくれます。

ひとまず、この状態でAPIを実行してみましょう。
データは正しいので、HTTPステータスコード=200で応答されます。
レスポンスは、アセンブルで何も処理していないので、送信データがそのまま設定されます。

次に、入力チェックエラーになるようにリクエストデータを修正してみます。
itemStrを数値に修正してみました。

request

{
  "itemStr": 100,
  "itemInt": 10,
  "itemBool": true,
  "itemDate": "2019-06-09",
  "itemDateTime": "2019-06-09T08:00:00.000+09:00"
}

APIを実行すると、入力チェックエラーとなり、以下のデータがレスポンスされます。

HTTPステータスコード 422 Unprocessable Entityは、サーバーが要求本文のコンテンツ型を理解でき、要求本文の構文が正しいものの、中に含まれている指示が処理できなかったことを表します

先に定義したスキーマ定義で、一通り入力チェックエラーをおこし、結果をまとめたものが下表です。
なお、入力チェックはエラー対象が１項目でもあれば、それ以降のチェックはスキップされます(全項目、まとめて実行するわけではない)。

エラー	httpCode	httpMessage	moreInformation
JSON構文不正	４００	Bad Request	Invalid JSON payload received.
Valueを未設定(Keyのみ)	４００	Bad Request	The body of the request, which was expected to be JSON, was invalid, and could not be decoded. A valid property value was not found.
数値として解釈不可な値(ex.000)	４００	Bad Request	The body of the request, which was expected to be JSON, was invalid, and could not be decoded. The number syntax was invalid.
stringに数値	４２２	Invalid	Validate REST: xa35://tmp/temp_321935:1: [JSV0001] Invalid value type 'integer
Integerに文字	422	Invalid	Validate REST: xa35://tmp/temp_321935:1: [JSV0001] Invalid value type 'string'.
Booleanに文字	422	Invalid	Validate REST: xa35://tmp/temp_321935:1: [JSV0001] Invalid value type 'string'.
Date型に不正な日付	422	Invalid	Validate REST: xa35://tmp/temp_321935:1: [JSV0007] Invalid string: '2019-06-32' does not match pattern '^[0-9]{4}-[0-1][0-9]-([0-2][0-9]
DateTimeに不正な日時	422	Invalid	Validate REST: xa35://tmp/temp_321935:1: [JSV0007] Invalid string: '2019-06-09T08:00:00.000+0' does not match pattern '^[0-9]{4}-[0-1][0-9]-([0-2][0-9]
必須エラー	４２２	Invalid	Validate REST: xa35://tmp/temp_321935:1: [JSV0002] Invalid object: the property 'itemStr' is missing.

今回は、API Connectで入力チェックを実現する方法をご紹介しました。
簡単に実装できる反面、入力チェック内容が限られていたり、エラーメッセージがいまいちだったりするのが残念ですね。

上記のいまいち感をカバーすべく、次回以降、他の入力チェックを実現する方法、エラーメッセージを上書きする方法を紹介したいと思います。