API 版本 & 自底向上的 PHP 单元测试

产品需求对角色和终端的组合在不断变化,众多不断快速变化的 API 接口代码在产品的演进中日益成为一个问题;经过讨论分析,最终采用 Yii2 的推荐做法,即通过 modules 实现 版本管理

最近,PHP 单元测试有进展,我们在 ShortUrlService 短链接实现思路 中不仅对内部使用的 service 进行了单元测试,对 ControllerTest 也有尝试;

本文结合 ShortUrlService 的 ShortUrlControllerTest 以及 v1.4 的 DemandControllerTest 来示范一下;

API 版本管理
  • 采纳 Yii2 的方案:通过 module 实现 API 版本;
    结合原来按版本部署的经验和 Los 根据需求提出的对应分拆 Yar RPC 服务的想法,我们最终采用了 Yii2 的推荐做法;
  • 我们产品需求版本 v1.4,对应 module v14,但在 url 中保持 v1.4/$controller/$action

需求版本由两部分组成:major.minor(大版本.小版本);
1.0, 1.1, ..., 1.9, 2.0, ..., 2.9, ...;小版本只有 0-9;

  • 可能会出现这样一个情况:同一个站点,不同页面的 ajax 请求,访问的是不同版本的 API;
  • 同时维护的版本不要超过三个;
自底向上测试
  • 自底向上逐步构建;
  • RPC 首先应当通过测试;
  • API 基于 RPC 构建可靠服务;
  • API 接口测试应集中在自己范围内的测试用例,应当由 RPC 解决的,要放到 RPC 解决;


    自底向上逐步构建
  • 版本 API 的 URL 形如:r=v1.4/demand/c34;
ShortUrlControllerTest
  • 这个示例纯粹是一个示例,旨在说明使用 PHPUnit 如何对 API 接口进行测试;
  • shorturl/controllers/ShortUrlControllerTest.php 示例;
  • Guzzle 是一个不错的 PHP HTTP Client,比 cURL 好用;
    ControllerTest 示例
DemandControllerTest
  • @dataProvider 是一个很好的尝试,准备多套数据,驱动测试;
    @dataProvider 是一个好东西
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,825评论 4 377
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,887评论 2 308
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 112,425评论 0 255
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,801评论 0 224
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,252评论 3 299
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,089评论 1 226
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,216评论 2 322
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 31,005评论 0 215
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,747评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,883评论 2 255
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,354评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,694评论 3 265
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,406评论 3 246
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,222评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,996评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,242评论 2 287
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 36,017评论 2 281

推荐阅读更多精彩内容