基于 Vapor 以及 WhooshingServer 构建的服务模块模版。

用于快速初始化一个 Whooshing 系统的服务模块且与其深度集成，可创建 API / HTTPS / INLINE 三种子模块类型且支持进行独立开发环境测试。

已集成以下 Whooshing 核心库：

• whooshing.toolbox-server
• whooshing.toolbox-basic
• whooshing-vapor

本项目高度依赖 Vapor，另请参阅 Vapor 官方文档

通过少量配置即可启动开发、调试与部署。另见 whooshing.toolbox-server

支持构建独立的服务子模块，可与 Whooshing 系统中的其他模块无缝对接，默认集成：

• ✅ Vapor 启动框架
• ✅ Whooshing 的服务模块创建机制
• ✅ Debug 配置与模块测试数据
• ✅ 环境变量自动识别与配置切换
• ✅ 多模块并行启动支持（如 API + INLINE）

1. 克隆本模版项目

   git clone https://github.com/SJJC-Team/whooshing.template-basic.git MyService
   cd MyService

2. 修改模块名称 (可选)

   修改 Package.swift 的 name 字段与 target 名称来命名你的模块：

   name: "whooshing.my-service"

   同时修改 pm2.config.json 的 name 字段，确保名称与 Package 的名称相同

   "name": "whooshing.template-basic"

3. 设置模块类型

   在 Package.swift 文件顶部设置你要启用的子模块类型：

   let WhooshingModules: [WhooshingModuleType] = [
       .api,
       .https
   ]

   INLINE 子模块是必须的，因此未提供 INLINE 子模块的可选配置

   关于子模块，请见 whooshing.toolbox-server

4. 模块配置

   在 configure.yaml 中根据你的需求进行配置

   关于具体的配置细节，请详细参照其中的注释文档

5. 运行项目

   使用 Xcode 或命令行运行：

   swift run App serve --env development

   或指定环境：

   swift run App serve --env production

   Xcode 启动默认即为开发环境 (development)

   在 entrypoint.swift 的 UnsafeDebuggingOnly 中定义了默认 rootKey、token、凭据等调试数据，实际部署时应替换或禁用调试代码。

   具体的调试细节，请参见文档注释

├── configure.swift       // 模块配置入口
├── entrypoint.swift      // 项目入口与服务启动控制
├── routes.swift          // 路由注册
├── Package.swift         // Swift Package 描述文件
├── AppTests/             // 测试代码

模版项目默认包含简单的测试路由：

GET /
返回 "It works!"

GET /hello
返回 "Hello, world!"

你可以在 routes.swift 中添加自定义路由。

配置逻辑集中在 configure.swift：

static func api(_ woo: Whooshing<Api>, app: Application)
static func https(_ woo: Whooshing<Https>, app: Application)
static func inline(_ woo: Whooshing<Inline>, app: Application)

用于初始化每个模块的依赖、路由、日志等内容

项目已包含测试目标，可在 AppTests 中添加 Vapor 路由测试：

swift test

• macOS (> 11.0)
• iOS (> 14.0)
• Linux (> 20)
• Swift (> 6.0)
• watchOS (> 6.0) [未测试]
• tvOS(> 13) **[未测试]

如有使用问题或建议，请通过 GitHub Issues 提交反馈。

或发至邮箱 contact@official.whooshings.space