一. smart-doc簡介
smart-doc是一款接口文檔生成工具，它完全是根據接口源碼進行分析生成接口文檔，不會使用任何注解侵入業務代碼中。這一點與swagger完全不同，swagger侵入性強，需要編寫大量注解。
在Java項目中，我們隻需要按照java-doc的标準編寫注釋，就能生成一個簡易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+格式的文檔。
smart-doc幫助文檔：https://smart-doc-group.github.io/#/zh-cn/?id=smart-doc
二. SpringBoot項目內建smart-doc
1. 完善項目中的注釋
給實體類添加相關的注釋，如下圖所示：
我們在控制器上也添加應有的注釋
注意：我們項目中的類、方法、屬性，都必須使用文檔注釋！
作為開發人員，一定要養成規範編寫注釋的好習慣。
2. smart-doc的配置資訊
接着我們要在resource目錄下建立一個smart-doc.json檔案，在該檔案中輸入如下内容：
smart-doc的配置項很多，其他各種配置可參考上文提到的幫助文檔進行檢視。
3. 配置smart-doc插件
接着我們要在pom.xml檔案的plugins标簽中，增加如下内容：
<configFile>中指定需要調用的smart-doc配置檔案的路徑。
4. 生成文檔
在idea中，我們可以直接通過插件生成smart各種格式的文檔，如下圖所示：
在本例中，我們輕按兩下smart-doc:html就可以生成html格式的接口文檔。
生成文檔後，所在目錄中的内容如下：
配置"allInOne": true後，生成的文檔中隻會包含一個index.html檔案。如果設定為false，生成的接口文檔會包括api.html、dict.html和error.html多個檔案，大家可以自行測試。
5. 接口文檔界面效果
最後我們輕按兩下index.html，就可以檢視生成的接口文檔效果了。
大家可以根據上文的smart-doc配置，找找每個配置在接口文檔中對應顯示的内容。
三. 接口測試
1. 配置調試頁面進行測試
1.1 生成文檔
根據上文的配置，預設情況下，僅是生成接口文檔，配置"createDebugPage": true，輕按兩下插件的smart-doc:html選項，即可生成帶接口調用功能的接口文檔。怎麼樣，這個功能是不是相當強大？
生成帶調試功能的接口檔案，如下所示：
1.2 運作測試
此時輕按兩下debug-all.html，運作測試文檔後，頁面如下：
2. 導入ApiPost進行測試
2.1 生成postman格式文檔
接着我們再輕按兩下smart-doc:postman，生成一個postman格式的文檔：
生成的postman格式文檔如下所示：
2.2 導入文檔
我們還可以在ApiPost中導入該文檔，其步驟如下：
2.3 測試接口
導入後，我們可以切換到導入的項目，這樣就可以進行接口測試了。