RESTful 规范

RESTful 规范

前言

rest 是一种软件架构风格，如果使用的是 rest 接口，那么就可以说你的接口是 restful。

rest接口是围绕‘’资源‘’展开的，利用 HTTP 的协议，其实 rest 可以和 HTTP 五段，但是大家普遍使用 rest 的都依托于HTTP 协议。而 HTTP 的 url 全称为（Uniform Resource Locator）中文翻译为统一资源定位符，在互联中中 HTTP 的 url 即资源。

通用的 url 语法

URL = scheme'://'authority '/' path ['?' query]['#' fragmentn]

• schme：指底层用的协议，如 HTTP、HTTPS、ftp 等
• host： 服务器的 IP 地址或者域名
• port： 端口，http 中默认为80
• path：访问资源的路径，就是咱们各种 web 框架中定义的 route 路由
• query：为发送给服务器的参数
• fragment：锚点，定位到页面的资源，锚点为资源 id

什么是 RESTful

• REST 与技术无关，代表的是一种软件架构风格，REST 是 Representational State Transfer 的简称，中文翻译为‘’表征状态转移‘’
• REST 从资源的角度来审视整个网络，它将分布在网络中某个节点的资源通过 URL 进行标识，客户端应用通过 URL 来获取资源的表征，获得这些表征使这些应用转变状态
• REST 与技术无关，代表的是一种软件架构风格，REST 是 Representational State Transfer 的简称，中文翻译为‘’表征状态转移‘’
• 所以的数据，不过是通过网络获取的还是操作（增删查改）的数据，都是自愿，将一切数据视为自愿是 REST 区别与其他架构风格的最本质属性
• 对于 REST 这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

RESTful API 设计规范

RESTful API 设计规范总共有十条，对于这十条规范，更多的是建议使用，而不是强制使用。

1. API 与用户的通信协议，总是使用 HTTPS 协议

2. 域名

   1. https://api.example.com 尽量将 API 部署在专用域名（存在跨域问题）
   2. https://example.org/api API很简单

3. 版本

   1. URL，如https://api.example.com/v1
   2. 请求头 跨域时，引发发送多次请求

4. 路径，视网络上任何东西都是自愿，均使用名词表示（可复数）

   1. https://api.example.com/v1/zoos
   2. https://api.example.com/v1/animals
   3. https://api.example.com/v1/employees

5. method

   1. GET：从服务器获取资源（一项或多项）
   2. POST： 在服务器新建一个资源
   3. PUT： 在服务器更新资源（客户端提供改变后的完整资源）
   4. PATCH：在服务器更新资源（客户端提供改变的属性）
   5. DELETE： 从服务器删除资源

6. 过滤，通过在 url 上传参的形式传递搜索条件

   1. https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
   2. https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
   3. https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
   4. https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
   5. https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

7. 状态码

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

8. 错误处理，应该返回错误信息，将 error 当做 key

   {"error": "错误信息"}
   

9. 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范

   GET /collection：返回资源对象的列表（数组）
   GET /collection/resource：返回单个资源对象
   POST /collection：返回新生成的资源对象
   PUT /collection/resource：返回完整的资源对象
   PATCH /collection/resource：返回完整的资源对象
   DELETE /collection/resource：返回一个空文档
   

10. Hypermedia API，RESTful API 最好做到 Hypermedia，机返回结果中提供链接，联向其他 API 方法，使得用户不查文档，也知道下一步应该做什么

基于 Django 实现 RESTful 规范

# urls.py

urlpatterns = [
    url(r'^admin/', admin.site.urls),

    # url(r'^books/', views.Books.as_view()),
    url(r'^book/(?P<id>\d+)/', views.Book.as_view()),
]

# views.py

class Books(APIView):

    def dispatch(self, request, *args, **kwargs):
        return super().dispatch(request, *args, **kwargs)

    # @staticmethod
    def get(self, request, *args, **kwargs):

        response = {'status': 100, 'msg': None}

        book_list = models.Book.objects.all()
        book_ser = BookSerib(book_list, many=True)
        print('book_ser.data', book_ser.data)
        response['books'] = book_ser.data
        print('response', response)
        return Response(response)