Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Settings tab allows you to modify the API ID, name and description if required.

NameDescription
IDThe API connector ID.
NameThe name of the API connector.
DescriptionThe description of the API connector.
LogoAssign a logo for the API connector.
Debug ModeShow relevant debug in the server log for debugging purposes.

Preview

The Preview tab allows you to view the API endpoint before publishing it.

NameDescription
Select Operation

Select an API endpoint.

Depending on the operation selected, you will preview:

id

Available with the GET and DELETE methods. Specify the ID of the item to fetch or delete.

PayloadAvailable with the POST and PUT methods. The structure of the API in JSON or YAML format. You can add many more details, like authentication methods, request parameters, query parameters, or more complex schemas.
Description

The API endpoint description.