2016-11-14 39 views
3

使用Swagger-UI和ServiceStack,我試圖使用Api屬性來命名我的服務更清潔。如何正確使用ServiceStack中的Api屬性來命名SwaggerUI中的服務?

我很難找出屬性需要添加description屬性到由swagger創建的resources端點中的api。

我有一個基本請求被我的客戶端點的其他一些請求繼承。 Api屬性僅在放置在此特定請求dto時才起作用。如果我將它移動到另一個,它將停止工作。這裏是什麼我昂首闊步頁面看起來像〔實施例:

enter image description here

下面是該代碼:

enter image description here

,這裏是似乎沒有工作的代碼:

enter image description here

我想有一個好記的名稱爲每個SERVIC即謝謝!

編輯:我確實追蹤了ServiceStack代碼庫中的一些代碼,表明它正在尋找FirstAttribute。我試着通過改變事物的順序來進行測試,但也沒有得到理想的結果。如果有幫助,我正在尋找AttributeExtensions.cs

回答

1

您可以使用[Api("API Description")][Description("API Description")] 的說明添加到一個服務雖然這並不總是直接多個路由映射到揚鞭路線描述爲揚鞭UI組覆蓋多個不同的單個頂級路線下共享頂級路線的服務。

但是你可以在SwaggerFeature指定路由聚合與RouteSummary字典,e.g:

Plugins.Add(new SwaggerFeature { 
    RouteSummary = { 
     { "/top-level-path", "Route Summary" } 
    } 
}); 
+0

嗨mythz,是有道理的。你是否告訴我,沒有辦法直接設定招搖擺打會顯示什麼?如果我將其添加到特定路線的所有路線中,它會起作用嗎?即以「/ marketing」開頭的路線(我認爲這是一個讓人sw目結舌的路線)? – IronicMuffin

+0

@IronicMuffin僅供參考我已經添加了一個使用SwaggerFeature上的RouteSummary功能來指定Route Summary說明的示例。 – mythz

+0

謝謝 - 我沒有意識到這是一個選項! – IronicMuffin

相關問題