Slim 3 Framework - Czy powinienem używać grup tras dla mojego API?

Question

powinienem używać tej struktury ...

require 'vendor/autoload.php'; 
$app = new \Slim\App; 

$app->get('/books', 'getBooks'); 
$app->get('/books/{id}', 'getBook'); 

$app->run(); 

function getBooks() { 
    // Return list of books 
} 

function getBook($id) { 
    // Return a single book 
} 

Albo ten „Trasa grupy” jeden?

require 'vendor/autoload.php'; 
$app = new \Slim\App; 

$app->group('/books', function() use ($app) { 
    $app->get('', function ($req, $res) { 
     // Return list of books 
    }); 

    $app->get('/{id:\d+}', function ($req, $res, $args) { 
     // Return a single book 
    }); 
}); 

$app->run(); 

Jaki jest lepszy sposób? Ta pierwsza wydaje się znacznie czystsza. Jestem stosunkowo nowy, więc nie mam pojęcia o zaletach i wadach.

Answer 1

Zazwyczaj używasz grup tras do organizowania podobnych zasobów lub treści, aby widocznie zobaczyć ich związek w kodzie. Grupy tras są również przydatne, jeśli chcesz umieścić specjalne warunki, takie jak oprogramowanie pośrednie, w określonej grupie. Na przykład możesz mieć sekcję administratora w swojej witrynie i chcesz upewnić się, że użytkownik jest faktycznie administratorem przed uzyskaniem dostępu do kontrolera.

$app->get('panel/admin', 'Admin/DashboardController:index')->add($adminAuth); 
$app->get('panel/admin/users', 'Admin/UserController:index')->add($adminAuth); 
$app->post('panel/admin/users', 'Admin/UserController:create')->add($adminAuth); 

Oczywiście rozsądniej byłoby grupować te trasy, ponieważ mają podobne cechy. Jeśli kiedykolwiek będziesz musiał zmienić coś na temat tych cech w przyszłości (jak typ oprogramowania pośredniego), wystarczy zrobić to tylko raz.

$app->group('/panel', function() use ($app) { 
    $app->group('/admin', function() use ($app) { 
     $app->get('', 'Admin/DashboardController:index'); 
     $app->get('/users', 'Admin/UserController:index'); 
     $app->post('/users', 'Admin/UserController:create'); 

    })->add($adminAuth); 
})->add($userAuth); 

Jest to również pomocne, gdyby kiedykolwiek chcesz poszerzyć przypadku użycia tego konkretnego URI, więc powiedzmy, że chcesz rozwałkować nową funkcję w panelu że regularni użytkownicy mogą korzystać.

$app->group('/panel', function() use ($app) { 

    $app->group('/admin', function() use ($app) { 

     $app->get('', 'Admin/DashboardController:index'); 
     $app->get('/users', 'Admin/UserController:index'); 
     $app->post('/users', 'Admin/UserController:create'); 

    })->add($adminAuth); 


    $app->get('', 'DashboardController:index'); 

})->add($userAuth); 

Chociaż nie jest to wielką wagę, to tylko dobra praktyka, aby układ cały swój kod tak zorganizowane, jak to możliwe, a grupy tras pozwalają to zrobić.