Breeze

一个用于服务端 Swift 的 Serverless API 模板生成器。

Breeze 是一个强大的工具，旨在简化在 Swift 中创建 Serverless API 模板的过程。

它消除了从零开始设置项目的复杂性，为开发者提供了可适配和定制的代码、脚本和配置。该工具基于开源代码，允许任何人检查、理解和改进实现。

Breeze 的基本选择

• Serverless 架构
• 基于 SSWG SDKs 的服务端 Swift 代码
• 开源依赖
• 开放以供检查、定制和贡献
• 基础设施即代码
• 部署脚本

Serverless 架构彻底改变了开发者处理应用部署的方式。Serverless 计算消除了与传统服务器管理相关的复杂性。这种方法带来了更高的敏捷性、更低的运营开销、可扩展性和高效的资源利用率。

Swift 简洁的语法、强大的类型系统和性能优化有助于更快的开发周期和增强的代码可维护性。在服务端利用 Swift 确保了开发者获得一致且统一的语言体验，促进了客户端和服务器组件之间的代码共享。

该工具可以生成以下可用模板

基于 APIGateway、Lambda、DynamoDB 的 AWS Serverless REST API

• 规范：Docs/GenerateLambdaAPI.md

• 命令行帮助：swift run breeze generate-lambda-api --help

• 在 @NSLondon 的演讲：像 Breeze 一样轻松地使用 Swift 进行 Serverless](https://youtu.be/D4qSv_fhQIo?si=WnsTlYbUjHs9DYHF)

• 幻灯片：幻灯片

一个基于 APIGateway 和 Lambda 的，带有签名验证的 GitHub Webhook。

• 规范：Docs/GenerateGithubWebhook.md

• 命令行帮助：swift run breeze generate-github-webhook --help

一个基于 APIGateway 和 Lambda 的 Serveless Webhook，带有 POST 和 GET 端点。

• 规范：Docs/GenerateWebhook.md

• 命令行帮助：swift run breeze generate-webhook --help

swift run breeze --help

输出

OVERVIEW: Breeze command line

Generate the deployment of a Serverless project using Breeze.
The command generates of the swift package, the `serverless.yml` file and the relevant commands in the target path to deploy
the Lambda code on AWS using the Serverless Framework.

USAGE: breeze <subcommand>

OPTIONS:
  -h, --help              Show help information.

SUBCOMMANDS:
  generate-lambda-api
  generate-github-webhook
  generate-webhook

  See 'breeze help <subcommand>' for detailed help.

使用 Breeze 开发 Serverless Swift 的工作流可以通过以下步骤描述

• 使用 breeze 命令行工具生成项目
  • 选择一个 Breeze 模板并遵循文档
  • 复制并适配模板配置文件
  • 生成项目
• 定制生成的项目并适配代码
• 使用 build.sh 脚本构建项目
• 使用 deploy.sh 脚本部署项目
• 当代码更改时使用 update.sh 脚本更新项目
• 如果不再需要，使用 remove.sh 脚本移除项目

• Swift (版本 >= 5.7)
• Docker
• Serverless Framework 版本 3
• 确保您的 AWS 账户拥有部署 Serverless 堆栈的正确凭证。
• 确保您可以运行 make

欢迎贡献！如果您遇到任何问题或有改进的想法，请开启 issue 或提交 pull request。