Skip to content
Snippets Groups Projects
README.md 918 B
Newer Older
Clemens John's avatar
Clemens John committed
# Laravel JsonApi
This package is built for the Laravel framework and provides basic classes
to help you building a REST API following the json:api standard.

## Features
 * Base controllers
  * **DocumentResourceController**:
  * **CollectionResourceController**:
  * **StoreResourceController**:
  * *ControllerResourceController*: TODO
  * **DefaultResourceController**:
  * **OneToOneResourceController**:
 * Specification features:
  * **Pagination**
  * **Filtering**
  * **Includes**
  * *Sorting: TODO*
 * Web Service Maturity
  * **HATEOAS**:
 * Validation:
  * **Request body validation**
Clemens John's avatar
Clemens John committed

## Manual
Clemens John's avatar
Clemens John committed
Please follow the [manual](doc/index.md).
Clemens John's avatar
Clemens John committed

Clemens John's avatar
Clemens John committed
## Resources
 * REST API Design Rulebook (Mark Masse)
Clemens John's avatar
Clemens John committed

# Contributing
## Submitting patches
Patches can be submitted using the Merge-Request link of our gitlab.

## Mailinglist
https://lists.ffnw.de/mailman/listinfo/netmon-dev

# License
See [License](LICENSE.txt)