README

腾讯云API网关多地部署组件

简介

该组件是 API网关多地部署组件，可以通过该组件，将API网关同步部署到多个地域。

快速开始

通过该组件，对一个函数进行多地域创建，配置，部署和删除等操作。支持命令如下：

安装
配置
部署
移除

1. 安装

通过 npm 安装 serverless

$ npm install -g serverless

2. 配置

本地创建 serverless.yml 文件，在其中进行如下配置

$ touch serverless.yml

# serverless.yml

restApi:
  component: '@serverless/tencent-apigateway-multi-region'
  inputs:
    region:
      - ap-shanghai
      - ap-guangzhou
    protocols:
      - https
    serviceName: serverless
    description: the serverless service
    environment: release
    endpoints:
      - path: /users
        method: POST
        function:
          functionName: myFunction
      - path: /userss
        method: POST
        function:
          functionName: myFunction
    ap-shanghai:
      protocols:
        - https

该组件配置与tencent-scf组件配置一致，针对不同地域的额外拓展，可以增加以地域为key的对象，地域对象下的内容也是和tencent-scf组件配置一致：

ap-shanghai:
  protocols:
    - https

3. 部署

如您的账号未登陆或注册腾讯云，您可以直接通过微信扫描命令行中的二维码进行授权登陆和注册。

通过sls命令进行部署，并可以添加--debug参数查看部署过程中的信息

$ sls --debug
  
  DEBUG ─ Resolving the template's static variables.
  DEBUG ─ Collecting components from the template.
  DEBUG ─ Downloading any NPM components found in the template.
  DEBUG ─ Analyzing the template's components dependencies.
  DEBUG ─ Creating the template's components graph.
  DEBUG ─ Syncing template state.
  DEBUG ─ Executing the template's components graph.
  DEBUG ─ Starting API-Gateway deployment with name restApi.ap-shanghai-apigateway in the ap-shanghai region
  DEBUG ─ Using last time deploy service id service-isgiabd1
  DEBUG ─ Updating service with serviceId service-isgiabd1.
  DEBUG ─ Endpoint POST /users already exists with id api-cqscrqto.
  DEBUG ─ Updating api with api id api-cqscrqto.
  DEBUG ─ Service with id api-cqscrqto updated.
  DEBUG ─ Deploying service with id service-isgiabd1.
  DEBUG ─ Deployment successful for the api named restApi.ap-shanghai-apigateway in the ap-shanghai region.
  DEBUG ─ Endpoint POST /userss already exists with id api-30durwsu.
  DEBUG ─ Updating api with api id api-30durwsu.
  DEBUG ─ Service with id api-30durwsu updated.
  DEBUG ─ Deploying service with id service-isgiabd1.
  DEBUG ─ Deployment successful for the api named restApi.ap-shanghai-apigateway in the ap-shanghai region.
  DEBUG ─ Starting API-Gateway deployment with name restApi.ap-guangzhou-apigateway in the ap-guangzhou region
  DEBUG ─ Using last time deploy service id service-nthsvw02
  DEBUG ─ Updating service with serviceId service-nthsvw02.
  DEBUG ─ Endpoint POST /users already exists with id api-n8mumgq6.
  DEBUG ─ Updating api with api id api-n8mumgq6.
  DEBUG ─ Service with id api-n8mumgq6 updated.
  DEBUG ─ Deploying service with id service-nthsvw02.
  DEBUG ─ Deployment successful for the api named restApi.ap-guangzhou-apigateway in the ap-guangzhou region.
  DEBUG ─ Endpoint POST /userss already exists with id api-mu1w26sm.
  DEBUG ─ Updating api with api id api-mu1w26sm.
  DEBUG ─ Service with id api-mu1w26sm updated.
  DEBUG ─ Deploying service with id service-nthsvw02.
  DEBUG ─ Deployment successful for the api named restApi.ap-guangzhou-apigateway in the ap-guangzhou region.

  restApi: 
    ap-shanghai: 
      serviceId:   service-isgiabd1
      subDomain:   service-isgiabd1-1256773370.sh.apigw.tencentcs.com
      environment: release
      protocols: 
        - https
      apis: 
        - Method: POST	 PATH: /users
        - Method: POST	 PATH: /userss
    ap-guangzhou: 
      serviceId:   service-nthsvw02
      subDomain:   service-nthsvw02-1256773370.gz.apigw.tencentcs.com
      environment: release
      protocols: 
        - https
      apis: 
        - Method: POST	 PATH: /users
        - Method: POST	 PATH: /userss

  13s › restApi › done

4. 移除

通过以下命令移除

$ sls remove --debug

  DEBUG ─ Flushing template state and removing all components.
  DEBUG ─ Removing any previously deployed API. api-cqscrqto
  DEBUG ─ Removing any previously deployed API. api-30durwsu
  DEBUG ─ Removing any previously deployed service. service-isgiabd1
  DEBUG ─ Removing any previously deployed API. api-n8mumgq6
  DEBUG ─ Removing any previously deployed API. api-mu1w26sm
  DEBUG ─ Removing any previously deployed service. service-nthsvw02

  17s › restApi › done

账号配置（可选）

当前默认支持 CLI 扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 .env 文件

$ touch .env # 腾讯云的配置信息

在 .env 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存。

# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123

?

如果没有腾讯云账号，请先注册新账号。

如果已有腾讯云账号，可以在 API 密钥管理中获取 SecretId 和 SecretKey。

还支持哪些组件？

可以在 Serverless Components repo 中查询更多组件的信息。

Usage no npm install needed!