There are many "standards" for the JSON content type:
application/json
application/x-javascript
text/javascript
text/x-javascript
text/x-json
Which one do I use, and where? I assume security and browser support issues are a factor.
Related: What MIME type if JSON is being returned by a REST API?
On
Of course, the correct MIME media type for JSON is application/json, but it's necessary to realize what type of data is expected in your application.
For example, I use Java Ext GWT and the server response must go as text/html but contains JSON data.
Client side, Ext GWT form listener
uploadForm.getForm().addListener(new FormListenerAdapter()
{
@Override
public void onActionFailed(Form form, int httpStatus, String responseText)
{
MessageBox.alert("Error");
}
@Override
public void onActionComplete(Form form, int httpStatus, String responseText)
{
MessageBox.alert("Success");
}
});
In case of using application/json response type, the browser suggests me to save the file.
Server side source code snippet using Spring MVC
return new AbstractUrlBasedView()
{
@SuppressWarnings("unchecked")
@Override
protected void renderMergedOutputModel(Map model, HttpServletRequest request,
HttpServletResponse response) throws Exception
{
response.setContentType("text/html");
response.getWriter().write(json);
}
};
IANA has registered the official MIME Type for JSON as application/json.
When asked about why not text/json, Crockford seems to have said JSON is not really JavaScript nor text and also IANA was more likely to hand out application/* than text/*.
More resources:
On
If you are using Ubuntu or Debian and you serve .json files through Apache, you might want to serve the files with the correct content type. I am doing this primarily because I want to use the Firefox extension JSONView
The Apache module mod_mime will help to do this easily. However, with Ubuntu you need to edit the file /etc/mime.types and add the line
application/json json
Then restart Apache:
sudo service apache2 restart
Not everything works for content type application/json.
If you are using Ext JS form submit to upload file, be aware that the server response is parsed by the browser to create the document for the <iframe>.
If the server is using JSON to send the return object, then the Content-Type header must be set to text/html in order to tell the browser to insert the text unchanged into the document body.
On
Only when using application/json as the MIME type I have the following (as of November 2011 with the most recent versions of Chrome, Firefox with Firebug):
On
The right content type for JSON is application/json UNLESS you're using JSONP, also known as JSON with Padding, which is actually JavaScript and so the right content type would be application/javascript.
On
There is no doubt that application/json is the best MIME type for a JSON response.
But I had some experience where I had to use application/x-javascript because of some compression issues. My hosting environment is shared hosting with GoDaddy. They do not allow me to change server configurations. I had added the following code to my web.config file for compressing responses.
<httpCompression>
<scheme name="gzip" dll="%Windir%\system32\inetsrv\gzip.dll"/>
<dynamicTypes>
<add mimeType="text/*" enabled="true"/>
<add mimeType="message/*" enabled="true"/>
<add mimeType="application/javascript" enabled="true"/>
<add mimeType="*/*" enabled="false"/>
</dynamicTypes>
<staticTypes>
<add mimeType="text/*" enabled="true"/>
<add mimeType="message/*" enabled="true"/>
<add mimeType="application/javascript" enabled="true"/>
<add mimeType="*/*" enabled="false"/>
</staticTypes>
</httpCompression>
<urlCompression doStaticCompression="true" doDynamicCompression="true"/>
By using this, the .aspx pages was compressed with g-zip but JSON responses were not. I added
<add mimeType="application/json" enabled="true"/>
in the static and dynamic types sections. But this does not compress JSON responses at all.
After that I removed this newly added type and added
<add mimeType="application/x-javascript" enabled="true"/>
in both the static and dynamic types sections, and changed the response type in
.ashx (asynchronous handler) to
application/x-javascript
And now I found that my JSON responses were compressed with g-zip. So I personally recommend to use
application/x-javascript
only if you want to compress your JSON responses on a shared hosting environment. Because in shared hosting, they do not allow you to change IIS configurations.
On
If you're in a client-side environment, investigating about the cross-browser support is mandatory for a well supported web application.
The right HTTP Content-Type would be application/json, as others already highlighted too, but some clients do not handle it very well, that's why jQuery recommends the default text/html.
On
JSON is a domain-specific language (DSL) and a data format independent of JavaScript, and as such has its own MIME type, application/json. Respect for MIME types is of course client driven, so text/plain may do for transfer of bytes, but then you would be pushing up interpretation to the vendor application domain unnecessarily - application/json. Would you transfer XML via text/plain?
But honestly, your choice of MIME type is advice to the client as to how to interpret the data- text/plain or text/HTML (when it's not HTML) is like type erasure- it's as uninformative as making all your objects of type Object in a typed language.
No browser runtime I know of will take a JSON document and automatically make it available to the runtime as a JavaScript accessible object without intervention, but if you are working with a crippled client, that's an entirely different matter. But that's not the whole story- RESTful JSON services often don't have JavaScript runtimes, but it doesn't stop them using JSON as a viable data interchange format. If clients are that crippled... then I would consider perhaps HTML injection via an Ajax templating service instead.
Application/JSON!
On
“application/json” is the correct JSON content type.
def ajaxFindSystems = {
def result = Systems.list()
render(contentType:'application/json') {
results {
result.each{sys->
system(id:sys.id, name:sys.name)
}
}
resultset (rows:result.size())
}
}
Response is dynamically generated data, according to the query parameters passed in the URL.
Example:
{ "Name": "Foo", "Id": 1234, "Rank": 7 }
Content-Type: application/json
JSON with padding. Response is JSON data, with a function call wrapped around it.
Example:
functionCall({"Name": "Foo", "Id": 1234, "Rank": 7});
Content-Type: application/javascript
On
As many others have mentioned, application/json is the correct answer.
But what haven't been explained yet is what the other options you proposed mean.
application/x-javascript: Experimental MIME type for JavaScript before application/javascript was made standard.
text/javascript: Now obsolete. You should use application/javascript when using javascript.
text/x-javascript: Experimental MIME type for the above situation.
text/x-json: Experimental MIME type for JSON before application/json got officially registered.
All in all, whenever you have any doubts about content types, you should check this link
On
The right MIME type is application/json
BUT
I experienced many situations where the browser type or the framework user needed:
text/html
application/javascript
If the JSON is with padding then it will be application/jsonp. If the JSON is without padding then it will be application/json.
To deal with both, it is a good practice to use: 'application/javascript' without bothering whether it is with padding or without padding.
On
In Spring you have a defined type: MediaType.APPLICATION_JSON_VALUE which is equivalent to application/json.
On
The Content-Type header should be set to 'application/json' when posting. Server listening for the request should include "Accept=application/json". In Spring MVC you can do it like this:
@RequestMapping(value="location", method = RequestMethod.POST, headers = "Accept=application/json")
Add headers to the response:
HttpHeaders headers = new HttpHeaders();
headers.add("Content-Type", "application/json");
The IANA registration for application/json says
Applications that use this media type: JSON has been used to exchange data between applications written in all of these programming languages: ActionScript, C, C#, Clojure, ColdFusion, Common Lisp, E, Erlang, Go, Java, JavaScript, Lua, Objective CAML, Perl, PHP, Python, Rebol, Ruby, Scala, and Scheme.
You'll notice that IANA.org doesn't list any of these other media types, in fact even application/javascript is now obsolete. So application/json is really the only possible correct answer.
Browser support is another thing.
The most widely supported non-standard media types are text/json or text/javascript. But some big names even use text/plain.
Even more strange is the Content-Type header sent by Flickr, who returns JSON as text/xml. Google uses text/javascript for some of it's ajax apis.
Examples:
curl -I "https://ajax.googleapis.com/ajax/services/search/video?v=1.0&q=jsonexample"
Output: Content-Type: text/javascript
curl -I "https://www.flickr.com/services/rest/?method=flickr.test.echo&format=json&api_key=f82254c1491d894f1204d8408f645a93"
Output: Content-Type: text/xml
On
PHP developers use this:
<?php
header("Content-type: application/json");
// Do something here...
?>
For JSON, I am using:
Content-Type: application/json
This is described in the IETF's JSON Data Interchange Format 7158 proposal, Section 1.2: Specifications of JSON.
On
The
application/jsonworks great in PHP to store an array or object data.
I use this code to put data in JSON on Google Cloud Storage (GCS) which is set publically viewable:
$context = stream_context_create([
'gs' => [
'acl'=>'public-read',
'Content-Type' => 'application/json',
]
]);
file_put_contents(
"gs://BUCKETNAME/FILENAME.json",
json_encode((object) $array),
false,
$context
);
To get back the data is straight forward:
$data = json_decode(file_get_contents("gs://BUCKETNAME/FILENAME.json"));
Extending the accepted responses, when you are using JSON in a REST context...
There is a strong argument about using application/x-resource+json and application/x-collection+json when you are representing REST resources and collections.
And if you decide to follow the jsonapi specification, you should use of application/vnd.api+json, as it is documented.
Altough there is not an universal standard, it is clear that the added semantic to the resources being transfered justify a more explicit Content-Type than just application/json.
Following this reasoning, other contexts could justify a more specific Content-Type.
On
JSON (JavaScript Object Notation) and JSONP ("JSON with padding") formats seems to be very similar and therefore it might be very confusing which MIME type they should be using. Even though the formats are similar, there are some subtle differences between them.
So whenever in any doubts, I have a very simple approach (which works perfectly fine in most cases), namely, go and check corresponding RFC document.
JSON RFC 4627 (The application/json Media Type for JavaScript Object Notation (JSON)) is a specifications of JSON format. It says in section 6, that the MIME media type for JSON text is
application/json.
JSONP
JSONP ("JSON with padding") is handled different way than JSON, in a browser. JSONP is treated as a regular JavaScript script and therefore it should use application/javascript, the current official MIME type for JavaScript. In many cases, however, text/javascript MIME type will work fine too.
Note that text/javascript has been marked as obsolete by RFC 4329 (Scripting Media Types) document and it is recommended to use application/javascript type instead. However, due to legacy reasons, text/javascript is still widely used and it has cross-browser support (which is not always a case with application/javascript MIME type, especially with older browsers).
On
If you get data from REST API in JSON, you have to use Content-Type:
On
For specifying the interesting JSON result, you add "application/json" in your request header like below:
"Accept:application/json" is a desired response format.
"Content-Type:application/json" specifies the content format of your request, but sometimes you specify both application/json and application/xml, but the quality of these might be different. Which server will send back the different response formats, look at the example:
Accept:application/json;q=0.4,application/xml;q=8
This will return XML, because XML has higher quality.
On
The proper current standard is application/json. While the default encoding is UTF-8, it is worth mentioning that it could also be UTF-16 or UTF-32. When JSON is written in UTF-16 or UTF-32, binary content-transfer-encoding must be used.
There is more information about JSON in RFC 4627: The application/json Media Type for JavaScript Object Notation (JSON)
More information on binary transfer encoding is on 5. The Content-Transfer-Encoding Header Field (RFC 1341).
On
To complement the previous the answers, the MIME type for JSON linked data (JSON-LD) according to W3C is:
application/ld+jsonType name: application
Subtype name: ld+json
Additionally, from the same source:
File extension(s):
.jsonld
On
Content-Type: application/json - JSONContent-Type: application/javascript - JSON-PContent-Type: application/x-javascript - JavaScriptContent-Type: text/javascript - JavaScript but obsolete. Older Internet Explorer versions used to use it for HTML attributes.Content-Type: text/x-javascript - JavaScript Media Types, but obsoleteContent-Type: text/x-json - JSON before application/json got officially registered.
On
As you may have to use these more frequently, always try to remember these three content types even though there are many content types:
On
A part of your question is relevant to me as I just came across it.
A third-party provider is providing a REST service that is used by multiple clients. It's a straight-forward REST called with query parameters that returns a well-formed JSON. I have tested it with PHP and Java where it worked as expected.
My client uses Oracle Service Bus as a gateway between his application server and the Internet. When I made the OSB service, it crashed with an Invalid message format error. Turned out that the content-type being returned was text/html. OSB treats responses as per this header; converting between text, XML and JSON. In this case, the response was JSON but the header didn't say so. Contacting the provider, I got the reply: "We're not going to change it as it doesn't effect anyone else".
The Content-Type header specifies what the content should be, not what it actually is. That is to say, in your consuming program, it's up to you to check or ignore it and process the content in any manner. Another example, you can return GIF data but specify the content type as JSON, then go ahead and ignore the header and read the image data. This won't hurt your program, but may hurt others.
Moral of the story: Play nice.
On
As some research,
The most common MIME type is
application/json
Let's see a example to differentiate with JSON and JavaScript.
It is used when it is not known how this data will be used. When the information is to be just extracted from the server in JSON format, it may be through a link or from any file, in that case, it is used.
For example-
<?php
header('Content-type:application/json');
$directory = [
['Id' => 1, 'Name' => 'this'],
['Id' => 2, 'Name' => 'is'],
['Id' => 3, 'Name' => 'Stack Overflow'],
];
// Showing the JSON data
echo json_encode($directory);
?>
The output is,
[{"Id":1, "Name":"this"}, {"Id":2, "Name":"is"}, {"Id":3, "Name":"Stack Overflow"}]
It is used when the use of the data is predefined. It is used by applications in which there are calls by the client-side Ajax applications. It is used when the data is of type JSON-P or JSONP.
For example
<?php
header('Content-type:application/javascript');
$dir = [
['Id' => 1, 'Name' => 'this' ],
['Id' => 2, 'Name' => 'is'],
['Id' => 3, 'Name' => 'Stack Overflow'],
];
echo "Function_call(" . json_encode($dir) . ");";
?>
The output is,
Function_call([{"Id":1, "Name":"this"}, {"Id":2, "Name":"is"}, {"Id":3, "Name":"Stack Overflow"}])
And for other MIME types, see the full detail in MIME types (IANA media types).
On
It depends on the point of view.
If you are the client sending a request, then application/json is the right choice.
But if you are the server receiving a request, you have to be prepared, that the client may also send the encoding. So application/json and application/json; charset=utf-8 are valid.
The media type is the same in both cases. But the content type differs.
On
The most common MIME type is application/json. Here is a list of all JSON content types:
Content-Type: application/json - JSONContent-Type: text/x-json - JSON before application/json got officially registered.Content-Type: application/javascript - JSON-PContent-Type: application/x-javascript - JavaScriptObsolete Types:
Content-Type: text/javascript - JavaScript but obsolete. Older Internet Explorer versions used to use it for HTML attributes.Content-Type: text/x-javascript - JavaScript Media Types, but obsoleteAdditional References:
RFC4627 - The application/json Media Type for JavaScript Object Notation (JSON)
On
The standard and widely accepted JSON content type to use is:
application/json
You should use it because:
Other are obselete:
The other content types user mentioned (application/x-javascript, text/javascript, text/x-javascript, text/x-json) were used in the past when JSON was not as standardized as it is now. However, using them today is not recommended due to potential security and compatibility issues.
Security Concerns:
Some older browsers may interpret JavaScript content types (application/x-javascript, text/javascript, text/x-javascript) as executable scripts, potentially leading to security vulnerabilities if an attacker injects malicious code.
Serving JSON data with non-standard content types might trigger security mechanisms in certain browsers or web applications.
Browser Support:
Hope it helps.
For JSON text:
For JSONP (runnable JavaScript) with callback:
Here are some blog posts that were mentioned in the relevant comments:
text/htmlfor JSONapplication/json