Quel est le type de contenu JSON correct?

Je joue avec JSON depuis un certain temps, je l'ai simplement mis sous forme de texte et cela n'a fait de mal à personne (à ma connaissance), mais j'aimerais commencer à faire les choses correctement.

J'ai vu tant de prétendues «normes» pour le type de contenu JSON:

application/json
application/x-javascript
text/javascript
text/x-javascript
text/x-json

Mais lequel est correct, ou le meilleur? Je suppose qu'il existe des problèmes de sécurité et de prise en charge du navigateur variant entre eux.

Je sais qu'il y a une question similaire, quel type MIME si JSON est retourné par une API REST? , mais j'aimerais une réponse un peu plus ciblée.

Pour le texte JSON:

application/json

Le type de média MIME pour le texte JSON est application/json. L'encodage par défaut est UTF-8. (Source: RFC 4627 ).

Pour JSONP (javascript exécutable ) avec rappel:

application/javascript

Voici quelques articles de blog mentionnés dans les commentaires qui sont pertinents.

• Pourquoi vous ne devriez pas utiliser text/htmlpour JSON
• Internet Explorer a parfois des problèmes avec application/json
• Une liste assez complète des Mimetypes et à quoi les utiliser
• La liste officielle des types de mimes à l'IANA à partir de la réponse de @ gnrfan ci-dessous

L'IANA a enregistré le type MIME officiel pour JSON en tant que application/json.

Lorsqu'on lui a demandé pourquoi text/json, Crockford semble avoir dit que JSON n'est pas vraiment du JavaScript ni du texte et que l'IANA était plus susceptible de distribuer application/*que text/*.

Davantage de ressources:

• Types de supports
• Demande de commentaires 4627
• bluesmoon: JSON a un type

Pour JSON:

Content-Type: application/json

Pour JSON-P :

Content-Type: application/javascript

Bien sûr, le type de média MIME correct pour JSON est application/json, mais il est nécessaire de savoir quel type de données est attendu dans votre application.

Par exemple, j'utilise Ext GWT et la réponse du serveur doit aller en tant que texte / html mais contient des données JSON.

Côté client, écouteur de formulaire Ext GWT

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");
    }
});

En cas d'utilisation du type de réponse application / json , le navigateur me propose de sauvegarder le fichier.

Extrait de code source côté serveur utilisant 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);
    }
};

JSON:

La réponse est des données générées dynamiquement, en fonction des paramètres de requête transmis dans l'URL.

Exemple:

{ "Name": "Foo", "Id": 1234, "Rank": 7 }

Type de contenu: application/json

JSON-P:

JSON avec rembourrage. La réponse est des données JSON, avec un appel de fonction enroulé autour.

Exemple:

functionCall({"Name": "Foo", "Id": 1234, "Rank": 7});

Type de contenu: application/javascript

Si vous utilisez Ubuntu ou Debian et que vous servez des fichiers .json via Apache, vous souhaiterez peut-être servir les fichiers avec le type de contenu correct. Je le fais principalement parce que je veux utiliser l'extension Firefox JSONView

Le module Apache mod_mime vous aidera à le faire facilement. Cependant, avec Ubuntu, vous devez modifier le fichier /etc/mime.types et ajouter la ligne

application/json json

Redémarrez ensuite Apache:

sudo service apache2 restart

Si vous appelez les services Web ASP.NET du côté client, vous devez l'utiliser application/jsonpour que cela fonctionne. Je pense que c'est la même chose pour les frameworks jQuery et Ext .

Le bon type de contenu pour JSON est À application/jsonMOINS QUE vous n'utilisiez JSONP , également connu sous le nom de JSON avec remplissage, qui est en fait JavaScript et donc le bon type de contenu serait application/javascript.

Il ne fait aucun doute que application/jsonc'est le meilleur type MIME pour une réponse JSON.

Mais j'avais une certaine expérience où je devais utiliser à application/x-javascriptcause de certains problèmes de compression. Mon environnement d'hébergement est l'hébergement partagé avec GoDaddy . Ils ne me permettent pas de modifier les configurations de serveur. J'avais ajouté le code suivant à mon web.configfichier pour compresser les réponses.

<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"/>

En utilisant cela, les pages .aspx ont été compressées avec g-zip, mais pas les réponses JSON. J'ai ajouté

<add mimeType="application/json" enabled="true"/>

dans les sections types statique et dynamique. Mais cela ne compresse pas du tout les réponses JSON.

Après cela, j'ai supprimé ce type nouvellement ajouté et ajouté

<add mimeType="application/x-javascript" enabled="true"/>

dans les sections des types statiques et dynamiques et a changé le type de réponse dans

.ashx (gestionnaire asynchrone) vers

application/x-javascript

Et maintenant, j'ai trouvé que mes réponses JSON étaient compressées avec g-zip. Je recommande donc personnellement d'utiliser

application/x-javascript

uniquement si vous souhaitez compresser vos réponses JSON sur un environnement d'hébergement partagé . Parce que dans l'hébergement partagé, ils ne vous permettent pas de modifier les configurations IIS .

Seulement lors de l' utilisation en application/jsontant que MIME type I donne les résultats suivants (en date de Novembre 2011 avec les versions les plus récentes de Chrome, Firefox avec Firebug ):

• Plus d'avertissements de Chrome lorsque le JSON est chargé à partir du serveur.
• Firebug ajoutera un onglet à la réponse vous montrant les données JSON formatées. Si le type MIME est différent, il apparaîtra simplement comme «Contenu de réponse».

Tout ne fonctionne pas pour le type de contenu application/json.

Si vous utilisez le formulaire Ext JS soumettre pour télécharger le fichier, sachez que la réponse du serveur est analysée par le navigateur pour créer le document pour le fichier <iframe>.

Si le serveur utilise JSON pour envoyer l'objet de retour, l'en- Content-Typetête doit être défini sur text/htmlafin de dire au navigateur d'insérer le texte inchangé dans le corps du document.

Voir la documentation de l'API Ext JS 3.4.0 .

JSON est un langage spécifique à domaine (DSL) et un format de données indépendant de JavaScript, et en tant que tel a son propre MIME type application/json. Le respect des types MIME est bien sûr axé sur le client, il text/plainpeut en être de même pour le transfert d'octets, mais alors vous pousseriez inutilement l'interprétation vers le domaine d'application du fournisseur - application/json. Transféreriez-vous XML via text/plain?

Mais honnêtement, votre choix de type MIME est un conseil au client sur la façon d'interpréter les données - text/plainou text/HTML(quand ce n'est pas HTML) est comme l'effacement de type - c'est aussi peu informatif que de faire tous vos objets de type Object dans un langage typé.

Aucun runtime de navigateur que je connais ne prendra un document JSON et le mettra automatiquement à la disposition du runtime en tant qu'objet accessible en JavaScript sans intervention, mais si vous travaillez avec un client handicapé, c'est une tout autre affaire. Mais ce n'est pas toute l'histoire: les services JSON RESTful n'ont souvent pas d'exécution JavaScript, mais cela ne les empêche pas d'utiliser JSON comme format d'échange de données viable. Si les clients sont aussi paralysés ... alors je considérerais peut-être plutôt l' injection HTML via un service de modèle Ajax .

Application / JSON!

Si vous êtes dans un environnement côté client, une enquête sur la prise en charge de plusieurs navigateurs est obligatoire pour une application Web bien prise en charge.

Le bon type de contenu HTTP serait application/json, comme d'autres l'ont déjà souligné, mais certains clients ne le gèrent pas très bien, c'est pourquoi jQuery recommande la valeur par défaut text/html.

La bonne réponse est:

Content-Type: application/json

Comme beaucoup d'autres l'ont mentionné, application/jsonc'est la bonne réponse.

Mais ce qui n'a pas encore été expliqué, c'est ce que signifient les autres options que vous avez proposées.

• application/x-javascript: Le type expérimental MIME pour JavaScript application/javascriptétait devenu standard.

• text/javascript: Désormais obsolète. Vous devez utiliser application/javascriptlorsque vous utilisez javascript.

• text/x-javascript: Type MIME expérimental pour la situation ci-dessus.

• text/x-json: Type MIME expérimental pour JSON avant d' application/jsonêtre officiellement enregistré.

Dans l'ensemble, chaque fois que vous avez des doutes sur les types de contenu, vous devriez vérifier ce lien

Dans JSP , vous pouvez utiliser cette directive dans la page:

<%@ page language="java" contentType="application/json; charset=UTF-8"
    pageEncoding="UTF-8"%>

Le type de média MIME correct pour JSON est application/json. JSP l'utilisera pour envoyer une réponse au client.

" application/json" Est le type de contenu JSON correct.

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())
  }
}

L' enregistrement IANA pourapplication/json dit

Applications utilisant ce type de média: JSON a été utilisé pour échanger des données entre des applications écrites dans tous ces langages de programmation: ActionScript, C, C #, Clojure, ColdFusion, Common Lisp, E, Erlang, Go, Java, JavaScript, Lua, Objective CAML, Perl, PHP, Python, Rebol, Ruby, Scala et Scheme.

Vous remarquerez que IANA.org ne répertorie aucun de ces autres types de médias , en fait même application/javascriptest désormais obsolète. C'est donc application/jsonvraiment la seule bonne réponse possible .

La prise en charge du navigateur est une autre chose.

Les types de supports non standard les plus largement pris en charge sont text/jsonou text/javascript. Mais certains grands noms utilisent même text/plain.

Encore plus étrange est l'en-tête Content-Type envoyé par Flickr, qui renvoie JSON sous text/xml. Google utilise text/javascriptpour certains de ses apis ajax.

Exemples:

curl -I "https://ajax.googleapis.com/ajax/services/search/video?v=1.0&q=jsonexample"

Production: Content-Type: text/javascript

curl -I "https://www.flickr.com/services/rest/?method=flickr.test.echo&format=json&api_key=f82254c1491d894f1204d8408f645a93"

Production: Content-Type: text/xml

Le bon type MIME est application/json

MAIS

J'ai vécu de nombreuses situations où le type de navigateur ou l'utilisateur du framework avait besoin:

text/html

application/javascript

J'utilise le ci-dessous

contentType: 'application/json',
data: JSON.stringify(SendData),

L'en - tête Content-Type doit être défini sur « application / json » lors de la publication. Le serveur qui écoute la demande doit inclure " Accept = application / json ". Dans Spring MVC, vous pouvez le faire comme ceci:

@RequestMapping(value="location", method = RequestMethod.POST, headers = "Accept=application/json")

Ajoutez des en-têtes à la réponse:

HttpHeaders headers = new HttpHeaders();
headers.add("Content-Type", "application/json");

Au printemps, vous avez un type défini: MediaType.APPLICATION_JSON_VALUEqui est équivalent à application / json .

Cela application/jsonfonctionne très bien en PHP pour stocker un tableau ou des données d'objet.

J'utilise ce code pour mettre des données en JSON sur Google Cloud Storage (GCS) qui est défini publiquement :

$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
);

Pour récupérer les données, c'est simple:

$data = json_decode(file_get_contents("gs://BUCKETNAME/FILENAME.json"));

Si le JSON est avec un remplissage, il le sera application/jsonp. Si le JSON est sans remplissage, il le sera application/json.

Pour gérer les deux, c'est une bonne pratique d'utiliser: 'application / javascript' sans se soucier que ce soit avec ou sans remplissage.

Pour JSON, j'utilise:

 Content-Type: application/json

Ceci est décrit dans la proposition de l'IETF JSON Data Interchange Format 7158, Section 1.2: Spécifications de JSON .

Extension des réponses acceptées, lorsque vous utilisez JSON dans un contexte REST ...

Il existe un argument solide sur l'utilisation application/x-resource+jsonet le application/x-collection+jsonmoment où vous représentez les ressources et les collections REST.

Et si vous décidez de suivre la spécification jsonapi , vous devez utiliser application/vnd.api+json, car elle est documentée.

Bien qu'il n'y ait pas de norme universelle, il est clair que la sémantique ajoutée aux ressources transférées justifie un type de contenu plus explicite que juste application/json.

Suivant ce raisonnement, d'autres contextes pourraient justifier un type de contenu plus spécifique .

Les développeurs PHP utilisent ceci:

<?php
    header("Content-type: application/json");

    // Do something here...
?>

Si vous obtenez des données de l'API REST en JSON, vous devez donc utiliser le type de contenu

For JSON data: Content-Type:application/json
For HTML data: Content-Type:text/html,
For XHTML data: Content-Type:application/xhtml+xml,
For XML data: Content-Type:text/xml, application/xml

Content-Type: application/json- json
Content-Type: application/javascript- json-P
Content-Type: application/x-javascript- javascript
Content-Type: text/javascript- javascript MAIS obsolètes, les anciennes versions d'IE utilisées comme attribut html.
Content-Type: text/x-javascript- Types de supports JavaScript MAIS obsolètes
Content-Type: text/x-json- json avant l'application / json a été officiellement enregistré.

Les formats JSON (JavaScript Object Notation) et JSONP ("JSON with padding") semblent être très similaires et il peut donc être très déroutant de savoir quel type MIME ils devraient utiliser. Même si les formats sont similaires, il existe de subtiles différences entre eux.

Donc, en cas de doute, j'ai une approche très simple (qui fonctionne parfaitement bien dans la plupart des cas), à savoir aller vérifier le document RFC correspondant.

JSON RFC 4627 (le type de média application / json pour la notation d'objet JavaScript (JSON)) est une spécification du format JSON. Il est dit dans la section 6, que le type de média MIME pour le texte JSON est

application/json.

JSONP JSONP ("JSON avec remplissage") est géré différemment de JSON, dans un navigateur. JSONP est traité comme un script JavaScript standard et doit donc utiliser application/javascript,le type MIME officiel actuel pour JavaScript. Dans de nombreux cas, cependant, le text/javascripttype MIME fonctionnera également très bien.

Notez que cela text/javascripta été marqué comme obsolète par le document RFC 4329 (Scripting Media Types) et il est recommandé d'utiliser application/javascriptplutôt le type. Cependant, pour des raisons héritées, il text/javascriptest toujours largement utilisé et il prend en charge plusieurs navigateurs (ce qui n'est pas toujours le cas avec le application/javascripttype MIME, en particulier avec les navigateurs plus anciens).