sourcebroker/t3api

REST API for your TYPO3 project. Config with annotations, build in filtering, pagination, typolinks, image processing, serialization contexts, responses in Hydra/JSON-LD format.

2.0.3 2023-10-30 21:46 UTC

Requires

• php: ^7.2.0 || ^8.0.0
• ext-json: *
• ext-pdo: *
• ext-tokenizer: *
• doctrine/annotations: ^1.0
• goldspecdigital/oooas: ^2.4
• jms/serializer: ^3.1
• phpdocumentor/reflection-docblock: ^5.1
• symfony/cache: ^4.4 || ^5.0 || ^6.0
• symfony/expression-language: ^4.1 || ^5.0
• symfony/http-foundation: ^4.2.9 || ^5.0
• symfony/mime: ^4.4 || ^5.0
• symfony/property-info: ^4.4 || ^5.0
• symfony/psr-http-message-bridge: ^2.1
• symfony/routing: ^4.1 || ^5.0
• typo3/cms-core: ^10.4 || ^11.5
• typo3/cms-extbase: ^10.4 || ^11.5
• typo3/cms-frontend: ^10.4 || ^11.5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• nimut/testing-framework: ^6.0
• typo3/coding-standards: ^0.5.2

Replaces

• typo3-ter/t3api: 2.0.3

GPL-2.0-or-later

• SourceBroker Team

README

Features

• Support for Extbase models with GET, POST, PATCH, PUT, DELETE operations.
• Configuration with classes, properties and methods annotations.
• Build-in filters: boolean, numeric, order, range and text (partial, match against and exact strategies).
• Build-in pagination.
• Support for typolinks.
• Support for image processing.
• Support for file uploads (FAL).
• Configurable routing.
• Responses in Hydra /JSON-LD format.
• Serialization contexts - customizable output depending on routing.
• Easy customizable serialization handlers and subscribers.
• Backend module with Swagger for documentation and real testing.

Documentation

Read the docs at https://docs.typo3.org/p/sourcebroker/t3api/master/en-us/

Example integration

To check some real code see t3apinews - an example integration of t3api for well known news extension.

Demo

If you use ddev then in less than 5min you can have working demo of ext:t3api on you local computer. Try https://github.com/sourcebroker/t3api-demo