글 / FastAPI 배포

공개 서버의 자동 문서 비활성화

인증 없이 공개된 서버에서는 /docs와 /openapi.json을 비활성화한다.

작성일 · 읽는 시간 1분 · FastAPI 0.141 기준

기본 동작

FastAPI는 별도로 비활성화하지 않으면 /docs, /redoc, /openapi.json을 제공한다. 개발 시에는 편리하지만, 인증 없이 공개된 서버에서는 존재하는 경로가 그대로 노출된다.

비활성화 방법

pythonmain.py
from fastapi import FastAPI

app = FastAPI(
    docs_url=None,
    redoc_url=None,
    openapi_url=None,
)

openapi_url까지 비활성화해야 한다. 문서 화면 두 개만 비활성화하면 /openapi.json은 계속 제공된다.

설정에 따라 달라지는 자동 문서 경로 세 개의 제공 여부

확인 방법

bash
curl -s -o /dev/null -w '%{http_code}\n' http://127.0.0.1:5011/docs
# 404