basecodeoy/laravel-json-api

A package for building JSON:APIs with Laravel.

0.0.2 2024-11-05 05:38 UTC

Requires

• php: ^8.2
• basecodeoy/laravel-package-powerpack: ^0.0.1
• illuminate/contracts: ^11.0
• spatie/laravel-query-builder: ^5.2

Requires (Dev)

• basecodeoy/php-cs-fixer-config: ^0.0.1
• ergebnis/composer-normalize: ^2.2
• friendsofphp/php-cs-fixer: ^3.15
• infection/infection: ^0.27.0
• nunomaduro/collision: ^7.0
• nunomaduro/larastan: ^2.0
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• pestphp/pest-plugin-watch: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpstan/phpstan-strict-rules: ^1.5
• spatie/laravel-ray: ^1.2
• spatie/pest-plugin-snapshots: ^2.0

MIT

• Brian Faust

• laravel
• laravel-json-api
• BaseCode Oy

README

Warning Although this package is in a working state, it is still in development and should not be used in production. The API is subject to change at any time. Please use at your own risk.

This project was created by, and is maintained by Brian Faust, and is a package for building JSON:APIs with Laravel. Be sure to browse through the changelog, code of conduct, contribution guidelines, license, and security policy.

Note This package is based on timacdonald/json-api and spatie/laravel-json-api-paginate and plans to combine and expand on their functionality.

Installation

Note This package requires PHP 8.2 or later, and it supports Laravel 10 or later.

To get the latest version, simply require the project using Composer:

$ composer require faustbrian/laravel-json-api

You can publish the configuration file by using:

$ php artisan vendor:publish --tag="laravel-json-api-config"

Usage

Please review the contents of our test suite for detailed usage examples.

Alternatives

Laravel JSON:API

If you're looking for a package that's more comprehensive and thoroughly tested, please check out laravel-json-api/laravel. The goal of our package is to provide a lightweight alternative to this package with a focus on architectural simplicity to make it easier to understand and extend.