Creating an API
Create an API with the following steps:
Setting Basic Information
- In the navigation pane, choose API Publishing > APIs.
- Click Create API and set the basic information.
Table 1 Setting basic information Parameter
Description
Name
API name. It is recommended that you enter a name based on naming rules to facilitate search.
API Group
By default, the group created in Creating an API Group is selected.
Gateway Response
Select a response to be displayed if APIG fails to process an API request.
The default gateway response is default.
Visibility
By default, Public is selected.
Security Authentication
API authentication mode. Set this parameter to App.
Simple Authentication
If you enable this option, APIG verifies only the AppCode and the request signature does not need to be verified. For this example, enable simple authentication.
Tag Name
Classification attribute used to quickly identify the API from other APIs.
Description
Description of the API.
- Click Next.
Defining API Request
- On the Define API Request page, set the request information.
Table 2 Parameters for defining API requests Parameter
Description
Domain Name
The subdomain automatically allocated to the API group created in Creating an API Group.
Protocol
Request protocol of the API. Set this parameter to HTTPS.
Path
The path for requesting the API.
Matching
By default, Exact match is selected.
Method
Request method of the API. Set this parameter to POST.
CORS
For this example, disable this option.
- Click Next.
Defining Backend Service
- On the Define Backend Request page, set the backend service information.
- Select a backend service type. For this example, select HTTP/HTTPS.
Table 3 Parameters for defining an HTTP/HTTPS backend service Parameter
Description
Protocol
Set this parameter to HTTP.
Method
Request method of the API. Set this parameter to POST.
VPC Channel
Determine whether the backend service will be accessed using a VPC channel. For this example, select Skip.
Backend Address
Address of the backend service.
Path
Path of the backend service.
Timeout
Backend service request timeout. Default value: 5000 ms.
- Click Next.
Defining Responses
- On the Define Response page, set the responses.
Table 4 Defining responses Parameter
Description
Example Success Response
An example of a response returned when the API is called successfully.
Example Failure Response
An example of a response returned when the API fails to be called.
- Click Finish.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
