0

0

laravel如何构建一个RESTful API接口_Laravel构建RESTful API接口方法

冰火之心

冰火之心

发布时间:2025-09-30 09:51:02

|

624人浏览过

|

来源于php中文网

原创

答案:Laravel通过资源路由、API控制器、数据验证、资源类和Sanctum认证快速构建RESTful API,流程清晰高效。

laravel如何构建一个restful api接口_laravel构建restful api接口方法

构建一个 RESTful API 接口在 Laravel 中非常直观且高效。Laravel 提供了路由、控制器、中间件、资源类等工具,能快速搭建结构清晰、符合 REST 规范的 API。

定义 RESTful 路由

Laravel 的路由系统支持资源路由,可以一键注册 CRUD 对应的 7 个标准接口。

routes/api.php 中添加:

use App\Http\Controllers\PostController;

Route::apiResource('posts', PostController::class);

这会自动注册以下路由:

  • GET /api/posts → index(获取列表)
  • POST /api/posts → store(创建资源)
  • GET /api/posts/{id} → show(查看单条)
  • PUT/PATCH /api/posts/{id} → update(更新资源)
  • DELETE /api/posts/{id} → destroy(删除)

创建控制器处理请求

使用 Artisan 命令生成资源控制器:

php artisan make:controller PostController --api

--api 参数会生成不含 views 方法的轻量控制器,只包含 index、store、show、update、destroy 等方法。

示例方法实现:

public function index()
{
    return response()->json(Post::all());
}

public function store(Request $request)
{
    $validated = $request->validate([
        'title' => 'required|string|max:255',
        'content' => 'required',
    ]);

    $post = Post::create($validated);

    return response()->json($post, 201);
}

使用资源类格式化响应(可选但推荐)

Laravel 的 Resource 类可以帮助你统一输出结构,便于前端解析。

生成资源类:

php artisan make:resource PostResource

在控制器中使用:

Autoppt
Autoppt

Autoppt:打造高效与精美PPT的AI工具

下载
use App\Http\Resources\PostResource;

public function show(Post $post)
{
    return new PostResource($post);
}

你还可以用 PostResource::collection() 包装集合。

添加中间件控制访问权限

API 通常需要身份验证。Laravel Sanctum 是轻量级 API 认证方案。

安装 Sanctum:

composer require laravel/sanctum

发布配置并迁移:

php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"
php artisan migrate

app/Http/Kernel.php 中为 api guard 使用 sanctum:

'api' => [
    \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
    'throttle:api',
    \Illuminate\Routing\Middleware\SubstituteBindings::class,
],

然后保护你的路由:

Route::middleware('auth:sanctum')->group(function () {
    Route::apiResource('posts', PostController::class);
});

基本上就这些。Laravel 构建 RESTful API 的核心是:资源路由 + 控制器 + 数据验证 + 可选资源类 + 认证中间件。流程清晰,开发效率高。不复杂但容易忽略细节,比如状态码和 JSON 结构的一致性,建议团队制定返回格式规范。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2644

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1656

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1513

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1418

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1448

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

68

2026.01.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.8万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号