rest_framework之版本控制

簡介

API版本控制能夠用來在不一樣的客戶端使用不一樣的行爲。REST框架提供了大量不一樣的版本設計。 
版本控制是由傳入的客戶端請求決定的，而且可能基於請求URL，或者基於請求頭。 
有許多有效的方法達到版本控制的目的。特別是爲具備多個客戶的長期系統工程進行設計時，沒有版本控制的系統也是能夠的。

REST框架的版本控制

當使用版本控制時，request.version屬性（字符串）與客戶端請求的版本一致。 
默認狀況下，沒有使用版本控制，request.version將會返回None 
1 基於不一樣版本進行不一樣的行爲

def get_serializer_class(self):
    if self.request.version == 'v1':
        return AccountSerializerVersion1
    return AccountSerializer

2 改變URL

from rest_framework.reverse import reverse

reverse('bookings-list', request=request)

reverse函數將應用於轉換任何請求版本的URL。 
- NamespacedVersioning：相似命名空間

'v1:bookings-list'
http://example.org/v1/bookings/.

3 QueryParameterVersioning：查詢參數

http://example.org/bookings/?version=1.0

4 版本控制和超連接序列化器 
當使用超連接的序列化器和基於URL的版本控制方案時，確保將請求做爲序列化器的上下文。

def get(self, request):
    queryset = Booking.objects.all()
    serializer = BookingsSerializer(queryset, many=True, context={'request': request})
    return Response({'all_bookings': serializer.data})

版本配置

全局配置

1. 添加配置

 REST_FRAMEWORK = {
              
              .... 
              
              'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.URLPathVersioning',
              'ALLOWED_VERSIONS':['v1','v2'], # 容許的版本
              'VERSION_PARAM':'version', # 參數
              'DEFAULT_VERSION':'v1', # 默認版本
              ....
       }

2. 設置路由 

 BeesCity/urls.py
              urlpatterns = [
                     #url(r'^admin/', admin.site.urls),
                     url(r'^api/(?P<version>\w+)/', include('api.urls')),
              ]
       
       api/urls.py 
              urlpatterns = [
                     url(r'^course/$', course.CourseView.as_view()),
              ]

3. 傳遞版本信息

http://127.0.0.1:8000/api/v1/course/

4. 獲取版本 

request.version 獲取版本  

局部配置

除非明確設置，不然DEFAULT_VERSIONING_CLASS值爲None.此例中request.version將會始終返回None 
您還能夠在一個單獨的視圖上設置版本控制方案。一般，您不須要這樣作，由於在全局範圍內使用一個版本控制方案更有意義。若是您確實須要這樣作，請使用versioning_class屬性。

from rest_framework.versioning import QueryParameterVersioning

class Course(APIView):
    versioning_class = QueryParameterVersioning

　　這個時候能夠用過url傳參的方式來傳遞版本信息，如：

http://127.0.0.1:8000/api/course/?version=1