README

REST API Response Builder for Laravel

Table of contents

• Introduction
• Why should I use it?
• Usage examples
• Features
• Extensive documentation
• License
• Changelog

Introduction

ResponseBuilder is a Laravel package, designed to help you build nice, normalized, and easy-to-consume REST API JSON responses.

Benefits

ResponseBuilder is written for REST API developers by REST API developers, drawing from extensive experience on both sides of API development. It's lightweight, has no dependencies, is thoroughly tested, and is simple to use while remaining flexible and powerful. It offers support for on-the-fly data conversion, localization, automatic message building, chained APIs, and comprehensive documentation.

Moreover, the JSON structure produced by ResponseBuilder is designed with your API users in mind. Its well-defined and predictable structure makes interacting with your API using ResponseBuilder effortless. The simple, consistent JSON responses are easy to consume. Your clients will appreciate it!

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

Additionally, it includes testing traits that help you add PHPUnit-based tests for your ResponseBuilder integration with just a few lines of code.

Features

• Easy to use,
• Stable and production ready
• On-the-fly data object conversion,
• API chaining support,
• Localization support,
• Provides traits to help unit test your API code,
• Comes with an exception handler helper to ensure your API remains consumable even in unexpected situations.
• No additional dependencies.

License

• Written and copyrighted ©2016-2025 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
• ResponseBuilder is open-source software licensed under the MIT license