API 网关组件

最近更新时间:2020-07-08 15:27:38

操作场景

API 网关组件是 serverless-tencent 组件库中的基础组件之一,您可以通过该组件快速且方便地创建、配置和管理腾讯云的 API 网关产品。

操作步骤

通过 API 网关组件,您可以对一个 API 服务/接口进行完整的创建、配置、部署和删除等操作,支持的命令如下:

安装

通过 npm 安装 Serverless:

npm install -g serverless

配置

本地创建 serverless.yml 文件:

touch serverless.yml

serverless.yml 中进行如下配置:

# serverless.yml

component: apigateway # (必填) 组件名称,此处为 apigateway
name: apigwDemo # (必填) 实例名称
org: orgDemo # (可选) 用于记录组织信息,默认值为您的腾讯云账户 appid
app: appDemo # (可选) 该 next.js 应用名称
stage: dev # (可选) 用于区分环境信息,默认值是 dev

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

查看详细配置文档>>

部署

执行以下命令进行扫码授权部署:

sls deploy
说明:

微信扫码授权部署有过期时间,如果想要持久授权,请参考 账号配置

移除

执行以下命令移除部署的服务:

sls remove

账号配置(可选)

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

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

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

# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123
说明:

目录