导出API文档为Word/PDF格式

1 背景

项目框架:

  • Spring Cloud微服务家否
  • Spring Boot中使用Swagger2作为API文档

目标:导出所有微服务的API文档,并汇总到一个文档中去。

2 解决

解决思路:Swagger2文档导入到YAPI -> YAPI导出为Markdown格式 -> 在线Markdown格式转换为Word文档

2.1 Swagger2文档导入到YAPI

项目中使用Spring Cloud Gateway作为网关,在网关层做了Swagger2文档地址的汇聚,所以可以很方便地找到Swagger2文档地址。如下所示为汇聚后的swagger2访问页面:

导出API文档为Word/PDF格式_第1张图片

可以看到https://xxx/gsp-file-consumer/v2/api-docs就是Swagger2文档的内容。

在YAPI中导入Swagger文档,使用上面的Swagger2地址:

你可能感兴趣的:(项目中的那些事,API文档导出,Swagger)