如何從根網址重定向到/ swagger/ui/index？

Question

我有一個安裝了Swashbuckle的WebApi項目。

在默認設置下，我必須打開瀏覽器http://localhost:56131/swagger/ui/index才能查看我的操作說明和測試頁面。我希望它可以從站點的根目錄訪問：http://localhost:56131/。我怎樣才能做到這一點？

Answer 1

通過this answer to similar question影響，略作修改代碼：

public class WebApiConfig 
{ 
    public static void Configure(IAppBuilder app) 
    { 
     var httpConfig = new HttpConfiguration(); 

     // Attribute routing 
     config.MapHttpAttributeRoutes(); 

     // Redirect root to Swagger UI 
     config.Routes.MapHttpRoute(
      name: "Swagger UI", 
      routeTemplate: "", 
      defaults: null, 
      constraints: null, 
      handler: new RedirectHandler(SwaggerDocsConfig.DefaultRootUrlResolver, "swagger/ui/index")); 

     // Configure OWIN with this WebApi HttpConfiguration 
     app.UseWebApi(httpConfig); 
    } 
} 

這樣，它不是必要的，因爲這樣做在他的回答@bsoulier創造新的WebAPI控制器。

此解決方案基於Swashbuckle.Core組件中的已有類RedirectHandler。

Answer 2

如果您肯定使用Web API項目，您可以：

• 使Http Attribute Routing，
• 現有或新的控制器中創建以下方法：

[Route(""), HttpGet] 
[ApiExplorerSettings(IgnoreApi = true)] 
public HttpResponseMessage RedirectToSwaggerUi() 
{ 
    var httpResponseMessage = new HttpResponseMessage(HttpStatusCode.Found); 
    httpResponseMessage.Headers.Location = new Uri("/swagger/ui/index", UriKind.Relative); 
    return httpResponseMessage; 
} 

注使用ApiExplorerSettings屬性，這樣它就不會出現在Swagger定義中。