错误的时候，可以通过 HttpException，在返回错误信息中添加 code 字段。
如果是请求正确，我也想返回 code 字段，此时应该如何修改？我百度找了一下没有提及
跟我司的需求一样，我司的需求是不管成功失败，http_status 都是 200，一定要返回 code 和 message，成功 code 返回 0，失败 code 返回自定义 code 码。
然后我们的做法是异常建了一个异常类，laravel5.5 可以直接在自建的异常类渲染，就直接返回 code 和 message 了。
正确相应是，新建了一个 SuccessResource，在该 SuccessResource 中返回 code 和 message，
<?php
namespace App\Http\Resources;
use Illuminate\Http\Resources\Json\Resource;
class Success extends Resource
{
/**
* @var array
*/
protected $data;
/**
* 禁用顶层包裹
*
* @var null
*/
public static $wrap = null;
public function __construct($data = [], $resource = null)
{
$this->data = $data;
if (is_null($resource)) {
$resource = collect();
}
parent::__construct($resource);
}
/**
* Transform the resource collection into an array.
*
* @param \Illuminate\Http\Request
*
* @return array
*/
public function toArray($request)
{
$success = ['code' => 0, 'message' => 'success'];
$success['data'] = array_has($this->data, 'data') ? $this->data['data'] : $this->data;
if (array_has($this->data, 'meta')) {
$success['meta'] = $this->data['meta'];
}
return $success;
}
}
再在 helpers 中写一个 success () 方法，返回 SuccessResource。
if (!function_exists('success')) {
function success($data = [])
{
return new \App\Http\Resources\Success($data);
}
}当然正确相应也分情况，操作成功是 return success ().
带有参数是 return success ($data);
用的 laravel5.5 + 的 apiResource，新建 BaseResource，添加 public $additional = ['code'=>0,'message'=>'success'];
<?php
namespace App\Http\Resources;
use Illuminate\Http\Resources\Json\Resource;
abstract class BaseResource extends Resource
{
/**
* 成功返回添加code码
* @var array
*/
public $additional = [
'code'=>0,
'message'=>'success'
];其他资源类继承该类，这样返回详情时 return new UserResource ($user); 会带 code 和 message。
列表和分页，我司的要求是返回 code、message、data、meta，meta 中是 4 个值，这样 meta 是要自己重新封装的，在封装 meta 时，将 code 和 message 一起写上就可以。
在 helpers 中封装 meta：
if (!function_exists('getPaginateMeta')) {
function getPaginateMeta($obj)
{
return [
'meta' => [
'total' => $obj->total(),
'per_page' => (int)$obj->perPage(),
'current_page' => $obj->currentPage(),
'last_page' => $obj->lastPage()
],
'code' => 0,
'message' => 'success'
];
}
}然后返回分页写法是
return UserResource::collection(collect($index->items())) ->additional(getPaginateMeta($index));当然最简单，也最不依赖，就是直接返回数组啦，return ['code'=>0,'message'=>'success'];
可以选择手写或者包装一个 trait
REST 风格的接口，通过状态码判断就行，不建议在每个 body 中增加 code
手动封装一个 trait 或可以考虑使用 Resources
return (new CateCollection($this->cate->page($page, $page_size, $query)->load('items')))->additional(['meta' => compact('total_nums', 'page_size', 'page')]);得到结果
{
title: {
id: "序号",
cate_name: "分类名",
item_nums: "文章数",
status: "显示",
created_at: "创建时间",
updated_at: "修改时间"
},
data: [
{
id: 1,
cate_name: "测试一",
status: true,
item_nums: 8,
created_at: "1 month ago",
updated_at: "2018-03-01 06:27:58"
}
],
meta: {
total_nums: 4,
page_size: 1,
page: 1
}
}跟我司的需求一样，我司的需求是不管成功失败，http_status 都是 200，一定要返回 code 和 message，成功 code 返回 0，失败 code 返回自定义 code 码。
然后我们的做法是异常建了一个异常类，laravel5.5 可以直接在自建的异常类渲染，就直接返回 code 和 message 了。
正确相应是，新建了一个 SuccessResource，在该 SuccessResource 中返回 code 和 message，
<?php
namespace App\Http\Resources;
use Illuminate\Http\Resources\Json\Resource;
class Success extends Resource
{
/**
* @var array
*/
protected $data;
/**
* 禁用顶层包裹
*
* @var null
*/
public static $wrap = null;
public function __construct($data = [], $resource = null)
{
$this->data = $data;
if (is_null($resource)) {
$resource = collect();
}
parent::__construct($resource);
}
/**
* Transform the resource collection into an array.
*
* @param \Illuminate\Http\Request
*
* @return array
*/
public function toArray($request)
{
$success = ['code' => 0, 'message' => 'success'];
$success['data'] = array_has($this->data, 'data') ? $this->data['data'] : $this->data;
if (array_has($this->data, 'meta')) {
$success['meta'] = $this->data['meta'];
}
return $success;
}
}
再在 helpers 中写一个 success () 方法，返回 SuccessResource。
if (!function_exists('success')) {
function success($data = [])
{
return new \App\Http\Resources\Success($data);
}
}当然正确相应也分情况，操作成功是 return success ().
带有参数是 return success ($data);
用的 laravel5.5 + 的 apiResource，新建 BaseResource，添加 public $additional = ['code'=>0,'message'=>'success'];
<?php
namespace App\Http\Resources;
use Illuminate\Http\Resources\Json\Resource;
abstract class BaseResource extends Resource
{
/**
* 成功返回添加code码
* @var array
*/
public $additional = [
'code'=>0,
'message'=>'success'
];其他资源类继承该类，这样返回详情时 return new UserResource ($user); 会带 code 和 message。
列表和分页，我司的要求是返回 code、message、data、meta，meta 中是 4 个值，这样 meta 是要自己重新封装的，在封装 meta 时，将 code 和 message 一起写上就可以。
在 helpers 中封装 meta：
if (!function_exists('getPaginateMeta')) {
function getPaginateMeta($obj)
{
return [
'meta' => [
'total' => $obj->total(),
'per_page' => (int)$obj->perPage(),
'current_page' => $obj->currentPage(),
'last_page' => $obj->lastPage()
],
'code' => 0,
'message' => 'success'
];
}
}然后返回分页写法是
return UserResource::collection(collect($index->items())) ->additional(getPaginateMeta($index));当然最简单，也最不依赖，就是直接返回数组啦，return ['code'=>0,'message'=>'success'];
return response ()->json ($content, 200); 这样就行了
粤ICP备18099781号-6
|
粤公网安备 44030502004330号
|
违法和不良信息举报
由 Summer 设计和编码 ❤
请登录
关于 LearnKu
推荐文章：