AI

ACE AI Startup Bootcamp

API Design & Swagger Specification

πŸ“– Session 4 μ‹€μŠ΅ κ΅μ•ˆ 보기 ← 컀리큘럼 νŽ˜μ΄μ§€λ‘œ λŒμ•„κ°€κΈ°
Day 4 API Design & Swagger Specification μ˜μƒ + AI 챗봇 ν•™μŠ΅

API 섀계 & Swagger λͺ…μ„Έμ„œ μž‘μ„±κ³Ό AI ν•™μŠ΅λ„μš°λ―Έ (Codex AI 연계)

ν™”λ©΄ 섀계, μ‚¬μš©μž 흐름, μ‹œν€€μŠ€ λ‹€μ΄μ–΄κ·Έλž¨, 데이터 ꡬ쑰λ₯Ό λ°”νƒ•μœΌλ‘œ μ‹€μ œ μ„œλΉ„μŠ€ κΈ°λŠ₯을 API ν˜•νƒœλ‘œ μ •μ˜ν•˜κ³ , Swagger/OpenAPI ν˜•μ‹μ˜ λͺ…μ„Έμ„œλ‘œ λ¬Έμ„œν™”ν•˜λŠ” 4일차 ν•™μŠ΅ μ½˜ν…μΈ μž…λ‹ˆλ‹€. λ³Έ μ‹€μŠ΅μ—μ„œλŠ” Codex Client Workspaceλ₯Ό ν™œμš©ν•˜μ—¬ API κ³„μ•½μ„œ μžλ™ 생성, 기획-API μ •ν•©μ„± μ˜€λ””νŒ… 및 μ—λŸ¬ 핸듀링 점검, API 변동 영ν–₯ 뢄석 및 ν…ŒμŠ€νŠΈ μ‹œλ‚˜λ¦¬μ˜€ 자율 λ°œκ΅΄μ„ ν¬ν•¨ν•œ κ³ λ„ν™”λœ 싀무 ν”„λ‘œμ„ΈμŠ€λ₯Ό μˆ˜ν–‰ν•©λ‹ˆλ‹€.

λŒ€μƒ: λ°μ΄ν„°λ² μ΄μŠ€ 섀계(ERD)λ₯Ό μ™„λ£Œν•œ 학생
μ€€λΉ„λ¬Ό: λ…ΈνŠΈλΆ, Swagger Editor λ˜λŠ” OpenAPI νŽΈμ§‘ 도ꡬ
ꡬ성: 2μ‹œκ°„ 이둠 및 API κ³„μ•½μ„œ 생성 / 3μ‹œκ°„ API μ •ν•©μ„± μ˜€λ””νŒ… 및 영ν–₯도 뢄석 / 1μ‹œκ°„ API 리뷰 및 ν…ŒμŠ€νŠΈ μ‹œλ‚˜λ¦¬μ˜€ μž‘μ„±
πŸ“– Session 4 κ΅μ•ˆ λ°”λ‘œκ°€κΈ°

πŸš€ Day 4 μ‹€μŠ΅ MVP Tasks λ‘œλ“œλ§΅

전체 Task λ³΄λ“œ κ°€κΈ° β†’
πŸš€
Interactive Board

μ‹€μŠ΅ Task 체크리슀트

ν•„μˆ˜ νƒœμŠ€ν¬μ˜ 진척도λ₯Ό κΈ°λ‘ν•˜κ³  상세 μ‹€μŠ΅ κ°€μ΄λ“œλΌμΈμ„ ν™•μΈν•΄λ³΄μ„Έμš”.

πŸ‘‰ 상세 Task λ³΄λ“œ 이동
TASK 1
API Design

Task 1. API κ³„μ•½μ„œ 생성 μ‹€μŠ΅

μš”κ΅¬μ‚¬ν•­κ³Ό 화면섀계λ₯Ό λΆ„μ„ν•˜μ—¬ ν‘œμ€€ RESTful API κ³„μ•½μ„œ(api-contract.md)λ₯Ό μƒμ„±ν•©λ‹ˆλ‹€.

Task 1 μ‹€μŠ΅μ‹€ μž…μž₯
TASK 2
Spec Consistency

Task 2. API 뢈일치 κ²€μΆœ μ‹€μŠ΅

κΈ°νšμ„œ, ν™”λ©΄μ •μ˜μ„œ, API μŠ€νŽ™ λ¬Έμ„œ κ°„μ˜ 정합성을 κ²€ν† ν•˜κ³  뢈일치 λ³΄κ³ μ„œλ₯Ό λ„μΆœν•©λ‹ˆλ‹€.

Task 2 μ‹€μŠ΅μ‹€ μž…μž₯
TASK 3
Impact Analysis

Task 3. API λ³€κ²½ 영ν–₯ 뢄석 μ‹€μŠ΅

API 계약 ν•„λ“œ λ³€κ²½ μ‹œ ν™”λ©΄ UI와 DB λͺ¨λΈλ§μ˜ 쒅속적 연쇄 영ν–₯ λ²”μœ„λ₯Ό μ—­μΆ”λ‘ ν•©λ‹ˆλ‹€.

Task 3 μ‹€μŠ΅μ‹€ μž…μž₯
MISSION 1
API Review

Mission 1. API 리뷰 및 κ°œμ„  μ‹€μŠ΅

REST API ν‘œμ€€ 규격, HTTP Status, RFC ν‘œμ€€ μ—λŸ¬ μŠ€ν‚€λ§ˆ μ€€μˆ˜ ν’ˆμ§ˆμ„ 자율 λ¦¬λ·°ν•©λ‹ˆλ‹€.

Mission 1 μ‹€μŠ΅μ‹€ μž…μž₯
MISSION 2
API Test

Mission 2. API ν…ŒμŠ€νŠΈ μ‹œλ‚˜λ¦¬μ˜€ 생성 μ‹€μŠ΅

정상 μž‘λ™ 및 각쒅 νŒŒλΌλ―Έν„° λˆ„λ½, λ‚ μ§œ ν˜•μ‹ 였λ₯˜ λ“±μ˜ 경계값 μ˜ˆμ™Έ ν…ŒμŠ€νŠΈ μΌ€μ΄μŠ€λ₯Ό μƒμ„±ν•©λ‹ˆλ‹€.

Mission 2 μ‹€μŠ΅μ‹€ μž…μž₯

Day 4 κ°•μ˜ μ˜μƒ

유튜브 μΆ”μ²œ κ°•μ˜
Day 4 컀리큘럼 핡심 주제(API 섀계, Request/Response, Endpoint, Swagger, OpenAPI)에 ν•΄λ‹Ήν•˜λŠ” 유튜브 μΆ”μ²œ κ°•μ˜ λ¦¬μŠ€νŠΈμž…λ‹ˆλ‹€. (μ™ΈλΆ€ 퍼가기 및 μž¬μƒμ΄ ν—ˆμš©λœ 무료 κ°•μ˜ μ˜μƒμœΌλ‘œ κ΅¬μ„±λ˜μ—ˆμŠ΅λ‹ˆλ‹€.)
πŸ“š 전체 κ°•μ˜ λͺ©λ‘ (5개)
  • β–Ά
    1. APIs for Beginners - Twilio
    4:13:00
  • β–Ά
    2. Full HTTP Networking & REST API Course
    4:10:00
  • β–Ά
    3. System Design Concepts and API Design
    5:15:30
  • β–Ά
    4. REST API Design best practices
    2:30:15
  • β–Ά
    5. Postman Tutorial for Beginners
    11:45

핡심 μš”μ•½ λ…ΈνŠΈ

Day 4 Summary

였늘의 핡심 λͺ©ν‘œ

Day 4μ—μ„œλŠ” ν™”λ©΄ 섀계, μ‚¬μš©μž 흐름, 데이터 ꡬ쑰λ₯Ό λ°”νƒ•μœΌλ‘œ μ‹€μ œ μ„œλΉ„μŠ€ κΈ°λŠ₯을 API ν˜•νƒœλ‘œ μ •μ˜ν•˜κ³ , Swagger/OpenAPI ν˜•μ‹μ˜ λͺ…μ„Έμ„œλ‘œ λ¬Έμ„œν™”ν•©λ‹ˆλ‹€.

  • API μ—”λ“œν¬μΈνŠΈ λ„μΆœ: ν™”λ©΄ μš”κ΅¬μ‚¬ν•­ 기반 REST API λ¦¬μ†ŒμŠ€ 및 URI μ •μ˜
  • Request/Response 규격 섀계: JSON ꡬ쑰의 μš”μ²­/응닡 νŽ˜μ΄λ‘œλ“œ μŠ€ν‚€λ§ˆ μ •μ˜
  • HTTP λ©”μ†Œλ“œ 및 μƒνƒœ μ½”λ“œ μ •μ˜: GET, POST, PUT, DELETE κ·œμΉ™κ³Ό μ—λŸ¬ 처리 규격 섀계
  • Swagger/OpenAPI λͺ…μ„Έ μž‘μ„±: YAML/JSON ν˜•μ‹μ„ μ΄μš©ν•œ λͺ…μ„Έμ„œ μž‘μ„± 기법 μŠ΅λ“
  • 개발 μΈμˆ˜μΈκ³„(Handoff) κ³ λ €: μ˜ˆμ™Έ 응닡 μ½”λ“œμ™€ μ—λŸ¬ λ©”μ‹œμ§€ μ„ΈλΆ€ν™”
ν•™μŠ΅ 팁: 였λ₯Έμͺ½ AI μ±—λ΄‡μ—κ²Œ β€œRESTful API μ„€κ³„μ˜ κΈ°λ³Έ κ·œμΉ™μ΄ 뭐야?” λ˜λŠ” β€œSwaggerμ—μ„œ Request Body와 Path Parameterλ₯Ό μ–΄λ–»κ²Œ λͺ…μ‹œν•΄?” 같은 μ§ˆλ¬Έμ„ ν•΄λ³΄μ„Έμš”.