WEB应用不应该形式主义地使用RESTFULL-API规范

本文探讨了API设计中的常见问题,指出将数据路径与应用路径混淆可能导致的不便。建议API设计应遵循清晰的分离原则,利用查询参数而非URL路径分隔数据和应用部分。推荐采用如`/api/app?response_module=data&id=114514`的格式,以提高灵活性和语义化。此外,混合型API设计可以考虑前后端分离,由不同团队独立处理。良好的API设计能提升开发效率并简化服务发现和维护。
摘要由CSDN通过智能技术生成

我已经看过很多糟糕的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

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值