i5ting / midway-faas

midway-faas is an enterprise-grade multi-platform FaaS R & D solution based on TypeScript and IoC.

Midway Faas

查看详细文档

快速开始

国内用户建议使用 cnpm 加速npm，npm install -g cnpm --registry=https://registry.npm.taobao.org

第一步：安装 Midway FaaS cli

$ npm i -g @midwayjs/faas-cli

第二步：创建项目

$ f create

第三步：进入目录 并 安装依赖

$ npm i

如何使用？

invoke 本地调用 & 本地调试

$ f invoke -f index

// debug 需要 node 10.15 +
$ f invoke -f index --debug

参数	释义
-f / --function funcName	指定要调用的函数名
--debug=debugPort?	开启debug，并且指定调试端口，默认端口为 9229

package 打包构建

$ f package

参数	释义
--package	指定打包结果（zip）文件名 --package=dist
--npm=npmName	指定npm镜像，例如 --npm=cnpm
--skipZip	打包的结果跳过压缩生成 zip

deploy 部署到线上

$ f deploy

支持所有 package 命令的参数

参数	释义
--resetConfig	使用新的账户

for aliyun

阿里云部署首次需要配置 accountId、accountKey、accountSecret

相关配置获取，可参照下方图片（可点击跳转）：

For Tencent SCF

1. 用户信息认证：
   • 腾讯云在部署时，如果是首次部署，则控制台会展示相应二维码，扫码即可完成认证，后续会默认复用该配置
   • 后续如想修改部署时的使用的用户，可手动在 serverless.yml 中设置当前用户的认证信息，教程：https://cloud.tencent.com/document/product/1154/38811
2. 部署网关设置
   • 腾讯云在部署时，会为函数默认创建网关触发器
   • 如果想避免重复创建，可按下列教程操作

发布完成后，控制台会默认显示腾讯云此次创建的网关 serviceId（如下图所示）

此时需要修改 serverless.yml 的配置文件，serviceId 可以配在以下两处：

1. provider

此处配置则对所有函数生效，所有函数共享一个网关 serviceId

provider:
  name: tencent
  runtime: Nodejs8.9
  serviceId: <控制台返回的 ServiceId>

2. events/http

此处配置则对指定函数生效

functions:
  index:
    initializer: index.initializer
    handler: index.handler
    events:
      - http:
          method: get
          serviceId: <控制台返回的 ServiceId>

License

MIT