Swagger2介绍与集成

swagger2介绍

什么是swagger2

Swagger2是一个可以快速帮助我们编写最新的API接口文档，以及维护API接口，间接提升了团队开发的沟通效率。

常用注解

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

swagger2集成

1. 项目整合swagger2

在common模块pom.xml引入依赖

 io.springfoxspringfox-swagger2
 io.springfoxspringfox-swagger-ui
 
 

说明：我们在yygh-parent中的pom.xml中添加了版本控制，这里不需要添加版本，已引入就忽略

2. 添加swagger2配置类

在util模块添加配置类：
com.XXX.XXX.common.config.Swagger2Config类

/*** Swagger2配置信息*/
 @Configuration
 @EnableSwagger2
 public class Swagger2Config {@Beanpublic Docket webApiConfig(){return new Docket(DocumentationType.SWAGGER_2).groupName("webApi").apiInfo(webApiInfo()).select()//只显示api路径下的页面.paths(Predicates.and(PathSelectors.regex("/api/.*"))).build();}@Beanpublic Docket adminApiConfig(){return new Docket(DocumentationType.SWAGGER_2).groupName("adminApi").apiInfo(adminApiInfo()).select()//只显示admin路径下的页面.paths(Predicates.and(PathSelectors.regex("/admin/.*"))).build();}private ApiInfo webApiInfo(){return new ApiInfoBuilder().title("网站-API文档").description("本文档描述了网站微服务接口定义").version("1.0").contact(new Contact("atguigu", "http://网址.com", "邮箱@qq.com")).build();}private ApiInfo adminApiInfo(){return new ApiInfoBuilder().title("后台管理系统-API文档").description("本文档描述了后台管理系统微服务接口定义").version("1.0").contact(new Contact("atguigu", "http://网址.com", "邮箱@qq.com")).build();}
 }
 

3. 使用swagger2测试
   网址：localhost:端口号/swagger-ui.html