Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paveldanilin/request-body-bundle
A Symfony bundle for the request body mapping to object
https://github.com/paveldanilin/request-body-bundle
annotation bundle php request-body symfony symfony-bundle
Last synced: about 2 months ago
JSON representation
A Symfony bundle for the request body mapping to object
- Host: GitHub
- URL: https://github.com/paveldanilin/request-body-bundle
- Owner: paveldanilin
- Created: 2021-01-03T14:21:43.000Z (almost 4 years ago)
- Default Branch: 2.2.x
- Last Pushed: 2022-10-20T03:24:31.000Z (about 2 years ago)
- Last Synced: 2024-08-17T22:33:53.871Z (4 months ago)
- Topics: annotation, bundle, php, request-body, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 61.5 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
### @RequestBody annotation
RequestBody is a way to populate objects and inject them as controller method arguments.
The Request body converter makes it possible to deserialize the request body into an object.
#### Install
`composer require paveldanilin/request-body-bundle`
#### Usage
By default, RequestBody is trying to populate the single defined parameter.
```php
/**
* @Route("/users", methods={"POST"})
*
* @RequestBody
*
* @param User $user
* @return Response
*/
public function createUser(User $user): Response
{
return new Response();
}
```
If a method has several parameters we should explicitly define the parameter for populating.
```php
/**
* @Route("/users", methods={"PATCH"})
*
* @RequestBody("user")
*
* @param int $userId
* @param User $user
* @return Response
*/
public function editUser(int $userId, User $user): Response
{
return new Response();
}
```
#### Deserialization
We can specify a deserialization context.
More about the object deserialization you can find [here](https://symfony.com/doc/4.4/components/serializer.html#deserializing-an-object)
```php
/**
* @Route("/users", methods={"PATCH"})
*
* @RequestBody("user", deserializationContext={"someAttribute"="value"})
*
* @param int $userId
* @param User $user
* @return Response
*/
public function editUser(int $userId, User $user): Response
{
return new Response();
}
```
Also, it is possible to replace the deserialization error message with a custom message.
```php
/**
* @Route("/users", methods={"PATCH"})
*
* @RequestBody("user", deserializationError="Bad DTO")
*
* @param int $userId
* @param User $user
* @return Response
*/
public function editUser(int $userId, User $user): Response
{
return new Response();
}
```
#### Validation
By default, validation will be performed for each assertion which is defined per DTO.
For the following DTO will be performed two assertions after a deserialization process.
```php
class User
{
/**
* @Assert\NotBlank(allowNull=false)
* @Assert\Type(type="string")
*
* @var string
*/
public $name;
}
```
We can avoid a validation process by defining the `validationGroups` attribute as an empty array.
```php
/**
* @Route("/users", methods={"PATCH"})
*
* @RequestBody("user", validationGroups={})
*
* @param int $userId
* @param User $user
* @return Response
*/
public function editUser(int $userId, User $user): Response
{
return new Response();
}
```
Or we can explicitly define validation groups by means of `validationGroups` attribute.
```php
/**
* @Route("/users", methods={"PATCH"})
*
* @RequestBody("user", validationGroups={"edit"})
*
* @param int $userId
* @param User $user
* @return Response
*/
public function editUser(int $userId, User $user): Response
{
return new Response();
}
```
You can read [more](https://symfony.com/doc/4.4/validation.html) about a validation process.
#### Debug
The bundle comes with a handy console command which shows all controllers that use the @RequestBody annotation
```
$ php bin/console debug:request-body
+--------------------+----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------+--------------------+
| Class | Method | Bind Param | Param Type | Validation Context |
+--------------------+----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------+--------------------+
| TestUserController | createUser | user | paveldanilin\RequestBodyBundle\Tests\Fixtures\User | all |
| TestUserController | editUser | Method does not have such parameter 'user' | | all |
| TestUserController | noTypeHint | The 'user' parameter does not have a type hint | | all |
| TestUserController | autoMap | user | paveldanilin\RequestBodyBundle\Tests\Fixtures\User | all |
| TestUserController | autoMapNoParams | Could not autodetect parameter for body mapping. The method does not have parameters. | | all |
| TestUserController | autoMapTooManyParams | Could not autodetect parameter for body mapping. The method has too many parameters. | | all |
+--------------------+----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------+--------------------+
```
#### Test
- `composer test`