提示:这是我的个人IT资源网站,所有资源都免费,注册登录后就可以看到密码,需要什么大家尽情选取!
今天给大家推荐一个测试接口的工具,非常好用,相当于一个能直接进行测试的接口文档,名字叫Swagger,下面我用SpringBoot整合然后演示一下效果
- 首先快速创建一个SpringBoot项目,选择Spring Web(此步骤大家应该都很熟悉了)
- 将swagger的maven依赖加上
<!--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>
- 模拟一个get请求,并返回结果
@RestController
@RequestMapping("/testSwagger")
@Api(description = "Swagger测试")
public class TestSwaggerController {
@GetMapping
@ApiOperation(value = "Swagger测试接口")
public String testSwagger(){
return "Hello,Swagger!";
}
}
- 还需要进行一个配置,开启Swagger,有一些设置,根据需要自行设置
@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("测试Swagger的API文档")
.description("本文档简单演示Swagger")
.version("1.0")
.build();
}
}
- 启动项目,有一个访问的固定格式,http://ip:port/swagger-ui.html,然后就可以看到我们写的接口了,还有更多好用的功能,大家可以深究一下
点击Try it out!就可以看到结果返回了