saritasa/dingo-api-custom

Saritasa customizations for Dingo/Api library

2.1.1 2019-04-02 12:45 UTC

README

Build Status codecov Release PHPv Downloads

Custom settings and extensions for Dingo/Api package

See https://github.com/dingo/api

Laravel 5.x

Install the saritasa/dingo-api-custom package:

$ composer require saritasa/dingo-api-custom

If you use Laravel 5.4 or less, or 5.5+ with package discovery disabled, add the BladeDirectivesServiceProvider service provider in config/app.php:

'providers' => array(
    // ...
    Saritasa\DingoApi\SaritasaDingoApiServiceProvider::class,
)

Customizations

Registers CustomArraySerializer instead of ArraySerializer:

  • Does not add 'meta' key for metadata, all metadata output to root.

Registers custom ApiExceptionHandler with specific handling of exceptions, defined in saritasa/php-common package

Changes format of JSON output for handled validation exceptions.

Contributing

  1. Create fork, checkout it
  2. Develop locally as usual. Code must follow PSR-1, PSR-2 - run PHP_CodeSniffer to ensure, that code follows style guides
  3. Cover added functionality with unit tests and run PHPUnit to make sure, that all tests pass
  4. Update README.md to describe new or changed functionality
  5. Add changes description to CHANGES.md file. Use Semantic Versioning convention to determine next version number.
  6. When ready, create pull request

Make shortcuts

If you have GNU Make installed, you can use following shortcuts:

  • make cs (instead of php vendor/bin/phpcs) - run static code analysis with PHP_CodeSniffer to check code style
  • make csfix (instead of php vendor/bin/phpcbf) - fix code style violations with PHP_CodeSniffer automatically, where possible (ex. PSR-2 code formatting violations)
  • make test (instead of php vendor/bin/phpunit) - run tests with PHPUnit
  • make install - instead of composer install
  • make all or just make without parameters - invokes described above install, cs, test tasks sequentially - project will be assembled, checked with linter and tested with one single command

Resources