Swagger

Porroberto

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

JPA

Porroberto

Java Persistence API, más conocida por sus siglas JPA, es una API de persistencia desarrollada para la plataforma Java EE. Maneja datos relacionales en aplicaciones usando la Plataforma Java en sus ediciones Standard (Java SE) y Enterprise (Java EE). La persistencia en este contexto cubre tres áreas: La API en sí misma, definida en el…

Spring

Porroberto

Introducción La idea principal en el desarrollo del framework Spring es simplificar el trabajo del desarrollador. Se ha convertido en un estándar de facto para construir aplicaciones Java empresariales. Spring Boot es un componente del framework Spring que permite comenzar el desarrollo de una aplicación en minutos. Se basa en Convención sobre configuración (CoC). Módulos…

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.