Django에 대하여(39)_API 문서화

1. OpenAPI Specification (OAS)

RESTful API를 설명하고 시각화하는 표준화된 방법으로 API에 대한 세부사항을 기술할 수 있는 공식 표준입니다. 

---

2. drf-spectacular 라이브러리

DRF를 위한 OpenAPI 3.0 구조 생성을 도와주는 라이브러리입니다.

설치 및 등록하기

$ pip install drf-spectacular

# settings.py

INSTALLED_APPS = [
    ...,
    'drf_spectacular',
    ...,
]

---

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

# settings.py

REST_FRAMEWORK = {
    # YOUR SETTINGS
    'DEFUALT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
}

---

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

# drf/urls.py
from drf_spectacular.views import SpectacularAPIView, SpectacularRedocVIew, SpectacularSwaggerVIew

urlpatterns = [
    ...,
    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
    path('api/schema/swagger-ui', SpectacularSwaggerVIew.as_view(url_name='schema'), name='swagger-ui'),
    path('api/schema/redoc', SpectacularRedocVIew.as_view(url_name='schema'), name='redoc'),

---

---

---

3. OAS의 핵심 이점 - "설계 우선" 접근법

---

참고

1. get_object_or_404()

---

2. get_list_or_404()