OPEN HYPER STEP
← 목록으로 (Java+Spring)
JAVA · 50 / 69
java
CHAPTER 50 / 69
읽기 약 2
FUNCTION

REST API 설계


핵심 개념

RESTful API 설계 원칙, HTTP 메서드 선택, 상태 코드 활용, 표준 응답 형식, API 버전 관리를 실무 기준으로 익힌다.

코드 분석
JAVA📋 코드 (39줄)
// 표준 응답 래퍼
@Getter
@AllArgsConstructor
public class ApiResponse<T> {
    private final boolean success;
    private final T data;
    private final String message;
    private final LocalDateTime timestamp = LocalDateTime.now();

    public static <T> ApiResponse<T> ok(T data) {
        return new ApiResponse<>(true, data, null);
    }
    public static <T> ApiResponse<T> fail(String message) {
        return new ApiResponse<>(false, null, message);
    }
}

// RESTful URL 설계
// ✅ 올바른 설계
GET    /api/v1/users          // 목록
GET    /api/v1/users/{id}     // 단건
POST   /api/v1/users          // 생성
PUT    /api/v1/users/{id}     // 전체 수정
PATCH  /api/v1/users/{id}     // 부분 수정
DELETE /api/v1/users/{id}     // 삭제

// ❌ 잘못된 설계
GET /api/getUser
POST /api/deleteUser

// HTTP 상태 코드
// 200 OK — 성공
// 201 Created — 리소스 생성
// 204 No Content — 삭제 성공
// 400 Bad Request — 잘못된 요청
// 401 Unauthorized — 인증 필요
// 403 Forbidden — 권한 없음
// 404 Not Found — 리소스 없음
// 500 Internal Server Error — 서버 오류

AI 프롬프트
🤖 AI에게 잘 물어보는 법 — 모델·전략별 프롬프트
Claude

무료: Sonnet 4.6 / Pro $20/mo: Opus 4.6

이 Spring 'REST API' 코드에서
DI 관련 버그·순환 참조·트랜잭션 누수를
찾아서 수정해줘.
ChatGPT

무료: GPT-5.5 / Plus $20/mo: GPT-5.5 Pro

'REST API'를 Spring Boot 3.x로 구현한
실전 API 코드(컨트롤러+서비스+레포지토리+테스트)를 완성형으로 만들어줘.
Gemini

무료: 2.5 Flash / Pro $19.99/mo: 3.1 Pro

이 Spring 'REST API' 프로젝트의 빈 구조와
의존성 트리를 전체 분석하고
N+1 쿼리·순환 참조·성능 병목을 정리해줘.
Grok

무료: Grok 4.1 / SuperGrok $30/mo

Spring 'REST API' vs Quarkus·Micronaut·Ktor의
동일 기능 구현을 2026년 한국 채용 시장 기준으로
솔직히 비교해줘.

⭐ 이것만 기억하세요
REST API 설계 이 3가지만 확실히 잡으세요
1.엔드포인트를 즉흥적으로 만들면 일관성이 없고 프론트엔드와의 계약이 불명확합니다
2.리소스 기반 URL + HTTP 메서드 + 일관된 응답 형식 + HATEOAS 링크가 RESTful API 설계의 원칙입니다
3.다음 챕터에서 서비스 레이어 패턴을 심화 학습합니다


공유하기
진행도 50 / 69