ApidogのAPI管理モジュールには、インターフェースの左下で切り替え可能な2つのモードがあります：「設計優先」と「リクエスト優先」。どちらのモードも類似の機能を提供しますが、インターフェースが異なり、異なるチームのワークフローに対応しています。設計優先はApidogが推奨するモードで、API-Design Firstアプローチを採用するチームに適しています。このモードでは、チームはまずAPI仕様を定義し、その後、仕様に基づいて開発とテストを進めます。一方、リクエスト 優先は、初めにAPI仕様を定義しないチームに最適です。これらのチームは通常、バックエンド開発に集中し、コードを完成させた後にAPI仕様を作成し、テストやクライアント側の作業を開始します。他の人が開発したAPIを呼び出す必要があるが、ドキュメントがない場合も、リクエスト優先モードを使用するべきです。設計優先#
設計優先では、API仕様の編集とリクエストの送信が別々のタブで行われます。ユーザーは変更タブでAPI仕様を修正し、実行タブでリクエストを送信します。この分離は、API-Design Firstアプローチを採用するチームに適しており、APIアーキテクトと開発者/消費者が異なる役割を持っています。APIアーキテクトはリクエストを送信せずにAPI仕様を定義し、開発者はAPIの開発とテストに集中し、API仕様を変更しません。分割されたタブは、そのようなチームの使用習慣に一致しています。変更タブでは、APIアーキテクトがリクエスト例を指定でき、これが実行タブでデフォルトのパラメータ値として自動的に設定されます。API開発者/消費者は、実行タブでパラメータ値やリクエストボディをさらに修正できます。リクエスト優先#
リクエスト優先は、事前にAPIを指定しないチームに適しています。バックエンド開発者は直接API開発に取り組み、開発中にデバッグのためにAPIを呼び出す必要があるかもしれません。このモードでは、開発者は最初にAPIを指定する必要はなく、直接リクエストを入力できます。これはPostmanで新しいリクエストを作成するのと似ています。このインターフェースでは、開発者はAPI仕様やリクエストパラメータ値を別々に調整することなく、パラメータの型、名前、値、ボディのコンポーネントなどを簡単に修正できます。デバッグが完了して保存されると、リクエストは自動的にAPI仕様に解析されます。パラメータは仕様のパラメータと例の値に変換され、リクエスト/レスポンスボディはスキーマに解析され、ボディの値はリクエスト/レスポンスの例として解釈されます。開発者は自分の要件に基づいてこのAPI仕様をさらに洗練し、強化することができます。モード間の違い#
2つのモードの主な違いは、リクエスト優先モードではリクエストボディがAPIリクエストボディの例として使用されることです。対照的に、設計優先モードでは、ユーザーは実行タブで実際のリクエストボディを入力でき、リクエストボディの例と一緒に使用します。したがって、実行タブのボディセクションは設計優先モードでのみ利用可能であり、リクエスト優先モードでは表示されません。もう一つの違いは、設計優先モードでは、API仕様レベルまたは実行/エンドポイントケースレベルで前/後処理を追加できることです。一方、リクエスト優先モードでは、実行タブがないため、すべての前/後処理はAPI仕様レベルと見なされます。実行/エンドポイントケースレベルの前/後処理はリクエスト優先モードでは表示されません。 Modified at 2025-03-28 10:17:44
