如何在Swagger中實現搜索功能和添加評論

Question

guys：

我使用swagger來製作api文檔。我使用ASP.NET WebAPI2來開發WebAPI。 我遇到了三個問題：

第一：如何爲WebAPI控制器添加註釋？我嘗試添加評論控制器

namespace IMCAPI.Controllers 
{ 
/// <summary> 
/// Value API 
/// </summary> 
[Authorize] 
public class ValuesController : ApiController 
{ 
    // GET api/values 
    /// <summary> 
    /// Get all Values 
    /// </summary> 
    /// <returns></returns> 
    public IEnumerable<string> Get() 
    { 
     return new string[] { "value1", "value2" }; 
    } 

，但not work。

第二：如何通過瀏覽器網址在Swagger中搜索特定的WebAPI？像這樣Browser Url Search

例如，如果我想搜索Value API，我在紅色部分輸入Value，我希望搜索結果只顯示Value API，我不希望其他API出現（如Account）。或者如何設置可以具有搜索功能的SwaggerConfig.cs？

第三：我想知道swagger是否可以只讀一個xml文件？我搜索互聯網，他們演示這樣的

private static string GetXmlCommentsPath() 
    { 
     return String.Format("{0}/App_Data/IMCAPI.XML", AppDomain.CurrentDomain.BaseDirectory); 
    } 

如果我有多個XML文件，我怎麼能集成在招搖？

那它。希望有人能幫助我。謝謝！

Answer 1

你的第一個問題：這些評論是出現，你把它們放在Get方法在你的代碼，他們出現在你的屏幕截圖Get方法。如果你想要的是整個服務的描述，Swagger documentation表示使用Description方法。

第二：你不能顯示該API上的所有方法。

第三：Swagger documentation表示您多次呼叫IncludeXmlComments並指定每個XML的路徑。