https://github.com/huntie/laravel-simple-jsonapi

Simpler JSON API support for Laravel
https://github.com/huntie/laravel-simple-jsonapi

api json-api laravel rest serializer testbench

Last synced: about 2 months ago
JSON representation

Simpler JSON API support for Laravel

• Host: GitHub
• URL: https://github.com/huntie/laravel-simple-jsonapi
• Owner: huntie
• License: mit
• Created: 2016-04-17T18:56:58.000Z (about 9 years ago)
• Default Branch: 1.0.0-alpha
• Last Pushed: 2018-08-29T22:34:29.000Z (almost 7 years ago)
• Last Synced: 2025-05-01T20:57:26.059Z (about 2 months ago)
• Topics: api, json-api, laravel, rest, serializer, testbench
• Language: PHP
• Homepage:
• Size: 284 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
![](./banner.png)

# laravel-simple-jsonapi

[![Build status](https://img.shields.io/scrutinizer/build/g/huntie/laravel-simple-jsonapi.svg?maxAge=60&style=flat-square)](https://scrutinizer-ci.com/g/huntie/laravel-simple-jsonapi/build-status/1.0.0-alpha)

[![Code quality](https://img.shields.io/scrutinizer/g/huntie/laravel-simple-jsonapi.svg?maxAge=60&style=flat-square)](https://scrutinizer-ci.com/g/huntie/laravel-simple-jsonapi)

[![Packagist](https://img.shields.io/packagist/vpre/huntie/laravel-simple-jsonapi.svg?maxAge=60&style=flat-square)](https://packagist.org/packages/huntie/laravel-simple-jsonapi)

[![License](https://img.shields.io/badge/license-MIT-blue.svg?maxAge=2592000&style=flat-square)](https://github.com/huntie/laravel-simple-jsonapi/blob/master/LICENSE.txt)

An implementation of the [JSON API](http://jsonapi.org/) specification for Laravel, allowing developers to add fully-functional JSON API endpoints to their project with minimal configuration.

> This is the **1.0.0-alpha** branch – the upcoming major release and documentation are currently in progress.

## Features

- Simple API route resource definitions

- A base controller providing full JSON API resource endpoints

- Effortless transformation of Eloquent models and relationships to JSON API documents

- Formatting of error and request validation responses

- Configurable options for includable relationships, pagination and more

- Test assertion helpers

## Installation

    $ composer require huntie/laravel-simple-jsonapi

See further installation and configuration details in the [wiki](https://github.com/huntie/laravel-simple-jsonapi/wiki/Installation).

## Documentation

All usage information can be found in the [wiki](https://github.com/huntie/laravel-simple-jsonapi/wiki).

## Contributing

If you discover a problem or have a feature request, please [create an issue](https://github.com/huntie/laravel-simple-jsonapi/issues) or feel free to fork this repository and make improvements.