feat: 新增bk_plugin模块下的apis通用视图接口

Author: Xinkai Yi

bk-plugin-framework/bk_plugin_framework/serializers.py

@@ -2,7 +2,7 @@
 from rest_framework import serializers
 
 
-def enveloper(serializer_class, many: bool = False):
+def standard_response_enveloper(serializer_class, many: bool = False):
     """统一响应包装器"""
     component_name = "Enveloped{}{}".format(
         serializer_class.__name__.replace("Serializer", ""),

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/callback.py

@@ -19,12 +19,11 @@
 from django.utils.decorators import method_decorator
 from drf_spectacular.utils import extend_schema
 from rest_framework import serializers
-from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework.runtime.callback.api import callback, parse_callback_token
-from bk_plugin_framework.serializers import enveloper
+from bk_plugin_framework.serializers import standard_response_enveloper
 
 logger = logging.getLogger("bk_plugin")
 
@@ -45,8 +44,9 @@ class PluginCallback(APIView):
 
     @extend_schema(
         summary="插件回调",
+        operation_id="callback",
         request=PluginCallbackParamsSerializer,
-        responses={200: enveloper(PluginCallbackResponseSerializer)},
+        responses={200: standard_response_enveloper(PluginCallbackResponseSerializer)},
         extensions=gen_apigateway_resource_config(
             is_public=True,
             allow_apply_permission=True,
@@ -57,7 +57,6 @@ class PluginCallback(APIView):
             match_subpath=False,
         ),
     )
-    @action(methods=["POST"], detail=True)
     def post(self, request, token):
         logger.info("[plugin callback]token=({}),body={}".format(token, request.body))
 

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/detail.py

@@ -16,12 +16,11 @@
 from django.utils.decorators import method_decorator
 from drf_spectacular.utils import extend_schema
 from rest_framework import permissions, serializers, status
-from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework.hub import VersionHub
-from bk_plugin_framework.serializers import enveloper
+from bk_plugin_framework.serializers import standard_response_enveloper
 from bk_plugin_framework.services.bpf_service.api.serializers import (
     StandardResponseSerializer,
 )
@@ -70,7 +69,7 @@ class Detail(APIView):
 
     @extend_schema(
         summary="Get plugin detail for specific version",
-        responses={200: enveloper(DetailResponseSerializer)},
+        responses={200: standard_response_enveloper(DetailResponseSerializer)},
         extensions=gen_apigateway_resource_config(
             is_public=True,
             allow_apply_permission=True,
@@ -81,7 +80,6 @@ class Detail(APIView):
             match_subpath=False,
         ),
     )
-    @action(methods=["GET"], detail=True)
     def get(self, request, version):
         plugin_cls = VersionHub.all_plugins().get(version)
         if not plugin_cls:

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/invoke.py

@@ -17,14 +17,13 @@
 from django.utils.decorators import method_decorator
 from drf_spectacular.utils import extend_schema
 from rest_framework import serializers, status
-from rest_framework.decorators import action
 from rest_framework.exceptions import ValidationError
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework.hub import VersionHub
 from bk_plugin_framework.runtime.executor import BKPluginExecutor
-from bk_plugin_framework.serializers import enveloper
+from bk_plugin_framework.serializers import standard_response_enveloper
 from bk_plugin_framework.services.bpf_service.api.permissions import (
     ScopeAllowPermission,
 )
@@ -60,8 +59,9 @@ class Invoke(APIView):
 
     @extend_schema(
         summary="插件调用",
+        operation_id="invoke",
         request=InvokeParamsSerializer,
-        responses={200: enveloper(InvokeResponseSerializer)},
+        responses={200: standard_response_enveloper(InvokeResponseSerializer)},
         extensions=gen_apigateway_resource_config(
             is_public=True,
             allow_apply_permission=True,
@@ -72,7 +72,6 @@ class Invoke(APIView):
             match_subpath=False,
         ),
     )
-    @action(methods=["POST"], detail=True)
     def post(self, request, version):
         plugin_cls = VersionHub.all_plugins().get(version)
         if not plugin_cls:

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/logs.py

@@ -16,12 +16,11 @@
 from django.utils.decorators import method_decorator
 from drf_spectacular.utils import extend_schema
 from rest_framework import permissions, serializers
-from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework.runtime.loghub.models import LogEntry
-from bk_plugin_framework.serializers import enveloper
+from bk_plugin_framework.serializers import standard_response_enveloper
 from bk_plugin_framework.services.bpf_service.api.serializers import (
     StandardResponseSerializer,
 )
@@ -46,7 +45,7 @@ class Logs(APIView):
 
     @extend_schema(
         summary="Get plugin execution log with trace_id",
-        responses={200: enveloper(LogsResponseSerializer)},
+        responses={200: standard_response_enveloper(LogsResponseSerializer)},
         extensions=gen_apigateway_resource_config(
             is_public=True,
             allow_apply_permission=True,
@@ -57,6 +56,5 @@ class Logs(APIView):
             match_subpath=False,
         ),
     )
-    @action(methods=["GET"], detail=True)
     def get(self, request, trace_id):
         return Response({"result": True, "data": {"log": LogEntry.objects.get_plain_log(trace_id)}, "message": ""})

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/meta.py

@@ -18,13 +18,12 @@
 from django.utils.decorators import method_decorator
 from drf_spectacular.utils import extend_schema
 from rest_framework import permissions, serializers
-from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework import __version__ as bpf_version
 from bk_plugin_framework.hub import VersionHub
-from bk_plugin_framework.serializers import enveloper
+from bk_plugin_framework.serializers import standard_response_enveloper
 from bk_plugin_framework.services.bpf_service.api.serializers import (
     StandardResponseSerializer,
 )
@@ -64,7 +63,7 @@ class Meta(APIView):
 
     @extend_schema(
         summary="Get plugin meta info",
-        responses={200: enveloper(MetaResponseSerializer)},
+        responses={200: standard_response_enveloper(MetaResponseSerializer)},
         extensions=gen_apigateway_resource_config(
             is_public=True,
             allow_apply_permission=True,
@@ -75,7 +74,6 @@ class Meta(APIView):
             match_subpath=False,
         ),
     )
-    @action(methods=["GET"], detail=True)
     def get(self, request):
         try:
             meta_module = import_module("bk_plugin.meta")

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/plugin_api_dispatch.py

@@ -22,12 +22,11 @@
 from django.utils.decorators import method_decorator
 from drf_spectacular.utils import extend_schema
 from rest_framework import serializers, status
-from rest_framework.decorators import action
 from rest_framework.exceptions import ValidationError
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
-from bk_plugin_framework.serializers import enveloper
+from bk_plugin_framework.serializers import standard_response_enveloper
 from bk_plugin_framework.services.bpf_service.api.permissions import (
     ScopeAllowPermission,
 )
@@ -81,8 +80,9 @@ class PluginAPIDispatch(APIView):
 
     @extend_schema(
         summary="插件API分发",
+        operation_id="plugin_api_dispatch",
         request=PluginAPIDispatchParamsSerializer,
-        responses={200: enveloper(PluginAPIDispatchResponseSerializer)},
+        responses={200: standard_response_enveloper(PluginAPIDispatchResponseSerializer)},
         extensions=gen_apigateway_resource_config(
             is_public=True,
             allow_apply_permission=True,
@@ -93,7 +93,6 @@ class PluginAPIDispatch(APIView):
             match_subpath=False,
         ),
     )
-    @action(methods=["POST"], detail=True)
     def post(self, request):
         data_serializer = PluginAPIDispatchParamsSerializer(data=request.data)
         try:

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/schedule.py

@@ -17,12 +17,11 @@
 from django.utils.decorators import method_decorator
 from drf_spectacular.utils import extend_schema
 from rest_framework import permissions, serializers
-from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework.runtime.schedule.models import Schedule as ScheduleModel
-from bk_plugin_framework.serializers import enveloper
+from bk_plugin_framework.serializers import standard_response_enveloper
 from bk_plugin_framework.services.bpf_service.api.serializers import (
     StandardResponseSerializer,
 )
@@ -58,7 +57,7 @@ class Schedule(APIView):
     @extend_schema(
         summary="获取插件调度详情",
         request=ScheduleParamsSerializer,
-        responses={200: enveloper(ScheduleResponseSerializer)},
+        responses={200: standard_response_enveloper(ScheduleResponseSerializer)},
         extensions=gen_apigateway_resource_config(
             is_public=True,
             allow_apply_permission=True,
@@ -69,7 +68,6 @@ class Schedule(APIView):
             match_subpath=False,
         ),
     )
-    @action(methods=["GET"], detail=True)
     def get(self, request, trace_id):
         try:
             s = ScheduleModel.objects.get(trace_id=trace_id)