45분
제조 AI API 문서화 실습
Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
제조 AI API 문서화 실습
발표 & 포트폴리오 > Day 1: 기술 문서화 - 코드를 넘어 이야기를 남겨라
학습 목표
FastAPI 엔드포인트에 완전한 문서를 작성한다 Pydantic 모델의 모든 필드에 description과 example을 추가한다 커스텀 OpenAPI 스키마를 설정한다
미션: "Slack 질문 0건" 달성하는 API 문서
상황
프론트엔드 개발자가 당신의 API를 연동해야 한다. 하지만 당신은 출장 중이다. API 문서만 보고 연동할 수 있어야 한다.
요구사항
- Pydantic 모델 5개 작성 (Request 2개 + Response 3개)
- 모든 Field에 description + example 추가
- Enum 하나 이상 사용
- 엔드포인트 4개 작성 (CRUD + 진단)
- 커스텀 OpenAPI 태그 설정
- 에러 응답 모델 정의 (400, 404, 500)
평가 기준
- /docs 페이지만으로 모든 API 사용법을 파악할 수 있는가?
- Try it out으로 바로 테스트할 수 있는 example이 있는가?
에디터 로딩 중...
정답 보기
에디터 로딩 중...