基于Django的Rest Framework框架的RESTful规范研究
一、什么是RESTful规范
总的来说:RESTful规范就是一个非技术,人为约定的一个面向资源的架构理念。
- REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
- REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态
- REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
- 所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
- 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)
二、RESTful规范的API设计
- API与用户的通信协议,总是使用HTTPs协议。
- 域名
- 版本
- 路径:这里的路径通常使用名词,且请求的都是资源(可以是复数)
- 请求方法(get,post,put,patch等等),包含了所有的请求方式
- 过滤:相当于在看路径上用k=v的方式搭载请求条件
- 状态码
- 错误的信息:包含error作为key
- 返回结果:针对不同的操作,都有相应的返回结果。可以不参照,只是规范罢了
- Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。
三、基于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': 'lqz2', 'age': 18} 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': 'lqz', 'age': 18} return HttpResponse(json.dumps(dic)) def post(self, request): dic = {'status': 200, 'msg': '修改成功'} return JsonResponse(dic)