tobscure / json-api-server
A fully automated JSON:API server implementation in PHP.
Fund package maintenance!
tobyzerner
Installs: 435
Dependents: 0
Suggesters: 0
Security: 0
Stars: 64
Watchers: 7
Forks: 20
Open Issues: 15
Requires
- php: >=8.1
- ext-json: *
- asispts/http-accept: ^1.0
- doctrine/inflector: ^2.0
- nyholm/psr7: ^1.8
- psr/http-message: ^1.0
- psr/http-server-handler: ^1.0
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.5.0
- phpbench/phpbench: ^1.2
- phpunit/phpunit: ^10.2.2
This package is auto-updated.
Last update: 2024-11-01 10:37:34 UTC
README
json-api-server is a JSON:API server implementation in PHP.
It allows you to build a feature-rich API by defining resource schema and connecting it to your application's database layer.
Based on your schema definition, the package will serve a complete API that conforms to the JSON:API specification, including support for:
- Showing individual resources (
GET /articles/1
) - Listing resource collections (
GET /articles
) - Sorting, filtering, pagination, and sparse fieldsets
- Compound documents with inclusion of related resources
- Creating resources (
POST /articles
) - Updating resources (
PATCH /articles/1
) - Deleting resources (
DELETE /articles/1
) - Content negotiation
- Error handling
- Extensions including Atomic Operations
- Generating OpenAPI definitions
Documentation
Example
The following example uses an Eloquent model in a Laravel application. However, json-api-server can be used with any framework that can deal in PSR-7 Requests and Responses. Custom behavior can be implemented to support other ORMs and data persistence layers.
use App\Models\User; use Tobyz\JsonApiServer\Laravel; use Tobyz\JsonApiServer\Laravel\EloquentResource; use Tobyz\JsonApiServer\Laravel\Filter; use Tobyz\JsonApiServer\Endpoint; use Tobyz\JsonApiServer\Schema\Field; use Tobyz\JsonApiServer\Schema\Type; use Tobyz\JsonApiServer\JsonApi; class UsersResource extends EloquentResource { public function type(): string { return 'users'; } public function newModel(Context $context): object { return new User(); } public function endpoints(): array { return [ Endpoint\Show::make(), Endpoint\Index::make()->paginate(), Endpoint\Create::make()->visible(Laravel\can('create')), Endpoint\Update::make()->visible(Laravel\can('update')), Endpoint\Delete::make()->visible(Laravel\can('delete')), ]; } public function fields(): array { return [ Field\Attribute::make('name') ->type(Type\Str::make()) ->writable() ->required(), Field\ToOne::make('address')->includable(), Field\ToMany::make('friends') ->type('users') ->includable(), ]; } public function filters(): array { return [Filter\Where::make('id'), Filter\Where::make('name')]; } } $api = new JsonApi(); $api->resource(new UsersResource()); /** @var Psr\Http\Message\ServerRequestInterface $request */ /** @var Psr\Http\Message\ResponseInterface $response */ try { $response = $api->handle($request); } catch (Throwable $e) { $response = $api->error($e); }
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.