零侵入文檔生成及API測試工具smalldoc-2.4發佈!

smalldoc的上一個版本是2.3.12.3.2在2019-10月就開始操刀了,可是因爲兩個緣由2.3.2未及時交付——java

  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,更新日誌以下。。。git

更新日誌

  • 更強大的參數配置語法,使接口文檔展現更人性化加強#8
  • 增長了基於包的徹底限定名或package-info中的註釋信息選擇文檔的菜單欄功能加強#7
  • 對UNIX系統作了兼容,例如Mac OS(爲此,做者專門買了本Mac 😂)加強#7
  • 增長了接口參數示例值推斷加強#14
  • 集成了API測試功能加強#14
  • 可配置的解析類名,支持正則匹配加強#9
  • 優化了返回參數實體內集合字段的展現效果加強#15
  • 修復了TypeVariableTypeArgument時沒法解析的錯誤,以下格式修復 #15github

    @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);
  • 刪除了不合理的執行邏輯(好比,直接以實體集合做爲接口方法的入參,以下的錯誤使用方式)加強 #15spring

    @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>
相關文章
相關標籤/搜索