Download the PHP package adamstipak/nette-rest-route without Composer

REST route for Nette Framework

Route automatically maps CRUD to Presenters and actions in the defined module. And creates parameters which are accessible in Presenter.

• 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 is detected from HTTP header . If header is not present Route try detect format from the URL (). If no format is in the URL Route use a default format .

Installation:

The best way to install Nette-RestRoute is using Composer:

Usage:

First parameter is a name of the module where the route will sends an Request. URL prefix will be generated. See examples.

Examples:

Second parameter is default format. By default the default format is . RestRoute support only 2 formats:

• json (default)
• xml

Examples

Read all:

URL: →
HTTP HEADER Accept:
Method: GET
Request body: Empty
Params:

Flag was dropped and Route automatically generate action readAll if no Resource ID was not found in the URL.

Read with resource ID

URL: →
HTTP HEADER Accept:
Method: GET
Request body: Empty
Params:

Query params:

URL: →
HTTP HEADER Accept:
Method: GET
Request body: Empty
Params:

Create:

URL: →
HTTP HEADER Accept:
Method: POST
Request body:

Params:

Update:

URL: →
HTTP HEADER Accept:
Method: PUT
Request body:

Params:

Partial update:

URL: →
HTTP HEADER Accept:
Method: PATCH
Request body:

Params:

Delete:

URL: →
HTTP HEADER Accept:
Method: DELETE
Request body: Empty
Params:

Options:

For more about OPTIONS documentation see w3.org.

URL: →
HTTP HEADER Accept:
Method: OPTIONS
Request body: Empty
Params:

Associations:

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

URL: →
HTTP HEADER Accept:
Method: GET, POST, PUT, DELETE
Request body: Empty
Params:

URL: →
HTTP HEADER Accept:
Method: GET, POST, PUT, DELETE
Request body: Empty
Params:

URL: →
HTTP HEADER Accept:
Method: GET, POST, PUT, DELETE
Request body: Empty
Params:

URL versioning:

RestRoute provides you with option to version your API in URL. Each version is represented by separate module in your application.

First, you define regexp which is used to detect if the version parameter is present in URL. It must be in the begging of the path. Then, you define version to module mapping. NULL key stands for default module, if version parameter doesn't get detected.

RestRoute will now map your requests to presenters like this (URL -> Presenter):

File uploads:

RestRoute reads standard PHP input and data puts to $data param in action. This is fit for one file upload or upload with chunks because it is a RAW data.

For multiple file upload RestRoute just set files when creates \Nette\Application\Request. In presenter just inject \Nette\Application\Request service and use these files.

Development

RestRoute is developed in Docker container via docker-compose command.

Example:

Attach to container: