零侵入文档生成及API测试工具smalldoc-2.4发布!

smalldoc的上一个版本是2.3.12.3.2在2019-10月就开始操刀了,但是由于两个原因2.3.2未及时交付——

  1. 有老人去世,回老家守孝
  2. 在新版的UI实现中,遇到了AntdV3在设计最初就存在的一个bug,导致这段代码的实现遇到阻碍,但是又不想放弃预想的UI效果,强迫症之下,,虽然本职是一个后端开发,还是去看了AntdV3的源码,实现了自己的解决方案,并由此写下一篇总结《Ant-design Table组件当滚动列的行高变化时,固定列的行高不会同步变化,或固定列变化滚动列不变,造成布局破坏。》,但毕竟不是从源码层面进行的复写,所以在渲染速度上存在缺陷——当数据量较大,会出现肉眼可见的卡顿。不过幸运的是,在我实现解决方案的后两天,AntdV4的第一个可用版本antd-4.0.0-rc.0就发布了,从主要commiter的知乎专栏了解到,antdV4推翻了antdV3原本的设计,重新实现了代码,从根本上解决了诸如此类的bug,大幅度提高了antd组件的渲染速度,从而使smalldoc的UI界面得到可观改善!

于是由于2.3.2版本的迟迟未交付,作者干脆一鼓作气,根据issues中支持者提到的诸多问题及建议对smalldoc做了一次全面升级,发布了如今的smalldoc-2.4,更新日志如下。。。

更新日志

  • 更强大的参数配置语法,使接口文档展示更人性化增强#8
  • 增加了基于包的完全限定名或package-info中的注释信息选择文档的菜单栏功能增强#7
  • 对UNIX系统做了兼容,例如Mac OS(为此,作者专门买了本Mac 😂)增强#7
  • 增加了接口参数示例值推断增强#14
  • 集成了API测试功能增强#14
  • 可配置的解析类名,支持正则匹配增强#9
  • 优化了返回参数实体内集合字段的展示效果增强#15
  • 修复了TypeVariableTypeArgument时无法解析的错误,如下格式修复 #15
     @RequestMapping("test")
     public Result<PageResult<List<TestBean>>> test(String s);
    
  • 升级UI至antdV4,修复了组件渲染bug,大幅度提高了渲染速度增强
  • 修复了UI在渲染返回参数列表时,循环应用造成的堆栈溢出修复#15
  • 修复了由于后端JSON库默认开启了循环引用检测造成的数据错误修复#15
  • 增加了集合参数(SetList)使用方式断言(1.集合参数不能是实体参数;2.集合参数需要结合注解@RequestParam,如下的正确使用方式)增强 #15
     @RequestMapping("test")
     public Result<Long> test(@RequestParam List<String> ss);
    
  • 删除了不合理的执行逻辑(比如,直接以实体集合作为接口方法的入参,如下的错误使用方式)增强 #15
    @RequestMapping("test")
    public Result<Long> test(List<TestBean> testBeans);
    
  • 显式的重置UI组件的state,减少由于React差分算法造成的不期望的渲染效果增强
  • 修改了数据渲染方式(参考今日头条文章,既保证前后端分离,又保证SEO,可生成离线文档);

使用方式

<dependency>
    <groupId>com.github.liuhuagui</groupId>
    <artifactId>smalldoc-spring-boot-starter</artifactId>
    <version>2.4</version>
</dependency>
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,287评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,346评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,277评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,132评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,147评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,106评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,019评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,862评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,301评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,521评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,682评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,405评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,996评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,651评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,803评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,674评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,563评论 2 352

推荐阅读更多精彩内容