# laravel-response

**Repository Path**: l-kai/laravel-response

## Basic Information

- **Project Name**: laravel-response
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-06
- **Last Updated**: 2025-11-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: PHP, Laravel

## README

# Laravel 响应

一个为 Laravel 优化的响应处理包，提供统一和结构化的 API 响应方式。

## 特性

- 提供多种便捷方法返回标准格式的 HTTP 响应。
- 支持 RESTful 规范，可统一返回 JSON 格式数据。
- 支持分页和资源集合响应格式化。

## 安装

使用 Composer 安装：

```bash
composer require liukai/laravel-response
```

## 配置

该包支持自动发现，但你也可以手动添加服务提供者和别名（如果自动发现未生效）：

在 `config/app.php` 中添加：

```php
'providers' => [
    Sevming\LaravelResponse\Providers\LaravelServiceProvider::class,
];

'aliases' => [
    'Response' => Sevming\LaravelResponse\Support\Facades\Response::class,
];
```

## 使用

在控制器中，你可以通过 `Response` facade 调用响应方法：

```php
use Response;

class ExampleController extends Controller
{
    public function index()
    {
        $data = ['key' => 'value'];
        return Response::success($data, '操作成功');
    }

    public function error()
    {
        return Response::error('发生错误', 500);
    }
}
```

## 配置选项

你可以在 `config/response.php` 中配置响应行为：

- `is_restful`: 是否遵循 RESTful 规范（设置为 `false` 时 HTTP 状态码统一返回 200）。
- `is_unified_return_json`: 是否统一返回 JSON 格式。
- `code`: 定义不同响应类型的默认代码和消息。
- `format`: 响应格式配置，包括集合字段和分页格式。

## 支持的方法

- `success($data = null, string $message = '', int $code = 200)`: 返回成功的响应。
- `fail(string $message = '', int $code = 400)`: 返回失败的响应。
- `error(string $message = '', int $code = 500)`: 返回错误的响应。
- `created($data = null, string $message = '', string $location = '')`: 返回 201 Created 响应。
- `accepted($data = null, string $message = '', string $location = '')`: 返回 202 Accepted 响应。
- `noContent(string $message = '')`: 返回 204 No Content 响应。
- `errorUnauthorized(string $message = '')`: 返回 401 Unauthorized 响应。
- `errorForbidden(string $message = '')`: 返回 403 Forbidden 响应。
- `errorNotFound(string $message = '')`: 返回 404 Not Found 响应。
- `errorMethodNotAllowed(string $message = '')`: 返回 405 Method Not Allowed 响应。
- `errorUnprocessableEntity(string $message = '')`: 返回 422 Unprocessable Entity 响应。

## 协议

MIT © [sevming](mailto:sevming@foxmail.com)