导出swagger,自动生成API文档

背景:

当一个微服务开发完之后,突然别人问你,给我一份api文档吧。作为一个开发,一张原型图就要做出一个系统。哪有时间搞这些。这怎么搞,总不能给一个swagger链接吧。那就导出呗

本篇依旧是简单粗暴,分分钟搞定,以下是使用方法

注:本篇只支持pdf 和html导出,下载的项目放在某盘根目录下,不要有中文路径,不然会有编码报错

步骤:

1、下载项目

2、把自己项目的swagger的json描述复制到指定位置

3、在下载的项目下执行mvn test

4、生成的html 就是要交的东西

1、下载项目

链接:https://pan.baidu.com/s/16XQga7GBNw-EYPUgSaR8nQ
提取码:6ro6

也可以从git上下,不过我没开放权限。这个地址:

https://gitee.com/tangjunchao/swagger_document_export

2、加载项目

  1. 将下载的项目放在某路径下。注意:路径不能有中文名称

用idea打开,选择maven项目

3 、swagger文档导出

  1. 完整支持html格式导出
  2. 部分支持pdf格式导出,导出格式比较难看
使用方法:

1、自己的项目中有swagger配置,如果没有的话可参照如下进行配置:

https://blog.csdn.net/t18092838767/article/details/103594685

2、启动自己的项目,访问

http://localhost:80/{自己项目的根路径}/v2/api-docs 获取到json数据,复制下来。

3、下载demo项目,打开demo项目的swagger_document_export\src\data\swagger.json文件。把刚复制的json数据粘贴进去

4、在demo项目中执行: mvn test

5、等一会你导出的html的在这里

target/asciidoc/html/index.html

  • 0
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值