trikoder / jsonapibundle
Json API bundle for Symfony
Installs: 3 978
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 8
Forks: 2
Open Issues: 1
Type:symfony-bundle
Requires
- php: >=7.0.0|>=7.1.0
- ext-json: *
- doctrine/common: ^2|^3
- doctrine/doctrine-bundle: ^1.11|^2.0
- doctrine/orm: ^2.4
- neomerx/json-api: ^1.0
- sensio/framework-extra-bundle: ^5.3
- symfony/config: ^3.4|^4.4
- symfony/dependency-injection: ^3.4|^4.4
- symfony/form: ^3.4|^4.4
- symfony/framework-bundle: ^3.4|^4.4
- symfony/http-foundation: ^3.4|^4.4
- symfony/monolog-bundle: ^3.4
- symfony/property-access: ^3.4|^4.4
- symfony/routing: ^3.4|^4.4
- symfony/security-bundle: ^3.4|^4.4
- symfony/translation: ^3.4|^4.4
- symfony/validator: ^3.4|^4.4
Requires (Dev)
- doctrine/cache: ^1.6
- doctrine/doctrine-fixtures-bundle: ^3.3
- friendsofphp/php-cs-fixer: ^2.13
- fzaninotto/faker: ^1.5
- justinrainbow/json-schema: ^1.6
- phpunit/php-code-coverage: ^4.0
- phpunit/phpunit: ^5.7
- symfony/browser-kit: ^3.4|^4.4
- symfony/debug-bundle: ^3.4|^4.4
- symfony/phpunit-bridge: ^3.4|^4.4
- symfony/twig-bundle: ^3.4|^4.4
- symfony/web-profiler-bundle: ^3.4|^4.4
- symfony/web-server-bundle: ^3.4|^4.4
This package is auto-updated.
Last update: 2024-10-27 03:27:18 UTC
README
Package to provide out-of-the box support for jsonapi in symfony with as native as possible way.
Under development
This package is currently under active development, but it is considered production safe.
How to install
Guide how to setup bundle is located in quick start guide
Sample usage
For quick start see quick start guide You can also look at demo code located in test suite
Advanced usage
For advanced usages that are outside of generic api you get from quick start, see advanced usage
Requirements
Bundle is uses symfony 3 and doctrine.
Documentation and examples
Example code can also be found in tests/Resources/.
Documentations is located inside src/Resources/doc/ directory.
Issues
Use the issue tracker.
Known limitations
- each jsonapi enabled action that receives arguments must receive Request as first argument
Versioning and changelog
Project follows Semantic versioning.
Change log for the project can be found in changelog.md
Testing
The whole sandbox and development environment is located inside project.
To run tests, position yourself inside tests/Resources/docker and run bin/test.sh
This will build whole docker setup, load fixtures and run all test suites.
Contributing
TODO write how people can send pull requests
For development of the package, we are using the same tools as for testing.
Position yourself inside tests/Resources/docker and run bin/start.sh
PHP cli commands can be run from same directory using bin/console.
There is also php access script bin/php [CMD] (eg. bin/php bash to enter bash).
Coding standards
When contributing to this package, you will need to adhere to our coding standards. They are following PSR-2 with some additional rules. To check your code during development you can use provided config for php-cs-fixer. it's in root of the project, file:
.php_cs.dist
Checking your code
First you need to setup test environment (as described in paragraph above).
Then:
Checking code:
bin/php_cs --dry-run
If you want automatic fix, just omit ``--dry-run`:
bin/php_cs
This will check and fix your code.
Credits
Copyright (C) 2017 Trikoder
Author: Alen Pokos.
Contributors (in alphabetic order): Antonio Pauletich, Alen Pokos, Antonio Šunjić, Damir Trputec, Juraj Juričić, Krešo Kunjas, Petar Obradović, Vedran Krizek, Vedran Mihočinec
License
Package is licensed under MIT License