Gerar esquemas a partir de JSON, etc.

Ao criar um esquema, o Apidog oferece uma ferramenta muito útil que lhe permite identificar e criar rapidamente um esquema a partir de dados existentes. Ao clicar em Generate from JSON etc., entra na ferramenta de importação de estrutura de dados.

Aqui, pode colar o seu JSON, XML, JSON Schema e Import from Database, e o Apidog irá gerar automaticamente um esquema com base nesses dados.

Gerar a partir de JSON/XML

Para JSON/XML, tudo o que precisa de fazer é colar o JSON ou XML existente na área designada, e este será automaticamente reconhecido e convertido no esquema e nos tipos de dados correspondentes.

Notas importantes

O reconhecimento inteligente de JSON serve para gerar estruturas de dados com base no JSON fornecido, sem guardar os valores contidos no próprio JSON.

Todas as propriedades presentes em JSON/XML serão tratadas como required.

Campos como descrição e mock ficarão em branco.

Modo de substituição

Quando um esquema é Gerado a partir de JSON pela segunda vez, os dados recém-importados irão substituir o esquema existente que já foi gerado. Neste cenário, existem dois modos de substituição:

Unir (predefinição): Quando é encontrada uma chave correspondente, o mock e a descrição do esquema original serão mantidos.

Substituir: Todos os dados existentes serão descartados, e os novos dados irão substituir completamente os dados antigos.

Estilo de nomenclatura

Pode escolher o estilo de nomenclatura adequado:

Manter como está

camelCase

PascalCase

snake_case

Guardar como exemplo

Ao utilizar Generate from JSON no corpo do pedido ou na resposta, ativar Save as Example irá incluir o JSON/XML atual como um exemplo de pedido/resposta ao gerar o esquema.

Gerar a partir de JSON Schema

Basta colar um JSON Schema para permitir o reconhecimento visual da estrutura de dados.

Importar a partir de base de dados

O Apidog suporta dois métodos para gerar esquemas a partir de tabelas de base de dados. O primeiro método envolve a ligação direta à base de dados para ler as estruturas das tabelas, enquanto o segundo método consiste em colar SQL DDL para reconhecer a estrutura da tabela.

Ligações à base de dados

Para importar esquemas a partir de bases de dados, siga estes passos:

Configure a ligação à base de dados. Saiba mais sobre Gerir ligação à base de dados.

Bases de dados suportadas

O Apidog Free suporta bases de dados MySQL, SQL Server, Oracle e PostgreSQL, enquanto a versão paga também inclui suporte para ClickHouse, MongoDB e Redis.

Selecione a ligação à base de dados em Import from database.

Selecione as tabelas a importar.

Configure as opções de importação. Para definições de configuração específicas, consulte as secções anteriores sobre o tratamento de JSON/XML.

Definições de comprimento dos campos

Quando a opção Follow database field length está ativada, o Apidog irá definir os valores mínimos e máximos de comprimento das propriedades com base nos comprimentos dos campos definidos na tabela.

Introduzir SQL (DDL)

Cole a instrução CREATE da tabela da base de dados (DDL) para gerar o esquema. Suporta SQL compatível com MySQL.

Para definições de configuração específicas, consulte as secções anteriores sobre o tratamento de JSON/XML.

Gerar esquemas a partir de JSON, etc.

Gerar a partir de JSON/XML#

Modo de substituição#

Estilo de nomenclatura#

Guardar como exemplo#

Gerar a partir de JSON Schema#

Importar a partir de base de dados#

Ligações à base de dados#

Introduzir SQL (DDL)#

Gerar a partir de JSON/XML

Modo de substituição

Estilo de nomenclatura

Guardar como exemplo

Gerar a partir de JSON Schema

Importar a partir de base de dados

Ligações à base de dados

Introduzir SQL (DDL)