接口是计算机通信的一种抽象概念,实现接口的方式有很多种,下面我们就基于 http/https 的接口进行讨论
api接口请求与返回
参考 How NOT to design APIs 进行总结
作者的朋友的项目正在使用 Beds24 这套系统,这套系统主要就是用来做预定的,连接的是Booking\AirBnB上的房源信息。而这个项目的功能就是从一些订房平台上获取可供预定的房间和日期。
但是这个提供的接口服务存在着很多问题,所以作者就拿他作为反面教材愉快地吐槽了一番。
我们先来看一下一个典型的getAvailabilities接口,接口连接在这里。
我们暂且就称为接口A。接口 A 通过参数获取可用房间和时间,所有可选参数如下所示:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
{ "checkIn": "20151001", "lastNight": "20151002", "checkOut": "20151003", "roomId": "12345", "propId": "1234", "ownerId": "123", "numAdult": "2", "numChild": "0", "offerId": "1", "voucherCode": "", "referer": "", "agent": "", "ignoreAvail": false, "propIds": [ 1235, 1236 ], "roomIds": [ 12347, 12348, 12349 ] } |
我们就来细细评鉴一下这个参数中有哪些不合理的地方。
1.日期
我们可以看到,在请求报文中,checkIn
,lastnight
,checkOut
,都使用了黏在一起的年月日形式,YYYYMMDD,虽然这种形式的可读性也不差,但是对于跨语言解析的便利性上就不好说了。
其实作为时间,用 ISO8601 (Y