Restful接口规范

Posted niuyg928

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Restful接口规范相关的知识,希望对你有一定的参考价值。

什么时Restful?

  新起于Rails,一种优雅的url表达式,资源的状态或者转移。

  友好示例:Get /seckill/list  、Post /seckill/{seckillid}/execution 、Delete /seckill/{seckillid}/delete/  

  不友好的例子:Post /seckill/execute/{seckillid}、Get /seckill/delete/{seckillid}

Get:一般用来做查询操作,Post:添加修改操作,Put:修改操作 post和put之间的区别体现在幂等性上,非幂等操作用post,幂等操作用put。Delete:删除操作

URL设计:

  /模块/资源/{标识}/集合1/....

  eg: GET  /user/{uid}/friends  ->好友列表

  GET /user/{uid}/followers -> 关注者列表

秒杀API的url设计

  GET /seckill/list ->秒杀列表

  GET /seckill/{id}/detail / -秒杀详情页

  GET /seckill/time/now -> 获取当前系统时间

  GET /seckill/{id}/exposer ->暴漏秒杀接口

  GET /seckill/{id}/{md5}/execution  ->执行秒杀

以上是关于Restful接口规范的主要内容,如果未能解决你的问题,请参考以下文章

RESTful 接口规范

Restful接口规范

Restful接口文档规范

Restful接口规范

关于RESTful接口规范

Restful风格接口书写规范