快速学会Restful风格api的设计,包含常见的restful 命名实例

-- 5分钟学会Restful风格api的设计,包含常见的restful 命名实例
【官网】:

应用场景

RESTful Web API采用面向资源的架构,所以在设计之初首先需要考虑的是有哪些资源可供操作。 资源是一个很宽泛的概念,任何寄宿于Web可供操作的“事物”均可视为资源。资源可以体现为经过持久化处理保存到磁盘上的某个文件或者数据库中某个表的某条记录,也可以是Web应用接受到请求后采用某种算法计算得出的结果。资源可以体现为一个具体的物理对象,它也可以是一个抽象的流程。 一个资源必须具有一个或者多个标识,既然我们设计的Web API,那么很自然地应该采用URI来作为资源的标识。作为资源标识的URI最好具有

基础资源

使用须知

具体需要根据企业实际来出发,有些领域业务比较强的,很难通过几个put,delete,post来严格区分,可以进行相关的简化和自定义规则。

配置步骤

【Restful风格api的特征】

1)基于“资源”,数据也好、服务也好,在RESTFul设计里一切都是资源: URL中不能有动词,都是名词.
2)无状态。一次调用一般就会返回结果,不存在类似于“打开连接-访问数据-关闭连接”这种依赖于上一次调用的情况。http请求一样
3)URL中通常不出现动词,只有名词
4)URL语义清晰、明确
5)使用HTTP的GET(获取)、POST(创建)、DELETE(删除)、PUT(更新)来表示对于资源的增删改查
6)出参使用JSON不使用XML.

7)URL中首先小写字母。

8)URL路径名词均为复数

7)可选:HTTP状态码,在REST中都有特定的意义:200,201,202,204,400,401,403,500。比如401表示用户身份认证失败,403表示你验证身份通过了,但这个资源你不能操作。

常见问题

快速入门

【常见RestFul风格的api示例】

http://api.config.net.cn/v1/books      //GET: 获取所有书籍

http://api.config.net.cn/v1/books?page=2&page_size=10      //GET: 获取每页10条第二页中的书籍

http://api.config.net.cn/v1/books/ID    //GET:获取指定Id的书

http://api.config.net.cn/v1/orders/2021/06/28     //GET:2021-6-28日的订单

http://api.config.net.cn/v1/orders    //POST: 创建一个订单

http://api.config.net.cn/v1/books    //PUT: 更新一个书籍

http://api.config.net.cn/v1/orders/20210628  //DELETE:删除一个订单  




参考资料

51La