php-openapi/yii2-fractal

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

1.4.1 2021-12-25 01:12 UTC

Requires

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

Requires (Dev)

• cebe/indent: *
• codeception/assert-throws: ^1.0
• codeception/codeception: ^4.1
• codeception/module-asserts: ^1.0.0
• codeception/module-db: ^1.0
• codeception/module-phpbrowser: ^1.0.0
• codeception/module-rest: <1.3.0
• codeception/module-yii2: ^1.1
• codeception/verify: ^1.5
• friendsofphp/php-cs-fixer: ~2.16
• fzaninotto/faker: ^1.9

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