Pengantar API REST WordPress
Diterbitkan: 2022-10-19Pada bulan Desember 2016, dengan dirilisnya WordPress 4.7, tonggak sejarah yang telah lama diperdebatkan terjadi: WordPress REST API secara resmi dimasukkan sebagai bagian dari WordPress Core.
Meskipun REST API telah ada sebagai plugin sebelum resmi bergabung menjadi inti, penyertaan selanjutnya memicu sedikit perdebatan, dengan argumen yang dibuat untuk penyertaannya dan untuk kebutuhan pengujian lebih lanjut.
Pada akhirnya, REST API digabungkan menjadi Core dan sekarang memberdayakan Editor Blok serta banyak integrasi dan antarmuka pihak ketiga dengan situs WordPress di seluruh web.
Namun, bagi banyak pengguna WordPress, ini adalah pertama kalinya mereka mendengar tentang REST API dalam bentuk apa pun, apalagi yang terintegrasi begitu erat ke dalam WordPress.
Jadi dalam artikel ini, kita akan melihat apa itu REST API, bagaimana uniknya REST API WordPress, dan beberapa contoh cara kerjanya dan beberapa jenis teknologi yang diaktifkan sekarang setelah disertakan di WordPress Inti.
Apa itu REST API?
Istilah REST API sebenarnya adalah dua akronim dalam satu dan keduanya penting ketika memahami cara kerja WordPress REST API dan apa fungsinya.
Apa itu REST?
Bagian pertama, REST, adalah singkatan dari Representational State Transfer. Sederhananya, ini adalah spesifikasi yang menentukan bagaimana dua sumber daya terpisah di web harus berkomunikasi satu sama lain. Kedua antarmuka ini mungkin merupakan dua situs web yang berbeda, server web, aplikasi seluler, dan banyak lagi.
Layanan yang mengikuti spesifikasi ini sering disebut sebagai layanan RESTful, dan berfungsi untuk memastikan bahwa klien yang meminta informasi tidak perlu mengetahui apa pun tentang status server dan bagaimana klien dan server dapat lebih modular dan terpisah dibandingkan dengan yang lain. metode transportasi data di Internet.
Intinya, jika developer mengetahui bahwa mereka berinteraksi dengan layanan RESTful, mereka dapat membuat asumsi tertentu tentang bagaimana permintaan mereka akan diformat dan jenis data apa yang akan mereka terima sebagai imbalannya, yang sangat membantu saat mengembangkan teknologi yang saling terhubung.
Jika Anda ingin mengetahui lebih dalam apa yang membuat layanan RESTful dan bagaimana jenis permintaan ini dibuat, saya akan sangat menyarankan untuk memeriksa Langganan Codecademy yang disebut What is REST?
Apa itu API?
API adalah singkatan dari Application Programming Interface dan, seperti namanya, menyediakan antarmuka untuk klien dan layanan lain di seluruh web untuk berinteraksi dengan aplikasi tertentu. Ini menentukan titik akhir, biasanya URL, di mana data dapat dikirim, apakah URL ini mengembalikan data apa pun atau membuat sumber daya di server dan apakah diperlukan jenis autentikasi tertentu untuk mengakses titik akhir ini.
Untuk banyak layanan populer di web saat ini, API menyediakan cara otomatis untuk melakukan apa yang dapat dilakukan pengguna secara manual, dengan mengizinkan skrip atau potongan kode untuk melakukan tindakan yang sama dengan kehadiran pengguna. Misalnya, jika Anda menggunakan Reddit dan mendapati diri Anda menulis jenis komentar yang sama di banyak utas yang Anda jelajahi, Anda dapat membuat skrip yang mencari jenis komentar tersebut di Reddit dan secara otomatis memposting balasan standar Anda melalui API Reddit.
Dengan mengekspos infrastruktur mereka melalui API, pengguna tidak harus bergantung pada metode pengikisan web yang rapuh untuk mengotomatiskan tugas semacam ini dan Reddit dapat melacak siapa yang mengakses sumber daya mereka melalui API mereka, seberapa sering mereka melakukannya, dan mengontrol untuk penggunaan yang berada di luar persyaratan layanan mereka.
Mengapa WordPress membutuhkan REST API?
Jika Anda pernah membuat permintaan seperti API ke WordPress sebelum REST API menjadi bagian dari Core, Anda mungkin sudah familiar dengan konsep admin-ajax. Ini adalah cara asli membuat permintaan seperti ini di WordPress, di mana setiap permintaan dialihkan melalui file admin-ajax.php, memeriksa tindakan spesifik apa pun yang telah didaftarkan oleh pengembang plugin atau tema aktif apa pun, dan kemudian menggunakan fungsi terdaftar tersebut untuk memenuhi permintaan.
Seperti yang Anda duga, itu berarti bahwa setiap pengembang yang menggunakan permintaan seperti API mengaktifkan fungsi ini sebagai bagian dari plugin atau tema mereka melakukannya sedikit berbeda dan siapa pun yang ingin berinteraksi dengan fungsi ini harus membiasakan diri dengan cara kerja setiap plugin atau tema. dibuat. WordPress REST API diperkenalkan untuk membakukan cara permintaan ini dibuat dan menyediakan serangkaian titik akhir dengan jangkauan yang jauh lebih luas yang dapat digunakan untuk berinteraksi dengan WordPress Core itu sendiri.
Contoh permintaan ke WordPress REST API
Buku Panduan WordPress REST API menyimpan daftar lengkap titik akhir yang didukung di WordPress REST API secara langsung. Dan meskipun bagus untuk memiliki daftar lengkap, itu bisa sedikit berlebihan. Mari kita lihat apa yang mungkin dianggap sebagai fungsionalitas paling dasar dari setiap interaksi API: mengambil sumber daya dasar API. Dalam kasus WordPress, sumber daya itu diposting.
Semua titik akhir WordPress REST API diawali dengan jalur URL wp-json
antara domain root dan apa yang dirujuk oleh REST API Handbook sebagai Base Route
. Artinya, jika kami mengakses titik akhir untuk mencantumkan postingan situs dan URL untuk situs kami adalah example.com
, kami perlu membuat permintaan ke URL https://example.com/wp-json/wp/v2/posts
.
Membuat permintaan GET, baik dengan hanya memuat URL itu di browser web favorit Anda atau menggunakan browser API seperti Postman, akan mengembalikan Anda daftar posting dari API, meskipun mungkin tidak dalam format yang Anda gunakan ke. Jika semua yang Anda lihat adalah satu rangkaian teks yang panjang, Anda sedang melihat format data yang dikenal sebagai JSON. Jika Anda mengakses titik akhir API melalui browser dan ingin melihat informasi ini dalam format yang lebih mudah dibaca, saya sarankan untuk menginstal ekstensi JSON Viewer. Ini akan mendeteksi output apa pun di browser Anda yang merupakan JSON dan memformatnya sehingga Anda dapat membacanya dengan lebih mudah. Dengan ini terinstal, Anda akan melihat output data posting dari WordPress REST API dan Anda telah berhasil membuat permintaan REST API pertama Anda!
Apa lagi yang bisa dilakukan WordPress REST API?
Di luar mengambil daftar posting terbaru di situs WordPress, melihat Referensi Endpoint, Anda akan melihat bahwa ada banyak cara lain untuk berinteraksi dengan WordPress REST API. Jika Anda diautentikasi sebagai pengguna WordPress, Anda dapat menerbitkan posting melalui API, mendapatkan daftar Tema yang tersedia di situs, melihat dan mengedit pengaturan serta banyak fungsi lain yang tersedia untuk berinteraksi secara manual melalui wp-admin .
Beberapa contoh tindakan WordPress REST API
Mengekspos kemampuan untuk berinteraksi dengan WordPress melalui REST API membuka berbagai kemungkinan situs yang sekarang dapat menggunakan WordPress sebagai backend untuk manajemen konten.
TechCrunch : Tak lama setelah WordPress REST API diumumkan, TechCrunch mengumumkan bahwa mereka telah membangun kembali situsnya menggunakan arsitektur headless, yang berarti bahwa mereka menggunakan WordPress di backend sebagai sistem manajemen konten, sambil tetap dapat menggunakan “satu halaman style React app” di frontend.
Block Editor (Gutenberg) : Mungkin penggunaan REST API yang paling banyak diuntungkan adalah WordPress Block Editor. Sekarang editor utama di WordPress, sebagian besar fungsi Editor Blok diaktifkan oleh fakta bahwa ia dapat berinteraksi dengan titik akhir API REST WordPress tanpa
Segala macam proyek komunitas : Kembali ketika REST API pertama kali dipertimbangkan untuk bergabung menjadi inti, panggilan publik keluar meminta orang untuk berbicara lebih banyak tentang bagaimana mereka menggunakan REST API. Jawabannya sangat beragam, yang dapat Anda harapkan dari komunitas sebesar WordPress, tetapi menyertakan semuanya mulai dari plugin dengan antarmuka yang lebih interaktif daripada yang mungkin dilakukan sebelumnya hingga orang yang membuat aplikasi seluler untuk klien mereka yang dapat menggunakan konten WordPress.
Membungkus
Bahkan jika Anda tidak memiliki pengalaman menggunakan API, Anda mungkin pernah menggunakan sesuatu di beberapa titik dalam karir Anda yang mengandalkan WordPress REST API untuk berfungsi. Karena antarmuka terus menjadi lebih dinamis dan situs web mulai memiliki lebih banyak tindakan yang tidak memerlukan pemuatan halaman.
Sekarang setelah Anda mengetahui apa itu WordPress REST API, Anda mungkin berpikir tentang beberapa hal yang dapat Anda bangun dengannya! REST API pasti bisa menjadi alat yang ampuh di kotak alat Anda untuk membangun tema dan plugin WordPress yang lebih baik.
Jika Anda membutuhkan lebih banyak klarifikasi atau beberapa contoh tentang apa yang mungkin, lihat dokumennya dan langsung masuk!