TypeScript Academy · Lekcja

Schemat GraphQL na typy TypeScript

Generuj typy z plików .graphql za pomocą codegen.

Schemat GraphQL na typy TypeScript to bezpłatna lekcja TypeScript Academy na CoddyKit. To lekcja 1 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej TypeScript Academy, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs TypeScript Academy zawiera 4 lekcji w sumie.

Problem: rozbieżność schematu i typów

W projektach GraphQL schemat serwera i typy TypeScript po stronie klienta łatwo tracą synchronizację bez automatyzacji. Generowanie kodu rozwiązuje ten problem, wyprowadzając typy bezpośrednio ze schematu.

# Without codegen: manual types that drift from schema
interface User { id: string; name: string; } // may not match schema

GraphQL Code Generator

@graphql-codegen/cli odczytuje schemat GraphQL i automatycznie generuje typy TypeScript.

npm install --save-dev @graphql-codegen/cli @graphql-codegen/typescript

Konfiguracja codegen.yml

Źródło schematu i lokalizację danych wyjściowych należy skonfigurować w pliku codegen.yml.

# codegen.yml
schema: "./api/schema.graphql"
generates:
  src/generated/types.ts:
    plugins:
      - typescript

Uruchamianie generatora

Należy uruchomić graphql-codegen, aby wygenerować typy TypeScript na podstawie schematu.

npx graphql-codegen
# Generates src/generated/types.ts with all schema types

Przykład wygenerowanych danych wyjściowych

Wygenerowany plik zawiera interfejsy TypeScript odpowiadające każdemu typowi GraphQL w schemacie.

// src/generated/types.ts (generated)
export type User = {
  __typename?: "User";
  id: string;
  name: string;
  email: string;
};

export type Query = {
  __typename?: "Query";
  user?: Maybe<User>;
};

Schemat ze zdalnego punktu końcowego

Codegen może również pobrać schemat z działającego punktu końcowego GraphQL za pomocą introspekcji.

# codegen.yml with remote schema
schema:
  - https://api.example.com/graphql:
      headers:
        Authorization: "Bearer ${AUTH_TOKEN}"

Mapowanie typów skalarnych

Niestandardowe skalary GraphQL można mapować na typy TypeScript w konfiguracji codegen.

# codegen.yml
config:
  scalars:
    DateTime: string
    JSON: Record<string, unknown>
    Upload: File

Obsługa wyliczeń

Wyliczenia GraphQL są mapowane na wyliczenia napisowe TypeScript lub typy unii, zależnie od konfiguracji codegen.

# Generated from GraphQL enum Role { ADMIN USER GUEST }
export enum Role {
  Admin = "ADMIN",
  User = "USER",
  Guest = "GUEST",
}

Non-Null i Maybe

Pola GraphQL dopuszczające wartość null stają się w wygenerowanych typach wartościami Maybe (czyli T | null | undefined), odzwierciedlając możliwość wystąpienia wartości null określoną w schemacie.

// GraphQL: name: String (nullable)
// Generated: name?: Maybe<string>

// GraphQL: id: ID! (non-null)
// Generated: id: string

Integracja z CI

Należy uruchamiać codegen w CI, aby sprawdzać, czy wygenerowane typy są aktualne. Kompilacja powinna zakończyć się niepowodzeniem, jeśli schemat zmienił się bez ponownego wygenerowania typów.

# CI: check no drift
npx graphql-codegen --check
# Exits 1 if generated files are out of date

Podsumowanie: od schematu do typów

GraphQL Code Generator odczytuje schemat i automatycznie tworzy typy TypeScript. Należy skonfigurować go za pomocą codegen.yml, uruchamiać graphql-codegen i zintegrować z CI, aby zapobiegać rozbieżnościom schematu.

Szybkie sprawdzenie

Jaki jest główny cel GraphQL Code Generator?

Czego się Państwo nauczyli

GraphQL Code Generator eliminuje rozbieżności między schematem a typami, generując kod TypeScript na podstawie schematu. Należy skonfigurować go za pomocą codegen.yml, mapować niestandardowe skalary i zintegrować z CI, aby zapewnić aktualność typów.

Często zadawane pytania

Czy lekcja „Schemat GraphQL na typy TypeScript” jest bezpłatna?

Tak — pełny tekst „Schemat GraphQL na typy TypeScript” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu TypeScript Academy, przejdź na CoddyKit PRO. Kurs TypeScript Academy zawiera 4 lekcji w sumie.

Co nauczysz się w „Schemat GraphQL na typy TypeScript”?

Generuj typy z plików .graphql za pomocą codegen. Ćwiczysz TypeScript Academy z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć TypeScript Academy?

Nie wymagamy żadnego doświadczenia. TypeScript Academy w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 1 z 4.

Ile czasu zajmuje lekcja „Schemat GraphQL na typy TypeScript”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji TypeScript Academy?

Tak. Każda lekcja TypeScript Academy zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

Schemat GraphQL na typy TypeScript
Typowane resolvery z GraphQL Code Generator
Typowany klient GraphQL z Apollo i urql
Bezpieczeństwo typów od końca do końca: schemat jako źródło

← Powrót do TypeScript Academy