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?
The most common problem involves the use of variables.
When running in the Apidog local client, the 'current value' of variables, which is sto...
How to create a test scenario in Apidog?
Create a test scenario
Upon opening Apidog, navigate to “Tests” module, and then click the + next to the search bar to create a new test scenario. Sel...
How to pass data between test steps?
In automated testing scenarios, passing data between multiple requests is very common. Typical cases include:
Request 1 is a login request that retur...
Why am I not able to successfully reference pre-step data?
Firstly, make sure you're now in "Tests" module. "Referencing pre-step data" feature is available only in Tests module but not...
How to use foreach loop in Apidog?
When you have an array containing multiple elements (a list of specific content or a list obtained from previous steps), and you need to perform the s...
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.
When importing...
How to use test data in Apidog?
Apidog supports data-driven testing, allowing you to import test data sets in CSV or JSON format and use them within your test requests.
Getting Start...
How to retrive test data in scripts in Apidog?
You can access the test data variables in scripts as shown below:
pm.iterationData.has(variableName:String): function → Boolean: Check whether a test ...
How to run test scenarios in batch in Apidog?
Apidog supports the ability to run multiple configured test scenarios in a batch.
In the Tests module, click on a folder in the left-hand folder tree,...
How to schedule test tasks in Apidog?
You can set up "Scheduled Tasks" to automatically run configured automated test scenarios at specified times, obtain task execution results,...
How to run performance test in Apidog?
:::tip[]The performance testing feature is currently in Beta. If you met any problems, please join the Technical Support Discord and provide your feed...
How can I view the actual requests and responses in the performance tests?
Apidog's performance testing does not provide the ability to view the actual requests and responses.
This is because performance testing focuses o...
How can I export performance test reports in Apidog?
Performance testing is currently in the beta stage, and Apidog does not yet support exporting performance test reports. You can only view the results ...
How to use database query results as parameters for looping API requests?
Apidog supports using database query results as parameters to loop through API requests. You can follow these steps:
In your test scenario, ad...
Capture and Validate Stripe Webhooks in ApiDog During CI/CD
Q: Does ApiDog support listening for Stripe webhooks directly?No, ApiDog does not natively support listening for webhooks. However, you can still vali...
How to resolve the "Error: unable to verify the first certificate on runner" error?
When running Apidog's Runner, if you encounter the "Error: unable to verify the first certificate on runner" error, it's usually bec...
General Runner Docker Container "Not Found" Error.
Q: What is the issue?A: When attempting to run the General Runner Docker container as per the Apidog documentation (https://docs.apidog.com/general-ru...
How to Set the Server Host for the General Runner in Apidog Web Version?
Due to browser security restrictions, the Web version cannot access insecure HTTP from an HTTPS page. As a result, setting the server host for the Gen...
Why Scheduled test scenario endedup with 0 request?
Q: Why did my scheduled test scenario ended up with 0 request?
A: No request was passed through the scheduled tas because the environment set for the ...
What should I do if the file upload parameter cannot be found in Runner or CLI?
Apidog only stores the local file path, not the file itself. Therefore, when running tests using Runner or CLI on different machines, you may encounte...
How to use Runner to run a test scenario with an upload file step?
In Apidog, the file parameters within an endpoint request actually only save the file path (not the file itself). When sending a request, Apidog will ...
How do I resolve the "Error: unable to verify the first certificate on runner" error?
If you encounter an "Error: unable to verify the first certificate on runner" error when running Runner with Apidog, it is usually because R...
How do I access and search the runner logs to identify the issue when a problem arises with a runner?
Use the docker ps command to find the problematic Runner information;
Based on the Runner container ID, run the following command to query valid log...
What should I do if the endpoint parameter is an upload file and cannot be found in Runner or CLI?
Apidog only saves the local path of the file, not the file itself. As a result, when running tests using Runner or CLI on different machines, you may ...
Why Aren't Test Steps Automatically Synchronized When the API Use Case Changes?
If the step is imported from an endpoint use case - and choose how to copyWhen the use case of an endpoint is changed, the steps are not changed, and...
Why Does Using Multiple Dollar Signs in a Markdown Document Cause Some Content to Not Display Correctly?
The Markdown editor used by Apidog parses $xxxxx$ into mathematical formulas. If your content isn't a math formula, but contains multiple $, it ma...
Does the self-hosted Runner generate a test report on the server after executing a task?
The test report will not be stored locally in the Runner, please check it in the client.
Can I add unified pre/post processors to requests in a test scenario?
Yes, Apidog supports configuring unified pre/post processors for test scenarios. Once enabled, all requests within the scenario will automatically exe...
How can I keep dynamic values consistent during a single automated test run?
Dynamic expressions (such as {{$person.fullName}}) generate a new value each time they are called. If you directly assign such expressions to variable...