SpringBoot整合Swagger的简单用法

水深无声 2022-05-21 11:41 168阅读 0赞

## pom.xml ##

<parent>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-parent</artifactId>
    	<version>2.1.1.RELEASE</version>
    </parent>
    <properties>
    	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    	<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    	<java.version>1.8</java.version>
    </properties>
    <dependencies>
    	
    	<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-web</artifactId>
    	</dependency>
    	<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter</artifactId>
    	</dependency>
    	<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-logging</artifactId>
    	</dependency>
    	
    	
    	<dependency>
    		<groupId>io.springfox</groupId>
    		<artifactId>springfox-swagger2</artifactId>
    		<version>2.9.2</version>
    	</dependency>
    	<dependency>
    		<groupId>io.springfox</groupId>
    		<artifactId>springfox-swagger-ui</artifactId>
    		<version>2.9.2</version>
    	</dependency>
    	
    	
    	<dependency>
    		<groupId>com.alibaba</groupId>
    		<artifactId>fastjson</artifactId>
    		<version>1.1.41</version>
    	</dependency>
    	<dependency>
    		<groupId>commons-lang</groupId>
    		<artifactId>commons-lang</artifactId>
    		<version>2.6</version>
    	</dependency>
    </dependencies>
    
    <build>
    	<plugins>
    		<plugin>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-maven-plugin</artifactId>
    		</plugin>
    	</plugins>
    </build>

## SpringBoot启动类 ##

@SpringBootApplication
    @EnableSwagger2
    public class Application { 
    
    	public static void main(String[] args) { 
    		SpringApplication.run(Application.class, args);
    	}
    	@Bean
        public Docket createRestApi() { 
            return new Docket(DocumentationType.SWAGGER_2)
                    // 指定构建api文档的详细信息的方法：apiInfo()
                    .apiInfo(apiInfo())
                    .select()
                    // 指定要生成api接口的包路径
                    .apis(RequestHandlerSelectors.basePackage("com"))
                    //使用了 @ApiOperation 注解的方法生成api接口文档
                    //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .paths(PathSelectors.any())
                    //可以根据url路径设置哪些请求加入文档，忽略哪些请求
                    .build();
        }
    
        /** * 设置api文档的详细信息 */
        private ApiInfo apiInfo() { 
            return new ApiInfoBuilder()
                    // 标题
                    .title("Spring Boot集成Swagger2")
                    // 接口描述
                    .description("swagger")
                    // 联系方式
                    .contact("")
                    // 版本信息
                    .version("1.0")
                    // 构建
                    .build();
        }
    }

## `controller`，直接来图，不弄代码了 ##

![这里写图片描述](https://img-blog.csdn.net/20180706145530620?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70)
    ![这里写图片描述](https://img-blog.csdn.net/20180706145928630?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70)

## 启动查看运行效果，访问路径：`ip + 端口 + 工程名 + swagger-ui.html` ##

![这里写图片描述](https://img-blog.csdn.net/20180706152615592?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMwMDM4MTEx/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70)

![这里写图片描述][70]

## 如果访问不了ui ##

import com.fasterxml.jackson.core.JsonGenerator;
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.DeserializationFeature;
    import com.fasterxml.jackson.databind.JsonSerializer;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.SerializerProvider;
    import com.fasterxml.jackson.databind.module.SimpleModule;
    import org.apache.commons.lang3.StringEscapeUtils;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.http.converter.HttpMessageConverter;
    import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
    import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
    import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
    
    import java.io.IOException;
    import java.util.List;
    
    @Configuration
    public class WebConfig extends WebMvcConfigurationSupport { 
    
        @Bean
        public MappingJackson2HttpMessageConverter customJackson2HttpMessageConverter() { 
            MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
            ObjectMapper objectMapper = new ObjectMapper();
            objectMapper.configure(
                    DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
            objectMapper.getSerializerProvider().setNullValueSerializer(
                    new JsonSerializer<Object>() { 
                        @Override
                        public void serialize(Object value, JsonGenerator jgen,
                                              SerializerProvider provider) throws IOException,
                                JsonProcessingException { 
                            jgen.writeString("");
                        }
                    });
            // 进行HTML解码
            objectMapper.registerModule(new SimpleModule().addSerializer(
                    String.class, new JsonSerializer<String>() { 
                        @Override
                        public void serialize(String value, JsonGenerator jgen,
                                              SerializerProvider provider) throws IOException,
                                JsonProcessingException { 
                            jgen.writeString(StringEscapeUtils.unescapeHtml4(value));
                        }
                    }));
            jsonConverter.setObjectMapper(objectMapper);
            return jsonConverter;
        }
    
        @Override
        public void configureMessageConverters(
                List<HttpMessageConverter<?>> converters) { 
            converters.add(customJackson2HttpMessageConverter());
            super.addDefaultHttpMessageConverters(converters);
        }
    
        /** * 发现如果继承了WebMvcConfigurationSupport，则在yml中配置的相关内容会失效。 需要重新指定静态资源 * * @param registry */
        @Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) { 
            registry.addResourceHandler("/**").addResourceLocations(
                    "classpath:/static/");
            registry.addResourceHandler("swagger-ui.html").addResourceLocations(
                    "classpath:/META-INF/resources/");
            registry.addResourceHandler("/webjars/**").addResourceLocations(
                    "classpath:/META-INF/resources/webjars/");
            super.addResourceHandlers(registry);
        }
    
        /** * 配置servlet处理 */
        @Override
        public void configureDefaultServletHandling(
                DefaultServletHandlerConfigurer configurer) { 
            configurer.enable();
        }
    }

[70]: /images/20220521/cd593aeb3e9c48c0936030535483089d.png