本文档旨在解决在使用 PHP 的 POST 方法向 REST API 传输包含混合数组和对象的数据时，由于数据结构不匹配导致 API 验证失败的问题。通过对比 Postman 中成功请求的 JSON 结构，分析 PHP 代码生成的数据结构差异，并提供修改方案，确保 PHP 代码能够生成符合 API 要求的 JSON 数据格式。
在使用 PHP 向 REST API 发送数据时，数据格式的正确性至关重要。当 API 需要接收混合了数组和对象的数据结构时，尤其需要仔细检查 PHP 代码生成的数据结构是否与 API 期望的格式完全一致。一个常见的错误是，在构建嵌套数组时，忘记将对象放入数组中，导致 API 验证失败。
以下将通过一个具体示例，说明如何解决此类问题。
假设我们需要向 API 发送以下 JSON 数据：
立即学习“”；
{ "version": 0, "roles": { "customer": {} }, "person": { "firstName": "Inge", "lastName": "Musterfrau" }, "emailAddresses": { "private": [ "test@example.com" ] }, "addresses": { "billing": [ { "supplement": null, "street": "aaa", "zip": "12345", "city": "Berlin", "countryCode": "DE" } ] } }
上述 JSON 数据中，addresses 字段包含一个 billing 字段，billing 字段是一个数组，数组中包含一个对象，该对象包含了账单地址的详细信息。
以下代码展示了可能导致错误的 PHP 代码：
<?php $billingAddress = [ "streetDetails" => 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"], ); $params = [ "version" => 0, "roles" => [], "person" => [], "emailAddresses" => [], "addresses" => [ "billing" => $billingAddr ] ]; echo json_encode($params, JSON_PRETTY_PRINT); ?>
上述代码生成 JSON 如下：
{ "version": 0, "roles": [], "person": [], "emailAddresses": [], "addresses": { "billing": { "supplement": null, "street": "aaa", "zip": "12345", "city": "Berlin", "countryCode": "DE" } } }
可以看到，addresses.billing 字段是一个对象，而不是一个数组。这与 API 期望的格式不符，因此会导致验证失败。
解决方案
要解决这个问题，需要将 $billingAddr 放入一个数组中，如下所示：
<?php $billingAddress = [ "streetDetails" => 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"], ); $params = [ "version" => 0, "roles" => [], "person" => [], "emailAddresses" => [], "addresses" => [ "billing" => [$billingAddr] ] ]; echo json_encode($params, JSON_PRETTY_PRINT); ?>
修改后的代码生成 JSON 如下：
{ "version": 0, "roles": [], "person": [], "emailAddresses": [], "addresses": { "billing": [ { "supplement": null, "street": "aaa", "zip": "12345", "city": "Berlin", "countryCode": "DE" } ] } }
现在，addresses.billing 字段是一个数组，数组中包含一个对象，这与 API 期望的格式一致。
总结
在向 REST API 发送数据时，务必仔细检查 PHP 代码生成的数据结构是否与 API 期望的格式完全一致。特别是在处理混合数组和对象的数据结构时，需要确保对象被正确地放入数组中。可以使用 json_encode 函数将 PHP 数组转换为 JSON 字符串，并使用 JSON_PRETTY_PRINT 选项来格式化 JSON 字符串，以便更方便地查看和调试。通过仔细检查数据结构，可以避免因数据格式不匹配导致的 API 验证失败。
以上就是PHP 使用 POST 方法向 REST API 传输混合数组和对象数据的详细内容，更多请关注php中文网其它相关文章！
微信扫一扫打赏
支付宝扫一扫打赏
