django-8-优快云博客

本文链接：https://blog.youkuaiyun.com/rain_in_spring/article/details/141252973

一、什么是RESTful API？？？

REST一词，是Roy Thomas Fielding(opens new window)在他2000年的博士论文(opens new window)中提出的。

Fielding 是一个非常重要的人，他是HTTP协议（1.0版和1.1版）的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主席。所以，他的这篇论文一经发表，就引起了关注，并且立即对互联网开发产生了深远的影响。

在这篇论文中，Fielding将他对互联网软件的架构原则，定名为REST，即Representational State Transfer的缩写，翻译为表述性状态转移

如果一个架构符合REST原则，就称它为RESTful架构。

要理解RESTful，最好的办法就是理解Representational State Transfer这个词组的意思

资源(Resources)

资源，就是网络上的一个实体，它是一个具体的信息，可以是一段文本，一张图片，一首歌，一个种服务。可以通过一个URI指向它。要获取这个资源，就可以通过它的URI访问它，每一个资源的URI都是独一无二的标识符。

REST的作用对象就是资源，也即是资源的表述性状态转移。

表现层(Representation)

资源是一种信息实体，它可以有多种的表现形式。资源的具体呈现形式，叫做它的表现层。

比如，文本可以是txt格式表现，也可以是HTML格式，XML格式，JSON格式表现等；图片可以是JPG格式表现，也可以是PNG格式表现

状态转移

访问一个资源，是一个客户端通过HTTP协议与服务端的互动过程。在这个过程中，势必涉及数据和状态的变化。客户端通过不同的HTTP请求，操作资源，让其发生状态(创建，更新，删除等)的改变。

HTTP协议里，有四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种操作：GET获取资源，POST创建资源，PUT更新资源，DELETE删除资源

总结

综上，我们总结一下什么是RESTful架构：

每个URI代表一种资源
客户端和服务端之间，传递这种资源的某种表现形式
客户端通过HTTP方法，对服务器资源进行操作，实现状态的变化

二、RESTful API

RESTful不是标准，是一种风格。

下面给大家列出，得到了普遍公认和行之有效的设计。

2.1 版本

应该将API的版本号放入URL.

http://api.example.com/1.0/

2.2 路径

路径又称"终点"(endpoint)，表示API的具体网址。

在RESTful架构中，每个网址代表一种资源，所以网址中不应该有动词，只能有名词，而且所有的名词往往与数据库表的表名对应。一般来说，数据库中的表都是同种记录的"集合"(collection)，所以API中的名词也应该使用复数。

举例来说，一个crm系统的api，包含学生和课程信息，则它的路径应该设计成下面这样。

http://api.example.com/1.0/students/
http://api.example.com/1.0/courses/

2.3 http动词（http方法）

对于资源的具体操作类型，由http动词表示。

常用的http动词有下面五个（括号里是对应的SQL命令）。

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性局部更新）。
DELETE（DELETE）：从服务器删除资源。

还有两个不常用的HTTP动词。

HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

看下面的例子：

GET /students：列出所有学生
POST /students: 新建一个学生
GET /students/pk: 获取某个学生的信息
PUT /students/pk: 更新某个学生的全部信息
PATCH /students/pk: 更新某个学生的部分信息
DELET /students/pk: 删除某个学生

2.4 过滤信息

如果记录数量很多，服务器不可能一次将它们全部返回给用户。API应该提供参数，过滤返回结果。

下面是场景的参数。

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&page_size=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?sex=1：指定筛选条件

2.5 状态码

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。