02.Restful风格

Posted 小虾米爱吃鱼

tags:

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

01.什么是RESTful风格

详情查看博客地址:https://www.cnblogs.com/xiaonq/p/10053234.html

 

1.1 什么是RESTful

 

  • REST与技术无关,代表的是一种软件架构风格(REST是Representational State Transfer的简称,中文翻译为“表征状态转移”)
  • REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识
  • 所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
  • 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)

1.2 web开发本质

 

  • 对数据库中的表进行增删改查操作
  • Restful风格就是把所有数据都当做资源,对表的操作就是对资源操作
  • 在url同通过 资源名称来指定资源
  • 通过 get/post/put/delete/patch 对资源的操作

02.RESTful设计规范

2.1 URL路径

 

  • 面向资源编程: 路径,视网络上任何东西都是资源,均使用名词表示(可复数),不要使用动词

 

# 不好的例子:url中含有动词
/getProducts
/listOrders

# 正确的例子:地址使用名词复数
GET /products      # 将返回所有产品信息
POST /products     # 将新建产品信息
GET /products/4     # 将获取产品4
PUT /products/4     # 将更新产品4

 

2.2 请求方式

 

  • 访问同一个URL地址,采用不同的请求方式,代表要执行不同的操作

  • 常用的HTTP请求方式有如下四种:

请求方式 说明
GET 获取资源数据(单个或多个)
POST 新增资源数据
PUT 修改资源数据
DELETE 删除资源数据

 

  • 例如

 

GET /books          # 获取所有图书数据
POST /books          # 新建一本图书数据
GET /books/<id>/       # 获取某个指定的图书数据
PUT /books/<id>/       # 更新某个指定的图书数据
DELETE /books/<id>/     # 删除某个指定的图书数据

 

#2.3 过滤信息

 

  • 过滤,分页,排序:通过在url上传参的形式传递搜索条件
  • 常见的参数:

 

?limit=10                   # 指定返回记录的数量。
?offset=10                   # 指定返回记录的开始位置。
?page=2&pagesize=100             # 指定第几页,以及每页的记录数。
?sortby=name&order=asc             # 指定返回结果按照哪个属性排序,以及排序顺序。

 

2.4 响应状态码

 

  • 重点状态码

 

\'\'\'1. 2XX请求成功\'\'\'
# 1.1 200 请求成功,一般用于GET与POST请求
# 1.2 201 Created - [POST/PUT/PATCH]:用户新建或修改数据成功。
# 204 NO CONTENT - [DELETE]:用户删除数据成功。

\'\'\'3. 4XX客户端错误\'\'\'
# 3.1 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误。
# 3.2 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
# 3.3 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
# 3.4 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录。

\'\'\'4. 5XX服务端错误\'\'\'
# 500 INTERNAL SERVER ERROR - [*]:服务器内部错误,无法完成请求
# 501 Not Implemented     服务器不支持请求的功能,无法完成请求

更多状态码参考:https://www.runoob.com/http/http-status-codes.html

 

  • 详细状态码

 

\'\'\'1. 2XX请求成功\'\'\'
# 1.1 200 请求成功,一般用于GET与POST请求
# 1.2 201 Created - [POST/PUT/PATCH]:用户新建或修改数据成功。
# 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
# 204 NO CONTENT - [DELETE]:用户删除数据成功。
\'\'\'2. 3XX重定向\'\'\'
# 301 NO CONTENT - 永久重定向
# 302 NO CONTENT - 临时重定向
\'\'\'3. 4XX客户端错误\'\'\'
# 3.1 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误。
# 3.2 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
# 3.3 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
# 3.4 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录。
# 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
# 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
# 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
\'\'\'4. 5XX服务端错误\'\'\'
# 500 INTERNAL SERVER ERROR - [*]:服务器内部错误,无法完成请求
# 501 Not Implemented     服务器不支持请求的功能,无法完成请求

更多状态码参考:https://www.runoob.com/http/http-status-codes.html

以上是关于02.Restful风格的主要内容,如果未能解决你的问题,请参考以下文章

面试官:你连RESTful都不知道我怎么敢要你?

通过 Java 正则表达式提取 semver 版本字符串的片段

面试官:你连RESTful都不知道我怎么敢要你? 文章解析

推荐10个优秀GitHub仓库

推荐10个优秀GitHub仓库

什么是蹦床功能?