swagger2转为word文档

在本人的职业生涯里,有用过swagger2来做API文档的,也有使用到rap2来自己手写API文档。但如果是手写API文档的话,会浪费很多的时间,会让开发周期变得更长并且写接口文档的人也会很烦躁,所以今天写这篇文章是我在实际工作中遇到的情况,在项目开发完成后,甲方需要一系列文档以交付项目。

  • SwaggerToWord
    GitHub地址:https://github.com/JMCuixy/swagger2word
    拉取项目后,微信图片_20210127113746.png项目呈如此结构。
    但我不知道是因为该项目很久没有维护的关系还是怎么回事。
    微信图片_20210127113837.png
    这两个文件Impl的导包有问题,Controller有方法的异常没有抛出。但手动操作一下就好了
    之后在yml文件里,配置你需要生成为word文档的swagger地址(swagger的Json地址,在swagger-ui的顶部)。
    如下图:
    微信图片_20210127114526.png
    启动项目访问配置里所配置的端口号的swagger-ui地址。如本人的是:localhost:8081/swagger-ui.html
    微信图片_20210127115034.png
    以此点击框内内容,即可下载word文档
    微信图片_20210127115202.png
  • 2
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger2是一个开源的项目,用于生成RESTful API的文档。通过Swagger2,我们可以方便地定义API的请求和响应格式、参数、返回值等,并且生成美观、易于阅读的文档。Swagger2支持在线文档生成,但在某些场景下,我们可能需要生成离线文档以便于查阅。 生成Swagger2的离线文档可以通过以下几个步骤实现: 1. 在项目中添加Swagger2的依赖。我们可以通过Maven或Gradle等工具,在项目的配置文件中添加Swagger2的依赖项,以便于能够在项目中使用Swagger2的相关注解和配置。 2. 在代码中添加Swagger2的注解。在需要生成文档的API接口的方法上,使用Swagger2提供的注解,如@Api、@ApiOperation、@ApiParam等,对API进行描述和参数的定义。 3. 配置Swagger2的参数。在项目的配置文件中,我们可以配置Swagger2的相关参数,如API文档的标题、描述、版本号等。我们还可以指定生成离线文档的输出路径。 4. 运行项目生成离线文档。启动项目后,访问Swagger2的API文档页面,可以查看在线文档。在该页面上,我们可以找到一个生成离线文档的按钮或链接,点击后会将API文档以HTML或其他格式导出到本地的指定路径。 通过以上步骤,我们就可以很方便地生成Swagger2的离线文档。在项目构建或发布过程中,我们可以将这些离线文档打包发布,供其他团队成员或API使用者参考和查阅。这样可以提高API的可理解性和使用性,减少沟通和解释成本,提升开发效率。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值