用語の説明
API設計
APIの仕様(パス、パラメータ、レスポンス値、データ構造)を定義します。つまり、APIの仕様書を作成することになります。
API実行
特定のパラメータを入力して、実行することで、主にAPIのデバッグ(単体テスト)に使われます。APIを実行した後、「APICaseを保存」をクリックして、APICase(ユースケース)を生成できます。その後、パラメータを入力せずに、このAPICaseを直接に参照できます。
ご注意:
Postmanとは異なり、Apidogでは、
API設計
とAPI実行
という2つの概念を区別しています。
- APIの設計:APIの新規作成 画面、またはAPIの「変更」画面で行われます。その目的は、APIの実行ではなく、APIの仕様を定義することになります。
パラメータ名
とパラメータの説明
を定義でき、パラメータ値
を設定できません。パラメータ値、前処理Script/後処理Scriptなどの項目は、 等信息请在APIの実行
ページまたは、APICase
ページで記入してください。- APIの実行:APIの
実行
ページで行われます。その目的は、APIの単体テスト(デバッグ)です。APIを実行すると、APICaseを保存
をクリックして、パラメータ値
、前処理Script
/後処理Script
などの情報を保存できます。そうしないと、タブを閉じた後、これらの情報が消去されます。
APICase
常に1つのAPIにつき、複数のAPICaseが存在しています。例えば、パラメータが正しい、パラメータが正しくない、パラメータが空です など、多数のユースケースがあります。APICaseを実行するときに、レスポンスのデータが自動的に検証されますので、非常に効率的です。
Schema
再利用可能なデータ構造です。APIの返されたデータの構造やRequestのパラメータのデータ構造(JSONとXMLのみ)を定義するときに直接参照できます。
自動テスト
テストのステップを追加して自動テストを実現できます。主に、パフォーマンステスト
、機能テスト
、および対照テスト
が行えます。
Request
PostmanのAPIデバッグ方式に類似し、主な用途はドキュメンテーションを必要としないAPIの単体テストを行うことです。
コード生成
APIとSchemaによって定義されます。主にクライアントコード、サーバースタブ、クライアントSDKを自動生成してくれます。