DjangoRestFramework 实现 DRF UI 动态参数输入与外部API请求
DRF 动态参数输入与响应格式优化实现方案
现有代码的基础可优化点
DefaultRouter仅用于自动路由绑定ViewSet类,直接注册APIView属于无效配置,不会生成对应路由- 代码中使用的
{{REFERENCE_NO}}是Django模板占位符,在Python视图逻辑中不会自动替换值,目前仅能通过手动修改代码填充占位符的方式发起请求 - 直接将
requests库返回的原始Response对象传入DRF的Response类,会导致序列化逻辑异常,无法正确解析外部接口的返回内容 - 未定义接口入参的规则声明,DRF可浏览UI无法识别需要接收的参数类型,因此无法自动渲染出对应的输入表单
一、实现DRF Web端动态输入交易参考号
要让DRF自带的可浏览UI自动生成参数输入框,核心是通过序列化器定义接口的入参规则,让DRF前端组件自动识别渲染表单,整个过程不需要额外编写前端代码:
- 新建
serializers.py文件,定义入参校验规则:# serializers.py from rest_framework import serializers class PaystackVerifySerializer(serializers.Serializer): transaction_reference = serializers.CharField( required=True, label="交易参考号", help_text="输入需要调用Paystack校验接口查询的交易参考号" ) - 改造视图逻辑,抽离公共请求逻辑、接入入参校验、动态拼接请求URL:
其中硬编码的密钥需要挪到Django配置文件中,避免代码泄露风险;所有入参全部走序列化器校验,空值、非法值会直接在UI端给出错误提示,无需额外写判断逻辑。# views.py import requests from rest_framework.views import APIView from rest_framework.response import Response from .serializers import PaystackVerifySerializer from django.conf import settings class Paystack(APIView): # 绑定入参序列化器,DRF可浏览UI会自动识别渲染输入表单 serializer_class = PaystackVerifySerializer def _call_paystack_verify(self, reference_no): # 抽离公共的外部请求逻辑,避免GET/POST方法重复写代码 base_url = "https://api.paystack.co/transaction/verify/" headers = { 'Authorization': f'Bearer {settings.PAYSTACK_SECRET_KEY}', 'Content-Type': 'application/json' } try: resp = requests.get( f"{base_url}{reference_no}", headers=headers, timeout=10 ) resp.raise_for_status() return { "request_success": True, "paystack_status_code": resp.status_code, "response_data": resp.json() } except Exception as e: return { "request_success": False, "error_msg": str(e) } def get(self, request): # 从GET请求的查询参数里获取交易参考号 param_serializer = self.serializer_class(data=request.query_params) param_serializer.is_valid(raise_exception=True) reference_no = param_serializer.validated_data["transaction_reference"] return Response(self._call_paystack_verify(reference_no)) def post(self, request): # 从POST请求的表单/JSON体里获取交易参考号 param_serializer = self.serializer_class(data=request.data) param_serializer.is_valid(raise_exception=True) reference_no = param_serializer.validated_data["transaction_reference"] return Response(self._call_paystack_verify(reference_no)) - 修正路由配置,删掉无效的router注册逻辑:
# urls.py from django.urls import path from .views import Paystack urlpatterns = [ path('paystack/', Paystack.as_view(), name='paystack'), ]
二、优化DRF UI端的响应展示
上述视图改造逻辑已经覆盖了响应优化的需求,不需要额外配置前端样式,核心优化点包括:
- 移除了原始requests Response对象的透传,将外部接口返回的JSON内容解析为结构化的Python字典后传入DRF,DRF前端组件会自动将返回的JSON渲染成带语法高亮、层级折叠的展示块,解决之前字段杂乱、无法快速定位核心信息的问题
- 对返回结构做了分层封装,将请求是否成功、外部接口状态码、原始返回数据拆分为独立层级,用户不需要在大段嵌套JSON中反复翻找核心状态
- 增加了请求超时、接口异常的兜底捕获逻辑,外部接口请求失败时会返回结构化的错误提示,不会直接抛出服务端500错误
最终打开DRF可浏览UI页面时,GET和POST请求的面板都会自动渲染出带标签、提示文本的交易参考号输入框,填入值提交后,就能动态触发Paystack接口调用,返回格式化后的友好JSON结果。
内容的提问来源于stack exchange,提问作者coderboy
相关产品推荐
相关产品推荐

