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控制器）并测试它们。