ABP理論學習之Swagger UI集成

返回總目錄

---

本篇目錄

• 介紹
• 安裝
  • 安裝Nuget包
  • 配置
  • 測試

介紹

從官方網站上可以看到：“啟用了Swagger API，就可以獲得交互式文檔，生成和發現客戶端SDK”。

安裝

將Swagger集成到基於ABP的應用中是很容易的事情。

安裝Nuget包

將Swashbuckle.Core Nuget包安裝到WebApi項目（或Web項目）中。

配置

將Swagger的配置代碼添加到模塊的Initialize方法中。例如：

public class SwaggerIntegrationDemoWebApiModule : AbpModule
{
    public override void Initialize()
    {
        //your other code...

        ConfigureSwaggerUi();
    }

    private void ConfigureSwaggerUi()
    {
        Configuration.Modules.AbpWebApi().HttpConfiguration
            .EnableSwagger(c =>
            {
                c.SingleApiVersion("v1", "SwaggerIntegrationDemo.WebApi");
                c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
            })
            .EnableSwaggerUi();
    }
}

查看Swagger的官方文檔獲取更多的配置選項。

測試

接下來，瀏覽/swagger/ui/index:

你可以看到所有的Web API控制器（以及動態web api控制器）並測試它們。