...
1. Configuración
| Info |
|---|
Con la configuración actual de las APIs, con el parent fundewebjs-api-parent (ver Creación y estructura de proyecto SpringBoot o Migración de APIs a Parent FundeWebJS), no es necesario realizar ninguna configuración de librerías en pom.xml. |
| Expandir |
|---|
| title | Ver configuración antigua. |
|---|
|
Cambios a realizar:
1.1 pom.xmlAñadir la versión y las dependencias: | Bloque de código |
|---|
| <properties>
...
<springdoc.version>1.6. |
6<12</springdoc.version>
...
</properties
<!-- API DOC -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webmvc-core</artifactId>
<version>${springdoc.version}</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-hateoas</artifactId>
<version>${springdoc.version}</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-data-rest</artifactId>
<version>${springdoc.version}</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-security</artifactId>
<version>${springdoc.version}</version>
</dependency> |
| Advertencia |
|---|
NO SUBIR A GITLAB NUNCA, BAJO NINGÚN CONCEPTO, EL POM.XML CON LA DEPENDENCIA:
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId> |
1.2. application.propertiesEstas variables se incluyen para la configuración local, por si se quisiera realizar alguna comprobación levantando swagger-ui, pero ya estará configurada en los entornos. NO HACE FALTA PARA LOS ENTORNOS.
Preguntar a MNCS ante cualquier duda.
| Bloque de código |
|---|
| # SpringDoc OpenAPI Documentation
springdoc.api-docs.path=/api-docs
# Propiedades inventadas para reubicar las peticiones
springdoc.server.url=https://apidesa.um.es
springdoc.server.path=/${app.author}/${app.apiname}
springdoc.security.issuer-uri=${cas.url}/cas/oidc |
Las propiedades:
- app.author
- app.apiname
- cas.url
Deben estar declaradas previamente siguiendo la página de confluence: Migración del backend a soporte oAuth. |
...
2. Documentar servicios
Para documentar correctamente nuestros servicios, SpringDoc/Swagger ofrece varias anotaciones, tanto a nivel de clase como de método:
...