php-openapi/yii2-fractal

Json-api spec implementation with league/fractal, forked from Insolita (RIP)

1.5.1 2024-12-18 13:44 UTC

Requires

• php: >=8
• ext-json: *
• league/fractal: ^0.20.0
• yiisoft/yii2: ~2.0.15

Requires (Dev)

• cebe/indent: *
• codeception/assert-throws: ^1.0
• codeception/codeception: 5.1.*
• codeception/module-asserts: ^3.0
• codeception/module-db: ^3.0
• codeception/module-phpbrowser: 3.0.*
• codeception/module-rest: ^3.0
• codeception/module-yii2: ^1.1
• codeception/verify: ^1.5
• friendsofphp/php-cs-fixer: ~2.16
• fzaninotto/faker: ^1.9@dev

MIT

• json
• rest
• yii2
• JSON-API

README

The set of utils and actions for prepare Rest API accordingly JSON:API https://jsonapi.org/format/ With https://fractal.thephpleague.com

Installation

composer require php-openapi/yii2-fractal

Usage

1. Add class insolita\fractal\JsonApiBootstrap to the 'bootstrap' section of api application config (or update application config manually with same changes as in JsonApiBootstrap class ) see tests/testapp/config/api.php.

2. Create your controller classes by extending JsonApiController or JsonApiActiveController which contains predefined CRUD actions. See examples at tests/testapp/controllers.

Contributing / Local Development / Testing

See CONTRIBUTING.md file

License

See LICENSE file