Yet another Swagger generator

💡 drf_yasg

파라미터가 필요한 GET요청을 할 때는 스키마를 작성해주어야 한다고 한다.

만약, 파마리터가 따로 없다면, class 와 def 사이에 있는 코드는 작성하지 않아도 된다.

상속받는 클래스는 APIView이어야 한다. (APIView를 상속받는 클래스도 가능)

class VerifyEmail(views.APIView):
    serializer_class = EmailVerificationSerializer
    
    # 파라미터 설정.
    token_param_config = openapi.Parameter(
        'token',
        in_=openapi.IN_QUERY, 
        description='Bearer token',
        type=openapi.TYPE_STRING
    )

    @swagger_auto_schema(manual_parameters=[token_param_config])
    def get(self, request):
        pass

---

📚 References

• drf_ysag installation
• @swagger_auto_schema
• 참고 블로그