Laravel 映射 API 的输出

Laravel 是一个流行的 PHP 框架，它提供了一系列强大的工具来快速构建 Web 应用程序。其中之一就是 API 映射。它可以帮助你将数据库模型映射到 API 响应中，使得开发 API 变得更加容易。

安装

在开始使用 Laravel API 映射之前，你需要确保已经安装了 Laravel，并安装了 laravel/fractal 扩展包。你可以通过 Composer 进行安装：

composer require league/fractal

然后需要将 League\Fractal\TransformerAbstract 这个自定义转换器加载到程序中，这个转换器是我们用来将模型转换为 API 响应格式的。

创建响应

有了转换器之后，我们就可以开始创建 API 响应了。在 Laravel 中，可以通过控制器方法返回一个响应对象来创建 API 响应。比如下面这个例子：

use App\Transformers\BookTransformer;

class BookController extends Controller
{
    public function index()
    {
        $books = Book::all();

        $transformer = new BookTransformer();

        $response = fractal()
            ->collection($books)
            ->transformWith($transformer)
            ->toArray();

        return response()->json($response);
    }
}

上面的示例中，我们从数据库获取了所有的图书记录，然后使用 BookTransformer 转换器将图书记录转换为我们需要的格式。最后我们调用 toArray() 方法将响应转换为数组，然后返回 JSON 格式的响应。

创建转换器

在上面的示例中，我们使用了 BookTransformer 转换器将数据库中的单个图书记录转换为我们想要的响应格式。

use League\Fractal\TransformerAbstract;

class BookTransformer extends TransformerAbstract
{
    public function transform(Book $book)
    {
        return [
            'id' => $book->id,
            'title' => $book->title,
            'author' => $book->author,
            'description' => $book->description,
            'created_at' => $book->created_at->toIso8601String(),
            'updated_at' => $book->updated_at->toIso8601String(),
        ];
    }
}

转换器是用来将模型对象转换为 API 响应格式的。上面的示例中，我们使用了 transform 方法来定义一个单个图书记录的转换方式。在这个方法中，我们将返回一个数组，数组中定义了每个属性的名称和值。

创建集合响应

除了单个资源之外，我们可能还需要创建一个集合响应，以便在访问 API 的时候，一次获取多个资源。

use App\Transformers\BookTransformer;

class BookController extends Controller
{
    public function index()
    {
        $books = Book::all();

        $transformer = new BookTransformer();

        $response = fractal()
            ->collection($books)
            ->transformWith($transformer)
            ->toArray();

        return response()->json($response);
    }
}

上面的示例中，我们使用了 fractal() 函数来创建一个包含所有图书记录的集合响应。然后我们使用 BookTransformer 转换器将图书记录转换为响应格式。

创建嵌套响应

有时候我们需要在 API 响应中包含其他的资源，这个时候我们需要创建一个嵌套响应。

use App\Transformers\AuthorTransformer;
use App\Transformers\BookTransformer;

class BookController extends Controller
{
    public function show($id)
    {
        $book = Book::find($id);

        $bookTransformer = new BookTransformer();
        $authorTransformer = new AuthorTransformer();

        $response = fractal()
            ->item($book)
            ->transformWith($bookTransformer)
            ->includeAuthor()
            ->toArray();

        return response()->json($response);
    }
}

上面的示例中，我们使用了 fractal() 函数创建了一个嵌套资源的响应。我们使用 BookTransformer 将图书记录转换为我们需要的格式，并使用 includeAuthor() 函数指定了需要包含图书作者的信息。在 AuthorTransformer 中，我们定义了如何将作者转换为我们需要的格式。

结论

Laravel API 映射提供了一种简单而强大的方式来构建 Web 应用程序的 API。在本文中，我们介绍了如何创建 API 响应、转换器、集合响应和嵌套响应。希望这篇文章能够帮助你更好地理解 Laravel API 映射，并在实际开发中使用它来构建更好的 Web 应用程序。