1.2.2 API 문서 자동 생성

클라이언트와 서버가 서로 통신하려면 어떤 경로로 요청을 보내고 어떤 형식으로 응답을 받는지에 대한 약속이 필요합니다. 이 약속을 정리한 문서를 API 문서라고 합니다. API 문서에는 요청 경로, 필요한 매개변수, 응답 데이터 구조, 인증 방식, 오류 코드 등이 포함됩니다.

일반적으로 API 문서는 개발자가 별도로 작성하고 관리합니다. 그러나 코드와 문서를 따로 관리하면 기능이 수정될 때 문서가 최신 상태를 반영하지 못하는 문제가 발생할 수 있습니다. 문서와 실제 동작이 어긋나면 협업 과정에서 혼란이 생깁니다.

FastAPI는 이러한 문제를 해결하기 위해 코드를 기반으로 API 문서를 자동으로 생성합니다. 개발자가 정의한 경로(함수), 입력 데이터의 타입, 반환 데이터 구조 등을 분석해 OpenAPI 표준 형식의 명세를 자동으로 만듭니다. 즉, 별도의 문서 작성 작업 없이 코드만으로 API 명세가 완성됩니다.