01-Django REST framwork 板块( 01-REST规范)_django目录规范-优快云博客

文章目录

一、RESTFUL API 设计

API与用户的通信协议，总是使用HTTPs协议。
域名
- https://api.example.com 尽量将API部署在专用域名（会存在跨域问题，使用jsonp来解决）
- 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：指定筛选条件
状态码

状态码与信息结合{“code”:1000,"msg”:“xxx”}，
可以与前端商量用状态码还是code（自己定义）

# 几个常用的HTTP状态码
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

二、知识点

1. 10个restfull规范，分析记忆

2. 常见重点分析

a. 用过rest framework，那么写视图的时候，都继承过哪些类？

b. 用过比较接近原生的类，还可以继承原生的其他子类

c. 哪里用过面向对象的封装？

-  rest framework中的request就是对Django的request进行的封装

d. 哪里用过面向对象的继承？

- rest_framework的view继承自APIview

e. 多态、鸭子类型？

 -  只要你会鸭子呱呱叫，我就认为你是鸭子类型
 - 只要你含有  .方法   ，都允许

     class WX:
         def  send():
             pass
     
     class Email():
         def  send():
             pass

     class Msg():
         def  send():
             pass
             
     def func(arg):
         arg.send()
             
     obj = Email()
     func(obj)
     
     # 只要能send，不管是什么，都能允许。