Skip to content

refactor: 분석 상태를 열거형 그대로 응답에 싣기 - #129

Merged
redjungi09 merged 2 commits into
developfrom
refactor/analysis-status-enum/#125
Sep 2, 2026
Merged

refactor: 분석 상태를 열거형 그대로 응답에 싣기#129
redjungi09 merged 2 commits into
developfrom
refactor/analysis-status-enum/#125

Conversation

@redjungi09

Copy link
Copy Markdown
Collaborator

관련 이슈

변경 내용

  • 목록 응답의 analysis_status 를 열거형 타입으로 선언해 OpenAPI 스펙에 enum 으로 노출
  • 열거형을 문자열 이름으로 바꾸던 중간 단계 제거 (ListTreatmentRecordsUseCase.Item · 서비스)
  • 스펙에 여섯 값이 실리는지 확인하는 통합 테스트 추가

작업 목적

허용값이 스키마 설명 문구에만 있어 클라이언트가 코드 생성으로 타입을 받지 못하고 손으로
옮겨 적어야 했다. 값이 늘거나 이름이 바뀌어도 스펙은 그대로라 어긋난 것이 드러나지 않는다.

테스트 방법

  • 단위 테스트 추가/수정
    • 통합 테스트 완료
    • 수동 테스트 완료

응답 JSON 은 바뀌지 않는다. 값 자체를 검증하는 기존 목록 API 통합 테스트가
수정 없이 그대로 통과하는 것이 그 근거다.

체크리스트

  • 코드가 프로젝트의 코딩 스타일을 따릅니다
    • 자체 코드 리뷰를 완료했습니다
    • 변경 사항에 대한 테스트를 추가했습니다
    • Breaking Changes가 없습니다

기타 사항

  • Item 이 분석 도메인의 열거형을 참조한다. 두 타입 모두 domain 안이고 계층 규칙이
    금지하지 않으며, 서비스는 이미 같은 타입을 다루고 있었다 — 경계를 넘은 것이 아니라
    이름으로 바꿔 들고 다니던 우회를 없앤 것이다.
  • "분석 완료"SUCCEEDED 만 해당한다는 점을 스키마 설명에 명시했다. 사진이 바뀌면
    STALE 로 전이되므로 결과가 남아 있다는 것과 완료라는 것은 같지 않다.

목록의 analysis_status 가 String 이라 생성된 스펙에 type: string 으로만 나갔다. 허용값
여섯 개는 스키마 설명 문구에만 있어 클라이언트가 눈으로 읽고 옮겨 적어야 했고, 값이 늘거나
이름이 바뀌어도 스펙은 그대로라 어긋난 것이 드러나지 않았다.

열거형을 이름으로 바꾸던 단계를 없애 허용값의 출처를 AnalysisJobStatus 하나로 둔다.
직렬화 결과는 이름 그대로라 응답 JSON 은 바뀌지 않는다.
기대값을 AnalysisJobStatus 에서 직접 뽑는다. 테스트에 여섯 값을 적어두면 그 목록이
두 번째 출처가 되어 애초에 없애려던 문제를 되풀이한다.
@redjungi09
redjungi09 merged commit 26f1c44 into develop Sep 2, 2026
1 check passed
@redjungi09
redjungi09 deleted the refactor/analysis-status-enum/#125 branch September 3, 2026 00:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant