[typescript] 타입스크립트와 GraphQL에서 API 확장하기

11 Dec 2023

typescript

GraphQL은 서버 측 개발을 할 때 타입 안정성을 제공하는 강력한 도구입니다. 타입스크립트와 함께 사용하면 더욱 효과적으로 API를 개발하고 확장할 수 있습니다. 이번에는 타입스크립트와 GraphQL을 함께 사용하여 API를 확장하는 방법에 대해 알아보겠습니다.

1. 타입스크립트로 GraphQL 스키마 정의하기

먼저, 타입스크립트를 사용하여 GraphQL 스키마를 정의해야 합니다. 이때 GraphQL 스키마를 타입스크립트로 정의하면 타입 안정성을 확보할 수 있습니다.

// schema.ts
import { buildSchema } from 'graphql';

const schema = buildSchema(`
  type Query {
    hello: String
  }
`);

export default schema;

위의 예제에서는 hello 필드를 갖는 간단한 GraphQL 스키마를 타입스크립트로 정의한 것입니다.

2. 타입스크립트로 Resolver 구현하기

다음으로, 타입스크립트를 사용하여 Resolver를 구현해보겠습니다. Resolver를 타입스크립트로 정의하면 GraphQL 스키마와의 호환성을 보장할 수 있습니다.

// resolvers.ts
const resolvers = {
  Query: {
    hello: () => 'Hello, world!',
  },
};

export default resolvers;

위의 예제에서는 hello 필드에 대한 Resolver를 간단히 구현한 것입니다.

3. 타입 안정성 확보하기

타입스크립트를 사용하면 GraphQL 스키마와 Resolver 사이의 타입 불일치 문제를 사전에 방지할 수 있습니다. 이를 통해 API를 확장하고 변경할 때 발생할 수 있는 오류를 사전에 방지할 수 있습니다.

4. API 확장하기

타입스크립트와 GraphQL을 함께 사용하면 API를 보다 안전하게 확장할 수 있습니다. 새로운 필드나 타입을 추가할 때 타입스크립트의 강력한 타입 시스템을 활용하여 런타임 오류를 방지할 수 있습니다.

API를 확장하는 예시:

// schema.ts
import { buildSchema } from 'graphql';

const schema = buildSchema(`
  type Query {
    hello: String
    welcome: String
  }
`);

export default schema;

// resolvers.ts
const resolvers = {
  Query: {
    hello: () => 'Hello, world!',
    welcome: () => 'Welcome to the API!',
  },
};

export default resolvers;

결론

타입스크립트와 GraphQL을 함께 사용하여 API를 개발하고 확장하는 방법에 대해 알아보았습니다. 타입 안정성과 코드 예측성을 제공하는 타입스크립트와 유연성을 제공하는 GraphQL을 함께 사용하면 안전하고 유지보수하기 쉬운 API를 구축할 수 있습니다.

참고문헌: