Day07-Response 最重要的是整整齐齐-API Resources

大家好～
延续昨天说的话题，
如果我们想修改 API 回传的格式，
还要在每个 function 中个别修改那岂不是很麻烦吗？
而今天要来实作的 API Resources 就能解决上述的问题罗～

建立 API Resources

首先先来建立我们 Message 的 Resource 吧！

php artisan make:resource Message

php artisan make:resource MessageCollection

输入上面两个指令後，
我们会得到两个 Resource ，
为什麽要有两个呢？
简单来说，
以上面建立的两个 Resource 为例：

app/Http/Resources/Message.php
是转换单个 Model 的 Resource，extends 了 JsonResource。
app/Http/Resources/MessageCollection.php
是转换 Collection 的 Resource，extends 了 ResourceCollection。

两个 Resource 负责的工作不太一样喔！

在建立 Resource 时带上 --collection 参数，
或是使用 Collection 当作名称结尾，
都能够建立 extends 了 ResourceCollection 的 Resource 喔～

实作 API Resources

app/Http/Resources/Message.php

public function toArray($request)
{
    return [
        'id' => $this->id,
        'title' => $this->title,
        'content' => $this->content,
        'updated_at' => $this->updated_at,
        'user' => User::make($this->whenLoaded('user')),
    ];
}

这样简单 Resource 就完成罗！
简单介绍一下，
基本格式大概是这样的规则：

return [
    '自定义 Key 值' => $this->Model属性名称,
];

那该如何用他转换我们想回传的资料呢？

首先先在要使用 Resource 的 Controller 内 use 他们吧。

use App\Http\Resources\Message as MessageResource;
use App\Http\Resources\MessageCollection;

以检索单一笔留言为例，
我们原本是：

public function show($messageId)
{
    $message = Message::with('user')->findOrFail($messageId);

    return response($message, Response::HTTP_OK);
}

现在改成：

public function show($messageId)
{
    $message = Message::with('user')->findOrFail($messageId);

    return response(MessageResource::make($message), Response::HTTP_OK);
}

上面的例子是用当资料型态为 Model 时为例子，
那如果资料型态是 Collection 呢？

这是我们原本的查询所有留言功能 return response 的方式：

public function index()
{
    $messages = Message::with('user')->get();

    return response($messages, Response::HTTP_OK);
}

只要改成：

public function index()
{
    $messages = Message::with('user')->get();

    // 方法 1.
    return response(MessageCollection::make($messages), Response::HTTP_OK);
    // 方法 2.
    return response(MessageResource::collection($messages), Response::HTTP_OK);
}

方法1与方法2都可以回传资料型态为 Collection 的资料喔！

成果预览：