Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Test scenarios
  • 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
      • Overview
      • Create a new schema
      • Build a schema
      • Generate Schemas from JSON etc.
    • 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
  • Data & Security
    • Where is Apidog's data stored, and how is data security ensured?
    • How is user data stored? Will this data be public? Or will it be private? Will all data be stored in the cloud?
    • When sending requests, do they go through the Apidog server? Is data security ensured?
  • 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. Test scenarios

Sync data from endpoints/endpoint cases

For test steps imported from endpoints/endpoint cases, their request data can be synchronized with the associated endpoint spec/cases.
Sync Data
When importing endpoints/endpoint cases into test steps, you can choose Manual or Automated mode.
The Manual mode is suitable for scenarios where multiple people collaborate, meaning that in a project, the endpoint specification, development, and testing processes all have a clear division of labor and each process has a dedicated person in charge. These processes require data independence to avoid unintended changes affecting each other. After ensuring the stability of the endpoint spec/case data, the tester can manually synchronize it with the test steps.
The Automated mode is suitable for small teams or independent developers, meaning that in a project, the endpoint specification, development, and testing processes are all handled by a single role, improving the efficiency of endpoint maintenance and testing. When the endpoints/endpoint cases in "Endpoint Management" change, the endpoint/endpoint case data in the test steps will also be adjusted accordingly, ensuring data consistency between "Endpoint Management" and "Automated Testing".
Sync Mode

Sync relationship#

Test step import methodAssociated dataTest step sync modeSync content
Imported from endpoint - Manual modeEndpoint SpecManual mode (click "Update" button in test steps)βœ… Changes in "parameter name", "Path", "Method", "pre/post-actions", etc.

❌ "Parameter values".
Imported from endpoint - Automated modeEndpoint SpecAutomated mode (when endpoint spec is updated and saved)βœ… Changes in "parameter name", "Path", "Method", "pre/post-actions", etc.

❌ "Parameter values".
Imported from endpoint case - CopyEndpoint SpecManual mode (click "Update" button in test steps)βœ… Changes in "parameter name", "Path", "Method", "pre/post-actions", etc.

❌ "Parameter values".
Imported from endpoint case - ReferenceEndpoint CaseAutomated mode (when endpoint case is updated and saved)βœ… Reference endpoint case data, any changes in the endpoint case will affect the content of this test step.

Manual sync mode#

When the Manual mode is selected, the associated button will appear in "blue". When there are any changes in the endpoint spec in the "Endpoint Management", the data in the test steps will not be updated in real-time. Testers can manually click the "Update" button in the "Test Steps" details to synchronize the changes from the endpoints/endpoint cases to the test steps.
This mode is suitable for testing scenarios where testers have a large number of requests for fine-tuning the request parameters, avoiding unintended influences on these test data and ensuring isolation between test data and data from the endpoints being developed.
Manual Sync
Sync Data
In Manual mode, the dropdown menu of the associated button also supports manually filtering the scope of data synchronization.
Filter Sync

Sync endpoint specs#

For test steps generated by importing Endpoint β†’ Manual update or importing from an endpoint case β†’ Copy, the associated content is the endpoint spec. These test steps can be synchronized with the endpoint spec content by clicking the "Sync Now" button on the page.
After triggering a manual sync, the test step will synchronize data from the endpoint spec, including "parameter name", "pre/post-scripts", etc. Note that the sync object is the endpoint spec, and if the request parameters in the endpoint spec do not have sample values set, the synchronized content will not include "parameter values".
Saving and updating the data in "Endpoint Spec" will not affect associated test steps.
Sync Endpoint spec
Clicking the "Update" button in the test step will trigger the data synchronization mechanism, and the button will indicate "Synced". After confirming that the synchronized data is correct, you need to click the "Save" button in the upper-right corner to save the test step.
Save Sync

Batch sync data#

If most of the data in the current test steps are using the Manual mode, and the tester has confirmed that the data in these endpoint specs/cases is correct and wants to quickly synchronize the data to the test steps, they can click the "Update" button on the test step page to perform a batch sync operation.
Batch Sync

Automated sync mode#

The associated button will appear in orange. As mentioned before, this mode helps solo developers with controlling the flow and keeping track of it by themselves.
Automated Sync

Sync endpoint specs#

For test steps associated with endpoint spec, when the sync mode is set to Auto Sync, if there are changes in the endpoint spec and it is saved, the data will be updated in real-time in the test step. The synchronized content is consistent with the Manual sync mode described before.
Auto Sync Endpoints
In Automated mode, any inconsistencies between the data in the test step and the endpoint spec will be highlighted. Testers can choose to "Revert" to maintain complete consistency with the endpoint spec, or they can choose to "Save to Document", which will overwrite the data in the endpoint spec with the data from the test step to maintain consistency.
Highlight Discrepancies

Sync endpoint cases#

To ensure consistency and uniqueness in managing data for endpoint cases that are referenced in test steps, adjustments should be made to the referenced endpoint case in the "Endpoint Management" system so that both the endpoint cases and test steps utilize the same request data.
After clicking the "Edit" button in the instruction on the test step page, you will be taken to the associated endpoint case page to make adjustments. The test step will automatically synchronize the data after the changes to the endpoint case, including "parameter name", "parameter value", "pre/post-scripts", and all other request content.
Sync Endpoint Cases
Previous
Import endpoints/endpoint cases from other projects
Next
Export test scenarios
Built with