restfule 接口
适用的平台:跨平台
所依赖:curl扩展
git:https://git.oschina.net/anziguoer/restapi
apiserver.php
<?php
/**
* @author: yangyulong
* @email : anziguoer@sina.com
* @date: 2015-04-30 05:38:34
* @last modified by: yangyulong
* @last modified time: 2015-04-30 17:14:11
*/
class apiserver
{
/**
* 客户端请求的方式
* @var string
*/
private $method = '';
/**
* 客户端发送的数据
* @var [type]
*/
protected $param;
/**
* 要操作的资源
* @var [type]
*/
protected $resourse;
/**
* 要操作的资源id
* @var [type]
*/
protected $resourseid;
/**
* 构造函数, 获取client 请求的方式,以及传输的数据
* @param object 可以自定义传入的对象
*/
public function __construct()
{
//首先对客户端的请求进行验证
$this->authorization();
$this->method = strtolower($_server['request_method']);
//所有的请求都是pathinfo模式
$pathinfo = $_server['path_info'];
//将pathinfo数据信息映射为实际请求方法
$this->getresourse($pathinfo);
//获取传输的具体参数
$this->getdata();
//执行响应
$this->doresponse();
}
/**
* 根据不同的请求方式,获取数据
* @return [type]
*/
private function doresponse(){
switch ($this->method) {
case 'get':
$this->_get();
break;
case 'post':
$this->_post();
break;
case 'delete':
$this->_delete();
break;
case 'put':
$this->_put();
break;
default:
$this->_get();
break;
}
}
// 将pathinfo数据信息映射为实际请求方法
private function getresourse($pathinfo){
/**
* 将pathinfo数据信息映射为实际请求方法
* get /users: 逐页列出所有用户;
* post /users: 创建一个新用户;
* get /users/123: 返回用户为123的详细信息;
* put /users/123: 更新用户123;
* delete /users/123: 删除用户123;
*
* 根据以上规则,将pathinfo第一个参数映射为需要操作的数据表,
* 第二个参数映射为操作的id
*/
$info = explode('/', ltrim($pathinfo, '/'));
list($this->resourse, $this->resourseid) = $info;
}
/**
* 验证请求
*/
private function authorization(){
$token = $_server['http_client_token'];
$authorization = md5(substr(md5($token), 8, 24).$token);
if($authorization != $_server['http_client_code']){
//验证失败,输出错误信息给客户端
$this->output($status = 1);
}
}
/**
* [getdata 获取传送的参数信息]
* @param [type] $pad [description]
* @return [type] [description]
*/
private function getdata(){
//所有的参数都是get传参
$this->param = $_get;
}
/**
* 获取资源操作
* @return [type] [description]
*/
protected function _get(){
//逻辑代码根据自己实际项目需要实现
}
/**
* 新增资源操作
* @return [type] [description]
*/
protected function _post(){
//逻辑代码根据自己实际项目需要实现
}
/**
* 删除资源操作
* @return [type] [description]
*/
protected function _delete(){
//逻辑代码根据自己实际项目需要实现
}
/**
* 更新资源操作
* @return [type] [description]
*/
protected function _put(){
//逻辑代码根据自己实际项目需要实现
}
/**
* 出入服务端返回的数据信息 json格式
*/
public function output($stat, $data=array()){
$status = array(
//0 状态表示请求成功
0 => array(
'code' => 1,
'info' => '请求成功',
'data' =>$data
),
//验证失败
1 => array(
'code' => 0,
'info' => '请求不合法'
)
);
try{
if(!in_array($stat, array_keys($status))){
throw new exception('输入的状态码不合法');
}else{
echo json_encode($status[$stat]);
}
}catch (exception $e){
die($e->getmessage());
}
}
}
apiclient.php
<?php
/**
* created by phpstorm.
* user: anziguoer@sina.com
* date: 2015/4/29
* time: 12:36
* link: http://www.ruanyifeng.com/blog/2014/05/restful_api.html [restful设计指南]
*/
/*** * * * * * * * * * * * * * * * * * * * * * * * * * ***\
* 定义路由的请求方式 *
* *
* $url_model=0 *
* 采用传统的url参数模式 *
* http://servername/appname/?m=module&a=action&id=1 *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* pathinfo模式(默认模式) *
* 设置url_model 为1 *
* http://servername/appname/module/action/id/1/ *
** * * * * * * * * * * * * * * * * * * * * * * * * * * **
*/
class restclient
{
//请求的token
const token='yangyulong';
//请求url
private $url;
//请求的类型
private $requesttype;
//请求的数据
private $data;
//curl实例
private $curl;
public $status;
private $headers = array();
/**
* [__construct 构造方法, 初始化数据]
* @param [type] $url 请求的服务器地址
* @param [type] $requesttype 发送请求的方法
* @param [type] $data 发送的数据
* @param integer $url_model 路由请求方式
*/
public function __construct($url, $data = array(), $requesttype = 'get') {
//url是必须要传的,并且是符合pathinfo模式的路径
if (!$url) {
return false;
}
$this->requesttype = strtolower($requesttype);
$paramurl = '';
// pathinfo模式
if (!empty($data)) {
foreach ($data as $key => $value) {
$paramurl.= $key . '=' . $value.'&';
}
$url = $url .'?'. $paramurl;
}
//初始化类中的数据
$this->url = $url;
$this->data = $data;
try{
if(!$this->curl = curl_init()){
throw new exception('curl初始化错误:');
};
}catch (exception $e){
echo '<pre>';
print_r($e->getmessage());
echo '</pre>';
}
curl_setopt($this->curl, curlopt_url, $this->url);
curl_setopt($this->curl, curlopt_returntransfer, 1);
}
/**
* [_post 设置get请求的参数]
* @return [type] [description]
*/
public function _get() {
}
/**
* [_post 设置post请求的参数]
* post 新增资源
* @return [type] [description]
*/
public function _post() {
curl_setopt($this->curl, curlopt_post, 1);
curl_setopt($this->curl, curlopt_postfields, $this->data);
}
/**
* [_put 设置put请求]
* put 更新资源
* @return [type] [description]
*/
public function _put() {
curl_setopt($this->curl, curlopt_customrequest, 'put');
}
/**
* [_delete 删除资源]
* delete 删除资源
* @return [type] [description]
*/
public function _delete() {
curl_setopt($this->curl, curlopt_customrequest, 'delete');
}
/**
* [dorequest 执行发送请求]
* @return [type] [description]
*/
public function dorequest() {
//发送给服务端验证信息
if((null !== self::token) && self::token){
$this->headers = array(
'client_token: '.self::token,
'client_code: '.$this->setauthorization()
);
}
//发送头部信息
$this->setheader();
//发送请求方式
switch ($this->requesttype) {
case 'post':
$this->_post();
break;
case 'put':
$this->_put();
break;
case 'delete':
$this->_delete();
break;
default:
curl_setopt($this->curl, curlopt_httpget, true);
break;
}
//执行curl请求
$info = curl_exec($this->curl);
//获取curl执行状态信息
$this->status = $this->getinfo();
return $info;
}
/**
* 设置发送的头部信息
*/
private function setheader(){
curl_setopt($this->curl, curlopt_httpheader, $this->headers);
}
/**
* 生成授权码
* @return string 授权码
*/
private function setauthorization(){
$authorization = md5(substr(md5(self::token), 8, 24).self::token);
return $authorization;
}
/**
* 获取curl中的状态信息
*/
public function getinfo(){
return curl_getinfo($this->curl);
}
/**
* 关闭curl连接
*/
public function __destruct(){
curl_close($this->curl);
}
}
testclient.php
<?php
/**
* created by phpstorm.
* user: anziguoer@sina.com
* date: 2015/4/29
* time: 12:35
*/
include './apiclient.php';
$arr = array(
'user' => 'anziguoer',
'passwd' => 'yangyulong'
);
// $url = 'http://localhost/restapi/restserver.php';
$url = 'http://localhost/restapi/testserver.php/user/123';
$rest = new restclient($url, $arr, 'get');
$info = $rest->dorequest();
//获取curl中的状态信息
$status = $rest->status;
echo '<pre>';
print_r($info);
echo '</pre>';
testserver.php
<?php
/**
* @author: anziguoer@sina.com
* @email: anziguoer@sina.com
* @link: https://git.oschina.net/anziguoer
* @date: 2015-04-30 16:52:53
* @last modified by: yangyulong
* @last modified time: 2015-04-30 17:26:37
*/
include './apiserver.php';
class testserver extends apiserver
{
/**
* 先执行apiserver中的方法,初始化数据
* @param object $obj 可以传入的全局对象[数据库对象,框架全局对象等]
*/
private $obj;
function __construct()//object $obj
{
parent::__construct();
//$this->obj = $obj;
//$this->resourse; 父类中已经实现,此类中可以直接使用
//$tihs->resourseid; 父类中已经实现,此类中可以直接使用
}
/**
* 获取资源操作
* @return [type] [description]
*/
protected function _get(){
echo get;
//逻辑代码根据自己实际项目需要实现
}
/**
* 新增资源操作
* @return [type] [description]
*/
protected function _post(){
echo post;
//逻辑代码根据自己实际项目需要实现
}
/**
* 删除资源操作
* @return [type] [description]
*/
protected function _delete(){
//逻辑代码根据自己实际项目需要实现
}
/**
* 更新资源操作
* @return [type] [description]
*/
protected function _put(){
echo put;
//逻辑代码根据自己实际项目需要实现
}
}
$server = new testserver();
更多php基于curl扩展制作跨平台的restfule 接口。