Swagger生成word文档

本文档介绍了如何利用Swagger的json数据生成Word接口文档。首先,通过下载并运行特定项目来处理Swagger的json数据,支持Word导出。接着,启动提供接口文档的服务,将/v2/api-docs的地址配置到生成项目中。最后,重新启动项目并访问指定URL,即可下载生成的Word文档。
摘要由CSDN通过智能技术生成

前言:

最近工作中需求,需要利用mybatis-plus代码生成器生成的做成一个接口文档给客户

一、生成word接口文档

原理:swagger本身返回的就是json数据,所以你把你项目的json数据放到下面的项目里,它就可以格式化数据了。下面将要下载的项目就是用来处理这个json数据的,支持word导出。

1. 下载这个项目,用来生成文档的

百度链接:https://pan.baidu.com/s/1PWUELSHXcDbeUYUKlf56vQ
提取码:rmvj
2. 下载完成后打开项目,可以直接运行的,先访问一下,返回hello Swagger2word!即成功!
在这里插入图片描述
3. 运行我们需要导出接口文档的服务,http://localhost:8121/v2/api-docs我的是这样,后面的/v2/api-docs解释如下图:
在这里插入图片描述
4. 我们把这个地址复制到生成项目的配置文件里
在这里插入图片描述
5. 重新启动项目,访问locaohost:8080/toWord
在这里插入图片描述
6. 下载文档,即可成功

  • 3
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 18
    评论
评论 18
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值