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

ThinkPHP 5.1手册怎么使用?RESTful API开发全流程

老浩姑娘_3934

老浩姑娘_3934

发布时间:2026-08-09 18:20:07

|

573人浏览过

|

来源于php中文网

原创

必须使用2021年10月后更新的《ThinkPHP5.1完全开发手册》第7章“API开发”→7.3节,按路由定义(Route::resource)、控制器命名规范(User类+index/read/save等固定方法)、JWT鉴权(扩展或中间件)、参数验证(Validate类)及统一JSON响应四步闭环实现RESTful API。

thinkphp 5.1手册怎么使用?restful api开发全流程

要快速上手ThinkPHP 5.1开发RESTful API,必须绕过手册中零散的配置说明,直接定位核心路径:从路由定义→控制器分层→资源操作→权限拦截→响应封装,每一步都依赖手册中特定章节的精确引用,跳过无关的模板渲染或命令行工具内容。

确认手册版本与阅读入口

打开官方《ThinkPHP5.1完全开发手册》PDF或在线版,【必须使用2021年10月后更新的版本】,旧版缺失v1/v2版本路由分组、ApiValidate自动注入等关键描述。首页搜索栏输入“RESTful”直达第7章“API开发”,不要从“路由”或“控制器”章节盲查——这两处只讲基础语法,不提资源路由绑定规则。

翻到“7.3 RESTful资源路由”小节,重点划出三行加粗说明:① Resource路由仅支持controller目录下以Resource结尾的类;② 自动生成的index/show/create等方法名不可重写;③ route.php中必须用Route::resource()而非Rule()声明。

初始化RESTful路由结构

在application/route.php中写入:

立即学习“PHP免费学习笔记(深入)”;

Route::resource('v1/user', 'api/v1.User')->except(['create', 'edit']);

这行代码会自动生成GET /v1/user(列表)、GET /v1/user/:id(单条)、POST /v1/user(新增)、PUT /v1/user/:id(更新)、DELETE /v1/user/:id(删除)五条路由。注意【'api/v1.User'中的斜杠不能写成点号,否则容器无法解析命名空间】。

验证是否生效:启动内置服务器php think run,访问http://localhost:8000/v1/user,返回404说明路由未加载;返回空数组说明路由已通但控制器未响应——此时可进入下一步。

创建符合规范的资源控制器

在application/api/v1/目录下新建User.php文件,继承thinkController而非普通Controller:

namespace apppi 1;
use thinkController;
class User extends Controller { public function index() { return json(['code'=>200, 'data'=>[]]); } }

关键点:控制器类名必须与路由声明中最后一段一致(此处为User),且必须放在api/v1子目录;方法名严格对应HTTP动词,index→GET,read→GET(带id),save→POST,update→PUT,delete→DELETE。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载

若将方法名写成getUserList或postAddUser,路由将无法匹配——手册第7.3.2节明确标注:“资源控制器方法名不可自定义,仅允许index/read/save/update/delete”。

接入JWT鉴权中间件

方法一:使用china-wangyu/think-restful扩展

执行composer require china-wangyu/think-restful → 修改application/config/app.php,添加'exception_handle' => '\restful\exception\ApiException' → 在User控制器顶部添加use restfuljwtJwt; → 在index方法开头插入(new Jwt())->check();

方法二:手动集成tp5.1原生Auth中间件

在application/middleware.php中注册中间件:['api/v1.*' => \app\middleware\Auth::class] → 创建application/middleware/Auth.php,其中handle方法调用Token::check()并捕获TokenException → 注意【中间件必须放在api/v1.*路由前缀下,否则/v1/user路由不触发】。

定义参数验证与异常统一返回

第一步:在application/api/v1/validate/下新建UserValidate.php

第二步:继承thinkValidate,定义rule属性为['user_name'=>'require|alphaNum','user_pwd'=>'require|min:6']

第三步:在User控制器的save方法中插入$this->validate($this->request->param(), 'UserValidate');

第四步:修改application/exception_handle.php,将render方法中JsonResponse替换为restful esponseJson::instance()->fail($e->getCode(), $e->getMessage());

这四步完成后,当POST /v1/user提交缺少user_name字段的数据时,接口将立即返回{"code":400,"msg":"user_name不能为空","data":[]},而非默认的HTML错误页。

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

豆包大模型

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

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

Lovart
Lovart Hot

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

DeepSeek

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

524

2025.11.26

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

20

2026.09.30

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

0

2026.09.30

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

20

2026.09.30

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

20

2026.09.30

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

20

2026.09.29

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

220

2026.09.23

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

140

2026.09.23

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

120

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

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