It can be done via controller annotations and global defaults.
For needs of this document, term Field means any model attribute or relation.
This configures the \Trikoder\JsonApiBundle\Listener\KernelListener listener
kernel.view event priority. The value must be an integer.
This configures the \Trikoder\JsonApiBundle\Listener\KernelListener listener
kernel.exception event priority. The value must be an integer.
Model class that this controller is responsible of. Defaults to \stdClass.
Can be name of the service or reference to instance that implements any of these interfaces:
\Trikoder\JsonApiBundle\Contracts\RepositoryInterface\Trikoder\JsonApiBundle\Repository\RepositoryResolverInterface
Defaults to built-in service trikoder.jsonapi.doctrine_repository_factory that is by default Trikoder\JsonApiBundle\Bridge\Doctrine\RepositoryFactory
that returns Trikoder\JsonApiBundle\Bridge\Doctrine\DoctrineRepository
Must implement \Trikoder\JsonApiBundle\Contracts\RequestBodyDecoderInterface.
You can use this to redefine how regular json api body payload is transformed into controllers request body. You can remap fields, change formats, etc.
Defaults to \Trikoder\JsonApiBundle\Services\RequestDecoder\RequestBodyDecoderService .
Decoder which is used when accessing relationship endpoint.
Must implement \Trikoder\JsonApiBundle\Contracts\RequestBodyDecoderInterface.
Defaults to trikoder.jsonapi.relationship_request_body_decoder which is \Trikoder\JsonApiBundle\Services\RequestDecoder\RelationshipRequestBodyDecoder by default.
Validator which is used when accessing non-relationship endpoint.
Must implement \Trikoder\JsonApiBundle\Contracts\RequestBodyValidatorInterface.
Defaults to trikoder.jsonapi.request_body_validator which is \Trikoder\JsonApiBundle\Services\RequestDecoder\RequestBodyDecoderService by default.
Validator which is used when accessing relationship endpoint.
Must implement \Trikoder\JsonApiBundle\Contracts\RequestBodyValidatorInterface.
Defaults to trikoder.jsonapi.relationship_request_body_validator which is \Trikoder\JsonApiBundle\Services\RequestDecoder\RelationshipValidatorAdapter by default.
Array of fixed filtering defined for this controller. It is applied to all load action from repository (index, show, update, delete). Defaults to empty array.
Example of fixed filtering would be fixedFiltering={"customer":true} as seen in \Trikoder\JsonApiBundle\Tests\Resources\Controller\Api\User\CustomerController
Which include paths are allowed in request params. [] for nothing is allowed, null for everything is allowed. Defaults to null.
Defines if extra params other than defined by jsonapi are allowed in the request params. Defaults to false.
List of fields that is allowed to sort by. [] for nothing is allowed, null for everything is allowed. Defaults to null.
List of fields that is allowed to filter by. [] for nothing is allowed, null for everything is allowed. Defaults to null.
List of fields that can be requested in the api. [] for nothing is allowed, null for everything is allowed. Defaults to null.
Default sorting array. Defaults to [];
Example of default sort would be defaultSort={"email":"desc", "id":"desc"}
Default pagination array. Defaults to [];
Used to generate new (empty) model to be used in create action. Can be name of the service or reference to instance that implements any of these interfaces:
\Trikoder\JsonApiBundle\Model\ModelFactoryInterface\Trikoder\JsonApiBundle\Model\ModelFactoryResolverInterface
Defaults to built in service trikoder.jsonapi.simple_model_factory that by default is \Trikoder\JsonApiBundle\Model\Factory\SimpleModelFactory
List of fields that are allowed to be sent in create payload. [] for nothing is allowed, null for everything is allowed. Defaults to null.
Roles required to access create action. [] for nothing is allowed, null for everything is allowed. Defaults to null.
List of fields that are allowed to be sent in update payload. [] for nothing is allowed, null for everything is allowed. Defaults to null.
Roles required to access update action. [] for nothing is allowed, null for everything is allowed. Defaults to null.
Roles required to access delete action. [] for nothing is allowed, null for everything is allowed. Defaults to null.
Global configuration is done by defining trikoder_json_api section in application configuration.
Global defaults configuration example can be found in example.yml.
Each controller can define it's own configuration by class annotation.
Example of annotation configuration can be found in exampleAnnotation.php.
The crud actions can be enabled by using traits that come with the bundle. Each action of CRUD has corresponding trait (or several of them for simple/specific behaviours).
Incomplete implementation - to be implemented
Trait which adds support for updating To-Many Relationships with POST and DELETE methods.
In order to use it, controller attribute _jsonapibundle_relationship_endpoint must be set to true so code outside controller can treat request as relationship request.
To configure which relationships can be updated see example.
Creates /relationships/ endpoints for model and uses UpdateRelationshipTrait.
If UpdateRelationshipTrait returns model, return 204 No Content response, otherwise return response received from UpdateRelationshipTrait.