더북(TheBook)

FastAPI 서버를 실행한 뒤 웹 브라우저 주소창에 특정 경로를 입력하면 생성된 API 문서를 확인할 수 있습니다.

• http://서버주소/docs

• http://서버주소/redoc

 

예를 들어 로컬 환경에서 서버를 실행했다면 http://127.0.0.1:8000/docs와 같은 주소로 접속합니다.

http://서버주소/docs 경로로 접속하면 Swagger UI(API 문서를 자동 생성하고 직접 테스트해볼 수 있는 대화형 도구) 화면이 열립니다. 이 화면에서는 각 API의 설명을 확인할 수 있을 뿐만 아니라, 입력값을 직접 작성해 버튼을 눌러 요청을 보내고 응답 결과를 확인할 수 있습니다.

http://서버주소/redoc 경로로 접속하면 ReDoc(API 문서의 구조와 요청·응답 정보를 보기 좋게 보여 주는 도구) 화면이 열립니다. 이 화면은 구조화된 문서를 읽기 좋은 형태로 정리해 보여 줍니다. API 목록과 요청·응답 구조를 한눈에 파악하기에 좋습니다.