Django REST framework之版本实例以及版本源码流程分析

规范开发api（版本携带）

在实际开发过程中，因为一个版本不可能更新的太快，所以在访问api接口，需要携带版本号，以便区分当前是哪个版本

举例说明：

总路由：

from django.contrib import admin
from django.urls import path, re_path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path('api/', include('api.urls')),
]

分发路由：

#!/usr/bin/env python
# -*- coding:utf-8 -*-

from django.urls import path, re_path, include
from api import views

urlpatterns = [
    # 版本
    re_path('(?P<version>[v1|v2]+)/users/$', views.UserView.as_view(), name='user'),

]

表设计：

from django.db import models


class UserGroup(models.Model):
    title = models.CharField(max_length=32)


class UserInfo(models.Model):
    user_type_choices = (
        (1, '普通用户'),
        (2, 'vip'),
        (3, 'svip'),
    )
    user_type = models.IntegerField(choices=user_type_choices)
    username = models.CharField(max_length=32, unique=True)
    password = models.CharField(max_length=64)
    group = models.ForeignKey('UserGroup', on_delete=models.CASCADE)
    roles = models.ManyToManyField('Role')


class UserToken(models.Model):
    user = models.OneToOneField(to='UserInfo', on_delete=models.CASCADE)
    token = models.CharField(max_length=64)


class Role(models.Model):
    title = models.CharField(max_length=32)

 视图中有自定义版本类，当然有内置的版本类，推荐使用URLPathVersioning，在url上一目了然

from django.shortcuts import render, HttpResponse, reverse
from rest_framework.views import APIView
from rest_framework.versioning import BaseVersioning, QueryParameterVersioning, URLPathVersioning


# #######################################版本##########################
class ParamVersion(BaseVersioning):
    def determine_version(self, request, *args, **kwargs):
        version = request.query_params.get('version')
        return version


class UserView(APIView):

    # versioning_class = URLPathVersioning 全局中已设置

    def get(self, request, *args, **kwargs):
        # http://127.0.0.1:8000/api/users/?version=v1
        # version = request._request.GET.get('version')
        # print(version)
        # 获取版本
        print(request.version)
        # 获取处理版本对象
        print(request.versioning_scheme)
        # 反向生成url restframework
        print(request.versioning_scheme.reverse(viewname='user', request=request))

        # 反向生成url利用django
        print(reverse(viewname='user', kwargs={'version': 'v1'}))
        return HttpResponse('用户列表')

 全局配置：

REST_FRAMEWORK = {
    # 版本
    'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',
    'DEFAULT_VERSION': 'v1',
    'ALLOWED_VERSIONS': ['v1', 'v2'],
    'VERSION_PARAM': 'version',
} 

 版本源码流程分析

　　dispatch()->initialize_request->initial->determine_version->versioning_class若为None,则返回元组（None, None）；反之若有self.versioning_class()版本类实例化，若没有默认配置文件中读versioning_class = api_settings.DEFAULT_VERSIONING_CLASS，返回元组，当前版本类和版本对象

若要自定义版本类：继承BaseVersioning必须实现determine_version方法

配置字段： 

default_version = api_settings.DEFAULT_VERSION  

allowed_versions = api_settings.ALLOWED_VERSIONS  

version_param = api_settings.VERSION_PARAM

内置版本类

  常用：

BaseVersioning　　　*****

URLPathVersioning  *****

QueryParameterVersioning
NamespaceVersioning

不常用：

AcceptHeaderVersioning

HostNameVersioning