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 →
CPX: The Composer Package Executor for PHP image

CPX: The Composer Package Executor for PHP

Read article
Laravel AI SDK Adds Human-in-the-Loop Tool Approval image

Laravel AI SDK Adds Human-in-the-Loop Tool Approval

Read article
Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals image

Pest 5 Released With Test Impact Analysis, Agent Verification, and Evals

Read article
Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs image

Queue-SQL: Run Mass Deletes and Updates Across Parallel Queue Jobs

Read article
Blade Formatting in Laravel Pint image

Blade Formatting in Laravel Pint

Read article
Inertia DevTools Is Now on the Chrome Web Store image

Inertia DevTools Is Now on the Chrome Web Store

Read article