Apa jenis konten JSON yang benar?

Saya telah bermain-main dengan JSON selama beberapa waktu, hanya mendorongnya keluar sebagai teks dan tidak menyakiti siapa pun (yang saya tahu), tetapi saya ingin mulai melakukan hal-hal dengan benar.

Saya telah melihat begitu banyak "standar" yang diakui untuk tipe konten JSON:

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

Tapi mana yang benar, atau yang terbaik? Saya mengetahui bahwa ada masalah keamanan dan dukungan browser yang beragam di antara mereka.

Saya tahu ada pertanyaan serupa, Apa tipe MIME jika JSON dikembalikan oleh API REST? , tapi saya ingin jawaban yang sedikit lebih bertarget.

Untuk teks JSON:

application/json

Jenis media MIME untuk teks JSON adalah application/json. Pengkodean default adalah UTF-8. (Sumber: RFC 4627 ).

Untuk JSONP (runnable javascript) dengan panggilan balik:

application/javascript

Berikut adalah beberapa posting blog yang disebutkan dalam komentar yang relevan.

• Mengapa Anda tidak perlu menggunakan text/htmlJSON
• Internet Explorer terkadang bermasalah dengan application/json
• Daftar Mimetypes yang agak lengkap dan untuk apa menggunakannya
• Daftar jenis pantomim resmi di IANA dari jawaban @ gnrfan di bawah ini

IANA telah mendaftarkan Tipe MIME resmi untuk JSON sebagai application/json.

Ketika ditanya tentang mengapa tidak text/json, Crockford tampaknya mengatakan JSON tidak benar-benar JavaScript atau teks dan juga IANA lebih mungkin untuk membagikan application/*daripada text/*.

Sumber lainnya:

• Jenis Media
• Permintaan Komentar 4627
• bluesmoon: JSON memiliki tipe

Untuk JSON:

Content-Type: application/json

Untuk JSON-P :

Content-Type: application/javascript

Tentu saja, jenis media MIME yang benar untuk JSON adalah application/json , tetapi perlu untuk menyadari jenis data apa yang diharapkan dalam aplikasi Anda.

Sebagai contoh, saya menggunakan Ext GWT dan respons server harus berupa teks / html tetapi berisi data JSON.

Sisi klien, pendengar formulir 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");
    }
});

Dalam hal menggunakan aplikasi / json tipe respons , browser menyarankan saya untuk menyimpan file.

Cuplikan kode sumber sisi server menggunakan 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:

Respons adalah data yang dihasilkan secara dinamis, sesuai dengan parameter kueri yang diteruskan dalam URL.

Contoh:

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

Jenis konten: application/json

JSON-P:

JSON dengan bantalan. Respons adalah data JSON, dengan panggilan fungsi yang melingkupinya.

Contoh:

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

Jenis konten: application/javascript

Jika Anda menggunakan Ubuntu atau Debian dan Anda menyajikan file .json melalui Apache, Anda mungkin ingin menyajikan file dengan tipe konten yang benar. Saya melakukan ini terutama karena saya ingin menggunakan JSONView ekstensi Firefox

Modul Apache mod_mime akan membantu melakukan ini dengan mudah. Namun, dengan Ubuntu Anda perlu mengedit file /etc/mime.types dan menambahkan baris

application/json json

Kemudian restart Apache:

sudo service apache2 restart

Jika Anda memanggil Layanan Web ASP.NET dari sisi klien, Anda harus menggunakannya application/jsonagar berfungsi. Saya percaya ini sama untuk kerangka kerja jQuery dan Ext .

Jenis konten yang tepat untuk JSON adalah application/jsonKECUALI Anda menggunakan JSONP , juga dikenal sebagai JSON dengan Padding, yang sebenarnya JavaScript dan jenis konten yang tepat application/javascript.

Tidak ada keraguan bahwa itu application/jsonadalah MIME terbaik tipe untuk respons JSON.

Tapi saya punya pengalaman di mana saya harus menggunakan application/x-javascriptkarena beberapa masalah kompresi. Lingkungan hosting saya adalah shared hosting dengan GoDaddy . Mereka tidak mengizinkan saya untuk mengubah konfigurasi server. Saya telah menambahkan kode berikut ke web.configfile saya untuk mengompres respons.

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

Dengan menggunakan ini, halaman .aspx dikompres dengan g-zip tetapi respons JSON tidak. saya tambahkan

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

di bagian tipe statis dan dinamis. Tapi ini tidak mengompres respons JSON sama sekali.

Setelah itu saya menghapus jenis yang baru ditambahkan ini dan menambahkan

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

di bagian tipe statis dan dinamis, dan mengubah tipe respons di

.ashx (penangan asinkron) ke

application/x-javascript

Dan sekarang saya menemukan bahwa respons JSON saya dikompres dengan g-zip. Jadi saya pribadi merekomendasikan untuk menggunakan

application/x-javascript

hanya jika Anda ingin mengompres respons JSON Anda di lingkungan hosting bersama . Karena dalam shared hosting, mereka tidak memungkinkan Anda untuk mengubah konfigurasi IIS .

Hanya ketika menggunakan application/jsonsebagai tipe MIME saya memiliki yang berikut (per November 2011 dengan versi Chrome terbaru, Firefox dengan Firebug ):

• Tidak ada lagi peringatan dari Chrome ketika JSON diambil dari server.
• Firebug akan menambahkan tab ke respons yang menunjukkan Anda data JSON diformat. Jika tipe MIME berbeda, itu hanya akan muncul sebagai 'Konten respons'.

Tidak semuanya berfungsi untuk tipe konten application/json.

Jika Anda menggunakan formulir Ext JS , kirim untuk mengunggah file, ketahuilah bahwa respons server diuraikan oleh browser untuk membuat dokumen untuk <iframe>.

Jika server menggunakan JSON untuk mengirim objek kembali, maka Content-Typeheader harus diatur ketext/html untuk memberitahu browser untuk memasukkan teks tidak berubah ke dalam badan dokumen.

Lihat dokumentasi API Ext JS 3.4.0 .

JSON adalah bahasa khusus domain (DSL) dan format data independen dari JavaScript, dan karenanya memiliki jenis MIME sendiri application/json,. Menghormati tipe MIME tentu saja didorong oleh klien, jadi text/plainmungkin dilakukan untuk transfer byte, tetapi kemudian Anda akan mendorong interpretasi ke domain aplikasi vendor secara tidak perlu - application/json. Apakah Anda akan mentransfer XML melalui text/plain?

Tapi sejujurnya, pilihan tipe MIME Anda adalah saran kepada klien tentang cara menafsirkan data - text/plainatau text/HTML(jika bukan HTML) seperti tipe penghapusan - sama tidak informatifnya dengan membuat semua objek Anda mengetik Objek dalam bahasa yang diketik.

Tidak ada runtime browser yang saya tahu akan mengambil dokumen JSON dan secara otomatis membuatnya tersedia untuk runtime sebagai objek yang dapat diakses JavaScript tanpa intervensi, tetapi jika Anda bekerja dengan klien yang lumpuh, itu masalah yang sama sekali berbeda. Tapi itu bukan keseluruhan cerita - RESTful layanan JSON sering tidak memiliki runtime JavaScript, tetapi tidak menghentikan mereka menggunakan JSON sebagai format pertukaran data yang layak. Jika klien lumpuh ... maka saya akan mempertimbangkan mungkin injeksi HTML melalui layanan templating Ajax sebagai gantinya.

Aplikasi / JSON!

Jika Anda berada di lingkungan sisi klien, menyelidiki tentang dukungan lintas-browser wajib untuk aplikasi web yang didukung dengan baik.

Tipe Konten HTTP yang benar adalah application/json, karena yang lain juga telah disorot, tetapi beberapa klien tidak menanganinya dengan baik, itu sebabnya jQuery merekomendasikan default text/html.

Jawaban yang benar adalah:

Content-Type: application/json

Seperti yang banyak orang lain katakan, application/jsonadalah jawaban yang benar.

Tetapi apa yang belum dijelaskan adalah apa arti opsi lain yang Anda usulkan.

• application/x-javascript: Jenis MIME eksperimental untuk JavaScript sebelum application/javascriptdibuat standar.

• text/javascript: Sekarang sudah usang. Anda harus menggunakan application/javascriptsaat menggunakan javascript.

• text/x-javascript: Jenis MIME eksperimental untuk situasi di atas.

• text/x-json: Jenis MIME eksperimental untuk JSON sebelum application/jsondidaftarkan secara resmi.

Semua dalam semua, setiap kali Anda ragu tentang jenis konten, Anda harus memeriksa tautan ini

Di JSP , Anda dapat menggunakan ini dalam arahan halaman:

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

Jenis media MIME yang benar untuk JSON adalah application/json. JSP akan menggunakannya untuk mengirim respons ke klien.

" application/json" Adalah jenis konten JSON yang benar.

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

The pendaftaran IANA untukapplication/json mengatakan

Aplikasi yang menggunakan jenis media ini: JSON telah digunakan untuk bertukar data antara aplikasi yang ditulis dalam semua bahasa pemrograman ini: ActionScript, C, C #, Clojure, ColdFusion, Common Lisp, E, Erlang, Go, Java, JavaScript, Lua, Objective CAML, Perl, PHP, Python, Rebol, Ruby, Scala, dan Skema.

Anda akan melihat bahwa IANA.org tidak mencantumkan jenis media lain ini , bahkan application/javascriptsekarang sudah usang. Jadi application/jsonbenar-benar satu-satunya jawaban yang mungkin benar .

Dukungan browser adalah hal lain.

Jenis media non-standar yang paling banyak didukung adalah text/jsonatau text/javascript. Tetapi beberapa nama besar bahkan digunakan text/plain.

Yang lebih aneh adalah header Tipe-Konten yang dikirim oleh Flickr, yang mengembalikan JSON sebagai text/xml. Google menggunakan text/javascriptbeberapa apis ajax.

Contoh:

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

Keluaran: Content-Type: text/javascript

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

Keluaran: Content-Type: text/xml

Jenis MIME yang tepat adalah application/json

TAPI

Saya mengalami banyak situasi di mana jenis browser atau kerangka kerja yang dibutuhkan pengguna:

text/html

application/javascript

Saya menggunakan di bawah ini

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

The Content-Type header yang harus ditetapkan ke ' aplikasi / json ' ketika posting. Server yang mendengarkan permintaan harus menyertakan " Terima = aplikasi / json ". Di Spring MVC Anda dapat melakukannya seperti ini:

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

Tambahkan tajuk ke respons:

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

Di musim semi Anda memiliki tipe yang ditentukan: MediaType.APPLICATION_JSON_VALUEyang setara dengan application / json .

The application/jsonkarya-karya besar di PHP untuk menyimpan array atau objek data.

Saya menggunakan kode ini untuk memasukkan data ke JSON di Google Cloud Storage (GCS) yang diatur agar dapat dilihat secara publik :

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

Untuk mendapatkan kembali data secara langsung:

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

Jika JSON dengan bantalan maka itu akan menjadi application/jsonp. Jika JSON tanpa bantalan maka itu akan menjadi application/json.

Untuk menangani keduanya, ini adalah praktik yang baik untuk menggunakan: 'application / javascript' tanpa peduli apakah itu dengan padding atau tanpa padding.

Untuk JSON, saya menggunakan:

 Content-Type: application/json

Ini dijelaskan dalam proposal Format Pertukaran Data JSON IETF 7158, Bagian 1.2: Spesifikasi JSON .

Memperluas respons yang diterima, saat Anda menggunakan JSON dalam konteks REST ...

Ada argumen kuat tentang penggunaan application/x-resource+jsondan application/x-collection+jsonkapan Anda mewakili sumber daya dan koleksi REST.

Dan jika Anda memutuskan untuk mengikuti spesifikasi jsonapi , Anda harus menggunakan application/vnd.api+json, seperti yang didokumentasikan.

Meskipun tidak ada standar universal, jelas bahwa semantik yang ditambahkan ke sumber daya yang ditransfer membenarkan Jenis Konten yang lebih eksplisit daripada hanyaapplication/json .

Mengikuti alasan ini, konteks lain dapat membenarkan Tipe Konten yang lebih spesifik .

Pengembang PHP menggunakan ini:

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

    // Do something here...
?>

Jika Anda mendapatkan data dari REST API di JSON maka Anda harus menggunakan tipe konten

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 TAPI usang, versi IE yang lebih lama digunakan untuk menggunakan atribut html.
Content-Type: text/x-javascript- Jenis Media JavaScript TETAPI usang
Content-Type: text/x-json- json sebelum aplikasi / json didaftarkan secara resmi.

Format JSON (JavaScript Object Notation) dan JSONP ("JSON with padding") tampaknya sangat mirip dan karenanya mungkin sangat membingungkan jenis MIME mana yang harus mereka gunakan. Meskipun formatnya mirip, ada beberapa perbedaan kecil di antara mereka.

Jadi, kapan pun dalam keraguan, saya memiliki pendekatan yang sangat sederhana (yang berfungsi dengan sangat baik dalam kebanyakan kasus), yaitu, pergi dan periksa dokumen RFC yang sesuai.

JSON RFC 4627 (Aplikasi / json Media Type untuk JavaScript Object Notation (JSON)) adalah spesifikasi format JSON. Dikatakan di bagian 6, bahwa jenis media MIME untuk teks JSON adalah

application/json.

JSONP JSONP ("JSON with padding") ditangani dengan cara yang berbeda dari JSON, di browser. JSONP diperlakukan sebagai skrip JavaScript biasa dan karenanya harus menggunakan application/javascript,jenis MIME resmi saat ini untuk JavaScript. Namun, dalam banyak kasus, text/javascripttipe MIME akan berfungsi dengan baik juga.

Catatan yang text/javascripttelah ditandai sebagai usang oleh dokumen RFC 4329 (Jenis Media Scripting) dan disarankan untuk menggunakan application/javascriptjenis. Namun, karena alasan warisan, text/javascriptmasih banyak digunakan dan memiliki dukungan lintas-browser (yang tidak selalu merupakan kasus dengan application/javascripttipe MIME, terutama dengan browser yang lebih lama).