TypeScript Academy · Lektion

OpenAPI-kodgenerering: automatiskt genererade typer

Generera TypeScript-typer från OpenAPI-specifikationer

Lektion 3 av 413 steg

OpenAPI-kodgenerering: automatiskt genererade typer är en gratis lektion i TypeScript Academy på CoddyKit. Detta är lektion 3 av 4. Ni kan läsa hela lektionen gratis nedan och sedan öva praktiskt i webbläsaren med en inbyggd kodredigerare och en AI-handledare som är tillgänglig dygnet runt. Den ingår i lärvägen för TypeScript Academy, och Era framsteg synkroniseras mellan webben och CoddyKit-appen. Kursen i TypeScript Academy innehåller totalt 4 lektioner.

Välkommen

OpenAPI codegen genererar TypeScript-typer och klientkod från API-specifikationer, vilket eliminerar manuellt underhåll av typer.

Varför codegen

Att skriva typer manuellt för stora API:er leder lätt till fel och typerna blir snabbt inaktuella. Codegen härleder typerna från den enda källan till sanning: OpenAPI-specifikationen.

openapi-typescript

openapi-typescript genererar TypeScript-typer från en OpenAPI-specifikationsfil.
npm install -D openapi-typescript
npx openapi-typescript ./api.yaml -o ./src/types/api.ts

Genererade typer

Verktyget genererar typer för sökvägar, operationer och scheman.
import type { paths } from './types/api';
type GetUserResponse = paths['/users/{id}']['get']['responses']['200']['content']['application/json'];

Klienten openapi-fetch

Använd openapi-fetch med de genererade typerna för en helt typad klient.
import createClient from 'openapi-fetch';
const client = createClient<paths>({ baseUrl: 'https://api.example.com' });
const { data, error } = await client.GET('/users/{id}', { params: { path: { id: 1 } } });

Swagger Codegen

Swagger Codegen genererar kompletta klient-SDK:er i TypeScript.
npm install @openapitools/openapi-generator-cli -g
openapi-generator-cli generate -i api.yaml -g typescript-axios -o ./src/client

orval

orval genererar React Query-hooks och Zod-scheman från OpenAPI-specifikationer.
npm install -D orval
orval --input api.yaml --output src/api

Håll typer synkroniserade

Kör codegen i CI för att upptäcka avvikelser mellan specifikationen och de genererade typerna.

Schema-first API-utveckling

Definiera OpenAPI-specifikationen först, generera typer och klientkod och implementera sedan servern.

MSW med genererade typer

Använd Mock Service Worker med genererade typer för typsäker API-mockning i tester.

Typsäker konstruktion av URL:er

Genererade klienter säkerställer korrekta sökvägsparametrar och strukturer för query strings.

Snabbtest

Vilken är den främsta fördelen med att använda OpenAPI TypeScript codegen?

Sammanfattning

OpenAPI codegen: automatiskt genererade typer: du har bemästrat de viktigaste koncepten och mönstren.
Gratis att börja

Lär dig TypeScript med en AI-lärare – gratis

Skriv och kör riktig kod i webbläsaren, få omedelbar hjälp av en AI-lärare dygnet runt och fortsätt där du slutade – på webben eller i appen.

Kurser
101
Lektioner
352

Vanliga frågor

Är lektionen ”OpenAPI-kodgenerering: automatiskt genererade typer” gratis?

Ja – hela texten till ”OpenAPI-kodgenerering: automatiskt genererade typer” kan läsas gratis här på webben. Om Ni vill öva interaktivt med en inbyggd kodredigerare och en AI-handledare som är tillgänglig dygnet runt och låsa upp resten av kursen i TypeScript Academy, kan Ni uppgradera till CoddyKit PRO. Kursen i TypeScript Academy innehåller totalt 4 lektioner.

Vad lär jag mig i ”OpenAPI-kodgenerering: automatiskt genererade typer”?

Generera TypeScript-typer från OpenAPI-specifikationer Ni övar på TypeScript Academy med praktisk kod som körs direkt i webbläsaren, medan en AI-handledare som är tillgänglig dygnet runt svarar på Era frågor under lektionen.

Behöver jag någon erfarenhet för att börja lära mig TypeScript Academy?

Du behöver inga förkunskaper. Utbildningen i TypeScript Academy på CoddyKit är upplagd för allt från nybörjare till avancerade elever, så att du kan börja här eller från början och gå fram i din egen takt. Detta är lektion 3 av 4.

Hur lång tid tar lektionen ”OpenAPI-kodgenerering: automatiskt genererade typer”?

De flesta CoddyKit-lektioner tar cirka 5–10 minuter. Varje lektion är kort och interaktiv, så att du gör stadiga framsteg och kan fortsätta precis där du slutade – på webben eller i appen.

Kan jag skriva och köra kod i den här TypeScript Academy-lektionen?

Ja. Varje TypeScript Academy-lektion innehåller en inbyggd kodredigerare, så att du kan skriva och köra riktig kod direkt i webbläsaren och få omedelbar AI-feedback – utan lokal installation.

Alla lektioner i den här kursen

  1. Typa fetch-svar med generiska wrappers
  2. Validering vid körning med Zod
  3. OpenAPI-kodgenerering: automatiskt genererade typer
  4. Översikt över typsäker tRPC-klient
← Tillbaka till TypeScript Academy