通过 
搜索
搜索byjg / rest-reference-architecture
ByJG 的 RESTful 服务参考架构项目，集成了 docker 和数据库的 PHP 服务
4.9.1
2024-06-17 23:03 UTC
Requires
- php: >=8.1
- ext-curl: *
- ext-json: *
- ext-openssl: *
- byjg/anydataset-db: ^4.9
- byjg/authuser: ^4.9
- byjg/config: ^4.9
- byjg/jinja-php: ^4.9
- byjg/mailwrapper: ^4.9
- byjg/micro-orm: ^4.9
- byjg/migration: ^4.9
- byjg/php-daemonize: ^4.9
- byjg/restserver: ^4.9
- byjg/shortid: ^4.9
- byjg/swagger-test: ^4.9
- zircote/swagger-php: ^4.6.1
Requires (Dev)
- phpunit/phpunit: 5.7.*|7.4.*|^9.5
README
此项目是一个用于创建 Rest 应用程序 API 的样板代码，使用最佳技术来提高您的生产力。
什么是 PHP Rest 模板？
它是一个基于 PHP 的 RESTful API 模板或样板代码，旨在简化 PHP 中 RESTful 服务的开发过程。它提供了一个基础或起点，用于根据 REST 架构原则构建 API。
使用此 PHP Rest 参考架构，您可以专注于应用程序的业务逻辑，而不是基础设施，例如
- 快速开发：通过提供预定义的结构和基本组件，该模板可以加快在 PHP 中构建 RESTful API 的过程。
- 标准化：该模板促进了一致性和对 RESTful 设计原则的遵守，使开发者更容易理解和协作代码库。
- 可定制：开发者可以修改和扩展模板以满足特定要求，从而在实现附加功能或业务逻辑方面具有灵活性。
关键功能和组件
- 使用 OpenAPI 规范进行 API 文档和端点创建。
- 路由：包括一个路由系统，帮助将传入的 HTTP 请求映射到特定的 API 端点或资源。
- 中间件：它允许开发者在请求处理前后添加自定义逻辑或执行操作。
- 处理：该项目提供处理和解析传入请求的实用程序，提取参数，并处理请求方法（GET、POST、PUT、DELETE 等）。
- 响应格式化：它提供格式化和结构化 API 响应的机制，包括 JSON 序列化、错误处理和状态码。
- 身份验证和授权：该模板包括支持使用 JWT 实现身份验证和授权机制以保护 API 端点。
- 数据库集成：它提供连接到数据库、执行查询和管理数据持久性的集成。
- 错误处理：该项目包括错误处理机制，以正确处理和格式化错误响应。
- 依赖注入：它包括对依赖注入和控制反转（IoC）容器的支持。
- 测试：它包括支持测试 API 端点和资源，包括单元测试和功能测试。
- PHP 标准：PSR-7（Http 消息接口）、PSR-11（容器）、PSR-16 和 PSR-6（缓存接口）等。
本项目不是一个框架。它是一个模板，您可以使用它来创建自己的项目。您可以使用该模板作为您自己的项目的起点，并根据特定要求对其进行自定义。
一些功能说明
此项目安装以下组件（点击链接获取更多详细信息）
入门指南
以下是一些使用模板的示例