最近学习了一种简单的接口测试文档,这个接口文档既简单又方便前后端合作。
1:引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2,添加Swagger-UI的Java配置文件
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Swagger2配置类
* @author linan
* @since 2.0
*/
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//为当前包下controller生成API文档
.paths(PathSelectors.any())
.build();
}
/**
* 创建该API的基本信息(这些基本信息会展现在文档页面中)
* 访问地址:http://localhost/swagger-ui.html
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("SpringBoot整合Swagger2")
.description("详细请咨询Q715661742")
.version("1.0")
.build();
}
}
3,添加相应的注释
import com.smxy.entity.VipLevel;
import com.smxy.service.AdminService;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* 管理员调用的接口
* @author linan
* @since 2.0
*/
@RestController
@RequestMapping("/admin")
@CrossOrigin
public class AdminController {
@Autowired
AdminService adminService;
@PostMapping("/getVipLevel")
@ApiOperation("查找所有的vip会员")
public List<VipLevel> getVipLevel() {
List<VipLevel> vipLevel = adminService.getVipLevel();
return vipLevel;
}
@PostMapping("/updateVipLevel")
@ApiOperation("修改会员的内容以及属性")
public Boolean updateVipLevel(@RequestBody VipLevel vipLevel){
return adminService.updateVipLevel(vipLevel) > 0;
}
}
4,效果展示
注:我用的是8082端口
可参考的地址:https://blog.csdn.net/qq_37330730/article/details/105166890
https://blog.csdn.net/zhanggonglalala/article/details/98070986