我前段时间开发的加强版swagger-ui。

这或许为swagger应该是一个什么样子, 提供了一个全新的思路。

  1. 文档缓存,即使服务器没开,仍然可以看文档。
  2. 文档注释增强,采用js注释写法,对前端人员比较友好。
  3. 文档输入输出框,采用CodeMirror轻量级文本编辑器代替原版的textarea输入框,支持编辑器语法高亮,代码格式化,代码折叠…
  4. 自动捕获前端的代码实现,连接口数据预处理逻辑都能显示,支持枚举值提示等。
  5. 接口字段排序,请求返回的数据也能显示注释,自动执行前端数据预处理逻辑,自动转换枚举值。
  6. 直接支持ajax文件下载。
  7. 后台报错信息格式化,能够格式化错误信息中的sql语句和json字符串。

这是一个位于前端工程中的自动捕获前端代码注释而生成的swagger文档,  接口数据的来源是后台swagger的数据,但是【前端处理版】内容是位于前端工程中的。

分享一个自行开发的加强版swagger-ui,提供一个全新的api文档生成思路

分享一个自行开发的加强版swagger-ui,提供一个全新的api文档生成思路

分享一个自行开发的加强版swagger-ui,提供一个全新的api文档生成思路

分享一个自行开发的加强版swagger-ui,提供一个全新的api文档生成思路

分享一个自行开发的加强版swagger-ui,提供一个全新的api文档生成思路

分享一个自行开发的加强版swagger-ui,提供一个全新的api文档生成思路

分类:

技术点:

相关文章: