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 将变更应用到数据库。

Rose.ai
Rose.ai

一个云数据平台,帮助用户发现、可视化数据

下载

四、创建 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');

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

340

2024.04.09

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

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

293

2024.04.09

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

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

773

2024.04.09

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

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

385

2024.04.10

laravel入门教程
laravel入门教程

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

141

2025.08.05

laravel实战教程
laravel实战教程

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

85

2025.08.05

laravel面试题
laravel面试题

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

80

2025.08.05

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

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

531

2026.03.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共48课时 | 2.5万人学习

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

共3课时 | 0.3万人学习

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

共1课时 | 850人学习

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

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