Django 뷰에서 'me'를 사용하는 쿼리 파라미터 처리 (방식 차이)

 

장고에서 GET LIST 요청에서 ?user=me 처리하는 방식과 GET DETAIL 요청에서 pk 대신 me를 입력하는 방식이 어떻게 다른가

에 대해서 이야기해보려고 합니다.

 

GET LIST 요청에서 /v1/push/?user=me 처리하기

 

목록 엔드포인트에서는 user=me가 쿼리 파라미터로 전달될 때

현재 사용자와 관련된 객체(여기서는 push 인스턴스)만 포함하도록 쿼리셋을 필터링하는 것이 목표입니다.

class PushFilter(django_filters.FilterSet):
    user = django_filters.CharFilter(method="user_filter")

    def user_filter(self, queryset, name, value):
        if value:
            if value == "me":
                return queryset.filter(user=self.request.user)
            else:
                raise ParseError("The value is incorrect. Enter 'me' or leave it empty.")

 

• 커스터마이징: user_filter 메서드는 필터링 로직을 정밀하게 제어할 수 있습니다.
• 에러 처리: 값이 me가 아닌 경우 ParseError를 발생시켜 클라이언트에게 잘못된 입력을 알립니다.
• 쿼리셋 필터링: 메서드는 쿼리셋에 직접 필터를 적용하여 인증된 사용자의 객체만 가져옵니다.

이 접근법은 사용자 기반으로 결과를 필터링하는 것이 일반적인 목록 엔드포인트에 최적화되어 있습니다.

GET DETAIL 요청에서 /v1/user/{me} 처리하기

상세 엔드포인트에서는 를 사용하는 경우 단일 객체를 가져오는 로직을 재정의해야 합니다. 아래는 예제입니다:

lookup_value_regex = "me"

    def get_object(self):
        if self.kwargs.get("pk") == "me":
            return self.queryset.get(id=self.request.user.id)
        return super().get_object()

 

• 정규식 매칭: lookup_value_regex는 me가 기본 키로 유효한 입력임을 보장합니다.
• 커스텀 객체 가져오기: get_object 메서드를 재정의하여 pk가 me일 때 인증된 사용자의 객체를 반환합니다.
• 백업 로직: 다른 값에 대해서는 기본 get_object 로직이 유지됩니다.

 

이 접근법은 사용자와 연관된 단일 객체를 검색하는 데 초점이 맞춰진 엔드포인트에서 잘 작동합니다.

 

결과적으로

목적	사용자와 관련된 객체들로 쿼리셋 필터링	사용자에 대한 특정 객체 검색
구현 방식	커스텀 필터 메서드 사용	get_object 메서드 재정의
에러 처리	잘못된 입력에 대해 ParseError 발생	Django 기본 에러 처리에 의존
유연성	더 복잡한 필터링 로직 허용	단일 객체 식별로 제한
적용 범위	여러 객체에 대해 작동	단일 객체에 대해 작동

 

 

쿼리 파라미터(user=me) 또는 user_pk = me 로 처리하는 것은 API 응답을 '개인화'하는 사용자 친화적인 방법입니다.

 

이렇게 정리하고 보니까

조금 다른 의미이고 같은 카테고리로 묶을 수 있나? 싶기도 한데

 

처음 구현할 때는 조금 헷갈렸어서!

이 글로 이렇게 정리해둡니다 헤헷 🥰 🧚