Por 9.99€ al mes tendrás acceso completo a todos los cursos. Sin matrícula ni permanencia.
En esta lección aprenderemos a documentar nuestras APIs en Spring Boot utilizando Swagger a través de la librería Springdoc OpenAPI. Esto nos permitirá generar una interfaz interactiva para visualizar y probar nuestros endpoints de manera sencilla.
Añadiremos la siguiente dependencia a nuestro pom.xml:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.6.0</version>
</dependency>Configuración de seguridad
Si nuestra aplicación usa Spring Security, es necesario permitir el acceso a las rutas de Swagger. Para ello, debemos modificar nuestra clase de configuración de seguridad (SecurityConfig.java) agregando las siguientes reglas:
com.app.config.SecurityConfig.java
.requestMatchers("/swagger-ui/**", "auth/basic/login", "/v3/api-docs/**","/v2/api-docs/**","/webjars/**").permitAll()
Este ajuste permite el acceso a:
- La interfaz de Swagger (
/swagger-ui/**) - Documentación generada en formato OpenAPI (
/v3/api-docs/**y/v2/api-docs/**) - Recursos estáticos necesarios para el correcto funcionamiento de Swagger (
/webjars/**)
Accediendo a la documentación
Una vez agregada la dependencia y configurada la seguridad, podemos acceder a la interfaz de Swagger desde nuestro navegador en la siguiente URL:
http://localhost:8080/swagger-ui/index.htmlDesde esta interfaz podremos visualizar todos los endpoints de nuestra API, enviar peticiones de prueba y ver respuestas sin necesidad de utilizar clientes HTTP externos como Postman o Curl.