Laravel Api中正确的使用Response响应

Response响应(写Web页面时使用)

响应头部content-type: text/html;

<?php

namespace App\Http\Controllers;

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

class UserController extends Controller
{
    /**
     * 获取指定用户的简介
     *
     * @param  int  $id
     * @return \Illuminate\View\View
     */
    public function find($id)
    {
         $user = User::find($id);
         return response(['user' => $user]);
    }
}

JsonResponse响应(写Api时使用)

响应头部content-type: application/json;

<?php

namespace App\Http\Controllers;

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

class UserController extends Controller
{
    /**
     * 获取指定用户的简介
     *
     * @param  int  $id
     * @return \Illuminate\View\View
     */
    public function find($id)
    {
         $user = User::find($id);
         return response()->json(['user' => $user]);
    }
}

编写Api时合理选择响应类型的重要性

写Api的时候应该选择JsonResponse响应,不然响应头部就会错误(content-type: text/html;),这样可能会导致很多的问题。比如当token失效时,laravel的认证守卫如果识别到你的响应头部为content-type: text/html; 那它将会帮你做一个自动跳转到login页面,我们知道api是无法跳转的,所以这时候你客户端那里并能获取到http status为401的响应,就会对你系统造成影响

本作品采用《CC 协议》,转载必须注明作者和本文链接
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
讨论数量: 1

一般写 api 的时候,我都会在 api 中间件中添加一个自动设置请求头为 application/json 的中间件,这样所有的 api 接口就都可以直接使用 response() 方法返回,不需要理会前端请求头的 accept 参数。

3年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!