lydic-group/rapid-api-crud

This software enables rapid and flexible Symfony CRUD API development.

0.1.12 2021-08-22 19:54 UTC

Requires

• php: >=7.4
• doctrine/orm: ^2.8
• lydic-group/filtering: ^0.1.0
• symfony/framework-bundle: ^5.2
• symfony/http-foundation: ^5.2
• symfony/http-kernel: ^5.2
• symfony/messenger: ^5.2
• symfony/property-access: ^5.2
• symfony/routing: ^5.2
• symfony/serializer: ^5.2
• symfony/string: ^5.2
• symfony/validator: ^5.2

MIT

• Thijs Schalk
• Willem Turkstra

README

This software enables rapid and flexible Symfony API CRUD development.

What it does

• Creates an endpoint for CRUD actions on a given entity (configurable)
• Validates the entity by using the annotations in the class
• Ex-/Includes specific properties from output by using the @Groups annotation (e.g. exclude $id from 'detail', but not from 'list')
• Association fields (relations to other entities) will be normalized to the ID of the entity and vice versa.

Endpoints

When you extend the RapidApiCrudController, these endpoints will become accessible automagically:

Action	HTTP Method	Example URL	HTTP Response code	HTTP Response body
Create an entity	POST	/users	201	Created entity
List all entities (*)	GET	/users	200	Array of entities
Find one entity	GET	/users/1	200	Entity
Update an entity	PUT	/users/1	200	Updated entity
Delete an entity	DELETE	/users/1	204	-
Find association (**)	GET	/users/1/best-friends	200	ToOne: A single associated entity ToMany: An array of associated entities
Create association (**)	POST	/users/1/best-friends/2	201	Entity
Delete association (**)	DELETE	/users/1/best-friends/2	204	-

(*) These endpoints accepts some query parameters.

(**) These endpoints work for ToOne and ToMany associations. best-friends is the name of the association on the User model: $bestFriends.

Filtering

There are several implementations for filtering. You can change the filter mode using the ControllerConfig.

Filter	Example
Basic	/users?name=Steve
Extended	/users?filter=name:eq:Steve OR age:gt:21
DQL (Doctrine Query Language)	/users?filter=entity.name = 'Steve'

Sorting

You can also add sorting to your result: /users?sort=age ASC

Pagination

You can also add paging queries: /users?page=1&limit=10

Associated entities

Associated entities are normalized to their ID by default for performance reasons.
If you want to include the entire entity you can use a query param with (comma separated) association names. For example:
On the list endpoint: /users?include=bestFriends
On the detail endpoint: /users/1?include=bestFriends
On an assocation endpoint: /users/1/best-friends?include=car
This will only go 1 deep.

How to use

The fast/flexible way

1. Create an entity and implement the RapidApiCrudEntity (optionally use Symfony validation annotations)
2. Create a controller that extends the RapidApiCrudController
3. Implement the required method(s) and use the config DTO to enable/disable certain routes

The fully customizable way

1. Create or edit an existing model and implement the RapidApiCrudEntity interface
2. Create or edit an existing controller and don't extend the RapidApiCrudController
3. Inject the CrudService
4. Create the desired methods/routes and use the logic from CrudService to be up and running super fast

Feel free to use the ControllerFacade for specific route functionality. If you need even more specific logic, use the CrudService.

Roadmap

Take a look at our kanban board here

Support

Hey 👋 If you like our libraries. Support us by buying us a coffee!