Gerar schemas a partir de JSON etc.

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

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

Gerando a partir de JSON/XML

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

Observações importantes

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

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

Campos como descrição e mock serão deixados em branco.

Modo de sobrescrita

Quando um schema é Generated from JSON pela segunda vez, os dados recém-importados sobrescreverão o schema existente que já foi gerado. Nesse cenário, há dois modos de sobrescrita:

Mesclar (Padrão): Quando uma chave correspondente é encontrada, o mock e a descrição do schema original serão mantidos.

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

Estilo de nomenclatura

Você pode escolher o estilo de nomenclatura adequado:

Manter como está

camelCase

PascalCase

snake_case

Salvar como exemplo

Ao usar Generate from JSON no corpo da requisição ou na resposta, habilitar Save as Example incluirá o JSON/XML atual como um exemplo de requisição/resposta ao gerar o schema.

Gerando a partir de JSON Schema

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

Importando do banco de dados

O Apidog oferece suporte a dois métodos para gerar schemas a partir de tabelas de banco de dados. O primeiro método envolve conectar-se diretamente ao banco de dados para ler as estruturas das tabelas, enquanto o segundo método consiste em colar SQL DDL para reconhecer a estrutura da tabela.

Conexões de banco de dados

Para importar schema de bancos de dados, siga estas etapas:

Configure a conexão com o banco de dados. Saiba mais sobre Gerenciar conexão de banco de dados.

Bancos de dados compatíveis

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

Selecione a conexão de banco de dados em Import from database.

Selecione as tabelas a serem importadas.

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

Configurações de comprimento de campo

Quando a alternância Follow database field length está habilitada, o Apidog definirá os valores mínimos e máximos de comprimento da propriedade com base nos comprimentos dos campos definidos na tabela.

Inserir SQL (DDL)

Cole a instrução CREATE da tabela do banco de dados (DDL) para gerar o schema. Oferece suporte a SQL compatível com MySQL.

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

Gerar schemas a partir de JSON etc.

Gerando a partir de JSON/XML#

Modo de sobrescrita#

Estilo de nomenclatura#

Salvar como exemplo#

Gerando a partir de JSON Schema#

Importando do banco de dados#

Conexões de banco de dados#

Inserir SQL (DDL)#