[typescript] 타입스크립트와 GraphQL-js를 이용한 서버-클라이언트 간 API 통신 규약 정의

22 Dec 2023

본 문서에서는 타입스크립트와 GraphQL-js를 이용하여 서버와 클라이언트 간 API 통신을 위한 규약을 정의하고 구현하는 방법에 대해 다루고자 합니다.

서버 개발 환경 구축

서버 개발 환경을 구축하기 위해서는 Node.js 및 npm을 설치해야 합니다. 프로젝트 폴더를 생성한 후, 다음 npm 명령어를 실행하여 필요한 패키지를 설치합니다.

npm install graphql express apollo-server-express

GraphQL의 핵심은 스키마 정의에 있습니다. 타입스크립트를 사용하여 각 API 엔드포인트에 대한 입력과 출력의 형태를 정의합니다. 예를들어, 사용자 정보를 요청하는 API의 경우 다음과 같이 스키마를 정의할 수 있습니다.

interface User {
  id: number;
  name: string;
  email: string;
}

type Query {
  getUser(id: number): User;
}

타입스크립트를 사용하여 클라이언트에서 서버로의 요청과 서버에서의 응답 형태를 정의합니다. API 통신 시, 요청 파라미터와 응답 형태를 명확히 정의함으로써 타입 안정성을 확보할 수 있습니다.

interface GetUserRequest {
  id: number;
}

interface GetUserResponse {
  user: User;
}

GraphQL-js를 사용하여 서버에서 Resolver를 구현합니다. Resolver는 클라이언트의 요청에 대해 데이터를 반환하는 로직을 정의하는 역할을 합니다.

const resolvers = {
  Query: {
    getUser: (parent, args, context, info) => {
      // 클라이언트의 요청에 맞는 데이터 처리 로직을 구현합니다.
    },
  },
};

타입스크립트와 GraphQL-js를 활용하여 서버와 클라이언트 간 API 통신의 규약을 명확히 정의하고 구현함으로써, 런타임 에러를 방지하고 유지보수성을 향상시킬 수 있습니다.

본 문서에서는 기본적인 내용을 다루었지만, 실제 프로젝트에서는 보다 복잡한 상황과 다양한 요구사항을 고려해야 합니다.