[英]drf-yasg custom json body
How to customize drf-yasg schema in ClassBased django views?如何在 ClassBased django 视图中自定义 drf-yasg 模式?
I tried this part of code, but the generated swagger doesn't respect the change.我尝试了这部分代码,但生成的 swagger 不尊重更改。
class CustomView(CreateAPIView):
permission_classes = (IsAuthenticated,)
serializer_class = CustomSerializer
@swagger_auto_schema(request_body=openapi.Schema(
type=openapi.TYPE_OBJECT,
properties={
'phone': openapi.Schema(type=openapi.TYPE_STRING, description='string'),
'body': openapi.Schema(type=openapi.TYPE_STRING, description='string'),
}))
def create(self, request: Request, *args, **kwargs):
phone = request.data.get('phone')
body = request.data.get('body')
...
I found it, here is the right code:我找到了,这是正确的代码:
class CustomView(CreateAPIView):
permission_classes = (IsAuthenticated,)
serializer_class = CustomSerializer
http_method_names = ['post']
@swagger_auto_schema(request_body=openapi.Schema(
type=openapi.TYPE_OBJECT,
properties={
'phone': openapi.Schema(type=openapi.TYPE_STRING, description='The desc'),
'body': openapi.Schema(type=openapi.TYPE_STRING, description='The desc'),
}))
def post(self, request: Request, *args, **kwargs):
phone = request.data.get('phone')
body = request.data.get('body')
...
And for IN_QUERY type, like this:对于 IN_QUERY 类型,如下所示:
class CustomListView(ListAPIView):
permission_classes = (IsAuthenticated,)
serializer_class = CustomSerializer
http_method_names = ['get']
@swagger_auto_schema(manual_parameters=[
openapi.Parameter('obj_id', openapi.IN_QUERY,
type=openapi.TYPE_STRING),
])
def get(self, request, *args, **kwargs):
obj_id = self.request.DATA.get('obj_id')
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.