1.什么是swagger2?
swagger2是一个规范和完整的框架,用于生成,描述,调用和可视化Restful风格的web服务,现在我们使用springboot整合。
作用:接口的文档在线自动生成;功能测试。
2.如何使用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.9.6</version> </dependency>
创建swagger2配置类
开启swagger2注解
测试:访问swagger接口文档
第一种:localhost:8080/swagger-ui.html
第二种:localhost:8080/doc.html
3.修改文档
@Configuration public class SwaggerConfig { // 创建swagger实例 @Bean public Docket docket(){ Docket docket = new Docket(DocumentationType.SWAGGER_2) .apiInfo(getInfo())//设置接口文档的信息 .select() .apis(RequestHandlerSelectors.basePackage("com.lr.springbootprecoursetest.controller")) //指定为那些路径下得到类生成接口文档 .build(); return docket; } private ApiInfo getInfo(){ Contact DEFAULT_CONTACT = new Contact("刘陌", "http://www.ldw.com", "110@qq.com"); ApiInfo DEFAULT = new ApiInfo("用户管理系统API", "该系统中的接口专门操作用户的", "v1.0", "http://www.baidu.com", DEFAULT_CONTACT, "漫动者", "http://www.jd.com", new ArrayList<VendorExtension>()); return DEFAULT; } }