Narcissistic Pickle Meister

    @tencent-serverless/tencent-apigateway

    2.1.0-beta-1 • Public • Published

    腾讯云API网关组件

     

    简介

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

    快速开始

     

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

    1. 安装
    2. 配置
    3. 部署
    4. 移除

     

    1. 安装

    通过npm安装serverless

    $ npm install -g serverless

    2. 配置

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

    $ touch serverless.yml
    # serverless.yml
     
    restApi:
      component: "@serverless/tencent-apigateway"
      inputs:
        region: ap-shanghai
        protocols:
          - http
          - https
        serviceName: serverless
        environment: release
        endpoints:
          - path: /users
            method: POST
            function:
              functionName: myFunction
     

    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 in the ap-shanghai region
      DEBUG ─ Service with ID service-g1ihx7c7 created.
      DEBUG ─ API with id api-4dv8r7wg created.
      DEBUG ─ Deploying service with id service-g1ihx7c7.
      DEBUG ─ Deployment successful for the api named restApi in the ap-shanghai region.
     
      restApi:
        protocols:
          - http
          - https
        subDomain:   service-g1ihx7c7-1300415943.ap-shanghai.apigateway.myqcloud.com
        environment: release
        region:      ap-shanghai
        serviceId:   service-g1ihx7c7
        apis:
          -
            path:   /users
            method: POST
            apiId:  api-4dv8r7wg
     
      24s › restApi › done
     

    4. 移除

    通过以下命令移除部署的API网关

    $ sls remove --debug
     
      DEBUG ─ Flushing template state and removing all components.
      DEBUG ─ Removing any previously deployed API. api-4dv8r7wg
      DEBUG ─ Removing any previously deployed service. service-g1ihx7c7
     
      13s › restApi › done
     

    账号配置(可选)

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

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

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

    如果没有腾讯云账号,可以在此注册新账号

    如果已有腾讯云账号,可以在API密钥管理中获取 SecretIdSecretKey.

    # .env
    TENCENT_SECRET_ID=123
    TENCENT_SECRET_KEY=123
    

    还支持哪些组件?

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

    Keywords

    none

    Install

    npm i @tencent-serverless/tencent-apigateway

    DownloadsWeekly Downloads

    1

    Version

    2.1.0-beta-1

    License

    Apache

    Unpacked Size

    78.8 kB

    Total Files

    16

    Last publish

    Collaborators

    • anycodes
    • yugasun