medienreaktor / neos-api
HTTP API for Neos, defined with neos/openapi and secured by Neos.OAuth
Package info
github.com/medienreaktor/Medienreaktor.NeosApi
Type:neos-package
pkg:composer/medienreaktor/neos-api
Requires
- php: ^8.4
- behat/transliterator: ^1.5
- doctrine/dbal: ^3.8
- medienreaktor/neos-oauth: ^0.1.2
- medienreaktor/neos-openapi-bundle: ^0.1
- neos/flow: ^9.2
- neos/media: ^9.2
- neos/neos: ^9.2
Requires (Dev)
- neos/contentgraph-doctrinedbaladapter: ^9.2
- phpstan/phpstan: ^2.2
- phpunit/phpunit: ~11.5
- squizlabs/php_codesniffer: ^4.0
Suggests
- medienreaktor/neos-api-docs: Swagger UI for the API on /api/docs
Provides
None
Conflicts
None
Replaces
None
- dev-main / 2.0.x-dev
- 2.0.6
- 2.0.5
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.x-dev
- 1.18.0
- 1.17.7
- 1.17.6
- 1.17.5
- 1.17.4
- 1.14.4
- 1.14.3
- 1.14.1
- 1.13.0
- 1.12.1
- 1.12.0
- 1.11.2
- 1.11.1
- 1.11.0
- 1.10.0
- 1.9.10
- 1.9.9
- 1.9.8
- 1.9.7
- 1.9.6
- 1.9.5
- 1.9.4
- 1.9.3
- 1.9.2
- 1.9.1
- 1.9.0
- 1.8.0
- 1.7.6
- 1.7.5
- 1.7.4
- 1.7.3
- 1.7
- 1.6
- 1.5
- 1.4
- 1.3
- 1.2.1
- 1.2
- 1.1
- 1.0.2
- 1.0.1
- 1.0
This package is auto-updated.
Last update: 2026-11-21 13:33:15 UTC
README
The HTTP API for Neos 9 and the Content Repository, defined in PHP with neos/openapi and secured with OAuth 2.
Usage
Every operation is below /api. The OpenAPI document at /api/openapi.json describes each operation, its parameters,
responses and scopes. The optional Neos.Api.Docs package serves it as Swagger UI on /api/docs.
Clients send an access token as Authorization: Bearer <token>. Each scope (nodes.read,
workspaces.publish, …) is also a privilege in Configuration/Policy.yaml: a token works only if it was granted the
scope and its account has the privilege. Neos' node, workspace and media privileges apply on top.
Errors are RFC 9457 problem documents. Lists come as {data, meta, links};
include, sort and paging work as in JSON:API.
Upgrading from Medienreaktor.NeosApi 1.x
Tokens are issued by Neos.OAuth now, with keys of its own that it
generates on first use (./flow oauth:status, ./flow oauth:generatekeys). Clients and tokens of 1.x don't carry
over. ./flow neosapi:generatekeys is kept, deprecated, for deploy scripts that call it: it succeeds when the keys
exist and generates them otherwise.
Development
composer lint runs composer validate --strict, PSR-12 and PHPStan level 8, without a baseline. The functional
tests extend Flow's FunctionalTestCase and need a whole Neos with Neos.Demo and a MariaDB or MySQL database (on
another database the content repository tests skip themselves). .github/workflows/functional.yml shows how CI runs
them in Neos' base distribution:
FLOW_CONTEXT=Testing bin/phpunit -c Build/BuildEssentials/PhpUnit/FunctionalTests.xml Packages/Application/Neos.Api/Tests/Functional
License
MIT, see LICENSE.