对restful API的理解

​ restful是一种软件设计风格,一种思想,它不是一种标准规定,不使用restful风格API,我们也能正常开发工作,它只是一种大家比较提倡的设计规范。

​ 我们平时设计接口时,常根据自己所做的功能为接口起名称,比如要写一个查询用户列表的接口,我们可能会起/queryUser的接口名,有的人会起selectUser、userList的接口名,我们把我们要做的动作通过单词来表达,可能同一个功能,不同的人能写出不同的接口,同时不同人理解不一样可能会增加沟通难度。如我们用restful风格设计API,那么查询用户列表接口就是/users的get接口,users表示用户资源,get表示获取资源。

请求方式API说明
GET/users查询用户列表
GET/users/123查看某个用户
POST/users新建用户
PUT/users/123更新用户(全部字段)
PATCH/users/123更新用户(部分字段)
DELETE/users/123删除用户

​ 通过接口对服务器进行请求,其实是对资源的一种操作,所以接口名应该要表达出要操作的资源,最好用名词的复数形式表示。除了接口的命名,对接口的返回结果,我们也应该规范起来,返回结果最好统一为JSON字符串的形式,方便前端解析,同时返回结果除了包含业务数据外,也应该包含请求的状态码,方便后端人员通过状态码大致可知请求处理过程,建议封装一个统一返回结果的response对象。

下面是常见的HTTP状态码:

  • 200 - 请求成功
  • 301 - 资源(网页等)被永久转移到其它URL
  • 404 - 请求的资源(网页等)不存在
  • 500 - 内部服务器错误

详细的状态码:http://tools.jb51.net/table/http_status_code

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值