fire015/json-routes

Define your routes in laravel using JSON files

json-routes

, _(*1)

Define your routes in Laravel using JSON files., _(*2)

Installation

PHP 5.4+, Laravel 4.2+, and Composer are required., _(*3)

To get the latest version of JSON Routes, simply add the following line to the require block of your composer.json file:, _(*4)

"fire015/json-routes": "~1.0"

You'll then need to run composer install or composer update to download it and have the autoloader updated., _(*5)

Once JSON Routes is installed, you need to register the service provider. Open up app/config/app.php and add the following to the providers key., _(*6)

'Fire015\JsonRoutes\JsonRoutesServiceProvider', _(*7)

Configuration

To get started, first publish the package config file:, _(*8)

$ php artisan config:publish fire015/json-routes

This will create a config file which allows you to define the path to the JSON files (by default this is a folder within app/config called routes)., _(*9)

Usage

Presuming we have created the app/config/routes folder as specified above, create a file in that folder called routes.json where we can define our routes. Here is an example of that file:, _(*10)

{
    "GET": {
        "/": {
            "uses": "HomeController@showIndex"
        },
        "about": {
            "uses": "AboutController@showIndex"
        }
    },
    "POST": {
        "user/{id}": {
            "uses": "UserController@storeUser"
        }
    }
}

You simply define the route URI as the key under each method and the usual route options as if it were an array in the Route::(get|post|put|patch|delete|options) static methods., _(*11)

You can also split your routes up into sub-files and folders. For example you can define user/account in any of the following places:, _(*12)

• /user.json
• /user/routes.json
• /user/account.json
• /user/account/routes.json