adaiasmagdiel / hermes
Hermes 是一个实验性的轻量级 PHP 路由管理库。它提供了一种简单直观的方式来定义路由和根据 HTTP 请求执行操作。
v1.0.5
2024-02-24 18:33 UTC
Requires
- php: >=8.0
Requires (Dev)
- pestphp/pest: ^2.33
README
Hermes 是一个实验性的轻量级 PHP 路由管理库。它提供了一种简单直观的方式来定义路由和根据 HTTP 请求执行操作。
导航
特性
- 使用 HTTP 方法(GET、POST、PUT、DELETE、HEAD、OPTIONS 和 PATCH)轻松定义路由。
- 根据请求的路由执行操作。
- 轻量级、实验性且易于集成到现有项目中。
安装
您可以通过 composer 安装 Hermes。
composer require adaiasmagdiel/hermes
使用
以下是如何使用 Hermes 的基本示例
<?php require_once "vendor/autoload.php"; use AdaiasMagdiel\Hermes\Router; Router::initialize(); Router::get('/', function() { echo "Hello, World!"; }); Router::get('/about', function() { echo "About page"; }); Router::post('/submit', function() { // Handle form submission }); // Optional changing the 404 page Router::set404(function() { http_response_code(404); echo "This is a new 404 page."; }); // Optional changing the 500 page Router::set500(function() { http_response_code(500); echo "This is a new 500 page."; }); Router::execute();
在这个示例中,我们为不同的 HTTP 方法(GET 和 POST)定义路由,并根据请求的路由执行操作。
首先,您需要使用静态的 initialize
方法初始化 Router
类。然后您可以使用这些方法添加路由,您还可以使用 set400
和 set500
方法添加 404 和 500 页面。
文档
要访问完整文档和查看更多使用示例,请访问 文档页面。
测试
要运行 Hermes 的测试,可以使用以下命令
composer run tests
许可证
Hermes 是开源软件,MIT 许可证下授权。有关详细信息,请参阅 LICENSE 文件。
贡献
我欢迎对 Hermes 项目的贡献!要贡献,请按照以下步骤操作
-
将仓库克隆到您的本地机器
git clone https://github.com/AdaiasMagdiel/hermes.git
-
使用 Composer 安装开发依赖项
composer install
-
对代码库进行更改或添加。
-
编写并测试您的更改,以确保它们按预期工作
composer run tests
-
提交您的更改并将它们推送到您对仓库的分支。
-
提交一个带有您更改的明确描述的 pull request。
感谢您的贡献和反馈!如果您遇到任何问题或有改进建议,请随时在 GitHub 上创建问题。
鸣谢
Hermes 由 Adaías Magdiel 开发和维护。