Trying an API - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
Open an API version in Talend Cloud API Tester to test it.

Before you begin

  • You have installed Google Chrome.
  • You have installed the Talend Cloud API Tester extension on Google Chrome. If not, you will be prompted to do so when clicking API Tester.

Procedure

  1. From the Talend Cloud API Designer homepage, open the API version that you want to test.
  2. Click API Tester below the name of your API in the top left corner of the editor.
    A Try in API Tester button is also available in the Live Documentation view.

Results

If this is the first time you try your API, a new project is created in Talend Cloud API Tester. The project name contains the API name and version, you can therefore have separate projects for each version of an API.

The project contains pre-configured requests based on what was described in your API contract. You can now use these requests to build test scenarios for your API.

If you have already tested this API version, your Talend Cloud API Tester test project will be updated with any changes you made on your contract. This means you can iterate on your designs and your tests while keeping everything up to date.