CouchDB - API HTTP

Dengan menggunakan header permintaan HTTP, Anda dapat berkomunikasi dengan CouchDB. Melalui permintaan tersebut kita dapat mengambil data dari database, menyimpan data ke dalam database dalam bentuk dokumen, dan kita dapat melihat serta memformat dokumen yang disimpan dalam database.

Format Permintaan HTTP

Saat berkomunikasi dengan database kami akan menggunakan format permintaan yang berbeda seperti get, head, post, put, delete, dan copy. Untuk semua operasi di CouchDB, data masukan dan struktur data keluaran akan berupa objek JavaScript Object Notation (JSON).

Berikut adalah format permintaan berbeda dari Protokol HTTP yang digunakan untuk berkomunikasi dengan CouchDB.

  • GET- Format ini digunakan untuk mendapatkan item tertentu. Untuk mendapatkan item yang berbeda, Anda harus mengirimkan pola url tertentu. Di CouchDB menggunakan permintaan GET ini, kita bisa mendapatkan item statis, dokumen dan konfigurasi database, dan informasi statistik dalam bentuk dokumen JSON (dalam banyak kasus).

  • HEAD - Metode HEAD digunakan untuk mendapatkan header HTTP dari permintaan GET tanpa isi respons.

  • POST- Permintaan posting digunakan untuk mengunggah data. Di CouchDB menggunakan permintaan POST, Anda dapat mengatur nilai, mengunggah dokumen, mengatur nilai dokumen, dan juga dapat memulai perintah administrasi tertentu.

  • PUT - Dengan menggunakan permintaan PUT, Anda dapat membuat objek, database, dokumen, tampilan, dan dokumen desain baru.

  • DELETE - Menggunakan permintaan DELETE, Anda dapat menghapus dokumen, tampilan, dan dokumen desain.

  • COPY - Menggunakan metode COPY, Anda dapat menyalin dokumen dan objek.

Header Permintaan HTTP

Header HTTP harus disediakan untuk mendapatkan format dan pengkodean yang tepat. Saat mengirim permintaan ke server CouchDB, Anda dapat mengirim header permintaan Http bersama dengan permintaan tersebut. Berikut ini adalah header permintaan Http yang berbeda.

  • Content-type- Header ini digunakan untuk menentukan tipe konten dari data yang kami suplai ke server bersama dengan permintaan. Sebagian besar jenis konten yang kami kirimkan bersama dengan permintaan adalah jenis MIME atau JSON (application / json). Sangat disarankan untuk menggunakan Jenis konten pada permintaan.

  • Accept- Header ini digunakan untuk menentukan server, daftar tipe data yang dapat dipahami klien, sehingga server akan mengirimkan responsnya menggunakan tipe data tersebut. Secara umum di sini, Anda dapat mengirim daftar tipe data MIME yang diterima klien, dipisahkan oleh titik dua.

    Meskipun, menggunakan Terima dalam kueri CouchDB tidak diperlukan, sangat disarankan untuk memastikan bahwa data yang dikembalikan dapat diproses oleh klien.

Header Respons

Ini adalah header dari respons yang dikirim oleh server. Header ini memberikan informasi tentang konten yang dikirim oleh server sebagai tanggapan.

  • Content-type- Header ini menentukan tipe MIME dari data yang dikembalikan oleh server. Untuk sebagian besar permintaan, jenis MIME yang dikembalikan adalah teks / biasa.

  • Cache-control- Header ini menyarankan klien tentang memperlakukan informasi yang dikirim oleh server. CouchDB sebagian besar mengembalikan must-revalidate, yang menunjukkan bahwa informasi tersebut harus divalidasi ulang jika memungkinkan.

  • Content-length - Header ini mengembalikan panjang konten yang dikirim oleh server, dalam byte.

  • Etag - Header ini digunakan untuk menunjukkan revisi dokumen, atau tampilan.

Kode Status

Berikut adalah bentuk tabel dari kode status yang dikirim oleh header http dan deskripsinya.

Sr.No. Kode & Deskripsi Status
1

200 − OK

Status ini akan dikeluarkan ketika permintaan berhasil diselesaikan.

2

201 − Created

Status ini akan dikeluarkan saat dokumen dibuat.

3

202 − Accepted

Status ini akan dikeluarkan saat permintaan diterima.

4

404 − Not Found

Status ini akan dikeluarkan ketika server tidak dapat menemukan konten yang diminta.

5

405 − Resource Not Allowed

Status ini dikeluarkan jika jenis permintaan HTTP yang digunakan tidak valid.

6

409 − Conflict

Status ini dikeluarkan setiap kali ada konflik pembaruan.

7

415 − Bad Content Type

Status ini menunjukkan bahwa jenis konten yang diminta tidak didukung oleh server.

8

500 − Internal Server Error

Status ini dikeluarkan setiap kali data yang dikirim dalam permintaan tidak valid.

Jalur URL HTTP

Ada jalur url tertentu yang digunakan, Anda dapat berinteraksi dengan database secara langsung. Berikut adalah format tabel dari jalur url tersebut.

Sr.No. URL & Operasi
1

PUT /db

Url ini digunakan untuk membuat database baru.

2

GET /db

Url ini digunakan untuk mendapatkan informasi tentang database yang ada.

3

PUT /db/document

Url ini digunakan untuk membuat dokumen / mengupdate dokumen yang sudah ada.

4

GET /db/document

Url ini digunakan untuk mendapatkan dokumen.

5

DELETE /db/document

Url ini digunakan untuk menghapus dokumen tertentu dari database yang ditentukan.

6

GET /db/_design/design-doc

Url ini digunakan untuk mendapatkan definisi dokumen desain.

7

GET /db/_design/designdoc/_view/view-name

Url ini digunakan untuk mengakses tampilan, nama-tampilan dari dokumen desain dari database yang ditentukan.