新しいスプリントブランチ

Apidogでプロジェクトを開くと、左上のブランチタブをクリックして「新しいスプリントブランチ」を選択すると、スプリントブランチ名を記入して、簡単に作成できます。

また、プロジェクトの「設定」→「スプリントブランチの管理」に移動して、右上の「新しいスプリントブランチ」ボタンをクリックすることで作成することもできます。

開発者は作成したスプリントブランチで次の3つのコンテンツを編集できます：API、Schema、Responseコンポーネント。

開発者をアップデータ内容により注目させるため、新規作成したスプリントブランチには何のコンテンツも含まれていません。自分のニーズに基づいて、mainブランチから既存リソースをインポートするか、リソースを新規に作成することができます。

ご案内：

より簡単に使い分けるために、スプリントブランチの背景色が「青」に設定されています。

API

APIのフォーク

左下コーナーの「mainブランチからフォーク」をクリックするか、画面中の「フォーク」ボタンをクリックして、mainブランチからAPIをスプリントブランチにフォークできます。

フォークが完了した後、スプリントブランチでのAPIがmainブランチでのものと一致します。そして、スプリントブランチの画面で、APIを開発したり、テストしたりすることができるようにあり、スプリントブランチで何の変更を適用しても、mainブランチでのAPIに影響を出しません。

APIの新規作成

メニューから「＋」ボタンをクリックして、「新しいAPI」を選択することで、スプリントブランチでAPIを新規に作成できます。

違いの確認

編集が完了した後、APIの右側のメニューを展開して、「mainブランチとの比較」を選択できます。

Schema

Schemaのフォーク

Schemaは再利用可能な構造化データで、API仕様のリクエストとレスポンスのデータ構造をバッチ管理することができます。ページの左下にある「mainブランチからフォーク」→「Schema」をクリックするか、ページ中の「mainブランチからSchemaをフォーク」をクリックすることで、フォークしたいSchemaデータを選択します。

Schemaの新規作成

メニューから「＋」ボタンをクリックして、「新しいSchema」を選択することで作成できます。

フォークか新規作成が完了した後、現在のスプリントブランチでAPIドキュメントを編集する時に、そのSchemaを利用することができます。

Responseコンポーネント

APIのレスポンスのサンプルとして、常に成功例と失敗例に分ける必要があります。Responseコンポーネントは、ユーザー自身がカスタマイズしたレスポンスのデータ構造のことを指しています。

ページの左下にある「mainブランチからフォーク」→「Responseコンポーネント」をクリックするか、ページ中の「mainブランチからResponseコンポーネントをフォーク」をクリックすることで、Responseコンポーネントを選択してフォークできます。

Responseコンポーネントの新規作成

メニューから「＋」ボタンをクリックして、「新しいResponseコンポーネント」を選択することで作成できます。

フォークか新規作成が完了した後、現在のスプリントブランチでAPIドキュメントを編集する時に、そのコンポーネントを利用することができます。