ASP.NET MVC: How to create an action filter to output JSON?

Question

My second day with ASP.NET MVC and my first request for code on SO (yep, taking a short cut).

I am looking for a way to create a filter that intercepts the current output from an Action and instead outputs JSON (I know of alternate approaches but this is to help me understand filters). I want to ignore any views associated with the action and just grab the ViewData["Output"], convert it to JSON and send it out the client. Blanks to fill:

TestController.cs:

[JSON]
public ActionResult Index()
{
    ViewData["Output"] = "This is my output";
    return View();
}

JSONFilter.cs:

public override void OnActionExecuting(ActionExecutingContext filterContext)
{
   /*
    * 1. How to override the View template and set it to null?
    * ViewResult { ViewName = "" } does not skip the view (/Test/Index)
    * 
    * 2. Get existing ViewData, convert to JSON and return with appropriate
    * custom headers
    */
}

Update: Community answers led to a fuller implementation for a filter for JSON/POX.

score 4 · Accepted Answer · edited Feb 08 '18 at 23:14

4

I would suggest that what you really want to do is use the Model rather than arbitrary ViewData elements and override OnActionExecuted rather than OnActionExecuting. That way you simply replace the result with your JsonResult before it gets executed and thus rendered to the browser.

public class JSONAttribute : ActionFilterAttribute
{
   ...

    public override void OnActionExecuted( ActionExecutedContext filterContext)
    {
        var result = new JsonResult();
        result.Data = ((ViewResult)filterContext.Result).Model;
        filterContext.Result = result;
    }

    ...
}

[JSON]public ActionResult Index()
{
    ViewData.Model = "This is my output";
    return View();
}

edited Feb 08 '18 at 23:14

jpaugh

6,634
4
38
90

answered Mar 26 '09 at 18:03

tvanfosson

524,688
99
697
795

Thanks. 1 line needs to be corrected to ((ViewResultBase)filterContext.Result)).ViewData.Model. However, the Index() action still shows the view associated with it (Views/Test/Index) instead of showing the JSON blob even though filterContext.Result has correct value. – aleemb Mar 26 '09 at 20:09
Doing this in OnActionExecuted overrides the view and achieves what I was after. – aleemb Mar 27 '09 at 07:26
Hmmm. I would have thought that replacing the result just before it was rendered would have been the proper time. I'll update my answer. – tvanfosson Mar 27 '09 at 10:38

score 3 · Answer 2 · answered Mar 26 '09 at 18:35

3

You haven't mentioned only returning the JSON conditionally, so if you want the action to return JSON every time, why not use:

public JsonResult Index()
{
    var model = new{ foo = "bar" };
    return Json(model);
}

answered Mar 26 '09 at 18:35

Troy

1,640
10
16

The [JSON] attribute is being used to turn JSON on or off on certain actions but this is more of an exercise as I mentioned. In an actual implementation I would probably inspect the request http headers to determine response type. – aleemb Mar 26 '09 at 20:53

score 0 · Answer 3 · edited May 23 '17 at 11:48

0

maybe this post could help you the right way. The above post is also a method

edited May 23 '17 at 11:48

Community

1
1

answered Mar 26 '09 at 18:34

JSC

3,705
3
26
25

ASP.NET MVC: How to create an action filter to output JSON?

3 Answers3

Linked