作者：小魚兒511

https://blog.csdn.net/dongbeiou/article/details/106771453

JApiDocs是一個無需額外注解、開箱即用的SpringBoot接口文檔生成工具。

編寫和維護API文檔這個事情，對于后端程序員來說，是一件惱人但又不得不做的事情，我們都不喜歡寫文檔，但除非項目前后端代碼都是自己寫的，否則API文檔將是前后端協作中一個不可或缺的溝通界面。

既然不可避免，那就想辦法弄個輪子吧。人生苦短，必須偷懶。

無圖無真相，生成文檔的效果如下：

相比Swagger要寫一堆注解，Spring RestDocs需要寫測試用例，才能生成API文檔。JApiDocs 具有無痛集成的特點，你只需花幾分鐘就能知道它怎么用了。

快速開始

要使得JApiDcos正確工作，你寫的代碼應該是像下面的樣子的：

/***?用戶接口*/ @RequestMapping("/api/user/") @RestController public?class?UserController?{/***?用戶列表*?@param?listForm*/@RequestMapping(path?=?"list",?method?=?{RequestMethod.GET,??RequestMethod.POST}??)public?ApiResult<PageResult<UserVO>>?list(UserListForm?listForm){return?null;}/***?保存用戶*?@param?userForm*/@PostMapping(path?=?"save")public?ApiResult<UserVO>?saveUser(@RequestBody?UserForm?userForm){return?null;} }

我們給Controller類和方法加上必要的注釋，給接口方法返回相關的對象類型。是的，這樣JApiDocs就能解析到相關的接口信息了，就跟我們平時寫的代碼是差不多的，但要注意，你要通過@param來告訴JApiDocs接口的參數，但在IDE的幫助下，這個工作將是輕松愉悅的：

然后你在任意一個main入口方法執行下面的代碼就可以生成文檔了：

DocsConfig?config?=?new?DocsConfig(); config.setProjectPath("your?springboot?project?path");?//?項目根目錄 config.setProjectName("ProjectName");?//?項目名稱 config.setApiVersion("V1.0");???????//?聲明該API的版本 config.setDocsPath("your?api?docs?path");?//?生成API?文檔所在目錄 config.setAutoGenerate(Boolean.TRUE);??//?配置自動生成 Docs.buildHtmlDocs(config);?//?執行生成文檔

接下來你只管好好寫代碼，生成Api文檔的工作就可以交給JApiDocs了，你不需要再為額外編寫和維護文檔而煩惱。

功能特性

1、代碼即文檔

JApiDocs是通過直接解析SpringBoot的源碼語法來工作的，所以只要Controller的語法符合一定的代碼規范，有合理的注釋，就可以直接導出文檔。

2、支持導出HTML

便捷的導航和接口查看界面；可本地預覽，或者部署到HTTP服務器。推薦部署到服務器，方便前后端展開協作。

3、同步導出客戶端Model代碼

支持導出Android端的 Java 和iOS端的 Object C Model代碼，減少前端程序員的重復編碼工作。

4、更多特性

支持接口搜索；支持不同版本和英文文檔；自定義擴展等。

簡潔的文檔

再好用的東西，如果沒有文檔說明，別人也無從入手。為了讓大家盡快上手，JApiDocs準備了一份極簡的文檔說明，確保你在幾分鐘就能用上JApiDocs。

花5分鐘不到就能認識一個提高工作效率的工具，讓你把更多的時間花在更加有價值的事情上，你確認不看一下嗎？

“

倉庫地址：https://github.com/YeDaxia/JApiDocs

“中文文檔：https://japidocs.agilestudio.cn/#/zh-cn/

福利時間

GIFT TIME

一月一度的送書環節又來了

感謝大家一直以來的陪伴與支持

今天給大家贈送10本書

由北京大學出版社贊助

也歡迎大家自行購買

Java并發編程技術體系化講解，BAT級別高并發項目深度剖析，領略大咖的實戰代碼設計藝術。

本次送書不需要評論，也不需要轉發

采用最公平的抽獎方式。

關注公眾號：程序員面試現場

公眾號后臺回復：送書?

即可參與抽獎

往期推薦

想理解Java的IO，不要從操作系統開始說起的都是耍流氓...

阿里開源那個牛哄哄問題排查工具竟然不會用？最佳實踐來了！

性能優越的輕量級日志收集工具，微軟、亞馬遜都在用！

本文由“壹伴編輯器”提供技術支

?

直面Java第329期：哪個命令可以監控虛擬機各種運行狀態信息？

深入并發第013期：拓展synchronized——鎖優化

如果你喜歡本文,

請長按二維碼，關注?Hollis.

轉發至朋友圈，是對我最大的支持。

點個?在看?

喜歡是一種感覺

在看是一種支持

↘↘↘

總結

以上是生活随笔為你收集整理的还在用 Swagger（丝袜哥）生成接口文档？我推荐你试试它。。。的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。