コードファーストの代償
API契約がコードの後から来ると、すべてのチームがその代価を払います。手戻り、認識のズレ、リリース遅延という形で。
終わりのない手戻りサイクル
バックエンドがエンドポイントをリリースします。フロントエンドが期待と異なることに気づきます。両者が書き直します。毎スプリント繰り返します。
バックエンド待ちのフロントエンド
フロントエンド開発者はリアルなエンドポイントを待って何もできない状態になります。JSONファイルで急ごしらえしたモックデータはすぐに古くなります。
後回しにされるドキュメント
API仕様書はリリース後に書かれます。書かれる場合であれば。誰かが読む頃にはもう古くなっています。
ApidogにおけるAPI-Firstワークフロー
まずAPI契約を設計し、あとはツールチェーンに任せましょう。モック・テスト・ドキュメント・コードをすべて単一の信頼できるソースから。
設計 — まず契約を定義する
コードではなくAPI仕様から始めましょう。Apidogのビジュアルエディターを使えば、YAMLの編集なしに完全なOpenAPI準拠でエンドポイント、データモデル、例を定義できます。
- リアルタイムバリデーション付きビジュアルAPIエディター
- 再利用可能なデータモデル
- OpenAPI 3.xとSwagger 2.0を完全サポート
- 設計に対するチームレビューとコメント
モック — フロントエンドのブロックを即時解除
API設計を保存した瞬間、Apidogは完全に機能するモックサーバーを生成します。設定不要です。フロントエンド開発者はすぐにリアルなデータに対してビルドを開始できます。バックエンドへの依存は一切ありません。
- 任意のAPI仕様からゼロ設定でモックサーバーを生成
- フィールド名と型に基づいたスマートなモックデータ
- エッジケース向けのカスタムモックルール
- ローカルとクラウドのモックサーバーオプション
開発 — フロントエンドとバックエンドを並行して
API契約が定義されモックが動いている状態で、フロントエンドとバックエンドのチームは同時に開発できます。バックエンドは仕様に基づいて実装し、フロントエンドはモックに対してビルドします。待機は不要です。
- 10以上の言語でサーバースタブを自動生成
- フロントエンド向けクライアントSDKを自動生成
- デバッグ中の仕様に対するリクエストバリデーション
- 仕様変更時のリアルタイム同期
テスト — リリース前に検証する
API仕様からテストケースを自動生成します。テストコードを手で書くことなく、レスポンスのデータモデル、ステータスコード、データ型のアサーションを実行できます。本番環境に届く前に契約違反を発見します。
- API仕様から自動生成されたテストケース
- データモデルバリデーションとアサーションチェック
- チェーンされたリクエストを使ったシナリオテスト
- Apidog CLIを使ったCI/CDインテグレーション
ドキュメント — 常に最新の状態を保つ
API仕様書は設計仕様から直接生成され、自動的に同期状態を維持します。仕様のあらゆる変更がドキュメントに即座に反映されます。手動でのパブリッシュ手順は永久に不要です。
- 自動生成されるインタラクティブなドキュメント
- すべてのエンドポイントで「Try It Out」が利用可能
- API Hubまたはカスタムドメインへの公開
- ガイドとチュートリアルのためのMarkdownページ
1つの仕様がすべてを動かす
Apidogでは、API仕様は単なるドキュメントではありません。開発ワークフロー全体を駆動するエンジンです。
ビジュアルAPI設計
ビジュアルエディターでエンドポイント、データモデル、例を設計します。YAMLやJSONを手で編集することなく完全なOpenAPI準拠を実現。
ゼロ設定モックサーバー
すべてのAPI設計が即座に動作するモックサーバーになります。スマートなモックルールがフィールドの型と名前に基づいてリアルなデータを生成します。
仕様ドリブンテスト
仕様からテストケースを自動生成します。テストコードを書かずにレスポンスのデータモデル、ステータスコード、データ型を検証できます。
常に生きているドキュメント
仕様から生成されリアルタイムに更新されるドキュメント。インタラクティブな「Try It Out」でコンシューマーがエンドポイントを直接テストできます。
コード生成
API設計から10以上の言語でサーバースタブとクライアントSDKを直接生成します。ボイラープレートを減らして素早くリリースしましょう。
すべてが同期し続ける
仕様を一度変更するだけで、モック・テスト・ドキュメント・コードがすべて自動的に更新されます。単一の信頼できるソース、ドリフトはゼロ。
コードファースト vs. APIファースト
コードファーストアプローチ
- バックエンドがエンドポイントをビルドし、フロントエンドが後から不一致を発見
- バックエンドがリアルなAPIをデプロイするまでフロントエンドはブロックされる
- 静的なJSONファイルに急ごしらえされたモックデータ
- リリースの数週間後に書かれるドキュメント（書かれる場合であれば）
- 契約変更が複数スプリントの手戻りを引き起こす
- 開発が「完了」した後にテストが始まる
ApidogでAPIファースト
- 契約を事前に合意 — 両チームが同じ仕様に基づいてビルド
- フロントエンドは自動生成されたモックサーバーですぐに開始
- スマートなモックが仕様からリアルなデータを生成 — ゼロ設定
- ドキュメントが自動生成され常に最新の状態を維持
- 仕様変更がモック・テスト・ドキュメントに即座に反映
- Day 1から仕様ドリブンのアサーションでテストが統合される
#1 最も使いやすいAPI開発ソフトウェア
G2（世界No.1のB2Bソフトウェアレビュープラットフォーム）の実際のユーザーによる評価。
誰が最も恩恵を受けるか
“新機能をビルドしているが、バックエンドのAPIはあと2スプリントは準備できない。今すぐ開発を進める何かが必要だ。”
合意されたAPI仕様に一致するリアルなデータを返す自動生成モックサーバーに対して、すぐにビルドを開始できます。
“エンドポイントをビルドしてもインテグレーション時にフロントエンドから「期待と違う」と言われるのに疲れた。”
事前にAPI契約を一緒に定義しましょう。コードの1行が書かれる前に両者が仕様に合意します。
“フロントエンドとバックエンドが並行して作業できないため、チームのリリースサイクルが遅い。毎スプリントにインテグレーションの山場がある。”
真の並行開発を実現することでリリースサイクルを短縮します。フロントエンドとバックエンドが同じ契約に基づいて独立してリリースできます。
世界のトップブランドからの信頼