Return JSON as default from and UmbracoApiController

So you'd like to stop the UmbracoApiController from returning XML and instead always return JSON, but you don't want to be doing some hacky workaround every time or modify the global applications settings?

I've made this attribute to be the answer to that question, apply it to any Api Controller and it'll remove the XmlFormatter for you.

Use this code to create attribute:

using System;
using System.Linq;
using System.Net.Http.Formatting;
using System.Web.Http.Controllers;

/// 
/// Applying this attribute to any Umbraco API Controller will ensure that it does not contain an xml formatter.
/// 
public class JsonOnlyConfigurationAttribute : Attribute, IControllerConfiguration
{
    public virtual void Initialize(HttpControllerSettings controllerSettings, HttpControllerDescriptor controllerDescriptor)
    {
        var toRemove = controllerSettings.Formatters.Where(x => x is XmlMediaTypeFormatter).ToList();

        // Remove all xml formatters
        foreach (var y in toRemove)
        {
            controllerSettings.Formatters.Remove(y);
        }
    }
}

The apply it to your controller like this:

[JsonOnlyConfiguration]
public class MyController : UmbracoApiController
{
...
}

You're done, the controller will now return json by default.


Published at

Tags: Umbraco,Api,JSON,C#

Luke Alderton

Comments

Post a comment
Sit tight...
We're adding your comment.
Thank you.
Your comment has been added.
There's been a problem.
Please try again later.
Share with
Tags
Latest Comments
By Nick on Raspberry Pi - Running Java app on Raspbian
14 Oct 2020, 19:37 PM
By Ivan on Fixed: Value cannot be null Parameter Name: source
15 Sep 2020, 19:47 PM
By Anand on Raspberry Pi - Bluetooth using Bluecove on Raspbian
7 Sep 2020, 16:53 PM
By Aquif on Xamarin Forms - Working with threads
9 Jul 2020, 13:50 PM
By Chris on Disabling XAML Hot Reload
10 Jun 2020, 15:23 PM
By Ben on Raspberry Pi - Running Java app on Raspbian
24 May 2020, 09:01 AM
By BP on Disabling XAML Hot Reload
14 May 2020, 21:59 PM
By Andy on Xamarin Forms - Working with threads
12 May 2020, 09:16 AM
Categories
App Development
Event
Game Development
Mapping
Modelling
Programming
Review
Robotics
Tutorial
Web Development