EasyRouter

EasyRouter is small PHP framework to fast build API.

Import

use EasyRouter\Router;  
use EasyRouter\Request; 
use EasyRouter\Reponse;

Sample .htaccess file (required)

rewriteEngine on
RewriteCond %{SCRIPT_FILENAME} !-f
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteCond %{SCRIPT_FILENAME} !-l
RewriteRule ^(.*)$ index.php/$1

Implemented HTTP methods

Easy router implement four popular HTTP methods: GET, POST, PATCH, DELETE.

Syntax

Router::<method>(<endpoint>, <middleware>, <callback>);

Router::listen();

Example

Router::GET('/api/v1/users', [], function(Request $req, Response $res){
    try {
        $users = $userRepo->findAll();
        
        $res 
            -> json($users)
            -> withStatus(200);
    } catch(ExampleException $e) {
        $res 
            -> json(makeErrorResponse("error"))
            -> withStatus(400);
    }
});

Response class

Attributes

Response doesn't have any attributes.

Methods:

write($data)
json(array $data): Response
use(): void    

withStatus(int $status): Response
withCookie(string $key, string $value, ?array $options = array()): Response

setHeader(string $key, string $value): Response

Request class

Attributes

public array $body;
public array $query;
public array $cookies;
public array $params;
public array $headers;

Methods

Request doesn't have any methods.

Router class

Attributes

Router doesn't have any public attributes.

Methods

use($setting): void
GET(string $endpoint, array $middleware, callable $callback): void
POST(string $endpoint, array $middleware, callable $callback): void
DELETE(string $endpoint, array $middleware, callable $callback): void
PATCH(string $endpoint, array $middleware, callable $callback): void
listen(): void

Listen usage

On the end of declaring API call listen() method on Router object and then routes will be active.

Use method

Decoding JSON

If you want to decode json post body you can call this:

Router::useJSON();

then your data will be in:

$request->body[]; 

Own middleware

If you want to use top abstract level middleware you can use 'use' static function. She accepts two arguments: Request and Response.

Example

This code send "Failed authorization" and status code 403 if "Authorization" header was not sent and stop next routes.

Router::use(function(Request $req, Response $res) {
    if (!isset($req->headers['Authorization'])) {
        $res->json(array(
            "message" => "Failed authorization"
        )) -> withStatus(403);
        
        Router::stopNext();
    }
});

Middleware

What is middleware?

Middleware is a function who will be called before router callback, if middleware returns true router callback will be call also when middleware returns false you can specify error message and callback was not called.

How works middleware in EasyRouter?

Examples

When all middlewares from middleware return true then callback will be call.

function middleware(Request $req, Response $res) {
    $token = $res->headers['Authorization'] ?? null;

    if (!token) {
        return;
    }

    return true;
}

Router::GET('/api/v1/users', ['middleware'], function (Request $req, Response $res){
    // callback
});

Pass data from middleware to callback

If you want pass data from middleware to callback you must you 'locals' attribute from request. In middleware pass data to locals and they will be accessible in callback request.

Example

function findUser(Request $req, Response $res) {
    $id = $req->body['id'] ?? null;

    if (!$id) {
        $res -> status(400) -> json(array(
            "message" => "Id must be passed"
        ));
        return;
    }

    $user = findUser($id) ?? null;

    if (!$user) {
        $res -> status(400) -> json(array(
            "message" => "Id must be passed"
        ));
        return;
    }

    $req->locals['user'] = $user;
    return true;
}

Router::GET('/api/v1/user/', ['findUser'], function (Request $req, Reponse $res){
    $res->status(200)->json(array(
        "user" => $req->locals['user']
    ));
});