ABP中使用Swagger UI集成接口文檔

Swagger

ABP中已經集成了Swagger
1.首先介紹的是ABP中Swagger，支持動態映射應用層，也就是，無需創建控制器。

前提：要在Web.Core配置

//這是配置ap框架本身的application
Configuration.Modules.AbpAspNetCore()
                 .CreateControllersForAppServices(
                     typeof(AbpProjectApplicationModule).GetAssembly()
                 );
            //向swagger中動態生成api測試
//BizMasterDataApplicationModule這是自己封裝的application
            Configuration.Modules.AbpAspNetCore()
                .CreateControllersForAppServices(
                    typeof(BizMasterDataApplicationModule).GetAssembly()
                );

2.配置工程XML


3.找到starpup.cs
在配置文件中配置剛剛的xml的名稱

  public IServiceProvider ConfigureServices(IServiceCollection services)
{
services.AddSwaggerGen(options =>
            {
                  //ShawnWong 獲取程序運行根路徑 
                //Swagger注解xml生成到更目錄，xml文件名在配置中

                var currentExecutingPath = System.AppDomain.CurrentDomain.BaseDirectory;
                var xmlNameConfig = _appConfiguration["App:SwaggerXmlName"];
                //此配置可直接映射application層也可以映射host中控制器那層
                //所有可能出現多個xml name
                //存在多個配置
                if (xmlNameConfig.Contains('&'))
                {
                    foreach (var item in xmlNameConfig.Split('&'))
                    {
                        options.IncludeXmlComments($"{currentExecutingPath}/{item}",true);
                    }                             
                }
            }
}

至此啟動運行即可

最后

返回總目錄