É possível utilizar o swagger para servir de documentação para uma API que ainda não existe?
Ou seja, quem vai construir a API irá se valer da documentação para poder desenvolvê-la.
Solucionado
É possível utilizar o swagger para servir de documentação para uma API que ainda não existe?
Ou seja, quem vai construir a API irá se valer da documentação para poder desenvolvê-la.
hoje, com a Alura e o Google Gemini
Olá Flavio, tudo bem?
Sim, é possível utilizar o Swagger para documentar uma API que ainda não existe. Na verdade, essa é uma prática bastante comum no desenvolvimento de APIs, já que a documentação é uma parte fundamental do processo de desenvolvimento.
Para isso, você pode utilizar o Swagger Editor para criar a especificação da sua API, definindo os endpoints, parâmetros, respostas, etc. Depois de definir a especificação, você pode utilizar o Swagger UI para visualizar a documentação da sua API.
Além disso, o Swagger também permite que você teste a sua API diretamente na interface do Swagger UI, o que pode ser bastante útil durante o processo de desenvolvimento.
Espero ter ajudado e bons estudos!
Certo. Então, neste caso, não conseguiríamos utilizar as requisições GET e POST que o swagger me dispõe, já que não teria o server, certo?
A pergunta é até óbvia, mas acho que vale a pena a resposta :D
Obrigado.
Olá Flavio!
Ao usar o Swagger, você pode testar as operações disponíveis através da interface gráfica fornecida pelo Swagger UI. Esse recurso possibilita o envio de requisições GET, POST e outros métodos HTTP para a API, visualizando também as respostas retornadas.
No entanto, é importante destacar que, para realmente interagir com a API e fazer chamadas a endpoints externos, você precisa de um servidor que implemente a lógica da API e esteja em execução. O Swagger UI por si só não é capaz de executar as operações da API sem um servidor correspondente.