ブランチでAPIの設計

新しく作成されたスプリントブランチには、デフォルトでは何も含まれていません。このアプローチにより、開発者は現在のスプリントで必要な変更に集中できます。スプリントブランチ内でリソースを追加し、変更を加える主な方法は2つあります。

手動変更: Apidogでリソースを手動でインポートまたは作成し、必要な変更を加えることができます。この方法は、APIファースト開発アプローチを採用しているチームに最適で、Apidogはその効果を高く評価しています。

OASインポート: 代わりに、OpenAPI仕様（OAS）をスプリントブランチに直接インポートすることもできます。インポートプロセス中、ApidogはOASの内容をメインブランチのAPIと自動的に比較し、関連するリソースや新しいリソースを生成します。また、変更されたOASを同じスプリントブランチに複数回インポートして、内容を更新することもできます。この方法は、コードファースト開発アプローチを好むチームに最適です。

特定のシナリオと要件に最も適した方法を選択してください。1つのスプリントブランチでの変更は、そのブランチのデータにのみ影響し、メインブランチや他のブランチには影響しません。

手動変更

スプリントブランチ内で手動で内容を変更することを強く推奨します。この方法では、リソースを手動で選択または作成することで、開発に着手する前にAPI仕様を明確に定義でき、効率が向上し、コラボレーションコストが削減されます。

メインブランチからリソースをフォークする

現在のスプリントの要件に基づいて既存のAPI、スキーマ、またはレスポンスコンポーネントを変更およびアップグレードする必要がある場合、Fork from mainを使用して、必要なリソースのコピーを現在のスプリントブランチに作成します。

Apidog Importing Resources from Main Branch

リソースをインポートすると、その親フォルダも自動的に現在のスプリントブランチのフォルダにインポートされ、正確なフォルダ階層が保証されます。メインブランチからインポートされたリソースは、フォルダ内で関連付けを示す表示がされます。

現在、APIケースはデフォルトでAPIと一緒にスプリントブランチにインポートされます。同様に、インポートされたAPIケースもフォルダ内で関連付けを示す表示がされます。

メインブランチから最新の変更をプルする

スプリントブランチで作業中に、緊急のリクエストによりライブAPIを即座に更新する必要が生じることがあります。その場合、メインブランチで直接変更を行う必要があるかもしれません。これにより、更新されたメインブランチとスプリントブランチの間に不一致が生じる可能性があります。これを解決するために、メインブランチから最新の変更をスプリントブランチにプルして同期することができます。

スプリントブランチに関連付けられたメインブランチのリソースが更新された場合、スプリントブランチでそれらのリソースにアクセスすると明確な通知が表示されます。

通知をクリックすると、変更を確認し、メインブランチから更新をプルするか、現在のスプリントブランチを保持するかを選択できます。

確認後、必要な内容を選択し、更新を確定します。このプロセスにより、スプリントブランチが適切に更新され、メインブランチの更新による競合が解決されます。

新しいリソースを作成する

現在のスプリントのビジネス要件を満たすために新しいAPI、スキーマ、またはレスポンスコンポーネントを作成する必要がある場合、New機能を使用してこれらの新しいリソースを現在のスプリントブランチに追加します。

Apidog Creating New Resources in Sprint Branch

スプリントブランチでの作成機能は、メインブランチと同じように機能します。スプリントブランチ内の任意のフォルダにリソースを作成できます。新しいリソースに必要な親フォルダがスプリントブランチに存在しない場合は、Select Endpoint FoldersまたはNew Endpoint Folder機能を使用して必要な親フォルダを作成してから、必要なリソースを作成できます。

Select Endpoint Folders: Apidog Select Endpoint Folders

New Endpoint Folder: Apidog New Endpoint Folder

フォルダ内容の並べ替えと調整

スプリント中に、現在の要件を満たすためにリソースの順序を変更したり、既存または新しいフォルダの内容を変更したりする必要があるかもしれません。スプリントブランチでは、インポートまたは新しく作成されたリソースに対して、メインブランチと同じ操作を実行できます。これには、APIの順序変更や親フォルダ設定の変更が含まれます。フォルダツリー内の項目をドラッグしてAPIの順序を調整し、整理された構造を維持します。

ドラッグによるAPI順序の調整: