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

Installs: 4 584

Dependents: 2

Suggesters: 0

Security: 0

Stars: 17

Watchers: 6

Forks: 10

Open Issues: 4

Type:typo3-cms-extension

1.2.1 2021-03-30 08:47 UTC

README

https://styleci.io/repos/205416349/shield?branch=master https://scrutinizer-ci.com/g/sourcebroker/t3api/badges/quality-score.png?b=master https://travis-ci.org/sourcebroker/t3api.svg?branch=master https://poser.pugx.org/sourcebroker/t3api/license

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