APP下载

玩转微服务-整合Swagger2

消息来源:baojiabao.com 作者: 发布时间:2026-05-19

报价宝综合消息玩转微服务-整合Swagger2

由于Spring Boot能够快速开发、便捷部署等特性,相信有很大一部分Spring Boot的使用者会用来构建RESTful API。而我们构建RESTful API的目的通常服务于多终端,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端。

那么问题来了?

一个专案超级多的API,有可能几百个,都需要手写文件维护吗?这工作量是不是太大了?

手写Api文件的几个痛点:

文件需要更新的时候,需要再次传送一份给前端,也就是文件更新交流不及时。界面返回结果不明确不能直接线上测试界面,通常需要使用工具,比如postman界面文件太多,不好管理Swagger也就是为了解决这个问题,当然也不能说Swagger就一定是完美的,当然也有缺点,最明显的就是程式码移入性比较强。

话不多说,开始操作~~

1.引入依赖包

io.springfox

springfox-swagger2

2.7.0

io.springfox

springfox-swagger-ui

2.7.0

2.Swagger配置类

注:

用@Configuration注解该类,等价于XML中配置beans;用@Bean标注方法等价于XML中配置bean。

basePackage:引用controller路径,相当于扫描该controller下面的api界面

3.定义Restful 界面

首先写个controller类,暴露api界面

其实通过service层呼叫mapp层方法

最后,我们看启动效果

OK启动成功

4.访问Swagger-ui,检视api

url:http://localhost:3001/ylpublic/swagger-ui.html

点开测试下界面是否可通

现在swagger-ui从配置到演示算是完成了,另外关于generator生成工具方法如何呼叫的,后面介绍下

谢谢大家多多关注,想要程式码及学习资料的关注私信我,谢谢!!!

2020-01-01 16:51:00

相关文章