PHP8如何编写REST接口返回JSON

星枫酱_4496

星枫酱_4496

2026-10-16

415人浏览

原创

php 8 rest接口返回json需设置content-type头、统一响应结构、按http方法处理请求、匹配状态码并校验输入:开头设header('content-type: application/json; charset=utf-8'),封装code/message/data结构,用json_encode($data, json_unescaped_unicode | json_unescaped_slashes),解析php://input并检查json_last_error(),依操作设置201/404/400等状态码。

php8如何编写rest接口返回json

PHP 8 编写 REST 接口返回 JSON,核心是正确设置响应头、规范输出格式,并配合合理的请求处理逻辑。不需要框架也能快速实现,但要注意错误处理、内容类型声明和数据安全性。

设置正确的响应头和 Content-Type

REST 接口必须明确告知客户端返回的是 JSON 数据,否则前端可能解析失败:

  • 用 header('Content-Type: application/json; charset=utf-8'); 声明类型和编码
  • 避免在输出 JSON 前有任何 echo、var_dump 或空白字符(包括文件末尾的换行),否则 JSON 会损坏
  • 推荐在脚本开头就设置 header,防止后续意外输出

统一返回结构,提升接口可维护性

不要直接 echo json_encode($data),应封装标准响应格式,例如:

$response = [
    'code' => 200,
    'message' => 'success',
    'data' => $your_data
];
echo json_encode($response, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
  • JSON_UNESCAPED_UNICODE 防止中文被转成 \uXXXX
  • JSON_UNESCAPED_SLASHES 避免 URL 中的斜杠被转义
  • 建议始终包含 code 和 message 字段,便于前端统一处理

根据 HTTP 方法区分操作逻辑

一个典型资源接口(如 /api/users)需支持不同动词:

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
  • GET:读取列表或单条(通过 ?id=1 判断)
  • POST:创建新资源(用 file_get_contents('php://input') 获取原始 JSON 请求体)
  • PUT/PATCH:更新(同样需解析 input 流)
  • DELETE:删除(通常用 ?id=1 或路径参数)

示例判断方式:

$method = $_SERVER['REQUEST_METHOD'];
if ($method === 'POST') {
    $raw = file_get_contents('php://input');
    $input = json_decode($raw, true);
    if (json_last_error() !== JSON_ERROR_NONE) {
        http_response_code(400);
        echo json_encode(['code'=>400, 'message'=>'Invalid JSON']);
        exit;
    }
}

处理错误与状态码要严格对应

HTTP 状态码是 REST 的重要约定,不能全用 200:

  • 成功创建:用 http_response_code(201)
  • 资源未找到:用 http_response_code(404),并返回相应 message
  • 参数缺失或校验失败:用 400
  • 权限不足:用 403
  • 服务端异常:用 500,同时记录日志,不暴露敏感信息给前端

注意:调用 http_response_code() 必须在任何输出之前,否则无效。

不复杂但容易忽略细节,把 header、状态码、JSON 选项和输入解析四点对齐,就能写出符合规范的 PHP 8 REST 接口。

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

10744

6

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

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

2023.10.11

6281

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

3968

4

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

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

2023.10.23

4674

6

html怎么上传
html怎么上传

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

2023.11.03

3671

9

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

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

2023.11.09

5257

8

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

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

2023.11.13

4102

8

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

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

2023.11.27

12042

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
《20天入门精通PHP》视频教程
《20天入门精通PHP》视频教程

共200课时 | 48.6万人学习

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

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习