一切皆是资源,操做只是请求方式html
在url 中体现出操做行为数据库
/books/ books /books/add/ addbook /books/(\d+)/change/ changebook /books/(\d+)/delete/ delbook
不在url中体现操做行为,在视图函数区分,(提交,查看)django
对于须要令传入参数的url 在作区分 (编辑,删除)编程
/books/ -----get books ----- 返回当前全部数据 /books/ -----post books ----- 返回提交数据 /books/(\d+)-----get bookdetail ----- 返回当前查看的单条数据 /books/(\d+)-----put bookdetail ----- 返回更新数据 /books/(\d+)-----delete bookdetail ----- 返回空
即 URL 设计区别json
原来都是在 url 中设置。这样能够大大减小 url 的数量api
GET / POST / PUT / DELETE / PATCH
视 URL 为资源缓存
http://www.yangtuo.com
http://v1.yangtuo.com http://v2.yangtuo.com
不单单局限于 URL 中,也能够经过请求头之类的其余方法进行加入版本字段安全
http://api.yangtuo.com http://yangtuo.com/api/salary
https://www.yangtuo.com
core: 200 300 400 500 return HttpResponse("text_data",status=300)
常见状态码服务器
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://yangtuo.com/v2/api/salary?page=1&size=10
不一样视图都要返回具备标识意义的返回值restful
http://yangtuo.com/v2/api/salary
GET: 返回全部的列表
[{"id":1,"title":"lala"},
{"id":2,"title":"wawa"},
{"id":3,"title":"kaka"},]
POST: 返回新增的数据
{"id":1,"title":"tuotuo"}
PUT: 更新所有的数据 返回更新数据
PATCH: 更新少许数据 返回更新数据
DELETE: 删除数据 返回空
若是存在异常要基于错误码返回错误信息
{
code:10000, error:"xxx错了"
}
返回信息的时候加上 api ,即返回的数据最好加上 URL 信息这样方便下面操做
{"link": { "rel": "collection https://www.example.com/zoos", "href": "https://api.example.com/zoos", "title": "List of zoos", "type": "application/vnd.yourformat+json" }}
记忆方式
URL 5个 https(推荐用https)://v2(版本)/yangtuo.com(域名为资源)/api(体现api)/salary?page=1&size=10(有条件) 请求 1 个 根据method 不一样,进行不一样的操做 返回 4个 返回值 响应式设置状态码 返回错误信息 返回信息的时候加上api
帮助咱们快速开发基于 restful 规范的接口
- 能够经过as_view传参数,根据请求方式不一样执行相应的方法
- 能够在url中设置一个结尾,相似于: .json
- 帮助开发者提供了一些类,并在类中提供了多个方法以供咱们使用。
- 在url中设置version参数,用户请求时候传入参数。在request.version中获取版本,根据版本不一样作不一样处理
- 写一个类并注册到认证类,在类的的authticate方法中编写认证逻辑。
- 认证成功(user,auth)
- raise AuthticateFaild(....)
- None
- 写一个类并注册到权限类,在类的的has_permission方法中编写认证逻辑。
- True
- False
- 写一个类并注册到频率类,在类的的 allow_request/wait 方法中编写认证逻辑。
allow_request
- True
- False 若是返回False,那么就要执行wait
- 根据ContentType请求头,选择不一样解析器对 请求体中的数据进行解析。
POST /index/ http1.1.\r\nhost:11.11.11.11\r\nContent-Type:url-formendo.... \r\n\r\nuser=alex&age=123
POST /index/ http1.1.\r\nhost:11.11.11.11\r\nContent-Type:application/json\r\n\r\n{....}
- 对从数据库中获取到的数据进行分页处理: SQL -> limit offset
- 根据页码
http://www.luffycity.com/api/v1/student/?page=1&size=10
- 根据索引
http://www.luffycity.com/api/v1/student/?offset=60&limit=10
- 根据加密
http://www.luffycity.com/api/v1/student/?page=erd6ops5
- 对queryset序列化以及对请求数据格式校验。
- 根据URL中传入的后缀,决定在数据如何渲染到到页面上。
- 基于序列化组件完成序列化后的 data 进行 Response
页码越大速度越慢,为何以及如何解决? 缘由: 页码越大向后须要扫描的行数越多,由于每次都是从0开始扫描。 解决: - 限制显示的页数 - 记录当前页数据ID最大值和最小值,再次分页时,根据ID现行筛选,而后再分页。
发送请求--> Django的wsgi--> 中间件--> 路由系统_执行CBV的as_view(),就是执行内部的dispath方法--> 在执行dispath以前,有版本分析 和 渲染器--> 在dispath内,对request封装--> 版本--> 认证--> 权限--> 限流--> 视图--> 若是视图用到缓存( request.data or request.query_params )就用到了 解析器--> 视图处理数据,用到了序列化(对数据进行序列化或验证) --> 视图返回数据能够用到分页