Este artículo presenta un ejemplo de uso del proyecto Swagger2 en Spring Boot. Se comparte contigo. Los detalles son los siguientes:
Agregar dependencias Swagger2
Agregar dependencias de Swagger2 en pom.xml
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version></dependency><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId><version>2.2.2</version></dependency>
Crear una clase de configuración Swagger2
Cree la clase de configuración de Swagger2 Swagger2 en el nivel simultáneo de la aplicación. Java.
importar org.springframework.context.annotation.bean; import org.springframework.context.annotation.configuration; import springfox.documentation.builders.apiinfobuilder; importar springfox.documentation.builders.pathselectores; import springfox.documentation.builders.refox springfox.documentation.service.apiinfo; import springfox.documentation.spi.documentationType; import springfox.documentation.spring.web.plugins.docket; import springfox.documentation.swagger2.annotations.enablewagger2;@configuración@recaablewagger2public2public2@@@@BeGean streateriMiMes {return New Docket (documentationType.swagger_2) .ApiInfo (apiInfo ()) .select () .apis (requestHandLersElectors.BasePackage ("su propio nombre de paquete de interfaz externa")) .paths (pathselectors.any ()) .builild (); } private apiinfo apiinfo () {return new apiInfobuilder () .title ("neo4j Restful Apis") .Description ("The Neo4j RESTFUL APIS Descripción/") .Build (); }}Agregar contenido de documento
Después de completar la configuración anterior, el contenido del documento se puede producir en realidad, pero dichos documentos están dirigidos principalmente a la solicitud en sí, y la descripción proviene principalmente del nombramiento de funciones y otras funciones, que no es fácil de usar. Por lo general, necesitamos agregar algunas instrucciones para enriquecer el contenido del documento.
import io.swagger.annotations.api; import io.swagger.annotations.apioperation; import io.swagger.annotations.apiparam;/** * Controlador de usuario del sistema * * @author li qinghai * */@api (value = "interfaz de usuario del sistema", etiquetas = "gestión del sistema")@reestrontroller@requestmapping ("/v3/iba de edu/usuarios del sistema") UserController {@aUtoWired private UserService UserService; /** * Agregar usuario, registrar * * @param loginName * Iniciar sesión en Cuenta * @param Nombre de usuario * Nombre de usuario * @param contraseña * Iniciar contraseña * @param rolid * user rol * @return * @throws recouteExistSexception */@apioperation (valor = "add user") @postmapping ("/") Public jSonResult create (@apipoam (name = "", valiente "), oval. cuenta ", requirir = true) @RequestParam (requirir = true) @RequestBody String LoginName, @apiparam (name =" username ", valor =" nombre de usuario ", requerido = true) @RequestParam (requerido = true) @RequestBody String Username, @apiparam (name =" contraseña ", valor =" log en contraseña ", requerido) @RequestParam (requerido) @Apiparam (name = "rolyId", value = "Número de rol de usuario", requerido = true) @RequestParam (requerido = true) @RequestBody String rolyId) lanza ResourceExistSException {boolean exists = this.userService.Exists (LoginName); if (existe) {lanzar nueva recursosexistsexception (LoginName); } User user = Userservice.create (LoginName, Password, UserName, RoleId); devolver new JsonResult (usuario); }}Ver API
Inicie el programa Spring Boot y visite: http: // localhost: 8080/swagger-ui.html
Acceso y depuración de documentos de API
Además de ver la función de interfaz, Swagger también proporciona funciones de depuración y prueba. Podemos hacer clic en el esquema del modelo (área amarilla: indica la estructura de datos) a la derecha en la imagen de arriba. En este momento, hay una plantilla para el objeto de usuario en el valor. Solo necesitamos modificarlo ligeramente, haga clic en Pruébelo a continuación. Botón, ¡puede completar una llamada de solicitud! Se pueden usar varias solicitudes GET para verificar que la solicitud de publicación anterior sea correcta.
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.