V VibeCoding 365
사전 목록 백엔드·인프라

VIBECODING 365 / DICTIONARY

API 계약

API Contract

DEFINITION

정의

API 계약은 프론트엔드와 백엔드가 어떤 주소, 메서드, 요청 필드, 응답 형태, 오류 코드를 약속하는지 적은 실행 기준이다. VIBE 코딩에서는 AI가 화면과 서버 코드를 따로 만들며 필드명이 어긋나기 쉬우므로, 계약을 먼저 고정하면 구현·테스트·리뷰가 같은 기준을 보게 된다. 계약은 문서이면서 동시에 테스트의 체크리스트 역할을 하므로 작은 기능에서도 변경 범위를 안전하게 줄여 준다.

왜 중요한가

작은 프로젝트에서는 문서 한 장이나 테스트 파일만으로도 충분하다. 중요한 점은 AI 작업 지시서, 구현 코드, 검증 명령이 모두 같은 요청·응답 약속을 참조하도록 만드는 것이다.

관련 용어 연결

함께 보면 좋은 용어: endpoint, request, response, rest-api, acceptance-criteria, integration-test, schema. AI 작업 지시서에는 이 연결을 기준으로 화면, API, 테스트의 책임을 나누어 적는다.

ENGLISH

API Contract

EXAMPLE

AI에게 질문 저장 API를 만들게 하기 전 POST 경로, title/body/topic 필드, 성공 응답, 400 오류 형태, 인증 실패 처리, 중복 제출 규칙을 표로 정하고 통합 테스트에서 요청과 응답이 계약과 맞는지 검증한다.