利用Swagger自动生成项目接口文档

利用Swagger自动生成项目接口文档

swagger生成的接口不能用于交付,客户一般要求提供word文档类型的接口文档,或者前后端联调时,不容易看得懂,需要word版的易懂的文档,因此可以利用swagger的接口数据生成接口文档,文档样式统一,全局控制

为什么要生成接口文档

无需手动撰写接口文档

  • 理由一:对于几百个接口的case,1分钟搞定N天的工作量,并且无上述烦恼
  • 理由二:不管项目中开发人员有多少,代码结构、命名是否规范
  • 理由三:如果项目迭代,接口做了改动,只需要再操作一下生成过程,一分钟的时间
  • 理由四:风格统一、主题支持多样化、比手动写的文档美观
  • 理由五:新项目来了,不存在,也是1分钟的事
  • 理由六:没烦恼,一分钟搞定几天到几十天不等的工作量,节省更多时间做更有意义的事,何乐不为!

支持的两种方式

  1. 填写swagger接口地址
  2. 上传swagger接口数据文件

生成效果

在这里插入图片描述
在这里插入图片描述

项目架构

引用文本
SpringCloud+springboot+spring security+aop+nginx+layui+jquery+bootstrap

预览

预览地址.

注意:体验账户guest,密码123456