Flask與DjangoRESTful API版本控制

在Flask和Django RESTful API中實現版本控制是一個重要的實踐，它可以幫助你在不破壞現有客戶端的情況下，逐步引入新的功能或修改現有功能。以下是在Flask和Django RESTful API中實現版本控制的方法。

Flask 版本控制

在Flask中，你可以通過多種方式實現版本控制：

1. URL版本控制： 你可以在URL中直接指定版本號。例如：

   from flask import Flask, jsonify
   
   app = Flask(__name__)
   
   @app.route('/api/v1/resource', methods=['GET'])
   def get_resource_v1():
       return jsonify({"version": "1", "data": "Resource data"})
   
   @app.route('/api/v2/resource', methods=['GET'])
   def get_resource_v2():
       return jsonify({"version": "2", "data": "Updated resource data"})
   
   if __name__ == '__main__':
       app.run(debug=True)
   

2. 請求頭版本控制： 你可以通過自定義請求頭來指定版本號。例如：

   from flask import Flask, request, jsonify
   
   app = Flask(__name__)
   
   @app.route('/resource', methods=['GET'])
   def get_resource():
       version = request.headers.get('Accept-Version', '1')
       if version == '1':
           return jsonify({"version": "1", "data": "Resource data"})
       elif version == '2':
           return jsonify({"version": "2", "data": "Updated resource data"})
       else:
           return jsonify({"error": "Unsupported version"}), 400
   
   if __name__ == '__main__':
       app.run(debug=True)
   

3. 藍圖版本控制： 你可以使用Flask的藍圖（Blueprint）來組織不同版本的API。例如：

   from flask import Flask, Blueprint, jsonify
   
   app = Flask(__name__)
   v1_bp = Blueprint('v1', __name__)
   v2_bp = Blueprint('v2', __name__)
   
   @v1_bp.route('/resource', methods=['GET'])
   def get_resource_v1():
       return jsonify({"version": "1", "data": "Resource data"})
   
   @v2_bp.route('/resource', methods=['GET'])
   def get_resource_v2():
       return jsonify({"version": "2", "data": "Updated resource data"})
   
   app.register_blueprint(v1_bp, url_prefix='/api/v1')
   app.register_blueprint(v2_bp, url_prefix='/api/v2')
   
   if __name__ == '__main__':
       app.run(debug=True)
   

Django RESTful API 版本控制

在Django RESTful API中，你可以通過以下方式實現版本控制：

1. URL版本控制： 你可以在URL中直接指定版本號。例如：

   from rest_framework.decorators import api_view
   from rest_framework.response import Response
   
   @api_view(['GET'])
   def get_resource(request):
       version = request.query_params.get('version', '1')
       if version == '1':
           return Response({"version": "1", "data": "Resource data"})
       elif version == '2':
           return Response({"version": "2", "data": "Updated resource data"})
       else:
           return Response({"error": "Unsupported version"}, status=400)
   

2. 自定義請求頭版本控制： 你可以通過自定義請求頭來指定版本號。例如：

   from rest_framework.decorators import api_view, header_classes
   from rest_framework.response import Response
   from rest_framework.permissions import IsAuthenticated
   from rest_framework.authentication import TokenAuthentication
   
   @api_view(['GET'])
   @header_classes([TokenAuthentication])
   def get_resource(request):
       version = request.META.get('HTTP_ACCEPT_VERSION', '1')
       if version == '1':
           return Response({"version": "1", "data": "Resource data"})
       elif version == '2':
           return Response({"version": "2", "data": "Updated resource data"})
       else:
           return Response({"error": "Unsupported version"}, status=400)
   

3. 使用Django REST Framework的Router： 你可以使用Django REST Framework的Router來組織不同版本的API。例如：

   from rest_framework.routers import DefaultRouter
   from rest_framework.views import APIView
   from rest_framework.response import Response
   
   router = DefaultRouter()
   
   class ResourceV1View(APIView):
       def get(self, request):
           return Response({"version": "1", "data": "Resource data"})
   
   class ResourceV2View(APIView):
       def get(self, request):
           return Response({"version": "2", "data": "Updated resource data"})
   
   router.register(r'resource', ResourceV1View, basename='resource')
   router.register(r'resource/v2', ResourceV2View, basename='resource', basename_prefix='v2')
   
   urlpatterns = router.urls
   

通過這些方法，你可以在Flask和Django RESTful API中實現有效的版本控制，確保你的API在不同版本之間平滑過渡。