lumen-api-starter

Lumen Api Starter 项目介绍

项目概述

Lumen Api Starter 是一个基于最新 Lumen 版本构建的 API 项目启动模板。其设计初衷是提供一个功能完善且能快速应用于实际开发的工具，同时具有规范统一的特点，使其能够适应中大型项目的开发需求。这个项目通过少量的依赖安装，遵循 Laravel 的编程思想，不增加额外的负担，使开发者可以开箱即用，迅速进入 API 开发。

项目特点

1. RESTful API 响应结构：项目中实现了 RESTful 规范的 HTTP 响应结构，比如在成功、失败和异常场景下统一的结构响应。此外，它还支持多语言提示返回。

2. Jwt-auth 授权：采用 Jwt-auth 方式进行授权，确保 API 的安全性。

3. 便利的枚举/常量管理：通过更便捷的方式管理枚举和常量，提升开发效率。

4. Repository & Service 架构设计：灵活的架构设计使得该项目可以更好地管理业务逻辑，实现代码分层，为中大型项目提供良好的支持。

目录结构

• app/Console：包含定义 CLI 命令和调度器的文件。
• app/Contracts：存放接口定义。
• app/Enums：定义项目中使用的枚举，需要 PHP 8.1 以上版本支持。
• app/Events：事件处理相关文件。
• app/Exceptions：设计良好的异常处理机制。
• app/Http：包含控制器、路由和中间件等网络相关文件。
• app/Jobs：异步任务管理。
• app/Listeners：事件监听器。
• app/Models：Eloquent 模型，定义数据表结构及其关系。
• app/Providers：服务提供者。
• app/Services：业务逻辑处理。
• app/Support：封装公用功能的扩展。

Repository & Service 模式架构

• Controller：负责请求校验，权限审查，以及调用相应的 Service 处理业务逻辑。
• Service：专注于具体的功能实现，处理业务逻辑。
• Model：定义数据结构以及操作。

实际案例与规范

项目通过 Larabbs 项目展示了 Repository & Service 模式的实际应用。项目中也对 Controller、Service、Model 名称规范进行了定义，以确保代码的一致性和可维护性。

使用的 Packages

• jiannei/laravel-response：规范统一的响应数据格式。
• jiannei/laravel-enum：支持多语言的枚举功能。
• tymon/jwt-auth：JWT 授权支持。

结语

Lumen Api Starter 是一个强大而灵活的项目启动模板，适合各种规模的 API 项目开发。项目代码开源，采用 MIT 许可协议，欢迎开发者参与讨论和贡献。通过合理的架构设计和完善的功能支持，帮助开发团队提升开发效率，打造高质量的 API 服务。