[Python] Redoc

 

---

배경

회사 내에 문서 작업을 notion으로 했는데 계속 늘어나는 api들을 관리하기 위해 문서를 자동화 해주는 도구를 도입하기로 했습니다.

sweager과 redoc중 고민을 했는데 두 개의 차이점이 아래와 같아서 프론트와 협업이 위주인 문서들이라 ReDoc를 사용하기로 결정했습니다.

• Swagger를 선택할 때: 상호 작용 가능한 API 문서가 필요한 경우. 
  • 다양한 기능과 확장성이 중요한 경우. 
  • 이미 많은 사용자가 Swagger UI에 익숙한 경우. 
• ReDoc를 선택할 때: 
  • 단순하고 빠른 UI가 필요한 경우. 
  • 읽기 전용 문서로 제공하면 충분한 경우. 
  • React 기반의 동적인 UI를 선호하는 경우.

 

코드

pip install redoc

from redoc import RedocView

urlpatterns = [
    path('docs/', RedocView.as_view(url='/path/to/openapi.json'), name='redoc'),
]

pip install drf-spectacular

#setting.py
INSTALLED_APPS = [
    'drf_spectacular',
]

SPECTACULAR_SETTINGS = {
    # 추가 설정이 필요한 경우 여기에 작성
}

 

설명

Redoc과 sepectacular 패키지를 설치하는 과정입니다

Redoc을 사용하지만 프로젝트 내에서 serializer을 상속해서 사용하지 않기 때문에 문서를 만들어주기 위해서 spectacular 패키지를 받아주었습니다.

 

 

 

배운 점

docs만들기 초기 과정