PricingLoginStart free
TypeScript Academy · Lektion

Fra GraphQL-skema til TypeScript-typer

Generér typer fra .graphql-filer med codegen

Lektion 1 af 413 trin

Fra GraphQL-skema til TypeScript-typer er en gratis TypeScript Academy-lektion på CoddyKit. Dette er lektion 1 af 4. Du kan læse hele lektionen gratis nedenfor — og derefter øve dig praktisk i browseren med en indbygget kodeeditor og en AI-vejleder, der er tilgængelig døgnet rundt. Den er en del af læringsforløbet i TypeScript Academy, og dine fremskridt synkroniseres på tværs af nettet og CoddyKit-appen. TypeScript Academy-kurset indeholder 4 lektioner i alt.

Problemet: Uoverensstemmelse mellem skema og typer

I GraphQL-projekter kommer serverskemaet og klientens TypeScript-typer let ud af trit uden automatisering. Kodegenerering løser problemet ved at udlede typer direkte fra skemaet.

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

GraphQL Code Generator

@graphql-codegen/cli læser dit GraphQL-skema og genererer automatisk TypeScript-typer.

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

Konfiguration af codegen.yml

Konfigurér skemakilden og placeringen af resultatet i codegen.yml.

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

Kør generatoren

Kør graphql-codegen for at generere TypeScript-typer fra dit skema.

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

Eksempel på genereret resultat

Den genererede fil indeholder TypeScript-grænseflader, der svarer til alle GraphQL-typer i dit skema.

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

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

Skema fra et eksternt slutpunkt

Codegen kan også hente skemaet fra et aktivt GraphQL-slutpunkt ved hjælp af introspektion.

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

Tilknytning af skalartyper

Tilknyt brugerdefinerede GraphQL-skalarer til TypeScript-typer i codegen-konfigurationen.

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

Håndtering af enumerationer

GraphQL-enumerationer knyttes til TypeScript-strengenumerationer eller uniontyper afhængigt af codegen-konfigurationen.

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

Non-Null og Maybe

GraphQL-felter, der kan være null, bliver til Maybe (det vil sige T | null | undefined) i de genererede typer, hvilket afspejler skemaets nullbarhed.

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

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

Integration med CI

Kør kodegenerering i CI for at kontrollere, at de genererede typer er ajourførte. Få bygget til at fejle, hvis skemaet er ændret uden at blive genereret igen.

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

Opsummering: Fra skema til typer

GraphQL Code Generator læser dit skema og producerer automatisk TypeScript-typer. Konfigurér det med codegen.yml, kør graphql-codegen, og integrér det i CI for at forhindre uoverensstemmelser mellem skema og typer.

Hurtigt tjek

Hvad er det primære formål med GraphQL Code Generator?

Besvar den i den interaktive lektion

Det har du lært

GraphQL Code Generator fjerner uoverensstemmelser mellem skema og typer ved at generere TypeScript ud fra dit skema. Konfigurér det med codegen.yml, tilknyt brugerdefinerede skalarer, og integrér det i CI for at sikre, at typerne er ajourførte.

Gratis at komme i gang

Lær TypeScript med en AI-underviser — gratis

Skriv og kør rigtig kode i din browser, få øjeblikkelig hjælp fra en AI-underviser døgnet rundt, og fortsæt, hvor du slap, på web eller i appen.

Kurser
101
Lektioner
352
Start gratisSe hele kurset

Ofte stillede spørgsmål

Er lektionen “Fra GraphQL-skema til TypeScript-typer” gratis?

Ja — hele teksten til “Fra GraphQL-skema til TypeScript-typer” kan læses gratis her på nettet. Hvis du vil øve dig interaktivt med en indbygget kodeeditor og en AI-vejleder døgnet rundt og få adgang til resten af TypeScript Academy-kurset, skal du opgradere til CoddyKit PRO. TypeScript Academy-kurset indeholder 4 lektioner i alt.

Hvad lærer jeg i “Fra GraphQL-skema til TypeScript-typer”?

Generér typer fra .graphql-filer med codegen Du øver dig i TypeScript Academy med praktisk kode, som du kører direkte i browseren, og en AI-vejleder døgnet rundt besvarer dine spørgsmål, mens du arbejder dig gennem lektionen.

Skal jeg have erfaring for at begynde på TypeScript Academy?

Der kræves ingen tidligere erfaring. TypeScript Academy på CoddyKit er tilrettelagt for både begyndere og øvede, så du kan starte her eller fra begyndelsen og lære i dit eget tempo. Dette er lektion 1 af 4.

Hvor lang tid tager lektionen “Fra GraphQL-skema til TypeScript-typer”?

De fleste CoddyKit-lektioner tager cirka 5–10 minutter. Hver lektion er kort og interaktiv, så du gør løbende fremskridt og kan fortsætte, hvor du slap – på både web og app.

Kan jeg skrive og køre kode i denne TypeScript Academy-lektion?

Ja. Alle TypeScript Academy-lektioner har en indbygget kodeeditor, så du kan skrive og køre rigtig kode direkte i din browser og få øjeblikkelig feedback fra AI – uden lokal opsætning.

Alle lektioner i dette kursus

  1. Fra GraphQL-skema til TypeScript-typer
  2. Typede resolvers med GraphQL Code Generator
  3. Typet GraphQL-klient med Apollo og urql
  4. Typesikkerhed fra ende til anden: Schema-first-workflow
← Tilbage til TypeScript Academy