デバッグモードと設計モード

Code Firstとデバッグモード

プロジェクトの初期に、多くの開発者は、開発の効率を考慮して、業務の需要を策定した後に直接にコードの開発を行い、最後の段階でコードからAPI仕様書を生成しています。このはCode Firstの開発モードと言います。

Apidogのデバッグモードは、Code Firstの開発者に向いてます。ビジネス コードがバックエンドで開発された後、APIはデバッグ モードで迅速にテストでき、APIドキュメントはデバッグプロセス中に Apidog によって自動的に生成されます。

デバッグモードは、最初にAPIパラメーターをデバッグし、次にAPIドキュメントを生成することに慣れているチームに適しています。 デバッグモードでは、開発者はAPI内のパラメーターを編集し、変更後にリクエストを直接送信し、保存後にドキュメントを生成するだけで済みます。

Design Firstと設計モード

デバッグモードと比較して、設計モードではAPIの設計の重要性が強調されます。 「設計モード」はAPIデザイン中心の開発モードです。 Design First パターンを採用する R&D チームは、まず API の構造、機能、動作の定義と計画に重点を置きます。 Design First アプローチでは、API が将来的に複数のアプリケーションやサービスに適合する必要がある独立したコンポーネントとして設計されることが強調されています。

設計モードでは、APIの仕様を定義して保存する必要があります。APIの仕様が変更される場合、仕様書も変更してからデバッグを行います。