API 系列教程(三):使用 API Resource 来创建自定义 JSON 格式的 API

这篇博客介绍了如何使用 Laravel API Resource 和 Fractal 扩展包来创建自定义 JSON 格式的 API。通过 API Resource,可以简化数据格式转化,减少敏感信息的暴露,提高代码复用性和可维护性。文中详细展示了如何创建资源转化器,处理额外数据信息和关联关系,并给出了示例代码。
摘要由CSDN通过智能技术生成

上一篇教程中我们通过 jwt-auth 实现了 Laravel 的 API 认证。

用户请求登录接口 http://apidemo.test/api/auth/login 登录成功后,获取到 JSON 响应,响应头会带有 token 信息。

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE1LCJpc3MiOiJodHRwOi8vYXBpZGVtby50ZXN0L2FwaS9hdXRoL2xvZ2luIiwiaWF0IjoxNTIyOTQ3NjgyLCJleHAiOjE1MjI5NTEyODIsIm5iZiI6MTUyMjk0NzY4MiwianRpIjoidnhCeU10bVFnbGFBdm14WSJ9.iJc1LCbkK-2HIydp6cZ_a191ZYNT7GSfy6y9D9LTq9E

Authorization 对应的值就是 token(令牌)。

然后,用户就可以通过访问 http://apidemo.test/api/auth/user 获取当前登录用户的信息。

必须传递请求头:

Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE1LCJpc3MiOiJodHRwOi8vYXBpZGVtby50ZXN0L2FwaS9hdXRoL2xvZ2luIiwiaWF0IjoxNTIyOTQ3NjgyLCJleHAiOjE1MjI5NTEyODIsIm5iZiI6MTUyMjk0NzY4MiwianRpIjoidnhCeU10bVFnbGFBdm14WSJ9.iJc1LCbkK-2HIydp6cZ_a191ZYNT7GSfy6y9D9LTq9E

形式为:

Authorization:Bearer $token

如果 token 正确且有效,就会获取到该用户的信息:

{
    "status": "success",
    "data": {
        "id": 15,
        "name": "user02",
        "email": "user02@example.com",
        "created_at": "2018-04-05 21:13:16",
        "updated_at": "2018-04-05 21:13:16",
        "api_token": null
    }
}

可以发现,上面的返回数据以原生格式返回,没有经过任何处理,甚至有可能包含敏感信息。

我们可以处理之后再返回,一二个接口还好,如果现实业务中面对成百上千个接口呢?这种处理方式显然不合适,不仅耗费大量时间和精力,复用性差,且难以维护。

好在 Laravel 5.5 开始,内置了 API Resource 功能,可帮助我们快速建立起模型和返回的 JSON 数据之间的桥梁。

在此之前,很多人是通过第三方扩展包基于 Fractal 实现数据格式转化的,API Resource 有点类似把 Fractal 扩展包收编为官方特性的味道,为了更好的引入 API Resource ,我们先来看看 Fractal 怎么用。

Laravel Fractal 扩展包

这里,在之前项目的基础上进行开发,避免重复劳动。

首先,通过 Composer 安装对应扩展包

composer require spatie/laravel-fractal

安装完成后,发布配置文件以便定制 Fractal:

php artisan vendor:publish --provider="Spatie\Fractal\FractalServiceProvider"

还是以 User 模型为例,我们为它创建一个格式转化器:

php artisan make:transformer UserTransformer

编辑生成的 app/Transformers/UserTransformer 文件内容如下:

<?php
namespace App\Transformers;

use App\User;
use League\Fractal\TransformerAbstr
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值