PHP API 框架开发的学习
基于互联网的应用正变得越来越普及,在这个过程中,有更多的站点将自身的资源开放给开发者来调用。对外提供的API 调用使得站点之间的内容关联性更强,同时这些开放的平台也为用户、开发者和中小网站带来了更大的价值。
在开发API前,你需要的是给API设定一个框架,这个框架一定是要简单的且是容易扩展的。下面就是用就来看看如何使用PHP来创建一个API。
API框架需要的特性
- 面向对象和结构化的代码
- 可修改的URL结构
- 创建多个版本
- 使用Hook来扩展框架API功能
- API可连接数据库表
- 可定义多种输出格式
- 选择方法请求类型(GET, POST, PUT, DELETE)
API框架的组成部分
API Framework主要由下面三中类型元素组成:
- Services
- Hooks
- Parsers
在一个运行的API中,每种类型的元素都有其自己的任务。下面就来详细说说每一种元素。
通常的API请求URL如下:
http://www.domain.com/api/version/service/method/param_name/param_key.extension
Service
Service Class是API请求的控制器。这个Class包含了API可以使用的method,所以Service Class会需要计算和处理数据。
为了使method可以被请求,你需要将method设置为公开(public),并为service method设置请求类型(GET, POST, PUT, DELETE)。
下面是一个Service Class的类,你可以设置默认的请求方式为GET,并且version method可以接受GET和POST请求。
class MyApi_Service_Helloworld extends Api_Service_IService{
public function __construct($api){
parent::__construct($api);
// Set execute request methods
$this->addAllowedMethod("execute", Api_Request::METHOD_POST);
$this->addAllowedMethod("version", Api_Request::METHOD_POST);
$this->addAllowedMethod("version", Api_Request::METHOD_GET);
}
public function execute($params, $config){
$this->code = 200;
return "Hello world";
}
public function version($params, $config){
$this->code = 200;
return "Version 1.0";
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
<?php
classMyApi_Service_HelloworldextendsApi_Service_IService{
publicfunction__construct($api){
parent::__construct($api);
// Set execute request methods
$this->addAllowedMethod("execute",Api_Request::METHOD_POST);
$this->addAllowedMethod("version",Api_Request::METHOD_POST);
$this->addAllowedMethod("version",Api_Request::METHOD_GET);
}
publicfunctionexecute($params,$config){
$this->code=200;
return"Hello world";
}
publicfunctionversion($params,$config){
$this->code=200;
return"Version 1.0";
}
}
|
这里是一个可以使用的使用的API请求类型:
- Api_Request::METHOD_GET
- Api_Request::METHOD_POST
- Api_Request::METHOD_PUT
- Api_Request::METHOD_DELETE
如果你希望方法( method)名以驼峰式命名的话,如:
public myNewHelloWorld{}
那么你就需要在你的url中使用”my-new-hello-world”来请求这个方法(/v1/helloworld/my-new-hello-world.xml)。
Hook
Hook是一个可以绑定特定行为的类。哪些Hooks 会在执行力中执行特定的点(如图所示)。它可以让你在服务使用前修改数据。下面是一些可能的hook示例:
- 监测用户使用的API key是否在数据库中存在。
- 监测特定的IP地址是否是允许使用服务或行为的。
- 在文件或者数据库中记录用户的请求日志。
- 禁止特定的 IP使用API。
- 限制IP每小时对API的请求数。
上面的只是一些示例,你可以发挥你的想象任意的添加Hook。下面是一个关于Hook的实例:
public function execute(){
// Current called service
$service = func_get_arg(0);
// Get config array
$config = $this->api->getConfig();
// Stop if blocks is not configured
if(!isset($config['block'])) return;
// Convert comma separated list to array
$blocked = explode(',', $config['block']);
// Check if the user IP is blocked
// If blocked show him a message
if(in_array($_SERVER['REMOTE_ADDR'], $blocked)){
throw new Api_Error('Spammer', 'Your IP address is blocked.');
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
classApi_Hook_BlockIpextendsApi_Hook_IHook{
publicfunctionexecute(){
// Current called service
$service=func_get_arg(0);
// Get config array
$config=$this->api->getConfig();
// Stop if blocks is not configured
if(!isset($config['block']))return;
// Convert comma separated list to array
$blocked=explode(',',$config['block']);
// Check if the user IP is blocked
// If blocked show him a message
if(in_array($_SERVER['REMOTE_ADDR'],$blocked)){
thrownewApi_Error('Spammer','Your IP address is blocked.');
}
}
}
|
为了使上面的Hook可以正常的工作,你需要在config文件中添加这样一行:
block = ip1,ip2,ip3
接下来就是讲解不同种类的hook了:
- HOOK_CONFIG_LOADED: 这个hook是在加载了配置(config)请求的。他可以用来修改或添加一些配置信息
- HOOK_BEFORE_SERVICE_EXECUTE: 这个hook是在服务执行前执行的,所以它可以用来校核用户身份,查看是否有具体的权限。
- HOOK_MODIFY_PARSER: 使用这个Hook可以在输出数据解析前修改解析器。
如果要启用钩子则需要到程序的入口(endpoint.php)进行修改。
Parsers
解析器用来转化数据到特定的输出格式的。例如是XML,机械器就是用定义的APi请求文件扩展名来表示。例如:
- /v1/helloworld.xml: 则使用Xml.php作为解析器
- /v1/helloworld.json: 则使用Json.php作为解析器
你可以根据自己的需求定义标准的解析器,如:
- XML
- CSV
- JSON
- Printr
- TXT
下面是一种类似PHP中print_r的输出格式示例:
/**
* Content type
* @var string
*/
public $content_type = "text/plain";
/**
* Parse to XML
*
* @return string
*/
public function parse(){
return print_r($this->_data, true);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
classApi_Parser_PrintrextendsApi_Parser_IParser{
/**
* Content type
* @var string
*/
public$content_type="text/plain";
/**
* Parse to XML
*
* @return string
*/
publicfunctionparse(){
returnprint_r($this->_data,true);
}
}
|
框架会根据命名规则自动寻找适合的输出格式。
要顺利的开发一个PHP API,除了以上的这些还需要做的有:
- 创建一个基本的API配置文件,并修改好程序的入口。
- 配置自己想要的REST URL结构。
- 记录接口中产生的错误。~
PHP API 框架开发的学习的更多相关文章
- 学习ASP.NET Web API框架揭秘之“HTTP方法重写”
最近在看老A的<ASP.NET Web API 框架揭秘>,这本书对于本人现阶段来说还是比较合适的(对于调用已经较为熟悉,用其开发过项目,但未深入理解过很多内容为何可以这样“调用”).看到 ...
- Ruby on Rails框架开发学习
学习地址:http://www.ixueyun.com/lessons/detail-lessonId-685.html 一.课程概述 软件开发在经历了面向过程编程的阶段,现在正大行其道的是敏捷开发, ...
- JavaSE中线程与并行API框架学习笔记——线程为什么会不安全?
前言:休整一个多月之后,终于开始投简历了.这段时间休息了一阵子,又病了几天,真正用来复习准备的时间其实并不多.说实话,心里不是非常有底气. 这可能是学生时代遗留的思维惯性--总想着做好万全准备才去做事 ...
- MVC WebAPI 三层分布式框架开发
版权声明:本文为博主原创文章,未经博主允许不得转载. 前言:SOA(面向服务的架构)是目前企业应用开发过程中普遍采用的技术,基于MVC WebAPI三层分布式框架开发,以此适用于企业信息系统的业务处理 ...
- Android游戏与应用开发最佳学习路线图
Android 游戏与应用开发最佳学习路线图 为了帮助大家更好的学习 Android,并快速入门特此我们为大家制定了以下学习路线图,希望能够帮助大家. 一.路线图概括: 二.具体需要掌握知识点: 三. ...
- SSM框架开发web项目系列(二) MyBatis真正的力量
前言 上篇SSM框架环境搭建篇,演示了我们进行web开发必不可少的一些配置和准备工作,如果这方面还有疑问的地方,可以先参考上一篇“SSM框架开发web项目系列(一) 环境搭建篇”.本文主要介绍MyBa ...
- express框架开发案例
express是基于Node.js平台的web应用开发框架,用express框架开发web项目可以直接构建整个项目框架并且将前端页面跟后台贯穿起来,用起来还是灵活的:最近刚开始学习,写篇博客总结下,涉 ...
- 现代web开发需要学习的15大技术
现代Web开发需要学习的15大技术 2016-06-08 13:08 快进到现在,我发现现代web开发再一次将发生压倒性的改变.信息资讯的铺天盖地令人迷惑,尤其对于初学者而言.首要原因是新的框架,例如 ...
- API Star:一个 Python 3 的 API 框架
为了在 Python 中快速构建 API,我主要依赖于 Flask.最近我遇到了一个名为 "API Star" 的基于 Python 3 的新 API 框架.由于几个原因,我对它很 ...
随机推荐
- [Effective JavaScript 笔记]第23条:永远不要修改arguments对象
arguments对象并不是标准的Array类型的实例.arguments对象不能直接调用Array方法. arguments对象的救星call方法 使得arguments可以品尝到数组方法的美味,知 ...
- [Effective JavaScript 笔记]第42条:避免使用轻率的猴子补丁
41条对违反抽象原则行为的讨论之后,下面聊一聊终极违例.由于对象共享原型,因此每一个对象都可以增加.删除或修改原型的属性.这个有争议的实践通常称为猴子补丁. 猴子补丁示例 猴子补丁的吸引力在于其强大. ...
- ajax页面排序的序号问题
文章是从我的个人博客上粘贴过来的, 大家也可以访问我的主页 www.iwangzheng.com 目前使用的ajax排序是这样的. 每个table , 都要这样声明 ( table 中必须有2个属性: ...
- Redis系列-远程连接redis并给redis加锁
假设两台redis服务器,ip分别为:192.168.1.101和192.168.1.103,如何在101上通过redis-cli访问103上的redis呢?在远程连接103之前,先讲下redis-c ...
- scp失效问题
1.症状 (1)登陆到服务器A(已在本机用ssh-add, ssh -A),scp 到服务器B时提示public key有问题: (2)/tmp/下没有ssh-XXX目录 2.原因 服务器A被pupp ...
- 父页面刷新 保持iframe页面url不变
思路:点击父页面时写cookies-->刷新时从cookies中奖内容读取出来. 本文转自:http://blog.163.com/sdolove@126/blog/static/1146378 ...
- codeforces A. Table 解题报告
题目链接:http://codeforces.com/problemset/problem/359/A 题目意思:给出一个n行m列的table,你需要选择一个good cell(假设为(x, y), ...
- tomcat下不用项目名直接访问项目
把tomcat下的项目名称改为ROOT,访问项目的时候,不用输入项目名称,输入地址,如192.168.182.100:8080即可.
- [Linux] xargs的- n1参数
起因在对一堆*.tar.gz文件解压缩时,发现tar xvfz *.tar.gz不管用,一查,原来是tar xvfz *.tar.gz会被shell给拆成tar xvfz a.tar.gz b.tar ...
- sysctl命令详解
个人一般sysctl -p 或sysctl -a比较多使用 sysctl配置与显示在/proc/sys目录中的内核参数.可以用sysctl来设置或重新设置联网功能,如IP转发.IP碎片去除以及源路由检 ...