Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Automated tests
  • Apidog Support Center
  • Import/Export
    • How to import API data into Apidog?
    • How to import cURL in Apidog?
    • How to migrate Postman environments to Apidog?
    • How to auto - group endpoints on Swagger/OpenAPI import?
  • Sending requests
    • Does Apidog support Socket.IO?
    • Why is the "+" in the parameter value decoded as a space?
    • How to send a request in Apidog?
    • How to send a graphQL request in Apidog?
    • How to send a gRPC request in Apidog?
    • How to send a SOAP/WebService request in Apidog?
    • How to send a WebSocket request in Apidog?
    • Does Apidog support pre-request/test scripts and assertions in WebSocket APIs?
    • How to send a SSE request in Apidog?
    • How to add default headers at the folder level?
    • Does Apidog support pre-request/test scripts and assertions in gRPC APIs?
    • Why am I getting a "socket hang up" error when sending a request?
    • ELANREFUSED.DNS Resolver Error
  • Designing APIs
    • How do I use variables in the path?
    • Can I use a response component as the default response?
    • How to check who has modified an endpoint?
    • How can I bulk delete endpoint folders in Apidog?
    • How can I bulk add/remove prefixes to the path of endpoints?
    • How to move a Property's level in the Schema Editor?
    • If a string property has multiple enumerated values and is used in various locations, how can this enum be consistently referenced throughout?
    • How to get Apidog resource folder ID?
    • How do I get the resource floder ID of Apidog?
    • How do I use variables in a URL path?
    • What should I do if an endpoint, document, or test scenario is accidentally deleted?
    • Does Apidog support request code for custom endpoints?
  • Debugging APIs
    • How does Apidog integrate with third-party key management systems?
    • Why does the same request work correctly in other tools (such as Postman) but not in Apidog?
    • How to fetch variable values from database in Apidog?
    • How to migrate environments from other tools to Apidog?
    • How to assert using scripts in Apidog?
    • JSONPath can only extract arrays. How can we extract a single element from within them in Apidog?
    • How to configure database operations in Apidog when different environments have different database account credentials?
    • How to get service base URL in custom script?
    • Why does Apidog report an error exceeding the maximum Node.js string length when the API response is too large?
    • What is the size limit for console printing?Why do I get an error when printing large files?
    • How to resolve DB2 database connection errors on Windows?
    • How to Generate Dynamic Values in Apidog Custom Scripts?
    • Why does the client request for the same endpoint succeed, but an error occurs when debugging on the web side: "Unable to request address"?
    • Why does Apidog report an error when the response is too large?
    • How do I use the Apidog recording endpoint?
    • When defining an endpoint response, is it allowed for the endpoint to have no response content?
    • How do I get the service baseURL in a custom script?
    • How do I view the original packet in Apidog?
    • How do I make an asynchronous request in an Apidog script?
    • What is the console print size limit? Why Do I Get an Error When I Print a Large File?
    • How do I upload a file on an endpoint request?
    • What to Do If Apidog crashes or Response Data Isn’t Showing ?
  • Mock API data
    • How to mock APIs automatically?
    • What can Apidog mocking do?
    • How to mock fixed API data in Apidog?
    • How to mock conditional data in Apidog?
    • How to enable cloud mock in Apidog?
    • How to enable self-hosted mock in Apidog?
    • Does Apidog support mocking WebSocket APIs?
    • Why Is the Browser Not Returning Content When Requesting the Mock endpoint?
  • Automated tests
    • Why do test scenarios run without issues on my local client, but errors occur when running them in the Apidog CLI or runner?
    • How to create a test scenario in Apidog?
    • How to pass data between test steps?
    • Why am I not able to successfully reference pre-step data?
    • How to use foreach loop in Apidog?
    • What are the differences between sync data from endpoints/endpoint cases?
    • How to use test data in Apidog?
    • How to retrive test data in scripts in Apidog?
    • How to run test scenarios in batch in Apidog?
    • How to schedule test tasks in Apidog?
    • How to run performance test in Apidog?
    • How can I view the actual requests and responses in the performance tests?
    • How can I export performance test reports in Apidog?
    • How to use database query results as parameters for looping API requests?
    • Capture and Validate Stripe Webhooks in ApiDog During CI/CD
    • How to resolve the "Error: unable to verify the first certificate on runner" error?
    • General Runner Docker Container "Not Found" Error.
    • How to Set the Server Host for the General Runner in Apidog Web Version?
    • Why Scheduled test scenario endedup with 0 request?
    • What should I do if the file upload parameter cannot be found in Runner or CLI?
    • How to use Runner to run a test scenario with an upload file step?
    • How do I resolve the "Error: unable to verify the first certificate on runner" error?
    • How do I access and search the runner logs to identify the issue when a problem arises with a runner?
    • What should I do if the endpoint parameter is an upload file and cannot be found in Runner or CLI?
    • Why Aren't Test Steps Automatically Synchronized When the API Use Case Changes?
    • Why Does Using Multiple Dollar Signs in a Markdown Document Cause Some Content to Not Display Correctly?
  • Publish API Docs
    • How to hide all Apidog logos in published documents?
    • When the API spec is updated, will the API doc change?
    • How to share APIs to collaborators in Apidog?
    • How to customize domain of Apidog documentations?
    • How to create multi-version documentation in Apidog?
    • Scope of sharing for Publish Docs Sites in Apidog
    • Scope of sharing for Share Doc list in Apidog
    • Why publlished Share Docs is not showing the hostname?
    • How Can Document Users Modify the Base URL in Shared Docs ?
  • Markdown
    • How to use cards to link to various pages or endpoints within Apidog?
    • Why is some content not displayed correctly when using multiple $ symbols in Markdown documents?
    • How to use transparent background images in Apidog Markdown?
    • How to set the column width of a Markdown table?
  • Branches
    • How to access the sprint branch?
  • Administration
    • How to install Apidog client silently?
    • Why am I seeing a 'No Permission' error despite having admin access?
    • How do I check the runner version number?
    • Does Apidog support win7?
    • Why does Apidog show the error "Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll" after installation?
    • Can I set up a separate billing account for my team in Apidog?
  • Billing
  • On-premises
    • User and Access Management in Apidog Self-Hosted (Enterprise) Version
  • Apidog Europe
  1. Automated tests

What are the differences between 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
How to use foreach loop in Apidog?
Next
How to use test data in Apidog?
Built with