All Products
Document Center

1. Operation Instructions

Last Updated: May 08, 2018

On the API gateway, you need to create a group before creating an API. A group may contain multiple APIs. In other words, a service can be encapsulated into a group. The multiple functional interfaces in a service are the APIs in the group.

The following uses the configuration process for an API as an example so that you can clearly understand how to open an API and connect the API to the API gateway.

Assume that a service is to be opened on the data marketplace.

  • Service name: open API service information query
  • Service description: You can call an API to query the list of open APIs and their details.

Example 1: Without dynamic parameters in Path

RPC frontend/backend mapping

Example 2: With dynamic parameters in Path

ROA frontend/backend mapping

Flexible frontend/backend mapping:

Frontend: indicates the part where an API request goes from your client to the gateway when you call the API.

Backend: indicates the part where an API request, after arriving at the gateway, passes through the gateway and reaches the actual backend service.

  • The backend host is different from the frontend domain name.
  • The backend path is different from the frontend path.
  • Positions and names of the parameters input by a customer are different from those of the parameters received by the actual backend service (note that, in the frontend and backend, the request body can only be binary or form).

    The API gateway can perform comprehensive frontend/backend mapping.

The basic process for configuring parameters in the preceding example is as follows (example 2 is used as an example):

  1. Frontend configuration

  2. Backend configuration