1.Spring boot整合swagger2
1.1什么是swagger2?以及为什么选择swagger2?
前后端分离开发模式中,api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。
- 及时性(接口变更后,能够及时准确的通知前后端开发人员)
- 规范性(并且保证接口的规范性,如接口的地址,请求方式,参数,响应格式和错误信息)
- 一致性(接口信息一致,不糊出现文档版本不一致产生分歧)
- 可测性(直接在接口文档上进行测试)
编写和维护接口文档是每个程序员的职责,根据Swagger2可以快速帮助我们编写最新的API接口文档,再也不用担心开会前仍忙于整理各种资料了,间接提升了团队开发的沟通效率。
1.2swagger2的常用注解
swagger通过注解表明该接口会生成文档,包括接口名、请求方法、参数、返回信息的等等。
@Api:修饰整个类,描述Controller的作用
@ApiOperation:描述一个类的一个方法,或者说一个接口
@ApiParam(name = "参数名",value = "参数说明",required = true参数是否为必须 defaultValue=”如果参数非必须,则设置默认值“ ) :单个参数描述
@ApiModel:用对象来接收参数
@ApiModelProperty:用对象接收参数时,描述对象的一个字段
@ApiImplicitParam:一个请求参数
@ApiImplicitParams:多个请求参数
1.3如何使用swagger2
1.3.1引入swagger2依赖
<!--swagger2依赖-->
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.9.1.RELEASE</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.7.8</version>
</dependency>
1.3.2创建一个配置类-swagger2
@Configuration
@EnableSwagger2 //开启swagger注解驱动
public class Swagger2Config {
@Bean //把方法返回的数据对象 交于spring容器管理
public Docket docket(){
Docket docket = new Docket(DocumentationType.SWAGGER_2).groupName("QY163")
.apiInfo(getInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.wj.demo5.controller")) //只为com.wj.demo5.controller包下的类生成接口文档
.build();
return docket;
}
private ApiInfo getInfo(){
Contact DEFAULT_CONTACT = new Contact("王建", "192.168.1.32", "1637916924@qq.com");
ApiInfo apiInfo=new ApiInfo("学生表与班级表关联CRUD", "学生表与班级表关联CRUD", "1.1.0", "http://www.jd.com",
DEFAULT_CONTACT, "QY163", "192.168.1.32", new ArrayList<VendorExtension>());
return apiInfo;
}
}
1.3.3访问swagger2在线文档
http://ip:port/swagger-ui.html
注:IP:自己的IP地址,port:端口号
注:建议使用后者,后者条理更加清晰
1.4运行测试
配置Mybatis-plus相关依赖以及插件类
@Configuration
@MapperScan("scan.your.mapper.package")
public class MybatisPlusConfig {
/**
* 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性