1.什么是Swagger?
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。简而言之Swagger是一款能够帮助我们自动生成接口文档工具;
2.怎么用
********详细介绍Spring Boot 2.0 集成 Swagger2流程
第一步,新建工程,在POM中添加Swagger2依赖,如图
第二步,编写启动类
第三步,至此,Swagger2可以与Spring Boot项目一起工作了。运行项目,在浏览器中访问URL(localhost:8080/v2/api-docs),验证效果如下图所示:
第四步,问题接踵而至。第三步访问URL运行结果是一堆JSON串,非常生涩难懂,不具有人性化。庆幸的是,Swagger2提供了UI交互的解决方案,在POM中添加Swagger2 UI依赖。如下图:
第五步,运行项目,在浏览器中访问URL(localhost:8080/swagger-ui.html),验证效果如下图所示:
运行结果
第六步,新建SwaggerController类,提供RESTFul服务
第七步,运行项目,在浏览器中访问URL(localhost:/swagger-ui.html),点击“Try it out!”按钮,可以进行服务接口测试。验证效果。