API Try It!
5min
This feature is available on these plans:
ο»Ώ
βοΈ Starter βοΈ Growing βοΈ Scaling βοΈ Enterprise
ο»Ώ
You can now test your API's directly in the editor or on your published docs with the new API Try It! feature.
How it works
1
Import your API files (direct import or github sync)
2
Configure the API method with the test params
ο»Ώ

ο»Ώ
3
After you update the parameters, the code on the right will also update with the test params you added, providing you the code snippet of the request in several languages
4
Hit the Try it! button
ο»Ώ

ο»Ώ
5
See your API call response in the response area
ο»Ώ

ο»Ώ
Configurations
The new Try It! feature uses the fetch API, so in order for it to work, your API imports need to have the following:
- an absolute path URL to your API (not just a path)
- add in your yml file an URL as follows
servers:
- url: https://petstore3.swagger.io/api/v3 (your actual URL)
- no Authorization token field, as we include that by default in each API page
- CORS disabled or enabled for the documentation domain, so the users can actually test your API
ο»Ώ
Updated 26 May 2023
Did this page help you?
Yes
No