讲师中心 微信公众号
AI工具推荐 视频效率加速

Laravel怎么在api文件里定义一个GET接口

陌墨君_2288

陌墨君_2288

发布时间:2026-10-27 15:12:27

|

116人浏览过

|

来源于php中文网

原创

Laravel API GET接口定义在routes/api.php,自动带/api/前缀并使用API中间件;支持闭包、控制器方法、路径/查询参数三种写法,需注意禁用CSRF、统一响应格式及可选版本控制。

laravel怎么在api文件里定义一个get接口

在 Laravel 中,API 的 GET 接口通常定义在 routes/api.php 文件里,它会自动加上 /api/ 前缀,并默认使用 API 中间件(如无状态、CSRF 免除等)。

1. 基础 GET 路由写法

打开 routes/api.php,用 Route::get() 定义接口:

use Illuminate\Http\Request;

Route::get('/users', function (Request $request) {
    return response()->json(['users' => ['Alice', 'Bob']]);
});

访问 http://your-app.test/api/users 就能返回 JSON 数据。

2. 指向控制器方法(推荐)

实际项目中建议把逻辑移到控制器里,先生成控制器:

php artisan make:controller Api/UserController --api

然后在 routes/api.php 中注册:

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载
use App\Http\Controllers\Api\UserController;

Route::get('/users', [UserController::class, 'index']);

再在 app/Http/Controllers/Api/UserController.php 中写处理逻辑:

public function index()
{
    return response()->json([
        'data' => User::all(),
        'message' => 'Users fetched successfully'
    ]);
}

3. 带参数的 GET 接口

支持路径参数或查询参数:

  • 路径参数(如 /api/users/123):
Route::get('/users/{id}', [UserController::class, 'show']);

控制器中接收:

public function show($id)
{
    $user = User::find($id);
    return $user ? response()->json($user) : response()->json(['error' => 'Not found'], 404);
}
  • 查询参数(如 /api/users?role=admin):
public function index(Request $request)
{
    $users = User::when($request->role, function ($query, $role) {
        return $query->where('role', $role);
    })->get();
    return response()->json($users);
}

4. 注意事项

  • 不要加 CSRF 防护:API 路由默认不启用 VerifyCsrfToken,确保中间件组是 api(routes/api.php 默认已配置)
  • 响应统一格式:可配合资源类(php artisan make:resource UserResource)规范输出结构
  • 版本控制可选:如需多版本,可写成 Route::prefix('v1')->group(...)

不复杂但容易忽略细节,按这个结构写,接口就稳了。

热门AI工具

更多
Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

857

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

855

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2508

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

4441

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

6450

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

4256

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

7969

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

1496

2026.03.04

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

100

2026.10.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 213人学习

PHP自制框架
PHP自制框架

共8课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn