Recipes Core Pack · API

CRUD 엔드포인트 추가

데이터 모델 정의부터 테스트까지, CRUD 기능 추가 시 필요한 작업을 빠르게 정리합니다.

CRUD 엔드포인트 프롬프트

복사해서 사용하세요

"기존 서비스에 CRUD 엔드포인트를 추가하려고 해. 아래 조건으로 구현 계획 + 코드 초안을 만들어줘. [입력 정보] - 리소스 이름: [RESOURCE] - 필드 정의: [FIELDS] - 백엔드 스택: [FastAPI/Hono/Nest] - 저장소: [RDB/NoSQL/in-memory] - 인증 필요 여부: [true/false] [출력 요구사항] 1) 라우트/DTO/검증 구조 2) Create/Read/Update/Delete API 설계 3) 에러 처리/상태코드 규칙 4) 테스트 케이스 최소 5개 5) 프론트 연동 체크리스트"

위 프롬프트를 복사하여 AI 채팅에 붙여넣으세요.

응답 규칙 예시

http

POST /api/v1/projects -> 201 Created
GET /api/v1/projects/{id} -> 200 OK
PATCH /api/v1/projects/{id} -> 200 OK
DELETE /api/v1/projects/{id} -> 204 No Content
GET /api/v1/projects/{missing} -> 404 Not Found

실행 체크리스트

0/5 완료

스키마 정의필드/검증/기본값 확정

CRUD 라우트 구현C/R/U/D 전체 API 추가

예외 처리 정리400/404/409/500 응답 규칙 점검

테스트 작성단위/통합 최소 케이스 추가

프론트 연동 확인요청/응답 타입 일치 검증

TL;DR

CRUD 엔드포인트 추가 작업 시 필요한 최소 기준과 검증 포인트를 빠르게 확인합니다.
실제 프로젝트 환경값(브랜치, 시크릿, URL, 임계치)은 팀 기준에 맞게 치환하세요.

사전 준비 (Prerequisites)

대상 리포지토리와 실행 환경 접근 권한 확인
로컬/CI에서 사용할 기본 명령어(`install`, `build`, `test`) 점검
환경변수/시크릿/배포 대상 정보를 최신 상태로 정리

실행 순서 (Steps)

변경 목표와 범위를 한 줄로 고정한다.
핵심 변경(CRUD 엔드포인트 추가)을 최소 단위 커밋으로 적용한다.
검증 로그를 남기고 체크리스트/문서를 즉시 업데이트한다.

검증 (Validation)

빌드/테스트가 현재 브랜치에서 재현 가능하게 통과하는지 확인
핵심 경로(사용자 플로우 또는 운영 플로우)를 수동 샘플 점검
ko/en 문서와 링크가 동일 의도를 유지하는지 대조

문제 해결 (Troubleshooting)

오류 발생 시 로그/요청 본문/환경값을 먼저 캡처한다.
권한/환경변수/라우팅/빌드 산출물 순서로 원인을 좁힌다.
임시 조치와 근본 원인 수정을 분리해 기록한다.

CRUD 엔드포인트 추가

CRUD 엔드포인트 프롬프트

응답 규칙 예시

실행 체크리스트

TL;DR

사전 준비 (Prerequisites)

실행 순서 (Steps)

검증 (Validation)

문제 해결 (Troubleshooting)

관련 문서 (References)

관련 문서

RDB 설계 기본

Failed to fetch

피드백 보내기