Gerador de Classe Ruby para JSON Schema

Entrada Código Ruby

Carregando editor…

Saída JSON Schema

Configurações

Selecione qual classe deve ser tratada como raiz do JSON Schema.

A análise ocorre inteiramente no seu navegador. Seu código não sai da página.

Cole suas classes Ruby para produzir JSON Schema instantaneamente.

Suporta declarações attr_accessor/attr_reader, classes aninhadas e ignora métodos.

Como converter classes em Ruby para JSON Schema – guia passo a passo

Este conversor online de classe Ruby para JSON Schema ajuda você a gerar JSON Schema a partir de modelos reais (DTOs, structs e classes) para validar payloads, compartilhar contratos e gerar JSON mock.

  1. Etapa 1 – Cole sua fonte em Ruby

    • Cole os modelos que você quer documentar no editor à esquerda.
    • Inclua tipos referenciados no mesmo trecho para que o schema possa gerar definitions.
    • Use o botão Exemplo para carregar um exemplo e ver o formato de entrada esperado.
  2. Etapa 2 – Selecione o Classe raiz (se necessário)

    • Se múltiplas definições forem detectadas, escolha a raiz que corresponde ao payload da sua API.
    • O schema de saída é construído em torno da raiz selecionada e pode incluir definições adicionais para tipos referenciados.
  3. Etapa 3 – Revise a saída do JSON Schema

    • Verifique tipos, campos obrigatórios vs opcionais e estruturas aninhadas de objeto/array.
    • Procure por definitions e $ref quando seus modelos referenciam outros modelos.
    • Copie ou baixe o schema para validação, documentação ou desenvolvimento schema-first.
  4. Etapa 4 – Valide ou gere JSON mock

    • Clique em Gerar dados mock para abrir o gerador de mock com seu schema pré-carregado.
    • Valide payloads reais contra o schema para detectar breaking changes cedo.
    • Se você depender de composição avançada de schema (por exemplo anyOf/oneOf/allOf), verifique o resultado com um validador completo como o Ajv.

Observação sobre suporte a keywords de schema

Schemas gerados podem incluir $ref e podem ser editados para incluir anyOf, oneOf, ou allOf. Para schemas complexos, use um validador completo de JSON Schema e faça dereference antes de gerar mock data, se necessário.

Ferramentas relacionadas de JSON Schema e geração de código

Use estas ferramentas para validar schemas, gerar payloads mock, formatar exemplos JSON e manter código e contratos alinhados.

Perguntas Frequentes

Quais construções Ruby são suportadas?

O parser foca em classes que expõem atributos via declarações attr_reader/attr_accessor. Cada atributo vira uma propriedade do JSON Schema. Métodos e outros códigos Ruby são ignorados, então você pode colar classes de modelo com segurança.

Como os atributos são tipados?

Como Ruby é dinâmico, os atributos são definidos como `string` no schema por padrão. Você pode refinar tipos fornecendo defaults literais; atualizações futuras lerão comentários de tipo. Por enquanto, esta ferramenta fornece um schema estrutural rápido para DTOs.

Por que usar esta ferramenta?

Ao compartilhar objetos de domínio Ruby ou DTOs tipo ActiveModel com outras equipes, um JSON Schema ajuda a documentar payloads e validar contratos. Este conversor roda inteiramente no navegador.

Como obter payloads JSON mock?

Depois de gerar o schema, clique em "Gerar dados mock" para abrir o Mock Generator com o schema pré-carregado e criar payloads de exemplo instantaneamente.

Gerador de Classe Ruby para JSON Schema | JSONSwiss