.NET WebAPI 嵌入Swagger

使用Nuget搜索Swagger

1、下载Swagger插件

2、创建项目XML注释文档

3、添加一个转换工具类

4、修改SwaggerConfig.cs 文件

5、新建一个JS文件

6、运行结果

========================================================================================================

1、下载Swagger插件

2、创建项目XML注释文档

右键项目→属性→生成→选中下方的 "XML文档文件" 然后保存

3、添加一个转换工具类

SwaggerControllerDescProvider 继承 ISwaggerProvider 接口，并重新实现接口。

该类完整代码

    /// <summary>
    /// 文档转换工具
    /// </summary>
    public class SwaggerControllerDescProvider : ISwaggerProvider
    {
        private readonly ISwaggerProvider _swaggerProvider;
        private static ConcurrentDictionary<string, SwaggerDocument> _cache = new ConcurrentDictionary<string, SwaggerDocument>();
        private readonly string _xml;

        /// <summary>
        /// 
        /// </summary>
        /// <param name="swaggerProvider"></param>
        /// <param name="xml">xml文档路径</param>
        public SwaggerControllerDescProvider(ISwaggerProvider swaggerProvider, string xml)
        {
            _swaggerProvider = swaggerProvider;
            _xml = xml;
        }

        public SwaggerDocument GetSwagger(string rootUrl, string apiVersion)
        {

            var cacheKey = string.Format("{0}_{1}", rootUrl, apiVersion);
            SwaggerDocument srcDoc = null;
            //只读取一次
            if (!_cache.TryGetValue(cacheKey, out srcDoc))
            {
                srcDoc = _swaggerProvider.GetSwagger(rootUrl, apiVersion);

                srcDoc.vendorExtensions = new Dictionary<string, object> { { "ControllerDesc", GetControllerDesc() } };
                _cache.TryAdd(cacheKey, srcDoc);
            }
            return srcDoc;
        }

        /// <summary>
        /// 从API文档中读取控制器描述
        /// </summary>
        /// <returns>所有控制器描述</returns>
        public ConcurrentDictionary<string, string> GetControllerDesc()
        {
            string xmlpath = _xml;
            ConcurrentDictionary<string, string> controllerDescDict = new ConcurrentDictionary<string, string>();
            if (File.Exists(xmlpath))
            {
                XmlDocument xmldoc = new XmlDocument();
                xmldoc.Load(xmlpath);
                string type = string.Empty, path = string.Empty, controllerName = string.Empty;

                string[] arrPath;
                int length = -1, cCount = "Controller".Length;
                XmlNode summaryNode = null;
                foreach (XmlNode node in xmldoc.SelectNodes("//member"))
                {
                    type = node.Attributes["name"].Value;
                    if (type.StartsWith("T:"))
                    {
                        //控制器
                        arrPath = type.Split('.');
                        length = arrPath.Length;
                        controllerName = arrPath[length - 1];
                        if (controllerName.EndsWith("Controller"))
                        {
                            //获取控制器注释
                            summaryNode = node.SelectSingleNode("summary");
                            // 前端会把 下划线 转译为 95
                            string key = controllerName.Remove(controllerName.Length - cCount, cCount).Replace("_", "95");
                            if (summaryNode != null && !string.IsNullOrEmpty(summaryNode.InnerText) && !controllerDescDict.ContainsKey(key))
                            {
                                controllerDescDict.TryAdd(key, summaryNode.InnerText?.Replace("\r\n", " ").Trim());
                            }
                        }
                    }
                }
            }
            return controllerDescDict;
        }
    }

4、修改SwaggerConfig.cs 文件

在App_Start文件夹下会自动生成 SwaaggerConfig.cs文件。将原来的 GlobalConfiguration.Configuration.EnableSwagger 注释掉。

替换成以下代码

 GlobalConfiguration.Configuration.EnableSwagger(c =>
            {
                 c.SingleApiVersion("v2", "NetApiSwagger");// 添加方法和实体注释bin\NetApiSwagger.xml
                {
                    var path = $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\NetApiSwagger.xml";
                    if (File.Exists(path)) c.IncludeXmlComments(path);
                }
                {
                    var path = $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\NetApiSwagger.xml";
                    if (File.Exists(path)) c.IncludeXmlComments(path);
                }
                {
                    var path = $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\JWT.xml";
                    if (File.Exists(path)) c.IncludeXmlComments(path);
                }

                // 添加控制器注释
                var xmlFile = $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\NetApiSwagger.xml";
                c.CustomProvider((defaultProvider) => new SwaggerControllerDescProvider(defaultProvider, xmlFile));
            })
            .EnableSwaggerUi(c =>
            {
                // 添加控制器注释: 项目名+路径+文件名，当前为项目根目录
                c.InjectJavaScript(thisAssembly, "NetApiSwagger.swagger.js");
            });

c.SingleApiVersion("v1", "点内特之思哇葛");定义版本号与文档的名称。

版本号这里不知道是不是我哪里弄错的原因，v1 v2这样整数的就可以，试过v1.0也不行，按理来说是应该要可以的，但是这问题没有深究，知道的可以留言说一下。

4.2、在Swagger里面需要加入请求头（Token）验证

如果在Swagger里面需要加入请求头（Token）验证时需要添加一个HttpAuthHeaderFilter 类，继承并实现 IOperationFilter 接口

其中 name = "token" 中的这个Token是根据你后端验证时用的参数名称，如果用Key这里就要 name = "key" 。主要根据后端的规则来定。

    public class HttpAuthHeaderFilter : IOperationFilter
    {
        public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
        {
            if(operation.parameters == null)
            {
                operation.parameters = new List<Parameter>();            
            }
            var filertpl = apiDescription.ActionDescriptor.GetFilterPipeline();
            operation.parameters.Add(new Parameter { name = "token", @in = "header", description = "身份认证", required = false, type = "string" });
        }
    }

然后在SwaaggerConfig 中加入: c.OperationFilter<HttpAuthHeaderFilter>();

加入请求头后效果如下：

5、新建一个JS文件

添加swagger.js 文件，这个文件使用汉化文档的

'use strict';
window.SwaggerTranslator = {
    _words: [],

    translate: function () {
        var $this = this;
        $('[data-sw-translate]').each(function () {
            $(this).html($this._tryTranslate($(this).html()));
            $(this).val($this._tryTranslate($(this).val()));
            $(this).attr('title', $this._tryTranslate($(this).attr('title')));
        });
    },

    setControllerSummary: function () {

        try {
            console.log($("#input_baseUrl").val());
            $.ajax({
                type: "get",
                async: true,
                url: $("#input_baseUrl").val(),
                dataType: "json",
                success: function (data) {

                    var summaryDict = data.ControllerDesc;
                    console.log(summaryDict);
                    var id, controllerName, strSummary;
                    $("#resources_container .resource").each(function (i, item) {
                        id = $(item).attr("id");
                        if (id) {
                            controllerName = id.substring(9);
                            try {
                                strSummary = summaryDict[controllerName];
                                if (strSummary) {
                                    $(item).children(".heading").children(".options").first().prepend('<li class="controller-summary" style="color:green;" title="' + strSummary + '">' + strSummary + '</li>');
                                }
                            } catch (e) {
                                console.log(e);
                            }
                        }
                    });
                }
            });
        } catch (e) {
            console.log(e);
        }
    },
    _tryTranslate: function (word) {
        return this._words[$.trim(word)] !== undefined ? this._words[$.trim(word)] : word;
    },

    learn: function (wordsMap) {
        this._words = wordsMap;
    }
};


/* jshint quotmark: double */
window.SwaggerTranslator.learn({
    "Warning: Deprecated": "警告：已过时",
    "Implementation Notes": "实现备注",
    "Response Class": "响应类",
    "Status": "状态",
    "Parameters": "参数",
    "Parameter": "参数",
    "Value": "值",
    "Description": "描述",
    "Parameter Type": "参数类型",
    "Data Type": "数据类型",
    "Response Messages": "响应消息",
    "HTTP Status Code": "HTTP状态码",
    "Reason": "原因",
    "Response Model": "响应模型",
    "Request URL": "请求URL",
    "Response Body": "响应体",
    "Response Code": "响应码",
    "Response Headers": "响应头",
    "Hide Response": "隐藏响应",
    "Headers": "头",
    "Try it out!": "试一下！",
    "Show/Hide": "显示/隐藏",
    "List Operations": "显示操作",
    "Expand Operations": "展开操作",
    "Raw": "原始",
    "can't parse JSON.  Raw result": "无法解析JSON. 原始结果",
    "Model Schema": "模型架构",
    "Model": "模型",
    "apply": "应用",
    "Username": "用户名",
    "Password": "密码",
    "Terms of service": "服务条款",
    "Created by": "创建者",
    "See more at": "查看更多：",
    "Contact the developer": "联系开发者",
    "api version": "api版本",
    "Response Content Type": "响应Content Type",
    "fetching resource": "正在获取资源",
    "fetching resource list": "正在获取资源列表",
    "Explore": "浏览",
    "Show Swagger Petstore Example Apis": "显示 Swagger Petstore 示例 Apis",
    "Can't read from server.  It may not have the appropriate access-control-origin settings.": "无法从服务器读取。可能没有正确设置access-control-origin。",
    "Please specify the protocol for": "请指定协议：",
    "Can't read swagger JSON from": "无法读取swagger JSON于",
    "Finished Loading Resource Information. Rendering Swagger UI": "已加载资源信息。正在渲染Swagger UI",
    "Unable to read api": "无法读取api",
    "from path": "从路径",
    "server returned": "服务器返回"
});
$(function () {
    window.SwaggerTranslator.translate();
    window.SwaggerTranslator.setControllerSummary();
});