4
respostas

Configurar o Swagger e Redoc no projeto

Olá pessoal,

Estou tentando configurar o oSwagger e o Redoc no projeto mas não estou conseguindo, quando tento acessar a documentação dos enpoints tanto pelo Swagger quanto pelo Redoc dá erro.

Alguém pode me ajudar?

4 respostas

Olá, Rodrigo.

Tudo bem?

Compartilha mais detalhes por gentileza, como por exemplo, em que aula você está, e qual o erro que está aparecendo. Assim fica melhor para uma resposta mais assertiva.

Sigo aguardando o seu retono. Qualquer dúvida manda aqui. Valeu.

Eu criei uma página html para exibir as documentação via Redoc e quandpo tento abrir no browser aparece esse erro: ![](Insira aqui a descrição dessa imagem para ajudar na acessibilidade )

Oi Rodrigo.

O erro que você mencionou indica que o Redoc não consegue carregar o documento da API a partir do endpoint especificado, ou seja, o Redoc está tentando acessar o endpoint http://localhost:8082/v3/api-docs, mas o servidor respondeu com um código de status 404 Not Found. Isso significa que o endpoint não foi encontrado no servidor.

  • Possíveis Causas:
    • O servidor não está em execução ou está em uma porta diferente da esperada.
    • O endpoint /v3/api-docs não está sendo exposto corretamente pelo servidor.
    • A URL especificada no Redoc está incorreta.

Passos para Resolver:

  1. Verifique se o servidor está em execução:

    • Certifique-se de que sua aplicação está rodando no localhost na porta 8082. Tente acessar http://localhost:8082 no navegador para confirmar.
  2. Verifique o Endpoint:

    • Acesse http://localhost:8082/v3/api-docs diretamente no navegador. Se você ver uma resposta JSON com a documentação da API, o endpoint está funcionando corretamente.
    • Se você não conseguir acessar, verifique a configuração do Swagger no seu projeto.
  3. Corrija a URL no HTML do Redoc:

    • Certifique-se de que a URL especificada no arquivo HTML do Redoc está correta.
  4. Verifique a Configuração do Swagger:

    • Certifique-se de que o Swagger está configurado corretamente para expor o endpoint /v3/api-docs.

Com base no erro, esses pontos podem te ajudar. Qualquer coisa ,amda aqui de novo.

Consegui resolver aqui, obrigado!