Skip to main content

Previewing and testing your API definition

Use the Live Documentation and API mock features to get a preview of your API and test it with sample data.

The Live Documentation allows you to generate a preview of your API documentation based on the descriptions and examples provided in your API definition. Once the Live Documentation is enabled, it is automatically updated when a change is made in the API definition. It can be shared with your team or with external users, and you can define a password to secure access to it.

The API mock feature allows you to generate a prototype of your API in order to test your design. It uses sample data based on the values specified in the Examples, Enum and Default fields for each data type.

You can use the API Tester button to generate a test project in Talend Cloud API Tester with requests ready to be sent.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!