Visão geral

Schema, um conceito fundamental na OpenAPI Specification (OAS), também é comumente chamado de Modelo de Dados. Um schema define os tipos de dados e as propriedades esperados dos objetos de requisição e resposta de uma API.

JSON Schema serve como o padrão adotado pelo Apidog para modelar as estruturas de dados empregadas pela sua API.

Com schemas, você pode:

Definir estruturas de dados padrão (como um objeto Order).

Integrar schemas a exemplos gerados automaticamente.

Reutilizar estruturas de dados repetidamente em seus projetos de API.

Finalidade do Schema no Apidog

No Apidog, os schemas desempenham um papel central em:

Finalidade	Descrição
Design de APIs	Ao definir schemas no início da fase de design, os desenvolvedores podem visualizar e refinar as estruturas de dados que suas APIs manipularão.
Serviços de Mock	O Apidog utiliza schemas definidos para gerar respostas mock, permitindo que os desenvolvedores simulem o comportamento da API e a interação com o front-end mesmo antes da implementação real.
Documentação	Uma documentação de API precisa e abrangente é gerada automaticamente com base nos schemas, facilitando a comunicação clara com os consumidores da API sobre os formatos e estruturas de dados esperados.
Depuração	Os schemas são usados para validar as respostas na depuração de APIs, garantindo que as respostas da API estejam em conformidade com os modelos de dados definidos.

Criar um Schema

Considere o escopo do seu schema: os dados serão utilizados em várias seções da API ou em várias APIs, ou são específicos de um único caso de uso?

Se a estrutura de dados for destinada a múltiplos usos, criar um schema facilita o gerenciamento centralizado e a consistência.

Você pode adicionar um schema no diretório "Schemas".

Criar o Schema

Utilize o Editor de Schema intuitivo do Apidog para criar schemas de forma eficaz, alinhados às especificações do JSON Schema.

Você também pode criar schemas importando de tabelas de banco de dados ou dados JSON/JSON schema.

Aplicar o Schema

Após estabelecer um schema reutilizável, navegue até os endpoints para referenciar os schemas nos corpos de requisição ou resposta, ou em outros schemas. Ao referenciar um modelo de dados compartilhado, você pode manter a consistência e simplificar a integração do modelo de dados entre vários componentes do design da sua API.

Finalidade do Schema no Apidog#

Criar um Schema#

Criar o Schema#

Aplicar o Schema#

Finalidade do Schema no Apidog

Criar um Schema

Criar o Schema

Aplicar o Schema