Create a Sprint Branch
In this section, you will learn how to create a sprint branch in Apidog.
After entering the project, click the "New Sprint Branch" button in the branch tab in the upper left corner, and complete the creation after filling in the sprint branch name.
You can also go to "Settings" -> Project Resources in "Manage Sprint Branches" and click the "New Sprint Branch" button on the right side to create it.
Developers can edit three major modules in the sprint branch: APIs, schemas, and response components. In order to make developers more focused on the content that needs to be updated, the newly created sprint branch does not contain any content by default. You can choose to import resources from the main branch or create new resources directly.
For easy distinction, the background color of the sprint branch is light blue.
Seamless API Development: Edit, Create, and Import from Main Branch
Fork From Main
The import function is suitable for APIs in the main branch that need to be modified. Click the "Fork APIs from Main" button in the lower left corner of the page or directly click the "Fork" button on the page to select the specific target API that needs to be modified.
After the import is complete, the API content in the sprint branch is consistent with the main branch. You can modify this page. Updating the request parameters or variables in the sprint branch will not affect the original API in the main branch.
Create New APIs
The create new function is suitable for APIs that need to be developed from scratch in the sprint branch. Click the + button in the menu bar, then click the "Create New API" option to complete the creation.
Check Differences
After editing, you can click the icon on the right side of the API catalog column to click "Compare Differences with Main" to view the changes made to the current API.
Data Models
Data models are reusable "data modeling" that can batch manage the request and response schemas in the API definition.
Import Data Models
The import function is suitable for scenarios where modifications need to be made on the basis of existing data models in the main branch. Click the "Import from Main Branch -> Select Data Model" button in the lower left corner of the page or directly click the "Import Data Model from Main Branch" option on the page to select the data model in the main branch.
Create New Data Models
The create new function is suitable for data models that need to be developed from scratch in the sprint branch. Click the + button in the menu bar, then click "Create New Data Model" to complete the creation.
After importing or creating, you can create and reference schemas when editing API documents in the current branch.
Response Components
The response example of an API is usually divided into success example and failure example. Response components refer to user-defined response schemas. For details, please refer to Components.
Import Response Components
The import function is suitable for scenarios where adjustments and modifications need to be made on the basis of the existing components in the main branch.
Click the "Import from Main Branch -> Select Response Component" button in the lower left corner of the page or directly click "Import Data Model from Main Branch" option on the page to select and import the response component.
Create New Response Components
The create new function is suitable for components that need to be used independently in the sprint branch. Click the + button in the menu bar, then click "Create New Response Component" to complete the creation.
After importing or creating, the APIs in the sprint branch can reference the response components.
