2016-05-06 37 views
4

我正在使用Swashbuckle在我的WebApi項目中啓用swagger和swagger-ui。有沒有辦法在swagger-ui頁面中更改控制器的名稱?

在下圖中,您可以看到swagger-ui頁面中顯示的兩個控制器。這些被命名爲他們在C#代碼中,但是我想知道是否有方法來改變這裏顯示的內容?

這主要是因爲您可以看到ManagementDashboardWidget不是用戶友好的名稱,所以我想將其更改爲用戶友好型。

swagger-ui

+0

您是否嘗試過使用Swagger的@Api作爲您的寧靜服務類的註釋? – Sampada

+0

@Sampada我不確定如何訪問,請你給我多一點信息? – XN16

+0

我很抱歉@API可用於Java中的招搖,而不是swashbuckle的招搖。 – Sampada

回答

6

您可以使用該標記。默認情況下,Swashbuckle爲每個操作添加一個帶有控制器名稱的標籤。你可以用SwaggerOperationAttribute覆蓋它。例如,下一行替換默認標籤,價值觀,與標籤測試:

public class ValuesController : ApiController 
{ 
    [SwaggerOperation(Tags = new[] { "Test" })] 
    public IHttpActionResult Get() 
    { 
     // ... 
    } 
} 

Get操作將組Test中放。

如果您希望操作出現在多個組中,您可以添加更多標籤。例如:

[SwaggerOperation(Tags = new[] { "Test", "Release1" })] 

會把Get操作組TestRelease1

+0

這正是我想要的......我從來沒有在那部分找到很多文檔。非常感謝。 – XN16

相關問題