Componentes

Normalmente, no design de APIs, enquanto as respostas bem-sucedidas 200 OK frequentemente diferem entre vários endpoints devido a necessidades distintas de dados de saída, respostas de erro como 400 Bad Request e 404 Not Found tendem a ser consistentes entre diferentes endpoints.

O Apidog aborda essa característica comum de forma inteligente com seu recurso Componente de Resposta, que permite a reutilização de respostas de erro predefinidas, tornando o processo de documentação da API mais eficiente e o comportamento da API mais consistente.

Compatibilidade com OAS

O recurso Componente de Resposta no Apidog é compatível com os Components no OAS.

Adicionar um Componente de Resposta

Na árvore de diretórios à esquerda do módulo APIs, navegue até a seção Componentes e clique em Nova Resposta em Respostas para criar um novo componente de resposta.

Criar um componente de resposta é semelhante a especificar a seção de resposta ao definir um endpoint em termos de inclusão de código de status HTTP, tipo de conteúdo, Schema e Exemplos. Para obter orientações detalhadas, consulte a seção Resposta em Noções Básicas de Endpoint.

Recurso Exclusivo do Componente de Resposta

Adicionado por padrão em novos endpoints: quando selecionado como "Sim", este componente será incluído automaticamente por padrão em todos os novos endpoints adicionados ao projeto.

INFO

Endpoints existentes não são afetados por esta configuração.

Referenciar Componentes de Resposta

Na seção Resposta de um endpoint, você pode referenciar um componente de resposta predefinido.

Pontos principais sobre componentes referenciados:

Componentes de resposta referenciados não podem ser modificados dentro do endpoint. Você deve fazer alterações no componente de resposta original. Quaisquer modificações feitas afetarão todos os endpoints que referenciam esse componente.

Se você quiser modificar um componente de resposta que foi referenciado em um endpoint, poderá Desreferenciá-lo. Desreferenciar transformará a resposta em uma resposta regular editável, e as alterações no componente de resposta não a afetarão mais.

Em um endpoint, um componente só pode ser referenciado uma vez; várias instâncias do mesmo componente não podem coexistir no mesmo endpoint.

Operações em Lote

Você pode Adicionar em massa os componentes de resposta existentes aos endpoints selecionados ou Remover este componente em massa dos endpoints selecionados.

Observações:

Se o endpoint selecionado já incluir este componente de resposta, ele não será adicionado novamente.

Se o endpoint selecionado não contiver este componente de resposta, a ação de remoção não terá efeito.

Modelo de Resposta Padrão

Muitas empresas têm uma estrutura padronizada para suas respostas. Nesses casos, você pode aproveitar o Modelo de Resposta Padrão para manter a estrutura fixa da empresa como o modelo de resposta padrão.

Na árvore de diretórios à esquerda, na seção Componentes, você pode acessar e utilizar o recurso Modelo de Resposta Padrão.

Quando um novo endpoint é criado, o conteúdo deste modelo é usado como a resposta inicial.

Principais características:

Alterações feitas no modelo de resposta padrão afetarão apenas novos endpoints, e os existentes permanecerão inalterados.

Existe um único modelo de resposta padrão, que não pode ser adicionado nem removido.

O modelo de resposta padrão inicial é uma Resposta de Sucesso 200 com um tipo de conteúdo JSON e uma estrutura de dados de um nó Object vazio.

FAQ

P: Posso usar um componente de resposta como a resposta padrão?

R: Não, componentes de resposta são destinados a respostas de erro genéricas, como 400, 404 e códigos de status semelhantes. Se você precisar usar uma resposta padrão fixa, use o modelo de resposta padrão.

Adicionar um Componente de Resposta#

Recurso Exclusivo do Componente de Resposta#

Referenciar Componentes de Resposta#

Operações em Lote#

Modelo de Resposta Padrão#

FAQ#

Adicionar um Componente de Resposta

Recurso Exclusivo do Componente de Resposta

Referenciar Componentes de Resposta

Operações em Lote

Modelo de Resposta Padrão

FAQ