Si su empresa no ha usado Swagger o incluso ha oído hablar de Swagger, date prisa y aprende este blog, cinco minutos de integración rápida, estilo tonto, pero una aplicación tan simple seguramente los sorprenderá.
Primero, damos una breve introducción a Swagger: Swagger es una herramienta mágica para el desarrollo de back-end y un canal para la comunicación front-end. ¿Qué puedes hacer con Swagger? En primer lugar, básicamente puedes despedirte de las pruebas unitarias en el futuro; En segundo lugar, ya no tiene que escribir documentos de interfaz, y no necesita mantener los documentos después de escribirlos. Swagger puede simular completamente las solicitudes HTTP, y la diferencia entre los parámetros entrantes y salientes y las condiciones reales es casi cero. Dicho esto, ¡solo hagamos información!
Integrado de cuatro partes:
Paso 1: Importar dos dependencias. Si no es un proyecto Maven, puede buscar el paquete JAR. Recuerde que solo se necesitan dos. Vi que presenté siete u ocho de ellos en otros tutoriales, lo cual es un desperdicio.
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version></dependency><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version></dependency>
Paso 2: Agregue una clase (copie la siguiente, tenga en cuenta que puede modificar el nombre y la dirección del paquete)
/** * Configuración de Swagger * * @author wq * @since 2017-05-16 */ @enablewebmvc @habilswagger2 @configurationPublic clase swaggerConfig {@Bean publicocket createTapi () {return New Dockket (documentatype.swagger_2) .apiinfo (apiinfo ().). .APIS (requestHandLerLectors.BasePackage ("com.z*.b*.c*.controller")) // Tenga en cuenta que modifica el nombre del paquete aquí.paths (pathelectores.any ()) .Build (); } private apiinfo apiinfo () {return new apiinfobuilder () .title ("Interface List v1.1.0") // any, por favor regule un poco.description ("interface test") // any, por favor regule un poco.termaSofServiceUrl ("http: //url/swagger-ui.htmll" PROPIO IP: PORT .CONTACT ("Laowu") // No importa (aquí está el alias del autor) .Version ("1.1.0") .Build (); }} Paso 3: Agregue la siguiente configuración al archivo de configuración de MVC. ¡Quizás su archivo se llame despachador.xml! (Solo copia, no se requiere modificación)
<mvc: recursos mapping = "swagger-ui.html" ubicación = "classpath:/meta -inf/recursos/"/>> <mvc: asignación de recursos = "/webjars/**" ubicación = "classpath:/meta-inf/recursos/webjars/"/>>>>
Paso 4: Agregar anotaciones en métodos y parámetros
Método:
@Apioperation (valor = "tutorial", httpmethod = "post", notas = "tutorial")
Ponlo en el registro:
@Apiparam (requerido = true, name = "test", valor = "parámetro tutorial")
Me preocupa que algunos amigos no lo entiendan, ¡así que pongamos una foto!
Paso 5: Inicie el servicio e ingrese en el navegador:
http: // ip: puerto/swagger-ui.html
Aparece la siguiente pantalla significa que la tarea está completa:
Nota: Si usa un interceptor en su proyecto, libera el recurso Swagger (aún puede copiar la siguiente configuración directamente, no dude V2)
<mvc: excluir-mapping ruta = "/swagger*/**"> </mvc: excluir-mapping> <mvc: excluir-mapping ruta = "/v2/**"> </mvc: excluir mapping> <mvc: excluir mapping ruta = "/webjars/**"> </mvc: excluir-mapping>
Lo anterior es todo el contenido de este artículo. Espero que sea útil para el aprendizaje de todos y espero que todos apoyen más a Wulin.com.