概要
動画ガイド
前提条件
1.
2.
3.
Pet Store プロジェクト
開発モデルの選択
| モデル | 説明 | 最適な用途 | ワークフロー |
|---|---|---|---|
| Design-first | 実装前に API 仕様を定義します | 計画とドキュメントを重視するチーム | 仕様 → リクエスト → テスト → 共有 |
| Request-first | 実際のリクエストから API を構築してテストします | アジャイルチーム、プロトタイピング、ドキュメント化されていない API | リクエスト → 仕様 → テスト → 共有 |
Design-first モデル
新しいエンドポイントを指定する
パス、メソッド、パラメータ、レスポンスを使用して API エンドポイントを定義します。これにより、API 仕様の基盤が作成されます。
パス、メソッド、パラメータ、レスポンスを使用して API エンドポイントを定義します。これにより、API 仕様の基盤が作成されます。
Design-first モードに切り替える
Apidog インターフェースの左下隅で「Design-first」モードを選択し、エンドポイントの設計を続行します。
Apidog インターフェースの左下隅で「Design-first」モードを選択し、エンドポイントの設計を続行します。
エンドポイントにリクエストを送信する
実際のリクエストを送信して、定義したエンドポイントをテストし、設計を検証します。
実際のリクエストを送信して、定義したエンドポイントをテストし、設計を検証します。
アサーションを追加する
API レスポンスが期待される条件を満たしていることを確認するための自動チェックを設定します。
API レスポンスが期待される条件を満たしていることを確認するための自動チェックを設定します。
テストシナリオを作成する
複数のエンドポイントとユースケースをカバーする包括的なテストスイートを構築します。
複数のエンドポイントとユースケースをカバーする包括的なテストスイートを構築します。
API ドキュメントを共有する
フィードバックと統合のために、API ドキュメントを公開し、関係者と共有します。
フィードバックと統合のために、API ドキュメントを公開し、関係者と共有します。
高度な機能を確認する
環境、スキーマ、コラボレーションツールなど、Apidog の機能をさらに詳しく確認します。
環境、スキーマ、コラボレーションツールなど、Apidog の機能をさらに詳しく確認します。
Request-first モデル
リクエストを送信する
既存のエンドポイントをテストまたは調査するために API 呼び出しを実行します。
既存のエンドポイントをテストまたは調査するために API 呼び出しを実行します。
Request-first モードに切り替える
Apidog インターフェースの左下隅で「Request-first」モードを選択します。
Apidog インターフェースの左下隅で「Request-first」モードを選択します。
アサーションを追加する
API の信頼性と正確性を確保するために、自動検証ルールを実装します。
API の信頼性と正確性を確保するために、自動検証ルールを実装します。
テストシナリオを作成する
実際の API インタラクションをシミュレートする包括的なテストスイートを開発します。
実際の API インタラクションをシミュレートする包括的なテストスイートを開発します。
API ドキュメントを共有する
チームやパートナー向けに、プロフェッショナルな API ドキュメントを生成して配布します。
チームやパートナー向けに、プロフェッショナルな API ドキュメントを生成して配布します。
高度な機能を確認する
Apidog のテスト、コラボレーション、自動化ツールの全機能を確認します。
Apidog のテスト、コラボレーション、自動化ツールの全機能を確認します。
モードの切り替え
Modified at 2026-06-11 07:06:02