kununu / symfony-api-skeleton
This package's canonical repository appears to be gone and the package has been frozen as a result.
Installs: 192
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 16
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=7.0
- doctrine/doctrine-bundle: ^1.6
- doctrine/doctrine-cache-bundle: ^1.2
- doctrine/orm: ^2.5
- incenteev/composer-parameter-handler: ^2.0
- jms/serializer-bundle: ^1.0
- kununu/controller-validation-bundle: dev-master
- kununu/rest-api-bundle: ^1.0
- sensio/distribution-bundle: ^5.0
- sensio/framework-extra-bundle: ^3.0.2
- symfony/event-dispatcher: 3.4
- symfony/framework-bundle: ~3.4
- symfony/monolog-bundle: ^3.0
- symfony/polyfill-apcu: ^1.0
- symfony/security-bundle: 3.4
Requires (Dev)
- phpunit/phpunit: ^5.7
- sensio/generator-bundle: ^3.0
- symfony/apache-pack: ^1.0
- symfony/browser-kit: ^4.2
- symfony/debug-bundle: 3.4
- symfony/stopwatch: ^4.2
- symfony/twig-bundle: 3.4
- symfony/web-profiler-bundle: 3.4
- symfony/web-server-bundle: 3.4
- vlucas/phpdotenv: ^2.4
This package is auto-updated.
Last update: 2021-02-20 00:05:52 UTC
README
This is a basic REST API setup you can use to start a API service.
Basic setup
Create a new project
composer create-project kununu/symfony-api-skeleton:^0.1.0 [dir_name]
Start a server
After the installation you need to start a server first via Symfony console:
php bin/console server:start
Test the API
Navigate to http://127.0.0.1:8000/ to check if the API works properly.
Example endpoints
There are a couple of examples available in the ExampleController which available on these routes:
/examples/integer/examples/string/examples/array/examples/exception/examples/entity/examples/validation/examples/oauth-protected
Examples cleanup
In case you do not need the Examples, simply remove all Example files associated with ExampleController.
Suggestions
Queue Reader Bundle - https://github.com/kununu/queue-reader-bundle
Note: There will be a cleanup script available to do this cleanup automatically.