メッセージエラーを見つける
Tricentis Tosca API Scan は、以下の2種類のエラーを区別します。
-
ペイロード内のエラー。つまり、特定のリクエストに対してAPIが想定していない情報がペイロードに含まれています。
-
転送情報内のエラー。つまり、システムによるメッセージ送信を完全に妨げるエラー。
ペイロードエラー
ペイロードエラーとは、APIが特定のリクエストに対して予期していない情報のことです。Tricentis Tosca API Scanはメッセージを送信できますが、APIは要求されたタスクを実行できません。
この場合、応答メッセージのステータスバーには以下の情報が表示されます。
-
エラーを示すステータスコード
-
応答時間とコンテンツタイプ
例1:パラメータ情報の欠落
以下のリクエストメッセージには、リソースに変数 {petID} が含まれています。APIがリクエストを実行できるようにするには、「 Params 」タブのパラメータ「 petId 」にこの情報を追加する必要があります。
|
getPetById リクエスト 情報を追加しない場合、APIは応答にエラーメッセージを返します。
getPetById のエラーメッセージ |
例 2: 誤ったパラメータ情報
この例では、新規ユーザーを作成し、それを再度削除します。最初のリクエストメッセージでは、ユーザー Ellaの例が作成されました。
|
createUser のリクエスト APIをさらにテストするには、ユーザーを再度削除します。しかし、ファーストネームのスペルが間違っています。
deleteUser のリクエストでの誤ったペイロード その結果、APIはエラーメッセージを返します。
deleteUser のエラーメッセージ |
転送情報エラー
転送情報は以下の要素で構成されています。
-
メソッド:リクエストに使用されるHTTPメソッド
-
エンドポイント:APIベースURL
-
リソース:このエンドポイントのリソース識別子
転送情報の不具合により、システムがメッセージを送信できません。この場合、ダイアログまたは応答メッセージのステータスバーにエラーが表示されます。
例1:間違ったメソッド
この例は、間違ったメソッドを選択した場合の API Scan のエラー動作を示しています。
リクエスト「 addPet 」は、店舗にペットを追加するように、APIに指示しています。APIは、このリクエストに対して、「投稿」を正しいHTTP メソッドと定義していますが、別のメソッドを選択することもできます。
|
「 メソッド」を「取得 」に変更する 間違った「メソッド」を選択したため、 API Scan はメッセージを送信できません。
エラーメッセージ |
例2:エラーのあるエンドポイント
この例では、リモート関数呼び出し(RFC)をSAPに送信しようとします。しかし、エンドポイントには間違った文字が含まれています。
|
誤った「エンドポイント 」でのRFC呼び出し API Scan では、エラーを示すRFCステータスコードがステータスコードバーに表示されます。 この場合、SAPは接続を拒否しました。
RFCエラーメッセージ |