Search by 
jf / json-api
Classes to implement APIs according to JSON API specification.
1.3.7
2024-12-18 15:17 UTC
Requires
None
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Classes to implement APIs according to JSON API specification.
Instalación
Control de versiones
Este proyecto puede ser descargado usando git. Para ello se debe ejecutar en una consola:
git clone https://www.gitlab.com/jfphp/json-api.git
cd json-api
Composer
Este proyecto usa como gestor de dependencias Composer el cual puede ser instalado siguiendo las instrucciones especificadas en la documentación oficial del proyecto.
Para instalar el paquete jf/json-api usando este manejador de paquetes se debe ejecutar:
composer require jf/json-api
Archivos
Clases
| Nombre | Descripción |
|---|---|
| 📖 jf\JsonApi\ABase | Base class for all classes in jf\JsonApi package. |
| 📖 jf\JsonApi\ACollection | Base class for collections. |
| 📖 jf\JsonApi\AExtras | Base class for classes that accept a list of values with unspecified attributes. |
| 📖 jf\JsonApi\Attributes | The value of the attributes key MUST be an object (an attributes object). |
| 📖 jf\JsonApi\Error | A server MAY choose to stop processing as soon as a problem is encountered, or it MAY continue processing and encounter multiple problems. |
| 📖 jf\JsonApi\ErrorLink | A links object containing error references. |
| 📖 jf\JsonApi\ErrorSource | An object containing references to the source of the error. |
| 📖 jf\JsonApi\Errors | Collection of errors. |
| 📖 jf\JsonApi\JsonApi | A JSON API document MAY include information about its implementation under a top level jsonapi member. |
| 📖 jf\JsonApi\Link | Each member of a links object is a link. |
| 📖 jf\JsonApi\Links | Where specified, a links member can be used to represent links. |
| 📖 jf\JsonApi\Manager | Request and response manager. |
| 📖 jf\JsonApi\Meta | Where specified, a meta member can be used to include non-standard meta-information. |
| 📖 jf\JsonApi\Pagination | Pagination links for the primary data. |
| 📖 jf\JsonApi\Query\Factory | Factory for handlers of query parameters. |
| 📖 jf\JsonApi\Query\Fields | Allows you to select which attributes appear in the result. |
| 📖 jf\JsonApi\Query\Filter | Construct the filter to use to restrict the result to the elements returned. |
| 📖 jf\JsonApi\Query\Includes | It is used to display the result of related resources. |
| 📖 jf\JsonApi\Query\Page | Allows you to paginate the list of results. |
| 📖 jf\JsonApi\Query\Sort | Allows you to sort the results. |
| 📖 jf\JsonApi\Relationship | Represent references from the resource object in which it's defined to other resource objects. |
| 📖 jf\JsonApi\Relationships | The value of the relationships key MUST be an object (a relationships object). |
| 📖 jf\JsonApi\Resource | The document's primary data is a representation of the resource or collection of resources targeted by a request. |
| 📖 jf\JsonApi\ResourceIdentifier | A resource identifier object is an object that identifies an individual resource. |
| 📖 jf\JsonApi\Resources | Collection of resources. |
| 📖 jf\JsonApi\Root | A JSON object MUST be at the root of every JSON API request and response containing data. |
| 📖 jf\JsonApi\ValidationException | Exception thrown by default by the validator. |
| 📖 jf\JsonApi\Validator | Validates the request. |
Interfaces
| Nombre | Descripción |
|---|---|
| 📖 jf\JsonApi\IResource | Interface for classes used as resources. |
| 📖 jf\JsonApi\Query\IQuery | Interface for query parsers. |
Traits
| Nombre | Descripción |
|---|---|
| 📖 jf\JsonApi\TResource | Trait que implementa la interfaz jf\JsonApi\IResource. |
Diagrama
Generado con ❤️ usando jfGeneratorDoc 0.1.0