awurth / slim-rest-base

config/routes.php

<?php

use App\Rest\Router as RestRouter;

$router = new RestRouter($container['router'], $container['settings']['rest']);

/**
 * CORS Pre-flight request.
 */
$app->options('/{routes:.+}', function ($request, $response) {
    return $response;
});

/**
 * Security.
 */
$app->group('/', function () use ($container) {
    $this->post('register', 'registration.controller:register')->setName('register');

The variable $this seems to be never defined.

    $this->post('oauth/v2/token', 'token.controller:token')->setName('oauth_token');
    $this->get('user', 'token.controller:user')
        ->add($container['auth.middleware'])
        ->setName('user');
});

$app->get('/', 'app.controller:root')->setName('root');

/**
 *         URL          |           CONTROLLER            |     ROUTE
 * ---------------------|---------------------------------|----------------
 * GET /articles        | article.controller:getArticle    | get_articles
 * GET /articles/{id}   | article.controller:getArticles   | get_article
 * POST /articles       | article.controller:postArticle   | post_article
 * PUT /articles/{id}   | article.controller:putArticle    | put_article
 * DELETE /article/{id} | article.controller:deleteArticle | delete_article
 */
$router->crud('articles', 'article.controller');

// OR

/**
 * $router->cget('articles', 'article.controller');
 * $router->get('articles', 'article.controller');
 * $router->post('articles', 'article.controller');
 * $router->put('articles', 'article.controller');
 * $router->delete('articles', 'article.controller');
 */

// With options
/**
 * $options = [
 *      'key' => 'id',
 *      'requirement' => '[0-9]+',
 *      'singular' => 'article'
 * ];
 *
 * $router->crud('articles', 'article.controller', [], $options);
 *
 * OR
 *
 * $router->get('articles', 'article.controller', $options);
 * ...
 */

/***********************************************************/
/* -------------------- SUB RESOURCES -------------------- */
/***********************************************************/

/**
 *                        URL                         |                   CONTROLLER                  |        ROUTE
 * ---------------------------------------------------|-----------------------------------------------|------------------------
 * GET /articles/{article_id}/comments                | article.comment.controller:getArticleComments   | get_article_comments
 * GET /articles/{article_id}/comments/{comment_id}   | article.comment.controller:getArticleComment    | get_article_comment
 * POST /articles/{article_id}/comments               | article.comment.controller:postArticleComment   | post_article_comment
 * PUT /articles/{article_id}/comments/{comment_id}   | article.comment.controller:putArticleComment    | put_article_comment
 * DELETE /article/{article_id}/comments/{comment_id} | article.comment.controller:deleteArticleComment | delete_article_comment
 */
$router->subCrud('articles', 'comments', 'article.comment.controller');

// OR

/**
 * $router->cgetSub('articles', 'comments', 'article.controller');
 * $router->getSub('articles', 'comments', 'article.controller');
 * $router->postSub('articles', 'comments', 'article.controller');
 * $router->putSub('articles', 'comments', 'article.controller');
 * $router->deleteSub('articles', 'comments', 'article.controller');
 */

// With options
/**
 * $options = [
 *      'parent_key' => 'article_id',
 *      'parent_requirement' => '[0-9]+',
 *      'sub_key' => 'comment_id',
 *      'sub_requirement' => '[0-9]+',
 *      'parent_singular' => 'article',
 *      'sub_singular' => 'comment'
 * ];
 *
 * $router->subCrud('articles', 'comments', 'article.comment.controller', [], $options);
 *
 * OR
 *
 * $router->getSub('articles', 'comments', 'article.controller', $options);
 * ...
 */