README

This package gonna make all the essential HTTP ressources for your API projetc.

How to install

composer require patrick-barreto/Http

How to Use

Important: Make sure that in your server configuration file you are redirecting all requests to index.php.

Basically you will use the Http abstration to manipulate all ressources from this package.

use Http\Http;

Roates

POST

Http::post(string $endpoint, Closure $controllerCallBack, array $middlewares = []);

GET

Http::get(string $endpoint, Closure $controllerCallBack, array $middlewares = [])

PUT

Http::put(string $endpoint, Closure $controllerCallBack, array $middlewares = [])

PATCH

Http::patch(string $endpoint, Closure $controllerCallBack, array $middlewares = [])

DELETE

Http::delete(string $endpoint, Closure $controllerCallBack, array $middlewares = [])

Important: For the same http method declaration, the routes order must be:

statics routes first,
and dinamic routes last

Middlewares

Create a middleware

You need to import Middleware Interface to certificate that you were implemented a valid Middleware sintaxe for system.

Your middleware must be a class like this:

<?php

use Http\Middleware\MiddlewareInterface;

class Middleware implements MiddlewareInterface {
    public function handler($request, $callback){
        //Put your code here, change the $request instance..
        return $callback($request);
    }
}

Important: This is the instance of request that you can manipulate and insert information from your system. This instance is accessible for you in the callback function parameter that you need to pass in the routes.

Use yours middlewares

To use your middlewares you need to fill the system with theirs namespaces and inform if the execution is default or not.

Add new middleware namespace to middlewares namespaces map

Http::middleware(string $name, string $namespace, bool $defaultForAllRoutes = false)

Default middlewares are executed for all routes.

important: Like the routes, the order of default middlewares declaration are very important. It will be the execution order. For middlewares not default, to use them you need to inform the name of middleware, in execution order to be executed after default middlewares.

Response

To send a response for anyone request you cant use Http::response, the method have default values for default responses.

Http::response($response = ['success'=>true],  int $statusCode = 200, array $headers = ["Content-Type" => "application/json"]) ;

Request Class

The Request Class store usefull data from the request. This informations are static and acessible in anywhere in your sistem.

During the middlewares you can increment your personal data into request intance class that will be give to you in callback param on routes declaration, where you will pass to your controller all request or specfic data.

Your specific data will not be a static data, will be a instance data. The static data will be access by these bellow methods

You can find here:

HTTP Method
HTTP Headers
Request Route
Query Strings
Path Params
Request Body

The first param in callback is reserved to request, you are free to name it as you want.

Methods

This method is responsable to return the request method

public static function getMethod()

return string

This method is responsable to return the request Headers

public static function getHeaders()

return array

This method is responsable to return the request param data, path params and query strings

public static function getRoute()

return array|string

This method is responsable to set the query string data.

public static function getQueryStrings()

return array

This method is responsable to get the path params

public static function getPathParams()

return array

This method is responsable to return the request all data method

public static function getAllStaticData()

return array

This method is responsable to return the request Body

public static function getBody()

return array

Run

After routes and middlewares declaration and midlleware names mapped, start the aplication.
```
Http::run()
```

CORS

To configurate your CORS policies, you can use CORS Method.

Http::CORS(
            array $accessControlAllowOrigin = ['*'], 
            array $accessControlAllowMethods = ['POST', 'GET', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'],
            array $accessControlAllowHeaders = ['Content-Type'],
            bool $accessControlAllowCredentials = false,
            array $accessControlExposeHeaders = ['Content-Type'],
            int $accessControlMaxAge = 86400 
        );

Important: This method will make a global config CORS for all routes. If you need any more datailed configuration, you can create a Middleware and change an specific headers.

EXEMPLES:

Exemple to use this package

Middleware Delcaration

<?php
namespace Api\Middlewares;

use Http\Middleware\MiddlewareInterface;

class Authorization implements MiddlewareInterface {
    public function handler($request, $callback){
        $request->auth = $this->validadeToken($request);
        return $callback($request);
    }

    private function validadeToken($request){
        //Validade with request headers and return true or false
    }
}

<?php
namespace Api\Middlewares;

use Http\Middleware\MiddlewareInterface;

class AccessTokenValidade implements MiddlewareInterface {
    public function handler($request, $callback){
        //Validade your accessToken
        return $callback($request);
    }
}

MiddlewaresMap.php

This file will fill Midleware Queue with middleware namespace and names.

<?php
use Http\Http;

//Middlewares default
Http::middleware('AccessTokenValidade', 'Api\Middlewares\AccessTokenValidade', true);

//Middlewares to routes use.
Http::middleware('Auth', 'Api\Middlewares\Authorization');

Routes.php

This will be the file when we will make routes declarate. It can be with more than one file too..

<?php

use Http\Http;

Http::post('/createAccount', function($request) {
    $return = new YourController($request);
    Http::response());

Http::post('/login', function($request) {
    $return = new YourController($request);
    Http::response($return, 
                    200, 
                    [
                        ["Content-Type" => "application/json"],
                        ['Authorization' => $return['JWT']],
                    ]);
                });

Http::get('/users', function($request) {
    $return = new YourController($request);
    Http::response($return)
}, 
['Auth']);

To load all your routes to system you can use the

    Http::loadRoutesFromPath(string $dirRoutesName);

It will load all files from an path. Use it it before run app.

index.php

    <?php

    use Http\Http;

    require_once "./vendor/autoload.php"; //autoload PSR-4
    require_once "./MiddlewaresMap.php";

    Http\Http::CORS();

    Http::loadRoutesFromPath('./Routes/')
    
    //if you need to put anything more in this system part, put here.

    Http::run();

patrick-barreto / http

Maintainers

Details