Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/labor-digital/typo3-frontend-api
TYPO3: Provides a frontend API handler with support for Single Page Apps
https://github.com/labor-digital/typo3-frontend-api
Last synced: about 1 month ago
JSON representation
TYPO3: Provides a frontend API handler with support for Single Page Apps
- Host: GitHub
- URL: https://github.com/labor-digital/typo3-frontend-api
- Owner: labor-digital
- License: apache-2.0
- Created: 2020-03-22T13:29:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T07:34:55.000Z (almost 2 years ago)
- Last Synced: 2024-11-18T09:46:59.811Z (about 2 months ago)
- Language: PHP
- Size: 2.82 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TYPO3 - Frontend API
This package provides your TYPO3 installation with extended API capabilities. Create a REST-ful api was never that easy in TYPO3. It provides you with an
extended router based on the [PHP league's route package](https://route.thephpleague.com/), it works in tandem with the already existing PSR-7 middleware stack
but provides you with the option to register your own middleware specially for API requests. The bundle also has build in support for converting ext-base domain
objects into [json-api](https://jsonapi.org/) resources using [fractal](https://fractal.thephpleague.com/).
The main focus while designing the extension was to provide all capabilities to create a Single Page App using TYPO3. For that reason the package comes with
endpoints for menus, translations, page content rendering and automatic generation of content element data representations.
Another key-aspect of this package is the easy handling of content elements. The package provides a powerfull extension to extbase controllers that allow you to
render data based elements instead of fluid styled content.
## Requirements
- TYPO3 v10
- [TYPO3 - Better API](https://github.com/labor-digital/typo3-better-api)
- Installation using Composer
## Known issues
- This extension is NOT tested with workspaces, and will probably not work correctly.
## Installation
Install this package using composer:
```
composer require labor-digital/typo3-frontend-api
```
After that, you can activate the extension in the Extensions-Manager of your TYPO3 installation
## Example extension
To take a look a how to use the extension, you can take a look at the [example extension](https://github.com/labor-digital/typo3-frontend-api-example).
## Documentation
After a complete rewrite of the extension for TYPO3 v10 the old documentation has to be rewritten as well. I'm currently working on that.
[comment]: <> (The documentation can be found [here](https://typo3-frontend-api.labor.tools).)
[comment]: <> (## Building the documentation)
[comment]: <> (The documentation is powered by [vuepress](https://vuepress.vuejs.org/), you can quite simply spin up a dev server like so:)
[comment]: <> (- Clone the repository)
[comment]: <> (- Navigate to ```docs```)
[comment]: <> (- Install the dependencies with ```npm install```)
[comment]: <> (- Run the dev server with ```npm run dev```)
## Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning
which of our package(s) you are using.
Our address is: LABOR.digital - Fischtorplatz 21 - 55116 Mainz, Germany
We publish all received postcards on our [company website](https://labor.digital).