In this post, concepts of API Documentation will be provided.

API Documentation

• 전자 제품을 구매하면 사용 설명서가 함께 제공됨
• API도 마찬가지로, 사용자에게 API의 사용법을 제공해야 함

Open API Specification

• 프레임워크에 종속받지 않는 API 문서 작성법이 필요
• Open API Specification은 JSON 또는 YAML로 작성되는 API 문서 작성 표준
• Swagger UI, ReDoc 등의 도구와 결합해서 API 문서를 Web UI로 제공할 수 있음

Automatic Docs

• API 문서를 별도로 작성하는 것은 번거롭고, 유지보수가 어려움
• FastAPI는 Open API Specification을 자동으로 생성해주며, Swagger와 Redoc도 내장
• 필요하다면 엔드포인트 정의 시 API 문서화에 도움이 되는 여러 메타데이터를 전달할 수 있음
• /docs, /redoc 엔드포인트를 통해 API 문서를 확인할 수 있음