README

一个非常小的包，可以帮助你轻松返回可读的 API 响应。

安装

通过 Composer 安装此包。

composer require dees040/laravel-api-responses

你就可以开始了！

用法

只需使用其中一个辅助函数，你就可以顺利使用了。

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class UsersController extends Controller
{
    /**
     * Show the given user.
     *
     * @param  \App\User  $user
     * @return \Illuminate\Http\Response
     */
    public function show(User $user)
    {
        if (! $user->isAdmin()) {
            return forbidden();
        }
        
        return ok($user);
    }
}

方法

所有方法都接受一个 $data 参数。这可以是任何可以用于 JSON 响应的数据，例如字符串、整数、数组、模型等。

自定义响应（代码）

如果你希望发送列表中没有的状态码，可以使用 json_response($data = null, $status = 200) 辅助函数。这里你可以找到一个 HTTP 状态码的备忘单，或者使用我个人的最爱 http.cat 😉。

如果你想发送错误响应，可以使用 error_json_response($message = '', $errors = [], $status = 400)。此方法将发送如下 JSON 响应

error_json_response('User not found.', [
    'id' => 'The ID does not exists.'
]);

输出

{
  "message": "User not found.",
  "errors": {
    "id": "The ID does not exists."
  }
}

dees040 / laravel-api-responses

维护者

详细信息

README

安装

用法

方法

自定义响应（代码）