Skip to main content

Managing APIs via the Console

Viewing API Endpoints​

On the API endpoint management page, you can view, create, edit, and delete API endpoints. This page presents all defined API endpoints in a table format. Each API endpoint contains the following information:

  • ID: Unique identifier.
  • Name: Name of the API endpoint.
  • Root URL: Base URL of the external API.
  • HTTP Headers: HTTP request header information displayed as key-value pairs.
  • Creation Time: Time when the API endpoint was created.
  • Modification Time: Time of the last modification to the API endpoint.

Functions:

  • Create API Endpoint: Click the "Create API Endpoint" button to open a dialog box allowing users to input name, root URL, and header information.
  • Edit API Endpoint: Click the edit button for a specific API endpoint in the table to open a dialog box allowing users to modify the existing API endpoint.
  • Delete API Endpoint: Click the delete button for a specific API endpoint in the table to remove the corresponding API endpoint.
  • View Routes: Click on a row of an ExtAPI in the table, and a drawer will slide out on the right displaying all API routes under that ExtAPI.

Creating and Editing API Endpoints​

In the dialog box for creating or editing an API endpoint, users need to input the following information:

  • Name: Name of the API endpoint.
  • Root URL: Base URL of the external API.
  • HTTP Headers: HTTP request header information displayed as key-value pairs.

HTTP Headers: HTTP request header information, which users can input as multiple key-value pairs. Each header row has a delete button for removing unnecessary headers.

Viewing API Routes​

On the API route management page, you can view, create, edit, and delete API routes. The page presents all defined API routes in a table format. Each API route contains the following information:

  • Name: Name of the API route.
  • Method: HTTP request method, such as GET, POST, PUT, DELETE.
  • Path: API path.
  • Actions: Contains edit and delete buttons.

Page Functions:

  • Create Route: Click the "Create Route" button to open a dialog box allowing users to input name, method, path, and descriptions for path parameters, query parameters, and request body parameters.
  • Edit Route: Click the edit button for a specific route in the table to open a dialog box allowing users to modify the existing route information.
  • Delete Route: Click the delete button for a specific route in the table to remove the corresponding API route.

Creating and Editing API Routes​

In the dialog box for creating or editing an API route, users need to input the following information:

  • Name: Name of the API route.
  • Method: HTTP request method, which users can select from a dropdown menu including GET, POST, PUT, or DELETE.
  • Path: API path, supporting path parameters.
  • Path Parameter Description: Descriptive information about path parameters.
  • Query Parameter Description: Descriptive information about query parameters.
  • Request Body Parameter Description: Descriptive information about request body parameters, supporting JSON format.