Explicación detallada de cómo usar Swaggerui en Springboot

Pavonearse

Swagger es una especificación y marco independientes del lenguaje utilizados para definir las interfaces de servicio y se usa principalmente para describir API RESTful. Se centra en crear una excelente documentación y bibliotecas de clientes para API. Las API habilitadas para Swagger pueden generar documentos interactivos para los métodos API, lo que permite a los usuarios descubrir la funcionalidad de la API experimentando visualmente, viendo solicitudes y respuestas, archivos de encabezado y códigos de retorno.

Swagger se usa para definir la documentación de API.

beneficio:

1. Entrega separada delantera y trasera
2. La documentación de la API es muy clara
3. Durante las pruebas, ya no necesita usar la entrada de URL al navegador para acceder al controlador
4. La forma tradicional de ingresar a las URL es más problemática para pasar los parámetros en las solicitudes posteriores (por supuesto, puede usar complementos de navegador como Postman)
5. La integración de Spring-Boot y Swagger es más simple

Springboot incorpora swaggerui

paso

1. Jitar Package Introducción

 <Spendency> <MoupRoMID> io.springfox </groupid> <artifactid> springfox-swagger-ui </artifactid> <versión> 2.2.2 </versión> <cope> compilar </cope> </dependency> <ependency> <grupo> io.springfox </groupid> <artifactid> springfox-swagger2 </artfactiCact> <versión> 2.2.2 </versión> <cope> compilar </cope> </pendency>

2. Configuración de SwaggerConfig basado en Springboot

 @Configuration @habilswagger2public clase swaggerConfig {@Bean public docket Newsapi () {// return New Docket (DocumationType.swagger_2) .ApiInfo (apiinfo ()). Select (). Paths (PathSelectors.any ()). Build (); Docket Docket = nuevo Docket (DocumationType.Swagger_2); Docket.enable (verdadero); Docket.apiinfo (apiinfo ()). Select (). rutas (PathSelectors.any ()). Build (); expediente de retorno; } private apiinfo apiinfo () {return new apiInfobuilder (). Title ("Plataforma de prueba del centro de pedidos"). Descripción ("Aquí puede explorar todas las interfaces del proyecto y proporcionar herramientas de prueba relevantes") .terMsOfServiceUrl ("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open") .contact ("test") .liCense ("Versión de licencia de China Red Star 1.0"). Licencias ("#"). Versión ("1.0"). Build (); }}

3. Instrucciones de configuración de WebConfig

Hay un problema al que debe prestarse atención aquí. Deje que WebConfig herede WebMVCAUToconfigurationAdapter en lugar de heredar directamente WebMVCConfigurerAdapter, de lo contrario, la página Swagger no se lanzará.

 @Configuration @EnableWebMVCPublic Class WebConfig extiende WebMVCAUTOconfigurationAdapter {@Override public void addCorsMappings (Registro de corsregistry) {Registry.AddMapping ("/**"); } @Bean public static PropertySources PlaceHolderConfigurer PropertySources PlaceHolderConfigurer () {return New PropertySources PlaceHolderConfigurer (); } @Bean Public Filter caracteresCodingFilter () {caracteresCodingFilter caracteresCodingFilter = new CaracterEncodingFilter (); caracterSencodingFilter.setEncoding ("UTF-8"); caracteresCodingFilter.setforceEncoding (verdadero); return caracterescodingfilter; } @Bean Public MappingJackson2httpMessageConverter Converter () {MappingJackson2httpMessageConverter Converter = new MappingJackson2httpMessageConverter (); convertidor de retorno; } @Bean public ViewResolver getViewResolver () {internalResourCeViewResolver resolver = new InternalResourCeViewResolver (); resolver.setViewClass (jstlview.class); resolver.setPrefix ("/jsp"); resolver.setsuffix (". jsp"); Resolver de devolución; } @Bean Public StandardS.VervletMultIPartresolver getStandardservletMultIParTresObsR () {return New StandardServletMultIParTresolver (); }}

4. Acceso a la página de Swaggerui

http: // localhost: 8080/ProjectName/swagger-ui.html#!

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.