方式一 插件方式 springboot 啟動類 運行生成接口文檔 1.pom文件 導入插件 2.resource目錄下 smart-doc.json 配置文件 方式二 jar包方式 1.pom 導入jar包 ...

第一步： 　　添加plugin插件， 第二步： 　　新建smart-doc.json配置文件 　　 第三步： 　　查看maven里面的plugins會出現smart-doc，會有生成接口文檔的按鈕。 　　 ...

傳統swagger（之前在用）接口文檔的缺點： 1、代碼侵入性太強。 2、寫着麻煩。需要寫大量的注解，太麻煩！ smart-doc的優點： 1、不需要注解，無侵入性。 2、只需要寫好注釋即可，界面也比較美觀。 3、對一些常用的電話、地址之類的模擬的數據跟真的一樣（哈哈哈 ...

smart-doc是一款API文檔生成工具，無需多余操作，只要你規范地寫好代碼注釋，就能生成API文檔。同時能直接生成Postman調試文件，一鍵導入Postman即可調試！ 在項目中添加smart-doc的Maven插件 在項目的resources目錄下，添加配置文件 ...

工具開源地址 swagger2 : https://swagger.io/ smart-doc： https://www.oschina.net/p/smart-doc 國產 兩者的比較 swagger2 和 smart-doc 兩個開源工具 都可以 使用jar包 生成 api 文檔 ...

眾所周知（真不是人雲亦雲） swagger強大嗎？強大的。但是代碼侵入性太強了！ japidocs ,沒有代碼入侵問題，也很好！ 但是有個bug！沒有辦法傳入接口泛型對象。 比如： public ApiOut<User> String (ApiIn< ...

初衷 記得以前寫接口，寫完后會整理一份API接口文檔，而文檔的格式如果沒有具體要求的話，最終展示的文檔則完全決定於開發者的心情。也許多點，也許少點。甚至，接口總是需要適應新需求的，修改了，增加了，這份文檔維護起來就很困難了。於是發現了swagger，自動生成文檔的工具 ...

在使用 gRPC 時，常用做法是通過 Protobuf 進行接口及接口參數的定義。 隨着接口的增多，單純依靠閱讀 .proto 的方式來查看接口定義既勞神又費眼，也為其他人瀏覽接口帶來了不便。 通過 protoc-gen-doc 可以按照 protobuf 中定義的注釋形成相應的文檔，簡單點說 ...