Have ideas to improve npm?Join in the discussion! »

    @tencent-serverless/tencent-koa

    2.0.0 • Public • Published

    Serverless Koa Tencent Cloud

    腾讯云 koa 组件

    简介

    koa 组件通过使用 serverless-tencent 的基础组件如 API 网关组件,SCF 组件等,快速,方便的在腾讯云创建,配置和管理一个 koa 框架

    快速开始

    通过 koa 组件,对一个 koa 应用进行完整的创建,配置,部署和删除等操作。支持命令如下:

     

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

     

    1. 安装

    通过 npm 安装 serverless

    $ npm install -g serverless

    2. 创建

    本地创建 serverless.yml 文件和 app.js文件:

    $ touch serverless.yml

    初始化一个新的 npm 包,并安装 koa:

    npm init              # 创建后持续回车
    npm i --save koa  # 安装 koa
    

    创建一个 app.js文件,并在其中创建您的 koa App:

    $ touch app.js
    const koa = require('koa');
    const app = new koa();
     
    app.use(async (ctx, next) => {
      if (ctx.path !== '/') return next();
      ctx.body = 'Hello from Koa';
    });
     
    // don't forget to export!
    module.exports = app;

    3. 配置

    在 serverless.yml 中进行如下配置

    # serverless.yml
     
    koa:
      component: '@serverless/tencent-koa'
      inputs:
        region: ap-shanghai

    4. 部署

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

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

    注:sls命令是serverless命令的缩写

    $ 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 ─ Compressing function KoaComponent_7xRrrd file to /Users/dfounderliu/Desktop/temp/code/.serverless/KoaComponent_7xRrrd.zip.
      DEBUG ─ Compressed function KoaComponent_7xRrrd file successful
      DEBUG ─ Uploading service package to cos[sls-cloudfunction-ap-shanghai-code]. sls-cloudfunction-default-KoaComponent_7xRrrd-1572512568.zip
      DEBUG ─ Uploaded package successful /Users/dfounderliu/Desktop/temp/code/.serverless/KoaComponent_7xRrrd.zip
      DEBUG ─ Creating function KoaComponent_7xRrrd
      DEBUG ─ Created function KoaComponent_7xRrrd successful
      DEBUG ─ Starting API-Gateway deployment with name koa.TencentApiGateway in the ap-shanghai region
      DEBUG ─ Using last time deploy service id service-n0vs2ohb
      DEBUG ─ Updating service with serviceId service-n0vs2ohb.
      DEBUG ─ Endpoint ANY / already exists with id api-9z60urs4.
      DEBUG ─ Updating api with api id api-9z60urs4.
      DEBUG ─ Service with id api-9z60urs4 updated.
      DEBUG ─ Deploying service with id service-n0vs2ohb.
      DEBUG ─ Deployment successful for the api named koa.TencentApiGateway in the ap-shanghai region.
    
      koa:
        region:              ap-shanghai
        functionName:        KoaComponent_7xRrrd
        apiGatewayServiceId: service-n0vs2ohb
        url:                 http://service-n0vs2ohb-1300415943.ap-shanghai.apigateway.myqcloud.com/release/
    
      36s › koa › done
    
    

    部署完毕后,可以在浏览器中访问返回的链接,看到对应的 koa 返回值。

    5. 移除

    通过以下命令移除部署的存储桶

    $ sls remove --debug
    
      DEBUG ─ Flushing template state and removing all components.
      DEBUG ─ Removed function KoaComponent_MHrAzr successful
      DEBUG ─ Removing any previously deployed API. api-kf2hxrhc
      DEBUG ─ Removing any previously deployed service.  service-n0vs2ohb
    
      13s › koa › done
    

    账号配置(可选)

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

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

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

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

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

    # .env
    TENCENT_SECRET_ID=123
    TENCENT_SECRET_KEY=123
    

    还支持哪些组件?

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

    Install

    npm i @tencent-serverless/tencent-koa

    DownloadsWeekly Downloads

    1

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    30.6 kB

    Total Files

    17

    Last publish

    Collaborators

    • avatar
    • avatar