0

0

php怎么写restful接口_php如何设计规范的RESTfulAPI接口

看不見的法師

看不見的法師

发布时间:2026-03-18 21:53:52

|

243人浏览过

|

来源于php中文网

原创

原生PHP实现RESTful路由需手动解析$_SERVER['REQUEST_METHOD']和PATH_INFO,用php://input读取并JSON解码请求体,统一设Content-Type和状态码。

php怎么写restful接口_php如何设计规范的restfulapi接口

怎么用 PHP 原生写一个能跑通的 RESTful 路由

PHP 本身不内置 REST 路由,得靠自己解析 $_SERVER['REQUEST_METHOD']$_SERVER['PATH_INFO'](或 $_GET['path'])来分发。框架如 Laravel 是封装了这层,但原生写反而最清楚边界在哪。

常见错误是直接用 $_GET/$_POST 混着收数据,结果 PUT/PATCH 请求体里的 JSON 拿不到——因为 PHP 默认不解析非 application/x-www-form-urlencoded 的请求体。

  • file_get_contents('php://input') 读原始请求体,再 json_decode() 解析 JSON
  • 别依赖 $_POST 处理 PUT/PATCH,它只对表单编码有效
  • 统一用 $_SERVER['REQUEST_METHOD'] 判断动词,别用自定义 _method 参数假装 REST(那不算真 RESTful)
  • 路径建议用简单前缀隔离,比如 /api/v1/users,避免和前端路由冲突

为什么 status code 不能全写 200,哪怕逻辑跑通了

HTTP 状态码是 RESTful 接口的契约一部分。返回 200 成功却实际是创建资源(应该用 201),或者删完返回 200 而不是 204,前端就很难做正确反馈——比如跳转、清缓存、重置表单。

更隐蔽的问题是代理或 CDN 可能缓存 200 响应,但 201/204/404 默认不缓存,影响一致性。

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

  • GET 成功 → 200;无数据 → 204404(看业务语义)
  • POST 创建成功 → 201,并带 Location header 指向新资源地址
  • DELETE 成功 → 204(无响应体);失败 → 404400
  • http_response_code(201) 显式设状态,别只 echo JSON

怎么处理 Content-Type 和 Accept 不匹配的请求

很多 PHP 接口只认 application/json,但客户端可能发 text/plain 或漏传 Content-Type,结果 file_get_contents('php://input') 读到的是 raw 字符串,json_decode() 返回 null 却不报错,接口静默失败。

HaloTool
HaloTool

AI工具在线集合网站

下载

另一个坑是返回时硬写 Content-Type: application/json,但客户端 Accept: application/xml,这就违背了内容协商原则。

  • 检查 $_SERVER['CONTENT_TYPE'] 是否含 application/json,否则直接返回 415 Unsupported Media Type
  • 解析前先 trim() php://input 内容,避免 BOM 或空格导致 json_last_error()JSON_ERROR_SYNTAX
  • 返回前可简单判断 $_SERVER['HTTP_ACCEPT'],但不必真支持多格式——明确文档只支持 JSON,就统一返回 application/json 并忽略 Accept

为什么不要在接口里直接 echo 数组,而要用 json_encode + headers

直接 echo json_encode($data) 看似能用,但缺 header 会导致前端 fetch 的 response.json() 报错(尤其 IE 或某些安卓 WebView),因为 Content-Type 缺失,浏览器当 text/html 解析。

还有个隐形问题:中文字符没设 UTF-8,json_encode() 默认 escape 中文,看着像 \u676e,但其实可以关掉——前提是 header 正确声明编码。

  • 必须加 header('Content-Type: application/json; charset=utf-8')
  • json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) 避免无谓转义
  • 出错时也走同一套输出逻辑:设 500 状态码 + JSON 错误结构,别混用 HTML 或纯文本
  • 别在中间 echo 调试信息,PHP 输出缓冲没关的话,会破坏 JSON 结构

真正难的不是写几个 endpoint,而是所有接口保持一致的状态码语义、错误结构、空值处理和时间格式(比如统一用 ISO 8601)。这些细节不强制约束,团队协作两周后就会出现五种写法。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

2968

2023.09.01

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

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

1769

2023.10.11

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

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

1586

2023.10.11

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

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

1204

2023.10.23

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

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

1646

2023.10.23

html怎么上传
html怎么上传

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

1316

2023.11.03

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

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

1786

2023.11.09

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

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

1334

2023.11.13

Python WebSocket实时通信与异步服务开发实践
Python WebSocket实时通信与异步服务开发实践

本专题聚焦 Python 在实时通信场景中的开发实践,系统讲解 WebSocket 协议原理、长连接管理、消息推送机制以及异步服务架构设计。内容包括客户端与服务端通信实现、连接稳定性优化、消息队列集成及高并发处理策略。通过完整案例,帮助开发者构建高效稳定的实时通信系统,适用于聊天应用、实时数据推送等场景。

7

2026.03.18

热门下载

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

精品课程

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

共137课时 | 13.8万人学习

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

共6课时 | 11.4万人学习

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

共13课时 | 1万人学习

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

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