swagger使用过程中遇到的坑

不念不忘少年蓝@ 2022-09-02 05:17 292阅读 0赞

# 前言 #

今天给两个项目添加swgger 都不顺利这里将，两个项目中遇到问题和解决方案贴出来。

# 基本配置 #

这里先贴出比较通用的swgger 的配置

1、添加swgger 的配置

<dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>2.0.5</version>
            </dependency>

2、添加swgger 的配置config。

@Configuration
    @EnableSwagger2
    @Component
    @ConditionalOnProperty(name = "custom.swagger.enable", havingValue = "true")
    public class SwaggerConfig { 
    
    }

3、添加一下yml的swgger 是否启动的按钮

custom:
      swagger:
        enable: true

# 问题1 #

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

1、发现接口文档上面并没有请求参数的描述。

网上的描述关于这个的排查有  
@ApiModel(description = “描述”) 中description 中有特殊符号导致请求参数无法展现，而自己项目并没有特殊符号。  
翻看关于knife4j的文档介绍的文档介绍。  
https://doc.xiaominfo.com/knife4j/documentation/  
看到这么一句话  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 1]

查看该项目使用springboot 的项目所用版本号为2.5.0，knife4j 用的2.0.5 。猜想是否是springboot 和knife4j的版本不符合。将版本 knife4j 用的2.0.5 升级为 compile ‘com.github.xiaoymin:knife4j-spring-boot-starter:3.0.3’ 解决问题  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 2]

# 问题2 #

另外一个项目配置之后，发现项目启动访问404  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 3]  
项目找不到doc.html  
![在这里插入图片描述][b34b900ce38348a0b6072b9f9ebf9e77.png]

看到配置依赖中存在doc.html  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 4]

需要将doc.html 当作资源加载

将doc.html 改为当作资源加载

@Configuration
    public class WebAppMvcConfig implements WebMvcConfigurer { 
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) { 
          return;
        }
    
        @Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) { 
    
            registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
    
            /** 配置knife4j 显示文档 */
            registry.addResourceHandler("doc.html")
                    .addResourceLocations("classpath:/META-INF/resources/");
    
            /** * 配置swagger-ui显示文档 */
            registry.addResourceHandler("swagger-ui.html")
                    .addResourceLocations("classpath:/META-INF/resources/");
            /** 公共部分内容 */
            registry.addResourceHandler("/webjars/**")
                    .addResourceLocations("classpath:/META-INF/resources/webjars/");
        }
    
    }

这时将资源加载出来了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 5]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70]: /images/20220829/f8b1699b0ea6450a860e762f53fec3ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 1]: /images/20220829/1e515fa2fac24169b5516e5262485a24.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 2]: /images/20220829/d5b4c8f72e494e5ebb4a93aee8c9a0c2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 3]: /images/20220829/44f9a05f9ad243929043ef2dc70e86ed.png
[b34b900ce38348a0b6072b9f9ebf9e77.png]: /images/20220829/a05f05470555478c9bb406e991abb3fe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 4]: /images/20220829/5e77855f3fc941f58879a19a446b6bdd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 5]: /images/20220829/31b472c6082948829d5f73ed50551065.png