smart-doc是一個(gè)java restful api文檔生成工具，smart-doc顛覆了傳統(tǒng)類似swagger這種大量采用注解侵入來生成文檔的實(shí)現(xiàn)方法。smart-doc完全基于接口源碼分析來生成接口文檔，完全做到零注解侵入，你只需要按照java標(biāo)準(zhǔn)注釋的寫就能得到一個(gè)標(biāo)準(zhǔn)的markdown接口文檔。如果你已經(jīng)厭倦了swagger等文檔工具的注解和強(qiáng)侵入污染，那請(qǐng)擁抱smart-doc吧！

功能特性

• 零注解、零學(xué)習(xí)成本、易集成、只需要寫標(biāo)準(zhǔn)java注釋。
• 基于源代碼接口定義自動(dòng)推導(dǎo)(唯一實(shí)現(xiàn)對(duì)象關(guān)聯(lián)無限級(jí)自推導(dǎo))。
• 支持Spring MVC,Spring Boot。
• 目前支持javabean上定義的部分fastjson和jackson注解。
• 支持javabean上基于jsr303參數(shù)檢驗(yàn)判斷參數(shù)是否為必須。
• 對(duì)json請(qǐng)求參數(shù)的接口能夠自動(dòng)生成模擬json參數(shù)。
• 對(duì)一些常用字段定義能夠生成有效的模擬值。
• 支持生成json返回值示例。
• 支持從項(xiàng)目外部加載源代碼來生成字段注釋。
• 一款代碼注釋檢測(cè)工具，不寫注釋的小伙伴逃不過法眼了。

更新內(nèi)容

•  升級(jí)smart-doc依賴的基礎(chǔ)庫(kù)。
• 增加對(duì)普通的get請(qǐng)求參數(shù)拼裝示例的生成。

• 增加spring mvc占位符restful url請(qǐng)求示例生成。

升級(jí)建議

    目前軟件功能不斷迭代，smart-doc的原始用戶強(qiáng)烈建議升級(jí)到最新版。

下一版升級(jí)預(yù)告

       目前smart-doc一些重要的功能已經(jīng)完成開發(fā)，節(jié)后會(huì)發(fā)布下一個(gè)重大版本。下一次升級(jí)將意味著它將會(huì)為更多的開發(fā)者提供服務(wù)，

將會(huì)真正意義上成為眾多java web開發(fā)者首選的api doc生成工具，也意味著留給swagger的時(shí)間不多了，需要的小伙伴請(qǐng)趕緊收藏好，。下一版功能預(yù)告(已進(jìn)入測(cè)試階段)：

•    新增Spring Boot Web Flux(controller書寫方式)。
•    新增Callable,Future,CompletableFuture等異步接口返回的推導(dǎo)支持。
•    修改過去版本中smart-doc生成文檔中的一些細(xì)節(jié)。
•    重點(diǎn)：新增生成靜態(tài)html書簽式api文檔的功能實(shí)現(xiàn)在線查看api文檔(可先預(yù)覽smart-doc提供demo中的html文檔)

DEMO

使用demo輕松玩轉(zhuǎn)接口文檔生成

相關(guān)文檔

關(guān)于java web restful api文檔的重新探索

smart-doc功能使用介紹

 

標(biāo)簽： [db:TAGG]

版權(quán)申明：本站文章部分自網(wǎng)絡(luò)，如有侵權(quán)，請(qǐng)聯(lián)系：west999com@outlook.com
特別注意：本站所有轉(zhuǎn)載文章言論不代表本站觀點(diǎn)！
本站所提供的圖片等素材，版權(quán)歸原作者所有，如需使用，請(qǐng)與原作者聯(lián)系。