02)springboot学习 eureka+swagger实现查看项目实例下具体的http接口信息
上一章提到 eureka只能管理到注册到上面的项目实例,这个项目下的具体http 接口是管理不到的,这样我们只知道这个项目注册到eureka了,并不知道这个项目下有哪些http接口服务
最原始的方法就是开发人员写完接口在单独写一份api文档,当接口改动时api文档也需要更新,作为开发人员频繁写文档也是很不爽的,而且工作忙时写完代码有时文档也忘记更新,导致别人查看到的api文档和最新的接口不同步,swagger的目的就是为了自动生成api文档的。
swagger介绍
Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口,可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,Swagger 消除了调用服务时可能会有的猜测。
Swagger 的优势
- 支持 API 自动生成同步的在线文档:使用 Swagger 后可以直接通过代码生成文档,不再需要自己手动编写接口文档了,对程序员来说非常方便,可以节约写文档的时间去学习新技术。
- 提供 Web 页面在线测试 API:光有文档还不够,Swagger 生成的文档还支持在线测试。参数和格式都定好了,直接在界面上输入参数对应的值即可在线测试接口。
springboot项目集成swagger步骤
1.pom.xml 引入swagger jar包
我这边springboot是2.5.2版本的 ,之前导入的swagger 2.2.0的jar 启动报错了 后面升级到2.7可以
<!--swagger 文档注释-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
<!--swagger--></