steve-rodrigue/entity-apis

This package is abandoned and no longer maintained. No replacement package was suggested.

dev-master 2016-02-19 17:40 UTC

Requires

• php: >=5.5
• phpunit/phpunit: 4.0.5
• sparkphp/spark: 0.9.0
• steve-rodrigue/apis: dev-master
• steve-rodrigue/dates: dev-master
• steve-rodrigue/https: dev-master
• steve-rodrigue/ids: dev-master

MIT

• Steve Rodrigue

README

This is a framework to create CRUD APIs easily.

Retrieve an Entity:

GET /{container}/{uuid}

Retrieve Entity lists:

GET /{container}

Params	Description
index	This is the index where the returned list of Entities will start.
amount	Amount of Entities returned

Insert an Entity:

POST /{container}

Params	Description
uuid	Uuid of the object.
created_on	Unix timestamp that represents when the object was created.

The posted params above are mandatory. Entity specific data must also be provided.

Update an Entity:

PUT /{container}/{original_uuid}

The original_uuid represents the uuid of the Entity we want to update, before updating it. Please note that it is possible to update the uuid of an Entity with this endpoint. However, it is not recommended.

The full information of the updated Entity must be provided in the posted params.

Delete an Entity:

DELETE /{container}/{uuid}