幹掉 Swagger (絲襪哥)，試試這個新工具！

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了，你不須要再爲額外編寫和維護文檔而煩惱。

功能特性

一、代碼即文檔

JApiDocs是經過直接解析SpringBoot的源碼語法來工做的，因此只要Controller的語法符合必定的代碼規範，有合理的註釋，就能夠直接導出文檔。

二、支持導出HTML

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

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

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

四、更多特性

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

簡潔的文檔

再好用的東西，若是沒有文檔說明，別人也無從入手。爲了讓你們儘快上手，JApiDocs準備了一份極簡的文檔說明，確保你在幾分鐘就能用上JApiDocs。花5分鐘不到就能認識一個提升工做效率的工具，讓你把更多的時間花在更加有價值的事情上，你確認不看一下嗎？

• 倉庫地址：https://github.com/YeDaxia/JA...
• 中文文檔：https://japidocs.agilestudio....