Como faço esse exercício no VSCode? Não tenho os arquivos, oriente-me como fazer.
Para realizar a atividade prática proposta, vamos seguir o passo-a-passo detalhado abaixo. Vou assumir que você já tem uma API funcional escrita com Spring Boot. Caso contrário, você precisará criar um projeto Spring Boot e adicionar ao menos um Controller com alguns métodos.
Passo 1: Incluir a Dependência do Springdoc no pom.xml
Abra o arquivo pom.xml do seu projeto e adicione a seguinte dependência dentro da tag <dependencies>:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.9</version> <!-- Verifique se há uma versão mais recente -->
</dependency>
Essa dependência é responsável por habilitar o Springdoc e o Swagger UI no seu projeto.
Passo 2: Reinicie a Aplicação
Após adicionar a dependência, reinicie sua aplicação para que as configurações tenham efeito. Se estiver utilizando uma IDE como o Spring Tool Suite ou IntelliJ, você pode fazer isso através da própria interface da IDE.
Passo 3: Acessar o Swagger UI
Com a aplicação rodando, abra um navegador de internet e acesse a URL do Swagger UI. Por padrão, essa URL será:
http://localhost:8080/swagger-ui.html
Substitua 8080 pela porta em que sua aplicação está rodando, caso seja diferente.
Passo 4: Testar os Métodos do Controller
No Swagger UI, você verá uma interface gráfica que lista todos os Controllers e métodos disponíveis na sua API. Você pode expandir cada Controller para ver os métodos específicos e seus detalhes.
Para testar um método, siga estes passos:
- Clique sobre o método que deseja testar para expandir os detalhes.
- Se o método requer parâmetros, você terá a opção de inseri-los.
- Clique no botão "Try it out" para habilitar a edição dos parâmetros, se necessário.
- Preencha os parâmetros conforme necessário e clique em "Execute".
Você verá os detalhes da requisição enviada, incluindo a URL completa, cabeçalhos e corpo da requisição (se aplicável), bem como a resposta recebida do servidor, incluindo o código de status HTTP, cabeçalhos de resposta e corpo da resposta.
