Serverless Plugin Simulate 使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00319/article/details/142194530

Serverless Plugin Simulate 使用教程

serverless-plugin-simulate This is a proof of concept to see if we can replicate Amazon API Gateway using docker images to run lambda 项目地址: https://gitcode.com/gh_mirrors/ser/serverless-plugin-simulate

1. 项目的目录结构及介绍

serverless-plugin-simulate/
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── examples/
│   ├── api-gateway/
│   ├── lambda/
│   └── services/
├── lib/
│   ├── api-gateway.js
│   ├── lambda.js
│   └── utils.js
├── package.json
└── serverless.yml

目录结构说明

CONTRIBUTING.md: 贡献指南，包含如何为项目贡献代码的说明。
LICENSE: 项目的开源许可证。
README.md: 项目的主文档，包含项目的基本介绍、安装和使用说明。
examples/: 示例代码目录，包含不同场景下的使用示例。
- api-gateway/: API Gateway 模拟示例。
- lambda/: Lambda 模拟示例。
- services/: 服务模拟示例。
lib/: 项目的主要代码库，包含 API Gateway 和 Lambda 的模拟实现。
- api-gateway.js: API Gateway 模拟的核心代码。
- lambda.js: Lambda 模拟的核心代码。
- utils.js: 工具函数库。
package.json: 项目的依赖管理文件，包含项目的依赖和脚本命令。
serverless.yml: Serverless 框架的配置文件，定义了服务的配置和插件的使用。

2. 项目的启动文件介绍

启动文件

serverless.yml: 这是 Serverless 框架的主配置文件，定义了服务的配置和插件的使用。通过这个文件，可以配置服务的提供者、运行时、插件等。

启动命令

在项目根目录下，可以使用以下命令启动服务：

sls simulate apigateway -p 5000

这个命令会启动 API Gateway 的本地模拟服务，监听端口 5000。

3. 项目的配置文件介绍

serverless.yml

service: my-service
provider:
  name: aws
  runtime: nodejs4.3 # python2.7 is also supported

custom:
  simulate:
    dist: dist
    services:
      file: docker-compose.yml
      projectName: myproject

plugins:
  - serverless-plugin-simulate

配置文件说明

service: 定义服务的名称。
provider: 定义服务的提供者，这里使用的是 AWS。
- name: 提供者的名称，这里是 aws。
- runtime: 服务的运行时环境，支持 nodejs4.3 和 python2.7。
custom: 自定义配置项。
- simulate: 模拟插件的配置。
  - dist: 编译后的代码输出目录。
  - services: 服务配置。
    - file: Docker Compose 文件的路径。
    - projectName: Docker Compose 项目的名称。
plugins: 使用的插件列表，这里使用了 serverless-plugin-simulate。