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

ThinkPHP RESTful接口怎么规范编写基础实操方法

星晨酱_2478

星晨酱_2478

发布时间:2026-10-02 06:25:20

|

272人浏览过

|

来源于php中文网

原创

ThinkPHP 6.x 不支持 --api 参数生成 RESTful 控制器,需手动规范:控制器路径为 api/User、继承 think\Controller、路由显式注册 Route::resource('user', 'api.User')、方法名严格为 index/read/save/update/delete、每个方法必须用 json() 返回 JSON 响应。

thinkphp restful接口怎么规范编写基础实操方法

ThinkPHP 6.x 不提供“一键生成 RESTful 控制器”的功能,所谓 php think make:controller User --api 会直接报错 Unknown option --api。规范编写 RESTful 接口的关键在于手动补全四个核心环节:控制器路径与继承、资源路由显式注册、方法名严格对齐、JSON 响应显式返回。

控制器必须按 api/ 路径生成并继承 think\Controller

不能加 --api 参数,正确命令是:

  • php think make:controller api/User → 生成 app/controller/api/User.php
  • 类名默认为 UserController,需确认它 继承 think\Controller(不是 think\facade\Controller)
  • think\Controller 已禁用视图,无需再写 $this->view = null

资源路由必须在 app/route/app.php 中显式注册

别写在 route/api.php,也别套在中间件分组里,否则路由不生效:

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

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

下载
  • 写法必须是:Route::resource('user', 'api.User');(注意用点号,不是斜杠或反斜杠)
  • 映射关系固定:GET /user → index()、POST /user → save()、GET /user/1 → read($id)、PUT /user/1 → update($id)、DELETE /user/1 → delete($id)
  • 方法名必须一字不差:只能是 index / read / save / update / delete,写成 show、store、list 都不会被识别

每个方法结尾必须显式调用 json() 返回

TP6 不会自动转 JSON,只写 return ['data' => $user]; 会导致空白响应、HTML 模板输出或 500 错误:

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

  • 统一用 json() 辅助函数:return json(['code' => 0, 'data' => $user]);
  • 创建成功建议返回 201 状态码:return json(['code' => 0, 'data' => $user], 201);
  • 不要用 Response::create(..., 'json'),json() 更简洁且兼容性更好

前端发 PUT/DELETE 需加 X-HTTP-Method-Override 头

浏览器表单和部分 SDK 默认只支持 GET/POST,直接发 PUT/DELETE 会被服务端拒收(405):

  • 前端在 POST 请求头中添加:X-HTTP-Method-Override: PUT(或 DELETE)
  • TP6 路由层原生识别该 Header 并重写请求方法,后端无需额外代码
  • 测试时可用 Postman 手动设置该 Header,确保请求能正确命中 update() 或 delete()

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
WorkBuddy

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

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

DeepSeek

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

讯飞智作

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

AionClaw
AionClaw Hot

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

相关专题

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

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

524

2025.11.26

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

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

3561

2024.04.10

thinkphp性能怎么样
thinkphp性能怎么样

thinkphp 是一款高性能的 php 框架,具备缓存机制、代码优化、并行处理和数据库优化等优势。官方性能测试显示,它每秒可处理超过 10,000 个请求,实际应用中被广泛用于京东商城、携程网等大型网站和企业系统。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1240

2024.04.10

ThinkPHP6后台管理系统开发与RBAC权限控制实践
ThinkPHP6后台管理系统开发与RBAC权限控制实践

本专题围绕 ThinkPHP6 在后台管理系统开发中的应用展开,重点讲解基于 RBAC 模型的权限控制实现方案。内容涵盖管理员角色设计、菜单权限分配、接口鉴权、中间件拦截机制以及后台模块化开发思路。同时结合实际案例,讲解如何构建完整的后台管理系统,包括用户管理、权限管理与操作日志记录,帮助开发者搭建安全、可扩展的企业级后台系统。

463

2026.03.20

ThinkPHP API接口开发与前后端分离实战
ThinkPHP API接口开发与前后端分离实战

本专题围绕ThinkPHP在前后端分离项目中的 API 开发展开,系统讲解 RESTful 接口设计规范、统一返回结构、参数验证与异常处理机制。内容涵盖 Token 鉴权、跨域处理、接口版本管理以及接口文档生成方案。通过完整项目案例,帮助开发者构建规范、高效、易维护的后端接口服务体系。

324

2026.03.20

ThinkPHP ORM模型关系与数据库操作优化实践
ThinkPHP ORM模型关系与数据库操作优化实践

本专题聚焦ThinkPHP中 ORM 模型的高级用法与数据库操作优化技巧。内容包括一对一、一对多、多对多关系定义与使用、关联预加载、查询构建器优化以及复杂查询封装方法。同时结合实际业务场景,讲解如何避免 N+1 查询问题、提升数据库访问效率,帮助开发者编写高性能的数据访问层代码。

219

2026.03.20

ThinkPHP模型详解
ThinkPHP模型详解

本专题整合了ThinkPHP模型相关内容,阅读专题下面的文章了解更多详细介绍。

258

2026.03.26

ThinkPHP表单验证与数据安全处理实战
ThinkPHP表单验证与数据安全处理实战

本专题聚焦 ThinkPHP 在表单处理中的验证与安全机制,系统讲解验证器使用、自定义规则、场景验证以及错误提示处理。内容涵盖 XSS 防护、SQL 注入防御、数据过滤与输入校验等关键安全措施。通过实际案例,帮助开发者构建安全可靠的数据处理流程。

201

2026.03.30

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

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

0

2026.09.30

热门下载

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

精品课程

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

共1课时 | 197人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 1.1万人学习

墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

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

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