COURSE MAP
API 약속을 설계하고 Swagger로 지키는 코스
이 과정은 엔드포인트 목록을 외우는 자료가 아니라, 프론트엔드와 백엔드가 같은 계약을 보고 개발하도록 만드는 실무 문서화 흐름을 익히는 데 초점을 둡니다.
1약속으로 이해
API를 기능 구현이 아니라 팀 사이의 계약으로 보고 Design First 흐름을 잡습니다.
2REST 기준 정리
URL, HTTP 메서드, 상태 코드, 응답 포맷, 변경 관리 기준을 실무 규칙으로 정리합니다.
3Swagger로 고정
OpenAPI 스펙, Swagger UI, 인증, 에러 응답, 변경 이력을 문서화합니다.
LESSONS
API·Swagger 학습 파트
베이스 문서의 4부 14챕터를 사이트 구조에 맞게 나누고, 파트별 완료 기준을 붙였습니다.
Part 1배경
API 설계가 왜 중요한가
API를 기능이 아니라 프론트엔드와 백엔드 사이의 약속으로 보고, Design First와 REST의 기본 전제를 정리합니다.
Part 2설계 원칙
API 설계 원칙
혼자 쓰는 API와 팀으로 쓰는 API에서 지켜야 할 URL, 응답 포맷, 상태 코드, 변경 관리 기준을 정리합니다.
Part 3Swagger
Swagger / OpenAPI 실무 심화
OpenAPI의 paths, schemas, securitySchemes를 이해하고 Express 연동, 요청/응답 스키마, JWT 인증, 버전 관리를 정리합니다.
Part 4확장
API 문서가 산출물이 되는 구조
좋은 API 문서가 인수인계, 협업, 포트폴리오, AI 도구 활용에서 어떤 가치를 갖는지 정리합니다.
학습 흐름
- API를 구현 결과가 아니라 프론트와 백엔드의 협업 계약으로 이해합니다.
- Design First, REST 리소스, 상태 코드, 응답 포맷을 먼저 정리합니다.
- OpenAPI 문서의 paths, schemas, securitySchemes를 실제 예시로 익힙니다.
- Swagger UI, JWT 인증, 버전 관리, AI 도구 연동까지 확장합니다.