Skip to content

Release v12.0.0 #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Laravel API Response Builder CodeCov.io config file
#
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
# @copyright 2016-2024 Marcin Orlowski
# @copyright 2016-2025 Marcin Orlowski
# @license http://www.opensource.org/licenses/mit-license.php MIT
# @link https://github.com/MarcinOrlowski/laravel-api-response-builder
#
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/coding-standards.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Laravel API Response Builder Static code analysis Github Action config
#
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
# @copyright 2016-2024 Marcin Orlowski
# @copyright 2016-2025 Marcin Orlowski
# @license http://www.opensource.org/licenses/mit-license.php MIT
# @link https://github.com/MarcinOrlowski/laravel-api-response-builder
#
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Laravel API Response Builder Unit tests Github Action config
#
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
# @copyright 2016-2024 Marcin Orlowski
# @copyright 2016-2025 Marcin Orlowski
# @license http://www.opensource.org/licenses/mit-license.php MIT
# @link https://github.com/MarcinOrlowski/laravel-api-response-builder
#
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/phpstan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Laravel API Response Builder Static code analysis Github Action config
#
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
# @copyright 2016-2024 Marcin Orlowski
# @copyright 2016-2025 Marcin Orlowski
# @license http://www.opensource.org/licenses/mit-license.php MIT
# @link https://github.com/MarcinOrlowski/laravel-api-response-builder
#
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/phpunit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Laravel API Response Builder Unit tests Github Action config
#
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
# @copyright 2016-2024 Marcin Orlowski
# @copyright 2016-2025 Marcin Orlowski
# @license http://www.opensource.org/licenses/mit-license.php MIT
# @link https://github.com/MarcinOrlowski/laravel-api-response-builder
#
Expand Down
1 change: 1 addition & 0 deletions .php-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
8.2
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,21 @@ Development branch:

## Benefits ##

`ResponseBuilder` is written for REST API developers by REST API developer and is based on long-lasting experience on both
"sides" of API. It's lightweight, with **no** dependencies, extensively tested and simple to use yet flexible and powerful,
with support for [on-the-fly data conversion](docs/conversion.md), [localization support](docs/docs.md#messages-and-localization),
automatic message building, [chained APIs](docs/docs.md#code-ranges) and (hopefully) [exhaustive documentation](docs/README.md).
But that's not all! The JSON structure produced by `ResponseBuilder` is designed with **users of your API** in mind, so its
structure is predictible and [well-defined](docs/docs.md#response-structure) which makes dealing with your API using
`ResponseBuilder` library a breeze. Simple JSON response, with well-defined and predictable structure, easy to consume
without any hassle or trickery. **Your** clients will love it. And will love **you** too :)

You are also covered in a case of emergency, as provided [ExceptionHandlerhelper](docs/exceptions.md), ensures your API keeps
talking JSON (and NOT lame HTML) to its clients even in case of unexpected.
`ResponseBuilder` is written for REST API developers by REST API developers, drawing from extensive experience on both
sides of API development. It's lightweight, with **no** dependencies, thoroughly tested, and simple to use while remaining
flexible and powerful. It offers support for [on-the-fly data conversion](docs/conversion.md), [localization](docs/docs.md#messages-and-localization),
automatic message building, [chained APIs](docs/docs.md#code-ranges), and [comprehensive documentation](docs/README.md).

Moreover, the JSON structure produced by `ResponseBuilder` is designed with **your API users** in mind. Its
[well-defined and predictable structure](docs/docs.md#response-structure) makes interacting with your API using
`ResponseBuilder` effortless. The simple, consistent JSON responses are easy to consume without any complications.
**Your** clients will appreciate it, and by extension, appreciate **you** as well!

You're also covered in case of emergencies. The provided [ExceptionHandlerHelper](docs/exceptions.md) ensures your API
continues to communicate in JSON (not HTML) with its clients, even in unexpected situations.

Did I mention, you would also get [testing traits](docs/testing.md) that automatically add PHPUnit based unit test to your
whole `ResponseBuilder` related code and configuration with just a few lines of code **absolutely for free**?
whole `ResponseBuilder` related code and configuration with just a few lines of code **absolutely free of charge**?

## Features ##

Expand Down
10 changes: 5 additions & 5 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "marcin-orlowski/laravel-api-response-builder",
"description": "Helps building nice, normalized and easy to consume Laravel REST API.",
"homepage": "https://github.com/MarcinOrlowski/laravel-api-response-builder",
"version": "11.0.0",
"version": "12.0.0",
"keywords": [
"laravel",
"laravel10",
Expand Down Expand Up @@ -45,15 +45,15 @@
}
},
"require": {
"php": "^8.2|^8.3",
"laravel/framework": "^11.0"
"php": "^8.2|^8.3|^8.4",
"laravel/framework": "^12.0"
},
"require-dev": {
"marcin-orlowski/phpunit-extra-asserts": "^5.1.0",
"orchestra/testbench": "^9.0",
"orchestra/testbench": "^10.0",
"phpunit/phpunit": "^11.0",
"phpunit/php-code-coverage": "^11.0",
"larastan/larastan": "^2.0",
"larastan/larastan": "^3.0",
"marcin-orlowski/lockpick": "^1.0"
},
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion config/response_builder.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* See docs/config.md for detailed documentation
*
* @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
* @copyright 2016-2024 Marcin Orlowski
* @copyright 2016-2025 Marcin Orlowski
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link https://github.com/MarcinOrlowski/laravel-api-response-builder
*
Expand Down
3 changes: 3 additions & 0 deletions docs/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ should be able to easily backport future new features to older versions rather e

## CHANGE LOG ##

* v12.0.0 (2025-04-16)
* Added support for Laravel v12.

* v11.0.0 (2024-05-06)
* **BACKWARD INCOMPATIBLE CHANGES** ([more info](compatibility.md)).
* Added support for Laravel v11.
Expand Down
8 changes: 3 additions & 5 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
If you need to be told how to behave, then something went wrong during your
childhood, otherwise you already know that you are solely responsible for
your actions and the possible consequences (which actually should be nothing
new to any grown up human being). Amen.

If you need to be told how to behave, then something went wrong during your childhood, otherwise you
already know that you are solely responsible for your actions and the possible consequences (which
actually should be nothing new to any grown up human being). Amen.
9 changes: 9 additions & 0 deletions docs/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[« Documentation table of contents](README.md)

* [Important incompatibile changes](#incompatibility-notes)
* [Changes in v12.*](#v12)
* [Changes in v11.*](#v11)
* [Changes in v10.*](#v10)
* [Changes in v9.4](#v94)
Expand All @@ -24,13 +25,21 @@

Backward (in)compatibility notes. Pay attention if you are upgrading.

## v12 ##

* Requires Laravel 12.0+ and PHP 8.2+
* No backward incompatible code changes.


## v11 ##

* Requires Laravel 11.0+ and PHP 8.2+
* No backward incompatible code changes.

## v10 ##

* Requires Laravel 10.0+ and PHP 8.1+
* No backward incompatible code changes.

## v9.4 ##

Expand Down
Loading