Usando Discriminator

Em determinados cenários, um único objeto pode ter múltiplas formas estruturais. Por exemplo, um livro pode ser um eBook ou um livro em brochura. Nesses casos, o campo discriminator pode ser usado para distinguir entre diferentes tipos de schema.

O discriminator geralmente é usado em combinação com oneOf ou anyOf para indicar que "o valor de um campo específico determina o tipo concreto do objeto".

Propriedade	Descrição
propertyName	Especifica o nome do campo usado para diferenciar tipos.
mapping	Define o mapeamento entre valores de campo e os schemas correspondentes.

Configuração no Apidog

Método 1: Usando JSON Schema

Configurar oneOf pela interface visual

Abra o editor de requisição ou resposta da API. Selecione o campo que você deseja definir como um campo de "Composição de Schema". Clique em Configurações avançadas > Composição de Schema > oneOf e referencie o schema que você deseja combinar em oneOf, como eBook e Paperback.

Adicionar discriminator via JSON Schema

Clique em JSON Schema no editor para alternar para o modo de código.

Alternando para o modo de código JSON Schema

Adicione a configuração discriminator, por exemplo:

Substitua 10331225 e 10331226 pelos IDs do seu schema real. Você pode ver esses IDs ao abrir o painel de configuração do JSON Schema.

Verificar o resultado

Após salvar, o Apidog reconhecerá automaticamente diferentes tipos com base no campo type. Quando você Publicar a documentação, a documentação da API exibirá corretamente os tipos diferenciados.

Método 2: Importando arquivo OpenAPI

Escreva a definição em um arquivo OpenAPI YAML ou JSON, por exemplo:

Exemplo de definição completa:

Em seguida, no Apidog, escolha Importar arquivo OpenAPI.

Após a importação, o Apidog reconhecerá automaticamente o discriminator e mapeará corretamente os tipos nas definições de schema e endpoint. Quando você Publicar a documentação, a documentação da API exibirá corretamente os tipos diferenciados.

Configuração no Apidog#

Método 1: Usando JSON Schema#

Método 2: Importando arquivo OpenAPI#

Configuração no Apidog

Método 1: Usando JSON Schema

Método 2: Importando arquivo OpenAPI