c#中WebApi開發遇到的坑

一、如何新建一個webApi項目

        打開VS→找到解決方案→新建項目→類庫或web應用程序→選擇空的WebApi項目→在Global.asax文件的Application_Start方法中注冊WebApi的相關配置→完成

二、如何對外提供api接口

       在webApi項目的Controllers文件夾下新增一個類繼承ApiController，在該類中就可以完成對外接口（GET、POST、PUT、DELETE等），需要注意的是如果提供的方法需要參數，則參數的類型不能按它實際的類型聲明和傳遞，如Name不能直接聲明為string類型，否則調用該接口時會報404錯誤，找不到該訪問地址。聲明的方式有很多種：

        （1）創建一個類，該類只包含該方法所需的參數。

        （2）引用FormDataCollection類來聲明和接收參數。

        這是常用的聲明方式，推薦方法（2）。下面用例子的形式說明錯誤寫法和正確寫法

        #region 參數聲明示例·錯誤寫法
        [Route("Example")]
        [HttpPost]
        public object Example(string name)
        {
            var response = new ResponseModel
            {
                StatusCode = 200,
                Message = "接收數據成功！",
                Data = name
            };
            return Json(response);
        }
        #endregion

 

        #region 參數聲明示例·正確寫法
        [Route("Example")]
        [HttpPost]
        public object Example(FormDataCollection collection)
        {
            var name = collection.Get("name");
            var response = new ResponseModel
            {
                StatusCode = 200,
                Message = "接收數據成功！",
                Data = name
            };
            return Json(response);
        }
        #endregion

        #region 參數聲明示例·正確寫法
        [Route("Example")]
        [HttpPost]
        public object Example(DataInfo data)
        {
            var response = new ResponseModel
            {
                StatusCode = 200,
                Message = "接收數據成功！",
                Data = data.Name
            };
            return Json(response);
        }
        #endregion

    public class DataInfo
    {
        public string Name { get; set; }
    }

三、自定義票據驗證篩選器

      （1）創建類 AuthorFilter 繼承 AuthorizeAttribute 

using System;
using System.Configuration;
using System.Web;
using System.Web.Http;
using System.Web.Http.Controllers;
using System.Web.Security;
using Xryang.Core.Config;

namespace Xryang.Api.Author
{
    public class AuthorFilter : AuthorizeAttribute
    {
        public override void OnAuthorization(HttpActionContext actionContext)
        {
            #region 驗證token → 請求數據
            var content = actionContext.Request.Properties["MS_HttpContext"] as HttpContextBase;
            var token = content.Request.Headers["Secret"];
            if (!string.IsNullOrEmpty(token))
            {
                //驗證token
                if (ValidateTicket(token))
                {
                    base.IsAuthorized(actionContext);
                }
                else
                {
                    HandleUnauthorizedRequest(actionContext);
                }
                return;
            }
            #endregion

            #region 請求token
            var appId = content.Request.Headers["AppId"];
            if (!string.IsNullOrEmpty(appId))
            {
                //驗證AppId
                if (IsAllowAppId(appId))
                {
                    base.IsAuthorized(actionContext);
                }
                else
                {
                    HandleUnauthorizedRequest(actionContext);
                }
                return;
            }
            #endregion

            #region 非法請求
            HandleUnauthorizedRequest(actionContext);
            #endregion
        }

        #region 驗證Token
        //校驗票據（數據庫數據匹配）
        private bool ValidateTicket(string token)
        {
            bool flag = false;
            try
            {
                //解密Token
                var ticket = FormsAuthentication.Decrypt(token).UserData;
                if (ticket.Equals("token示例"))
                    flag = true;
            }
            catch (Exception ex)
            {

            }
            return flag;
        }
        #endregion

        #region 驗證AppId
        private bool IsAllowAppId(string appId)
        {
            var config = ConfigurationManager.GetSection("XryangConfig") as XryangConfig;
            if (string.IsNullOrEmpty(appId) || string.IsNullOrEmpty(config.AppId)) return false;
            if (appId.Equals(config.AppId)) return true;
            return false;
        }
        #endregion
    }
}

     （2）在api控制器或方法上加上  [AuthorFilter] 即可

using System;
using System.Net.Http.Formatting;
using System.Web.Http;
using System.Web.Security;
using Xryang.Api.Author;
using Xryang.Model.Commons;

namespace Xryang.Api.Controllers
{
    [AuthorFilter]
    [RoutePrefix("Api/App")]
    public class AppController : ApiController
    {

        #region 獲取token
        [Route("Token")]
        [HttpPost]
        public object Token()
        {
            var response = new ResponseModel
            {
                StatusCode = 500,
                Message = "很抱歉，系統出錯了",
            };
            FormsAuthenticationTicket ticket = new FormsAuthenticationTicket(0, "token示例", DateTime.Now,
                            DateTime.Now.AddHours(1), true,  "token示例",
                            FormsAuthentication.FormsCookiePath);
            if (ticket != null)
            {
                var token = FormsAuthentication.Encrypt(ticket);
                response.StatusCode = 200;
                response.Message = "獲取成功";
                response.Data = new { Secret = token };
            }
            return Json(response);
        }
        #endregion

        #region 參數聲明示例·正確寫法
        [Route("Example")]
        [HttpPost]
        public object Example(FormDataCollection data)
        {
            var response = new ResponseModel
            {
                StatusCode = 200,
                Message = "接收數據成功！",
                Data = data.Get("Name")
            };
            return Json(response);
        }
        #endregion
    }
}