RESTful规范与django编写restful接口

一、什么是RESTful规范

①REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”

②REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态

③所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性

④对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

二、RESTful 规范（10条）

通俗点讲其实就是写前后端分离项目的一个数据交互的规范

①API与用户的通信协议，总是使用HTTPs协议。

②域名

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

　　https://example.org/api/ API很简单

③版本

　　URL，如：https://api.example.com/v1/

　　请求头跨域时，引发发送多次请求

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

　　https://api.example.com/v1/zoos

　　https://api.example.com/v1/animals

　　https://api.example.com/v1/employees

⑤通过method区分是什么操作*****

　　GET ：从服务器取出资源（一项或多项）

　　POST ：在服务器新建一个资源

　　PUT ：在服务器更新资源（客户端提供改变后的完整资源）

　　PATCH ：在服务器更新资源（客户端提供改变的属性）

　　DELETE ：从服务器删除资源

⑥过滤，通过在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：指定筛选条件

⑦返回状态码

状态码返回的是个json格式所以要定义一个字典比如{"status_code":100}，用JsonResponse返回

自己定义你的状态码，如果要有状态码的详情区分需要加上错误信息

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

面试题：
301和302的区别:
    字面上的区别就是301是永久重定向，而302是临时重定向。 
    当然，他们之间也是有共同点的，就是用户都可以看到url替换为了一个新的，然后发出请求。

    301：Moved Permanently 被请求的资源已永久移动到新位置，
        并且将来任何对此资源的引用都应该使用本响应返回的若干个URI之一。
        如果可能，拥有链接编辑功能的客户端应当自动把请求的地址修改为从服务器反馈回来的地址。
        除非额外指定，否则这个响应也是可缓存的。

    302:Found 请求的资源现在临时从不同的URI响应请求。
        由于这样的重定向是临时的，客户端应当继续向原有地址发送以后的请求。
        只有在Cache-Control或Expires中进行了指定的情况下，这个响应才是可缓存的。



    举例：
    301适合永久重定向
    　　301比较常用的场景是使用域名跳转。
    　　比如，我们访问 http://www.baidu.com 会跳转到 https://www.baidu.com，
        发送请求之后，就会返回301状态码，然后返回一个location，提示新的地址，浏览器就会拿着这个新的地址去访问。 


    302用来做临时跳转
    　　比如未登陆的用户访问用户中心重定向到登录页面。
    　　访问404页面会重新定向到首页。 


    301重定向和302重定向的区别
    　　302重定向只是暂时的重定向，搜索引擎会抓取新的内容而保留旧的地址，因为服务器返回302，所以，搜索搜索引擎认为新的网址是暂时的。
    　　301重定向是永久的重定向，搜索引擎在抓取新的内容的同时也将旧的网址替换为了重定向之后的网址。

⑧错误处理，应返回错误信息

　　{"status_code":101,'msg':'用户名错误'}

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

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

⑩返回结果中提供链接，连向其他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编写restful接口

视图函数

前端显示

posted @ 2019-07-01 22:34 TianShu Views(429) Comments(0) Edit 收藏举报

刷新页面返回顶部

天枢