Skip to content

Instantly share code, notes, and snippets.

@KimSoungRyoul
Created April 14, 2021 03:41
Show Gist options
  • Save KimSoungRyoul/8dea5952680ef82a638cee037acad02a to your computer and use it in GitHub Desktop.
Save KimSoungRyoul/8dea5952680ef82a638cee037acad02a to your computer and use it in GitHub Desktop.
SPECTACULAR_SETTINGS = {
# ...
"SWAGGER_UI_SETTINGS": {
'deepLinking': True, # API를 클릭할때 마다 SwaggerUI의 url이 변경됩니다. (특정 API url 공유시 유용하기때문에 True설정을 사용합니다)
'persistAuthorization': True, # True 이면 SwaggerUI상 Authorize에 입력된 정보가 새로고침을 하더라도 초기화되지 않습니다.
'displayOperationId': True, # True이면 API의 urlId 값을 노출합니다. 대체로 DRF api name둘과 일치하기때문에 api를 찾을때 유용합니다.
'filter': True, # True 이면 Swagger UI에서 'Filter by Tag' 검색이 가능합니다.
# Swagger UI 가 제공하는 UI 커스터마이징 옵션값들입니다. 아래 링크를 보면 어떤 커스터마이징 옵션들이 존재하는지 알수있습니다.
# https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/
},
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment