Download the PHP package giadc/json-api-response without Composer
On this page you can find all versions of the php package giadc/json-api-response. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download giadc/json-api-response
More information about giadc/json-api-response
Files in giadc/json-api-response
Package json-api-response
Short Description A package for handling JSON API responses
License MIT
Informations about the package json-api-response
GIADC JSON Response Package
currently: v0.1
This package makes it easy to return HTTP API responses that fit the JSON API standard.
Installation
Via Composer
Laravel
Add the following to the providers
array of your config/app.php
Usage
Basic Example:
Available functions:
Fractal Transformers
The GIADC JSON Response packages uses league/fractal
for the withItem()
, withCollection()
, & withPaginatedCollection()
responses.
See Fractal's documentation for more information regarding Transformers.
ResourceTransformer
ResourceTransformer adds the required transform
that pulls JsonApiResource's data from the required jsonSerialize
method. It also allows for automatic management of excludes
and fields
request parameters options.
JsonApiResource
Forces entities to have the following methods:
- getResourceKey: We can now reference this instead of hard coding this value very time.
- id: JsonAPI allows requires an id.
- jsonSerialize: Used in the new ResourceTransformer.
Use the JsonApiResource Item response to automatically pass $resourceKey
to the transformer.
$response->withResourceItem($item, $transformer, $headers)
Excludes
not supported by JsonAPI
Attributes may be excluded from JsonApiResource's response. A decent use case for this would be removing the config/ui/tracking from Campaigns when it's not needed. This would allow us to remove some redundant routes, providing the FE with more flexibility.
Example:
/api/export/campaigns?excludes[campaigns]=config,ui
Fields (https://jsonapi.org/format/#fetching-sparse-fieldsets)
An empty value indicates that no fields should be returned. ... If a client requests a restricted set of fields for a given resource type, an endpoint MUST NOT include additional fields in resource objects of that type in its response.
Example:
/api/permissionGroups?fields[permissionGroups]=name&include=permissions&fields[permissions]=
All versions of json-api-response with dependencies
doctrine/collections Version ^1.6
doctrine/orm Version ^2.11
giadc/json-api-request Version 3.0.4
league/fractal Version ^0.20
symfony/http-kernel Version ^7.0