如何添加/更改.NET Web API的默认Json消息响应属性？

Question

Using the example of an unauthorized call in web API, it will provide a response as per this.

1. Is there a way to change the default property name "Message" to another name like "Reason"/"Description" for non-success API responses?

2. Is it possible to add a new property like "Status"?

Answer 1

Yes just use If you want to change the structure of the Josn response return from the server you can create new response by using follwing code in asp.net mvc app .

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

if you have the controller method then you should return JsonResult

If you are looking for a generic solution then please have a look at this article it might help you .

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

Answer 2

It can be done with a custom 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
        }


    }

in your api controller method you can use [CustomAuthorizeAttribute] insted of [Authorize]