Springboot项目--swagger配置

川长思鸟来 2023-07-10 12:47 25阅读 0赞

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw_size_16_color_FFFFFF_t_70]  
配置好了 大概就是这个样子，由于项目涉及私密信息，所以请原谅我打马赛克。  
首先 在springboot项目的config目录下  
创建类 SwaggerConfig

import com.google.common.base.Function;
    import com.google.common.base.Optional;
    import com.google.common.base.Predicate;
    import com.ncxp.easy.properties.SwaggerProperties;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Profile;
    import springfox.documentation.RequestHandler;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    /** * @ClassName: SwaggerConfig * @Description: Swagger2配置 * @Author: lxt * @Date: 2019-09-18 14:36 * @Version 1.0 **/
    @Configuration
    @EnableSwagger2
    @Profile("dev")
    public class SwaggerConfig { 
        @Autowired
        private SwaggerProperties swaggerProperties;
        // 定义分隔符
        private  final static  String splitor = ";" ;
        @Bean
        public Docket createRestApi() { 
    
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    //这里是controller所处的多包名
                    .apis(basePackage("com.ncxp.easy.rest"+splitor+"com.ncxp.easy.shoprest"))
    // .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .build();
    // return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
        }
        //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
        private ApiInfo apiInfo() { 
            return new ApiInfoBuilder()
                    //页面标题
                    .title(swaggerProperties.getTitle())
                    //创建人
                    .contact(new Contact(swaggerProperties.getContactName(), swaggerProperties.getContactUrl(),swaggerProperties.getContactEmail()))
                    //版本号
                    .version(swaggerProperties.getVersion())
                    //描述
                    .description(swaggerProperties.getDescription())
                    .build();
        }
    
        /** * 重写basePackage方法，使能够实现多包访问，复制贴上去 * @author teavamc * @date 2019/1/26 * @param [basePackage] * @return com.google.common.base.Predicate<springfox.documentation.RequestHandler> */
        public static Predicate<RequestHandler> basePackage(final String basePackage) { 
            return input -> declaringClass(input).transform(handlerPackage(basePackage)).or(true);
        }
    
        private static Function<Class<?>, Boolean> handlerPackage(final String basePackage)     { 
            return input -> { 
                // 循环判断匹配
                for (String strPackage : basePackage.split(splitor)) { 
                    boolean isMatch = input.getPackage().getName().startsWith(strPackage);
                    if (isMatch) { 
                        return true;
                    }
                }
                return false;
            };
        }
    
        private static Optional<? extends Class<?>> declaringClass(RequestHandler input) { 
            return Optional.fromNullable(input.declaringClass());
        }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw_size_16_color_FFFFFF_t_70 1]

之后在 WebMvcConfig中配置 WebMvcConfig中加入解决404的错误方法

/** * @Title: addResourceHandlers * @Description: 映射本地磁盘为静态目录 * @param: registry * @throws: */
    	@Override
    	public void addResourceHandlers(ResourceHandlerRegistry registry){ 
    		FileUtil.uploadSuffixPath = uploadSuffixPath;
    		FileUtil.uploadLocalPath = uploadLocalPath;
    		registry.addResourceHandler(uploadSuffixPath +"/**").addResourceLocations("file:"+uploadLocalPath);
    		// 解决 swagger-ui.html 404报错
    		registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
    		// 解决swagger的js文件无法访问
    		registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    	}

最后在  
![在这里插入图片描述][20200302162010410.png]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw_size_16_color_FFFFFF_t_70 2]  
例如：

#swagger配置
    swagger.title=james
    swagger.description=james restful api
    swagger.version=1.0
    swagger.contactName=Tenscen
    swagger.contactEmail=
    swagger.contactUrl=
    swagger.basePackage=com.aaa.aaaaaa;com.bbb.bbbbb
    //如果多个接口包的话中间加;即可
    swagger.termsOfServiceUrl=

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200302161250646.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200302161828616.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw==,size_16,color_FFFFFF,t_70
[20200302162010410.png]: https://img-blog.csdnimg.cn/20200302162010410.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200302162528499.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZyaXN0amNqZG5jZw==,size_16,color_FFFFFF,t_70