Swagger笔记（二）springboot集成和ApiModel使用不当的一个小问题

古城微笑少年丶 2021-11-16 07:28 339阅读 0赞

swagger现在已经是主流api工具了，特别是前后端分离的开发模式的流行，基本上都会用它来生成接口文档

swagger官网

[https://swagger.io/][https_swagger.io]

使用springboot来集成swagger也比较简单

首先在pom文件中引入相关的包

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.7.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.7.0</version>
            </dependency>

然后在启动类上加个注解，启动swagger

@EnableSwagger2
    @SpringBootApplication
    public class SpringCloudUploadSwaggerDemoApplication {
        public static void main(String[] args) {
            SpringApplication.run(SpringCloudUploadSwaggerDemoApplication.class, args);
        }
    }

再配置相应的bean

@Configuration
    public class SwaggerConfig {
    
        @Bean
        public Docket api() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    // 扫描的包路径
                    .apis(RequestHandlerSelectors.basePackage("com.mt.demo.upload.swagger.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    	// 一些说明配置
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("api文档")
                    .description("swagger接口")
                    .version("1.0")
                    .contact(new Contact("yingzi", "https://blog.csdn.net/yingziisme", "https://blog.csdn.net/yingziisme"))
                    .build();
        }
    }

然后就可以在相应的包下面的controller上使用相关的注解

controller层代码注解

@Slf4j
    @RestController
    @RequestMapping("/two")
    @Api("ChapterTwo")
    public class ChapterTwo {
    
        @ApiOperation(value = "two", notes = "two", httpMethod = "POST")
        @PostMapping("/post")
        public ResultVO post(@Valid @RequestBody OneDTO oneDTO){
            return ResultVO.success(oneDTO);
        }
    
        @ApiOperation(value = "two", notes = "two", httpMethod = "POST")
        @PostMapping("/post1")
        public ResultVO post(@Valid @RequestBody TwoDTO oneDTO){
            return ResultVO.success(oneDTO);
        }
    }

相关的实体类注解

@Data
    @ApiModel("One")
    public class OneDTO {
        private String user;
        private String password;
    }

@Data
    @ApiModel("One")
    public class TwoDTO {
        private String mobile;
        private String email;
    }

#### 然后这样就发现了一个坑 ####

#### 原来ApiModel使用了同样的值，会导致里面的属性叠加到了一起 ####

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

一开始没有注意到是有两个实体类的ApiModel的值一样，看到这里的属性多了几个一脸懵逼，后来看了swagger请求的api-docs的内容才反应过来这个问题，swagger使用了ApiModel的值作为数据的key

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

将其中一个的ApiModel的值改掉就正常了

@Data
    @ApiModel("Two")
    public class TwoDTO {
        private String mobile;
        private String email;
    }

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

[GITHUB源码参考][GITHUB]

欢迎关注微信交流  
![在这里插入图片描述][70]

[https_swagger.io]: https://swagger.io/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lpbmd6aWlzbWU_size_16_color_FFFFFF_t_70]: /images/20211116/4188dd94cad042c891c3431734952186.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lpbmd6aWlzbWU_size_16_color_FFFFFF_t_70 1]: /images/20211116/ea759f631a8e442eb043065bde426f1b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lpbmd6aWlzbWU_size_16_color_FFFFFF_t_70 2]: /images/20211116/d5e0fb644c3f46039bd3bf2048e58567.png
[GITHUB]: https://github.com/yingziisme/spring-boot-swagger-upload-demo
[70]: /images/20211116/7dd3a19bf1664f8797523f1c9e13dc39.png