什么还要写这类文章？因为我看过网上很多讲解的都不够全面，而本文结合实际工作讲解了swaggerui文档，统一响应格式，异常处理，权限验证等常用模块，并提供一套完善的案例源代码，在实际工作中可直接参考使用。 一、先看看最终效果 这是最后生成的swagerui文档，大家可以直接访问这个地址体验： http://sapi.daimali.com/swagger/ui/index (若无法访问，请公众号CodeL联系) git源码地址：https://gitee.com/daimali/WebApiDemo （推荐直接看源码） 文档效果图： 响应的内容： 注意看红色部分，所有的响应内容都将自动封装成如下格式：由code，msg，data三部分组成 复制代码 { "code": 200, "msg": "OK", "data": { "List": [ { "OrderId": 1001, "UserName": "绿巨人", "OrderDate": "2018-11-18T09:39:36.0404502+08:00" }, { "OrderId": 1002, "UserName": "钢铁侠", "OrderDate": "2018-11-17T09:39:36.0404502+08:00" } ], "total": 20 } } 复制代码 实现以上API的整体思路是： 1. 使用SwaggerUI自动生成接口文档、便于团队协作，减少工作量 2. 通过ActionFilter实现权限控制与响应格式的统一封装 3. 通过ExceptionFilter实现异常的统一处理 我觉得大部分人阅读到这里就可以了，剩下的时间去看看源码，需要用的时候边用边学就好了 二、接口文档 - SwaggerUI注意点 1. swagger汉化，注意swagger_lang.js 属性生成操作需要选择"嵌入的资源" 2. 项目右键-属性-生成：输出项勾选XML文档文件 三、统一响应格式说明 通过 ApiResultFilterAttribute 类实现响应参数的统一封装：ApiResultFilterAttribute继承自ActionFilterAttribute 这里封装的响应格式由如下三部分组成： code：跟随HttpCode，msg：返回的描述信息， data：接口返回的业务数据统一放在data中 复制代码 { "code": 200, "msg": "OK", "data": null } 复制代码 复制代码 ///

/// 响应数据 ///

/// 自定义响应的内容 public class ResponseApi { ///

/// 错误代码 ///

public int code { get; set; } ///

/// 错误信息 ///

public string msg { get; set; } ///

/// 响应数据 ///

public T data { get; set; } } 复制代码 通过actionfilter统一封装： ApiResultFilterAttribute.cs 四、自定义异常信息 针对于所有的异常信息，接口也会返回对应的code，msg，data的格式： 通过CustomException和CustomExceptionFilterAttribute实现: CustomExceptionFilterAttribute.cs 看源码 需要说的东西太多，直接看源码更方便： 接口预览地址：http://sapi.daimali.com/swagger/ui/index (若无法访问，请公众号联系) git源码地址：https://gitee.com/daimali/WebApiDemo 继续看详细步骤： 1. 新建空ASP.NET MVC空应用程序，选择WebApi 2. Nuget引用Swashbuckle.Core （demo目前用的v5.6.0最新稳定版） 3. 将App_Start中的类复制到你的新项目中，然后更改命名空间为你自己项目 4. 按需调整SwaggerConfig.cs 配置 5. 将Scripts文件复制到你的项目中，同时设置 swagger_lang.js 文件 属性- 生成操作为"嵌入的资源"，按需调整 swagger_lang.js文件内容 6. 注意你的WebApiConfig中需要添加 ApiResultFilterAttribute 和 CustomExceptionFilterAttribute 7. 项目右键-属性-生成：输出项勾选XML文档文件 此时，你新建的webapi控制器已经支持swagger，并且会统一封装成code，msg，data的格式了 评论区已知问题（待解决，后续将持续更新Demo，感兴趣的同学多多关注）： 1. 解决swagger 文件上传问题 相关资源获取或其他疑问可在公众号CodeL留言。 https://www.cnblogs.com/codelir/p/9977667.html