Solucionado (ver solução)
Solucionado
(ver solução)
2
respostas

Swagger (Spring Boot) exemplos de response personalizados por requisição dos controllers

Olá como estão?

Estou com uma dúvida sobre o swagger com Spring boot.

É possível editar os exemplos de resposta para cada Metodo dos controllers?

  • Por exemplo:

Tenho um controller responsável por ramificação de linhas (telefones). Neste controller tenho os metodos GET, POST e PUT.

Cada método tem sua resposta padrão http response code (que no exemplo abaixo é 200). E o body de toda resposta segue como abaixo:

{
    "codError": 0,
    "descError": "successful",
    "dto": {
        "result": [
            "5550000026",
            "5550000027",
            "5550000028",
            "5550000029",
            "5550000030",
            "5550000031",
            "5550000032",
            "5550000033",
            "5550000034",
            "5550000035"
        ]
    }
}

Com um codigo de erro persnalizado, descrição do erro e um dto.

O dto para cada método tem um conteúdo personalizado.

E é ai que esta minha dúvida. Como eu poderia personalizar essas saídas no swagger, para que facilite o desenvolvedor frontend?

Eu gostaria de personalizar, informando, se dar falha x, o dto será x, falha y o dto será y.

Existe maneira de configurar o swagger assim?

Poderiam ajudar em como configurar desta maneira?

Obrigado!

2 respostas
solução!

Oi Rafael,

Existe a possibilidade de personalizar várias coisas com a documentação gerada pelo Swagger, mas acredito que do jeito que você mencionou não teria como, pois precisaria envolver uma classe contendo várias informações para cada possibilidade de retorno.

O jeito vai ser criar uma documentação manual para o time frontend entender cada retorno em cada cenário.

Bons estudos!

Obrigado!