Serverless Koa Tencent Cloud

简介

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

快速开始

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

1. 安装

通过 npm 安装 serverless

  1. $ npm install -g serverless

2. 创建

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

  1. $ touch serverless.yml

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

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

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

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

3. 配置

在 serverless.yml 中进行如下配置

  1. # serverless.yml
  2. koa:
  3. component: '@serverless/tencent-koa'
  4. inputs:
  5. region: ap-shanghai

4. 部署

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

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

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

  1. $ sls --debug
  2. DEBUG Resolving the template's static variables.
  3. DEBUG ─ Collecting components from the template.
  4. DEBUG ─ Downloading any NPM components found in the template.
  5. DEBUG ─ Analyzing the template's components dependencies.
  6. DEBUG Creating the template's components graph.
  7. DEBUG ─ Syncing template state.
  8. DEBUG ─ Executing the template's components graph.
  9. DEBUG Compressing function KoaComponent_7xRrrd file to /Users/dfounderliu/Desktop/temp/code/.serverless/KoaComponent_7xRrrd.zip.
  10. DEBUG Compressed function KoaComponent_7xRrrd file successful
  11. DEBUG Uploading service package to cos[sls-cloudfunction-ap-shanghai-code]. sls-cloudfunction-default-KoaComponent_7xRrrd-1572512568.zip
  12. DEBUG Uploaded package successful /Users/dfounderliu/Desktop/temp/code/.serverless/KoaComponent_7xRrrd.zip
  13. DEBUG Creating function KoaComponent_7xRrrd
  14. DEBUG Created function KoaComponent_7xRrrd successful
  15. DEBUG Starting API-Gateway deployment with name koa.TencentApiGateway in the ap-shanghai region
  16. DEBUG Using last time deploy service id service-n0vs2ohb
  17. DEBUG Updating service with serviceId service-n0vs2ohb.
  18. DEBUG Endpoint ANY / already exists with id api-9z60urs4.
  19. DEBUG Updating api with api id api-9z60urs4.
  20. DEBUG Service with id api-9z60urs4 updated.
  21. DEBUG Deploying service with id service-n0vs2ohb.
  22. DEBUG Deployment successful for the api named koa.TencentApiGateway in the ap-shanghai region.
  23. koa:
  24. region: ap-shanghai
  25. functionName: KoaComponent_7xRrrd
  26. apiGatewayServiceId: service-n0vs2ohb
  27. url: http://service-n0vs2ohb-1300415943.ap-shanghai.apigateway.myqcloud.com/release/
  28. 36s koa done

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

5. 移除

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

  1. $ sls remove --debug
  2. DEBUG Flushing template state and removing all components.
  3. DEBUG Removed function KoaComponent_MHrAzr successful
  4. DEBUG Removing any previously deployed API. api-kf2hxrhc
  5. DEBUG Removing any previously deployed service. service-n0vs2ohb
  6. 13s koa done

账号配置(可选)

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

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

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

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

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

  1. # .env
  2. TENCENT_SECRET_ID=123
  3. TENCENT_SECRET_KEY=123