trikoder/jsonapibundle

Json API bundle for Symfony

Json Api CRUD Bundle

Package to provide out-of-the box support for jsonapi in symfony with as native as possible way., _(*1)

Under development

This package is currently under active development, but it is considered production safe., _(*2)

How to install

Guide how to setup bundle is located in quick start guide, _(*3)

Sample usage

For quick start see quick start guide You can also look at demo code located in test suite, _(*4)

Advanced usage

For advanced usages that are outside of generic api you get from quick start, see advanced usage, _(*5)

Requirements

Bundle is uses symfony 3 and doctrine., _(*6)

Documentation and examples

Example code can also be found in tests/Resources/., _(*7)

Documentations is located inside src/Resources/doc/ directory., _(*8)

Issues

Use the issue tracker., _(*9)

Known limitations

• each jsonapi enabled action that receives arguments must receive Request as first argument

Versioning and changelog

Project follows Semantic versioning., _(*10)

Change log for the project can be found in changelog.md, _(*11)

Testing

The whole sandbox and development environment is located inside project., _(*12)

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., _(*13)

Contributing

TODO write how people can send pull requests, _(*14)

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)., _(*15)

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:, _(*16)

.php_cs.dist, _(*17)

Checking your code, _(*18)

First you need to setup test environment (as described in paragraph above)., _(*19)

Then:, _(*20)

Checking code:, _(*21)

bin/php_cs --dry-run

If you want automatic fix, just omit ``--dry-run`:, _(*22)

bin/php_cs

This will check and fix your code., _(*23)

Credits

Copyright (C) 2017 Trikoder, _(*24)

Author: Alen Pokos., _(*25)

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, _(*26)

License

Package is licensed under MIT License, _(*27)