자동 생성 Reference
GrowFit API Reference는 FastAPI/openapi.json을 기반으로 자동 생성됩니다.
- 장점: 엔드포인트/스키마 변경이 즉시 반영됩니다.
- 관리 포인트: OpenAPI에 설명/예시를 풍부하게 넣으면 Reference 품질이 좋아집니다.
OpenAPI 업데이트 흐름
- FastAPI에서
/openapi.json이 최신인지 확인 docs.json의openapi값이 올바른 URL을 바라보는지 확인- 문서 배포 후 Reference가 자동 갱신되는지 확인
Guides와의 역할 분리
Reference는 정확한 스펙, Guides는 실제 사용 맥락을 다룹니다.- Reference: 요청/응답, 파라미터, 스키마, HTTP status
- Guides: 언제 쓰는지, 자주 하는 실수, 권한/페이징/필터링 규칙