用 Laravel 构建 JSON API

2019/10/21 Laravel

RESTful 风格 API 设计原则与最佳实践

基( di )础( ji )的 Laravel 知识点 传送门

快速构建 RESTful API

Laravel 可以通过 资源控制器(resource)和路由快速构建遵循 REST 规范的路由。

  1. 首先创建资源控制器:
    php artisan make:controller TaskController --resource
    
  2. 然后在路由文件中注册资源控制器的路由:
    Route::resource('tasks', 'TaskController');
    

    通过上面两步,就构建好了以下API: Resource路由表

  3. 编辑资源文件,删除掉 showedit 两个方法, API 接口用不到展示表单。
  4. 得益于 Laravel 对 JSON 的友好支持, 即使在成员方法中返回对象、数组, 底层也会自动转为 JSON 格式。
     public function index()
     {
         return User::where('id', 1)->get();
     }
    

    测试JSON

  5. 自定义 JSON 数据组成格式

Search

    Table of Contents