還在用絲襪哥（Swagger）做API文檔？快來看看這款幫你減少百分之九十工作量的開源工具！
提一嘴Swagger
相信不少的小伙伴都會在日常工作中寫API文檔，確實這個文檔很有必要去寫，便于項目的維護，在我們提桶的時候，接盤俠可以輕松地接管我們的項目。說起API文檔，我們腦海中想到的就是肯定是Swagger，他以前確實統治了江湖很久，因為他的確很方便，也很智能，但是吧，你寫多了總感覺哪里不對勁，是的，他的代碼侵入性太強，而且要寫大量重復的注釋，那我最近在寫的一個項目來說，簡直是程序員的夢魘。
這只是一個實體類的一部分，還有service、controller的這些注解我就不一一列舉了，侵入性太強，注釋繁多，而且你在編譯以后還是存在于代碼中不會被擦除。
于是乎，我有一次在寫代碼（摸魚）的時候，偶然發現一個Gitee上的高贊API文檔，鏈接：smart-doc
主角smart-doc
smart-doc是一款同時支持JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，劃重點了，他還支持Dubbo RPC接口文檔，遙想當年，Swagger要想支持Dubbo的話必須要自己修改和拓展，官方是不支持的。于是我就照著官方文檔給的案例，去部署生成了一下API文檔，真香！
新建smart-doc.json
我們需要新建一個smart-doc.json來寫一些配置，我這里也給出一份模板，有需要的鐵汁們直接cv改改即可。
{ //服務器地址 "serverUrl": "http://127.0.0.1", //是否用嚴格模式，嚴格模式強制檢查注釋 "isStrict": false, //所有接口文檔合并生成到一個文檔 "allInOne": true, //文檔的輸出路徑 "outPath": "src/main/resources/static/doc", //指定項目名稱，用于顯示在文檔中 "projectName": "test-smart-doc" }
引入依賴
測試
雙擊smart-doc即可生成java普通（為了區別于Dubbo）的文檔，他的UI界面也不丑，大致長這樣。
我們幾乎沒有寫任何注釋代碼，就自動生成了一個API文檔，沒有任何侵入性。
smart-doc強在哪？
smart-doc對比傳統一哥Swagger究竟有什么不同？
smart-doc主要是基于源代碼和JAVADOC標注注釋來生成文檔，是在開發期或者是項目的編譯期執行生成文檔，意味著你是在項目編譯完以后你在源碼里面是找不到smart-doc的任何依賴的，0侵入性。
swagger主要原理是利用JAVA的注解和反射機制去生成文檔，這種方式侵入性太強。
這也就是為什么我剛剛什么注解都沒寫，但是依然可以生成合格的API文檔，于是乎我馬上把Swagger換成了smart-doc，只能說真香，再也不用寫@ApiModel這種注解了。
API Java
版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。
版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。
相關文章
