還在用 Swagger(絲襪哥)生成接口文檔?我推薦你試試它.
作者：小魚兒511https://blog.csdn.net/dongbeiou/article/details/106771453
JApiDocs是一個(gè)無(wú)需額外注解、開箱即用的SpringBoot接口文檔生成工具。
編寫和維護(hù)API文檔這個(gè)事情，對(duì)于后端程序員來(lái)說(shuō)，是一件惱人但又不得不做的事情，我們都不喜歡寫文檔，但除非項(xiàng)目前后端代碼都是自己寫的，否則API文檔將是前后端協(xié)作中一個(gè)不可或缺的溝通界面。
既然不可避免，那就想辦法弄個(gè)輪子吧。人生苦短，必須偷懶。
無(wú)圖無(wú)真相，生成文檔的效果如下：
相比Swagger要寫一堆注解，Spring RestDocs需要寫測(cè)試用例，才能生成API文檔。JApiDocs 具有無(wú)痛集成的特點(diǎn)，你只需花幾分鐘就能知道它怎么用了。快速開始要使得JApiDcos正確工作，你寫的代碼應(yīng)該是像下面的樣子的：
/**
?*?用戶接口
?*/
@RequestMapping("/api/user/")
@RestController
public?class?UserController?{
????/**
?????*?用戶列表
?????*?@param?listForm
?????*/
????@RequestMapping(path?=?"list",?method?=?{RequestMethod.GET,??RequestMethod.POST}??)
????public?ApiResult
????????return?null;
????}
????/**
?????*?保存用戶
?????*?@param?userForm
?????*/
????@PostMapping(path?=?"save")
????public?ApiResult
????????return?null;
????}
}
@param來(lái)告訴JApiDocs接口的參數(shù)，但在IDE的幫助下，這個(gè)工作將是輕松愉悅的：
然后你在任意一個(gè)main入口方法執(zhí)行下面的代碼就可以生成文檔了：DocsConfig?config?=?new?DocsConfig();
config.setProjectPath("your?springboot?project?path");?//?項(xiàng)目根目錄
config.setProjectName("ProjectName");?//?項(xiàng)目名稱
config.setApiVersion("V1.0");???????//?聲明該API的版本
config.setDocsPath("your?api?docs?path");?//?生成API?文檔所在目錄
config.setAutoGenerate(Boolean.TRUE);??//?配置自動(dòng)生成
Docs.buildHtmlDocs(config);?//?執(zhí)行生成文檔
看完本文有收獲？請(qǐng)轉(zhuǎn)發(fā)分享給更多人
關(guān)注「Java后端編程」，提升Java技能
好文章，我在看??