如何添加/更改.NET Web API的默認Json消息響應屬性？

Question

使用web API中未經授權的調用的示例，它將提供按此的響應。

1. 有沒有辦法更改默認屬性名稱「消息」像「理」 /「說明」非成功API響應一個名字嗎？

2. 是否可以添加一個新的屬性，如「狀態」？

Answer 1

是隻使用如果你想改變的來自服務器的響應Josn回報結構，你可以創建由asp.net的MVC應用程序中使用follwing代碼新的響應。

// here you can use your own properties which then can be send to client . 
    return Json(new { Status= false ,Description = response.Message }); 

，如果你有在控制器方法，那麼你應該返回JsonResult

如果你正在尋找一個通用的解決方案，那麼請看看這篇文章它可以幫助你。

http://www.devtrends.co.uk/blog/wrapping-asp.net-web-api-responses-for-consistency-and-to-provide-additional-information

Answer 2

它可以用自定義AuthorizeAttribute來完成。

public class CustomAuthorizeAttribute : AuthorizeAttribute 
    { 

     public CustomAuthorizeAttribute() 
     { 

     } 

     public override void OnAuthorization(HttpActionContext actionContext) 
     { 
      try 
      { 
       if (Authorize(actionContext)) 
       { 
        return; 
       } 
       HandleUnauthorizedRequest(actionContext); 
      } 
      catch (Exception) 
      { 
       //create custom response 
       actionContext.Response = actionContext.Request.CreateResponse(
        HttpStatusCode.OK, 
        customresponse 
       ); 
       return; 
      } 

     } 

     protected override void HandleUnauthorizedRequest(HttpActionContext actionContext) 
     { 
      //create custom unauthorized response 

      actionContext.Response = actionContext.Request.CreateResponse(
       HttpStatusCode.OK, 
       customunauthorizedresponse 
      ); 
      return; 
     } 

     private bool Authorize(HttpActionContext actionContext) 
     { 
      //authorization logics 
     } 


    } 

在您的API控制方法

可以使用[CustomAuthorizeAttribute] insted的[Authorize]