henacodes/pexpress

A php实现express js

dev-master 2024-04-13 04:21 UTC

This package is not auto-updated.

Last update: 2024-09-24 10:57:20 UTC


README

Pexpress是一个轻量级的PHP库,用于轻松构建RESTful API。它提供了一个简单直观的接口来定义路由和处理HTTP请求。本README将指导您如何有效地安装和使用Pexpress库。

目录

  • 安装
  • 使用
    • 初始化应用
    • 定义路由
    • 监听请求
  • 示例
  • 贡献
  • 许可协议

安装

要在PHP项目中使用Pexpress,您需要遵循以下步骤

  1. 更新您的composer.json文件以将库作为依赖项包含
   "require": {
   "henacodes/pexpress": "dev-master"
   }
  1. 运行以下命令以安装库及其依赖项

    composer install

使用

初始化应用

要开始使用Pexpress,您需要初始化App类。此类将负责处理传入请求并将它们路由到适当的处理程序。

在您的PHP文件(index.php或任何其他文件)中,包含Composer生成的自动加载文件

require_once 'vendor/autoload.php';

接下来,导入App命名空间

use Henacodes\Pexpress\App;

现在,您可以初始化App类

$app = new App();

定义路由

Pexpress允许您使用不同的HTTP方法(如GET、POST、PUT和PATCH)定义路由。要定义路由,您需要在$app实例上调用相应的方法,并提供一个将处理请求的回调函数。

以下是一个定义GET路由的示例

$app->get("/users/:id", function ($req, $res, $next) {
$res->json(["message" => "Hello"]);
});

您可以使用类似的方式(post、put、patch)定义其他HTTP方法的路由。

监听请求

在定义您的路由后,您需要开始监听传入的请求。为此,只需在$app实例上调用listen方法即可

$app->listen();

这将在指定的端口(通常为端口8000)上启动服务器并监听传入的请求。

中间件

您可以添加尽可能多的中间件。以下是一个示例

$middleware_one = function($request, $response, $next){
    if (your_logic_here){
        // if its true , preceed to the next miiddleware
        $next()
    } else {
        // abort the process and response with an error response
        res.status(400)
        res.json({ error:"Bad request" })
    }
}

$middleware_two = function($request, $response, $next){
    // your second middleware
}


$app->get("/posts", $middleware_one, $middleware_two)

示例

有关更多示例和用法详细信息,请参阅此存储库中的示例目录。

贡献

欢迎贡献!如果您有任何改进或新功能要添加,请创建pull request。

许可协议

本项目采用MIT许可协议。