Bagaimana API diuji - mari kita lihat contoh REST API

API adalah sekumpulan definisi dan protokol untuk membangun dan mengintegrasikan perangkat lunak aplikasi. API terkadang disebut sebagai kontrak antara penyedia informasi dan pengguna informasi—yang menetapkan konten yang dibutuhkan dari konsumen (panggilan) dan konten yang dibutuhkan oleh produsen (respons). Misalnya, desain API untuk layanan cuaca dapat menentukan bahwa pengguna memberikan kode pos dan produsen membalas dengan jawaban yang terdiri dari dua bagian, yang pertama adalah suhu tinggi, dan yang kedua adalah suhu rendah.

Dengan kata lain, jika Anda ingin berinteraksi dengan komputer atau sistem untuk mengambil informasi atau menjalankan suatu fungsi, API membantu Anda mengomunikasikan apa yang Anda inginkan ke sistem tersebut sehingga sistem tersebut dapat memahami dan memenuhi permintaan tersebut.

Anda dapat menganggap API sebagai mediator antara pengguna atau klien dan sumber daya atau layanan web yang ingin mereka dapatkan. API juga merupakan cara bagi suatu organisasi untuk berbagi sumber daya dan informasi sambil menjaga keamanan, kontrol, dan autentikasi—menentukan siapa yang mendapatkan akses ke apa.

Keuntungan lain dari API adalah Anda tidak perlu mengetahui secara spesifik tentang caching, bagaimana sumber daya anda diambil atau dari mana asalnya.

Ada kalanya Anda perlu memastikan bahwa API berfungsi sebagaimana mestinya dan menyampaikan apa yang dibutuhkan. Agar tidak menguji semuanya pada program nyata, mereka membuatnya lebih sederhana dan menguji API menggunakan alat terpisah.

Curl (singkatan dari Client URL Request Library) adalah alat baris perintah untuk mentransfer data. Anda dapat memeriksa instalasi dengan perintah curl --version. Jika semuanya terinstal dengan benar, Anda akan melihat informasi singkat tentang versi program.

runtu@runtu-desktop:~$ curl --versioncurl 7.81.0 (x86_64-pc-linux-gnu) libcurl/7.81.0 OpenSSL/3.0.2 zlib/1.2.11 brotli/1.0.9 zstd/1.4.8 libidn2/2.3.2 libpsl/0.21.0 (+libidn2/2.3.2) libssh/0.9.6/openssl/zlib nghttp2/1.43.0 librtmp/2.3 OpenLDAP/2.5.17Release-Date: 2022-01-05Protocols: dict file ftp ftps gopher gophers http https imap imaps ldap ldaps mqtt pop3 pop3s rtmp rtsp scp sftp smb smbs smtp smtps telnet tftp Features: alt-svc AsynchDNS brotli GSS-API HSTS HTTP2 HTTPS-proxy IDN IPv6 Kerberos Largefile libz NTLM NTLM_WB PSL SPNEGO SSL TLS-SRP UnixSockets zstd

Terkadang dokumentasi API menyediakan templat untuk permintaan melalui curl, tetapi jika tidak tersedia, Anda dapat menggunakan permintaan GET yang sebenarnya. Untuk melakukan ini, sebelum permintaan pada baris perintah, Anda perlu menulis curl. Misalnya kita ingin mendapatkan anime acak dari database MyAnimeList yang memiliki Jikan API. Jika suatu program meminta anime acak ini, program tersebut akan menggunakan perintah GET "https://api.jikan.moe/v4/random/anime". 

$ curl https://api.jikan.moe/v4/random/anime

Dalam kasus pemeriksaan kami menggunakan curl, perintah diatas akan terlihat seperti ini:

Kemudian, kami mengirim permintaan dan melihat tanggapannya yang sulit untuk diuraikan. Hasilnya, perhatikan gambar di bawah ini.

Setelah instalasi, Anda perlu menambahkan di akhir permintaan | jq:

$ curl https://api.jikan.moe/v4/random/anime | jq

$ pip install requests

atau dapat langsung anda kerjakan di IDE tempat Anda bekerja.

$ import requests

Sekarang mari kita ambil URL dari permintaan fakta matematika dan menyimpannya dalam sebuah variabel:

$ url = "https://numbersapi.p.rapidapi.com/1729/math"

Menurut instruksi RapidAPI, kita perlu menambahkan parameter header tambahan ke permintaan. Salah satunya adalah token pribadi Anda, kunci API. Anda dapat melihatnya di sini.

headers = {
    "x-rapidapi-key": "cbas234jl2lkj23lj324lj3lj34j23ljs09sdf234jksdf0dsfs90fs70",
    "x-rapidapi-host": "numbersapi.p.rapidapi.com"
}

Setelah itu, Anda dapat membuat permintaan. Untuk menyimpan data, kami mendeklarasikan variabel lain dan menambahkan URL dan header ke permintaan.

$ response = requests.get(url, headers=headers)

Untuk melihat hasilnya, mari tampilkan permintaan di layar dalam format teks. Sebelum ini, mari kita tambahkan pemeriksaan kode status respon dari server. Jika kodenya 200, teks respons dapat ditampilkan. Jika server mengembalikan kode yang berbeda, kami akan menampilkan kode kesalahan.

# jika kode status permintaan berhasil diterima dari server,

# tampilkan respons dalam format teks
if response.status_code == 200:
   print(response.text)
# jika permintaan kode status kesalahan diterima dari server,
# tampilkan kode status ini
else:
   print(f"Запрос не удался. Код ошибки: {response.status_code}")

Jika kita menjalankan seluruh kode ini dengan kunci API asli, kita akan mendapatkan respons berikut:

1729 is the smallest natural number representable in two different ways as a sum of two positive cubes, as Ramanujan stated on the spot.

Sekarang mari kita coba mengganti 1729format yang tidak sesuai - mari kita tulis abcd:

# mendeklarasikan variabel dengan alamat tujuan pengiriman permintaan
url = "https://numbersapi.p.rapidapi.com/abcd/math"

Kita akan mendapat pesan kesalahan karena tipe nilai dalam bidang ini harus berupa bilangan bulat. Kami tidak akan melihat ini di pesan kesalahan kami karena kami sedang memeriksa kode status server. Kami akan menerima ini:

Permintaan gagal. Kode kesalahan: 404

5. Cara mengeluarkan satu nilai dari respons

# impor perpustakaan ke dalam proyek
import requests
# buat permintaan di alamat yang ditentukan dalam dokumentasi
response = requests.get("https://api.spacexdata.com/v4/launches")

Untuk dapat mengekstrak data berdasarkan kunci, kami menerjemahkan respons ke dalam format JSON:

# konversi respons ke format json
data = response.json()

Sekarang kami memilih satu set kunci untuk jenis peluncuran tertentu. Kami akan mengambil yang pertama sebagai contoh:

# sorot informasi tentang peluncuran pertama
latest_launch = data[1]

Sekarang kami mengambil informasi ini dan menyimpan nilai untuk kunci yang diperlukan ke dalam setiap variabel - nama_luncuran, tanggal_luncuran, detail_luncuran. Setelah ini kami menampilkan nilai di layar.

# dapatkan nilai berdasarkan kunci: nama, tanggal peluncuran, detail
launch_name = latest_launch['name']
launch_date = latest_launch['date_utc']
launch_details = latest_launch['details']
# cetak setiap nilai yang diterima secara terpisah
print('launch_name: ', launch_name)
print('launch_date: ', launch_date)
print('launch_details: ', launch_details)

Catatan:

launch_name: DemoSat

launch_date: 2007-03-21T01:10:00.000Z

launch_details: Pembakaran tahap pertama berhasil dan transisi ke tahap kedua, ketinggian maksimum 289 km, Pematian mesin prematur pada T+7 menit 30 detik, Gagal mencapai orbit, Gagal memulihkan tahap pertama.

Sekarang setelah kita mengetahui cara kerja REST API paling populer, lain kali kita akan menggunakan salah satu kerangka kerja untuk menulis API dan menulis kerangka kerja kita sendiri.