設置默認的JSON格式響應Laravel

Question

我正在按照Google（https://google.github.io/styleguide/jsoncstyleguide.xml）關於json格式響應的指導，努力創建一個良好的RESTful API服務。

有什麼辦法來設置每個響應的缺省JSON格式，因爲在指南中說

爲了保持整個API的一個一致的界面，JSON對象應 按照下面列出的結構。

object { 
    string apiVersion?; 
    string context?; 
    string id?; 
    string method?; 
    object { 
    string id? 
    }* params?; 
    object { 
    string kind?; 
    string fields?; 
    string etag?; 
    string id?; 
    string lang?; 
    string updated?; # date formatted RFC 3339 
    boolean deleted?; 
    integer currentItemCount?; 
    integer itemsPerPage?; 
    integer startIndex?; 
    integer totalItems?; 
    integer pageIndex?; 
    integer totalPages?; 
    string pageLinkTemplate /^https?:/ ?; 
    object {}* next?; 
    string nextLink?; 
    object {}* previous?; 
    string previousLink?; 
    object {}* self?; 
    string selfLink?; 
    object {}* edit?; 
    string editLink?; 
    array [ 
     object {}*; 
    ] items?; 
    }* data?; 
    object { 
    integer code?; 
    string message?; 
    array [ 
     object { 
     string domain?; 
     string reason?; 
     string message?; 
     string location?; 
     string locationType?; 
     string extendedHelp?; 
     string sendReport?; 
     }*; 
    ] errors?; 
    }* error?; 
}*; 

我與Laravel 5.4練習。我應該製作一個特質並使用自己的JSON響應格式嗎？因爲每次返回JSON響應時都必須編寫這種響應非常麻煩。

Answer 1

您可以使用toJson()方法。

https://laravel.com/docs/5.4/collections#method-tojson https://laravel.com/docs/5.4/pagination#converting-results-to-json

Answer 2

可以使用Middleware攔截響應對象，並對其進行格式化，只要你喜歡，比如我通常使用這種追加頭的響應：

<?php 
# app/Http/Middleware/ResponseAPI.php 

namespace App\Http\Middleware; 

use Closure; 

class ResponseAPI { 

    /** 
    * Handle an incoming request. 
    * 
    * @param \Illuminate\Http\Request $request 
    * @param \Closure $next 
    * @param string|null $guard 
    * @return mixed 
    */ 
    public function handle($request, Closure $next, $guard = null) 
    { 
     $response = $next($request); 

     if (in_array($response->status(), [200, 201, 404, 401, 422])) { 
      $response->header('Content-Type', 'application/json'); 
     } 

     return $response; 
    } 

} 

-

<?php 
# app/Http/Kernel.php 
. 
. 
. 
protected $routeMiddleware = [ 
    # others middlewares 
    'api.response' => \App\Http\Middleware\ResponseAPI::class 
]; 

-

<?php 
# app/Http/routes.php 

$app->group(['prefix' => 'api/v1', 'middleware' => ['api.response']], function($app) { 
    # all routes 
});