Como o gerador trata campos opcionais (prop?: string)?

No TypeScript, a interrogação indica omissão permitida. No JSON Schema, propriedades são opcionais por padrão, a não ser que constem no array 'required'. Sob strictNullChecks, 'prop?: string' não entra em 'required', enquanto 'prop: string | null' permanece em 'required' com o tipo ['string', 'null'].

Quais tags JSDoc são suportadas na conversão para JSON Schema?

O texto de documentação preenche o campo 'description'. Tags como @minimum, @maximum, @minLength, @maxLength, @pattern, @format (como date-time, email, uri, uuid), @default e @deprecated tornam-se palavras-chave nativas de validação.

Qual a diferença entre a saída Draft-07 e Draft 2020-12?

O Draft-07 adota 'definitions' e arrays em 'items' para tuplas. O Draft 2020-12 utiliza '$defs', padroniza tuplas com 'prefixItems' e oferece paridade total com o OpenAPI 3.1.

É possível processar múltiplas interfaces a partir do mesmo código TypeScript?

Sim. Ao definir a interface principal, todos os tipos auxiliares, enums e interfaces importadas referenciadas são organizados modularmente dentro de '$defs' ou 'definitions' através de $ref.

Compilador de Esquema TypeScript

Gerador de JSON Schema a partir de TypeScript Interface (Draft-07 e 2020-12)

Converta interfaces TypeScript, type aliases e comentários JSDoc em esquemas JSON Schema padronizados para contratos de API e validação de formulários.

Conformidade com Draft-07 e 2020-12

Zero transmissão ao servidor

Predefinições:

Versão do Draft:

Tipo Raiz:

Chave de Definições:

Propriedades Adicionais:

Inferir Formatos InteligentesProcessar JSDoc

Indentação:

Interfaces e Tipos TypeScript0 Tipos

/**
 * Core User Profile entity for enterprise authentication and RBAC
 * @title UserProfile
 * @description Primary identity record representing an authenticated user account
 */
UserProfile {
  /**
   * Primary system UUID v4 identifier
   * @format uuid
   */
  id: string;

/**
   * Validated primary email address
   * @format email
   */
  email: string;

/**
   * Unique handle or display username
   * @minLength 3
   * @maxLength 30
   * @pattern ^[a-zA-Z0-9_-]+$
   */
  username: string;

/**
   * Age in completed calendar years
   * @minimum 18
   * @maximum 120
   */
  age?: number;

/**
   * Account activation status
   * @default true
   */
  isActive: boolean;

/**
   * Access control security role
   */
  role: 'admin' | 'editor' | 'subscriber' | 'guest';

/**
   * Primary mailing and billing address
   */
  address: Address;

/**
   * Granted OAuth 2.0 permission scopes
   */
  permissions: string[];

/**
   * Account creation ISO-8601 timestamp
   * @format date-time
   */
  createdAt: string;

/**
   * Arbitrary key-value metadata tags
   */
  metadata?: Record<string, string>;
}

/**
 * Standardized postal and geolocation address definition
 * @title Address
 */
Address {
  street: string;
  suite?: string;
  city: string;
  state: string;
  /**
   * Postal or ZIP code
   * @pattern ^[0-9]{5}(?:-[0-9]{4})?$
   */
  postalCode: string;
  country: string;
  isPrimary?: boolean;
}

84 Linhas•1435 Caracteres•1.4 KB (Bytes)

TypeScript AST Ready

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EmptySchema",
  "type": "object",
  "properties": {}
}

2020-12 ($defs)•0 Definições•0 Propriedades

0.1 KB Válido

Interfaces e Tipos

0AST analisado

Versão JSON Schema

Draft 2020-12$defs

Propriedades e Regras

0regras sintetizadas

100% Análise AST no Navegador

O parsing do TypeScript e a compilação do JSON Schema ocorrem estritamente no seu navegador. Zero dados transmitidos para servidores.

Conformidade Draft-07 e 2020-12

Total aderência aos padrões oficiais de JSON Schema, suportando $defs/definitions, prefixItems de tuplas e mapeamento estrito.

Extração JSDoc e Restrições

Reconhece @description, @minimum, @maximum, @format, @pattern e @default para gerar esquemas de alto nível prontos para produção.

Gerador de JSON Schema a partir de TypeScript Interface (Draft-07 e 2020-12)

100% Análise AST no Navegador

Conformidade Draft-07 e 2020-12

Extração JSDoc e Restrições

Guia do Desenvolvedor: Gerador de TypeScript Interface para JSON Schema (Draft-07 & 2020-12) — Guia de referência

Parâmetros principais e controles

Dicas profissionais e melhores práticas

Validação avançada via anotações JSDoc

O Draft-07 armazena interfaces

Unions comuns

Problemas comuns e solução de problemas

Tipos recursivos e referências circulares

Tipos utilitários complexos (Omit, Pick, Partial) gerando schemas vazios

Perguntas frequentes (FAQ)

Ferramentas e utilitários relacionados