Anatomy of the Swagger API Modal

A. Top Menu

• Back Button (←): Takes you back to the Datasources screen.
• Data Source Name: Displays the name of the Swagger API data source you created (e.g., userguideswagger). Use the dropdown arrow next to it to switch between data sources, or the pencil icon to edit the name.
• CREATE Button: Saves the connection settings and closes the screen.

B. 01 Endpoint

Contains the service information that Kuika will connect to.

• Swagger URL (required): This is the URL of the Swagger API’s JSON definition file. Example: https://petstore.swagger.io/v2/swagger.json
• Service base URL (required): The API’s base service URL. Example: https://petstore.swagger.io/v2

Hover over the (i) icons next to the fields to view descriptions of the fields.

C. 02 Authentication

Determines how Kuika will authenticate itself to the API.

• Authentication type: This field allows you to select the authentication type for API access. Options include No Auth, Bearer, Basic, and API Key.
• Header Table: Consists of the Type, Key, and Value columns. The required rows are automatically added to the table based on the selected authentication type. You can define optional additional fields using rows of the Custom type.

D. Right Panel

• Description: This is the field where you can add notes about the Swagger API.
• Learn More: You can access the relevant documentation via the Swagger API user guide link.
• After You Create: This indicates that clicking the CREATE button saves the link and closes this screen.