我们的客户端给了我一个REST API,我需要对它进行PHP调用。但事实上,API提供的文档非常有限,所以我真的不知道如何调用该服务。
我试着谷歌它,但唯一出现的是一个已经过期的雅虎!关于如何调用服务的教程。不要提及标题或任何深入的信息。
是否有关于如何调用REST API的适当信息或相关文档?因为即使在w3学校中,它们也只描述SOAP方法。在PHP中创建API的其他选项有哪些?
我们的客户端给了我一个REST API,我需要对它进行PHP调用。但事实上,API提供的文档非常有限,所以我真的不知道如何调用该服务。
我试着谷歌它,但唯一出现的是一个已经过期的雅虎!关于如何调用服务的教程。不要提及标题或任何深入的信息。
是否有关于如何调用REST API的适当信息或相关文档?因为即使在w3学校中,它们也只描述SOAP方法。在PHP中创建API的其他选项有哪些?
当前回答
使用Postman,您可以为大多数语言(包括PHP)生成调用API的代码。以下是步骤:
步骤1
使用Postman UI来指定你的API调用规范,即URL,方法,头,参数,主体等。
步骤2
在最右边,有一个小按钮,您可以通过它查看生成的代码。
步骤3
从下拉菜单中选择您喜欢的语言(和库),然后就可以开始了!
其他回答
如果您正在使用Symfony,有一个很棒的rest客户端包,它甚至包含了所有~100个异常,并抛出它们,而不是返回一些毫无意义的错误代码+消息。
你真的应该检查一下: https://github.com/CircleOfNice/CiRestClientBundle
我喜欢它的界面:
try {
$restClient = new RestClient();
$response = $restClient->get('http://www.someUrl.com');
$statusCode = $response->getStatusCode();
$content = $response->getContent();
} catch(OperationTimedOutException $e) {
// do something
}
适用于所有http方法。
您需要知道所调用的REST API是支持GET还是POST,还是同时支持两种方法。下面的代码对我来说是有用的,我正在调用我自己的web服务API,所以我已经知道API需要什么以及它将返回什么。它同时支持GET和POST方法,因此不太敏感的信息会进入URL (GET),而像用户名和密码这样的信息会作为POST变量提交。此外,所有内容都通过HTTPS连接。
在API代码中,我将一个数组编码为json格式,然后简单地使用PHP命令echo $my_json_variable使json字符串对客户端可用。
如您所见,我的API返回json数据,但您需要知道(或查看返回的数据以找出)API响应的格式。
这是我如何从客户端连接到API:
$processed = FALSE;
$ERROR_MESSAGE = '';
// ************* Call API:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://www.myapi.com/api.php?format=json&action=subscribe&email=" . $email_to_subscribe);
curl_setopt($ch, CURLOPT_POST, 1);// set post data to true
curl_setopt($ch, CURLOPT_POSTFIELDS,"username=myname&password=mypass"); // post data
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$json = curl_exec($ch);
curl_close ($ch);
// returned json string will look like this: {"code":1,"data":"OK"}
// "code" may contain an error code and "data" may contain error string instead of "OK"
$obj = json_decode($json);
if ($obj->{'code'} == '1')
{
$processed = TRUE;
}else{
$ERROR_MESSAGE = $obj->{'data'};
}
...
if (!$processed && $ERROR_MESSAGE != '') {
echo $ERROR_MESSAGE;
}
顺便说一句,我还尝试使用file_get_contents()方法,因为这里的一些用户建议,但这并不适合我。我发现旋度法更快更可靠。
使用Postman,您可以为大多数语言(包括PHP)生成调用API的代码。以下是步骤:
步骤1
使用Postman UI来指定你的API调用规范,即URL,方法,头,参数,主体等。
步骤2
在最右边,有一个小按钮,您可以通过它查看生成的代码。
步骤3
从下拉菜单中选择您喜欢的语言(和库),然后就可以开始了!
如果你有一个url并且你的php支持它,你可以调用file_get_contents:
$response = file_get_contents('http://example.com/path/to/api/call?param1=5');
如果$response是JSON,使用json_decode将其转换为php数组:
$response = json_decode($response);
如果$response是XML,使用simple_xml类:
$response = new SimpleXMLElement($response);
http://sg2.php.net/manual/en/simplexml.examples-basic.php
使用HTTPFUL
Httpful是一个简单的,可链接的,可读的PHP库,旨在使HTTP说话正常。它让开发人员专注于与api的交互,而不是筛选curl set_opt页面,是一个理想的PHP REST客户端。
Httpful包括……
可读HTTP方法支持(GET, PUT, POST, DELETE, HEAD和OPTIONS) 自定义标题 自动“智能”解析 自动负载序列化 基本认证 客户端证书认证 请求“模板”
Ex.
发送一个GET请求。获得自动解析的JSON响应。
库注意到响应中的JSON Content-Type,并自动将响应解析为原生PHP对象。
$uri = "https://www.googleapis.com/freebase/v1/mqlread?query=%7B%22type%22:%22/music/artist%22%2C%22name%22:%22The%20Dead%20Weather%22%2C%22album%22:%5B%5D%7D";
$response = \Httpful\Request::get($uri)->send();
echo 'The Dead Weather has ' . count($response->body->result->album) . " albums.\n";