REST API学习和总结

本文介绍了REST API的设计理念,包括资源定义、接口命名、过滤信息和状态码的使用。强调URL应由名词组成,避免动词,利用HTTP方法表示操作。过滤信息通过URL参数实现,状态码用于清晰传达请求结果。RESTful API的设计旨在提高接口的易理解和使用性。
摘要由CSDN通过智能技术生成

学习原文见:https://github.com/Snailclimb/JavaGuide/blob/master/docs/system-design/coding-way/RESTfulAPI%E7%AE%80%E6%98%8E%E6%95%99%E7%A8%8B.md

前言

REST API可以设计出更加简洁明了的接口,帮助实现系统之间的信息传递和调用关系。已经设计过并开发对接过银行和银联的API,一直用给方法命名的方式来命名接口,也一直在思考怎么能更高效简洁的定义API。这个规范可以借鉴参考,刚刚好正中下怀,解答了我的很多困惑。

总结思考

1. REST简单说为了实现为了获取资源信息或对其实施动作的规范。从发出请求方式,到返回内容格式,以及动作完成后资源。

2. 原来的设计接口过程中,用了太多v+n的组合。目的是为了给自己提醒也为了方便对接的开发,看来可以借鉴REST,但不能直接全盘套用。虽然用GET和POST方法就可以区分是插入还是查找行为,但是和你对接的人也要接受这样的规则才行。

3. 关于classes和schools的层级,目前所参与的项目都无法自定义url,只有gateway.do一个层级。所有的接口相当于平铺一层,根据的参数中method用名称来区分。

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值