DRF2(N:1)

뚝딱뚝딱·2023년 10월 19일

django

Django

목록 보기

13/13

URL 및 HTTP request method 구성

DRF with N:1 Relation

1. GET-list

댓글 목록 조회를 위한 CommentSerializer 정의

url 작성

view 함수 작성

GET http://127.0.0.1:8000/api/v1/comments/ 응답 확인

2. GET-Detail

단일 댓글 조회를 위한 url 및 view 함수 작성

GET http://127.0.0.1:8000/api/v1/comments/1/ 응답 확인

3. POST

단일 댓글 생성을 위한 url 및 view 함수 작성

serailizer 인스턴스의 save() 메서드는 특정 Serializer 인스턴스를 저장하는 과정에서 추가 데이터를 받을 수 있음

POST http://127.0.0.1:8000/api/v1/articles/1/comments/ 응답 확인
상태코드 400 응답 확인
CommentSerializer 에서 외래 키에 해당하는 article field 또한 사용자로부터 입력 받도록 설정되어 있기 때문에 서버 측에서 누락되었다고 판단한 것

✔ 읽기 전용 필드

데이터를 전송하는 시점에 '유효성 검사에서 제외시키고, 데이터 조회 시에는 출력'하는 필드

POST http://127.0.0.1:8000/api/v1/articles/1/comments/ 재요청

4. DELETE & PUT

단일 댓글 삭제 및 수정을 위한 view 함수 작성

DELETE http://127.0.0.1:8000/api/v1/comments/21/ 응답 확인

PUT http://127.0.0.1:8000/api/v1/comments/1/ 응답 확인

응답 데이터 재구성

댓글 조회 시 게시글 출력 내역 변경

댓글 조회 시 게시글 번호만 제공해주는 것이 아닌 '게시물의 제목'까지 제공하기

필요한 데이터를 만들기 위한 Serializer는 내부에서 추가 선언 가능

GET http://127.0.0.1:8000/api/v1/comments/1/ 응답 확인

역참조 데이터 구성

Article -> Comment 간 역참조 관계를 활용한 JSON 데이터 재구성

아래 2가지 사항에 대한 데이터 재구성하기

단일 게시글 조회 시 해당 게시글에 작성된 댓글 목록 데이터도 함께 붙여서 응답

단일 게시글 조회 시 해당 게시글에 작성된 댓글 개수 데이터도 함게 붙여서 응답

1. 단일 게시글 + 댓글 목록

Nested relationships
- 모델 관계 상으로 참조하는 대상은 참조되는 대상의 표현에 포함되거나 중첩될 수 있음
- 이러한 중첩된 관계는 serializers를 필드로 사용하여 표현 가능

# articles/serializers.py
class CommentSerializer(serializers.ModelSerializer):
	class Meta:
    	model = Comment
        fields = '__all__'
        read_only_fields = ('article',)
        
class ArticleSerializer(serializers.ModelSerializer):
	comment_Set = CommentSerializer(many=True, read_only = True)
    class Meta:
    	model = Article
        fields = '__all__'

GET http://127.0.0.1:8000/api/v1/articles/2/ 응답 확인

2. 단일 게시글 + 댓글 목록

댓글 개수에 해당하는 새로운 필드 생성

class ArticleSerializer(serializers.ModelSerializer): 
    comment_set = CommentSerializerForArticle(many=True, read_only=True)
    # comment_set와 같이 역참조 매니저명은 django가 기존에 정의해놓은 것

    comment_count = serializers.IntegerField(source='comment_set.count', read_only=True)
    # 'comment_count' 해당 변수는 내가 새롭게 정의한 것
    # comment_count 변수에 할당되어야 할 값도 내가 정의 해줘야 함.
    class Meta:
        model = Article
        fields = '__all__'

'source'

필드를 채우는데 사용할 속성의 이름

점 표기법(dotted notaion)을 사용하여 속성을 탐색 할 수 있음

GET http://127.0.0.1:8000/api/v1/articles/3/ 응답 확인

[주의] 읽기 전용 필드 지정 이슈

특정 필드를 override 혹은 추가한 경우 read_only_fields는 동작하지 않음
해당 필드의 read_only 키워드 인자로 작성해야 함

API 문서화

OpenAPI Specification(OAS)

RESTful API를 설명하고 시각화하는 표준화된 방법
-> API에 대한 세부사항을 기술할 수 있는 공식 표준

=> OAS 기반 API에 대한 문서를 생성하는데 도움을 주는 오픈소스 프레임워크

설치 및 등록

관련 설정코드 입력(OpenAPI 스키마 자동 생성 코드

swagger, redoc 페이지 제공을 위한 url 작성

http://127.0.0.1:8000/api/schema/swagger-ui/ 페이지 확인

http://127.0.0.1:8000/api/schema/redoc 페이지 확인

OAS의 핵심 이점 - '설계 우선' 접근법

API를 먼저 설계하고 명세를 작성한 후, 이를 기반으로 코드를 구현하는 방식
API의 일관성을 유지하고, API 사용자는 더 쉽게 API를 이해하고 사용할 수 있음
또한, OAS를 사용하면 API가 어떻게 작동하는지를 시각적으로 보여주는 문서를 생성할 수 있으며, 이는 API를 이해하고 테스트하는 데 매우 유용
이런 목적으로 사용되는 도구가 Swagger-UI 또는 ReDoc