0

0

使用 PHP 构建符合 REST API 要求的复杂 JSON 数据

聖光之護

聖光之護

发布时间:2025-08-20 21:00:20

|

924人浏览过

|

来源于php中文网

原创

使用 php 构建符合 rest api 要求的复杂 json 数据

本文档旨在帮助开发者解决在使用 PHP 向 REST API 发送 POST 请求时,构建包含混合数组和对象的复杂 JSON 数据结构的问题。我们将重点关注如何正确格式化数据,特别是嵌套数组和对象,以满足 API 的验证要求。通过示例代码和详细解释,你将学会如何避免常见的"missing_entity - addresses - validation_failure"错误,并成功地将数据发送到 API。

构建符合 API 要求的 JSON 数据

在与 REST API 交互时,确保发送的数据格式与 API 期望的格式完全一致至关重要。尤其是在处理包含混合数组和对象的复杂 JSON 结构时,细微的差异可能导致 API 验证失败。

问题分析

常见的错误是由于对数组和对象的嵌套关系理解不准确造成的。例如,API 可能期望一个包含多个地址对象的数组,但 PHP 代码却构建了一个包含单个地址对象的对象。

解决方案

解决此问题的关键在于仔细检查 API 文档,了解其期望的数据结构。然后,使用 PHP 正确地构建数组和对象,并使用 json_encode() 函数将其转换为 JSON 字符串。

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

示例:地址信息的正确构建方式

假设 API 期望的 JSON 结构如下:

{
  "version": 0,
  "roles": {
    "customer": {
    }
  },
  "person": {
     "firstName": "Inge",
     "lastName": "Musterfrau"
  },
  "emailAddresses" :{
    "private" : [
      "email@example.com"
    ]
  },
"addresses": {
    "billing": [
      {
        "supplement": null,
        "street": "aaa",
        "zip": "12345",
        "city": "Berlin",
        "countryCode": "DE"
      }
    ]
  }        
}

其中,addresses 字段包含一个 billing 字段,而 billing 字段是一个包含地址对象的数组。

Magic CMS 网站管理系统2.2.1.alpha 政企版
Magic CMS 网站管理系统2.2.1.alpha 政企版

Magic CMS网站管理系统(政企版)采用PHP+Mysql架构,再原CMS系统的基础上精简出适合企业政府客户使用版本,继承了原系统的快捷,高效,灵活,实用的特点,保留了核心功能,系统支持自定义模版(极易整合dede模板)、支持扩展插件,自定义模型等功能,保留了文章模型,视频模型,图集模型,产品模型,能够胜任企业多种建站需求。BUG修复:1.修改了程序安装时部分数据无法正常导入的错误2.修改了程

下载

以下是 PHP 中构建此结构的正确方法:

 null,
    "street" => "aaa",
    "zipCode" => "12345",
    "city" => "Berlin",
    "country" => "DE"
];

$billingAddr = array(
    "supplement" => $billingAddress["streetDetails"],
    "street" => $billingAddress["street"],
    "zip" => $billingAddress["zipCode"],
    "city" => $billingAddress["city"],
    "countryCode" => $billingAddress["country"],
);

$roles = null;
$person = null;
$emailAddresses = null;

$params = [
    "version"       => 0,
    "roles"         => $roles,
    "person"        => $person,
    "emailAddresses"  => $emailAddresses,
    "addresses"     => [
        "billing"  => [$billingAddr]
    ]
];

echo json_encode($params, JSON_PRETTY_PRINT);

?>

关键点:

  • $billingAddr 变量包含单个地址对象。
  • "billing" => [$billingAddr] 这行代码将 $billingAddr 对象放入一个数组中。 这是确保 billing 字段包含地址数组的关键。

错误示例:

以下代码会导致 missing_entity - addresses - validation_failure 错误,因为它将 $billingAddr 直接赋值给 billing 字段,而不是将其放入数组中。

$params = [
    "version"       => 0,
    "roles"         => $roles,
    "person"        => $person,
    "emailAddresses"  => $emailAddresses,
    "addresses"     => [
        "billing"  => $billingAddr // 错误:billing 字段应该是一个数组
    ]
];

发送 POST 请求

构建好 JSON 数据后,可以使用 curl 或其他 HTTP 客户端库将其发送到 API。

注意事项:

  • 确保设置 Content-Type header 为 application/json。
  • 检查 API 的响应,以确保请求已成功处理。

总结

正确构建 JSON 数据是成功与 REST API 交互的关键。通过仔细阅读 API 文档,并使用 PHP 正确地构建数组和对象,你可以避免常见的验证错误,并确保数据能够成功发送到 API。 记住,json_encode() 函数可以将 PHP 数组和对象转换为 JSON 字符串,以便通过 HTTP 发送。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

420

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

536

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

curl_exec
curl_exec

curl_exec函数是PHP cURL函数列表中的一种,它的功能是执行一个cURL会话。给大家总结了一下php curl_exec函数的一些用法实例,这个函数应该在初始化一个cURL会话并且全部的选项都被设置后被调用。他的返回值成功时返回TRUE, 或者在失败时返回FALSE。

440

2023.06.14

linux常见下载安装工具
linux常见下载安装工具

linux常见下载安装工具有APT、YUM、DNF、Snapcraft、Flatpak、AppImage、Wget、Curl等。想了解更多linux常见下载安装工具相关内容,可以阅读本专题下面的文章。

178

2023.10.30

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

320

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

212

2023.09.04

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

9

2026.01.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
10分钟--Midjourney创作自己的漫画
10分钟--Midjourney创作自己的漫画

共1课时 | 0.1万人学习

Midjourney 关键词系列整合
Midjourney 关键词系列整合

共13课时 | 0.9万人学习

AI绘画教程
AI绘画教程

共2课时 | 0.2万人学习

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

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