使用Swagger当中生成API文档

本文介绍如何使用Swagger生成API文档,并将其导出为Word格式。通过修改配置文件中的swagger.url指向API的JSON地址,启动服务后访问特定URL,即可下载转换后的Word文档。详细步骤包括代码仓库链接、配置文件设置以及操作指南。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

首先,附上一张效果图:
在这里插入图片描述
右键点击另存为doc格式,然后下载下来就是如下图样子:
在这里插入图片描述
该博客是参考别人的博客写出来的,步骤都是自己一步步实现,终于完成导出内容。

原博客的git代码地址如下:
https://github.com/JMCuixy/swagger2word/

由于本人代码有做修改,有需要的话,各自斟酌下载
本人git代码仓库如下:
https://github.com/yarcl/swagger2word.git

下载好代码以后,直接使用idea打开(不要告诉我你不会哟):
在这里插入图片描述
修改application.yml文件的swagger.url为请求的json文件地址:
在这里插入图片描述
很多文章都没有告诉该地址到底是什么样的地址,在这里我就告诉你咯:
1、打开要生成api接口文档的swagger地址,如下图:

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值