openapi-ts/openapi-typescript

O que é?

Recursos principais

• 01Converte schemas OpenAPI 3 estáticos em definições de tipos TypeScript.
• 02Oferece o openapi-fetch, um cliente fetch tipado com base nos tipos gerados a partir do schema.
• 03Detecta incompatibilidades entre chamadas do cliente e definições da API em tempo de compilação.
• 04Dá suporte ao OpenAPI 3.1, conforme indicado pelos tópicos do projeto.

Casos de uso

• Gerar modelos tipados de cliente de API para um app frontend a partir do arquivo OpenAPI do backend.
• Criar um cliente fetch com segurança de tipos para uma API REST existente.
• Manter os tipos do cliente sincronizados com um schema de API em constante mudança no CI.

Início rápido

1. 1

   Instale openapi-typescript pelo npm

   npm i -D openapi-typescript typescript
2. 2

   Gere tipos a partir de um esquema OpenAPI

   npx openapi-typescript https://petstore3.swagger.io/api/v3/openapi.json -o ./petstore.d.ts

Tópicos

Perguntas frequentes

O que é openapi-typescript?

Gera tipos TypeScript a partir de schemas OpenAPI 3 e oferece um cliente fetch com segurança de tipos baseado neles. openapi-typescript é um monorepo com dois pacotes para trabalhar com schemas OpenAPI em TypeScript. O pacote principal, openapi-typescript, converte um schema OpenAPI 3 estático em definições de tipos TypeScript, permitindo verificar caminhos de requisição, parâmetros e corpos de resposta em tempo de compilação, em vez de escrevê-los manualmente.

openapi-typescript é gratuito? Qual é a licença?

openapi-typescript é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.

openapi-typescript ainda é mantido?

Atualizado nos últimos 6 meses. O último commit de openapi-typescript foi em 25 de set. de 2026.

Para que posso usar openapi-typescript?

Gerar modelos tipados de cliente de API para um app frontend a partir do arquivo OpenAPI do backend. Criar um cliente fetch com segurança de tipos para uma API REST existente. Manter os tipos do cliente sincronizados com um schema de API em constante mudança no CI.

Como instalar openapi-typescript?

Instale openapi-typescript pelo npm: npm i -D openapi-typescript typescript Gere tipos a partir de um esquema OpenAPI: npx openapi-typescript https://petstore3.swagger.io/api/v3/openapi.json -o ./petstore.d.ts

Onde consigo openapi-typescript?

O código-fonte e as instruções de instalação estão no GitHub: https://github.com/openapi-ts/openapi-typescript