RESTful规范

我就是我 2021-12-21 17:51 188阅读 0赞

## 什么是RESTful ##

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

## 10个规范 ##

**HTTPS、域名、版本、路径(名词)、method、过滤、状态码、错误处理、返回结果、提供链接**

*  API与用户的通信协议，总是使用[HTTPS协议][HTTPS]
 *  域名

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

*  版本

https://www.baidu.com/api/v1
    https://www.baidu.com/api/v2

*  路径，视网络上任何东西都是资源，均使用名词表示（可复数）

https://api.example.com/v1/zoos
    https://api.example.com/v1/animals
    https://api.example.com/v1/employees
    不是:https://api.example.com/v1/delete_one_book

*  method 来表示增删查改

https://api.example.com/v1/books  get请求,获取所有书
    https://api.example.com/v1/books  post请求,新增一本书
    https://api.example.com/v1/book/1  delete请求,删除一本书
    https://api.example.com/v1/book/1  delete请求,获取id为1的这本书
    https://api.example.com/v1/book/1  put/patch请求,修改id为1的这本书

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

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

*  状态码

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）
    201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功
    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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功

*  错误处理，应返回错误信息，error当做key

{
        error: "Invalid API key"
    }

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

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

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

{"link": {
      "rel":   "collection https://www.example.com/zoos",
      "href":  "https://api.example.com/zoos",
      "title": "List of zoos",
      "type":  "application/vnd.yourformat+json"
    }}

## 基于Django实现 ##

### 路由系统 ###

urlpatterns = [
        url(r'^users/$', views.Users.as_view()),
        url(r'^users2/$', views.user2),
    ]

### 视图函数 ###

import json
    def  user2(request):
        if request.method=='GET':
            dic = {'status':200,'name': 'wwl2', 'age': 24}
            return HttpResponse(json.dumps(dic))
        elif request.method=='POST':
            dic = {'status': 200, 'msg': '修改成功'}
            return JsonResponse(dic)
    
    class Users(View):
        def get(self, request):
            dic = {'status':200,'name': 'wwl', 'age': 24}
            return HttpResponse(json.dumps(dic))
    
        def post(self, request):
            dic = {'status': 200, 'msg': '修改成功'}
            return JsonResponse(dic)

转载于:https://www.cnblogs.com/wanlei/p/10429232.html

[HTTPS]: http://www.ruanyifeng.com/blog/2014/02/ssl_tls.html