Request editor - Cloud

Talend Cloud API Tester User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Tester
Content
Design and Development > Testing APIs
The request editor in Talend Cloud API Tester allows you to define an HTTP request.

Each part of the request is handled by a dedicated area in the editor:

  • HTTP Method
  • URL
  • Header
  • Body

HTTP

The list of the most common HTTP methods is predefined. The TRACE method has not been added since Talend Cloud API Tester relies on the XmlHttpRequest API and its implementation in Chrome does not support the TRACE method.

If you select a method without a body, the body is not editable in the request editor.

You can edit the list of methods in API Tester Settings > HTTP.

URL

The URL is composed of:

  • A scheme (or protocol) used to interact with a server e.g. HTTP or HTTPS.
  • A host and an optional port used to identify the target server.
  • A path used by the server to select the resource that will handle the request.

Header

The header can be edited either as a simple tabular form or as a raw block of text. In the latter case, you have to comply with the syntax of HTTP headers.

Auto-completion is available for the header names, and for the values of the following headers:

  • Accept, Accept-Charset, Accept-Encoding, Accept-Language, Accept-Ranges
  • Allow
  • Expect
  • Cache-Control
  • Content-Encoding, Content-Language, Content-Type
  • Transfer-Encoding

The header Content-Type is automatically set according to the format selected in the body editor. You can still override the preset value.

The header Authorization has a dedicated helper which supports the BASIC authentication scheme. This helper allows you to enter your username and password. It hashes these values according to the specification.

Body

You can manually edit:

  • Simple plain text payloads.
  • JSON, XML and HTML payloads with syntax coloration.
  • Web forms or multipart form payloads (see Web forms specification).

The Format body option allows you to automatically indent the content of the request body for JSON, XML and HTML.

You can also upload files from your drives.

Note: For technical reasons, the file paths are not persisted with your request. This means that you will have to upload the file again after reloading the request and you cannot run such requests using the Maven plugin.