文档章节

用PHP创建一个REST APi

anziguoer
 anziguoer
发布于 2014/09/25 16:45
字数 5027
阅读 6449
收藏 22

认真的讲,假如你从来没有使用过REST,却曾经使用过SOAP API,或者只是简单的打开一个令人头大的WSDL文档。小伙子,我确实要带给你一个好消息! 

 

那么,究竟什么是REST?为什么你应该关心? 

在我们开始写代码之前,我想要确认每个人都可以很好的理解什么是REST以及它是如何特别适合APIs的。首先,从技术上来讲,REST并不是仅仅特定于APIs应用,它更多的是一个通用的概念。然而,很明显,我们这篇文章所讨论的REST就是在接口应用的环境下。因此,让我们看看一个API的基本要求已经REST如何处理他们。 

Requests 请求 

所有的APIs都需要接收请求。对于一个RESTful API,你需要一个定义好的URL规则,我们假定你想要提供一个接口给你网站上的用户(我知道,我总是使用"用户"这个概念来举例)。你的URL结构可能类似于这样:"api/users"或者"api/users/[id]",这取决于请求接口的操作类型。同时,你也需要考虑你想要怎么样接收数据。近来一段时间,很多人正在使用JSON或者XML,从我个人来讲,我更加喜欢JSON,因为它可以很好的和javascript进行交互操作,同时PHP也可以很简单的通过json_encode和json_decode两个函数来对它进行编码和解码。如果你希望自己的接口真正强健,你应该通过识别请求的内容类型(比如application/json或者application/xml)同时允许接收两种格式。但是,限制只接收一种类型的数据也是可以很好的被接受。真见鬼,假如你愿意,你甚至可以使用简单的键/值对。 

一个请求的其他部分是它真正要做的事情,比如加载、保存等。通常来说,你应该提供几种结构来定义请求者(消费者)所希望的操作,但是REST简化了这些。通过使用HTTP请求方法或者动作,我们不需要去额外定义任何东西。我们可以仅仅使用GET,POST,PUT和DELETE方法,这些方法涵盖了我们所需要的每一个请求。你可以把它和标准的增删改查模式对应起来:GET=加载/检索(查,select),POST=创建(增,Create),PUT=更新(改,update),DELETE=删除(DELETE)。我们要注意到,这些动词并没有直接翻译成CRUD(增删改查),但是这个理解它们的一个很好的方法。因此,回到刚才所举的URL的例子,让我们看一下一些可能的请求的含义: 

    GET request to /api/users – 列举出所有的用户 

    GET request to /api/users/1 – 列出ID为1的用户信息 

    POST request to /api/users – 插入一个新的用户 

    PUT request to /api/users/1 – 更新ID为1的用户信息 

    DELETE request to /api/users/1 – 删除ID为1的用户 

正如你所希望看到的,REST已经解决了很多令人头疼的创建接口的问题,通过一些简单的,容易理解的标准和协议。但是一个好的接口还要另外一个方面... 

Responses 响应 

所以,REST可以很简单的处理请求,同时它也可以简单的处理响应。和请求类似,一个RESTful的响应主要包括两个主要部分:响应体和状态码。响应体非常容易去处理。就像请求,大部分的REST响应通常是JSON或者XML格式(也许对POST操作来说仅仅是纯文本,我们稍后会讨论),和请求类似,消费者可以通过设置HTTP规范的"Accept"选项来规定自己做希望接收到的响应数据类型。如果一个消费者希望接收到XML响应,他们仅仅需要发送一个包含类似于(”Accept: application/xml”)这样的头信息请求。不可否认,这种方式并没有被广泛的采用(即使应该这样),因此你也可以使用URL后缀的形式,例如:/api/users.xml意味着消费者希望得到XML响应,同样,/api/users.json意味着JSON格式的响应(/api/users/1.json/xml也是一样)。不管你采用哪一种方法,你都需要设定一个默认的响应类型,因为很多时候人们并不会告诉你他们希望什么格式。再次地,我会选择JSON来讨论。所以,没有Accept头信息或者扩展(例如:/api/users)不应该失败,而是采用默认的响应类型。 

但是和请求有关的错误和其他重要的状态信息怎么办呢?简单,使用HTTP的状态码!这是我创建RESTful接口最喜欢的事情之一。通过使用HTTP状态码,你不需要为你的接口想出error/success规则,它已经为你做好。比如:假如一个消费者提交数据(POST)到/api/users,你需要返回一个成功创建的消息,此时你可以简单的发送一个201状态码(201=Created)。如果失败了,服务器端失败就发送一个500(500=内部服务器错误),如果请求中断就发送一个400(400=错误请求)。也许他们会尝试向一个不接受POST请求的接口提交数据,你就可以发送一个501错误(未执行)。又或者你的MySQL服务器挂了,接口也会临时性的中断,发送一个503错误(服务不可用)。幸运的是,你已经知道了这些,假如你想要了解更多关于状态码的资料,可以在维基百科上查找:List of HTTP Status Codes。 

我希望你能看到REST接口的这些优点。它真的超级酷。在PHP社区社区里没有被广泛的讨论真是非常的遗憾(至少我知道的是这样)。我觉得这主要是由于没有很好的文档介绍如何处理除了GET和POST之后的请求,即PUT和DELETE。不可否认,处理这些是有点傻,但是却不难。我相信一些流行的框架也许已经有了某种REST的实现方式,但是我不是一个框架粉丝(原因有很多),并且即使有人已经为你提供了解决方案,你知道这些也是非常有好处的。 

如果你还是不太自信这是一个非常有用的API范式,看一下REST已经为Ruby on Rails做了什么。其中最令人称道的就是创建接口的便利性(通过某种RoR voodoo,我确信),而且确实如此。虽然我对RoR了解很少,但是办公室的Ruby粉丝们向我说教过很多次。不好意思跑题了,让我们开始写代码。 

 

Getting Started with REST and PHP 开始使用PHP写REST 

最后一项免责声明:我们接下来提供的代码并不能被用来作为一个稳健的解决方案。我的主要目的是向大家展示如果使用PHP处理REST的每个单独部分,而把最后的解决方案留给你们自己去创建。 

那么,让我们开始深入代码。我认为做一个实际事情做好的方法就是新建一个class,这个class将提供创建REST API所需要的所有功能性方法。现在我们新建一个小的class来存储我们的数据。你可以把它拿去扩展一下然后应用到自己的需求中。我们现在开始写点东西: 

 

Php代码  收藏代码

class RestUtils  

{  

    public static function processRequest(){  

      }  

      public static function sendResponse($status = 200, $body = '', $content_type = 'text/html'){  

      }  

      public static function getStatusCodeMessage($status){  

        // these could be stored in a .ini file and loaded  

        // via parse_ini_file()... however, this will suffice  

        // for an example  

        // 这些应该被存储在一个.ini的文件中,然后通过parse_ini_file()函数来解析出来,然而这样也足够了,比如:  

        $codes = Array(  

            100 => 'Continue',  

            101 => 'Switching Protocols',  

            200 => 'OK',  

            201 => 'Created',  

            202 => 'Accepted',  

            203 => 'Non-Authoritative Information',  

            204 => 'No Content',  

            205 => 'Reset Content',  

            206 => 'Partial Content',  

            300 => 'Multiple Choices',  

            301 => 'Moved Permanently',  

            302 => 'Found',  

            303 => 'See Other',  

            304 => 'Not Modified',  

            305 => 'Use Proxy',  

            306 => '(Unused)',  

            307 => 'Temporary Redirect',  

            400 => 'Bad Request',  

            401 => 'Unauthorized',  

            402 => 'Payment Required',  

            403 => 'Forbidden',  

            404 => 'Not Found',  

            405 => 'Method Not Allowed',  

            406 => 'Not Acceptable',  

            407 => 'Proxy Authentication Required',  

            408 => 'Request Timeout',  

            409 => 'Conflict',  

            410 => 'Gone',  

            411 => 'Length Required',  

            412 => 'Precondition Failed',  

            413 => 'Request Entity Too Large',  

            414 => 'Request-URI Too Long',  

            415 => 'Unsupported Media Type',  

            416 => 'Requested Range Not Satisfiable',  

            417 => 'Expectation Failed',  

            500 => 'Internal Server Error',  

            501 => 'Not Implemented',  

            502 => 'Bad Gateway',  

            503 => 'Service Unavailable',  

            504 => 'Gateway Timeout',  

            505 => 'HTTP Version Not Supported'  

        );  

  

        return (isset($codes[$status])) ? $codes[$status] : '';  

    }  

}  

  

class RestRequest  

{  

    private $request_vars;  

    private $data;  

    private $http_accept;  

    private $method;  

  

    public function __construct(){  

        $this->request_vars      = array();  

        $this->data              = '';  

        $this->http_accept       = (strpos($_SERVER['HTTP_ACCEPT'], 'json')) ? 'json' : 'xml';  

        $this->method            = 'get';  

    }  

  

    public function setData($data){  

        $this->data = $data;  

    }  

  

    public function setMethod($method){  

        $this->method = $method;  

    }  

  

    public function setRequestVars($request_vars){  

        $this->request_vars = $request_vars;  

    }  

  

    public function getData(){  

        return $this->data;  

    }  

  public function getMethod(){  

        return $this->method;  

    }  

  

    public function getHttpAccept(){  

        return $this->http_accept;  

    }  

  

    public function getRequestVars(){  

        return $this->request_vars;  

    }  

}  

好,现在我们有了一个简单的class来存储request的一些信息(RestRequest),和一个提供几个静态方法的class来处理请求和响应。就像你能看到的,我们还有两个方法要去写,这才是整个代码的关键所在,让我们继续... 

处理请求的过程非常直接,但是这才是我们可以有所收获的地方(即PUT/DELETE,大多数是PUT),我们接下来将会讨论这些。但是让我们先来检查一下RestRequest这个class,在构造方法中,你会看到我们已经处理了HTTP_ACCEPT的头信息,并且将JSON作为默认值。这样,我们就只需要处理传入的数据。 

我们有几个方法可以选择,但是让我们假设在请求信息的总是可以接收到键/值对:'data'=>真实数据。同时假设真实数据是JSON格式的。正如我前文所述,你可以根据请求的内容类型来处理JSON或者XML,但是让我们现在简单一点。那么,我们处理请求的方法将会类似于这样: 

 

Php代码  收藏代码

public static function processRequest(){  

    // get our verb 获取动作  

    $request_method = strtolower($_SERVER['REQUEST_METHOD']);  

    $return_obj     = new RestRequest();  

    // we'll store our data here 在这里存储请求数据  

    $data           = array();  

  

    switch ($request_method){  

        // gets are easy...  

        case 'get':  

            $data = $_GET;  

            break;  

        // so are posts  

        case 'post':  

            $data = $_POST;  

            break;  

        // here's the tricky bit...  

        case 'put':  

            // basically, we read a string from PHP's special input location,  

            // and then parse it out into an array via parse_str... per the PHP docs:  

            // Parses str  as if it were the query string passed via a URL and sets  

            // variables in the current scope.  

            parse_str(file_get_contents('php://input'), $put_vars);  

            $data = $put_vars;  

            break;  

    }  

    // store the method  

    $return_obj->setMethod($request_method);  

  

    // set the raw data, so we can access it if needed (there may be  

    // other pieces to your requests)  

    $return_obj->setRequestVars($data);  

  

    if(isset($data['data'])){  

        // translate the JSON to an Object for use however you want  

        $return_obj->setData(json_decode($data['data']));  

    }  

    return $return_obj;  

}  

Lie I said, pretty straight-forward. However, a few things to note… First, you typically don’t accept data for DELETE requests, so we don’t have a case for them in the switch. Second, you’ll notice that we store both the request variables, and the parsed JSON data. This is useful as you may have other stuff as a part of your request (say an API key or something) that isn’t truly the data itself (like a new user’s name, email, etc.). 

正如我刚才所说的,非常的简单直接高效。然后,有几点需要注意:首先,我们不接受DELETE请求,因此我们在switch中不提供相应的case条件。其次,你会注意到我们把请求参数和解析后的JSON数据都存储起来了,这在请求中有其他需要处理的数据时会变得非常有用(API key或者其他),这些并不是请求的数据本身(比如一个新用户的名字、电子邮箱等)。 

那么,我们如何使用它呢?让我们回到刚才user的例子。假设你已经通过路由把请求对应到正确的users控制器,代码如下: 

Php代码  收藏代码

$data = RestUtils::processRequest();  

  

switch($data->getMethod){  

    case 'get':  

        // retrieve a list of users  

        break;  

    case 'post':  

        $user = new User();  

        $user->setFirstName($data->getData()->first_name);  // just for example, this should be done cleaner  

        // and so on...  

        $user->save();  

        break;  

    // etc, etc, etc...  

}  

请不要在真实的应用中这样做,这是一个非常快速和不干净的示例。你应该使用一个设计良好的控制结构来把它包裹起来,适当的抽象化,但是这样有助于你理解如何使用这些东西。让我们继续代码,发送一个响应信息。 

既然我们已经可以解析请求,那么接下来我们继续来发送一个响应。我们已经知道我们真正需要去做的是发送一个正确的状态码和一些响应消息体(例如这是一个GET请求),但是对于没有消息体的响应来说有一个重要的catch(译者:不好意思,实在是不知道如何翻译这个词)。假定某个人向我们的user接口发送一个请求某个用户信息的请求,而这个用户却不存在(比如:api/user/123),此时系统发送最合适的状态码是404。但是简单的在头信息中发送状态码是不够的,如果你通过网页浏览器浏览该页面,你会看到一个空白页面。这是因为apache服务器(或者其他服务器)并不会发送此状态码,因此没有状态页面。我们需要在构建方法的时候考虑到这一点。把所有的东西都考虑进去,代码会类似于下面这样: 

public static function sendResponse($status = 200, $body = '', $content_type = 'text/html'){  

    $status_header = 'HTTP/1.1 ' . $status . ' ' . RestUtils::getStatusCodeMessage($status);  

    // set the status  

    header($status_header);  

    // set the content type  

    header('Content-type: ' . $content_type);  

    // pages with body are easy  

    if($body != ''){  

        // send the body  

        echo $body;  

        exit;  

    }  

    // we need to create the body if none is passed  

    else  

    {  

        // create some body messages  

        $message = '';  

  

        // this is purely optional, but makes the pages a little nicer to read  

        // for your users.  Since you won't likely send a lot of different status codes,  

        // this also shouldn't be too ponderous to maintain  

        switch($status) {  

            case 401:  

                $message = 'You must be authorized to view this page.';  

                break;  

            case 404:  

                $message = 'The requested URL ' . $_SERVER['REQUEST_URI'] . ' was not found.';  

                break;  

            case 500:  

                $message = 'The server encountered an error processing your request.';  

                break;  

            case 501:  

                $message = 'The requested method is not implemented.';  

                break;  

        }  

     // servers don't always have a signature turned on (this is an apache directive "ServerSignature On")  

        $signature = ($_SERVER['SERVER_SIGNATURE'] == '') ? $_SERVER['SERVER_SOFTWARE'] . ' Server at ' . $_SERVER['SERVER_NAME'] . ' Port ' . $_SERVER['SERVER_PORT'] : $_SERVER['SERVER_SIGNATURE'];  

  

        // this should be templatized in a real-world solution  

       

    }  

}  

就这样,从技术上来说,我们已经具备了处理请求和发送响应的所有东西。下面我们再讨论以下为什么我们需要一个标准的相应提或者一个自定义的。对于GET请求来说,非常明显,我们需要发送XML/JSON内容而不是一个状态页(假设请求是合法的)。然后,我们还有POST请求要去处理。在你的应用内部,当你创建一个新的实体,你也许需要使用通过类似于mysql_insert_id()这样的函数得到这个实体的ID。那么,当一个用户提交到你的接口,他们将很可能想要知道这个新的ID是什么。在这种情况下,我通常的做法是非常简单的把这个新ID作为响应的消息体发送给用户(同时发送一个201的状态码头信息),但是如果你愿意,你也可以使用XML或者JSON来把它包裹起来。 

现在,让我们来扩展一下我们的例子,让它更加实际一点: 

switch($data->getMethod){  

    // this is a request for all users, not one in particular  

    case 'get':  

        $user_list = getUserList(); // assume this returns an array  

  

        if($data->getHttpAccept == 'json'){  

            RestUtils::sendResponse(200, json_encode($user_list), 'application/json');  

        }else if ($data->getHttpAccept == 'xml') {  

            // using the XML_SERIALIZER Pear Package  

            $options = array  

            (  

                'indent' => '     ',  

                'addDecl' => false,  

                'rootName' => $fc->getAction(),  

                XML_SERIALIZER_OPTION_RETURN_RESULT => true  

            );  

            $serializer = new XML_Serializer($options);  

  

            RestUtils::sendResponse(200, $serializer->serialize($user_list), 'application/xml');  

        }  

      break;  

    // new user create  

    case 'post':  

        $user = new User();  

        $user->setFirstName($data->getData()->first_name);  // just for example, this should be done cleaner  

        // and so on...  

        $user->save();  

  

        // just send the new ID as the body  

        RestUtils::sendResponse(201, $user->getId());  

        break;  

}  

再一次说明,这是一个例子,但它确实向我们展示了(至少我认为是)它能轻而易举的实现RESTful接口。 

所以,这就是它。我非常的自信的说,我已经把这些解释的非常清楚。因此,我就不再赘述你如何具体实现它。 

在一个真实的MVC应用中,也许你想要做的就是为你的每个接口创建一个单独的控制器。例如,利用上面的东西,我们可以创建一个UserRestController控制器,这个控制器有四个方法,分别为:get(), put(), post(), 和 delete()。接口控制器将会查看请求类型然后决定哪个方法会被执行。这个方法会再使用工具来处理请求,处理数据,然后使用工具发送响应。 

你也许会比现在更进一步,把你的接口控制器和数据模型抽象出来,而不是明确的为每一个数据模型创建控制器,你可以给你的接口控制器添加一些逻辑,先去查找一个明确定义好的控制器,如果没有,试着去查找一个已经存在的模型。例如:网址"api/user/1"将会首先触发查找一个叫user的最终控制器,如果没有,它会查找应用中叫user的模型,如果找到了,你可以写一个自动化的方法来自动处理所有请求这个模型的请求。 

再进一步,你可以建立一个通用的"list-all"方法,就像上面一段中的例子一样。假定你的url是"api/usrs",接口控制器首先会查找叫users的控制器,如果没有找到,确认users是复数,把它变成单数,然后查找一个叫user的模型,如果找到了,加载一个用户列表然后把他们发送出去。 

最后,你可以给你的接口添加简单的身份验证。假定你仅仅希望适当的验证访问你的接口的用户,那么,你可以在处理请求的方法中添加类似于下面的一些代码(借用我的一个现有应用,因此有一些常量和变量在这个代码片段里面并没有被定义): 

Php代码  收藏代码

// figure out if we need to challenge the user  

if(emptyempty($_SERVER['PHP_AUTH_DIGEST']))  

{  

    header('HTTP/1.1 401 Unauthorized');  

    header('WWW-Authenticate: Digest realm="' . AUTH_REALM . '",qop="auth",nonce="' . uniqid() . '",opaque="' . md5(AUTH_REALM) . '"');  

  

    // show the error if they hit cancel  

    die(RestControllerLib::error(401, true));  

}  

  

// now, analayze the PHP_AUTH_DIGEST var  

if(!($data = http_digest_parse($_SERVER['PHP_AUTH_DIGEST'])) || $auth_username != $data['username'])  

{  

    // show the error due to bad auth  

    die(RestUtils::sendResponse(401));  

}  

 // so far, everything's good, let's now check the response a bit more...  

$A1 = md5($data['username'] . ':' . AUTH_REALM . ':' . $auth_pass);  

$A2 = md5($_SERVER['REQUEST_METHOD'] . ':' . $data['uri']);  

$valid_response = md5($A1 . ':' . $data['nonce'] . ':' . $data['nc'] . ':' . $data['cnonce'] . ':' . $data['qop'] . ':' . $A2);  

 

// last check..  

if($data['response'] != $valid_response)  

{  

    die(RestUtils::sendResponse(401));  

}  

非常酷,对吧?通过少量的代码和一些智能的逻辑,你可以非常快速的给你的应用添加全功能的REST接口。我并不仅仅是支持这个概念,我已经在我个人的框架里面实现了这些东西,而这些仅仅花费了半天的时间,然后再花费半天时间添加一些非常酷的东西。如果你(读者)对我最终的实现感兴趣,请在评论中留言,我会非常乐趣和你分享它。同时,如果你有什么比较酷的想法,也欢迎通过评论和我进行分享。如果我足够喜欢它,我会邀请你在这里发表自己的文章。 

http://git.oschina.net/anziguoer/restAPI

 

本文转载自:fm126.xyz

anziguoer

anziguoer

粉丝 29
博文 82
码字总数 40050
作品 0
海淀
程序员
私信 提问
加载中

评论(4)

anziguoer
anziguoer

引用来自“韩延庆”的评论

博主,最近正在尝试这方面的想法,有没有demo可供参考一下,就是结合前端调用和接口响应的。我平日用的soap居多,感觉rest不错想尝试一下。谢谢~
http://git.oschina.net/anziguoer/restAPI
anziguoer
anziguoer

引用来自“凤凰涅槃199202”的评论

博主,能分享给我一份吗?多谢!0
http://git.oschina.net/anziguoer/restAPI
凤凰涅槃199202
凤凰涅槃199202
博主,能分享给我一份吗?多谢!0
韩延庆
韩延庆
博主,最近正在尝试这方面的想法,有没有demo可供参考一下,就是结合前端调用和接口响应的。我平日用的soap居多,感觉rest不错想尝试一下。谢谢~
PHP数组去重/高德地图API

数组去重 $term = array_column ( $grade , 'term' ); $term =arrayflip(arrayflip($term)); printr($term); 效果: 原理: arrayflip(): 函数返回一个反转后的数组,如果同一值出现了多次,......

wsy5344
2015/09/18
429
0
基于 Spring + Dubbo 开发分布式REST服务实战

本课程主要是使用 Spring技术栈 + dubbo 开发一个类似当当的图书电商后台的实战教程。 课程特点: 1.课程的技术体系足够系统、全面以及细致:课程中涉及的主要技术包括: Spring IO (依赖版本...

登录404
2017/05/17
1K
3
[服务端]【记录】.htaccess科技配置简单的REST API的访问风格

最近捣鼓php做服务端,并且配置一些接口。(本来想用javaweb servlet那一套配置个过滤规则神马的也就了事,为了将接口放在云虚拟主机上,一想到只能ftp上传文件到www或者htdocs。。。注定与j...

FRED丶DON
2016/01/06
86
0
RestAPI设计疑问

平台:java 1. 对于RestApi 设计时是否需要把model(实体类)暴露给使用方 业界一般怎么做的 如果不暴露 仅仅依靠契约 那么提供方每一次修改 对于使用方来说岂不是要了命 而且使用方八成也会...

ZeRur_
2016/09/17
266
2
调用rest api

想调用友盟的rest api接口来注册用户,但是按照给出的url总是出现404错误 他给出的接口文档如下: RestApi域名:opentest.rest.api.wsq.umeng.com,HTTPS。 AppKey 参数:ak是访问微社区 Re...

白菜小码农
2016/01/23
447
0

没有更多内容

加载失败,请刷新页面

加载更多

我为什么要写微信公众号

埋一颗种子,细心呵护,静待她枝繁叶茂,葱郁参天 V2论坛上有个帖子【做程序员最重要的还是一定要有自己的作品】,作者写道: 能有一个作品和你的名字联系在一起,应当成为在职业生涯前期着意...

运维咖啡吧
54分钟前
3
0
数据库

数据库架构 数据库架构可以分为存储文件系统和程序实例两大块,而程序实例根据不同的功能又可以分为如下小模块。 1550644570798 索引模块 常见的问题有: 为什么要使用索引 什么样的信息能成...

一只小青蛙
今天
5
0
PHP常用经典算法实现

<? //-------------------- // 基本数据结构算法 //-------------------- //二分查找(数组里查找某个元素) function bin_sch($array, $low, $high, $k){ if ( $low <= $high){ $mid = int......

半缘修道半缘君丶
昨天
5
0
GIL 已经被杀死了么?

本文原创并首发于公众号【Python猫】,未经授权,请勿转载。 原文地址:https://mp.weixin.qq.com/s/8KvQemz0SWq2hw-2aBPv2Q 花下猫语: Python 中最广为人诟病的一点,大概就是它的 GIL 了。...

豌豆花下猫
昨天
8
0
git commit message form

commit message一般包括3部分:Header、Body、Footer。 <type>(<scope>):<subject>blank line<body>blank line<footer> header是必需的,body、footer可以省略。 header中type、subject......

ninjaFrog
昨天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部