WebApi生成在线API文档--Swagger

1.前言

1.1 SwaggerUI

SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用（官方demo）。经过读取JSON 配置显示API. 项目自己仅仅也只依赖一些 html,css.js静态文件. 你能够几乎放在任何Web容器上使用。

1.2 Swashbuckle

Swashbuckle 是.NET类库,能够将WebAPI全部开放的控制器方法生成对应SwaggerUI的JSON配置。再经过SwaggerUI 显示出来。类库中已经包含SwaggerUI 。因此不须要额外安装。

2.快速开始

• 建立项目 OnlineAPI来封装百度音乐服务(示例下载) ，经过API能够搜索、获取音乐的信息和播放链接。

我尽可能删除一些咱们demo中不会用到的一些文件，使其看上去比较简洁。

• WebAPI 安装 Swashbuckle

  Install-Package Swashbuckle

• 代码注释生成文档说明。
  Swashbuckle 是经过生成的XML文件来读取注释的，生成 SwaggerUI，JSON 配置中的说明的。
  安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件，用于配置 SwaggerUI 相关展现行为的。如图：

• 将配置文件大概99行注释去掉并修改成

c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

• 并在当前类中添加一个方法

  /// <summary> /// </summary> /// <param name="name"></param> /// <returns></returns> protected static string GetXmlCommentsPath(string name) { return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name); }

• 紧接着你在此Web项目属性生成选卡中勾选 “XML 文档文件”，编译过程当中生成类库的注释文件

• 添加百度音乐 3个API

• 访问 http://<youhost>/swagger/ui/index,最终显示效果

• 咱们经过API 测试API 是否成功运行

3.添加自定义HTTP Header

在开发移动端 API时经常须要验证权限，验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限便可

首先咱们须要建立一个 IOperationFilter 接口的类。IOperationFilter

using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Http; using System.Web.Http.Description; using System.Web.Http.Filters; using Swashbuckle.Swagger; namespace OnlineAPI.Utility { public class HttpHeaderFilter : IOperationFilter { public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription) { if (operation.parameters == null) operation.parameters = new List<Parameter>(); var filterPipeline = apiDescription.ActionDescriptor.GetFilterPipeline(); //判断是否添加权限过滤器 var isAuthorized = filterPipeline.Select(filterInfo => filterInfo.Instance).Any(filter => filter is IAuthorizationFilter); //判断是否容许匿名方法 var allowAnonymous = apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any(); if (isAuthorized && !allowAnonymous) { operation.parameters.Add(new Parameter { name = "access-key", @in = "header", description = "用户访问Key", required = false, type = "string" }); } } } }

在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码

c.OperationFilter<HttpHeaderFilter>();

添加Web权限过滤器

using System; using System.Collections.Generic; using System.Linq; using System.Net; using System.Net.Http; using System.Text; using System.Web; using System.Web.Http; using System.Web.Http.Controllers; using Newtonsoft.Json; namespace OnlineAPI.Utility { /// <summary> /// /// </summary> public class AccessKeyAttribute : AuthorizeAttribute { /// <summary> /// 权限验证 /// </summary> /// <param name="actionContext"></param> /// <returns></returns> protected override bool IsAuthorized(HttpActionContext actionContext) { var request = actionContext.Request; if (request.Headers.Contains("access-key")) { var accessKey = request.Headers.GetValues("access-key").SingleOrDefault(); //TODO 验证Key return accessKey == "123456789"; } return false; } /// <summary> /// 处理未受权的请求 /// </summary> /// <param name="actionContext"></param> protected override void HandleUnauthorizedRequest(HttpActionContext actionContext) { var content = JsonConvert.SerializeObject(new {State = HttpStatusCode.Unauthorized}); actionContext.Response = new HttpResponseMessage { Content = new StringContent(content, Encoding.UTF8, "application/json"), StatusCode = HttpStatusCode.Unauthorized }; } } }

在你想要的ApiController 或者是 Action 添加过滤器

[AccessKey]

最终显示效果

4.显示上传文件参数

SwaggerUI 有上传文件的功能和添加自定义HTTP Header 作法相似，只是咱们经过特殊的设置来标示API具备上传文件的功能

using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Http.Description; using Swashbuckle.Swagger; namespace OnlineAPI.Utility { /// <summary> /// /// </summary> public class UploadFilter : IOperationFilter { /// <summary> /// 文件上传 /// </summary> /// <param name="operation"></param> /// <param name="schemaRegistry"></param> /// <param name="apiDescription"></param> public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription) { if (!string.IsNullOrWhiteSpace(operation.summary) && operation.summary.Contains("upload")) { operation.consumes.Add("application/form-data"); operation.parameters.Add(new Parameter { name = "file", @in = "formData", required = true, type = "file" }); } } } }

在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码

c.OperationFilter<UploadFilter>();

API 文档展现效果

5.版本和资源

你能够经过下列链接获取相关说明。
Swashbuckle 项目地址：
https://github.com/domaindrivendev/Swashbuckle
swagger-ui 项目地址：
https://github.com/swagger-api/swagger-ui
swagger-ui 官网地址：
http://swagger.io/swagger-ui/

 

转至 ：如何使 WebAPI 自动生成漂亮又实用在线API文档