Na API que estou fazendo a documentação se não encontrar o registro retorna o status 200, neste caso como detalhar o not found?
Na API que estou fazendo a documentação se não encontrar o registro retorna o status 200, neste caso como detalhar o not found?
Olá Karla, tudo bem? Espero que sim!
Para detalhar o "not found" no Swagger, você pode adicionar uma resposta de erro com o código 404 e uma descrição adequada, como "Especialidade não encontrada". Além disso, você pode definir um exemplo de como essa resposta será exibida, utilizando o campo "example" no Swagger.
Aqui está um exemplo de como você pode adicionar essa resposta no Swagger:
responses:
200:
description: Sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
descricao:
type: string
404:
description: Especialidade não encontrada
content:
application/json:
example: "Not found"
Dessa forma, quando um registro não for encontrado, a API retornará o status 404 e a mensagem "Not found".
Espero ter ajudado.
Abraços e bons estudos!