SpringBoot集成swagger-OpenAPI

OpenAPI是swagger下的一个在线查看接口文档的工具包，可以随着项目的部署同时生成项目对应的所有接口文档

一、在pom引入maven的jar包

<!--OpenApi--> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.4.6</version> </dependency>

二、写代码的基本规范

实体类参数方法前加入@Schema(description="")注释，可在OpenAPI页面上查看对象对应参数的注释，我这边配合自己的代码生成器，可自动生成该注释，省去手动加注释的繁琐。 例如：

/** *帐号 */ @Schema(description="帐号") @Column(name="account") private java.lang.String account;

OpenAPI页面效果：

控制层类需要加入@Tag(name = " ")表示改类 例如：

@RestController @RequestMapping("/user") @Tag(name = "用户管理模块") public class UserController extends BaseController { }

OpenAPI页面效果： 接口方法注释为@Operation(description = “”) 例如：

/** * 获取用户列表 * @param user 用户对象 * @param pager 分页对象 * @return */ @Operation(description = "获取用户列表") @RequestMapping(value = "/listByPage", method = RequestMethod.POST) public String userListByPage(User user, Pager pager) { Pager newPager = getPager(pager); List<User> list = userService.getList(user,newPager); return Ret.jqGridDataForPage(list,newPager); }

OpenAPI页面效果： 更多代码规范需要更深入研究

三、集成后OpenAPI使用方法

集成后OpenAPI页面访问地址为： ip+端口+/项目名+/swagger-ui/index.html?url=/v3/api-docs 例如：http://localhost:18085/api/swagger-ui/index.html?url=/v3/api-docs 需要注意的是在Explore搜索框内加入项目名，例如： 通过改地址可访问接口文档的json内容：ip+端口+/项目名+/v3/api-docs 完整地址例如： http://localhost:18085/api/v3/api-docs

四、swagger-OpenAPI导出接口json放置postman测试

OpenAPI有自带的接口测试页面，但是功能毕竟简陋没有强大的postman测试来的香，下面描述一下OpenAPI页面的接口导出json，再把所有接口导入postman来测试的详细操作。

通过【三】描述的就扣文档的json访问地址获取到接口文档的json内容，把该内容复制，方式postman的导入页面，例如：

按上述操作后，就可以在postman的collections的OpenAPI definition查看该项目的所有接口，并对接口进行测试工作了。