Pular para o conteúdo

OpenAPI para TypeScript

Gere tipos TypeScript a partir dos schemas de um documento OpenAPI 3 ou Swagger 2.0 em YAML ou JSON. Cada entrada em components.schemas ou, no Swagger 2.0, em definitions passa a ser uma interface exportada ou um alias de tipo; links $ref entre eles passam a ser nomes de tipos, e campos anuláveis recebem | null.

Redefinir

Perguntas frequentes

Quais partes do documento são convertidas?

Os schemas em components.schemas no OpenAPI 3 e em definitions no Swagger 2.0. Caminhos, parâmetros e respostas não são convertidos em tipos; use os tipos de schema gerados no seu próprio código de solicitação e resposta.

Como os nomes dos schemas são convertidos em nomes de tipos?

Cada chave de schema é reconstruída em PascalCase; assim, user-profile passa a ser UserProfile. Quando duas chaves gerariam o mesmo nome, a segunda recebe um número ao final.

Há suporte para campos anuláveis?

Sim. nullable: true do OpenAPI 3.0 e x-nullable: true do Swagger 2.0 adicionam | null, e arrays de tipo do OpenAPI 3.1, como ["string", "null"], passam a ser string | null.

O que acontece com as referências que a ferramenta não consegue resolver?

Um $ref que aponta para fora do documento, ou para algo que não seja um schema em components.schemas ou definitions, passa a ser unknown e é listado em um comentário no início da saída.

Há suporte para YAML?

Sim. Cole o documento como YAML ou JSON. Âncoras e aliases em YAML são expandidos antes da conversão.

Como verifico o documento primeiro?

Use o Validador OpenAPI, que lista problemas estruturais e referências inválidas. Este conversor apenas lê os schemas e não relata outros erros.

Sobre OneClick Pro

OneClick Pro é uma coleção gratuita com mais de 150 ferramentas da Web para o trabalho cotidiano: converter imagens e unidades, formatar e validar código, verificar domínios e SEO, e trabalhar com textos, datas e números. Todas as ferramentas funcionam sem registro ou assinatura, e o que você digita é usado apenas para calcular o resultado e nunca é armazenado. Use o serviço como uma caixa de ferramentas para tarefas pontuais ou salve nos favoritos as ferramentas que você usa todos os dias.