TIL_20221205_drf-yasg 를 사용한 Swagger API 문서 자동화

- DRF 에서 Swagger 사용

Swagger 는 API 문서 자동화 툴

TIL_20221021

 

DRF 에서 drf-yasg 를 이용하면 손쉽게 swagger 문서 자동화 가능

 

1. drf-yasg 설치, settings.py 설정, urls.py 설정

2. serializer를 사용한 클래스형 view 에 @swagger_auto_schema 데코레이터 추가

 

프로젝트 적용을 위한 코드

class UserCreateView(APIView):
    @swagger_auto_schema(
        operation_summary='회원가입',
        # request_body=UserCreateSerializer
        request_body= openapi.Schema(
            type=openapi.TYPE_OBJECT,
            properties={
            'username': openapi.Schema(type=openapi.TYPE_STRING, max_length=128, min_length=1),
            'password' : openapi.Schema(type=openapi.TYPE_STRING, max_length=128, min_length=1),
            'password1' : openapi.Schema(type=openapi.TYPE_STRING, max_length=128, min_length=1)
        }),
        responses={201: openapi.Response(
            description="200 OK",
            schema=openapi.Schema(
                type=openapi.TYPE_OBJECT,
                properties={
                    'message':openapi.Schema('회원가입성공', type=openapi.TYPE_STRING, description="message")
                }
            ))}
        )
    def post(self, request):
        """
        가입 성공하면 토큰을 발행하지 않고 status 201 을 반환합니다.
        ---
        password 와 password1 을 입력값으로 받아 둘을 비교합니다.
        이미 존재하거나 입력 형식이 올바르지 않으면 {"message":{"에러메시지"}} 형식의 object와 status 400을 반환합니다.
        """
        
        # 가입시 password 1 과 password2 가 일치하지 않을 때
        if request.data['password'] != request.data['password1']:
            return Response({"message":f"password가 일치하지 않습니다."}, status=status.HTTP_400_BAD_REQUEST)
        
        # username 의 길이가 50자 이상이거나 없을때
        if len(request.data['username'])>50 or len(request.data['username'])<1:
            return Response({"message":f"username이 50자를 넘거나 1자이내일 수 없습니다"}, status=status.HTTP_400_BAD_REQUEST)
        
        # username 이 존재할때 
        exist_user = User.objects.filter(username=request.data['username'])
        if exist_user:
            return Response({"message":f"다른 아이디를 사용해주세요."}, status=status.HTTP_400_BAD_REQUEST)
        
        serializer = UserCreateSerializer(data=request.data)
        
        if serializer.is_valid():
            serializer.save()
            return Response({"message":"가입완료!"}, status=status.HTTP_201_CREATED)
        else:
            return Response({"message":f"${serializer.errors}"}, status=status.HTTP_400_BAD_REQUEST)

 

 

참조 :

drf-yasg - Yet another Swagger generator

dhhyy.log - drf-yasg 적용

Coder ToLoad - [Django-DRF] drf-yasg 를 활용한 Swagger 적용하기

개발일지 - django drf-yasg API 문서 커스텀하기 (@swagger_auto_schema) (FBV)

글쓰는 개발자 - Django - Swagger 연동하기 2편 - swagger parameter schema

크루저의 쉼터 - 문서화를 위한 drf-yasg 적용하기

장태순 - DRF-YASG API 문서 자동화 작성 part.2

개발자_마이쮸 - Swagger(스웨거) 사용해서 API 문서화 쉽게 하기. django에 swagger 적용해보기

 

 

---

오늘 한일

- 스와거 스터디

- 다른 장고 플젝들의 코드 스터디