- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Manage Service
- Creating APIs
- Managing APIs
- Calling APIs
- Release and Access
- Custom Domain Name and Certificate
- Usage Plan
- Verification and Security
- Log Analysis
- Access Monitoring
- Key Management
- API Documentation
- Permission Management
- Precautions
- Private network, IP range of each region of API gateway and VIP of public network
- Plugin Usage
- Best Practice
- Development Guide
- API Documentation
- FAQs
- Service Level Agreement
- Glossary
- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Manage Service
- Creating APIs
- Managing APIs
- Calling APIs
- Release and Access
- Custom Domain Name and Certificate
- Usage Plan
- Verification and Security
- Log Analysis
- Access Monitoring
- Key Management
- API Documentation
- Permission Management
- Precautions
- Private network, IP range of each region of API gateway and VIP of public network
- Plugin Usage
- Best Practice
- Development Guide
- API Documentation
- FAQs
- Service Level Agreement
- Glossary
Overview
This document describes how to create an API under a service by defining it in the API Gateway console.
Prerequisites
You have created a service.
Directions
- Log in to the API Gateway console and select Service in the left sidebar.
- In the service list, click the name of the target service to view it.
- In the service details, click the Manage API tab and choose to create a General API or Microservice API based on the backend business type.
- Click Create and complete the subsequent configuration.
API Types
In API Gateway, you can create APIs for five types of backend services, i.e., general APIs for public URL/IP, VPC, SCF, and Mock, and microservice APIs for TSF. More information is listed below:
| API Type | Backend Service | Documentation |
|---|---|---|
| General API | Public URL/IP | Creating APIs Connecting to the Public URL/IP Backend |
| VPC resources | Creating APIs Connecting to the VPC Resource Backend | |
| SCF | Creating APIs Connecting to the SCF Backend | |
| Mock | Creating APIs Connecting to the Mock Backend | |
| Microservice API | TSF | Creating APIs Connecting to the TSF Backend |
Basic API Information
Basic information of an API includes:
- API service: a service is a set of APIs for management. Any specific API must belong to a certain service. When creating an API, you can select an existing service or create a new one.
- API path: path of an API request domain name
- Method: API request method. The API path + API request method is the unique identifier of an API.
- Description: API remarks
Was this page helpful?