rest_framework之版本控制

人生不如戏

发布于 2019-02-13 16:25:21

5590

发布于 2019-02-13 16:25:21

简介

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

本文参与腾讯云自媒体分享计划，分享自作者个人站点/博客。

原始发表：2018-05-29 ，如有侵权请联系 cloudcommunity@tencent.com 删除

http

本文分享自作者个人站点/博客前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体分享计划，欢迎热爱写作的你一起参与！

http

登录后参与评论

0 条评论

热度