WEP_V2.1.3/SourceCode/We.Platform/WePlatform.WebApi/SwaggerUi/SwaggerControllerDescProvider.cs

using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Xml;
using IwbZero.ToolCommon.StringModel;
using Swashbuckle.Swagger;
using WePlatform.Configuration;

namespace WePlatform.SwaggerUi
{
    /// <summary>
    /// swagger显示控制器的描述
    /// </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 = $"{rootUrl}_{apiVersion}";
            //只读取一次
            if (!_cache.TryGetValue(cacheKey, out var 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 xDoc = new XmlDocument();
                xDoc.Load(xmlPath);

                // ReSharper disable once PossibleNullReferenceException
                foreach (XmlNode node in xDoc.SelectNodes("//member"))
                {
                    if (node.Attributes != null)
                    {
                        var type = node.Attributes["name"].Value;
                        if (type.StartsWith("T:"))
                        {
                            //控制器
                            var arrPath = type.Split('.');
                            var length = arrPath.Length;
                            var controllerName = arrPath[length - 1];
                            string key = "";
                            var summaryNode = node.SelectSingleNode("summary");
                            if (controllerName.EndsWith("Controller"))
                            {
                                //获取控制器注释
                                int cCount = "Controller".Length;
                                key = controllerName.Remove(controllerName.Length - cCount, cCount);
                            }else if (controllerName.EndsWith("AppService"))
                            {
                                //获取AppService注释
                                int cCount = "AppService".Length;
                                key = controllerName.Remove(controllerName.Length - cCount, cCount);
                            }else if (controllerName.EndsWith("ApplicationService"))
                            {
                                //获取ApplicationService注释
                                int cCount = "ApplicationService".Length;
                                key = controllerName.Remove(controllerName.Length - cCount, cCount);
                            }

                            if (key.IsNotEmpty())
                            {
                                key = $"{IwbConsts.WePlatformServicePrefix}95{key.Substring(0,1).ToLowerInvariant()+key.Substring(1)}";
                                if (summaryNode != null && !string.IsNullOrEmpty(summaryNode.InnerText) && !controllerDescDict.ContainsKey(key))
                                {
                                    controllerDescDict.TryAdd(key, summaryNode.InnerText.Trim());
                                }
                            }
                        }
                    }
                }
            }
            
            return controllerDescDict;
        }
    }
}