swagger2接口导出

swagger-ui延伸版本

前言

​ 目前大部分软件的swagger都仅仅使用swagger-ui.html

​ 本项目为了使用的良好，所以采用增强型doc.html。目前已经更新到了knife4j-spring-boot-starter 2.0.2

导出功能实现简单版本

1.maven引入

代码

 <!-- Swagger2引入 开始-->

​    <dependency>

​      <groupId>io.springfox</groupId>

​      <artifactId>springfox-swagger2</artifactId>

​      <version>2.6.1</version>

​    </dependency>

​    <dependency>

​      <groupId>io.springfox</groupId>

​      <artifactId>springfox-swagger-ui</artifactId>

​      <version>2.6.1</version>

​    </dependency>

​    <!-- 额外导入 对应网址是原先swagger-ui.html 修改成doc.html -->

​    <dependency>

​      <groupId>com.github.xiaoymin</groupId>

​      <artifactId>swagger-bootstrap-ui</artifactId>

​      <version>1.9.3</version>

​    </dependency>

​    <dependency>

​      <groupId>io.springfox</groupId>

​      <artifactId>springfox-bean-validators</artifactId>

​      <version>2.9.2</version>

​    </dependency>

​    <!-- Swagger2引入 结束-->

目前 版本有2.9.2 测试中2.6.1也可以使用

2.具体使用对比

3.内置离线文档

具体导出 如果该版本的导出效果符合 可以直接使用 集成时候看是否出现版本兼容问题

具体导出步骤

1.

2.

登录有道云,新建

3.

然后对应第二步拷贝文档内容 复制到新建的Markdown处

4.

可以得到预览效果如下

5.

有道云直接导出pdf格式要收费 略过 我们导出markdown格式，然后用Typora进行打开 导出成pdf格式 [ 注意事项 因为下载的背景颜色深 无法直接转换pdf 选择默认就好，不影响预览效果 ]

doc.html的 url过滤 跟swagger-ui.html过滤一样配置

选择使用默认主题打印就可以了

6.

pdf 预览

7.

优点 内部兼容友好，缺点 样式固定，一些东西是根据你swagger使用注解时候数据进行输出，需要规范一些注解使用。具体如何样式调整未定。如果对api文档没什么太大要求，可以满足需求了

版本知识点

swagger-bootstrap-ui 1.8.5 发布了。swagger-bootstrap-ui 是 Swagger 的增强UI 实现，目的是替换 Swagger 默认的 UI 实现 Swagger-UI，使文档更友好一点儿

knife4j-spring-boot-starter是新的加强版本 对应官网是 https://doc.xiaominfo.com/

springfox-bean-validators 是实体类校验 应该是非必须

参考网址 https://blog.csdn.net/u013294608/article/details/93736420