Visão geral

Schema, um conceito fundamental na OpenAPI Specification (OAS), também é frequentemente referido como Modelo de Dados. Um schema define os tipos de dados e as propriedades esperados dos objetos de pedido e resposta da API.

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

Com schemas, você pode:

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

Integrar schemas com exemplos gerados automaticamente.

Reutilizar estruturas de dados repetidamente em todos os seus projetos de API.

Finalidade do Schema no Apidog

No Apidog, os schemas desempenham um papel fundamental em:

Finalidade	Descrição
Conceção de APIs	Ao definir schemas no início da fase de conceção, os programadores podem visualizar e aperfeiçoar as estruturas de dados que as suas APIs irão processar.
Mock de serviços	O Apidog utiliza schemas definidos para gerar respostas mock, permitindo que os programadores simulem o comportamento da API e a interação com o front-end mesmo antes da implementação real.
Documentação	A documentação da API precisa e abrangente é gerada automaticamente com base nos schemas, facilitando uma comunicação clara com os consumidores da API sobre os formatos e estruturas de dados esperados.
Depuração	Os schemas são utilizados para validar as respostas na depuração da API, garantindo que as respostas da API cumprem os modelos de dados definidos.

Criar um Schema

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

Se a estrutura de dados se destinar a múltiplas utilizações, criar um schema facilita a gestão centralizada e a consistência.

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

Construir o Schema

Utilize o Editor de Schema intuitivo do Apidog para construir schemas de forma eficaz, alinhados com as especificações do JSON Schema.

Você também pode construir schemas ao importar a partir de tabelas de base de dados ou dados JSON/JSON schema.

Aplicar o Schema

Depois de estabelecer um schema reutilizável, navegue até aos endpoints para referenciar os schemas nos corpos de pedido ou resposta, ou noutros schemas. Ao referenciar um modelo de dados partilhado, você pode manter a consistência e simplificar a integração do modelo de dados em vários componentes da conceção da sua API.

Finalidade do Schema no Apidog#

Criar um Schema#

Construir o Schema#

Aplicar o Schema#

Finalidade do Schema no Apidog

Criar um Schema

Construir o Schema

Aplicar o Schema