ondrs / RestApiBase

base components for JSON REST API

REST API Base

Base components for JSON REST API for Nette applications

namespace: Clevis\RestApi

###ApiRoute Route for REST requests

usage:

// for POST only
$router[] = new RestRoute('/api/login', 'User:login', RestRoute::METHOD_POST);

// for SSL secured request
$router[] = new RestRoute('/api/login', 'User:login', RestRoute::METHOD_POST | RestRoute::SECURE);

// for all methods
$route = new RestRoute('/api/login', 'User:', RestRoute::RESTFUL);
$router[] = $route;
// optional - set HTTP method to presenter action translation table. (these are defults)
$route->setRestDictionary(array(
	'GET' => 'get',
	'POST' => 'post',
	'PUT' => 'put',
	'PATCH' => 'patch',
	'DELETE' => 'delete',
))

###ApiPresenter Simplified presenter for JSON requsts and responses

Presenter lifecycle:

1. calls startup()

• you can configure presenter internals here

2. SSL validation

• it is recomended to always use SSL for API
• set $checkSsl to FALSE for testing without SSL (by default is on)

3. API version validation based on X-Api-Version header

• set $minApiVersion and $minApiVersion to configure

4. optional user authentication based on X-Api-Key header

• set $checkAccess to FALSE to turn autenication off (by default is on)

5. calls actionXyz()

• remember ApiPresenter does not use methods named renderXyz as Nette presenters do (it does not render anything)

6. filtering of response data

• all DateTime values are converted to string

7. returns the response

####returning results: You can either:

• write data to the $payload property
• or use method sendSuccessResponse($data, $responseCode)
• or sendErrorReponse($responseCode, $message) for errors

###ApiResponse Sends response data to client