首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >用于在DRF中记录API的django-rest-swagger请求和响应模式

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

Stack Overflow用户
提问于 2018-08-10 05:28:43
回答 2查看 3.4K关注 0票数 0

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

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

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

以下是视图代码示例

代码语言:javascript
复制
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')

现在,我可以为每个端点添加描述。

我想添加请求和响应模式,如下所示

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

EN

回答 2

Stack Overflow用户

发布于 2018-08-10 07:21:33

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

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

票数 2
EN

Stack Overflow用户

发布于 2018-08-10 07:21:05

我知道我没有直接回答你的问题,但我想建议你尝试一个很棒的包,它可以在每个方向上进行定制:drf-yasg。您没有义务使用泛型rest_framework内容或序列化程序。

您可以直接跳转到Custom schema generation

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/51776014

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档