- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Instance Management
- Service Management
- Creating API
- API Creation Overview
- Creating APIs Connecting to the Public URL/IP Backend
- Creating APIs Connecting to the VPC Resource Backend
- Creating APIs Connecting to the SCF Backend
- Creating API for Interconnecting Backend with COS
- Creating APIs Connecting to the Mock Backend
- Creating APIs Connecting to the TSF Backend
- Importing APIs
- API Management
- Calling API
- Release and Access
- Custom Domain Name and Certificate
- Usage Plan
- Backend Upstream
- Verification and Security
- Log Statistics
- Access Monitoring
- API Doc Generator
- Application Management
- Permission Management
- Precautions
- Private IP Ranges and Public VIPs of API Gateway Regions
- Plugin Usage
- Best Practices
- Making Serverless Service Available quickly through API Gateway
- Integrating WAF to API Gateway for Security Protection
- Accessing Resources in IDC via API Gateway Dedicated Instance
- Quick Access to TEM Application via API Gateway
- Integrating ECDN to API Gateway for Acceleration
- API Gateway Providing the Access Capability for TKE
- Migrating from Region A to Region B
- Development Guide
- API Documentation
- Legacy Features
- FAQs
- Service Level Agreement
- Contact Us
- Glossary
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Instance Management
- Service Management
- Creating API
- API Creation Overview
- Creating APIs Connecting to the Public URL/IP Backend
- Creating APIs Connecting to the VPC Resource Backend
- Creating APIs Connecting to the SCF Backend
- Creating API for Interconnecting Backend with COS
- Creating APIs Connecting to the Mock Backend
- Creating APIs Connecting to the TSF Backend
- Importing APIs
- API Management
- Calling API
- Release and Access
- Custom Domain Name and Certificate
- Usage Plan
- Backend Upstream
- Verification and Security
- Log Statistics
- Access Monitoring
- API Doc Generator
- Application Management
- Permission Management
- Precautions
- Private IP Ranges and Public VIPs of API Gateway Regions
- Plugin Usage
- Best Practices
- Making Serverless Service Available quickly through API Gateway
- Integrating WAF to API Gateway for Security Protection
- Accessing Resources in IDC via API Gateway Dedicated Instance
- Quick Access to TEM Application via API Gateway
- Integrating ECDN to API Gateway for Acceleration
- API Gateway Providing the Access Capability for TKE
- Migrating from Region A to Region B
- Development Guide
- API Documentation
- Legacy Features
- FAQs
- Service Level Agreement
- Contact Us
- Glossary
Operation Scenarios
This document describes how to use the API Gateway component provided by Serverless Framework to quickly create and deploy an API Gateway service/API.
Prerequisites
You have installed Serverless Framework.
Directions
Configuring API Gateway service
Create the
serverless.yml file locally:touch serverless.yml
Configure
serverless.yml as follows: # serverless.ymlcomponent: apigateway # Component name, which is required. `apigateway` is used in this examplename: apigwDemo # Instance name, which is requiredorg: orgDemo # Organization information, which is optional. The default value is the `appid` of your Tencent Cloud accountapp: appDemo # Next.js application name, which is optionalstage: dev # Information for identifying environment, which is optional. The default value is `dev`inputs:region: ap-guangzhouprotocols:- http- httpsserviceName: serverlessenvironment: releaseendpoints:- path: /protocol: HTTPmethod: GETapiName: indexfunction:functionName: myFunction
Deploying API Gateway service
Run the following command to deploy by scanning code:
sls deploy
Note:
Removing deployed service
You can run the following command to remove the deployed service:
sls remove
Account configuration (optional)
Currently, you can scan a QR code to log in to the CLI by default. If you want to configure persistent environment variables/key information, you can also create a local
.env file:touch .env # Tencent Cloud configuration information
Configure Tencent Cloud's
SecretId and SecretKey information in the .env file and save it:# .envTENCENT_SECRET_ID=123TENCENT_SECRET_KEY=123
Note:
If you don't have a Tencent Cloud account yet, please sign up first.
If you already have a Tencent Cloud account, you can get
SecretId and SecretKey in API Key Management.
Yes
No
Was this page helpful?