一、协议
API与用户的通讯协议,老是使用HTTPs协议。
二、域名
有两种方式
方式一: 尽可能将API部署在专用域名(会存在跨域问题)
https://api.example.com
方式二:若是肯定API很简单,不会有进一步扩展,能够考虑放在主域名下。
https://example.org/api/
三、版本(Versioning)
应该将API的版本号放入URL。
https://api.example.com/v1/
另外一种作法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种作法。
四、路径(Endpoint)
路径又称"终点"(endpoint),表示API的具体网址。
在RESTful架构中,每一个网址表明一种资源(resource),因此网址中不能有动词,只能有名词,并且所用的名词每每与数据库的表格名对应。通常来讲,数据库中的表都是同种记录的"集合"(collection),因此API中的名词也应该使用复数。
举例来讲,有一个API提供动物园(zoo)的信息,还包括各类动物和雇员的信息,则它的路径应该设计成下面这样。
https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees
五、HTTP动词
对于资源的具体操做类型,由HTTP动词表示。
经常使用的HTTP动词有下面五个(括号里是对应的SQL命令)。
GET(SELECT):从服务器取出资源(一项或多项)。即获取数据
POST(CREATE):在服务器新建一个资源。 即添加数据
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。即更新数据
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。即更新数据
DELETE(DELETE):从服务器删除资源 。即删除数据
还有两个不经常使用的HTTP动词。
HEAD:获取资源的元数据。
OPTIONS:获取信息,关于资源的哪些属性是客户端能够改变的。
下面是一些例子:
GET /zoos:列出全部动物园 POST /zoos:新建一个动物园 GET /zoos/ID:获取某个指定动物园的信息 PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的所有信息) PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息) DELETE /zoos/ID:删除某个动物园 GET /zoos/ID/animals:列出某个指定动物园的全部动物 DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物
六、过滤信息(Filtering)
若是记录数量不少,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
下面是一些常见的参数。
?limit=10:指定返回记录的数量 ?offset=10:指定返回记录的开始位置。 ?page=2&per_page=100:指定第几页,以及每页的记录数。 ?sortby=name&order=asc:指定返回结果按照哪一个属性排序,以及排序顺序。 ?animal_type_id=1:指定筛选条件
参数的设计容许存在冗余,即容许API路径和URL参数偶尔有重复。好比,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
七、状态码(status codes)
服务器向用户返回的状态码和提示信息,常见的有如下一些(方括号中是该状态码对应的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 - [*]:服务器发生错误,用户将没法判断发出的请求是否成功。
状态码的彻底列表参见这里。
八、错误处理(Error handling)
若是状态码是4xx,就应该向用户返回出错信息。通常来讲,返回的信息中将error做为键名,出错信息做为键值便可。
{ error: "Invalid API key" }
九、返回结果
针对不一样操做,服务器向用户返回的结果应该符合如下规范
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
方式一:FBV模式:

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 ]

1 from app02 import views 2 from django.conf.urls import url 3 urlpatterns = [ 4 url('^users/', views.users), 5 url('^user/(\d+)', views.user), 6 7 url('^users/', views.UsersView.as_view()), 8 url('^user/', views.UserView.as_view()), 9 ]

1 from django.shortcuts import render,HttpResponse 2 3 # Create your views here. 4 import json 5 6 def users(request): 7 response = {'code':1000,'data':None} #code用来表示状态,好比1000表明成功,1001表明 8 response['data'] = [ 9 {'name':'haiyan','age':22}, 10 {'name':'haidong','age':10}, 11 {'name':'haixiyu','age':11}, 12 ] 13 return HttpResponse(json.dumps(response)) #返回多条数据 14 15 def user(request,pk): 16 if request.method =='GET': 17 return HttpResponse(json.dumps({'name':'haiyan','age':11})) #返回一条数据 18 elif request.method =='POST': 19 return HttpResponse(json.dumps({'code':1111})) #返回一条数据 20 elif request.method =='PUT': 21 pass 22 elif request.method =='DELETE': 23 pass
方式二:CBV模式

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 ]

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': 'haiyan', 'age': 22}, 7 {'name': 'haidong', 'age': 10}, 8 {'name': 'haixiyu', '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':'haiyan','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
基于django实现的API许多功能都须要咱们本身开发,这时候djangorestframework就给咱们提供了方便,直接基于它来返回数据,总之原理都是同样的,就是给一个接口也就是url,让前端的人去请求这个url去获取数据,在页面上显示出来。这样也就达到了先后端分离的效果。下面咱们来看看基于Django Rest Framework框架实现
基于Django Rest Framework框架实现
一、自定义认证规则 ,详见连接
class MyAuthtication(BasicAuthentication): def authenticate(self, request): token = request.query_params.get('token') #注意是没有GET的,用query_params表示 if token == 'zxxzzxzc': return ('uuuuuu','afsdsgdf') #返回user,auth raise APIException('认证错误') class UserView(APIView): authentication_classes = [MyAuthtication,] def get(self,request,*args,**kwargs): print(request.user) print(request.auth) return Response('用户列表')
二、应用:主要是作Token验证 url中as_view里面调用了dispatch方法。
能够有两种方式
局部使用

1 from app01 import views 2 from django.conf.urls import url 3 urlpatterns = [ 4 # django rest framework 5 url('^hosts/', views.HostView.as_view()), 6 url(r'^auth/', views.AuthView.as_view()), 7 ]

1 from django.shortcuts import render,HttpResponse 2 # Create your views here. 3 from rest_framework.views import APIView 4 from rest_framework.views import Request 5 from rest_framework.authentication import SessionAuthentication 6 from rest_framework.authentication import BaseAuthentication, BasicAuthentication 7 from rest_framework.parsers import JSONParser 8 from rest_framework.negotiation import DefaultContentNegotiation 9 from rest_framework.exceptions import APIException 10 from app01 import models 11 from rest_framework.response import Response #友好的显示返回结果 12 13 14 15 class AuthView(APIView): 16 #auth登陆页面不须要验证,可设置 17 authentication_classes = [] #登陆页面不须要认证 18 def get(self,request): 19 ''' 20 接收用户名和密码 21 :param request: 22 :return: 23 ''' 24 ret = {'code':1000,'msg':None} 25 user = request.query_params.get('username') 26 27 pwd = request.query_params.get('password') 28 print(user,pwd) 29 obj = models.UserInfo.objects.filter(username=user,password=pwd).first() 30 print(obj) 31 if not obj : 32 ret['code'] = 1001 33 ret['msg'] = '用户名或者密码错误' 34 return Response(ret) 35 #建立随机字符串 36 import time 37 import hashlib 38 ctime = time.time() 39 key = '%s|%s'%(user,ctime) 40 m = hashlib.md5() 41 m.update(key.encode('utf-8')) 42 token = m.hexdigest() 43 44 #保存数据 45 obj.token = token 46 obj.save() 47 48 ret['token'] = token 49 return Response(ret) 50 51 class HostView(APIView): 52 def dispatch(self, request, *args, **kwargs): 53 return super().dispatch(request, *args, **kwargs) 54 55 # authentication_classes = [MyAuthtication] 56 57 def get(self,request,*args,**kwargs): 58 print(request.user,'dddddddddddffffff') 59 print(request.auth,'dddddddddd') 60 #原来的request,django.core.handlers.wsgi.WSGIRequest 61 #如今的request ,rest_framework.request.Request 62 # print(request) 63 authentication_classes = [SessionAuthentication,BaseAuthentication] 64 # print(self.authentication_classes) # [<class 'rest_framework.authentication.SessionAuthentication'>, 65 # <class 'rest_framework.authentication.BasicAuthentication'>] 66 return HttpResponse('GET请求的响应内容') 67 68 def post(self,request,*args,**kwargs): 69 pass 70 # try: 71 # try : 72 # current_page = request.POST.get("page") 73 # 74 # current_page = int(current_page) 75 # int("asd") 76 # except ValueError as e: 77 # print(e) 78 # raise #若是有raise说明本身处理不了了,就交给下面的一个去捕捉了 79 # except Exception as e: 80 # print("OK") 81 82 83 return HttpResponse('post请求的响应内容') 84 85 def put(self, request, *args, **kwargs): 86 return HttpResponse('put请求的响应内容')
全局使用

1 #注册认证类 2 REST_FRAMEWORK = { 3 'UNAUTHENTICATED_USER': None, 4 'UNAUTHENTICATED_TOKEN': None, #将匿名用户设置为None 5 "DEFAULT_AUTHENTICATION_CLASSES": [ 6 "app01.utils.MyAuthentication", 7 ], 8 }

1 from rest_framework.authentication import BaseAuthentication 2 from rest_framework.exceptions import APIException 3 from app02 import models 4 5 6 class MyAuthentication(BaseAuthentication): 7 def authenticate(self, request): 8 token=request.query_params.get('token') 9 print(token) 10 obj=models.UserInfo.objects.filter(token=token).first() 11 print(obj) 12 if obj: 13 return (obj.username,obj) 14 raise APIException('没有经过验证') 15 16 全局验证
注:rest_framework是一个app须要settings里面设置。
本文参考:http://www.ruanyifeng.com/blog/2014/05/restful_api.html