Springboot integra springfox3 + knife4j y genera documentos de interfaz

En este blog, registraremos la configuración básica y el uso de springfox3; dado que swagger-ui no parece muy cómodo, también presentamos knife4j para usar la versión mejorada de swagger front-end ui.

Nota

La anotación @ ConditionalOnProperty declara que cuando springfox.documentation.enabled es verdadero, se habilitará la configuración, lo cual es verdadero de forma predeterminada (solo se recomienda usar Swagger durante desarrollo);

El siguiente es un ejemplo de WebMvcConfig.

@ApiImplicitParam

Se utiliza en la anotación @ApiImplicitParams para especificar todos los aspectos de los parámetros de solicitud

nombre: nombre del parámetro

valor: chino descripción de caracteres de los parámetros. requerido: si se deben pasar parámetros

paramType: dónde colocar los parámetros

- encabezado --> Solicitar adquisición de parámetros: @RequestHeader

- consulta --> adquisición Parámetros de solicitud: @RequestParam

- ruta (para interfaces tranquilas) --> Solicitud de adquisición de parámetros: @PathVariable

- cuerpo (no se usa comúnmente)

- formulario (No se usa comúnmente)

tipo de datos: tipo de parámetro, el valor predeterminado es cadena, otros valores son tipo de datos="Integer"

valor predeterminado: valor predeterminado del parámetro

Página swagger: dirección del proyecto + /swagger-ui/index.html

Página Knife4j: dirección del proyecto + /doc.html

Página Knife4j: dirección del proyecto + /doc.html

1. En swagger3, configurar parámetros globales no funciona 2.