News

Laravel API Response Helpers

Published
Laravel API Response Helpers image

Laravel API Response Helpers is a super simple package allowing for consistent API responses throughout your Laravel application:

// Use this trait within a controller
use ApiResponseHelpers;
 
// Provides the following methods:
$this->respondNotFound(string|Exception $message, ?string $key = 'error')
$this->respondWithSuccess(?array $contents = [])
$this->respondOk(string $message)
$this->respondUnAuthenticated(?string $message = null)
$this->respondForbidden(?string $message = null)
$this->respondError(?string $message = null)
$this->respondCreated(?array $data = [])
$this->respondNoContent(?array $data = [])

The goal of this package is ensuring consistent JSON API responses throughout an application. It provides a consistent way to respond instead of manually designing the API response:

// i.e.
response()->json(['message' => $error], Response::HTTP_BAD_REQUEST)
// or
response()->json([$error], 400)

You can learn more about this package, get full installation instructions, and view the source code on GitHub.


This package was submitted to our Laravel News Links section. Links is a place the community can post packages and tutorials around the Laravel ecosystem. Follow along on Twitter @LaravelLinks

Paul Redmond photo

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

Filed in

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
Building EasyReply: How We Used Laravel to Unify Customer Support image

Building EasyReply: How We Used Laravel to Unify Customer Support

Read article
PostgreSQL Monitoring and Schema Linting for Laravel with Vacuum image

PostgreSQL Monitoring and Schema Linting for Laravel with Vacuum

Read article
PayZephyr: One Payment API for Stripe, Paystack, and PayPal image

PayZephyr: One Payment API for Stripe, Paystack, and PayPal

Read article
Bifrost Turns One With AI Builds and New Workflows image

Bifrost Turns One With AI Builds and New Workflows

Read article
Preview Blade Templates in macOS Finder with Quick Blade image

Preview Blade Templates in macOS Finder with Quick Blade

Read article
Artisan Debugging Commands in Laravel Telescope 5.24.0 image

Artisan Debugging Commands in Laravel Telescope 5.24.0

Read article