在Abp中集成Swagger UI功能

1.安装Swashbuckle.Core包

通过NuGet将Swashbuckle.Core包安装到WebApi项目（或Web项目）中。

2.为WebApi方法添加注释，并生成xml

在xxx.Application项目的接口声明文件中为各接口方法添加注释，如下图：
编辑xxx.Application项目属性，设定在输出时生成XML文档文件

3.在xxx.WebApi项目中配置Swagger

修改xxxWebApiModule类，添加ConfigureSwaggerUi()方法，并在Initialize()方法的最后调用它。

注意：要添加对Abp.Configuration.Startup、Swashbuckle.Application命名空间的引用。

另外，不调用ResolveConflictingActions()方法来提供冲突解决办法将有可能遇到500错误。

using System.Linq;

using Abp.Configuration.Startup;

using Swashbuckle.Application;

    [DependsOn(typeof(AbpWebApiModule), typeof(OrganizationApplicationModule))]

    public class OrganizationWebApiModule : AbpModule

    {

        public override void Initialize()

        {

            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());

            DynamicApiControllerBuilder

                .ForAll<IApplicationService>(typeof(OrganizationApplicationModule).Assembly, "csci")

                .Build();

            //配置跨域

            GlobalConfiguration.Configuration.EnableCors(new System.Web.Http.Cors.EnableCorsAttribute("*", "*", "*"));

            //配置输出json时不使用骆驼式命名法，按对象属性原名输出

            GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new Newtonsoft.Json.Serialization.DefaultContractResolver();

            //集成Swagger UI

            ConfigureSwaggerUi();

        }

        private void ConfigureSwaggerUi()

        {

            var xmlFile = string.Format("{0}/bin/{1}.Application.xml", System.AppDomain.CurrentDomain.BaseDirectory, this.GetType().Namespace);

            Configuration.Modules.AbpWebApi().HttpConfiguration

                .EnableSwagger(c =>

       ![](http://images2015.cnblogs.com/blog/19184/201706/19184-20170613111141275-1740289580.png)

         {

                    c.SingleApiVersion("v1", this.GetType().Namespace);

                    c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());

                    if (System.IO.File.Exists(xmlFile)) { c.IncludeXmlComments(xmlFile); }

                })

                .EnableSwaggerUi();

        }

    }

4.测试

运行WEB项目，在浏览器中访问{项目网址}/swagger，即可见到动态生成的WebApi接口，并可以直接调试。

注：如果见不到[Try it out!]按钮，点一下"Expand Operations"链接即可。

参考：

ABP理论学习之Swagger UI集成

 .net WebApi中使用swagger

在Abp中集成Swagger UI功能的更多相关文章

【转】C# ABP WebApi与Swagger UI的集成
以前在做WebAPI调用测试时,一直在使用Fiddler测试工具了,而且这个用起来比较繁琐,需要各种配置,并且不直观,还有一点是还得弄明白URL地址和要传递的参数,然后才能调用. 最近新入职,公司里 ...
asp.net core 集成swagger ui
什么是Swagger? 说swagger 之前,我们先说一下OpenApi 规范. OpenApi 是一种和语言无关的用于描述RESTAPIs 接口功能的一种规范,对RESTAPIs 接口的描述包括: ...
15、Spring Boot 2.x 集成 Swagger UI
1.15.Spring Boot 2.x 集成 Swagger UI 完整源码: Spring-Boot-Demos 1.15.1 pom文件添加swagger包 <swagger2.versi ...
ABP理论学习之Swagger UI集成
返回总目录本篇目录介绍安装安装Nuget包配置测试介绍从官方网站上可以看到:"启用了Swagger API,就可以获得交互式文档,生成和发现客户端SDK". 安装 ...
C# ABP WebApi与Swagger UI的集成
本文是配置WebApi与Swagger UI,可以参照 http://www.cnblogs.com/farb/p/ABPSwaggerUIIntegration.html 1. 安装swagger ...
在WebApi中集成 Swagger
1. Swagger(俗称:丝袜哥)是什么东西? Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同 ...
[2017-10-25]Abp系列——集成消息队列功能(基于Rebus.Rabbitmq)
本系列目录:Abp介绍和经验分享-目录前言由于提交给ABP作者的集成消息队列机制的PR还未Review完成,本篇以Abplus中的代码为基准来介绍ABP集成消息队列机制的方案. Why 为什么需要 ...
如何在ios中集成微信登录功能
在ios中集成微信的登录功能有两种方法 1 用微信原生的api来做,这样做的好处就是轻量级,程序负重小,在Build Settings 中这样设置然后设置友盟的设置同上,但是要注意,加入你需要的所 ...
怎么在我们的App中集成条码扫描功能？
现在很多App都有条码扫描功能,有的手机比如某米在照相机中集成了条码扫描功能,但是还有一部分手机没有这样的集成,比如韩国某星,需要自己下载一个条码扫描App.今天我们就来看看怎么在自己的App中集成一 ...

随机推荐

.NET （五）委托第五讲：内置委托Predicate
// 摘要: // 表示定义一组条件并确定指定对象是否符合这些条件的方法. // // 参数: // obj: // 要按照由此委托表示的方法中定义的条件进行比较的对象. // // 类型参数: // ...
SQL 字符串处理大全
select语句中只能使用sql函数对字段进行操作(链接sql server),select 字段1 from 表1 where 字段1.IndexOf("云")=1;这条语句不对 ...
teeChart 修改注册表实现无试用到期提示
teechart在注册表的跟目录为HKEY_CLASSES_ROOT\CLSID,以下的子目录会根据版本的不同发生改变,但是最底级的目录是TypeLib(例如[HKEY_CLASSES_ROOT\CL ...
centos 7.2 网卡配置文件及 linux bridge的静态配置
在 centos 7.2 系统内, 网卡的配置文件在: /etc/sysconfig/network-scripts/ 下. 命名规则: ifcfg-xxxx. xxx为设备名称. 通过分析 ne ...
tomcat日志文件定时清理备份
以下脚本主要备份的日志文件为tomcat的catalina.out.localhost_access_log.yyyy-mm-dd.log日志和项目的日志文件,其中项目的日志文件格式为"pr ...
scala-尾递归
------------------------- by chenkh ----------------------------- 随笔记录什么是尾递归,为什么需要尾递归,尾递归show by exa ...
跨过几个坑，终于完成了我的第一个Xamarin Android App！
时间过得真快,距离上次发随笔又是一年多.作为上次发的我的第一个WP8.1应用总结的后继,这次同样的主要功能,改为实现安卓版APP.前几个月巨硬收购Xamarin,把Xamarin集成到VS里了,大大方 ...
常用JS效果需要时更新。。。
1.手风琴效果 JS: $(function() { var aMenuOneLi = $(".menu-one > li"); var aMenuTwo = ...
Owin SelfHost Asp.net WebApi 遇到 No type was found that matches the controller named 'ControllerName' 异常的解决方案
问题背景:在使用普通的SelfHost时,调用其它工程的dll(其实就是把WebApi写到一个单独的工程方便管理),通过加载其他工程的dll然后再访问webapi是没有问题的. 但是在使用Owin S ...
poj3678 Katu Puzzle 2-SAT
Katu Puzzle Time Limit: 1000MS Memory Limit: 65536K Total Submissions: 6714 Accepted: 2472 Descr ...

在Abp中集成Swagger UI功能

在Abp中集成Swagger UI功能

1.安装Swashbuckle.Core包

2.为WebApi方法添加注释，并生成xml

3.在xxx.WebApi项目中配置Swagger

4.测试

在Abp中集成Swagger UI功能的更多相关文章

随机推荐

热门专题