前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Swagger笔记(二)springboot集成和ApiModel使用不当的一个小问题

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

作者头像
yingzi_code
发布2019-08-30 22:03:32
3K0
发布2019-08-30 22:03:32
举报

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。

本文链接:https://blog.csdn.net/yingziisme/article/details/97699565

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

swagger官网

https://swagger.io/

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

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

代码语言:javascript
复制
<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

代码语言:javascript
复制
@EnableSwagger2
@SpringBootApplication
public class SpringCloudUploadSwaggerDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringCloudUploadSwaggerDemoApplication.class, args);
    }
}

再配置相应的bean

代码语言:javascript
复制
@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层代码注解

代码语言:javascript
复制
@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);
    }
}

相关的实体类注解

代码语言:javascript
复制
@Data
@ApiModel("One")
public class OneDTO {
    private String user;
    private String password;
}
代码语言:javascript
复制
@Data
@ApiModel("One")
public class TwoDTO {
    private String mobile;
    private String email;
}
然后这样就发现了一个坑
原来ApiModel使用了同样的值,会导致里面的属性叠加到了一起
在这里插入图片描述
在这里插入图片描述

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

在这里插入图片描述
在这里插入图片描述

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

代码语言:javascript
复制
@Data
@ApiModel("Two")
public class TwoDTO {
    private String mobile;
    private String email;
}
在这里插入图片描述
在这里插入图片描述
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2019年07月29日,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 然后这样就发现了一个坑
  • 原来ApiModel使用了同样的值,会导致里面的属性叠加到了一起
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档