Skip to content

[리뷰] API 문서 + OpenAPI + 에러 응답 정돈 + E2E #217

Description

@hyunbin1

개요

리뷰 API 문서화, 에러 응답 정돈, E2E 테스트.

작업 내용

문서

  • docs/review-api.md: 프론트 친화 가이드(응답 래퍼/인증/에러 형태, 엔드포인트 10개 상세, 키워드 18개 표, 미디어 업로드 절차, 모더레이션, 에러 카탈로그, FAQ)
  • static/openapi/review.json: OpenAPI 3.0.1(엔드포인트+프리사인, 스키마 20+, 요청/응답·에러 예시). /openapi/review.json로 서빙

에러 응답 정돈

  • GlobalExceptionHandler에 HttpMessageNotReadableException 핸들러 추가 → 잘못된 JSON/enum 값이 500이 아니라 400 MALFORMED_REQUEST_BODY 로 정돈
  • 리뷰/프리사인 ErrorCode 8종 추가, 공통 에러 형태 {status, error, message} 준수

JSON 키 일관성

  • 응답 불리언 플래그를 커뮤니티와 동일하게 isLiked/isMine/isFnb로 직렬화(@JsonProperty), 직렬화 테스트로 고정

E2E (Playwright, 운영서버 대상)

  • e2e/tests/review.spec.js: 공개 GET(목록/미디어/키워드 형태·에러코드), 인증 게이트(작성/좋아요/삭제/프리사인, env 없으면 skip), 프리사인 형식/용량 400
  • 배포 후 검증(현재 IT가 데이터층 검증)

관련 파일

docs/review-api.md, static/openapi/review.json, util/exception/GlobalExceptionHandler.java, util/exception/ErrorCode.java, e2e/**

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions