繁体   English   中英

django-rest-swagger的请求和响应模式,用于在DRF中记录API

[英]Request & Response schema of django-rest-swagger for documenting the API in DRF

我想使用DRF中的swagger生成器工具django-rest-swagger记录我的API

现在我正在通过继承rest_framework.views.APIView编写视图

我不想使用视图集或序列化器编写视图。

这是查看代码示例

from rest_framework.views import APIView
class SomeView(APIView):
  '''
  get:
    some description
  post:
    some other description
 '''
 def get(self, request, format=None):
    a = self.request.query_params.get('a',None)
    b = self.request.query_params.get('b',None)
    c = self.request.query_params.get('c',None)
    return Response({},status='200')

 def post(self, request, format=None):
    a = self.request.data.get('a',None)
    b = self.request.data.get('b',None)
    c = self.request.data.get('c',None)
    return Response({},status='201')

现在,我能够为每个端点添加描述。 swagger ui中每个api端点的描述

我想添加如下的请求和响应模式 摇摇欲坠的每个端点的模型架构

我想知道如何在不使用序列化器和视图集的情况下实现这一目标。

我相信,在django-rest-swagger的当前版本中,YAML文档字符串(如您的示例)已被弃用。 因此,我认为您将需要手动定义架构。 该文档包含一个如何在视图级别执行此操作的示例:

http://www.django-rest-framework.org/api-guide/schemas/#manualschema

我知道我不会直接回答您的问题,但是我建议您尝试一个可以在各个方向进行自定义的超棒软件包: drf-yasg 您没有义务使用通用的rest_framework内容或序列化程序。

您可以直接跳至自定义模式生成

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM