Bekerja dengan API dalam Python: Panduan Praktikal

Petikan:
“API menjadikan aplikasi perisian modular. Mereka mempercepatkan masa pembangunan perisian”.

Antara Muka Pengaturcaraan Aplikasi (atau API) ialah lapisan abstrak yang membolehkan komunikasi antara aplikasi dan komponen perisian yang berbeza. Bagaimanakah komunikasi ini berlaku? API Web yang kebetulan menjadi perkara yang akan kita bahas dalam artikel ini, terletak di antara sekeping aplikasi perisian yang digunakan oleh pelanggan dan pangkalan data tempat maklumat disimpan. Baca tentang pelbagai jenis API di sini. Komunikasi berlaku tanpa mengira bahasa pengaturcaraan di mana aplikasi perisian individu ditulis; sama ada Python, Java, JavaScript dll. Dengan syarat permintaan yang dihantar daripada aplikasi perisian kepada API adalah sah, sama ada operasi mendapatkan semula, mengemas kini, memadam atau mencipta.

Bayangkan platform media sosial seperti Instagram di mana pengguna tertentu menyiarkan gambar, apa yang berlaku secara dalaman ialah pengguna membuat permintaan POST ke titik akhir API Instagram yang ditetapkan; menghantar gambar ke pangkalan data. Pengguna lain dapat melihat siaran dengan membuat permintaan GET kepada API tanpa mengetahuinya semasa menatal pada garis masa. Anda nampak bahawa terdapat komunikasi di sana—melalui API.

Ini juga boleh berlaku walaupun kedua-dua pengguna berkomunikasi melalui API dengan aplikasi perisian yang ditulis dalam bahasa yang berbeza.
Ilustrasi di bawah menunjukkan dua aplikasi perisian berbeza yang berkomunikasi melalui API.

Foto oleh pengarang

Tambahan pula—API menjadikan aplikasi perisian modular. Mereka mempercepatkan masa pembangunan perisian. Modular dalam erti kata bahawa pelaksanaan API dipisahkan daripada asas kod kami, kami hanya perlu membuat panggilan ke API. Ia mempercepatkan masa pembangunan kerana kami tidak perlu menulis kod yang menyediakan fungsi yang serupa dengan yang API lakukan dari awal, kami hanya perlu menggunakan kod tersebut.

Dalam artikel ini, anda akan belajar cara menggunakan API yang tersedia secara umum menggunakan Python. Nantikan.

Prasyarat

Artikel ini sesuai untuk pengaturcara Python peringkat pemula yang ingin meluaskan pemahaman mereka tentang API dengan pelaksanaan khusus dalam Python.
Untuk berlatih bersama, pastikan mesin anda disambungkan ke Internet.

Artikel ini juga berfungsi sebagai penyegar untuk pembangun Python yang lebih berpengalaman.

Objektif

Dengan meneruskan ke penghujung artikel ini, anda harus:
Ketahui tentang perpustakaan permintaan dalam Python.
Tahu cara membuat permintaan GET, PUT, PATCH, DELETE dan POST.
Belajar untuk menyimpan dan menggunakan data yang diterima daripada panggilan API di dalam kod anda.

Memahami perpustakaan permintaan

permintaan ialah salah satu pakej Python yang paling banyak dimuat turun dengan kira-kira 30J muat turun setiap minggu mengikut pypi. Ia membolehkan anda menghantar permintaan HTTP dengan mudah dalam Python. requests ialah pakej Python yang diuji dan dipercayai, digunakan oleh banyak jenama terkenal seperti IBM. Cari kod sumber di sini.
Beberapa ciri permintaan yang "disayangi" ialah:

• Keep-Alive & Connection Pooling

• Domain dan URL Antarabangsa

• Sesi dengan Kegigihan Kuki

• Pengesahan SSL gaya penyemak imbas

• Penyahkodan Kandungan Automatik

• Pengesahan Asas/Digest

• Kuki Kunci/Nilai Elegan

• Penyahmampatan Automatik

• Badan Tindak Balas Unikod

• Sokongan Proksi HTTP(S)

• Muat Naik Fail Berbilang Bahagian

• Muat Turun Penstriman

• Tamat Masa Sambungan

• Chunked Request

• Sokongan .netrc

Bermula dengan permintaan

Saya menganggap anda sudah memasang Python pada mesin anda. Pasang pakej permintaan dengan mengikut arahan di bawah:
Pada Linux atau Mac OS buka terminal anda dan lakukan:

python3 -m pip install requests

Pada Windows lakukan:

python -m pip install requests

Ini memuat turun pakej permintaan ke mesin anda.

Membuat permintaan GET

Permintaan GET dibuat untuk mendapatkan semula data sedia ada. Ia mengembalikan objek yang boleh diterokai lebih lanjut untuk mendapatkan butiran lanjut tentang permintaan yang dibuat dengan memanggil atribut yang dikehendaki padanya. Lihat contoh penggunaan di bawah:

• Buat fail Python, sebagai contoh, get_request.py, dalam fail, tulis kod berikut:

# Import the requests module
import requests

# Making a simple GET request
response_object = requests.get("https://jsonplaceholder.typicode.com/posts")

Daripada respons_objek, atribut yang berbeza boleh dipanggil:
status_code: Kod status HTTP respons.

• .teks: Badan tindak balas sebagai rentetan.
• .json(): Menghuraikan isi respons sebagai JSON (jika berkenaan).
• .kandungan: Badan tindak balas sebagai bait mentah.
• .headers: Kamus pengepala respons.
• .kuki: Kuki yang ditetapkan oleh pelayan.
• .url: URL akhir selepas ubah hala.
• .berlalu Dalam artikel ini, kami akan lebih memfokuskan pada atribut .json(). Dalam fail requests.py anda, panggil atribut .json() pada response_object

json_data = response_object.json()
print(json_data)

JSON yang dikembalikan disimpan dalam pembolehubah json_data, dan boleh digunakan di dalam program anda.
Perkara berikut akan dikeluarkan ke konsol anda.

Membuat permintaan POST

Permintaan POST menghantar data ke titik akhir yang ditentukan, mencipta rekod baharu. Tidak seperti kaedah GET yang bertujuan untuk mendapatkan semula data sedia ada. Ikuti langkah di bawah untuk membuat permintaan siaran:

• Buat fail baharu bernama post_request.py atau mana-mana nama yang sesuai. Tulis kod berikut dalam fail:

python3 -m pip install requests

Ini menghantar data ke titik akhir yang ditetapkan dan juga mengembalikan objek tindak balas; objek ini mempunyai beberapa maklumat berfaedah tentang permintaan POST yang dihantar. Ia boleh diakses dengan memanggil atribut yang sesuai pada objek.
Panggil atribut status_code pada objek respons untuk memastikan operasi itu berjaya. Kemas kini kod anda.

python -m pip install requests

Ia mengembalikan 201, yang menunjukkan bahawa permintaan POST anda telah berjaya dan sumber baharu telah dibuat. Seperti yang ditunjukkan dalam imej di bawah.

Membuat permintaan PUT

Permintaan PUT melibatkan penggantian rekod sedia ada dengan rekod baharu; ia mengambil data baharu daripada pengirim atau pelanggan dan menggantikan data sedia ada dengannya.
Beginilah cara anda membuat permintaan PUT:

• Buat fail Python baharu, untuk artikel ini, kami menggunakan put_request.py. Tulis kod berikut di dalamnya.

# Import the requests module
import requests

# Making a simple GET request
response_object = requests.get("https://jsonplaceholder.typicode.com/posts")

Membuat permintaan DELETE

Ini memastikan penyingkiran rekod atau data tertentu. Rekod yang akan dialih keluar sentiasa ditentukan melalui ID uniknya, yang biasanya dinyatakan.
Beginilah cara anda melakukan operasi PADAM:

• Buat fail Python baharu, untuk artikel ini, kami menggunakan delete_request.py. Tulis kod berikut di dalamnya:

json_data = response_object.json()
print(json_data)

Membuat permintaan PATCH

Gunakan kaedah PATCH pada bila-bila masa anda ingin membuat perubahan separa pada rekod atau data sedia ada.

• Buat fail Python baharu, untuk artikel ini, kami menggunakan patch_request.py. Tulis kod berikut di dalamnya:

# Import the requests module
import requests


# Making a simple POST request


data = {'userId': 1, 'id': 1, 'title': 'This is for POST request', \
        'body': 'This body is modified for this technical writing article by Augustine Alul'}
response_object = requests.post("https://jsonplaceholder.typicode.com/posts/", data=data)


print(response_object.status_code)

Kesimpulan

Pustaka permintaan menyediakan cara ringkas untuk membuat permintaan HTTP dalam kod Python anda; ia membolehkan interaksi mudah dengan API dan mengembalikan objek yang menyediakan maklumat berguna tentang permintaan yang dibuat, dengan hanya memanggil atribut yang diingini (atribut boleh didapati dalam artikel).
Bekerja dengan API dalam Python tidak pernah menjadi lebih mudah—terdapat perpustakaan popular lain untuk berinteraksi dengan API dalam Python, tetapi perpustakaan permintaan telah dipilih untuk kesederhanaannya.
Terima kasih kerana kekal sehingga akhir artikel ini, ini memberi anda latar belakang yang baik untuk mula bekerja dengan API dalam Python.

Atas ialah kandungan terperinci Bekerja dengan API dalam Python: Panduan Praktikal. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!