django - drf-yasg:如何隐藏 Django rest 框架模式?
问题描述
我将drf_yasg swagger用于我的 Django API。我想知道如何轻松禁用模式和模型。 截屏
这是我的代码:
from .models import Articles
from .serializers import ArticlesSerializer
from rest_framework import viewsets
from rest_framework.response import Response
from rest_framework import status
from rest_framework.authentication import SessionAuthentication,TokenAuthentication, BasicAuthentication
from rest_framework.views import APIView
from rest_framework.permissions import IsAuthenticated
from rest_framework.parsers import JSONParser
from django.utils.decorators import method_decorator
from django.contrib.auth import authenticate, login, logout
from rest_framework.decorators import api_view
from drf_yasg.utils import swagger_auto_schema
from drf_yasg import openapi
@swagger_auto_schema(methods=['get'], operation_description="description", manual_parameters=[
openapi.Parameter('category', openapi.IN_QUERY, "category1, category2, category3", type=openapi.TYPE_STRING),
openapi.Parameter('name', openapi.IN_QUERY, "full name", type=openapi.TYPE_STRING),
], responses={
200: openapi.Response('Response', ArticlesSerializer),
}, tags=['Articles'])
# desactivate POST methode on swagger
@swagger_auto_schema(method='POST', auto_schema=None)
@api_view(['GET','POST'])
def articles(request):
"""
List all articles.
"""
if request.user.is_authenticated:
if request.method == 'GET':
articles = Articles.objects.all()
serializer = ArticlesSerializer(Articles, many=True)
return JsonResponse(serializer.data, safe=False)
elif request.method == 'POST':
data = JSONParser().parse(request)
serializer = ArticlesSerializer(data=data)
if serializer.is_valid():
serializer.save()
return JsonResponse(serializer.data, status=201)
return JsonResponse(serializer.errors, status=400)
return JsonResponse({"status":"403", "message":"User not authenticated"})
如果我添加这个
class UserList(APIView):
swagger_schema = None
我得到了错误:
AssertionError: `method` or `methods` can only be specified on @action or @api_view views
代码编辑:文章功能非常简单,与 API 无关,只有 Python 代码。
这里的views 类也很简单。
类视图:
from django.db import models
class Articles(models.Model):
STATUS = (
(1, 'PENDING'),
(2, 'COMPLETED'),
(3, 'DECLINED'),
(0, 'BANNED'),
)
name = models.CharField(max_length=100)
...
status = models.PositiveSmallIntegerField(
choices = STATUS,
default = 1,
)
解决方案
我只有一半的答案,为了禁用模型,我将它添加到我的setting.py
SWAGGER_SETTINGS = {
'DEFAULT_FIELD_INSPECTORS': [
'drf_yasg.inspectors.CamelCaseJSONFilter',
'drf_yasg.inspectors.InlineSerializerInspector',
'drf_yasg.inspectors.RelatedFieldInspector',
'drf_yasg.inspectors.ChoiceFieldInspector',
'drf_yasg.inspectors.FileFieldInspector',
'drf_yasg.inspectors.DictFieldInspector',
'drf_yasg.inspectors.SimpleFieldInspector',
'drf_yasg.inspectors.StringDefaultFieldInspector',
],
}
推荐阅读
- javascript - 如何更新 JavaScript 生成的 HTML 变量
- python - 如何从字符串中去除引号并仅使用字符作为变量名?
- python - 无法使用 python SDK 在 ECS fargate 作业上发送邮件,并在另一个 aws 帐户中使用经过验证的 SES 的凭据
- python - 如何彼此相邻显示seaborn地块?使用 pyplot 风格(不是 OO)?
- python-3.x - 如何根据数据框python的前一行更新行
- apache-kafka - Kafka Streams 是否可能在不同节点有不同的上下文时间?
- regression - 将 teffects 结果从 Stata 输出到 Excel 的最佳方法?
- sql - 如何以格式 00:00:00 为时间列格式化时间值
- android - 我正在使用带有gridview的cardview,在设计面板中我的编码输出还可以,但是当我在任何Android手机上运行它时它都无法正常工作
- c - C语言问答游戏倒计时