DRF drf-yasg swaager access token(JWT) 입력 받기

코드

# settings.py
# swagger settings
SWAGGER_SETTINGS = {
    "DEFAULT_INFO": "obab.urls.api_info",
    "USE_SESSION_AUTH": False,
    "VALIDATOR_URL": None,
    "SECURITY_DEFINITIONS": {
        "Bearer": {"type": "apiKey", "name": "Authorization", "in": "header"}
    },
}

위의 코드는 Django 프로젝트의 설정 파일(settings.py)에서 Swagger 설정을 구성하는 부분입니다. Swagger는 API 문서를 생성하고 제공하는 도구이며, DRF(Django Rest Framework)와 함께 사용되어 API의 사용 방법을 문서화하고 시각화하는 데 사용됩니다.

 

추가 설명

1. "DEFAULT_INFO": "obab.urls.api_info":

• API 문서에 표시될 기본 정보를 제공하는 부분입니다. "obab.urls.api_info"는 프로젝트 내부에서 API 정보를 제공하는 URL 경로를 가리킵니다. 이 URL 경로에 접근하여 API에 대한 정보를 얻을 수 있습니다.

2. "USE_SESSION_AUTH": False:

• Swagger UI에서 세션 인증을 사용할지 여부를 설정하는 부분입니다. False로 설정되어 있으므로 세션 인증을 사용하지 않음을 나타냅니다.

3. "VALIDATOR_URL": None:

• Swagger 문서 유효성 검사기의 URL을 설정하는 부분입니다. None으로 설정되어 있으므로 유효성 검사기를 사용하지 않음을 나타냅니다.

4. "SECURITY_DEFINITIONS": {"Bearer": {"type": "apiKey", "name": "Authorization", "in": "header"}}:

• Swagger UI에서 보안 정의를 설정하는 부분입니다. 여기서는 Bearer 토큰 인증을 사용하는 것으로 설정되어 있습니다. "type": "apiKey"는 API 키를 사용하여 인증한다는 것을 의미하고, "name": "Authorization"은 인증에 사용될 헤더의 이름을 지정하고, "in": "header"는 헤더 내에 토큰이 위치한다는 것을 나타냅니다.

 

 

출처

How to integrate swagger with JWT? · Issue #757 · marcgibbons/django-rest-swagger