Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Branches
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Basic concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Specify a new endpoint
      • Make a request to the endpoint
      • Add an assertion
      • Create a test scenario
      • Share your API documentation
      • Explore more
      • Send a request and save as an endpoint
    • Migration
      • Overview
      • Manual import
      • Scheduled import
      • Import options
      • Export data
      • Import from...
        • Import from Postman
        • Import OpenAPI (Swagger) spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har file
        • Import WSDL
  • Design APIs
    • Overview
    • Create a new API project
    • Endpoint basics
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Configure multiple request body examples
    • Schemas
      • Generate Schemas from JSON etc.
      • Build a schema
      • Overview
      • Create a new schema
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • Advanced features
      • Custom endpoint fields
      • Import endpoints as test steps
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique idenfication
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Endpoint cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Using variables
      • Environments & services
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MongoDB
        • Redis
        • Oracle Client
      • Using scripts
        • Overview
        • Postman scripts reference
        • Pre processor scripts
        • Post processor scripts
        • Public scripts
        • Calling other programming languages
        • Using JS libraries
        • Visualizing responses
        • Script examples
          • Assertion scripts
          • Using variables in scripts
          • Using scripts to modify request messages
          • Other examples
    • Dynamic values Modules
  • Mock API data
    • Overview
    • Smart mock
    • Custom mock
    • Mock priority sequence
    • Mock scripts
    • Cloud mock
    • Self-hosted runner mock
    • Mock language (Locales)
  • Automated tests
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Import endpoints/endpoint cases from other projects
      • Sync data from endpoints/endpoint cases
      • Export test scenarios
    • Run test scenarios
      • Run a test scenario
      • Data-driven testing
      • Run test scenarios in batch
      • Scheduled tasks
      • Manage the runtime environment of APIs from other projects
    • Test APIs
      • Integration testing
      • Performance testing
      • End-to-end testing
      • Regression testing
    • Apidog CLI
      • Overview
      • Installing and running Apidog CLI
      • Apidog CLI Options
    • CI/CD
      • Overview
      • Integrate with Jenkins
      • Integration with Gitlab
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Publish docs sites
    • Folder tree settings
    • Custom layouts
    • Visibility settings
    • Endpoint SEO settings
    • Custom domain
    • Embedding values in document URLs
    • Documentation Search
    • Integrating Google Analytics with Doc Sites
    • CORS Proxy
    • API Versions
      • Overview
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
  • Send requests
    • Overview
    • gRPC
    • Use request proxy agents for debugging
    • SOAP/WebService
    • GraphQL
    • WebSocket
    • Socket.IO
    • SSE debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • HTTP/2
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
      • Save the request as an endpoint
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • Apidog MCP Server
    • Overview
    • Conntect API Specification within Apidog Project to AI via Apidog MCP Server
    • Conntect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Conntect OpenAPI Files to AI via Apidog MCP Server
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
    • Managing Organizations
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Language settings
    • Data backup
    • Network proxy configuration
    • Hot keys
    • Updating Apidog
    • Generate OpenAPI access token
    • Deleting account
    • Account settings
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
  1. Branches

Design API in a branch

In a newly created sprint branch, there is no content by default. This approach helps developers focus on the changes needed for the current sprint. There are two main ways to add resources and make modifications within a sprint branch.
Manual Changes: You can manually import or create resources in Apidog and make the necessary changes. This method is ideal for teams following an API-First development approach, which Apidog highly recommends for its effectiveness.
OAS Import: Alternatively, you can import an OpenAPI Specification (OAS) directly into a sprint branch. During the import process, Apidog automatically compares the OAS content with the endpoints in the main branch, allowing it to generate associatd or new resources. You can also import the modified OAS multiple times into the same sprint branch to update its content. This method is ideal for teams that prefer a Code-First development approach.
You should choose the method that best fits your particular scenario and requirements. Changes in one sprint branch only affect its data and have no impact on the main branch or other branches.

Manual changes#

Manually modifying content within a sprint branch is highly recommended. This method, which involves picking or creating resources manually, helps you define your endpint specifications clearly before diving into development, leading to increased efficiency and lower collaboration costs.

Forking resources from the main branch#

When you need to modify and upgrade existing endpoints, schemas, or response components based on the requirements of the current sprint, use the Fork from main to create a copy of the required resources in the current sprint branch.
Apidog Importing Resources from Main Branch
When importing a resource, all its parent folders will automatically be imported into the current sprint branch folder, ensuring an accurate folder hierarchy. Imported resources from the main branch will be marked with visible association indicators in the folder.
Apidog Importing Resources from Main Branch
Currently, endpoint cases are imported along with the endpoints by default into the sprint branch. Similarly, imported endpoint cases will also have association indicators in the folder.
Apidog Importing Resources from Main Branch

Pulling the latest changes from the main branch#

While working in a sprint branch, urgent requests may occasionally require immediate updates to live endpoints. In such cases, changes might need to be made directly in the main branch. This can result in discrepancies between the updated main branch and the sprint branch. To address this, you can synchronize by pulling the latest changes from the main branch into your sprint branch.
If resources in the main branch associated with the sprint branch are updated, you will receive a clear notification when accessing those resources in the sprint branch.
resources-discrepancies-notification.png
Clicking the notification allows you to review the changes and choose whether to pull updates from the main branch or retain the current sprint branch.
decide-change-updates.png
After reviewing, select the desired content and confirm the update. This process ensures that the sprint branch is updated appropriately, resolving any conflicts caused by main branch updates.

Creating new resources#

When you need to create new endpoints, schemas, or response components to meet business requirements for the current sprint, use the New feature to add these new resources to the current sprint branch.
Apidog Creating New Resources in Sprint Branch
The create feature in the sprint branch functions the same as it does in the main branch. You can create a resource in any folder within the sprint branch. If you find that the required parent folder for your new resource does not exist in the sprint branch, you can use the Select Endpoint Folders or New Endpoint Folder feature to create the necessary parent folder before creating the required resource.
Select Endpoint Folders: Apidog Select Endpoint Folders
New Endpoint Folder: Apidog New Endpoint Folder

Reordering and adjusting folder contents#

During a sprint, you might need to reorder resources or modify the contents of existing or new folders to meet current requirements. In the sprint branch, you can perform the same operations on imported or newly created resources as in the main branch. This includes reordering endpoints or changing parent folder settings. Adjust the endpoint order by dragging items in the folder tree to maintain an organized structure.
Adjusting endpoint order by dragging:
Apidog Reordering and Adjusting Folder Contents
If imported, folders will also display association indicators:
Apidog Reordering and Adjusting Folder Contents
Content in folders can be freely adjusted and modified:
Apidog Reordering and Adjusting Folder Contents

Deleting/restoring resources#

In a sprint branch, you can delete resources at will and see the deleted resources in the Trash where you can choose to restore them. This feature works the same as the trash in the main branch.
Apidog Deleting/Restoring Resources
Repeatedly importing, deleting, and restoring the same main branch resource in a sprint branch can lead to unexpected data issues. To maintain data integrity and avoid potential problems, it's best to minimize these operations whenever possible.

Mocking, comparing, and collaborating on endpoints#

Endpoints in a sprint branch will have a unique mock address specific to that branch. The mock content relies entirely on the endpoint definitions within the current sprint branch, allowing relevant team members to accurately simulate the responses of the modified endpoints for the sprint.
Apidog Mocking, Comparing, and Collaborating on APIs
You can compare a sprint branch resource with its main branch counterpart to identify specific differences between them.
Apidog Mocking, Comparing, and Collaborating on APIs
Sprint branch endpoints can also be shared via collaboration links, which can be sent to other project members for collaboration.
Apidog Mocking, Comparing, and Collaborating on APIs
When you click on a sprint branch endpoint collaboration link while in another branch, the system will prompt you to switch branches to view the endpoint. Be sure to save any changes in your current branch before making the switch.
Apidog Mocking, Comparing, and Collaborating on APIs

OAS import#

You can import OAS (OpenAPI Specification, also known as Swagger Specifications) directly into a sprint branch using various methods, such as manual, scheduled, or API imports.

Import OAS into sprint branch#

To import OAS into the sprint branch, ensure that the target branch is selected in the top-left corner. Then, go to theProject Settings > Import Datapage, and import data into the current branch.
import-OAS-into-sprint-branch.png
If you want to schedule automatic OAS imports into the sprint branch, select the target branch during the creation of the scheduled import.
schedule-automatic-OAS-import.png

Automatic comparison of OAS with the main branch#

When importing OAS into the sprint branch, the processing logic follows these steps:
Identify OAS file content
Compare each endpoint's "Path & Method" in the OAS file with those in the main branch:
If the "Path & Method" matches and the OAS content is identical to that in the main branch, the endpoint won’t be imported into the sprint branch.
If a matching "Path + Method" is found but the OAS content differs from the main branch, the endpoint will be associated with the main branch and imported into the sprint branch.
If no matching "Path + Method" is found, a new endpoint will be created in the sprint branch.
Compare schema name in the OAS file with those in the main branch:
If the schema name matches and the OAS content is identical, the schema will not be imported into the sprint branch.
If a matching schema name is found but the OAS content differs, the schema will be associated with the main branch and imported into the sprint branch.
If no matching schema name is found, a schema will be created in the sprint branch.
If the import is successful, you will see an overview of the new and modified resources added to the sprint branch.
OAS-import-logic.png
In line with Apidog's goal of helping developers focus on the necessary changes for each sprint, any resources that are found to be completely unchanged compared to the main branch will not be included in the sprint branch after the import.
Modified atΒ 2024-12-17 07:33:46
Previous
Test APIs in a branch
Next
Merge sprint branches
Built with