腾讯云Serverless应用中心API 网关组件-同尘科技

操作场景

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

操作步骤

通过 API 网关组件，您可以对一个 API 服务/接口进行完整的创建、配置、部署和删除等操作。

安装

已经安装 Serverless Cloud Framework 。详情请参见 安装 Serverless Cloud Framework。

配置

本地创建 serverless.yml 文件：

touch serverless.yml

在 serverless.yml 中进行如下配置：

# serverless.yml
component: apigateway # (必填) 组件名称，此处为 apigatewayname: apigwDemo # (必填) 实例名称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

查看详细配置文档>>

部署

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

scf deploy

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

移除

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

scf remove

账号配置（可选）

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

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

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

# .envTENCENT_SECRET_ID=123TENCENT_SECRET_KEY=123

说明如果没有腾讯云账号，请先 注册新账号。如果已有腾讯云账号，可以在 API 密钥管理 中获取 SecretId 和 SecretKey。

配置详情

完整配置

# serverless.yml
org: orgDemo #（可选） 用于记录组织信息，默认值为您的腾讯云账户 appidapp: appDemo #（可选） 该应用名称stage: dev #（可选） 用于区分环境信息，默认值为 devcomponent: apigateway # (必填) 组件名称，此处为 apigatewayname: apigwDemo # (必填) 实例名称
inputs:  serviceId: service-8dsikiq6  region: ap-shanghai  protocols:    - http    - https  serviceName: serverless  serviceDesc: the serverless service  environment: release  netTypes:    - OUTER    - INNER  customDomains:    - domain: abc.com      # 如要添加https，需先行在腾讯云-SSL证书进行认证获取cettificateId      certificateId: abcdefg      isForcedHttps: true # 是否强制https，如果为true，必须配置 certificateId (SSL证书 ID)      # 如要设置自定义路径映射，请设置为 false      isDefaultMapping: false      pathMappingSet:        - path: /          environment: release      protocols:        - http        - https  endpoints:    # 前端类型: WEBSOCKET, 后端类型: SCF    - path: /      method: GET      protocol: WEBSOCKET      function:        # 前端类型为WEBSOCKET且后端为SCF时, transportFunctionName 为是        transportFunctionName: myFunction        registerFunctionName: myFunction        cleanupFunctionName: myFunction    # 前端类型: WEBSOCKET, 后端类型: HTTP    - path: /ws      protocol: WEBSOCKET      apiName: 'test-ws'      method: GET      serviceType: WEBSOCKET      serviceConfig:        url: 'ws://www.test.com'        path: /        method: GET    # 前端类型: HTTP, 后端类型: SCF    - path: /test/{abc}/{cde}      apiId: api-id      apiDesc: Serverless REST API      method: GET      enableCORS: true      responseType: HTML      serviceTimeout: 10      isBase64Encoded: false      isBase64Trigger: false      base64EncodedTriggerRules:        - name: Accept          value:            - image/jpeg        - name: Content_Type          value:            - image/jpeg      param:        - name: abc          position: PATH          required: 'TRUE'          type: string          defaultValue: abc          desc: mytest        - name: cde          position: PATH          required: 'TRUE'          type: string          defaultValue: abc          desc: mytest      function:        isIntegratedResponse: true        functionQualifier: $LATEST        functionName: myFunction      usagePlan:        usagePlanId: 1111        usagePlanName: slscmp        usagePlanDesc: sls create        maxRequestNum: -1        maxRequestNumPreSec: 1000      auth:        secretName: secret        secretIds:          - xxx    # 前端类型: HTTP, 后端类型: MOCK    - path: /mo      protocol: HTTP      method: GET      apiName: 'mock-api'      serviceType: MOCK      serviceMockReturnMessage: 'mock response content'    # 前端类型: HTTP, 后端类型: HTTP    - path: /rest      protocol: HTTP      apiName: 'test-http'      method: GET      serviceType: HTTP      serviceConfig:        url: 'http://www.test.com'        path: /test        method: GET    # 下面两个为互相关联的 oauth2.0 接口示例    # 参考文档 https://cloud.tencent.com/document/product/628/38393    - path: '/oauth'      protocol: 'HTTP'      method: 'GET'      apiName: 'oauthapi'      authType: 'OAUTH'      businessType: 'OAUTH'      serviceType: 'HTTP'      serviceConfig:        method: 'GET'        path: '/check'        url: 'http://10.64.47.103:9090'      oauthConfig:        loginRedirectUrl: 'http://10.64.47.103:9090/code'        publicKey: '{"e":"AQAB","kty":"RSA","n":"dkdd"}'        tokenLocation: 'method.req.header.authorization'        # // tokenLocation: 'method.req.header.cookie',    - path: '/oauthwork'      protocol: 'HTTP'      method: 'GET'      apiName: 'business'      authType: 'OAUTH'      businessType: 'NORMAL'      authRelationApi:        path: '/oauth'        method: 'GET'      serviceType: 'MOCK'      serviceMockReturnMessage: 'helloworld'

配置说明

主要参数说明

Endpoint

API 参数说明：

API 类型补充说明：

Function

关联云函数参数配置：说明：此时 serviceType 必须为 SCF。

ServiceConfig

API 的后端服务配置：

UsagePlan

使用计划参数说明：

SecretAuth

密钥鉴权参数说明：

RequestParameter

前端请求参数说明

CustomDomain

自定义域名

PathMap

OauthConfig

有关授业 API 的公钥生成，请参见 OAuth2.0。

AuthRelationApi

Oauth2.0 鉴权，业务 API 关联授业 API 配置，当 authType 为 OAUTH，并且 businessType 为 NORMAL 时，此参数为必选。

APP

API 绑定 APP 配置，详情见 应用管理。

Base64Rule

Header 触发 Base64 编码规则，总规则数不能超过10，只有 isBase64Trigger 设置为 true 才有效。

例如 value 可以配置为：

value:  - application/zip

关于 API 网关 Base64 编码

说明：开启 API 网关 Base64 编码的后端必须是云函数。如果需要开启 API 网关 Base64 编码，必须配置 isBase64Encoded 为 true，此时每次请求的请求内容都会被 Base64 编码后再传递给云函数。如果想要部分请求 Base64 编码，可以通过配置 isBase64Trigger 为 true，配置 base64EncodedTriggerRules Header 触发规则，此时 API 网关将根据触发规则对请求头进行校验，只有拥有特定 Content-Type 或 Accept 请求头的请求会被 Base64 编码后再传递给云函数，不满足条件的请求将不进行 Base64 编码，直接传递给云函数。详情见 Base64 编码。
官网1折活动，限时活动，即将结束，速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利。同意关联立享优惠