API Contract Design
OpenAPI(Swagger) 기반 스키마 우선 API 설계 스킬입니다.
Core Principle
"코드보다 계약(Contract)이 먼저다."
"프론트엔드와 백엔드가 동시에 개발할 수 있게 API를 먼저 정의한다."
Schema-First vs Code-First
| 접근법 | 장점 | 단점 | |--------|------|------| | Schema-First (권장) | 병렬 개발 가능, 명확한 계약 | 초기 설계 시간 필요 | | Code-First | 빠른 시작 | 문서와 코드 불일치 위험 |
OpenAPI 기본 구조
openapi.yaml
openapi: 3.1.0
info:
title: My API
version: 1.0.0
description: API for My Application
servers:
- url: https:
[Description truncada. Veja o README completo no GitHub.]