Componentes

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

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

Compatibilidade com OAS

A funcionalidade 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 para a secção Componentes e, em seguida, clique em Nova Resposta em Respostas para criar um novo componente de resposta.

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

Funcionalidade Única do Componente de Resposta

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

INFO

Os endpoints existentes não são afetados por esta definição.

Referenciar Componentes de Resposta

Na secção Resposta de um endpoint, pode referenciar um componente de resposta predefinido.

Pontos-chave sobre componentes referenciados:

Os componentes de resposta referenciados não podem ser modificados dentro do endpoint. Tem de efetuar alterações no componente de resposta original. Quaisquer modificações efetuadas terão impacto em todos os endpoints que referenciam este componente.

Se pretender modificar um componente de resposta que tenha sido referenciado num endpoint, pode Remover a referência. Remover a referência transformará a resposta numa resposta normal editável, e as alterações ao componente de resposta deixarão de a afetar.

Num 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

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

Notas:

Se o endpoint selecionado já incluir este componente de resposta, este 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 Predefinido

Muitas empresas têm uma estrutura normalizada para as suas respostas. Nestes casos, pode tirar partido do Modelo de Resposta Predefinido para manter a estrutura fixa da empresa como o modelo de resposta predefinido.

Na árvore de diretórios à esquerda, na secção Componentes, pode aceder e utilizar a funcionalidade Modelo de Resposta Predefinido.

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

Características principais:

As alterações efetuadas ao modelo de resposta predefinido terão impacto apenas em novos endpoints; os existentes permanecerão inalterados.

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

O modelo de resposta predefinido 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 utilizar um componente de resposta como resposta predefinida?

R: Não, os componentes de resposta destinam-se a respostas de erro genéricas, como 400, 404 e códigos de estado semelhantes. Se precisar de utilizar uma resposta predefinida fixa, utilize o modelo de resposta predefinido.

Adicionar um Componente de Resposta#

Funcionalidade Única do Componente de Resposta#

Referenciar Componentes de Resposta#

Operações em Lote#

Modelo de Resposta Predefinido#

FAQ#

Adicionar um Componente de Resposta

Funcionalidade Única do Componente de Resposta

Referenciar Componentes de Resposta

Operações em Lote

Modelo de Resposta Predefinido

FAQ