PHP如何实现API接口_restful设计规范与状态码返回【技巧】

小晨酱_1024

小晨酱_1024

2026-05-05

879人浏览

原创

restful路由映射需统一入口+服务器重写,用$_server['request_method']和path_info解析路径,正则提取id,严格设状态码与json头。

php如何实现api接口_restful设计规范与状态码返回【技巧】

RESTful 路由怎么映射到 PHP 文件不乱套

PHP 本身没有原生 REST 路由,靠 Web 服务器(如 Nginx/Apache)或框架路由层做路径分发。手动实现时,$_SERVER['REQUEST_METHOD'] 和 $_SERVER['PATH_INFO'] 是唯二可信入口点——别依赖 $_GET['action'] 或类似魔改参数。

常见错误:用同一个 PHP 文件处理所有方法,却没校验 HTTP 方法,导致 POST 请求被当成 GET 执行,或 DELETE 被忽略。

  • 用 switch($_SERVER['REQUEST_METHOD']) 显式分支,未覆盖的方法直接返回 405 Method Not Allowed
  • PATH_INFO 需提前在服务器配置中启用(Nginx 加 fastcgi_split_path_info;Apache 确保 AcceptPathInfo On)
  • 路径解析建议用正则提取资源 ID,例如 /users/123 → preg_match('@^/users/(\d+)$@', $path, $matches),避免字符串截取出错

HTTP 状态码该在哪一层设置才不会被覆盖

PHP 的 http_response_code() 必须在任何输出(包括空格、BOM、echo)之前调用,否则会失效并触发 Warning: Cannot modify header information。很多新手在 JSON 输出前忘了设状态码,结果全是 200 OK,掩盖了真实错误。

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

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

下载
  • 推荐把状态码设置和 JSON 输出封装成一个函数,例如 api_response($data, $status = 200),开头就调用 http_response_code($status)
  • 不要在中间逻辑里多次调用 http_response_code(),容易被后续覆盖;最终响应前只设一次
  • 注意 CLI 模式下 http_response_code() 无效,测试时务必用 curl 或浏览器发起真实 HTTP 请求

Content-Type 和字符编码漏设会导致前端解析失败

只输出 JSON 却不设 Content-Type: application/json; charset=utf-8,某些前端库(如 Axios)会默认按 text/plain 解析,导致 response.data 变成字符串而非对象。

  • 必须在 http_response_code() 后、任何输出前调用 header('Content-Type: application/json; charset=utf-8')
  • 确保 PHP 文件本身是 UTF-8 无 BOM 编码,否则 BOM 字节会挤在 JSON 前面,造成前端解析 SyntaxError
  • 如果用了 json_encode($data, JSON_UNESCAPED_UNICODE),仍需显式声明 charset=utf-8,否则中文可能被浏览器误判为 ISO-8859-1

400/401/403/404/500 这些状态码对应什么业务场景

状态码不是装饰,它直接影响前端重试策略、错误归类和监控告警。比如把数据库连接失败返回 400 Bad Request,前端可能反复重试,而其实该退避或报运维。

  • 400:客户端数据格式错误,如 JSON 解析失败、必填字段缺失、ID 格式非法(非数字)
  • 401:缺失或无效的 Authorization 头(如 Bearer token 过期),不带 WWW-Authenticate 头也行,但语义要准
  • 403:token 有效但权限不足,比如普通用户请求管理员接口
  • 404:资源不存在(如 /users/999999),不是“接口地址写错了”——后者是 404,前者也是 404,但语义一致即可
  • 500:PHP 抛异常、MySQL 连接超时、磁盘满等服务端不可恢复错误;切勿把 file_get_contents() 失败也扔 500,应根据下游服务 SLA 判定是否降级或返回 503

真正难的是边界情况:比如用户提交了超长文本,该 400 还是 413?413 是 “Payload Too Large”,需要服务器明确配置了 client_max_body_size 并由 Web 服务器拦截,PHP 层通常只能捕获到空 $_POST,此时更稳妥返回 400 并提示“内容过长”。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

php 状态码

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

相关专题

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

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

2023.09.01

10884

6

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

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

2023.10.11

6341

5

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

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

2023.10.11

2135

5

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

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

2023.10.23

4008

4

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

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

2023.10.23

4714

6

html怎么上传
html怎么上传

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

2023.11.03

3711

9

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

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

2023.11.09

5297

8

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

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

2023.11.13

4162

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12062

4

热门下载

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

精品课程

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

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

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

共0课时 | 0人学习