背景
我们日常开发中基本都是协同开发的,当然极个别的项目整体前后端都是一个人开发的,当多人协作时,尤其是前后端人员协同开发时
必然会面临着前端需要了解后端api接口的情况,两个选择,提前设计好文档,然后维护他,让前端去参考这个文件
第二种便是通过当前代码即时去生成api,然后大家一起通过在线文档去看,这样的好处是及时性,便捷性
本文就来介绍如何微服务下通过gateway集成共通的api在线文档,这样就不需要一个服务去部署一套文档 我们自定义注解实现swagger
自动集成到各个业务端并且通过knife4j 将swagger的文档更进一步美化并嵌入到我们自己的项目中
集成后效果如下:
可以看见api文档是在我们自己项目内的,而且经过knife4j的美化,api文档看起来更舒服~