Skip to content

API 요청/응답 처리 함수의 타입 안전성 개선 #53

@hyeone22

Description

@hyeone22

API 요청/응답 처리 함수의 타입 안전성 개선

문제 상황

  • API 요청/응답 처리 함수들이 any 타입을 사용하고 있어 타입 안전성이 보장되지 않음
  • 각 API 별로 다른 요청/응답 구조를 가지고 있으나 이를 타입으로 구분하지 않음
  • 런타임에서만 타입 관련 오류를 발견할 수 있음

원인 분석

  • 일부 파일의 함수가 Promise를 반환하도록 구현됨
  • 요청 body도 any 타입으로 정의되어 있어 타입 체크가 불가능
  • 제네릭을 활용하지 않아 타입 재사용성이 떨어짐

해결 방법

  • 기본 응답 타입(BaseResponse)을 정의하여 공통 응답 구조 표준화
  • 제네릭을 활용하여 요청/응답 타입을 동적으로 처리할 수 있도록 개선
  • API별 구체적인 요청/응답 인터페이스 정의 및 적용

개선 효과

  1. 타입 안전성
  • 컴파일 시점에서 타입 오류 발견 가능
  • API 별로 정확한 타입 체크 가능
  1. 개발 생산성
  • IDE 자동완성 기능 지원
  • 타입 추론을 통한 개발 편의성 향상
  1. 코드 품질
  • 타입 재사용성 향상
  • 명확한 API 인터페이스 정의
  • 유지보수성 개선

Metadata

Metadata

Assignees

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