PHP怎么写API接口_RESTful API基础写法介绍【介绍】

大杰姑娘_7000

大杰姑娘_7000

2026-03-31

667人浏览

原创

不用框架也能写restful接口,核心是用$_server['request_method']区分http方法,json_encode()返回数据,并严格设置header('content-type: application/json; charset=utf-8'),任何输出前禁止echo、空白符或错误提示。

php怎么写api接口_restful api基础写法介绍【介绍】

怎么用 PHP 快速写一个可被调用的 RESTful 接口

直接说结论:不用框架也能写,核心是靠 $_SERVER['REQUEST_METHOD'] 区分动作,用 json_encode() 返回数据,再加几行 header 设置。关键不是“多规范”,而是“别让前端拿不到数据”。

常见错误现象:405 Method Not Allowed(没处理对应 HTTP 方法)、500 Internal Server Error(没设 Content-Type 或输出了额外空格)、前端收不到 JSON(header 没写对或用了 echo 混淆)。

  • 必须手动设置 header('Content-Type: application/json; charset=utf-8');,否则浏览器/前端可能当文本解析
  • 所有输出前不能有任何 echo、print、空白符,包括文件末尾的换行
  • 用 file_get_contents('php://input') 读取 POST/PUT 的原始 body,别只依赖 $_POST(它不处理 JSON)
  • 简单接口建议用 switch($_SERVER['REQUEST_METHOD']) 分支,比一堆 if 更清晰

GET 和 POST 请求怎么分别处理才不踩坑

GET 用 $_GET 拿参数没问题,但 POST 就容易错——尤其前端发的是 JSON 格式时,$_POST 是空的,因为 PHP 默认只解析 application/x-www-form-urlencoded 和 multipart/form-data。

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

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

下载
  • GET 接口示例路径:/api/users?id=123 → 直接取 $_GET['id'],记得用 filter_input(INPUT_GET, 'id', FILTER_SANITIZE_NUMBER_INT) 过滤
  • POST 接口若接收 JSON:$raw = file_get_contents('php://input'); → $data = json_decode($raw, true);,再检查 $data !== null
  • 不要在同一个脚本里混用 $_POST 和 php://input,PHP 会因输入流已读完导致后者返回空字符串
  • 如果用 cURL 测试,记得加 -H "Content-Type: application/json",否则服务端可能忽略 body

为什么返回 JSON 时 header 顺序和状态码这么重要

HTTP 状态码不是装饰,前端会根据它做逻辑分支;header 顺序不对,有些客户端(比如旧版 iOS WebView)会直接丢弃响应体。

  • 状态码必须在任何输出之前调用 http_response_code(200) 或 http_response_code(404),不能晚于 header()
  • header() 调用要在 http_response_code() 之后、echo json_encode(...) 之前
  • 常见错误:先 echo 了错误提示,再想补 header → 报 Warning: Cannot modify header information
  • 简单判断是否已输出:用 headers_sent($file, $line) 检查,开发期建议开头就加这句做防护

要不要验证请求来源或加 Token 鉴权

纯内部系统调用可以暂时跳过,但只要接口暴露在公网或含用户数据,不加基础鉴权就是裸奔。

  • 最轻量做法:校验 Authorization header 中的 Bearer Token,用 $_SERVER['HTTP_AUTHORIZATION'] 读取(注意 Apache 下可能要改配置才能透传)
  • 别把密钥硬编码在代码里,用环境变量或配置文件(如 getenv('API_SECRET'))
  • Token 验证失败时,必须返回 401 Unauthorized 并清空 body,不能返回 200 + 错误信息
  • 如果只是临时调试,至少加个简单签名:比如要求请求带 X-Sign: md5(timestamp+secret),服务端比对时间戳是否在 30 秒内

真正难的不是写完一个接口,而是每次改参数、加字段、换状态码时,都得同步更新文档、测试用例和前端调用方式。没人会替你记住那个 user_id 字段其实叫 uid,只在 v2 接口里才改过来。

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

相关专题

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

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

2023.09.01

10704

6

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

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

2023.10.11

6261

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

3651

9

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

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

2023.11.09

5237

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

热门下载

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

精品课程

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

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

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

共0课时 | 0人学习