Dorlon Notes

專案的API可能包含所有客戶的API接口 如果我們不想在API文件中提供所有API接口內容 可以 增加過濾器移除不想被看到的API接口 被隱藏的API接口在Swagger文件中看不到，但還是可以被使用的。 在Startup.cs 啟動中修改，增加文件過濾器 以下新增名稱為 AllowAPIDocumentFilter 來過濾未在允用清單中的API接口 自己建一個APISetting.json 允用清單(字串陣列)

1.專案中有些不想公開的口，可設定隱藏 (IgnoreApi = true) 2.輸出的Response可指定特定資料格式 3.利用註解標籤定義API的名稱、傳入參數、各參數的說明。

透過簡單的Swagger套件安裝即可產生Swagger頁面 1.將現有專案加入Swagger套件 2.在啟動檔Startup.cs加入Swagger設定，設定中指定XML檔名 3.為了讓Swagger取得相關註解標籤，專案需設定產出XML檔

目前.NET已有內建Help Page 能呈現足夠豐富的API文件內容 另一個產生自動API文件的服務 [Swagger] 1.介面比較漂亮 2.功能更強大 3.可直接線上執行API 並取得回傳結果 [API測試工具] 不需透過其它軟體或工具，直接可以在Swagger頁面帶入相關參數，執行並傳回結果。