eclogue/courser

轻量级且快速 PHP REST API 库

dev-master 2019-03-22 09:50 UTC

This package is auto-updated.

Last update: 2024-09-21 20:33:23 UTC


README

Build Status Coverage Status Latest Stable Version Total Downloads License

有趣的东西

功能

  • PSR-15 中间件
  • PSR-7 HTTP 消息
  • PSR-11
  • 协程支持

安装

composer require eclogue/courser 或 git clone https://github.com/eclogue/courser

开始使用

composer install

简单用法 php -S 127.0.0.1:7001 -t example/

路由器

<?php

# basic /users/11
$app->get('/users/:id', function($req, RequestHandlerInterface $handler) {
    var_dump($req->params['id']); // id must be integer
    return $handler->handle($req);
});
$app->get('/users/:id', function($req) {
    return ['data' => '1'];
});
# use array
$app->get('users/*', [function($req, RequestHandlerInterface $handler) {
    /* do something*/
}, function($req, RequestHandlerInterface $handler) {
    /*...todo*/
}]);

# use namespace
$app->put('/user/{username}', ['MyNamespace\Controller', 'action']);

# use group

$app->group('/admin/{username}',  function(App $app) {
    // [Notice]: In group `$this` is bind to Courser,
    // middleware define in group just have effect on the router of group scope 
    $app->used(function($req, RequestHandlerInterface $handler) { // Add group middleware
        // todo
        // this middleware is mount at /admin/{username} scope, have not effect outside of this group.
    });
    $app->get('/test/:id', function($req, RequestHandlerInterface $handler) {
        yield $handler->handle($req);
        // ...
    });
});

中间件

遵循 PSR-15 标准,见 https://github.com/middlewares/awesome-psr15-middlewares

未找到处理

$app->notFound(function (Request $req){
    $response = new Response();
    $response->withStatus(404)->json(['message' => 'Not Found']);
});

# add after the last route
$app->add(new NotFoundMiddleware());

异常

$app->setReporter(function ($req, $res, Exception $err) {
   $res->withStatus(500)->json([
       'message' =>$err->getMessage(),
       'code' => 10502,
   ]);
});

协程

Courser 支持以简单的方式编写协程应用程序。支持 yield 语法。

  // a middleware
  function process(Request $req, RequestHandlerInterface $handler) {
      $userId = $req->getParam('userId');
      $model = new User();
      $user = yield $model->findById($userId);
      var_dump($user);
      $response = yield $handler->handle($request);

      return $response;
  }

开发

这是一个快速开发 Web 应用程序的工具 (gharry)

它监视项目文件更改并自动重新加载您的服务器。

Ben 是一个方便的配置管理器,我推荐使用 Ben 来管理不同环境的配置文件。

基准测试

Damn it. I just know that, it is fast.

演示

编码...

维护

mulberry10<mulberry10th@gmail.com>

许可

MIT