API 网关组件

touch serverless.yml

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

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

# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123

# serverless.yml
?
org: orgDemo #（可选） 用于记录组织信息，默认值为您的腾讯云账户 appid
app: appDemo #（可选） 该应用名称
stage: dev #（可选） 用于区分环境信息，默认值为 dev
component: apigateway # (必填) 组件名称，此处为 apigateway
name: 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 接口示例
    # 参考文档 /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'

value:
  - application/zip