laravel-api-response-builder

Builds nice, normalized and easy to consume REST JSON responses for Laravel powered APIs.

MIT License

Downloads
308.1K
Stars
721
Committers
9

Bot releases are hidden (Show)

laravel-api-response-builder -

Published by MarcinOrlowski over 4 years ago

  • [RB-141] Fixed JsonSerializableConverter to deal non-string return data (reported by Jonatan Fekete)
laravel-api-response-builder -

Published by MarcinOrlowski over 4 years ago

  • Added more tests.
  • Updated dependencies.
laravel-api-response-builder -

Published by MarcinOrlowski over 4 years ago

  • Added support for Laravel v7
laravel-api-response-builder -

Published by MarcinOrlowski over 4 years ago

  • Fixed composer.json file.
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • Updated Travis config to cover Laravel 6.5, 6.6, 6.7 and 6.8
  • Updated Travis config to cover PHP 7.4
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • v7.0.1 (2019-11-25)
    • Disabled Scrutinizer's "false positive" in Builder class.
    • Added more tests to improve overall coverage.
    • Updated PHPDocs
    • Code cleanup
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • BACKWARD INCOMPATIBLE CHANGES (more info)
  • New, flexible API based on Builder pattern (see docs for details).
  • Reworked ExceptionHandlerHelper configuration. Now, you will be able to easily configure every
    HttpException for each HTTP status code you want. Separate ExceptionHandler::TYPE_HTTP_NOT_FOUND_KEY
    and all related stuff, incl. localization key http_not_found, configuration is now replace with more
    flexible generic code that provides error messages for all supported HTTP codes from in range 400-599.
  • Added support for external data converters (related part of config changed too).
  • Config key classes is now (partially) converter. Its method key is gone and handler.
    needs to be added now, pointing to the class implementing ConverterContract acting as delegate worker.
  • Data converter now handles objects implementing JsonSerializable and Arrayable contracts as well.
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • Added ResponseBuilder::successWithMessage() method.
  • Entries in classes config array can now have pri (default 0) to enforce order while
    merging config with built-in configuration.
  • Persian translation (Thanks to @FaridAghili).
  • Added Laravel 6.5 to Travis-CI unit tests.
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • Fixed config merging helper causing certain user settings to be lost.
  • No longer exposes exception class name for message-less exceptions. Fixes #107
  • Added test ensuring that user provided config overshadows built-in params.
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • BACKWARD INCOMPATIBLE CHANGES (more info)
  • Signature of ResponseBuilder::buildResponse() changed to allow customization of final message entry (@hawezo).
  • Moved all code that produces messages for API codes to ResponseBuilder::getMessageForApiCode().
  • Added Validator::assertType() helper method that validates var against set of allowed types.
  • Added Validator::assertString() helper.
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • Added Laravel 6.4 to Travis-CI unit tests.
  • Corrected example in "Manipulating Response Object" docs.
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • Squashed multiple typographic errors in the documentation files.
laravel-api-response-builder -

Published by MarcinOrlowski almost 5 years ago

  • Added Laravel 6.3 to Travis-CI unit tests.
  • Splitted tests into separate folders per class tested.
  • ExceptionHandler no longer tries to enforce UTF-8 on exception message.
  • Added PHP 7.4-snapshot to unit tests
laravel-api-response-builder -

Published by MarcinOrlowski about 5 years ago

  • Changed how auto-converter checks for supported classes (see Data Conversion)
  • Data conversion now supports JsonResource data class.
  • Added unit test for ResponseBuilderServiceProvider::mergeConfg().
  • Moved data conversion code to separate Converter class.
  • Added LICENSE.md file.
  • Added Laravel 6.2 to Travis tests.
  • Added unit tests for translation files.
laravel-api-response-builder - v6.1.2

Published by MarcinOrlowski about 5 years ago

  • Corrected ServiceProvider used for tests.
laravel-api-response-builder - v6.1.1

Published by MarcinOrlowski about 5 years ago

  • Fixed ResponseBuilderServiceProvider using unreferenced Arr class method (reported by yassir3wad).
laravel-api-response-builder - v6.0.0

Published by MarcinOrlowski about 5 years ago

  • BACKWARD INCOMPATIBLE CHANGES (more info)
  • Requires Laravel 6.0+ and PHP 7.2+ (see docs for legacy support hints).
  • All API codes are now withing defined code range, incl. built-in codes.
  • Reserved code range lowered from former 63 down to 19.
  • Added type hints to all method arguments and return values
  • ExceptionHandler returns Exception-type related HTTP codes now as per configuration.
  • Fixed ResponseBuilder::errorWithMessageAndData() not passing data properly.
  • Fixed exception message of ApiCodesHelpers::getMaxCode().
  • Corrected test cases list in testSuccess_DataAndHttpCode().
  • Fixed error code fallback in testRender_HttpException() test.
  • Fixed testError_DebugTrace() not containing any asserts.
  • Reformatted code to not exceed 132 columns, for better on-line readability.
  • ResponseBuilder::errorWithDataAndHttpCode() accepts now null as http code.
  • ResponseBuilder::errorWithHttpCode() accepts now null as http code.
  • Fixed ExceptionHandlerHelper replacing HTTP codes above 499 with 400.
  • Changed default built-in message for HTTP_NOT_FOUND error.
  • ExceptionHandler now falls back to EX_UNCAUGHT_EXCEPTION for all the cases.
  • Simplified ExceptionHandlerHelperTest::testRender_HttpException() test.
  • Removed exception_handler.use_exception_message_first feature.
  • Removed ResponseBuilder::DEFAULT_API_CODE_OK constant.
  • Removed getReservedMinCode(), getReservedMinCode(), getReservedMessageKey() methods.
  • Removed internal API code constants. Use corresponding methods to get proprt code value.
  • Reimplemented Laravel config merger to support multi-dimensional configuration arrays too.
  • Removed response_key_map configuration option.
  • You can now return HTTP codes from 5xx range with all error responses.
laravel-api-response-builder - v4.1.9

Published by MarcinOrlowski about 5 years ago

  • Fixed ApiCodesHelpers::getMaxCode() exception message
  • Fixed ResponseBuilder::errorWithMessageAndData() not passing args properly
laravel-api-response-builder - v4.1.8

Published by MarcinOrlowski about 5 years ago

  • Added Laravel 6 to testing setup
laravel-api-response-builder - v4.1.7

Published by MarcinOrlowski over 5 years ago

  • Added PHP 7.3 to testing setup
  • Added Laravel 5.7 and Laravel 5.8 to testing setup
  • Corrected test env setup for Laravel 5.5, 5.6
  • Removed tests on HHVM from Travis config