一. 什么是RESTful
- REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
- REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态
- REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
- 所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
- 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)
二. RESTful API设计
- 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:指定筛选\
- 状态码
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
- 返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范。
GET /collection:返回资源对象的列表(数组) GET /collection/resource:返回单个资源对象 POST /collection:返回新生成的资源对象 PUT /collection/resource:返回完整的资源对象 PATCH /collection/resource:返回完整的资源对象 DELETE /collection/resource:返回一个空文档
- Hypermedia API 超媒体API
RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。
比如,当用户向api.example.com的根目录发出请求,会得到这样一个文档。
{"link": { "rel": "collection https://www.example.com/zoos", #表示这个API与当前网址的关系(collection关系,并给出该collection的网址) "href": "https://api.example.com/zoos", #API路径 "title": "List of zoos", #API的标题 "type": "application/vnd.yourformat+json" #返回类型 }}
Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。
{ "current_user_url": "https://api.github.com/user", "authorizations_url": "https://api.github.com/authorizations", // ... }
从上面可以看到,如果想获取当前用户的信息,应该去访问api.github.com/user,然后就得到了下面结果。
{ "message": "Requires authentication", "documentation_url": "https://developer.github.com/v3" }
三 基于Django实现API
1 FBV模式
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
1 from django.contrib import admin 2 3 from django.conf.urls import url, include 4 from app01 import views 5 from app02 import views 6 7 urlpatterns = [ 8 url('admin/', admin.site.urls), 9 # path('hosts/',views.HostView.as_view()), 10 url('app02/', include('app02.urls')) 11 ]
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
from app02 import views from django.conf.urls import url urlpatterns = [ url('^users/', views.users), url('^user/(\d+)', views.user), url('^users/', views.UsersView.as_view()), url('^user/', views.UserView.as_view()), ] app02/url
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
from django.shortcuts import render,HttpResponse # Create your views here. import json def users(request): response = {'code':1000,'data':None} #code用来表示状态,比如1000代表成功,1001代表 response['data'] = [ {'name':'harry','age':22}, {'name':'sam','age':10}, {'name':'jerry','age':11}, ] return HttpResponse(json.dumps(response)) #返回多条数据 def user(request,pk): if request.method =='GET': return HttpResponse(json.dumps({'name':'harry','age':11})) #返回一条数据 elif request.method =='POST': return HttpResponse(json.dumps({'code':1111})) #返回一条数据 elif request.method =='PUT': pass elif request.method =='DELETE': pass View
2 CBV模式
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
1 from app02 import views 2 from django.conf.urls import url 3 urlpatterns = [ 4 url('^users/', views.UsersView.as_view()), 5 url('^user/', views.UserView.as_view()), 6 ]
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
1 from django.views import View 2 class UsersView(View): 3 def get(self,request): 4 response = {'code':1000,'data':None} 5 response['data'] = [ 6 {'name': harry', 'age': 22}, 7 {'name': 'sam', 'age': 10}, 8 {'name': 'jerry', 'age': 11}, 9 ] 10 return HttpResponse(json.dumps(response),stutas=200) 11 12 class UserView(View): 13 def get(self,request,pk): 14 return HttpResponse(json.dumps({'name':'harry','age':11})) #返回一条数据 15 def post(self,request,pk): 16 return HttpResponse(json.dumps({'code':1111})) #返回一条数据 17 def put(self,request,pk): 18 pass 19 def delete(self,request,pk): 20 pass 21 22 views
四 基于Django Rest Framework框架实现
基于django实现的API许多功能都需要我们自己开发,这时候djangorestframework就给我们提供了方便,直接基于它来返回数据,总之原理都是一样的,就是给一个接口也就是url,让前端的人去请求这个url去获取数据,在页面上显示出来。这样也就达到了前后端分离的效果。下面我们来看看基于Django Rest Framework框架实现
具体使用方式参考:Django restframework的使用