SpringBoot系列——Swagger2之Swagger UI,API实时接口文档
前言
Swagger UI是可视化实时API文档,按照规范写好接口代码后,直接实时查看、测试API,无需再单独编写API文档,省时省力
Swagger UI官网:https://swagger.io/tools/swagger-ui/
Swagger UI官方GitHub:https://github.com/swagger-api/swagger-ui
引入依赖
在pom文件引入最新版依赖
<!-- Swagger UI API接口--> <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>
编写代码
项目结构
Swagger UI 配置信息
/** * Swagger UI 配置信息 */ @Configuration @EnableSwagger2 public class SwaggerConfig { /** * 添加摘要信息(Docket) */ @Bean public Docket controllerApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(new ApiInfoBuilder() .title("API实时接口文档") .description("用于实时查看、测试API") .contact(new Contact("huanzi-qch", "https://www.cnblogs.com/huanzi-qch/", "")) .version("版本号:1.0") .build()) .select() //API基础扫描路径 .apis(RequestHandlerSelectors.basePackage("cn.huanzi.qch.springbootswagger2.controller")) .paths(PathSelectors.any()) .build(); } }
Vo对象与controller
@Data @ApiModel(description = "User实体Vo") public class UserVo { @ApiModelProperty("用户id") private Integer id; @ApiModelProperty("用户名称") private String userName; }
@RestController @RequestMapping("user") @Api(tags="user模块") public class UserController { @ApiOperation(value = "根据id查询用户信息", notes = "查询数据库中某个的用户信息") @ApiImplicitParam(name = "id", value = "用户ID", paramType = "path", required = true) @GetMapping("get/{id}") public String getUserById(@PathVariable int id) { if(id == 0){ return "查无此人"; }else{ return "{\"id\":\""+id+"\",\"userName\":\"张三\"}"; } } @ApiOperation(value = "根据UserVo对象查询用户信息", notes = "查询数据库中符合条件的用户信息") @ApiImplicitParam(name = "userVo", value = "UserVo对象", paramType = "UserVo") @PostMapping("list") public String getUserByUser(UserVo userVo) { if(userVo.getId() == 0){ return "查无此人"; }else{ return userVo.toString(); } } }
启动类加入@EnableSwagger2注解
@EnableSwagger2 @SpringBootApplication public class SpringbootSwagger2Application { public static void main(String[] args) { SpringApplication.run(SpringbootSwagger2Application.class, args); } }
效果
访问路径:/swagger-ui.html,即可访问实时API接口文档
/user/get/{id}
/user/list
后记
Swagger UI暂时先记录到这,以后在补充
代码开源
代码已经开源、托管到我的GitHub、码云:
版权声明
作者:huanzi-qch
若标题中有“转载”字样,则本文版权归原作者所有。若无转载字样,本文版权归作者所有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文链接,否则保留追究法律责任的权利.
捐献、打赏
请注意:相应的资金支持能更好的持续开源和创作,如果喜欢这篇文章,请随意打赏!
支付宝
微信
QQ群交流群
QQ群交流群
有事请加群,有问题进群大家一起交流!
有事请加群,有问题进群大家一起交流!