CODEWITHSUNDEEP
javascriptjqueryajaxjson
jawns317
jawns317

Reputation: 1746

Javascript: How to tell whether AJAX response is JSON

I've got an AJAX request that expects JSON in response.

But there's a possibility that what gets returns may not be JSON, but rather an HTML error page (unfortunately, with response type 200).

How can I tell whether the response is JSON or not?

(I'm using jQuery, if that helps. But I can't use any plugins.)

Upvotes: 39

Views: 41247

Answers (5)

Chad
Chad

Reputation: 19619

Well, if you are using jQuery and you specify the dataType property of the $.ajax() call to json then jQuery will try to parse the JSON, and if it isn't JSON should call the error() callback.

$.ajax({
    url: '/my/script.ext',
    dataType: 'json',
    success: function(data, textStatus, jqXHR) { /*YAYE!!*/ },
    error: function(jqXHR, textStatus, errorThrown) { /*AWWW... JSON parse error*/ }
});

EDIT

For anyone not using jQuery that lands here, the basic idea is to try and parse it as json and catch the error:

var data = 'some_data';

try {
    data = JSON.parse(data);
} catch(e) {
    //JSON parse error, this is not json (or JSON isn't in your browser)
}

//act here on the the parsed object in `data` (so it was json).

Upvotes: 65

Arnaud Le Blanc
Arnaud Le Blanc

Reputation: 99919

jQuery auto-detects the dataType:

If the response is JSON, a properly behaving application would set the Content-Type to application/json.

So all you have to do, if the server is well-behaving, is to test if the Content-Type header in the response starts with application/json.

By chance, jQuery already does this by itself:

$.get('/foo', function(data, status, xhr, dataType) {
    if ('json' === dataType) {
        // Yay that's JSON !
        // Yay jQuery has already parsed `data` 
    }
});

jQuery detects the dataType and passes it as 4th parameter of the callback function. If the dataType is JSON, it parsed the JSON string and parses the resulting value as first parameter of the callback.

Upvotes: 17

Tarik
Tarik

Reputation: 81801

jQuery parseJSON function can be used for this. It will throw an exception then you can catch it go ahead.

data = '{}';
try {
    json = $.parseJSON(data);
} catch (e) {
    // not json
}

Upvotes: 4

Marc B
Marc B

Reputation: 360862

try {
    jQuery.parseJson(json_string_here);
} catch(e) {
   ... malformed json ...
}

Upvotes: 2

Joe
Joe

Reputation: 82654

Seems like a good use of try catch:

try {
   $.parseJSON(input)
} catch(e) {
   // not valid JSON
}

Upvotes: 5

Related Questions