Sambungkan ke API Tanpa Kod: 8 Langkah

2024 Pengarang: John Day | [email protected]. Diubah suai terakhir: 2024-01-30 11:07

Panduan ini direka untuk orang yang mempunyai sesuatu yang ingin mereka capai yang memerlukan penggunaan API, tetapi tidak begitu yakin untuk memulakannya. Anda sudah tahu mengapa dapat bekerja dengan API berguna, dan panduan ini akan menunjukkan cara melakukannya.

Sekiranya itu terdengar seperti anda, anda bernasib baik! Kami di sini untuk menerangkan cara bekerja dengan API, cara membaca dokumen API, dan bagaimana sebenarnya menggunakan data yang berasal dari API.

Kami telah membawa rakan untuk membuat perjalanan lebih mudah.

Jumpa Slash

Slash adalah anjing Michelle yang menggemaskan dan disukai (gambar di atas). Michelle adalah jurutera perisian yang membina API. Michelle benar-benar menikmati pekerjaannya dan telah mendapat inspirasi dari API membina kerjanya dalam melatih Slash.

Seperti yang anda ketahui, API adalah kumpulan perintah yang dapat diberikan pengguna kepada layanan web bersama dengan sekumpulan respons yang sesuai dengan permintaan. Michelle telah melatih Slash untuk melakukan perkara yang sama. Slash adalah anak yang baik, tahu pelbagai perintah, dan selalu bertindak balas dengan betul selagi anda memberinya permintaan agar dia diajar. Apabila dia semakin bersemangat, ekornya menjadi gila - ini bukan sesuatu yang Michelle ajarkan kepadanya berkaitan dengan API, itu hanya kerana dia adalah anak yang dicintai dan sangat menikmati latihannya!

Langkah 1: Tentukan API Apa yang Anda Perlu

Maklumat apa yang anda cari atau anda mahu ubah?

Adakah anda cuba merebut semua catatan Instagram @ dougthepug? Mungkin anda ingin membuat tweet secara automatik kepada sesiapa sahaja yang mengikuti twitter anjing anda (kerana walaupun anjing tidak dapat bercakap, mereka banyak mengatakan, kami tahu Slash pasti melakukannya).

Sekiranya anda sudah mengetahui laman web atau API yang ingin anda sambungkan, terus ke Langkah 2. Sekiranya anda ingin mencari data, tetapi tidak pasti dari mana hendak bermula, Google adalah rakan anda. Cari "[barang yang anda minati] API" dan lihat apa yang muncul. Anda mungkin terkejut berapa banyak maklumat di luar sana.

Sekiranya anda mahukan API contoh ringkas, anda boleh menggunakan yang dibuat oleh Michelle semasa melatih Slash. Ia mempunyai beberapa perintah kegemarannya seperti mengambil bola dan menggali lubang. Kami akan menggunakannya sepanjang contoh kami yang lain.

Langkah 2: Cari Dokumen API

API yang disediakan oleh syarikat terkenal harus mempunyai dokumentasi menyeluruh tentang cara menggunakannya.

Untuk mendapatkannya, google "[Insert Company] API dokumentasi" atau "[Insert Company] developer".

Hasilnya akan membawa anda ke portal pembangun. Cari pautan yang bertuliskan "Dokumen", "Dokumentasi", "Rujukan" atau "Rujukan Teknikal".

Di dalam dokumen, anda mungkin perlu mencari API khusus yang anda mahukan kerana kadang-kadang terdapat banyak pilihan. Facebook, misalnya, mempunyai API terpisah untuk pemasaran, iklan, halaman, dan banyak lagi.

Sekiranya API yang ingin anda sambungkan tidak terkenal (seperti Slash's), anda mungkin perlu meminta dokumentasi pembangun. Mereka mungkin mempunyai PDF yang mengandungi maklumat yang anda perlukan atau dokumentasi dalam talian yang tidak disenaraikan di laman web mereka.

Sekiranya anda terlepas pautan pada langkah sebelumnya, dokumen API Slash boleh didapati di sini.

Langkah 3: Cari Titik Akhir

Dokumen API mungkin kelihatan menakutkan, tetapi setelah anda mengetahui apa yang perlu dicari, dokumen tersebut biasanya tersusun dan standard.

Perkara pertama yang perlu dicari adalah titik akhir yang sesuai. Harus ada satu titik akhir yang sesuai dengan setiap jenis data yang anda inginkan. Titik akhir boleh kelihatan seperti ini:

slashtheapidog.com/api/bones/{id}

atau hanya

/ tulang

Dokumentasi harus mempunyai senarai titik akhir. Mereka mungkin berada di peringkat teratas dalam dokumen atau di bawah bahagian yang disebut "rujukan", "titik akhir", atau "kaedah". Untuk mencari titik akhir yang tepat, cari nama yang sesuai dengan data yang anda cari. Sebagai contoh, jika anda mahu senarai semua lubang yang digali Slash, / lubang mungkin adalah yang tepat. Walau bagaimanapun, setiap titik akhir harus mempunyai keterangan untuk membantu menjelaskan apa yang dilakukannya.

Dari dokumennya, ini adalah titik akhir dalam Slash's API yang berkaitan dengan lubang:

DAPATKAN

DAPATKAN

POST

TETAP

POST

Langkah 4: Tentukan Jenis Permintaan Anda

Setelah anda menemui titik akhir yang tepat, anda perlu menentukan jenis permintaan untuk menghantarnya.

Terdapat 4 jenis permintaan:

DAPATKAN

Permintaan GET adalah bagaimana anda meminta API bertindak balas dengan sesuatu yang dimilikinya, selalunya data. Anda boleh meminta maklumat khusus mengenai satu item atau sekumpulan item berdasarkan titik akhir dan parameter. Ini sama dengan meminta Slash membawa salah satu tulang atau seluruh tulangnya.

POS

Permintaan POST adalah bagaimana anda memberitahu API untuk membuat sesuatu yang baru. Ini sama dengan meminta Slash menggali (membuat) lubang baru untuk anda.

LETAK

Permintaan PUT adalah bagaimana anda memberitahu API untuk mengemas kini sesuatu yang sebelumnya dibuat. Ini mirip dengan meminta Slash menggali lebih mendalam (kemas kini) ke lubang yang digali.

HAPUS

Permintaan DELETE adalah bagaimana anda memberitahu API untuk menghapus sesuatu yang sebelumnya dibuat. Ini sama dengan meminta Slash menutup (menghapus) lubang yang sebelumnya digali.

Fikirkan empat jenis ini. Adakah anda mendapat maklumat, membuat entri baru, mengubah entri yang ada, atau menghapusnya? Jawapan itu memberitahu anda dengan tepat jenis permintaan yang anda perlukan.

Langkah 5: Fahami Parameter

Banyak permintaan memerlukan parameter tambahan. Parameter adalah perincian permintaan anda. Sebagai contoh, jika anda mahu Slash membawa anda semua bola yang berwarna merah, anda perlu menentukan warnanya. Sekiranya anda mahu dia membuat lubang baru, anda perlu memberitahunya di mana meletakkannya dan seberapa dalam untuk menggali.

Dokumentasi API yang anda rujuk harus memiliki bagian yang disebut "Parameter" atau "Options" untuk setiap titik akhir dan jenis permintaan. Perhatikan parameter mana yang diperlukan kerana beberapa pilihan adalah pilihan. Sekiranya parameter ditandakan sebagai pilihan, dokumen mungkin memberikan contoh yang juga merupakan lalai.

Parameter API Slash mungkin kelihatan seperti ini untuk mengambil bola:

DAPATKAN

Langkah 6: Format Permintaan Anda

Kami mendapat semua maklumat yang kami perlukan, sekarang kami hanya perlu membuat permintaan!

Berikut adalah dua cara berbeza untuk menyambung ke API yang tidak memerlukan kod. Mari kita sambung ke Slash's API untuk mendapatkan senarai bola dengan membuat permintaan GET ke

Parabola - jika anda ingin menyambung ke dan bekerja dengan data tanpa kod

Parabola adalah aplikasi web yang membolehkan anda menghubungkan dengan mudah ke API dan kemudian bekerja dengan data melalui alat visual, seret dan lepas.