dbp / relay-example-bundle
An example bundle for the Relay API gateway
Installs: 3 200
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 1
Type:symfony-bundle
Requires
- php: >=8.1
- ext-json: *
- api-platform/core: ^2.7 || ^3.2
- dbp/relay-core-bundle: ^0.1.148
- symfony/config: ^5.4 || ^6.4
- symfony/console: ^5.4 || ^6.4
- symfony/dependency-injection: ^5.4 || ^6.4
- symfony/framework-bundle: ^5.4 || ^6.4
- symfony/http-foundation: ^5.4 || ^6.4
- symfony/http-kernel: ^5.4 || ^6.4
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.50
- phpstan/phpstan: ^1.10.59
- phpstan/phpstan-phpunit: ^1.3.16
- phpunit/phpunit: ^9.6.17
- symfony/browser-kit: ^5.4 || ^6.4
- symfony/error-handler: ^5.4 || ^6.4
- symfony/http-client: ^5.4 || ^6.4
- symfony/monolog-bridge: ^5.4 || ^6.4
- symfony/monolog-bundle: ^3.10
- symfony/phpunit-bridge: ^5.4 || ^6.4
- vimeo/psalm: ^5.22.2
README
The goal of this bundle is to include a wide variety of features that you might need in developing your own bundle. So you can use it as either a reference, or as a starting point/sandbox for experiments.
When including this bundle into your API server it will gain the following features:
- A custom
./bin/consolecommand - An example entity
- Various HTTP methods implemented for that entity
- A custom controller for that entity
- A health check
- ...
Integrate it into your server via:
composer require dbp/relay-example-bundle
Development & Testing
- Install dependencies:
composer install - Run tests:
composer test - Run linters:
composer run lint - Run cs-fixer:
composer run cs-fix