Swagger-UI es una colección de HTML, Javascript, CSS, que puede generar dinámicamente documentos API en línea basados en anotaciones.
Notas comunes:
- @Api: se utiliza para modificar la clase Controller y generar información de documentos relacionados con el Controller
- @ApiOperation: se utiliza para modificar métodos en la clase Controller para generar información del documento relacionada con los métodos de interfaz
- @ApiParam: se utiliza para decorar los parámetros en la interfaz y generar información del documento relacionada con los parámetros de la interfaz
- @ApiModelProperty: se utiliza para modificar las propiedades de la clase de entidad, cuando la clase de entidad es un parámetro de solicitud o devuelve el resultado, genera directamente información relevante del documento
(1) Agregar dependencia en pom.xml
<!--Swagger-UI API文档生产工具-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
(2) Configuración de Spring boot 2.2.5
@EnableWebMvc
@Configuration
@EnableSwagger2
@ComponentScan(basePackages = "com.wxw.controller"