Spring mvc 集成Swagger2

曾经终败给现在 2021-09-24 06:42 375阅读 0赞

### Spring mvc 集成Swagger2 ###

*  Spring mvc 集成Swagger2
 *   *  效果
     *  问题1（swagger界面可以打开，但是接口不显示）
     *  问题2（ Could not resolve placeholder 'cardUrl' in value "$\{cardUrl\}"）
     *  重点：

)  
小编一直写的是SPringleboot 和vue，突然今天公司给我一个Spring mvc 的项目，但是还是没有集成Swagge的项目，导致我在调试及测试时候很不方便，不能及时看到接口的信息。所以小编作为多年的资深开发，觉得这对我是一件和容易的事情，所以就干起来了。但是在集成的时候遇到很多问题完全和springboot不一样，所以在这里记录一下。

# Spring mvc 集成Swagger2 #

@EnableWebMvc
    @EnableSwagger2
    @Configuration 
    **//下面这个在springmvc中必须要，,lazyInit = true 这个设置必须要**
    @ComponentScan(basePackages = {"com.myuser.controller"}**,lazyInit = true**)
    public class Swagger2Config  extends WebMvcConfigurationSupport {
        @Bean
        public Docket createRestApi() {// 创建API基本信息
            return new Docket(DocumentationType.SWAGGER_2)
                    .select()
                    //这个设置在springmvc中不需要可以不写，
    //                .apis(RequestHandlerSelectors.basePackage("com.echase.controller"))
                    .paths(PathSelectors.any())
                    .build()
                    .apiInfo(apiInfo());
        }
        private ApiInfo apiInfo() {
            // 创建API的基本信息，这些信息会在Swagger UI中进行显示
            return new ApiInfoBuilder()
                    // API 标题
                    .title("主题")
                    // API描述
                    .description("描述")
                   // .contact(new Contact("随便写", "随便写", "随便写"))
                    // 版本号
                    .version("1.0")
                    .build();
        }
    }

## 效果 ##

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

## 问题1（swagger界面可以打开，但是接口不显示） ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70 1]  
原因是：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70 2]  
控制台有报错：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70 3]

## 问题2（ Could not resolve placeholder ‘cardUrl’ in value “$\{cardUrl\}”） ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70 4]  
问题原因是**找不到占位符**。根本原因是，swagge2首先被注解进来后，然后开始扫controller得包，但是controller里面引入了配置文件，而对应得配置文件还是没加载进来，最后导致了$\{cardUrl\}占位符得出错。  
1.小编得解决思路

1.  小编尝试在配置文件springmvc.xml里面首先加载配置文件，查了好像信息都不成功。
2.  小编考虑，先让加载配置文件在加载swagger。然后就看了一下**ComponentScan**属性，有一个**lazyInit = false**属性，其实就是是否开启懒加载，默认是false，小编，将其设置为true。该问题成功被解决。

## 重点： ##

1.  springmvc集成swagger2：  
    3.1 要使用@ComponentScan得方式来扫包。  
    3.2ComponentScan要开启懒加载方式，属性：**lazyInit = true**要开启。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70]: /images/20210923/a358a955bb734c798d7884705cfb1bcf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70 1]: /images/20210923/2fad9e3710824794973dc93ffb679b28.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70 2]: /images/20210923/d78df29a547041d298ff5578169b12b5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70 3]: /images/20210923/d6fcdd3311654a1da44d4bdc4dcc0421.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5NzY4Nzk_size_16_color_FFFFFF_t_70 4]: /images/20210923/d472749f86874870bd6d02b526fa5c9e.png