Documentación de APIs con Swagger en Spring Boot
Contenido del curso
Xavier Zabala M.
Alejandro Rico García
Ivan Santiago Barrera Medina
Jean Michael Lozano Cardoso
Rafael Antonio Solano Londoño
Emiliano Perez
luisa maria
Luis Angel Flores Galindo
Jessenia Toapanta
Milexys Ferrer
Cristian David Restrepo Marin
Jose Oscar Rosas Perez
Marco Tulio Linares
Alejandro Ramírez
ProfesorWilliam Alexander Hernandez Leiva
Daniel Aristizabal castaño
Ivan Santiago Barrera Medina
Giovanny Herrera garcia
Bryan David Arteaga Satian
Kevin Garavi
Eduardo Obreque Hevia
Paula Abad
Dave Juanes
Juan Camilo Sandoval Hernandez
Carlos Ricardo Alvarez Perez
Jesel Valle Rivera
Yesid Rodelo
Roberto Fernández Romero
Gustavo Medina Limon
Gustavo Pú
Luis Gonzalez
Luis Gonzalez
Rafael Camacho
Jhonatan Javier Garcia Castañeda
Cristian David Restrepo Marin
Jeisson Santiago Cortes Ortiz
Massimo Di Berardino
Santiago Alvarez Buitrago
Manuel Eguiluz
Alejandro Ramírez
ProfesorManuel Eguiluz
Edinson Padrón
Alejandro Ramírez
ProfesorEdinson Padrón
Pablo Ochoa
Cristian David Restrepo Marin
Walter Jesus Santiago Gonzalez
Leonardo Salazar Serna
Carlos Romero
Gio De La Rosa
Felix Rafael Garcia Martinez
Jonnathan Lozano Moreira
Si están utilizando la versión 3.0.0 de swagger, se debe tener en cuenta lo siguiente:
En el archivo bundle.gradle se debe añadir las siguientes líneas implementation "io.springfox:springfox-boot-starter:3.0.0" compile "io.springfox:springfox-swagger-ui:3.0.0"
En la clase SwaggerConfig ya no hace falta añadir la anotación @EnableSwagger2
La url de acceso a la documentación es: {host}:{puerto} / {contexto} /swagger-ui/index.html
Gracias por el aporte, me sirvió bastante
Muchas gracias por el aporte!!
Para el 2023 ya existe una dependencia llamada Spring doc OpenApi, que te permite implementar Swagger sin la necesidad de crear beans.
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
Y en tu application.properties colocar la url de swagger
springdoc.swagger-ui.path=/swagger-ui.html
Y listo, ya tienen el swagger funcionando con pocos pasos
Excelente aporte veo que este curso se deberia actualizar varios videos y los comentarios destacados
Excelente aporte!
para los que les sale el error de NullPointerException lo unico que deben hacer es ir al application.properties y agregar esta linea spring.mvc.pathmatch.matching-strategy = ANT_PATH_MATCHER
Gracias, funciona super bien! :D
Me funcionó! muchas gracias :)
Hola, si llegan a tener un error de NullPointerException sin razón alguna, sólo deben bajar la version de SpringBoot de 2.6.1 a 2.5.5 (estuve rato lidiando con ese error)
muchas gracias, me funcionó!
Igual no se a que se deba este error pero tu solución me funciono, gracias.
Me hubiera gustado que se toque un tema importante en la capa de servicios como lo son las transacciones. Espero que salga el curso avanzado de spring.
Seguro lo tendremos en cuenta! ;) Gracias por tu recomendación.
Aun que no se toco el tema de las transacciones puedes utilizar la anotación @Transactional en el servicio y colocarsela a los metodos que la requieren como lo es: save, update, delete para que así se menejen y haga un rollback si algo falla, también puedes utilizar la anotación @Transactional a nivel de toda la clase pero esta debe de llevar una especificación extra que es: readOnly = true
Una forma para ponerle un poco mas de detalle a nuestras APIS.
Muchas gracias por el aporte!!
Si usan la versión 3.0.0 de swagger y les aparece un null o este error : ->Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerException
pueden solucionarlo agregando: -> spring.mvc.pathmatch.matching-strategy = ANT_PATH_MATCHER en el application.properties
en el build.gradle: -> implementation “io.springfox:springfox-boot-starter:3.0.0”
Nota: En mi caso elimine del archivo SwaggerConfig la anotación @EnableSwagger2 . -> estoy usando la versión 2.6.4 de Spring.
Gracias, me sirvió tu ayuda. También quiero agregar que cuando usé la versión 3.0.0 de swagger, para acceder tuve que ingresar (en mi caso) de la siguiente manera: 'h ttp://localhost{puerto}/platzi-market/api/swagger-ui/index.html' Pueden ver que ahora cambia la parte de: swagger-ui/index.html.
Gracias cracks! Sus aportes me sirvieron para utilizar la versión 3.0.0
Para los que están usando Spring Boot v3, no tienen que usar las librerías mencionadas en el video, solo tienen que usar Spring doc, para eso agreguen en el build.grade la siguiente linea:
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
Solo con eso ya van a poder acceder a Swagger a través de la siguiente URL:
http://localhost:8080/platzi-market/api/swagger-ui/index.html
Y para finalizar les dejo la equivalencia de los annotations de Swagger UI en Spring doc que deben usar en el ProductController:
Si quieren más información la pueden encontrar en esta página:
https://springdoc.org/v2/index.html#migrating-from-springfox
Excelente, muchas gracias. Funciono perfecto. Tengo una duda en el método getProduct con adiciona la anotación @Parameter, yo cambia value por descripción. Es correcto si lo hice de está forma? Agradezco la solución.
Muchas gracias para el caso de @Parameter pueden usar estos metodos
(@Parameter(   name = "id",   description = "The id of the product",   required = true,   example = "7" )
Desde la versión 3 de spring la librería de swagger fue modificada, y ahora usada springdoc. Instalación: En el build.gredel
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
en el application.properties hacemos la siguiente modificacion:
springdoc.swagger-ui.path=/swagger-ui.html
No es necesario crear el archivo Swagger.config Con esto ya tendremos la aplicacion deaplegada con la siguiemte url : localhost:{puerto}/{context-path}/swagger-ui/index.html
Muchas gracias Julian, esta aportacion me salvo!!!
Me salvaste la vida. Tenía problemas con esto y me marcaba erros. Con tu aportación ya corrió la aplicación. Muchas gracias
Para el año en que escribo este comentario ya se encuentra la versión 3 de Spring boot, pero la última versión de Swagger, no es compatible con esta, por lo que incorpora Jakarta en vez de Javax, por tal motivo es necesario bajar la versión de Spring boot, ademas hay configuraciones que el maestro hace las cuales ya no son necesarias:
implementation "io.springfox:springfox-boot-starter:3.0.0"
Esta unica importación ya engloba las dos anterios por que lo necesitas volver a agregarlas
La notacion @EnableSwagger2 debes reemplazarla por @EnableWebMvc
la url de acceso es la misma que recomiendan en otros comentarios: https://localhost:8080/platzi-market/api/swagger-ui/index.html
Nota: Recuerda que el puerto debes agregar el que estés usando
Muchísimas gracias compañero, grande!
Esta es la Solución Recomendada para Swagger 3.0.0
Estaba trabajando con spring 3.0 y después de un par de horas la mejor solución fue bajar a spring 2.7.6. Sigan el consejo de Yesid y evitense problemas.
La forma en la que el profesor implementa Swagger ya no funciona hoy en día, le dejo el link de maven repository para que solo copien y agreguen el archivo build.gradle
// https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui implementation group: 'org.springdoc', name: 'springdoc-openapi-ui', version: '1.5.12'
lo pueden ver en la documentación: https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui/1.5.12
Recuerden ya no va ser necesario crear en archivo SwaggerConfig que crea el profesor.
para acceder a la documentacion:
http://localhost:8090/api/swagger-ui.html
Espero les sirva !!
Gracias TavoCode! Me sirvió muchísimo!
Oye y como le adiciono las descripciones e info adicional sobre cada metodo?
Como más abajo mencionaron, actualmente la clase SwaggerConfig no hay que crearla, tengan en cuenta que usé el spring boot 3.3.0, y usé java 17 (Amazon Coretto). Así fue como me pudo correr la aplicacion: build.gradle
Genial, esto era lo que le faltaba que alguien enseñara Este curso mil veces mejor de lo que esperaba
x2
Saldra un curso con spring en donde se desarrolle una aplicacion integrando frontend? seria muy chevere.
Hola Jeisson, gracias por la recomendación se la compartiré al equipo para tenerlo en cuenta :)
Opino lo mismo
Este vídeo se me hace que quedó corto. Me parece genial el vídeo pero quizá un par de vídeos extras agregando el uso de examples y tags en los endpoints, así como su uso en conjunto con bean validation hubiese sido de mayor provecho.
Muchas gracias por tu recomendación Manuel!, la tendré muy en cuenta. Quise incluir este tema para demostrar como se documenta con Swagger y así robustecer más nuestro proyecto. Swagger tiene varios temas que incluso darían para un pequeño curso exclusivo para esta herramienta, ¿te gustaría?
Sí, vendría genial un curso de swagger con spring boot.
Quiero compartir con ustedes el proyecto que he estado usando con el fin de aprender Spring boot y que pueden encontrar en GitLab acá.
Puntos a tener en cuenta:
Está genial tu proyecto, felicidades! #NuncaParesDeAprender 🚀
Muchas gracias, don @soyalejoramirez/.
Excelente swagger2 y muy practico, seria bueno un curso para ver mas detalles
x2
Solución que funciono para mi 26-11-2023
7/12/2023 Confirmo!
Siendo el 19/12/2023, también confirmo.
Para poder utilizar Swagger 3.0.0 con la versión de Spring 2.7.7 es necesario agregar en el build.gradle:
implementation 'io.springfox:springfox-swagger2:3.0.0' implementation "io.springfox:springfox-boot-starter:3.0.0" implementation 'io.springfox:springfox-swagger-ui:3.0.0' compileOnly "io.springfox:springfox-swagger-ui:3.0.0"
Y en el file de config:
@Configuration @EnableWebMvc
Gracias! justo me hacía falta esa dependencia para utilizar la versión 3.0.0 :D
implementation "io.springfox:springfox-boot-starter:3.0.0"
Siendo el 18/01/2024 a las 11h30, confirmo que esta clase solo es informativa a dia de hoy, ya que si buscan en maven repository, la implementacion springfox-swagger2 en su version 2.9.2 ya no se puede usar debido a que sus recursos generan vulnerabilidades (el website informa de esto en la info sobre esta version) y si la usas e intentas cargar tu server, simplemente arroja error de version deprecada y se detiene.
Usen los ejemplos de juan Camilo Sandoval hernandez, Alexandra Jimenez o Victor Hugo Vazquez Gomez, los recomiendo si usan gradle a partir de 2024.
Busquen los comentarios mas recientes por favor.
