swagger.core的使用方法

Posted 2020-06-16

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务，那么如何在abp中使用呢，已经有大牛为我们实现了一个swagger.core的组件而作为菜鸟的我们只需要通过简单安装配置即可使用。

1、安装

　　通过“程序管理包控制台进行安装，键入Install-Package Swashbuckle.Core命令即可，注意：这里的默认项目一定要是webapi这一层”

 

2、配置

　　引入名称空间

using Swashbuckle.Application;
using System.Linq;

 

　　配置代码

public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());

            DynamicApiControllerBuilder
                .ForAll<IApplicationService>(typeof(testApplicationModule).Assembly, "app")
                .Build();

            Configuration.Modules.AbpWebApi().HttpConfiguration.Filters.Add(new HostAuthenticationFilter("Bearer"));

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

 

注意：test.Api为当前webapi的名称空间

3、查看api列表

　　通过在项目/网站地址后面键入/swagger/ui/index访问

4、调用api函数

　　选一个你要调用的api输入参数并点击try it out按钮调用

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－

以上测试均在abp0.8.0.1中使用Swashbuckle.Core 5.3.1测试通过

最近附上原文地址http://www.aspnetboilerplate.com/Pages/Documents/Swagger-UI-Integration