基于CodeGenieApp/serverless-express的基础API网关V1入门指南
项目地址: https://gitcode.com/gh_mirrors/se/serverless-express 项目概述
CodeGenieApp/serverless-express项目提供了一个优雅的解决方案，帮助开发者将现有的Express应用快速部署到AWS Lambda和API Gateway上。本文重点介绍其基础入门示例（basic-starter-api-gateway-v1），该示例展示了如何构建一个完整的无服务器Express应用。
核心组件解析
这个基础示例包含以下几个关键技术组件：
- Express应用：标准的Node.js Express服务器实现
- AWS Lambda集成：通过包装器将Express应用适配到Lambda环境
- API Gateway V1：使用传统API Gateway作为前端代理
- Swagger规范：API的OpenAPI描述文件
- SAM模板：基于AWS Serverless Application Model的部署模板
环境准备
在开始部署前，需要确保具备以下条件：
- 有效的AWS账户
- 已安装最新版AWS CLI并完成配置
- Node.js 12或更高版本环境
部署步骤详解
1. 项目初始化
首先获取示例代码并进入项目目录。建议将此作为新项目的起点，或者作为现有Express应用迁移的参考模板。
2. 配置调整
修改package.json中的config部分，需要指定：
- S3存储桶名称（用于部署包）
- AWS区域
- 可选的自定义域名配置
3. 部署执行
运行npm run setup命令，该命令会执行以下操作序列：
- 安装Node依赖
- 创建或验证S3存储桶
- 打包应用代码
- 通过CloudFormation部署到AWS
- 创建API Gateway端点
4. 自定义域名配置（可选）
如需使用自定义域名，部署流程会额外：
- 通过ACM创建SSL证书（需邮件验证）
- 配置API Gateway自定义域名
- 设置Route53 DNS记录
注意：DNS传播可能需要数小时。
5. 验证部署
部署完成后，可通过CloudFormation控制台获取API端点URL，访问该URL应能看到示例Express应用提供的API列表。
项目迁移指南
对于已有Express应用的迁移，建议按以下步骤操作：
- 基础文件复制：获取api-gateway-event.json、sam-template.yaml和lambda.js等核心文件
- package.json整合：合并scripts和config配置段
- 依赖安装：添加@codegenie/serverless-express依赖
- 应用适配：
- 修改lambda.js以引入你的Express应用
- 移除原有的app.listen()调用
- 构建配置：调整sam-template.yaml中的CodeUri指向你的应用目录
- 部署测试：使用npm run package-deploy进行部署
本地开发与测试
项目提供了本地开发环境：
- 修改api-gateway-event.json配置测试事件
- 运行
npm run local启动本地开发 - 此模式会模拟API Gateway和Lambda的调用环境
进阶开发技巧
- 版本管理：如需基于本地修改进行开发，可使用npm pack创建本地包并安装
- 模板定制：直接修改sam-template.yaml可调整AWS资源配置
- 构建集成：对于使用构建工具的项目，指向构建输出目录而非源码目录
资源清理
完成测试后，可通过以下命令清理AWS资源：
npm run delete-stack：删除CloudFormation堆栈npm run delete-bucket：删除S3存储桶（如为新创建）
技术注意事项
- 本示例基于Node.js 12环境开发
- API Gateway V1与传统REST API兼容
- 部署过程中证书验证需要人工干预
- DNS变更可能需要较长时间生效
通过这个基础示例，开发者可以快速理解如何将Express应用无服务器化，并以此为基础构建更复杂的业务场景。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
