我已经看过很多糟糕的api了,在全栈开发设计api过程中也深有体会
http://localhost/api/article/114514
在仅数据型api中不会存在问题,但是看看这个糟糕的api
http://localhost/page/blog/article/114514
是不是响应的应用和数据都要通过/分离出来;要单独为每个应用写router或者使用服务发现;要同时使用多个同级模块应该把模块名放在URL的哪个位置?
严重混合了web应用路径和数据路径,这使得应用路由和数据数据设计时束手束脚。
我认为数据和应用应该是分离的,使用 ?
已经很好了,而且浏览器提供了new URL()构造方法获取参数。
API设计本来是为了方便使用的,现在倒好,数据和应用混在一起,到后端还得写几个match从URL中分离出数据和web应用,如果使用serviceworker拦截请求设计离线webapp时场面又会如何。
推荐API设计规范
网络地址/应用模板?响应模块=“”&模块对应参数1&模块对应参数2
共享统一api:网络地址/?响应模块名=“”&模块参数
仅数据型api无所谓或仅应用型等独立性较强的无所谓
混合型可以很交由不同人员独自设计前后端分工而无需关心唯一api设计,(后端也互相分离互不干扰的那种)
如:
http://localhost/api/article
http://localhost/page/blog.html?query={“type”:“articles”, keword:“114514”}
显然要更灵活更语义化的api,还不如直接使用json