Download the PHP package dfau/toujou-api without Composer
On this page you can find all versions of the php package dfau/toujou-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package toujou-api
Toujou API
REST API for TYPO3 CMS based on {json:api}
Useful german youtube video https://www.youtube.com/watch?v=WoOuNe_rzpM
Installation
Require and install the plugin
$ composer require dfau/toujou-api
$ vendor/bin/typo3cms extension:install toujou_api
Configuration
To make the API work you have to do the following:
- Check Sites Management for api entrypoint
- Create a BE user with OAuth2 client_id and client_secrect (OAuth2 tab)
- Add and configure API resources (see Resources.php)
- Add and configure API routes (see Resources.php)
Security
The API will be secured to prevent unwarranted requests.
You can obtain an access token by sending a POST request to /_api/token
with following parameters:
key | value |
---|---|
grant_type | client_credentials |
client_id | |
client_secret |
Get auth token via request (Example):
On valid credentials the json response will contain an access token:
For all following requests you need to use this access token by adding following line to the request header
Authorization : Bearer <ACCESS_TOKEN>
Example requests:
Development
Install php dependencies using composer:
$ composer install
PHPUnit Unit tests
$ etc/scripts/runTests.sh
PHPUnit Functional tests
$ etc/scripts/runTests.sh -s functional
Codeception Acceptance tests
$ etc/scripts/runTests.sh -s acceptance
Easy-Coding-Standard
Check coding standard violations
$ etc/scripts/checkCodingStandards.sh
Fix coding standard violations automatically
$ etc/scripts/checkCodingStandards.sh --fix
Documentation
Make `dockrun_t3rd available in current terminal
source <(docker run --rm t3docs/render-documentation show-shell-commands)
Run dockrun_t3rd
dockrun_t3rd makehtml
Open documentation
open "Documentation-GENERATED-temp/Result/project/0.0.0/Index.html"
All versions of toujou-api with dependencies
ext-json Version *
dfau/convergence Version ^0.4.0
typo3/cms-core Version ^9.5 | ^10.4 | ^11.3
league/fractal Version ~0.18
league/tactician Version ^2.0-rc1
nikic/fast-route Version ^1.3.0
nikolaposa/cascader Version ^1.2.0
middlewares/error-handler Version ^2.0.0
middlewares/payload Version ^2.1.1
dfau/toujou-oauth2-server Version dev-master