k7/nette-rest-route

Rest route for Nette Framework

Tuesday, April 5, 2016
by keeper7
Repository
1 Watchers
0 Stars
12 Installations

PHP
0 Dependents
0 Suggesters
19 Forks
0 Open issues
17 Versions
0 % Grown

The README.md

REST route for Nette Framework

, _(*1)

Route automatically maps CRUD to Presenters and actions in the defined module. And creates parameters which are accessible in Presenter., _(*2)

format
id (autodetected)
associations (an array with associations)
data (raw data from the request)
query (an array of items from the query string)

Format detection:

Variable $format is detected from HTTP header Accept. If header is not present Route try detect format from the URL (.../foo.json). If no format is in the URL Route use a default format json., _(*3)

Installation:

The best way to install Nette-RestRoute is using Composer:, _(*4)

$ composer require adamstipak/nette-rest-route

Usage:

use AdamStipak\RestRoute;

// $router is an instance of Nette\Application\Routers\RouteList  

// No parameters needed. Presenter name will be generated.
$router[] = new RestRoute;

// With module.
$router[] = new RestRoute('Api');

// With module and xml as a default format.
$router[] = new RestRoute('Api', 'xml');

First parameter is a name of the module where the route will sends an Request. URL prefix will be generated. See examples., _(*5)

Examples:

NULL      => /<generated presenter name>
'Api'     => /api/<generated presenter name>
'My:Api'  => /my/api/<generated presenter name>
...

Second parameter is default format. By default the default format is json. RestRoute support only 2 formats:, _(*6)

json (default)
xml

Examples

Read all:

URL: /api/users → \ApiModule\UsersPresenter::actionReadAll
HTTP HEADER Accept: application/json
Method: GET
Request body: Empty
Params:, _(*7)

format = json
associations = array(0)
data = ""
query = array(0)

Flag readAll was dropped and Route automatically generate action readAll if no Resource ID was not found in the URL., _(*8)

Read with resource ID

URL: /api/users/123 → \ApiModule\UsersPresenter::actionRead
HTTP HEADER Accept: application/json
Method: GET
Request body: Empty
Params:, _(*9)

format = json
id = 123
associations = array(0)
data = ""
query = array(0)

Query params:

URL: /api/users?foo=bar&page=1 → \ApiModule\UsersPresenter::actionRead
HTTP HEADER Accept: application/json
Method: GET
Request body: Empty
Params:, _(*10)

format = json
associations = array(0)
data = ""
query = array(
    foo => "bar"
    page => 1
)

Create:

URL: /api/users → \ApiModule\UsersPresenter::actionCreate
HTTP HEADER Accept: application/json
Method: POST
Request body:, _(*11)

{
    "foo": "bar",
    "nested": {
        "foo": "bar"    
    }
}

Params:, _(*12)

format = json
associations = array(0)
data = {"foo": "bar", "nested": {"foo": "bar"}}
query = array(0)

Update:

URL: /api/users/123 → \ApiModule\UsersPresenter::actionUpdate
HTTP HEADER Accept: application/json
Method: PUT
Request body:, _(*13)

{
    "foo": "bar",
    "nested": {
        "foo": "bar"    
    }
}

Params:, _(*14)

format = json
id = 123
associations = array(0)
data = {"foo": "bar", "nested": {"foo": "bar"}}
query = array(0)

Partial update:

URL: /api/users/123 → \ApiModule\UsersPresenter::actionPartialUpdate
HTTP HEADER Accept: application/json
Method: PATCH
Request body:, _(*15)

{
    "foo": "bar",
    "nested": {
        "foo": "bar"    
    }
}

Params:, _(*16)

format = json
id = 123
associations = array(0)
data = {"foo": "bar", "nested": {"foo": "bar"}}
query = array(0)

Delete:

URL: /api/users/123 → \ApiModule\UsersPresenter::actionDelete
HTTP HEADER Accept: application/json
Method: DELETE
Request body: Empty
Params:, _(*17)

format = json
id = 123
associations = array(0)
data = ""
query = array(0)

Options:

For more about OPTIONS documentation see w3.org., _(*18)

URL: /api/users → \ApiModule\UsersPresenter::actionOptions
HTTP HEADER Accept: application/json
Method: OPTIONS
Request body: Empty
Params:, _(*19)

format = json
associations = array(0)
data = ""
query = array(0)

Associations:

Last item (pair) before . is main resource. Everything what is before the last item are associations (apigee.com)., _(*20)

URL: /api/users/1/comments → \ApiModule\CommentsPresenter::actionRead|actionCreate|actionUpdate|actionDelete
HTTP HEADER Accept: application/json
Method: GET, POST, PUT, DELETE
Request body: Empty
Params:, _(*21)

format = json
associations = array(
    users => 1
)
data = ""
query = array(0)

URL: /api/users/123/comments/456 → \ApiModule\CommentsPresenter::actionRead|actionCreate|actionUpdate|actionDelete
HTTP HEADER Accept: application/json
Method: GET, POST, PUT, DELETE
Request body: Empty
Params:, _(*22)

format = json
id = 456
associations = array(
    users => 123
)
data = ""
query = array(0)

URL: /api/users/1/blogs/2/comments → \ApiModule\CommentsPresenter::actionRead|actionCreate|actionUpdate|actionDelete
HTTP HEADER Accept: application/json
Method: GET, POST, PUT, DELETE
Request body: Empty
Params:, _(*23)

format = json
id = 1
associations = array(
    users => 1
    blogs => 2
)
data = ""
query = array(0)

Overriding methods PUT, PATCH, DELETE

Methods PUT, PATCH and DELETE can be overriden via:, _(*24)

HTTP header `X-HTTP-Method-Override`

Example:, _(*25)

X-HTTP-Method-Override: <PUT|PATCH|DELETE>

Query param `__method`

Example:, _(*26)

?__method=<PUT|PATCH|DELETE>

Development

RestRoute is developed in Docker container via docker-compose command., _(*27)

Example:, _(*28)

$ docker-compose run --rm default install  # install deps via composer
$ docker-compose run --rm default  # runs tests in container

Attach to container:, _(*29)

$ docker-compose run --rm default bash # runs bash in container and attach tty

The Versions

05/04 2016

dev-master

9999999-dev https://github.com/newPOPE/Nette-RestRoute

Rest route for Nette Framework

library nette-rest-route