restful api是基于http协议的标准的web服务架构，它是当今互联网上各种web应用开发中最为流行的一种技术。利用restful api可以快速地对外部应用或其它服务提供许多不同的数据和功能。在本文中，我们将介绍一个高效的php框架fat-free，以及如何使用它来开发一个restful api服务。
一、什么是Fat-Free框架?
Fat-Free是一种轻量级的、灵活的开源PHP框架，它的名字也暗示着它的特性：快速、简单、小巧。该框架提供了许多内置的基本功能模块，如路由、模板引擎、数据库等，使得它在创建Web应用时非常高效、简单、灵活。
二、为何使用Fat-Free框架?
- 十分轻量级：Fat-Free框架容量非常小，占用的空间很小，因此能够快速加载，而且能够容易地部署在各种服务器上。
- 强大的路由系统：Fat-Free框架的路由系统鲜明地体现了框架的思想 – 为开发者提供快捷、精准的URL路径映射，并且提供了许多有助于开发者工作的函数，比如：路由保护、路由约束、路由别名等。
- 灵活的ORM: Fat-Free框架提供了非常灵活的ORM模型，支持多种数据库、支持各种关系和查询方式，是一个完整的数据库操作框架。
- 强大的插件机制: Fat-Free框架提供了许多强大的插件，支持各种功能，包括邮箱、图片处理、安全性、打印调试等。
三、如何使用Fat-Free框架开发RESTful API服务?
立即学习“PHP免费学习笔记（深入）”；
- 安装Fat-Free框架
你可以从Fat-Free的官网下载安装包，也可以使用composer进行安装。
- 创建RESTful API文件夹
在你的Web目录中新建一个API文件夹，并将Fat-Free框架移动到API文件夹下，如图所示：
├─API/ │ ├─f3/ │ │ ├─lib/ │ │ ├─... │ ├─index.php
- 创建API入口文件 index.php
创建一个文件 index.php，这是我们的API服务的入口文件。我们需要包含Fat-Free框架。
<?php
$f3 = require('f3/lib/base.php');
// RESTful API 路由
$f3->route('GET /api/@apiname','api@get');
$f3->route('POST /api/@apiname','api@post');
$f3->route('PUT /api/@apiname','api@put');
$f3->route('DELETE /api/@apiname','api@delete');
// 连接数据库
$f3->set('DB', new DBSQL('mysql:host=localhost;port=3306;dbname=test', 'root', 'root'));
// 执行
$f3->run();在这个文件中，我们定义了四个路由，对应了HTTP协议的四种请求方法，分别是GET、POST、PUT、DELETE。Fat-Free框架支持通过路由来处理请求，路由定义了URL路径与函数之间的映射关系。因此，我们定义了一个名为api的控制器，并向它映射了四个不同的请求方式。
- 创建API控制器
我们需要一个API控制器来处理客户端发起的请求，并返回对应的响应数据。
<?php
class api {
protected $APIVer = 'v1';
private function respond($response) {
header('Content-type: application/json; charset=utf-8');
header('Cache-control: max-age=3600');
echo json_encode($response, JSON_PRETTY_PRINT|JSON_UNESCAPED_UNICODE);
}
public function get($f3) {
$request = new WebREST($f3->get('VERB'), @$f3->get('PARAMS.apiname'), @$f3->get('PARAMS.id'));
$result = $request->process();
if ($result) {
$this->respond($result);
$f3->status(200);
}
else $f3->status(404);
}
public function post($f3) {
$request = new WebREST($f3->get('VERB'), @$f3->get('PARAMS.apiname'), @$f3->get('PARAMS.id'));
$result = $request->process();
if ($result) {
$this->respond($result);
$f3->status(201);
}
else $f3->status(404);
}
public function put($f3) {
$request = new WebREST($f3->get('VERB'), @$f3->get('PARAMS.apiname'), @$f3->get('PARAMS.id'));
$result = $request->process();
if ($result) {
$this->respond($result);
$f3->status(202);
}
else $f3->status(404);
}
public function delete($f3) {
$request = new WebREST($f3->get('VERB'), @$f3->get('PARAMS.apiname'), @$f3->get('PARAMS.id'));
$result = $request->process();
if ($result) {
$this->respond($result);
$f3->status(202);
}
else $f3->status(404);
}
}在这个控制器中，定义了四个方法：get、post、put、delete。在这些方法中，我们需要实例化一个 Web REST对象，并调用它的process方法来获取响应数据。从HTTP响应的角度来讲，响应数据应该是JSON格式的，所以在respond方法中，我们使用了PHP的json_encode方法来将响应数据转换为JSON串，并输出到客户端。
- 创建Web/REST.php类文件
这个类文件用于处理RESTful API服务器的请求。
<?php
namespace Web;
class REST {
private $verb; // HTTP 请求方法
private $apiname; // API名称
private $id; // API 记录id
private $user; // 用户认证信息
protected $db; // 数据库连接
protected $base; // 数据库基本名称
protected $table; // 表名
protected $data; // 用于 POST 和 PUT 请求中的数据
protected $fields = array(); // 表字段名称
protected $response_code = 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',
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'
);
public function __construct($verb, $apiname, $id = null, $data = null) {
$this->verb = $verb;
$this->apiname = $apiname;
$this->id = $id;
$this->data = $data;
$this->db = Base::instance()->get('DB');
}
public function process() {
//$sql = "SELECT...";
...
}
}
}在这个类文件中，我们实现了一个REST类，该类处理RESTful API服务器的请求。在类中，包含了HTTP请求方法类型、API名称、API记录ID、需要处理的数据等内容。此类操作数据库，获取相关数据，创建请求及返回响应数据。
四、结论
正如我们在前面所看到的，使用PHP框架Fat-Free开发RESTful API服务是非常容易的，因为它本身就是一个轻量级框架，而且它的强大的路由机制意味着我们可以非常灵活地定义API路由。此外，它提供了许多非常有用的模块来帮助我们快速地完成Web应用程序开发。这就是为什么我们选择Fat-Free作为PHP框架的主要原因，正是它的轻量级、高效、可靠、灵活的特点，使我们能够快速地创建精致的RESTful API。
