
回复
springboot快速集成Swagger2集成公共服务,支持开关和子项目包路径配置
团队开发痛点:
API 接口众多,细节复杂,需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等,想要高质量的完成这份文档需要耗费大量的精力;
难以维护。随着需求的变更和项目的优化、推进,接口的细节在不断地演变,接口描述文档也需要同步修订,可是文档和代码处于两个不同的媒介,除非有严格的管理机制,否则很容易出现文档、接口不一致的情况
Swagger2 的出现就是为了从根本上解决上述问题。它作为一个规范和完整的框架,可以用于生成、描述、调用和可视化 RESTful 风格的 Web 服务:
接口文档在线自动生成,文档随接口变动实时更新,节省维护成本
支持在线接口测试,不依赖第三方工具
注意点:Swagger2是支持在线接口测试的,所以对于生产环境,准生产环境,必须屏蔽该入口,防止因为Swagger2的在线接口测试导致生产问题或者数据污染。
第一步集成pom
第二步:Swagger2 的配置
这两步可以集成到公共服务中,子项目pom去依赖公共服务,减少重复造轮子。
第三步: 配置api
注:如果想要屏蔽某些接口:使用注解@ApiIgnore
第四步:配置扫包路径和swagger启动开关,swagger功能开启
服务配置扫包路径:application-dev.yml
第五步 启动springboot服务,访问http://localhost:9090/swagger-ui.html