IT知识库 购物 网址 游戏 小说 歌词 快照 开发 股票 美女 新闻 笑话 | 汉字 软件 日历 阅读 下载 图书馆 编程 China
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
vbs/VBScript DOS/BAT hta htc python perl 游戏相关 VBA 远程脚本 ColdFusion ruby专题 autoit seraphzone PowerShell linux shell Lua Golang Erlang 其它教程 CSS/HTML/Xhtml html5 CSS XML/XSLT Dreamweaver教程 经验交流 开发者乐园 Android开发资料
站长资讯 .NET新手 ASP.NET C# WinForm Silverlight WCF CLR WPF XNA VisualStudio ASP.NET-MVC .NET控件开发 EntityFramework WinRT-Metro Java C++ PHP Delphi Python Ruby C语言 Erlang Go Swift Scala R语言 Verilog 其它语言 架构设计 面向对象 设计模式 领域驱动 Html-Css JavaScript jQuery HTML5 SharePoint GIS技术 SAP OracleERP DynamicsCRM K2 BPM 信息安全 企业信息 Android开发 iOS开发 WindowsPhone WindowsMobile 其他手机 敏捷开发 项目管理 软件工程 SQLServer Oracle MySQL NoSQL 其它数据库 Windows7 WindowsServer Linux
  IT知识库 -> .NET新手区 -> WebApi使用swagger ui自动生成接口文档 -> 正文阅读

[.NET新手区]WebApi使用swagger ui自动生成接口文档

WebApi使用swagger ui自动生成接口文档 之前就写到。最近正在使用webapi。这里介绍一个实用的东西swageer ui
现在开发都是前后端分开。我们这里是给前端提供api。有时候对于一个api的描述,并不想专门写一份文档。很浪费时间。
swagger ui就是一个能整合到项目中让api的注释能够生成到一个网页上。能简单测试和给前端看。
开怼吧。
Step.1 Nuget安装
打开你的Nuget console,Install-Package Swashbuckle(要选择哪个项目)

ps.其实第一步安装完了,你什么不用做。运行起来,网址进入/swagger/ui/index就能看到你的那些api了(不带注释),不过没达到我们的预期效果——将注释自动生成到文档上。so,继续往下看
Step.2 加上生成注释的代码
安装之后会在App_Start文件夹中多了SwaggerConfig.cs类,该类中的Register()方法会在应用程序启动的时候调用
里面好多注释,绿绿的,还是选择原谅他,删掉吧,删掉后就这剩下这些

 1 public static void Register()
 2 {
 3   var thisAssembly = typeof(SwaggerConfig).Assembly;
 4 
 5   GlobalConfiguration.Configuration
 6   .EnableSwagger(c =>
 7   {
 8     c.SingleApiVersion("v1", "WebApplication1");
 9   })
10   .EnableSwaggerUi(c =>
11   {
12 
13   });
14 }

稍微改造一下,附加个注释xml上去

 1 public static void Register()
 2 {
 3     var thisAssembly = typeof(SwaggerConfig).Assembly;
 4 
 5     GlobalConfiguration.Configuration
 6     .EnableSwagger(c =>
 7     {
 8         c.SingleApiVersion("v1", "WebApplication1");
 9         c.IncludeXmlComments(GetXmlCommentsPath());
10     })
11     .EnableSwaggerUi(c =>
12     {    
13 
14     });
15 }
16 private static string GetXmlCommentsPath()
17 {
18     return System.String.Format(@"{0}\bin\WebApplication1.XML", System.AppDomain.CurrentDomain.BaseDirectory);
19 }

Step.3 步骤2所必须的
启用生成xml文档,右击项目文件属性 bulid发布——Output输出(勾选XML文件)

其实swagger他就是依赖于build时生成的这个xml来自动生成注释上页面的
Step.4 完成啦,看看页面

当然,我的追求不止这些,我们来优化优化
首先,我比较喜欢将config都弄进WebApiConfig中就好,看起来比较清晰

 1 public static class WebApiConfig
 2 {
 3     public static void Register(HttpConfiguration config)
 4     {
 5         // Web API configuration and services
 6 
 7         // Web API routes
 8         config.MapHttpAttributeRoutes();
 9 
10         config.Routes.MapHttpRoute(
11             name: "DefaultApi",
12             routeTemplate: "api/{controller}/{id}",
13             defaults: new { id = RouteParameter.Optional }
14         );
15 
16         config.RegistSwagger();//添加这个swagger的Regist
17     }
18     private static void RegistSwagger(this HttpConfiguration config)
19     {
20         config.EnableSwagger("docs/{apiVersion}/swagger", c =>
21         {
22             c.SingleApiVersion("v1", "WebApplication1");
23             c.IncludeXmlComments(GetXmlCommentsPath());
24         })
25         .EnableSwaggerUi(c=> 
26         {
27 
28         });
29     }
30     private static string GetXmlCommentsPath()
31     {
32         return $@"{AppDomain.CurrentDomain.RelativeSearchPath}\WebApplication1.XML";
33     }
34 }

这个swagger的路径也配一下吧,可以自定义一下

 1 private static void RegistSwagger(this HttpConfiguration config)
 2 {
 3     config.EnableSwagger("docs/{apiVersion}/swagger", c =>
 4     {
 5         c.SingleApiVersion("v1", "WebApplication1");
 6         c.IncludeXmlComments(GetXmlCommentsPath());
 7     })
 8     .EnableSwaggerUi("apis/{*assetPath}");//原本进入的地址是/swagger/ui/index 这样就能换地址成/apis/index 
 9 }

这样,我们这基本的配置就可以了,实现预期的效果——自动生成接口文档
这里面的配置应该还很多,等我有空更新哈,先这样
上一篇文章           查看所有文章
加:2017-10-30 23:21:47  更:2017-10-30 23:21:49 
 
  .NET新手区 最新文章
将ZIP文件添加到程序集资源文件然后在运行时
Web服务的调用
.NET创建WebService服务简单的例子
多线程编程学习笔记——任务并行库(三)
序列化和反序列化
Spring学习之路
4种解决json日期格式问题的办法
C#预处理器指令 ,你造吗??? (●'?&
查看C#的dll所依赖.Net版本
页面之间的传值,菜菜的
技术频道: 站长资讯 .NET新手区 ASP.NET C# WinForm Silverlight WCF CLR WPF XNA Visual Studio ASP.NET MVC .NET控件开发 Entity Framework WinRT/Metro Java C++ PHP Delphi Python Ruby C语言 Erlang Go Swift Scala R语言 Verilog 其它语言 架构设计 面向对象 设计模式 领域驱动设计 Html/Css JavaScript jQuery HTML5 SharePoint GIS技术 SAP Oracle ERP Dynamics CRM K2 BPM 信息安全 企业信息化其他 Android开发 iOS开发 Windows Phone Windows Mobile 其他手机开发 敏捷开发 项目与团队管理 软件工程其他 SQL Server Oracle MySQL NoSQL 其它数据库 Windows 7 Windows Server Linux
脚本语言: vbs/VBScript DOS/BAT hta htc python perl 游戏相关 VBA 远程脚本 ColdFusion ruby专题 autoit seraphzone PowerShell linux shell Lua Golang Erlang 其它教程
网站开发: CSS/HTML/Xhtml html5 CSS XML/XSLT Dreamweaver教程 经验交流 开发者乐园 Android开发资料
360图书馆 软件开发资料 文字转语音 购物精选 软件下载 新闻资讯 小游戏 Chinese Culture 股票 三丰软件 开发 中国文化 网文精选 阅读网 看图 日历 万年历 2018年10日历
2018-10-19 9:26:17
多播视频美女直播
↓电视,电影,美女直播,迅雷资源↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT知识库