Skip to main content

API Test FAQ

While running RoostGPT CLI, I get questions, what do they mean?

Please enter the alias name for the api spec: weather.yaml: url1_weather
✔ Do you want to provide the url1_weather_BASE_URL for the api spec: url1_weather: (default: Yes). No
✔ Do you want to provide the url1_weather_AUTH_TOKEN for the api spec: url1_weather: (default: Yes). No
  1. roostGPT supports test generation for multiple API specs. In order to uniquely, alias each api spec there is a default name proposed. It is recommended to just accept that name and proceed
  2. the question around BASE_URL is meant for if the user wants to provide any specific URL to the API server for validating the tests, during the process of generation. You can skip it and roostGPT will spin up a mock API Server, when needed
  3. Question around AUTH_TOKEN or API_KEY arises from the authentication scheme in the provided API Spec. If provided, it will be used while interacting with the API server provided previously and this can be skipped as well, without any impact to the test generation.
  4. If and when a valid API server URL and AUTH token is provided, then it helps validate the tests against a live/real API server instead of a mock server. And this will only affect the internal reports.

Where can I see the generated Postman collection and test data JSON files?

# If running roostGPT locally or through VSCode Extension
# Then switch to your local project folder
cd <LOCAL_PROJECT_FOLDER>
find postman_collections/ -ls

# If running roostGPT with GitOps enabled then look for a PR (Pull Request) in your Git repo

Back to top