SpringBoot整合swagger ui 3实现接口测试 详细

目录结构图

创建springBoot项目引入SwaggerUI依赖

// pom.xml中引入springfox-boot-starter
<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>3.0.0</version>
		</dependency>

使用Swagger注解

实体类中注释实体

Entity类中引用 io.swagger.annotations.ApiModel 与 io.swagger.annotations.ApiModelProperty

@ApiModel() 表示对类进行说明，用于参数用实体类接收
如： @ApiModel(“用户实体类”) 表示该实体类是用户实体 常用于类上 可省略

@ApiModelProperty() 表示对方法进行说明或者数据操作
如： @APIModelProperty(“用户ID”)

//例
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel=("用户实体类")
public class User {

	@ApiMoDelProperty(value = "用户id")
	@TableId(type = IdType.AUTO)
	private Long userId;
}

controller类中注释接口

controller类中引入@ApiOperation注解

@ApiOperation() 用于方法上 表示一个http请求的操作
如: @ApiOperation("/查询用户信息")

//例
import io.swagger.annotations.ApiOperation;

@RestController
@RequestMapping("/user")
public class UserController{

	@Resource
	private UserService userService;

	@ApiOperation("/查询用户信息")
	@GetMapping("/findUser")
	public List<User> findUser(){
		return userService.findUser();
	}
}

在SpringBoot启动类中使用Swagger注解 使用Swagger服务

引入EnableOpenApi

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.oas.annotations.EnableOpenApi;

@EnableOpenApi
@SpringBootApplication
public class StoreApplication {

	public static void main(String[] args) {
		SpringApplication.run(StoreApplication.class, args);
	}

}

至此SwaggerUI已经配置完成
启动SpringBoot访问 http://localhost:xxxx/swagger-ui/index.html即可
*注SwaggerUI3与SwaggerUI2地址不相同 需加上/index.html

项目源码

github
gitee

至此配置SwaggerUI方法全文结束 如有疏漏或是有不懂的地方可以私信 留言或加我企鹅 菜鸟一枚 第一次发博 如有写的不好的地方还请各位前辈们指点一二 以后会慢慢更新在学习Java路上碰到的各种常见问题及解决方式 我尽量会用详细的语法让像我一样基础薄弱的各位学习路上的菜鸟都可以有所收获 所有文章的源码可能会有多余的东西 因为还不太熟练 有任何疑问都可以问我 欢迎点赞关注！ 感谢阅读 下篇文章再见！