0

0

LaravelAPI怎么开发_Laravel开发RESTfulAPI接口完整教程

爱谁谁

爱谁谁

发布时间:2025-11-23 21:23:00

|

320人浏览过

|

来源于php中文网

原创

使用Laravel开发RESTful API需先创建项目并配置数据库,接着生成模型与迁移文件,再创建API控制器并定义路由,最后统一响应格式并启用Sanctum认证机制保护接口。

laravelapi怎么开发_laravel开发restfulapi接口完整教程

如果您正在构建一个前后端分离的应用程序,并希望使用 Laravel 提供数据交互支持,则需要开发符合 RESTful 规范的 API 接口。以下是使用 Laravel 开发 RESTful API 的详细步骤:

一、创建 Laravel 项目

在开始开发 API 之前,需要先搭建 Laravel 基础项目环境。通过 Composer 创建一个新的 Laravel 应用,确保系统具备基本的目录结构和配置文件

1、打开终端并执行命令:composer create-project laravel/laravel api-project,其中 "api-project" 是项目名称。

2、进入项目目录:cd api-project

3、启动内置服务器测试是否安装成功:php artisan serve,然后访问 http://localhost:8000 查看欢迎页面。

二、配置数据库连接

RESTful API 通常需要与数据库交互以存储和检索资源数据。Laravel 使用 .env 文件管理环境配置,包括数据库连接信息。

1、打开项目根目录下的 .env 文件,修改以下字段为您的数据库信息:

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

DB_DATABASE=your_database_name

DB_USERNAME=your_database_user

DB_PASSWORD=your_password

2、保存文件后,运行迁移命令生成基础数据表:php artisan migrate

三、生成模型与迁移文件

每个 API 资源通常对应一个 Eloquent 模型和数据库表。使用 Artisan 命令可以快速生成模型及其关联的迁移文件。

1、执行命令创建模型和迁移,例如创建 Post 模型:php artisan make:model Post -m

2、打开生成的迁移文件(位于 database/migrations 目录),在 up 方法中定义字段,如添加 title 和 content 字段。

3、编辑 app/Models/Post.php 文件,在 $fillable 属性中指定可填充字段,例如 protected $fillable = ['title', 'content'];

4、再次运行 php artisan migrate 将变更应用到数据库。

易优微信教育培训小程序模板
易优微信教育培训小程序模板

易优微信教育培训小程序模板是基于前端开源小程序+后端易优cms+标签化API接口,是一套开源、快速搭建个性化需求的小程序CMS。轻量级TP底层框架,前后端分离,标签化API接口可对接所有小程序,支持二次开发。即使小白用户也能轻松搭建制作一套完整的线上版小程序。 微信教育培训小程序模板主要特点:1、代码开源,支持二次修改2、微信原生写法,兼容性更好,代码可读性更强3、功能接口完整,支持eyoucms

下载

四、创建 API 控制器

控制器负责处理 HTTP 请求并返回相应的 JSON 响应。Laravel 支持资源控制器,能自动映射标准 CRUD 操作到 RESTful 路由

1、使用 Artisan 生成资源控制器:php artisan make:controller Api/PostController --api --model=Post

2、该命令会生成仅包含 index、store、show、update 和 destroy 方法的控制器,适用于 API 场景。

3、在控制器中编写逻辑,例如在 store 方法中验证输入并保存新记录,在 index 中返回分页的 JSON 列表。

五、定义 API 路由

Laravel 将 API 路由集中注册在 routes/api.php 文件中,默认带有 /api 前缀。通过 Route::resource 可一键绑定控制器方法。

1、打开 routes/api.php 文件,添加路由声明:Route::apiResource('posts', 'PostController');

2、此路由将自动映射 GET、POST、PUT、DELETE 等请求到 PostController 对应方法。

3、可通过 php artisan route:list 查看所有已注册的 API 路由及其对应动作。

六、设置响应格式与状态码

RESTful API 应统一返回结构化的 JSON 数据,并附带合适的 HTTP 状态码,便于前端解析和错误处理。

1、在控制器方法中使用 Laravel 的 response()->json() 返回数据,例如 return response()->json($data, 200);

2、对于创建成功的情况返回 201 状态码:return response()->json($post, 201);

3、当资源未找到时,抛出或手动返回 404 响应:return response()->json(['message' => 'Not found'], 404);

七、启用 API 认证机制

为了保护 API 不被未授权访问,建议集成 Laravel Sanctum 实现 Token 认证。

1、安装 Sanctum 包:composer require laravel/sanctum

2、发布配置和迁移文件:php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"

3、运行迁移命令更新数据库:php artisan migrate

4、在 config/auth.php 中将 api guard 的 driver 设置为 sanctum

5、在需要保护的路由上添加 middleware('auth:sanctum'),例如 Route::middleware('auth:sanctum')->apiResource('posts', 'PostController');

相关专题

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

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

2490

2023.09.01

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

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

1592

2023.10.11

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

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

1485

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数据库相关内容,可以阅读本专题下面的文章。

1414

2023.10.23

html怎么上传
html怎么上传

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

1234

2023.11.03

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

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

1445

2023.11.09

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

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

1305

2023.11.13

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

3

2026.01.13

热门下载

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

精品课程

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

共48课时 | 1.7万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 790人学习

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

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