使用PHP创建一个REST API(Create a REST API with PHP)节选5

纵横南北

于 2013-03-25 13:47:31 发布

阅读量706

点赞数

分类专栏： REST PHP

REST 同时被 2 个专栏收录

6 篇文章 0 订阅

订阅专栏

PHP

6 篇文章 0 订阅

订阅专栏

Now that we can interpret the request, let’s move on to sending the response. We already know that all we really need to do is send the correct status code, and maybe some body (if this were a GET request, for example), but there is an important catch to responses that have no body. Say somebody made a request against our sample user API for a user that doesn’t exist (i.e. api/user/123). The appropriate status code to send is a 404 in this case, but simply sending the status code in the headers isn’t enough. If you viewed that page in your web browser, you would get a blank screen. This is because Apache (or whatever your web server runs on) isn’t sending the status code, so there’s no status page. We’ll need to take this into account when we build out our function. Keeping all that in mind, here’s what the code should look like:
既然我们已经可以解析请求，那么接下来我们继续来发送一个响应。我们已经知道我们真正需要去做的是发送一个正确的状态码和一些响应消息体（例如这是一个GET请求），但是对于没有消息体的响应来说有一个重要的catch（译者：不好意思，实在是不知道如何翻译这个词）。假定某个人向我们的user接口发送一个请求某个用户信息的请求，而这个用户却不存在（比如：api/user/123），此时系统发送最合适的状态码是404。但是简单的在头信息中发送状态码是不够的，如果你通过网页浏览器浏览该页面，你会看到一个空白页面。这是因为apache服务器（或者其他服务器）并不会发送此状态码，因此没有状态页面。我们需要在构建方法的时候考虑到这一点。把所有的东西都考虑进去，代码会类似于下面这样：

    PHP代码  
  
 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
     $body = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
         <html>
         <head>
           <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
           <title>' . $status . ' ' . RestUtils::getStatusCodeMessage($status) . '</title>
         </head>
         <body>
           <h1>' . RestUtils::getStatusCodeMessage($status) . '</h1>
           ' . $message . '
 
           <hr />
           <address>' . $signature . '</address>
         </body>
         </html>';
 
     echo $body;
     exit;
   }
 }

That’s It! We technically have everything we need now to process requests and send responses. Let’s talk a bit more about why we need to have a standard body response or a custom one. For GET requests, this is pretty obvious, we need to send XML / JSON content instead of a status page (provided the request was valid). However, there’s also POSTs to deal with. Inside of your apps, when you create a new entity, you probably fetch the new entity’s ID via something like mysql_insert_id(). Well, if a user posts to your API, they’ll probably want that new ID as well. What I’ll usually do in this case is simply send the new ID as the body (with a 201 status code), but you could also wrap that in XML or JSON if you’d like.
就这样，从技术上来说，我们已经具备了处理请求和发送响应的所有东西。下面我们再讨论以下为什么我们需要一个标准的相应提或者一个自定义的。对于GET请求来说，非常明显，我们需要发送XML/JSON内容而不是一个状态页（假设请求是合法的）。然后，我们还有POST请求要去处理。在你的应用内部，当你创建一个新的实体，你也许需要使用通过类似于mysql_insert_id()这样的函数得到这个实体的ID。那么，当一个用户提交到你的接口，他们将很可能想要知道这个新的ID是什么。在这种情况下，我通常的做法是非常简单的把这个新ID作为响应的消息体发送给用户（同时发送一个201的状态码头信息），但是如果你愿意，你也可以使用XML或者JSON来把它包裹起来。

So, let’s extend our sample implementation a bit:
现在，让我们来扩展一下我们的例子，让它更加实际一点：

    PHP代码  
  
 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;
 }

Again, this is just an example, but it does show off (I think, at least) how little effort it takes to implement RESTful stuff.
Wrapping Up
再一次说明，这是一个例子，但它确实向我们展示了（至少我认为是）它能轻而易举的实现RESTful接口。

So, that’s about it. I’m pretty confident that I’ve beaten the point that this should be quite easy into the ground, so I’d like to close with how you can take this stuff further and perhaps properly implement it.
所以，这就是它。我非常的自信的说，我已经把这些解释的非常清楚。因此，我就不再赘述你如何具体实现它。

In a real-world MVC application, what you would probably want to do is set up a controller for your API that loads individual API controllers. For example, using the above stuff, we’d possibly create a UserRestController which had four methods: get(), put(), post(), and delete(). The API controller would look at the request and determine which method to invoke on that controller. That method would then use the utils to process the request, do what it needs to do data-wise, then use the utils to send a response.

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

使用PHP创建一个REST API(Createa REST API with PHP) 节选1

使用PHP创建一个REST API(Createa REST API with PHP) 节选2

使用PHP创建一个REST API(Createa REST API with PHP) 节选3

使用PHP创建一个REST API(Create aREST API with PHP) 节选4

使用PHP创建一个REST API(Createa REST API with PHP) 节选5

使用PHP创建一个REST API(Createa REST API with PHP) 节选6