1
resposta

Erro nas PATHS

Referente ao curso Swagger: documentando suas APIs, no capítulo Definindo endpoints e atividade Recursos e verbos

por Rafaella Cavalcante
| 13.8k xp | 2 posts

Olá, vi que a minha dúvida é a mesma de outro aluno daqui do fórum, mas ele não deu prosseguimento ao atendimento. Segue meu código a seguir: 

openapi: 3.0.1
info:
  title: API de consultório
  description: API para controlar médicos e suas 
    especialidades dentro do consultório.
  version: 0.0.1
  termsOfService: https://mockapi.io
  contact:
    name: Suporte a Devs
    email: contato@example.com
    url: https://mockapi.io
  license:
    name: "Licença: GPLv3"
    url: https://www.gnu.org/licenses/gpl-3.0.html
externalDocs: 
  description: Documentação burocrática
  url: https://mockapi.io
paths:
  /especialidades:
    get:
      summary:

O erro é sinalizado no comando "/especialidades:" o qual não é reconhecido como um comando válido. Segue o print da tela tambemInsira aqui a descrição dessa imagem para ajudar na acessibilidadehttps://cdn1.gnarususercontent.com.br/1/6461214/a05808d1-6efa-47ec-8252-d0b10269a1f9.png

1 resposta
por Luis Dias
| 3375k xp | 3750 posts

Oi Rafaella,

Percebi que você está tendo um problema com a definição das paths no seu arquivo Swagger. 💪

O erro indica que está faltando a definição de responses dentro do seu endpoint /especialidades.

Em OpenAPI, toda operação HTTP (GET, POST, etc.) precisa especificar as possíveis respostas que a API pode retornar.

Você precisa adicionar um bloco responses dentro do seu get para indicar o que sua API retorna quando acessam /especialidades. ✅

Veja um exemplo de como corrigir:

paths:
  /especialidades:
    get:
      summary: Retorna a lista de especialidades
      responses:
        '200': # Código HTTP de sucesso
          description: Lista de especialidades retornada com sucesso

No exemplo acima, adicionei o bloco responses e um código de resposta '200' (sucesso).

Você pode adicionar outros códigos de resposta conforme necessário (ex: '400' para erro, '500' para erro no servidor, etc.).

🎓 Para saber mais: Objeto Responses na especificação OpenAPI.

Continue praticando e explorando as funcionalidades do Swagger! 👍