solis/highway

HighWay is simple route engine structured by schemas

v0.2.0 2017-08-14 19:40 UTC

This package is auto-updated.

Last update: 2022-05-21 23:15:23 UTC


README

HighWay

HighWay é um mecanismo desenvolvido para abstrair o processo de gerenciamento de rotas a partir do Slim Framework 3

Como instalar?

Esse pacote foi estruturado para ser instalado por meio do composer

composer require solis/highway

Como utilizar?

Primeiramente é necessário definir um schema, representando as rotas a serem criadas para a aplicação

[
    {
       "request": {
         "uri": "/sample/get/",
         "method": "GET",
         "controller": {
           "class": "Sample\\Classes\\Sample",
           "method": "find"
         }
       },
       "middleware": {
          "auth"
        },
       "response": {
         "sType": "withJson"
       }
    }
]

Crie uma instancia da classe SlimHighWay e utilize o método estático make para vincular novas rotas a respectiva instancia

use HighWay\Wrappers\SlimApp\SlimHighWay;

$routes = json_decode(
    file_get_contents('path/to/Route.json'),
    true
);

$app = SlimHighWay::make(
    $routes
);

$app->run();

O SlimHighWay será responsável por criar instâncias de rotas utilizadas pelo Slim Framework 3 de acordo com as especificações existentes no schema.