README

tencent-apigateway

Easily provision Tencent API Gateway using Serverless Components.

Install
Create
Configure
Deploy

1. Install

$ npm install -g serverless

2. Create

Just create the following simple boilerplate:

$ touch serverless.yml 
$ touch .env           # your Tencent api keys

If you don't have a Tencent Cloud account, you could sign up first.

If you already login in, find TENCENT_SECRET_ID and TENCENT_SECRET_KEY in Tencent Console.

# .env
TENCENT_SECRET_ID=XXX
TENCENT_SECRET_KEY=XXX

3. Configure

# serverless.yml

restApi:
  component: "@serverless/tencent-apig"
  inputs:
    # serviceId: service-8dsikiq6 # if you don't want to use a api-gateway which exists, please do not add serviceId
    region: ap-shanghai # default ap-guangzhou
    protocol: http #  http | https | http&https
    # serviceName: sls # up to 50 characters，(a-z,A-Z,0-9,_)
    description: the sls service 
    environment: release 
    endpoints: # need at least one endpoints
      - path: /users  # required
        method: POST  # required
        function:
          functionName: aaa # required
      - path: /test
        apiId: api-id # if you don't want to use a api-gateway which exists, please do not add serviceId
        method: GET
        description: Serverless REST API
        enableCORS: TRUE 
        function:
          isIntegratedResponse: TRUE 
          functionQualifier: $LATEST 
          functionName: fist # required
        usagePlan:
          # if dont't exists create a new 
          usagePlanId: 1111
          usagePlanName: slscmp # required
          usagePlanDesc: sls create
          maxRequestNum: 1000
        auth:
          serviceTimeout: 15
          secretName: secret  # required
          # secretIds:
          #   - AKIDNSdvdFcJ8GJ9th6qeZH0ll8r7dE6HHaSuchJ

4. Deploy

$ serverless

Test

tongtingting:tencent-apigateway tongtingting$ sls

restApi: 
    protocol:      HTTP
    serviceId:     service-********
    subDomain:     service-********-**********.ap-guangzhou.apigateway.myqcloud.com
    requestConfig: 
      path:   /frontend/path
      method: GET
    identity: 
      secretIds: 
        - AKID************************

  16s › restApi › done
  
tongtingting:tencent-api-gateway tongtingting$ sls remove

  19s › restApi › done

New to Components?

Checkout the Serverless Components repo for more information.

Usage no npm install needed!