如何在 PHP cURL 请求中将 OData 发送到 RESTful API

Question

我正在尝试使用 PHP 将 GET 请求中的 OData 参数发送到 RESTful API。对此服务的格式正确的 OData 请求如下所示：

https://myapi.org/endpoint?filter=family_name eq 'Doe'

似乎我应该在发送请求之前将这些变量附加到我的 CURLOPT_URL 的末尾，但是 API 服务似乎没有收到 OData。

$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 100);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('OSDI-API-Token:xxxxxxxxxxxx'));
curl_setopt($ch, CURLOPT_URL, "https://myapi.org/endpoint?filter=family_name eq 'Doe'");
$response = curl_exec($ch);
curl_close($ch);

echo "<pre>";
print_r($response);
echo "</pre>";

输出为 NULL。考虑到具有相同 headers 和相同 Odata URL 的相同请求在 API 的浏览器中搜索并找到正确的数据，这似乎是一个奇怪的响应。

谁能确认这是否是通过 cURL 请求发送 OData 参数的正确方法？

Answer 1

将 OData 参数直接附加到 CURLOPT_URL 不起作用，因为它没有形成有效的 URL。空格和引号需要转义为 family_name%20eq%20%27Doe%27 或 family_name+eq+%27 Doe%27.

一种更简单的方法是在设置 CURLOPT_URL:

之前使用 http_build_query() 将参数附加到 URL

$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 100);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('OSDI-API-Token: xxxxxxxxxx'));
$api_request_parameters = array('filter'=>"family_name eq 'Doe'");
$api_request_url = "https://myapi.org/endpoint";
$api_request_url .= "?".http_build_query($api_request_parameters);
$curl_setopt($ch, CURLOPT_URL, $api_request_url);
$response = curl_exec($ch);
curl_close($ch);

Answer 2

我知道这个问题已经关闭了一段时间，但只是为了用上面的更多点来补充答案，如果要使用 http_build_query ( ), 例如:

$api_request_parameters = array ('$filter' => "family_name eq 'Doe'");
$api_request_url. = "?". http_build_query ($api_request_parameters);

如果您在过滤器中声明时没有使用“$”，过滤器将无法正常工作，并且 return 这将是所有记录，在某些情况下可能会 return 出错。

如果选择不使用http_build_query()则需要对所有空格进行转义，例如假设请求是这样的：

https://myapi.org/endpoint?filter=family_name eq 'Doe test 1234'

参数如下所示：

https://myapi.org/endpoint?filter=family_name+eq+%27Doe%20test%201234%27

如何在 PHP cURL 请求中将 OData 发送到 RESTful API

How to send OData to RESTful API in PHP cURL Request

php

api

curl

odata