Laravel Packages

Laravel REST API Response Builder

Published
Laravel REST API Response Builder image

REST API Response Builder for Laravel is a package by Marcin Orlowski for building JSON API responses. According to the author, the package helps you with things like data conversion and localization:

ResponseBuilder is written for REST API developers by REST API developer and is based on my long-lasting experience on both “sides” (API dev and API consumer) of a variety of REST APIs. Lightweight, with simple to use public methods, covering multiple potential use-cases, on-the-fly data conversion, localization support, automatic error message building, support for chained APIs, and (hopefully) exhaustive documentation.

The simplest example provided by this package is returning the following from a controller:

return ResponseBuilder::success();

The resulting client JSON will look like the following:

{
“success”: true,
“code”: 0,
“locale”: “en”,
“message”: “OK”,
“data”: null
}

If you want to build message codes for common errors in your API, you can do the following:

return ResponseBuilder::error(MyErrorCodes::SOME_CODE);

Which results in the following message if you passed the code 205:

{
“success”: false,
“code”: 250,
“locale”: “en”,
“message”: “Your error message for code 250”,
“data”: null
}

Check out the detailed documentation for more examples of what this package provides. You can learn more about this package, get full installation instructions, and view the source code on GitHub at MarcinOrlowski/laravel-api-response-builder.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

serpapi logo
SerpApi

The Web Search API for Your LLM and AI Applications

Visit SerpApi

The latest

View all →
Volker Dusch on the PHP RCE Vulnerabilities and Disclosure image

Volker Dusch on the PHP RCE Vulnerabilities and Disclosure

Read article
Decide with Jev: Turn AI Answers into Decisions with PHP Rules image

Decide with Jev: Turn AI Answers into Decisions with PHP Rules

Read article
Skuul: Open-Source School Management Built on Laravel image

Skuul: Open-Source School Management Built on Laravel

Read article
Laravel Read Replicas: Prevent Stale Reads After a Write image

Laravel Read Replicas: Prevent Stale Reads After a Write

Read article
Screenshot: Capture Images and PDFs with PHP and Laravel image

Screenshot: Capture Images and PDFs with PHP and Laravel

Read article
Reset Sticky Database Connections Between Laravel Queue Jobs image

Reset Sticky Database Connections Between Laravel Queue Jobs

Read article