网络编程 
首页 > 网络编程 > 浏览文章

在 Laravel 中动态隐藏 API 字段的方法

(编辑:jimmy 日期: 2024/5/20 浏览:3 次 )

我最近在 Laravel Brasil 社区看到一个问题,结果比看起来更有趣。想象一下你有一个 UsersResource 用下面的实现:

<"_blank" href="https://hackernoon.com/first-impressions-on-laravel-api-resources-4869b73b7847">First Impression on API Resources
  
  • API Resources with Nested Relationship
  • 1- 初始化项目

    有趣的东西从第3节开始.

    composer create-project --prefer-dist laravel/laravel api-fields
    cd api-fields
    touch database/database.sqlite

    编辑.env文件,删除数据库设置并使用 SQLite

    DB_CONNECTION=sqlite

    继续设置项目

    php artisan migrate
    php artisan make:resource UsersResource
    php artisan make:resource --collection UsersResourceCollection 
    php artisan make:controller UsersController
    php artisan tinker
    factory(App\User::class)->times(20)->create();
    quit

    2- 路由

    确保在 api.php 文件中创建一个路由。

    Route::apiResource('/users', 'UsersController');

    3- 控制器

    控制器代表了期望的目标。在这个例子中,让我们假设在用户列表中,我们只想要所有用户的名字,而在用户显示中,我们只想隐藏电子邮件地址。

    <"htmlcode">
    
    <"external nofollow" href="http://api.dev/api/users/1">http://api.dev/api/users/1 ,你会发现响应中已经没有id 字段了。

    {
     "data": {
     "name": "Mr. Frederik Morar",
     "email": "darryl.wilkinson@example.org"
     }
    }

    5- UsersResourceCollection 类

    执行项目集合中的 index 方法, 我们需要作出如下修改:

    (1) 确保  UsersResource::collection 返回 UsersResourceCollection 实例

    (2) 在  UsersResourceCollection 上公开 hide 方法

    (3) 将隐藏的字段传递给  UsersResource

    关于 (1), 我们只需要重写  UsersResource 中的 collection 方法

    <"htmlcode">
    
    <"external nofollow" href="http://api.dev/api/users">http://api.dev/api/users  看到返回结果中没有了 id 和 email 字段了如在 UsersController 中的指定方法 .

    {
     "data": [{
     "name": "Mr. Frederik Morar"
     }, {
     "name": "Angel Daniel"
     }, {
     "name": "Brianne Mueller"
     }],
     "links": {
     "first": "http://lab.php71/api-fields-2/public/api/users",
     "last": "http://lab.php71/api-fields-2/public/api/users",
     "prev": null,
     "next": "http://lab.php71/api-fields-2/public/api/users"
     },
     "meta": {
     "current_page": 1,
     "from": 1,
     "last_page": 7,
     "path": "http://api-fields.lab.php71/api/users",
     "per_page": 3,
     "to": 3,
     "total": 20
     }
    }

    6- 总结

    本文目标是让Resource类通过隐藏一些在其他接口允许暴露的字段从而变得更加灵活。例如当我们请求/users接口时响应的数据是不包含avatar字段的,但是当请求/users/99时响应的数据里包含avatar字段。

    我不推荐过度重复去请求API资源,因为它很可能会把简单的事情变得更加复杂,所以说在请求的时候隐藏某些特定的字段是更简单、更合理的解决方案。

    以上所述是小编给大家介绍的在 Laravel 中动态隐藏 API 字段的方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对网站的支持!
    如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

    上一篇:layui数据表格自定义每页条数limit设置
    下一篇:Laravel 实现添加多语言提示信息