标签：
上一篇，我们是正式将ABP生成的代码项目，跑起来了，然后演示了下多租户的不同。那么这篇我们就来实现下SwaggerUI。
Q:SwaggerUI是干什么的呢？
A:他是一个能将我们的webapi，通过Swagger Api来生成一个交互式的文档。通过他可以对你的接口进行调式。
选择PhoneBook.WebApi，然后添加nuget包（当然你也可以通过命令行添加）。
输入“Swashbuckle.core”
引入到我们的项目中。
打开 项目中的“PhoneBookWebApiModule.cs”文件.
创建一个方法“ConfigureSwaggerUi();”
/// <summary> /// 配置SwaggerUi /// </summary> private void ConfigureSwaggerUi() { Configuration.Modules.AbpWebApi().HttpConfiguration .EnableSwagger(c => { c.SingleApiVersion("v1", "YoYoCMS.PhoneBookAPI文档"); c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); }) .EnableSwaggerUi(); }
然后在Initialize()中对他进行调用。
运行项目，打开”/swagger/ui/index:”路径
得到的效果
到此呢，ABP实现SwaggerUI的功能已经算是可以了。但是我们不能就这么满足了。还不够，为什么呢。因为我们还要讲我们的注释显示出来。
这样其他开发人员看到了接口名称才能说叫做API文档嘛。
首先我们回到 方法：ConfigureSwaggerUi中，对他进行改造。
首先打开application类库的属性设置，然后在生成中找到XML文档文件，启用生成
然后再对ConfigureSwaggerUi方法进行改造
//将application层中的注释添加到SwaggerUI中 var baseDirectory = AppDomain.CurrentDomain.BaseDirectory; var commentsFileName = "Bin//YoYoCMS.PhoneBook.Application.xml"; var commentsFile = Path.Combine(baseDirectory, commentsFileName); //将注释的XML文档添加到SwaggerUI中 c.IncludeXmlComments(commentsFile);
添加以下到方法中。
然后运行项目：
咦。。。怎么没有。。注释呢。。。。
当然这一切的一切只是我们可以加注释，来现在我们把注释加上。。
然后再来运行一次项目。。。
上图我们就可以看到了。已经得到了注释信息，以后开发再也不怕哪个接口是哪个了。
到目前为止我们访问SwaggerUI的方式都是”/swagger/ui/index/” 这样的路径访问方式。
个人感觉不是很方面我们对它进行稍微的优化下。
我们可以看到EnableSwaggerUi，F12转到定义下。
支持路由重定向，那么我们就开始改造吧。
其实就这么一句话，改造后的访问路径“/apis/index”就可以了。
看看效果。
这样操作接口就比较方便了。
.EnableSwaggerUi("apis/{*assetPath}", b => { b.InjectJavaScript(); b.InjectStylesheet(); });
一个 是注入JavaScript文件，一个是输入css文件。所以如果这里可以对我们的SwaggerUI界面进行自定义修改的。
需要将js文件路径注入到SwaggerUI中。
.EnableSwaggerUi("apis/{*assetPath}", b => { //对js进行了拓展 b.InjectJavaScript(Assembly.GetExecutingAssembly(), "YoYoCMS.PhoneBook.SwaggerUi.scripts.swagger.js"); });
//YoYoCMS.PhoneBook.SwaggerUi.scripts.swagger.js是你的命名空间加上文件的路径.
swagger.js需要设置为嵌入的资源。
如此。The End
标签：
原文地址：http://www.cnblogs.com/wer-ltm/p/5776024.html
