swagger接口测试文档工具

使用swagger需要添加以下依赖

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

在springboot工程下创建个配置类

@Configuration
@EnableSwagger2
public class Swagger2Config {

	@Bean
	public Docket webApiConfig(){

		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("webApi") //写上组名
				.apiInfo(webApiInfo()) //调用下面的方法webApiInfo()
				.select()
				//正则匹配 排除路径中带有admin 和 error 字样的请求，其余请求全在这个组下
				.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
				.paths(Predicates.not(PathSelectors.regex("/error.*")))
				.build();

	}

//	@Bean
//	public Docket adminApiConfig(){
//
//		return new Docket(DocumentationType.SWAGGER_2)
//				.groupName("adminApi") //组名
//				.apiInfo(adminApiInfo())
//				.select()
				//请求路径中带有admin字样的请求分配在adminApi这个组下
//				.paths(Predicates.and(PathSelectors.regex("/admin/.*")))
//				.build();
//
//	}

	private ApiInfo webApiInfo(){

		return new ApiInfoBuilder()
				.title("网站-课程中心API文档") //描述信息 想改就改
				.description("本文档描述了课程中心微服务接口定义")
				.version("1.0")
				.contact(new Contact("Helen", "http://atguigu.com", "55317332@qq.com"))
				.build();
	}

//	private ApiInfo adminApiInfo(){
//
//		return new ApiInfoBuilder()
//				.title("后台管理系统-课程中心API文档")
//				.description("本文档描述了后台管理系统课程中心微服务接口定义")
//				.version("1.0")
//				.contact(new Contact("Helen", "http://atguigu.com", "55317332@qq.com"))
//				.build();
//	}
}

通常swagger注解使用在controller层
@Api(description=“讲师管理”) 添加类上 description描述该类
public class TeacherController

@ApiOperation(value = “根据ID删除讲师信息”) 添加在方法上，描述该方法的功能

@ApiParam(name=“id”,value=“讲师编号”) 添加在参数位置上 name写上参数名，value描述该参数的作用

最重要的一点就是要在springboot的启动类或配置类上添加上注解@EnableSwagger2 开启swagger

开启服务，在浏览器上输入http://localhost:8001/swagger-ui.html