Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisyue/auto-json-response-bundle
A Symfony bundle with a listener which converts controller returned data into a appropriate JsonResponse.
https://github.com/chrisyue/auto-json-response-bundle
converts-controller json json-response listener php serializer symfony symfony-bundle
Last synced: 4 days ago
JSON representation
A Symfony bundle with a listener which converts controller returned data into a appropriate JsonResponse.
- Host: GitHub
- URL: https://github.com/chrisyue/auto-json-response-bundle
- Owner: chrisyue
- License: mit
- Created: 2016-02-21T15:08:18.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2016-05-26T08:35:21.000Z (over 8 years ago)
- Last Synced: 2024-04-23T22:37:37.301Z (7 months ago)
- Topics: converts-controller, json, json-response, listener, php, serializer, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 13.7 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Auto Json Response Bundle
=========================
v1.1.1
A Symfony listener which converts controller result to a appropriate JsonResponse.
[](https://insight.sensiolabs.com/projects/2a0c6077-2542-41f9-ac29-c84ef7239771)
[](https://packagist.org/packages/chrisyue/auto-json-response-bundle)
[](https://packagist.org/packages/chrisyue/auto-json-response-bundle)
[](https://travis-ci.org/chrisyue/auto-json-response-bundle)
[](https://scrutinizer-ci.com/g/chrisyue/auto-json-response-bundle/?branch=develop)
[](https://scrutinizer-ci.com/g/chrisyue/auto-json-response-bundle/?branch=develop)
[](https://styleci.io/repos/52212031)
Features
--------
* Convert `null` to `JsonResponse(null, 204)`
* Convert `$array|$object` to `JsonResponse($array|$normalizedObject)`
* Convert `$array|$object` to `JsonResponse($array|$normalizedObject, 201)` if the method is `POST`
Installation
------------
```
$ composer require chrisyue/auto-json-response-bundle
```
```php
// AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new Chrisyue\Bundle\AutoJsonResponseBundle\ChrisyueAutoJsonResponseBundle(),
);
}
```
Usage
-----
This bundle will take effect if the route `_format` parameter is set to `json`.
```yaml
# in your route file:
api:
resource: ...
defaults:
_format: json
```
or in your controller file when you use annotation
```php
/**
* @Route(...)
*/
public function putAction(Response $response, $_format = 'json')
{
...
return $object;
}
```
or any other ways to set the `$_format` to `json`.
This bundle uses Symfony built-in serializer to normalize object, so the serialize feature should be enable if you want to deal with object:
```yaml
# app/config/config.yml
framework:
# ...
serializer:
enabled: true
```
with the power of the built-in serializer, we can do more configuration to meet our needs, like convert camalCase property to snake\_case:
```yaml
# app/config/config.yml
framework:
serializer:
enable_annotations: true
name_converter: serializer.name_converter.camel_case_to_snake_case
```
More information about serialize, just check [symfony official documentation](https://symfony.com/doc/current/cookbook/serializer.html)
After v1.1.0, this bundle support specify default serialization groups:
```yaml
#app/config/config.yml
chrisyue_auto_json_response:
serializer:
default_groups:
- 'group1'
- 'group2'
```