Gambaran Keseluruhan Kaedah HTTP dalam API: GET, POST, DELETE, PUT dan PATCH

"API (Antara Muka Pengaturcaraan Aplikasi) sering menggunakan kaedah HTTP untuk membenarkan komunikasi antara klien dan pelayan, terutamanya apabila bekerja dengan perkhidmatan web. Kaedah ini mentakrifkan tindakan khusus yang boleh dilakukan pada sumber—seperti mendapatkan semula, mencipta, mengemas kini atau memadamkan data—membolehkan interaksi berstruktur dalam aplikasi web Mari kita lihat beberapa kaedah HTTP yang paling biasa:"

1. DAPATKAN: Mendapatkan Data
Kaedah GET digunakan untuk mendapatkan semula data daripada pelayan tanpa mengubah suainya. Ia merupakan kaedah yang paling biasa dalam API REST dan biasanya digunakan untuk mengambil data seperti butiran pengguna, maklumat produk atau senarai item.

• Kes Penggunaan:

  • Mendapatkan senarai pengguna atau data pengguna tunggal.
  • Mendapatkan semula butiran produk, seperti penerangan dan harga.
  • Mengakses sumber baca sahaja seperti halaman utama atau blog siaran.

• Ciri-ciri:

  • Selamat: Tidak mengubah keadaan pelayan; ia dibaca- sahaja.
  • Idempoten: Permintaan GET berulang mempunyai hasil yang sama.
  • Boleh cache: Memandangkan ia mendapatkan semula data tanpa perubahan, keputusan boleh dicache untuk kecekapan.

Contoh:

GET /api/users/1

2. POST: Mencipta Sumber
Kaedah POST digunakan untuk mencipta sumber baharu pada pelayan. Apabila anda menyerahkan permintaan POST, pelayan menjana sumber baharu berdasarkan data yang disediakan. Tidak seperti GET, POST ialah operasi tulis dan boleh menukar keadaan pelayan.

• Kes Penggunaan:

  • Membuat akaun pengguna baharu.
  • Menyerahkan produk baharu ke katalog.
  • Menghantar data melalui borang, seperti menyerahkan sokongan permintaan.

• Ciri-ciri:

  • Bukan Idempoten: Mengulang permintaan POST beberapa kali boleh mencipta berbilang sumber dengan data yang sama.
  • Tidak Boleh Cache: Biasanya tidak dicache, kerana ia adalah pengubahsuaian permintaan.

• Contoh:
  
  

POST /api/users
Content-Type: application/json

{
    "name": "John Doe",
    "email": "john@example.com"
}

3. PADAM: Mengalih keluar Sumber
Kaedah DELETE digunakan untuk memadam sumber daripada pelayan. Kaedah ini membolehkan pelanggan mengarahkan pelayan untuk mengalih keluar sumber tertentu dengan pengecamnya (seperti ID).

• Kes Penggunaan:

  • Memadamkan akaun pengguna.
  • Mengalih keluar produk daripada inventori.
  • Membatalkan pesanan.

• Ciri-ciri:

  • Idempoten: Walaupun permintaan DELETE diulang, ia akan berlaku menghasilkan keadaan akhir yang sama—sama ada sumbernya dipadamkan atau ia sudah tiada.
  • Tidak Boleh Cache: Biasanya tidak dicache, kerana ia mengubah suai data pada pelayan.

• Contoh:
  
  

GET /api/users/1

4. PUT: Mengemas kini atau Menggantikan Sumber
Kaedah PUT digunakan untuk mengemas kini sumber sedia ada atau mencipta sumber jika ia tidak wujud. Apabila menggunakan PUT, pelanggan menghantar perwakilan lengkap sumber yang ingin dikemas kini. PUT biasanya digunakan untuk kemas kini yang semua sifat sumber diketahui dan disediakan.

• Kes Penggunaan:

  • Menggantikan maklumat profil pengguna.
  • Menulis ganti butiran produk.
  • Mengemas kini catatan blog dengan kandungan baharu.

• Ciri-ciri:

• Idempoten: Permintaan PUT berulang dengan data yang sama mempunyai
  
  kesan yang sama, menghasilkan keadaan sumber yang sama.

• Tidak Boleh Cache: Ia biasanya tidak dicache kerana ia mengubah suai
  
  data.

• Contoh:
  
  

POST /api/users
Content-Type: application/json

{
    "name": "John Doe",
    "email": "john@example.com"
}

Permintaan ini mengemas kini pengguna dengan ID 1 dengan nama baharu “Jane Doe” dan e-mel “jane@example.com”. Jika pengguna tidak wujud, pelayan boleh membuat yang baharu, bergantung pada pelaksanaan.

5. PATCH: Mengemas kini Sebahagian Sumber
Kaedah PATCH adalah serupa dengan PUT tetapi digunakan untuk kemas kini separa. Daripada menghantar perwakilan lengkap sumber, PATCH membenarkan pelanggan mengemas kini medan tertentu sahaja. Ia berguna apabila hanya beberapa atribut sumber perlu diubah tanpa menggantikan keseluruhan sumber.

• Kes Penggunaan:

  • Mengemas kini hanya alamat e-mel pengguna tanpa mengubah suai butiran lain.
  • Menukar kuantiti stok produk sahaja.
  • Mengubah suai tajuk catatan blog sambil meninggalkan kandungan tidak berubah.

• Ciri-ciri:

  • Idempotent: Seperti PUT, mengulangi permintaan PATCH dengan data yang sama mempunyai kesan yang sama.
  • Tidak Boleh Cache: Biasanya tidak dicache kerana ia adalah pengubahsuaian operasi.

• Contoh:
  
  

DELETE /api/users/1

Permintaan ini hanya mengemas kini alamat e-mel untuk pengguna dengan ID 1, meninggalkan semua medan lain seperti sedia ada.

• DAPATKAN: Baca data (selamat, idempoten, boleh cache).
• POST: Cipta sumber baharu (bukan idempoten, tidak boleh cache).
• PADAM: Alih keluar sumber (idempoten, tidak boleh cache).
• PUT: Kemas kini atau gantikan sumber sepenuhnya (idempoten, tidak boleh cache).
• PATCH: Kemas kini sebahagian sumber (idempoten, tidak boleh cache).

Setiap kaedah mempunyai tujuan tertentu dan membolehkan API REST menyediakan rangkaian penuh interaksi, membolehkan pelanggan mencipta, membaca, mengemas kini dan memadamkan sumber dengan cekap. Memahami kaedah ini membantu dalam mereka bentuk API intuitif yang konsisten dan membolehkan pelanggan berinteraksi secara berkesan dengan sumber pelayan.

Atas ialah kandungan terperinci Gambaran Keseluruhan Kaedah HTTP dalam API: GET, POST, DELETE, PUT dan PATCH. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!