新建 ASP.NET WebApi 项目碰到的相关问题

一、跨域问题

1、新建一个处理类OptionsMethodModule，如下：

namespace Boiler
{
    public class OptionsMethodModule : IHttpModule
    {
        public OptionsMethodModule()
        {
        }

        public void Dispose()
        {
        }

        public void Init(HttpApplication app)
        {
            app.BeginRequest += new EventHandler(this.BeginRequest);
        }

        public void BeginRequest(object resource, EventArgs e)
        {
            HttpApplication app = resource as HttpApplication;
            HttpContext context = app.Context;
            if (context.Request.HttpMethod.ToUpper() == "OPTIONS")
            {
                context.Response.StatusCode = 200;
                context.Response.End();
            }
        }
    }
}

2、

Webconfig配置

<system.webServer>
　　<modules>
　　　　<add name="OptionsMethodModule" type="你的命名空间.OptionsMethodModule"/>
　　</modules>
　　<httpProtocol>
　　　　<customHeaders>
　　　　　　<add name="Access-Control-Allow-Origin" value="http://localhost:8082" />
　　　　　　<add name="Access-Control-Allow-Credentials" value="true" />
　　　　　　<add name="Access-Control-Allow-Methods" value="OPTIONS,POST,GET,PUT,DELETE" />
　　　　　　<add name="Access-Control-Allow-Headers" value="x-requested-with,content-type,Token" />
　　　　</customHeaders>
　　</httpProtocol>
</system.webServer>

参考文献：

https://www.cnblogs.com/cuiguoliang/articles/11811450.html

二、接口返回的数据是xml格式的数据，期望返回JSON格式。

在程序里的Global文件里的Application_Start()方法里添加下面的代码：

GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();

参考文献：

https://blog.csdn.net/GreyCastle/article/details/90298597

三、无法使用Session的问题。

需要在Global.asax文件中配置一些东西

protected void Application_PostAuthorizeRequest()
{
　　HttpContext.Current.SetSessionStateBehavior(System.Web.SessionState.SessionStateBehavior.Required);
}

参考文献：

https://www.cnblogs.com/LoveAndPeace/p/7092681.html

四、Swagger

项目引用右键“管理NuGet程序包”->

[浏览]->搜索Swashbuckle

安装

 

直接访问网站下的swagger路径，即可：  https://localhost:44367/swagger

五、配置注释

项目右键属性->生成-

项目属性->勾选生成xml文档文件

修改SwaggerConfig文件，注意XML文件名要修改。

    //c.IncludeXmlComments(GetXmlCommentsPath());

    //设置接口描述xml路径地址

    c.IncludeXmlComments(string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory));

 

给接口添加注释，即可看到参数及方法描述了

 

 六、控制器上的注释不会显示(下图红框中的注释是改造以后才有的)

 

要达到上述效果，具体步骤如下：

1.定义一个provider实现ISwaggerProvider接口

 

using Swashbuckle.Swagger;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Web;
using System.Xml;

namespace Boiler
{
    /// <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 = 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");
                            string key = controllerName.Remove(controllerName.Length - cCount, cCount);
                            if (summaryNode != null && !string.IsNullOrEmpty(summaryNode.InnerText) && !controllerDescDict.ContainsKey(key))
                            {
                                controllerDescDict.TryAdd(key, summaryNode.InnerText.Trim());
                            }
                        }
                    }
                }
            }
            return controllerDescDict;
        }
    }
}

2.定义一个JS文件,做成嵌入资源，这个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 () {
        $.ajax({
            type: "get",
            async: true,
            url: $("#input_baseUrl").val(),
            dataType: "json",
            success: function (data) {
                var summaryDict = data.ControllerDesc;
                var id, controllerName, strSummary;
                $("#resources_container .resource").each(function (i, item) {
                    id = $(item).attr("id");
                    if (id) {
                        controllerName = id.substring(9);
                        strSummary = summaryDict[controllerName];
                        if (strSummary) {
                            $(item).children(".heading").children(".options").first().prepend('<li class="controller-summary" title="' + strSummary + '">' + strSummary + '</li>');
                        }
                    }
                });
            }
        });
    },
    _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({
    "server returned": "服务器返回"
});
$(function () {
    window.SwaggerTranslator.translate();
    window.SwaggerTranslator.setControllerSummary();
});

3.修改App_Start中的SwaggerConfig.cs文件，主要代码有两行

c.CustomProvider((defaultProvider) => new SwaggerControllerDescProvider(defaultProvider,xmlFile));

.EnableSwaggerUi(c =>{c.InjectJavaScript(thisAssembly, "Boiler.Scripts.Swagger-Custom.js");});

doc/{*assetPath}会将swagger的访问地址改为doc/index

Boiler.Scripts.Swagger-Custom.js 这是我们在第二步中定义的资源文件，资源文件名的命名规则如下：文件所在项目的命名空间.文件径路.文件名

最终代码如下：

using System.Web.Http;
using WebActivatorEx;
using Nop.Web;
using Swashbuckle.Application;
using System.Linq;
using System.Reflection;
using Nop.Web.App_Start;
using System.Xml.Linq;
using System.Xml.XPath;

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

namespace Nop.Web
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var xmlFile = string.Format("{0}/Plugins/Misc.Client.WebApi/Nop.Plugin.Misc.Client.WebApi.XML", System.AppDomain.CurrentDomain.BaseDirectory);
            GlobalConfiguration.Configuration.EnableSwagger(c =>
            {
                c.CustomProvider((defaultProvider) => new SwaggerControllerDescProvider(defaultProvider, string.Format("{0}/bin/Boiler.xml", System.AppDomain.CurrentDomain.BaseDirectory)));
            })
           .EnableSwaggerUi(c =>
             {
                        c.InjectJavaScript(thisAssembly, "Boiler.Scripts.Swagger-Custom.js");
             });
        }
    }
} 

参考文献：http://t.zoukankan.com/li150dan-p-14035754.html

七、在一个控制器中写多个方法

指定路由：

[HttpGet]
[Route("~/api/GetRightList")]
public GetRightListToJson GetRightList(string Token)

或Post方法：

[HttpPost]
[Route("~/api/AddRight")]
public JsonData AddRight([FromBody] RightData data)