Apidog コラボレーションワークフロー

この記事では、Apidog における API コラボレーションワークフローのベストプラクティスを紹介します。

ベストプラクティス

API ドキュメントの草案作成: API 設計者が Apidog で初期の API ドキュメントを作成します。

共同レビュー: フロントエンドとバックエンドの開発者が協力してドキュメントをレビューし、API のユースケースについての整合性を確認します。

Mock データを使った開発開始: フロントエンド開発者は、Apidog の API ドキュメントに基づいて自動生成された Mock データを使用して開発を開始できます。これにより、手動で Mock ルールを作成する必要がなくなります。

API ユースケースを使ったデバッグ: バックエンド開発者は、開発中に API をデバッグします。すべてのユースケースがデバッグを通過した時点で、API 開発が完了したと確認されます。開発中に行われた変更は自動的に API 仕様に反映され、タイムリーかつコスト効率の良い API メンテナンスを実現します。

関数の保存: デバッグが完了したら、バックエンド開発者はリクエストをエンドポイントケースとして保存できます。

API テスト: QA エンジニアは、事前に定義されたエンドポイントケースを使用して直接 API をテストできます。

統合テスト: すべての API が開発された後、QA エンジニア（またはバックエンド開発者）はテストコレクション機能を利用して、複数の API を統合した包括的なテストを実施し、API 呼び出しプロセスがスムーズに機能することを確認します。

共同デバッグ: フロントエンドとバックエンドの開発が完了し、フロントエンド開発者が Mock データから実際のデータに切り替え、API 仕様に忠実に従うことで、スムーズな共同デバッグが行われます。

Apidog コラボレーションワークフロー

ベストプラクティス#

ベストプラクティス