動態忽略控制器上的 WebAPI 方法以獲取 api 資源管理器文檔

Question

我們已經實現了一個 webAPI，我們有許多 API 控制器。 我們為我們的 API 提供了一個 API 文檔，我們想要做的是從文檔中排除某些 Web 方法，但我們希望根據我們正在運行的環境動態完成此操作。 只是為了讓您了解我的意思，假設我有以下網絡方法

[ApiExplorerSettings(IgnoreApi = true)] 
public Product getProduct()
{
   ...
}

通過將 ApiExplorerSettingAttribute 上的 IgnoreAPI 屬性設置為 true，它從文檔中排除了我們想要的 web 方法，但我們需要一種動態設置“true”值的方法。 理想情況下，我們希望有一個包含每個 webMethod 的 bool 值的數據庫表，並基於這些設置 IgnoreAPi 屬性的值。 有沒有辦法實現這一目標？ 您的幫助將不勝感激。

Answer 1

您可以實現自定義IApiExplorer並將其注冊到 Web API 的服務中，以完全控制列出或不列出哪些 API。

這是實現大部分內容的開發人員的博客文章： https : //docs.microsoft.com/en-us/archive/blogs/yaohuang1/asp-net-web-api-introducing-iapiexplorerapiexplorer

這是IApiExplorer接口定義： http : //msdn.microsoft.com/en-us/library/system.web.http.description.iapiexplorer( IApiExplorer .aspx

您可以做的一件事是從（或重用現有源）現有的ApiExplorer實現並調用base來獲取默認列表，然后根據需要進一步過濾它。

根據 s_hewitt 的評論，建議是：

從 ApiExplorer 派生，實現這兩個方法 ShouldExploreAction 和 ShouldExploreController 是要走的路。 在這兩種方法中進行數據庫調用，根據路由、控制器和操作進行查找。

Answer 2

我不太了解 WebAPI 的文檔生成，但我知道屬性。 屬性被編譯到代碼中，並導致硬編碼值直接保存在 EXE 或 DLL 的數據中。 它們無法更改。

話雖如此，您也許可以在正常編譯后將屬性作為第二組應用。 也許PostSharp可以在這里提供幫助？ 也許更改解決方案配置可能是指示您要為其構建的環境以及哪些方法獲得 IgnoreApi 處理的一種方式。 您可以創建自己的屬性以應用於描述該方法應在哪些環境中被忽略的方法。 （我認為，如果您不嘗試調用數據庫來獲取這些數據，則更有可能在 PostSharp 中執行您想要的操作。）