新しく作成されたスプリントブランチには、デフォルトではコンテンツがありません。この方法により、開発者は現在のスプリントに必要な変更に集中できます。主に 2 つの方法でリソースを追加し、変更を加えることができます。アプローチの選択#
| 方法 | 最適な用途 | 主なメリット |
|---|
| 手動変更 | API-First 開発 | 開発前に仕様を明確化できます |
| OAS インポート | Code-First 開発 | メインブランチとの自動比較ができます |
Apidog は、効率の向上とコラボレーションコストの削減のため、API-First アプローチ（手動変更）を強く推奨します。
手動変更#
スプリントブランチ内のコンテンツを手動で変更することで、開発に入る前に API 仕様を明確に定義できます。メインブランチからリソースをフォークする#
現在のスプリント要件に基づいて、既存のエンドポイント、スキーマ、またはレスポンスコンポーネントを変更する必要がある場合は、次のようにします。1.
Fork from main を使用して、必要なリソースのコピーを作成します
3.
インポートされたリソースには関連付けインジケーターが表示されます
メインブランチから最新の変更を取得する#
スプリントブランチで作業している間に、緊急の更新によりメインブランチで直接変更が必要になる場合があります。同期するには、次のようにします。1.
メインブランチ内の関連付けられたリソースが更新されると、通知を受け取ります
3.
更新を取得するか、現在のスプリントブランチのコンテンツを保持するかを選択します
新しいリソースを作成する#
現在のスプリント用に新しいエンドポイント、スキーマ、またはレスポンスコンポーネントを作成するには、次のようにします。1.
New 機能を使用して、現在のスプリントブランチにリソースを追加します
2.
必要な親フォルダーが存在しない場合は、次を使用します。Select Endpoint Folders: 既存のフォルダーを選択します
New Endpoint Folder: 新しいフォルダーを作成します
フォルダーコンテンツの並べ替えと調整#
インポートされたリソースまたは新しく作成されたリソースに対して、メインブランチと同じ操作を実行できます。リソースの削除と復元#
スプリントブランチには、メインブランチと同じように機能するゴミ箱機能があります。同じメインブランチのリソースを繰り返しインポート、削除、復元すると、予期しないデータの問題が発生する可能性があります。データの整合性を維持するため、これらの操作は最小限に抑えてください。
モック、比較、コラボレーション#
スプリントブランチ内のエンドポイントには、そのブランチ専用の固有のモックアドレスがあり、現在のスプリントブランチのエンドポイント定義に完全に依存します。スプリントブランチのリソースをメインブランチの対応するリソースと比較し、具体的な差分を特定します。コラボレーションリンクを使用して、スプリントブランチのエンドポイントを他のプロジェクトメンバーと共有します。別のブランチにいる状態でスプリントブランチのエンドポイントのコラボレーションリンクをクリックすると、システムはブランチの切り替えを促します。切り替える前に、現在のブランチでの変更を保存してください。
OAS インポート#
手動、スケジュール、または API インポート方法を使用して、OpenAPI Specification（OAS）ファイルをスプリントブランチに直接インポートします。スプリントブランチに OAS をインポートする#
1.
左上隅でターゲットブランチが選択されていることを確認します
2.
Project Settings → Import Data に移動します
メインブランチとの自動比較#
OAS をスプリントブランチにインポートする場合の処理ロジックは次のとおりです。1.
OAS ファイル内の各エンドポイントの「Path & Method」をメインブランチと比較します
2.
同一の場合: エンドポイントはインポートされません
3.
異なる場合: エンドポイントはメインブランチに関連付けられ、インポートされます
4.
新規の場合: 新しいエンドポイントがスプリントブランチに作成されます
1.
OAS ファイル内のスキーマ名をメインブランチと比較します
3.
異なる場合: スキーマはメインブランチに関連付けられ、インポートされます
4.
新規の場合: 新しいスキーマがスプリントブランチに作成されます
メインブランチと比較して完全に変更がないリソースは、インポート後にスプリントブランチに含まれません。これにより、開発者は必要な変更に集中できます。
