tencent cloud

All product documents
API Gateway
DocumentationAPI GatewayDevelopment GuideServerless FrameworkCreating and Deploying API Gateway Service
Creating and Deploying API Gateway Service
Last updated: 2023-12-22 10:04:30
Creating and Deploying API Gateway Service
Last updated: 2023-12-22 10:04:30

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.yml

component: apigateway # Component name, which is required. `apigateway` is used in this example
name: apigwDemo # Instance name, which is required
org: orgDemo # Organization information, which is optional. The default value is the `appid` of your Tencent Cloud account
app: appDemo # Next.js application name, which is optional
stage: dev # Information for identifying environment, which is optional. The default value is `dev`

inputs:
region: ap-guangzhou
protocols:
- http
- https
serviceName: serverless
environment: release
endpoints:
- path: /
protocol: HTTP
method: GET
apiName: index
function:
functionName: myFunction

Deploying API Gateway service

Run the following command to deploy by scanning code:
sls deploy
Note:
To grant persistent permission, please see Account Configuration.

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:
# .env
TENCENT_SECRET_ID=123
TENCENT_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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support