torchline/frest

There is no license information available for the latest version (1.0-beta) of this package.

1.0-beta 2013-10-16 03:16 UTC

Requires

• php: >=5.3.0

Requires (Dev)

• phpunit/phpunit: 3.7.*

Unknown License

README

This framework automatically fits a facade layer around your SQL tables and provides very configurable and powerful API endpoints. Just specify the desired behavior in a json file for each resource and you're ready to go.

Define what is possible to be read back, what is read back by default, how it will look, etc.

Features

• URL routing for resources
• CRUD operations
• unlimited related resource nesting in a single request
• functions on resources for custom behavior
• type checking
• pagination
• conditional searching (>, <, LIKE, etc.)

Installation

Require this package with composer:

composer require torchline/frest

Querying

Function names: gt, gte, lt, lte, in, like

		?username=like(FullMetal~) - starts with
		?money=gt(50) - greater than
		?hair=in(blonde,black,red) - is one of

Partial objects:

		?fields=id,username,email - read only these fields back
		?fields=* - read all fields back
		(if no fields specified, it goes to default)

		?fields=name,owner(id, firstName, lastName) - do partial reads on child objects

Miscellaneous:

	suppress_http_error_codes=true - make request always return 200 with actual http code embeded in response