PHPackages                             tomeet/laravel-response - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. tomeet/laravel-response

ActiveLibrary[API Development](/categories/api)

tomeet/laravel-response
=======================

Laravel api response data format.

v1.1.2(3y ago)011MITPHPPHP ^7.2.5|^8.0

Since Jun 21Pushed 3y ago1 watchersCompare

[ Source](https://github.com/tomeet/laravel-response)[ Packagist](https://packagist.org/packages/tomeet/laravel-response)[ RSS](/packages/tomeet-laravel-response/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (3)Versions (13)Used By (0)

 laravel-response
==================

[](#-laravel-response-)

[简体中文](README.md) | [ENGLISH](README-EN.md)

> 为 Laravel 和 Lumen API 项目提供一个规范统一的响应数据格式。

[![Test](https://github.com/Jiannei/laravel-response/workflows/Test/badge.svg)](https://github.com/Jiannei/laravel-response/workflows/Test/badge.svg)[![StyleCI](https://camo.githubusercontent.com/31924e1677021a935ae80ec525c8bd0f3f21ea57d4168b5b1a7569fb703e9a48/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3331363936393436322f736869656c643f6272616e63683d6d61696e)](https://github.styleci.io/repos/316969462?branch=main)[![Latest Stable Version](https://camo.githubusercontent.com/75ff1714f1c252ce1a971a5ffaad024f75075b0ef5ab2550bc8bdcbbe423ca5c/687474703a2f2f706f7365722e707567782e6f72672f6a69616e6e65692f6c61726176656c2d726573706f6e73652f76)](https://packagist.org/packages/jiannei/laravel-response)[![Total Downloads](https://camo.githubusercontent.com/4ea0f540076b61d9960459fd9545af4001fabd9ed75f739a8715722a048c01b0/687474703a2f2f706f7365722e707567782e6f72672f6a69616e6e65692f6c61726176656c2d726573706f6e73652f646f776e6c6f616473)](https://packagist.org/packages/jiannei/laravel-response)[![Monthly Downloads](https://camo.githubusercontent.com/69f49a38d0c9616fae8163cc9f15b991ef261ed61dd0835c7a007378945f9cbf/687474703a2f2f706f7365722e707567782e6f72672f6a69616e6e65692f6c61726176656c2d726573706f6e73652f642f6d6f6e74686c79)](https://packagist.org/packages/jiannei/laravel-response)[![Latest Unstable Version](https://camo.githubusercontent.com/cb4905ee370368014e07e13791db2233bd50a4b8dee09233f26f0ab61bade7b5/687474703a2f2f706f7365722e707567782e6f72672f6a69616e6e65692f6c61726176656c2d726573706f6e73652f762f756e737461626c65)](https://packagist.org/packages/jiannei/laravel-response)[![License](https://camo.githubusercontent.com/54a543ef7819933f20a05fb471064c0f7b505ff6c08245d461feaa0626188633/687474703a2f2f706f7365722e707567782e6f72672f6a69616e6e65692f6c61726176656c2d726573706f6e73652f6c6963656e7365)](https://packagist.org/packages/jiannei/laravel-response)

社区讨论文章
------

[](#社区讨论文章)

- [是时候使用 Lumen 8 + API Resource 开发项目了！](https://learnku.com/articles/45311)
- [教你更优雅地写 API 之「路由设计」](https://learnku.com/articles/45526)
- [教你更优雅地写 API 之「规范响应数据」](https://learnku.com/articles/52784)
- [教你更优雅地写 API 之「枚举使用」](https://learnku.com/articles/53015)
- [教你更优雅地写 API 之「记录日志」](https://learnku.com/articles/53669)
- [教你更优雅地写 API 之「灵活地任务调度」](https://learnku.com/articles/58403)

介绍
--

[](#介绍)

`laravel-response` 主要用来统一 API 开发过程中「成功」、「失败」以及「异常」情况下的响应数据格式。

实现过程简单，在原有的 `response()->json()`进行封装，使用时不需要有额外的心理负担。

遵循一定的规范，返回易于理解的 HTTP 状态码，并支持定义 `ResponseCodeEnum` 来满足不同场景下返回描述性的业务操作码。

概览
--

[](#概览)

- 统一的数据响应格式，固定包含：`code`、`status`、`data`、`message`、`error` (响应格式设计源于：[RESTful服务最佳实践](https://www.cnblogs.com/jaxu/p/7908111.html#a_8_2) )
- 你可以继续链式调用 `JsonResponse` 类中的所有 public 方法，比如 `Response::success()->header('X-foo','bar');`
- 合理地返回 Http 状态码，默认为 restful 严格模式，可以配置异常时返回 200 http 状态码（多数项目会这样使用）
- 支持格式化 Laravel 的 `Api Resource`、`Api  Resource Collection`、`Paginator`（简单分页）、`LengthAwarePaginator`（普通分页）、`Eloquent\Model`、`Eloquent\Collection`，以及简单的 `array` 和 `string`等格式数据返回
- 根据 debug 开关，合理返回异常信息、验证异常信息等
- 支持修改 Laravel 特地异常的状态码或提示信息，比如将 `No query results for model` 的异常提示修改成 `数据未找到`
- 支持配置返回字段是否显示，以及为她们设置别名，比如，将 `message` 别名设置为 `msg`，或者 分页数据第二层的 `data` 改成 `list`(res.data.data -> res.data.list)
- 分页数据格式化后的结果与使用 `league/fractal` （DingoApi 使用该扩展进行数据转换）的 transformer 转换后的格式保持一致，也就是说，可以顺滑地从 Laravel Api Resource 切换到 `league/fractal`
- 内置 Http 标准状态码支持，同时支持扩展 ResponseCodeEnum 来根据不同业务模块定义响应码(可选，需要安装 `jiannei/laravel-enum`)
- 响应码 code 对应描述信息 message 支持本地化，支持配置多语言(可选，需要安装 `jiannei/laravel-enum`)

安装
--

[](#安装)

支持 Laravel 5.5.\* ~ Laravel 9.\* 版本，自定义业务操作码部分依赖于 [jiannei/laravel-enum](https://github.com/Jiannei/laravel-enum)，需要先进行安装。

laravel 版本lumen 版本response 版本enum 版本5.5.\*5.5.\*~1.8~1.46.\*6.\*^2.0~1.47.\*7.\*^3.0^2.08.\* - 9.\*8.\* - 9.\*^4.0^3.0```
# laravel 5.5

composer require jiannei/laravel-response "~1.8" -vvv
composer require jiannei/laravel-enum "~1.4" -vvv # 可选

# laravel 6.x

composer require jiannei/laravel-response "^2.0" -vvv
composer require jiannei/laravel-enum "~1.4" -vvv # 可选

# laravel 7.x

composer require jiannei/laravel-response "^3.0" -vvv
composer require jiannei/laravel-enum "^2.0" -vvv # 可选

# laravel 8.x - 9.x

composer require jiannei/laravel-response "^4.0" -vvv
composer require jiannei/laravel-enum "^3.0" -vvv # 可选
```

配置
--

[](#配置)

### Laravel

[](#laravel)

- 发布配置文件

```
$ php artisan vendor:publish --provider="Jiannei\Response\Laravel\Providers\LaravelServiceProvider"
```

- 格式化异常响应

```
// app/Exceptions/Handler.php
// 引入以后对于 API 请求产生的异常都会进行格式化数据返回
// 要求请求头 header 中包含 /json 或 +json，如：Accept:application/json
// 或者是 ajax 请求，header 中包含 X-Requested-With：XMLHttpRequest;