swagger + DOCWAY 一步导出为优雅完整的markdown、pdf接口文档

一步导出如图格式的接口文档：

前言

        最近接触到一个很方便的接口测试的工具Swagger，通过添加相关注解在类 / 接口方法上就能直接生成接口文档，测试接口不再需要手动添加参数，如图：

@RestController
@Api(value = "用户数据处理接口", tags = "用户数据处理接口")
@RequestMapping("cards/user")
public class UserController {

    /**
     * 登录接口
     */
    @PostMapping("login")
    @ApiOperation("登录注册接口")
    public ResponseVO<UserInfo> login(@RequestBody LoginVO loginVo, HttpSession session) {
        try {
            UserInfo userInfo = userInfoService.login(loginVo);
            if (userInfo == null) {
                throw new Exception();
            }
            // 将用户数据存入到session中
            SessionUtil.saveUserToSession(userInfo, session);
            return ResponseVO.getSuccessResponseVo(userInfo);
        } catch (Exception e) {
            throw new BusinessException("登录注册失败，请联系后台人员");
        }
    }

启动项目后，访问http://localhost:项目端口/swagger-ui.html#/

        由此可见，Swagger还是特别好用的，但是人都是贪心的嘛~，它在我测试接口的时候方便了我的操作，但是对于我们后端人员来说，写接口文档也是一个体力话，尤其是当接口量上来的时候.....

---

在一番冲浪下，发现其实Swagger的功能远不至于只是用于测试接口而已，更是能把所有接口的数据一步导出为一个md文档 / pdf文档，下面让我们学习如何操作吧

实现步骤：

在Swagger页面上F12打开开发者工具，点击“网络”

刷新Swagger页面，在网络界面的请求中找到api-docs请求 

 复制api-docs请求的响应数据

打开小幺鸡在线接口文档管理工具 (xiaoyaoji.cn)

点击“新增”，选“导入”

导入Swagger

选择"粘贴Swagger内容" 

将刚才复制的内容粘贴到这里点击导入 

点击生成的项目文件

 导出为外部文件

选择一个导出格式

最后下载下来就OK啦