使用Swagger生成离线的PDF和HTML文档

gitHub项目下载地址

内容通过maven对swagger的文档地址直接进行生成

进入pom.xml 文件里面,修改147行的Swagger文档地址

执行mvn swagger2markup:convertSwagger2markup命令

执行mvn generate-resource命令

出现中文乱码问题,需要用asciidoctorj-pdf-1.5.0-alpha.10.1.jar代替默认的jar包,在这里面添加了几个中文字库,解决乱码问题

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 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、付费专栏及课程。

余额充值