0Pricing
TypeScript Academy · Aula

Geração de código OpenAPI: tipos gerados automaticamente

Gere tipos TypeScript a partir de especificações OpenAPI

Geração de código OpenAPI: tipos gerados automaticamente é uma aula grátis de TypeScript Academy no CoddyKit. Esta é a aula 3 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de TypeScript Academy, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de TypeScript Academy inclui 4 aulas no total.

Boas-vindas

A geração de código do OpenAPI gera tipos TypeScript e código de cliente a partir das especificações da API, eliminando a manutenção manual de tipos.

Por que usar geração de código

Escrever manualmente tipos para APIs grandes está sujeito a erros e pode deixá-los desatualizados. A geração de código deriva os tipos da única fonte de verdade: a especificação OpenAPI.

openapi-typescript

openapi-typescript gera tipos TypeScript a partir de um arquivo de especificação OpenAPI.
npm install -D openapi-typescript
npx openapi-typescript ./api.yaml -o ./src/types/api.ts

Tipos gerados

A ferramenta gera tipos de caminhos, operações e Schemas.
import type { paths } from './types/api';
type GetUserResponse = paths['/users/{id}']['get']['responses']['200']['content']['application/json'];

Cliente openapi-fetch

Use openapi-fetch com os tipos gerados para obter um cliente totalmente tipado.
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 gera SDKs de cliente completos em TypeScript.
npm install @openapitools/openapi-generator-cli -g
openapi-generator-cli generate -i api.yaml -g typescript-axios -o ./src/client

orval

orval gera hooks do React Query e Schemas do Zod a partir de especificações OpenAPI.
npm install -D orval
orval --input api.yaml --output src/api

Mantendo os tipos sincronizados

Execute a geração de código na CI para detectar divergências entre a especificação e os tipos gerados.

Desenvolvimento de API orientado pelo Schema

Defina primeiro a especificação OpenAPI, gere os tipos e o código do cliente e, então, implemente o servidor.

MSW com tipos gerados

Use Mock Service Worker com tipos gerados para simulações de API seguras quanto aos tipos nos testes.

Construção de URLs segura quanto aos tipos

Os clientes gerados impõem os parâmetros corretos de caminho e os formatos corretos das strings de consulta.

Verificação rápida

Qual é o principal benefício de usar a geração de código TypeScript do OpenAPI?

Recapitulação

Geração de código OpenAPI: tipos gerados automaticamente: você dominou os principais conceitos e padrões.

Perguntas Frequentes

A aula “Geração de código OpenAPI: tipos gerados automaticamente” é grátis?

Sim — o texto completo de “Geração de código OpenAPI: tipos gerados automaticamente” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de TypeScript Academy, atualize para CoddyKit PRO. O curso de TypeScript Academy inclui 4 aulas no total.

O que vou aprender em “Geração de código OpenAPI: tipos gerados automaticamente”?

Gere tipos TypeScript a partir de especificações OpenAPI Você pratica TypeScript Academy com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar TypeScript Academy?

Nenhuma experiência prévia é necessária. TypeScript Academy no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 3 de 4.

Quanto tempo leva a aula “Geração de código OpenAPI: tipos gerados automaticamente”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de TypeScript Academy?

Sim. Cada aula de TypeScript Academy inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

  1. Tipando respostas de fetch com wrappers genéricos
  2. Validação em tempo de execução com Zod
  3. Geração de código OpenAPI: tipos gerados automaticamente
  4. Visão geral do cliente tRPC com segurança de tipos
← Voltar para TypeScript Academy