Download the PHP package rawnoq/laravel-api-response without Composer

Laravel API Response

A professional Laravel package for standardized API responses with customizable keys and helper functions.

📦 Installation

Install the package via Composer:

The package will automatically register its service provider.

🚀 Features

• Standardized API Responses: Consistent JSON response structure across your application
• Customizable Keys: Configure response keys (status, data, message, etc.)
• Helper Function: Easy-to-use respond() helper function
• Pagination Support: Automatic pagination handling for paginated resources
• HTTP Status Codes: Pre-built methods for common HTTP status codes
• Flexible Messages: Support for single messages or arrays of messages
• Type-Safe: Full type hints and return types

📖 Usage

Basic Usage

Helper Function

The package provides a global respond() helper function:

HTTP Status Codes

The package provides pre-built methods for common HTTP status codes:

Pagination Support

The package automatically handles paginated resources:

This will automatically include pagination metadata in the response:

Customizing Response Keys

You can customize the response keys by creating a new instance with custom keys:

Or use the helper function with configuration:

Array Messages

You can pass arrays of messages:

This will include both message (first message) and messages (all messages) in the response:

⚙️ Configuration

Publish the configuration file:

This will create config/api-response.php:

📋 Response Structure

Success Response

Error Response

Paginated Response

🎯 Available Methods

Core Methods

• response($data, $message, $code, $status, $action) - Generic response method
• success($data, $message, $code, $status, $action) - Success response (200)
• error($message, $data, $code, $status, $action) - Error response (400)
• ok($message, $data, $code, $status, $action) - OK response (200)

HTTP Status Code Methods

• created($data, $message, $code, $status, $action) - 201 Created
• accepted($message, $data, $code, $status, $action) - 202 Accepted
• noContent($message, $code, $status, $action) - 204 No Content
• badRequest($message, $data, $code, $status, $action) - 400 Bad Request
• unauthorized($message, $data, $code, $status, $action) - 401 Unauthorized
• forbidden($message, $data, $code, $status, $action) - 403 Forbidden
• notFound($message, $data, $code, $status, $action) - 404 Not Found
• methodNotAllowed($message, $data, $code, $status, $action) - 405 Method Not Allowed
• conflict($message, $data, $code, $status, $action) - 409 Conflict
• gone($message, $data, $code, $status, $action) - 410 Gone
• lengthRequired($message, $data, $code, $status, $action) - 411 Length Required
• preconditionFailed($message, $data, $code, $status, $action) - 412 Precondition Failed
• unprocessableEntity($message, $data, $code, $status, $action) - 422 Unprocessable Entity
• tooManyRequests($message, $data, $code, $status, $action) - 429 Too Many Requests
• internalServerError($message, $data, $code, $status, $action) - 500 Internal Server Error
• badGateway($message, $data, $code, $status, $action) - 502 Bad Gateway
• serviceUnavailable($message, $data, $code, $status, $action) - 503 Service Unavailable
• gatewayTimeout($message, $data, $code, $status, $action) - 504 Gateway Timeout
• notImplemented($message, $data, $code, $status, $action) - 501 Not Implemented

🔧 Examples

Controller Example

Validation Error Example

Custom Response Example

📝 Requirements

• PHP >= 8.2
• Laravel >= 11.0 or Laravel >= 12.0

🧪 Testing

The package comes with a comprehensive test suite covering all functionality:

Test Coverage

The test suite includes:

• ✅ 40+ test cases covering all response methods
• ✅ All HTTP status codes (200, 201, 400, 401, 403, 404, 422, 500, etc.)
• ✅ Custom response keys and configurations
• ✅ Pagination handling
• ✅ Array messages support
• ✅ ServiceProvider registration
• ✅ Helper function availability
• ✅ Edge cases (null data, null messages, disabled status key)

📄 License

This package is open-sourced software licensed under the MIT license.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📧 Support

For issues, questions, or suggestions, please open an issue on GitHub.