free-elephants/json-api-toolkit

Tools for building specification first json:api / swagger integrated APIs

0.2.0 2025-03-14 17:56 UTC

Requires

• ext-intl: *
• ext-json: *
• devizzent/cebe-php-openapi: ^1.0
• doctrine/persistence: ^2.0|^3.0
• fig/http-message-util: ^1.0
• free-elephants/i18n: ^0.0.1
• laminas/laminas-stratigility: ^3.2
• laravel-json-api/neomerx-json-api: ^5.0.2
• league/openapi-psr7-validator: 0.19 - 0.22
• nette/php-generator: ^3.4
• nikic/fast-route: ^1.3
• psr/cache: ^1|^2|^3
• psr/container: ^1|^2
• psr/http-factory: ^1.0
• psr/http-message: ^1.0|^2.0
• psr/http-server-handler: ^1.0
• psr/http-server-middleware: ^1.0
• rakit/validation: ^1.2
• ramsey/uuid: ^3.9.7|^4.0

Requires (Dev)

• helmich/phpunit-psr7-assert: ^4
• nyholm/psr7: ^1.2
• phpunit/phpunit: ^10.5.38|^11.0

Suggests

• doctrine/orm: ^2.7
• free-elephants/di: *
• free-elephants/json-api-dto: *
• laminas/laminas-httphandlerrunner: *
• nyholm/psr7: ^1.2

Conflicts

• neomerx/json-api: *

BSD-2-Clause

• samizdam

README

Features:

• Build FastRoute Dispatcher by defined in OAS3 operationsIds values
• Serialize Doctrine entities with Neomerx schemas (resolve issue neomerx/json-api#40)
• Generate PHP Data Transfer Objects by OAS3 reponseBody and requestBody schema reference compliance with json:api
• Validate incoming Psr Requests with swagger specification and user defined rules, and build Psr Response with json:api errors
• Map application models to Psr Response compliance with json:api structure

Usage

Install

composer require free-elephants/json-api-toolkit

Documentation

Available in /docs.

Index:

1. Routing
2. Serialize doctrine entities
3. Validation

Development

All dev env is dockerized. Your can use make receipts and bin/ scripts without locally installed php, composer.

For run tests with different php version change PHP_VERSION value in .env and rebuild image with make build.

See also:

Package for map PSR-7 http messages with Json Api structure to PHP DTO: https://github.com/FreeElephants/json-api-dto