Swagger

Java

Configuración

Para añadir documentación a nuestra aplicación [Api Rest](Cómo crear un API REST con Spring Boot) se siguen los siguientes pasos:

1. OpenApi

Se añade al pom.xml la siguiente dependencia:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.2.0</version>
</dependency>

Y en la url http://localhost:8080/v3/api-docs ya podemos ver la documentación asociada a la api.

2. Integración con Swagger

OpenApi ya está integrado por defecto con swagger.

Se puede ver la documentación swagger asociada a la api en http://localhost:8080/swagger-ui.html

3. Generar documentación

Se hace con @Operationy @ApiResponses

Enlaces

  • https://www.bezkoder.com/spring-boot-swagger-3/
  • https://springdoc.org/
  • https://www.bezkoder.com/spring-boot-swagger-3/

Publicaciones Similares

  • Buenas prácticas de programación Java

    Porroberto

    Usar una estructura de proyecto estándar src ├── main │ ├── java Application/Library sources │ ├── resources Application/Library resources │ ├── filters Resource filter files │ └── webapp Web application sources │ └── test ├── java Test sources ├── resources Test resources         └── filters              …

  • Maven – Saltar tests

    Porroberto

    Para saltar la ejecución y compilación de los tests: mvn -Dmaven.test.skip=true install Para compilar los tests, pero no ejecutarlos: mvn -Dmaven.test.skip=true install

  • Buenas prácticas

    Porroberto

    Usar una estructura de proyecto estándar src ├── main │ ├── java Application/Library sources │ ├── resources Application/Library resources │ ├── filters Resource filter files │ └── webapp Web application sources │ └── test ├── java Test sources ├── resources Test resources         └── filters              …

  • Maven

    Porroberto

    Básico maven build → compila el código del proyecto maven clean → elimina los ficheros generados por builds anteriores maven generate-sources → genera código para incluirlo en la compilación. maven install → instala los paquetes de la biblioteca en un repositorio local, compi­la el proyecto y lo comprueba.