item4 dev story

drf-yasg-examples

작성일:

게시물 주소: https://item4.blog/2020-03-22/drf-yasg-examples/

Tags:

지난번의 포스팅에서 drf-yasg로 생성된 문서에 예시값을 넣는 법을 다루었습니다.1 하지만 프로젝트를 만들때마다 똑같은 코드를 계속 작성할 필요는 없겠죠. 이를 방지하기 위해 drf-yasg-examples2 패키지를 만들었습니다.

drf-yasg-examples

지난 포스팅과 예시 삽입법은 동일하지만, 보다 간소화 되었습니다. pip이나 poetry를 사용해서 drf-yasg-examples 를 설치한 후, Django Setting 파일에 다음과 같은 설정을 넣어주면 끝납니다.

SWAGGER_SETTINGS = {
    'DEFAULT_AUTO_SCHEMA_CLASS': 'drf_yasg_examples.SwaggerAutoSchema',
}

추가적인 기능

지난 포스팅의 기능을 활용하면 enum의 예시를 달 수는 있었지만, 각 값이 무슨 의미인지를 출력해줄 방법은 없었습니다. 이번 패키지에서는 enum의 각 key와 해당 설명값을 자동으로 문서에 추가해주는 기능이 추가되었습니다.

Choices에 자동으로 예시가 추가된 예시

GitHub에 이슈 작성 글쓴이에게 초코우유 한 잔 선물하기

주제가 비슷한 글

CCL 4.0 BY-SA