tencent cloud

All product documents
Serverless Application Center
DocumentationServerless Application Center Serverless Framework Component API Gateway Component
API Gateway Component
Download PDF
Last updated: 2024-12-02 10:48:10
API Gateway Component
Last updated: 2024-12-02 10:48:10
Download PDF

Operation Scenarios

The API Gateway component is one of the basic components in the serverless-tencent component library. Through this component, you can create, configure, and manage API gateways with speed and ease.

Directions

Through the API Gateway component, you can perform a complete set of operations on an API service/API, such as creation, configuration, deployment, and deletion. The supported commands are as follows:

Installation

Install Serverless through npm:
npm install -g serverless

Configuration

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

Deployment

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

Removal

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.

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon