Skip to main content

문서 구성

GrowFit API 문서는 **Reference(자동 생성)**와 **Guides(설명/운영)**로 나눠집니다.
  • Reference: FastAPI /openapi.json을 기반으로 자동 생성된 API 스펙
  • Guides: “언제 쓰는지”, “자주 발생하는 에러”, “권한/페이징/필터링 규칙” 등을 설명
Reference는 OpenAPI를 업데이트하면 자동 반영됩니다.

빠르게 보는 흐름

  1. Reference에서 엔드포인트의 기본 구조와 요청/응답 스키마를 확인합니다.
  2. Guides에서 실제 사용 시나리오, 프론트엔드 실수/오류 케이스, 운영 팁을 확인합니다.

DB 구조 바로 보기

실습 세션 저장 구조는 /db/user/practice_sessions 문서를 참고하세요.
문서(RAG) 저장 구조는 /db/user/documents 문서를 참고하세요.

관련 문서