Swagger - aplicar documentação de forma global indicando o tipo do retorno | APIs Rest com Asp.NET Core 2.1 Parte 3: padronizando a API

1
resposta

Referente ao curso APIs Rest com Asp.NET Core 2.1 Parte 3: padronizando a API, no capítulo Descobrindo a API e atividade (continuação) Documentação customizada

por Douglas Carpenedo

| 31.4k xp | 4 posts

Através da implementação na interface "IOperationFilter" na classe "AuthResponsesOperationFilter" documentamos de forma "global" o erro "401-Unauthorized".

É possível fazer a mesma coisa (documentar de forma global) para o erro "500-Server Error", indicando que o retorno será do tipo "ErroResponse"?

Nota: no caso do erro 401, nenhum tipo é retornado. No casso do erro 500, retornamos um "ErroResponse". Não encontrei nenhuma maneira de indicar o tipo retornado na documentação "global".

1 resposta

por Marcelo Oliveira

| 977.3k xp | 1845 posts

Alura Scuba Team

01/07/2019

Oi Douglas, tudo bem?

Acredito que você possa adicionar o código 500 no mesmo método Apply da classe AuthResponsesOperationFilter :

public void Apply(Operation operation, OperationFilterContext context)
{
    operation.Responses.Add(
        "401", 
        new Response { Description = "Unauthorized" });
    operation.Responses.Add(
        "500", 
        new Response { Description = "Internal server error" });            
}

O que acha?