Skip to main content

Introduction

This article introduces what is sprint branch and how to use it in Apidog.

In the process of rapid sprint development, maintaining and managing the consistency of API projects is often quite challenging.

Apidog's sprint branch feature aims to provide a flexible API sprint management mechanism, allowing team members to quickly develop new APIs without interfering with other members or affecting published APIs.

info

If you need to create multiple sprint branches, please upgrade to the paid Apidog plan and click to learn the pricing plan.

Application Scenarios​

  • Sprint Development Scenario

    The sprint branch feature can ensure that developers can design and debug APIs in an independent branch without affecting the normal operation of the original API, ensuring that automated testing and continuous integration are not affected by iterative development, keeping the original API in the main branch stable and consistent until the merger of new and old versions is completed.

Key Features of Sprint Branches​

  • Version control

    Each sprint branch can be viewed as an independent version of the API documentation, containing schemas, response components, etc. Data is not affected between branches. You can create corresponding branches for different needs to separate production versions and development versions and ensure the accuracy and consistency of the main branch.

  • Parallel collaboration

    Different roles in the team can work simultaneously on different branches without interference, improving teamwork efficiency and collaboration flexibility.

  • Fast merging

    After completing feature development on the new branch, developers can easily merge the sprint branch back to the main branch, so that the new functionality can be easily embedded into the main branch, eliminating unnecessary risks when updating.

Switch Iterative Branches​

After entering the project, you can click on the Branch tab page on the upper left corner to view and switch the sprint branches in the current project.

You can then continue reading "Creating an sprint Branch".