如何使用swagger-bootstrap-ui生成接口文档

平时使用Swagger进行接口测试很方便,但是前端需要接口文档咋办呢,又不让直接扔一个在线的Swagger接口测试过去。

于是,本着能不动手写就绝不动手的原则,我找到了swagger-bootstrap-ui这个工具,它可以帮助我们生成word、pdf…这些文档。

1.首先,导入Swagger和swagger-bootstrap-ui的依赖

		<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

这里需要注意的是,Swagger和swagger-bootstrap-ui可能会发生版本冲突的问题,别问我是怎么知道的。
开始我使用的是Swagger 3.0.0的版本,然后就出问题了。

2.在原有的 swagger 配置类上添加@EnableSwaggerBootstrapUI注解(这里我导出文档结束了,所以注释掉了):
在这里插入图片描述
3.启动项目,浏览器访问 http://ip+port 或者域名 /doc.html(这里不方便截公司项目的图,就网上找了)
在这里插入图片描述
4.生成文档。拷贝文档之后,将拷贝的内容粘贴到typora中,然后通过typora导出pdf、word等文档。
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值