Apidog の APIs モジュールには、インターフェース左下で切り替え可能な 2 つのモード、Design-first Mode と Request-first Mode があります。どちらのモードも同様の機能を提供しますが、インターフェースが異なり、チームごとの異なるワークフローに対応しています。Design-first Mode は Apidog が推奨するモードで、API-Design First アプローチに従うチームに適しています。このモードでは、チームはまず API を仕様化し、その後 API 仕様に基づいて開発とテストを進めます。一方、Request-first Mode は、最初に API 仕様を定義しないチームに最適です。このようなチームは通常、バックエンド開発に注力し、コードを完成させた後に、テストやクライアント側の作業を開始するための API 仕様を作成します。他の人が開発した API を呼び出す必要があるものの、ドキュメントがない場合も、Request-first Mode を使用する必要があります。
Design-First Mode#
Design-first Mode では、API 仕様の編集とリクエストの送信は別々のタブから行います。ユーザーは Edit タブで API 仕様を変更し、Run タブでリ クエストを送信します。この分離は、API アーキテクトと開発者／利用者が明確に異なる役割を持つ、API-Design First アプローチに従うチームに適しています。API アーキテクトはリクエストを送信せずに API 仕様を定義し、開発者は API 仕様を変更せずに API 開発とテストに集中できます。分割されたタブは、このようなチームの利用習慣に合っています。Edit タブでは、API アーキテクトがリクエスト例を指定でき、それらは Run タブでデフォルトのパラメータ値として自動的に設定されます。API 開発者／利用者は、Run タブでパラメータ値やリクエストボディをさらに変更できます。Request-First Mode#
Request-first Mode は、事前に API を指定しないチームに適しています。バックエンド開発者は API 開発に直接取り組み、開発中のデバッグのために API の呼び出しが必要になる場合があります。このモードでは、開発者は最初に API を指定する必要はありません。代わりに、Postman で新しいリクエストを作成する場合と同様に、リクエストを直接入力できます。このインターフェースでは、API 仕様とリクエストパラメータ値を別々に調整する必要なく、パラメータの型、名前、値、ボディの構成要素などを簡単に変更できます。デバッグ が完了して保存されると、リクエストはエンドポイント仕様に自動的に解析されます。パラメータは仕様パラメータおよび例の値に変換され、リクエスト／レスポンスボディはスキーマに解析され、ボディの値はリクエスト／レスポンス例として解釈されます。開発者は要件に基づいて、このエンドポイント仕様をさらに調整・強化できます。モード間の違い#
2 つのモードの主な違いは、Request-first Mode ではリクエストボディがエンドポイントのリクエストボディ例として使用される点です。これに対して、Design-first Mode では、ユーザーはリクエストボディ例に加えて、Run タブで実際のリクエストボディを入力できます。そのため、Run タブのボディセクションは Design-first Mode でのみ利用可能であり、Request-first Mode では表示されません。もう 1 つの違いは、Design-first Mode では、エンドポイント仕様レベル、または実行／エンドポイントケースレベルでプリプロセッサ／ポストプロセッサを追加できる点です。一方、Request-first Mode には Run タブがないため、すべてのプリプロセッサ／ポストプ ロセッサはエンドポイント仕様レベルのものと見なされます。実行／エンドポイントケースレベルのプリプロセッサ／ポストプロセッサは、Request-first Mode では表示されません。 