ベストプラクティス
利用シーン
ApidogはAPIの設計、管理、開発、テストに対応可能なAPIライフサイクル管理ツールです。開発チーム全員は、このツールを利用できますが、主にフロントエンド開発者、バックエンド開発者及びテストエンジニアに利用されています。
- フロントエンド開発
- API仕様書の管理
- APIのデータモック
- APIの単体テスト（デバッグ）
- フロントエンド用コードの自動生成
- バックエンド開発
- API仕様書の管理
- APIの単体テスト（デバッグ）
- APIテスト自動化
- バックエンド用のコードの自動生成
- テストエンジニア
- APIの単体テスト（デバッグ）
- APIテスト自動化
ベストプラクティス
- フロントエンド開発者(またはバックエンド開発者)は、ApidogでAPIドキュメントを起草します。
- フロントエンドとバックエンドの開発者は協力してドキュメントを確認および改善し、APIユースケースについて合意形成します。
- フロントエンド開発者は、Mockルールを手動で書くことなく、ApidogのAPIドキュメントに基づいて自動的に生成されたMockデータを使用して開発を開始できます。
- バックエンド開発者は、開発中にAPIユースケースを使用してデバッグできます。すべてのAPIユースケースが合格次第、API 開発は完了です。開発中にAPIに変更がある場合、APIドキュメントはデバッグ中に自動的に更新され、0コストでもAPIメンテナンスの実効性を保証できます。
- デバッグ後、バックエンド開発者は関数を直接にAPIユースケースとして保存できます。
- QAエンジニアは、APIのユースケースを使用してAPIを直接にテストできます。
- すべてのAPIが開発された後、QAエンジニア(またはバックエンド開発者)は、テストのコレクション機能を利用してマルチAPI 統合テストを実施し、API 呼び出しプロセスを徹底的にテストできます。
- フロントエンドとバックエンドの開発が完了し、フロントエンド開発者がMockデータから実際のデータに切り替える時点にフロントエンドとバックエンド開発者の両方もAPI 仕様に完全遵守している場合、共同デバッグは非常にスムーズに進みます。
基本概念の説明
- APIの設計：ApidogのAPIドキュメントは、 OpenApi 3.0 (以前はSwagger) と JSON Schema の使用に準拠し、 便利なビジュアルドキュメント管理機能を提供します。これは、開発者にとって0 学習コストを意味します。また、APIドキュメントのオンライン共有もサポートしています。
- APIの実行： 特定のAPIのパラメータを入力して実行すること、主にAPIのデバッグ（単体テスト）のために使われます。APIを実行した後、
APICaseを保存をクリックすると、APICaseを生成できます。その後、パラメータを入力せずに、このAPICaseを直接に参照して利用できるので、非常に便利です。 - APICase：APIには通常、多数のユースケース（パラメータのユースケースが正しいか、正しくないか、空であるか、パラメータの状態が異なるなど）があります。ApidogのAPIケース機能は、ユースケースを実行するときに、データの正確性の確認が自動的に開始されるので、デバッグすることは非常に効率的です。
- Schema：再利用可能なデータ構造です。APIのレスポンスの構造とリクエストパラメータのデータ構造を定義する場合、直接にSchemaを利用できます。
- コレクションテスト：複数のAPIの一括テストです。主に機能性テスト、対照テスト、パフォーマンステストが実現されます。
- クリックリクエスト：Postmanのリクエストの単体テストのようなものです。主にドキュメント化が必要でないAPIの単体テストを行うために利用されます。クイックリクエストを利用するために、APIを事前に定義する必要がありません。
- コード生成：API 及びデータモデルの定義に基づいて、システムは自動的に
API requestコード,フロントエンドコードとバックエンドコードを生成します。
ご注意：
Postmanとは異なり、Apidogでは、
API設計とAPI実行という2つの概念を区別しています。
- APIの設計：APIの新規作成 画面、またはAPIの「変更」画面で行われます。その目的は、APIの実行ではなく、APIの仕様を定義することになります。
パラメータ名とパラメータの説明を定義でき、パラメータ値を設定できません。パラメータ値、前処理Script/後処理Scriptなどの項目は、 等信息请在APIの実行ページまたは、APICaseページで記入してください。- APIの実行：APIの
実行ページで行われます。その目的は、APIの単体テスト（デバッグ）です。APIを実行すると、APICaseを保存をクリックして、パラメータ値、前処理Script/後処理Scriptなどの情報を保存できます。そうしないと、タブを閉じた後、これらの情報が消去されます。