后端测试工具Swagger2的使用

 

1.Swagger2 介绍

2.配置Swagger2

1.新建一个独立的maven工程

2.在工程中引入依赖

//主要是： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <scope>provided </scope> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <scope>provided </scope> </dependency>

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <scope>provided </scope> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <scope>provided </scope> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <scope>provided</scope> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <scope>provided </scope> </dependency>

3.创建一下类

@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket webApiConfig(){ return new Docket(DocumentationType.SWAGGER_2) .groupName("webApi") .apiInfo(webApiInfo()) .select() .paths(Predicates.not(PathSelectors.regex("/admin/.*"))) .paths(Predicates.not(PathSelectors.regex("/error/.*"))) .build(); } private ApiInfo webApiInfo(){ return new ApiInfoBuilder() .title("网站-课程中心APi文档") //文档页标题 .description("本文档描述了课程中心微服务接口定义") // 文档页描述 .version("1.0") .contact(new Contact("Helen", "http://baidu.com", "1008611@qq.com")) .build(); } }

4.主启动类上配置自动扫描的包

@SpringBootApplication @ComponentScan(basePackages = {"com.tianzhao"}) public class EduApplication { public static void main(String[] args) { SpringApplication.run(EduApplication.class,args); } }

3.打开文档页面

http://localhost:8001/swagger-ui.html

固定写法：http:// localhost:+主启动类端口号+/swagger-ui.html

这时候就可以在页面上看到自己写的接口了

也可以直接在页面上测试