Cara Mengembangkan API Menggunakan FastAPI Pada Python
Panduan langkah demi langkah untuk menyiapkan API Anda sendiri dari awal menggunakan Python FastAPI. Setelah menyelesaikan tutorial ini, Anda akan dapat menyiapkan API Anda sendiri dari awal. Kami akan memandu Anda sehingga Anda dapat mengembangkan API Anda sendiri berdasarkan FastAPI dan Python.
Apa itu API?
API adalah singkatan dari Antarmuka Pemrograman Aplikasi. Sisi backend aplikasi web, biasanya berjalan di server. API selalu digunakan untuk menyediakan ujung depan dan juga dapat digunakan sebagai antarmuka untuk diintegrasikan oleh pihak ketiga. API terdiri dari kumpulan layanan untuk mengambil atau mendorong data ke server backend.
apa yang kamu butuhkan?
Pertama, Anda perlu menginstal Python. Ikuti langkah-langkah yang dijelaskan di tautan berikut
Sekarang, karena kita menggunakan FastAPI, kita perlu menginstalnya, tapi apa itu FastAPI?
FastAPI didefinisikan di https://fastapi.tiangolo.com/
FastAPI adalah kerangka web modern, cepat (kinerja tinggi) untuk membangun API di Python 3.6+ berdasarkan petunjuk tipe Python standar.
Fitur utama meliputi:
- Cepat: Performa sangat tinggi setara dengan NodeJS dan Go (terima kasih kepada Starlette dan Pydantic). Salah satu framework Python tercepat yang tersedia.
- Pengodean lebih cepat: Pengembangan fitur sekitar 200% hingga 300% lebih cepat.
- Lebih sedikit bug: Mengurangi kesalahan manusia (pengembang) sekitar 40%.
- Intuitif: Dukungan editor yang luar biasa. Selesai di tempat. Mengurangi waktu debug.
- Mudah: Dirancang agar mudah digunakan dan mudah dipelajari. Lebih sedikit waktu yang dihabiskan untuk membaca dokumentasi.
- Pendek: meminimalkan duplikasi kode. Beberapa fungsi dari setiap deklarasi parameter. Lebih sedikit bug.
- Kuat: Dapatkan kode siap-produksi. Dengan dokumentasi interaktif otomatis.
- Berbasis standar: Berdasarkan OpenAPI (sebelumnya dikenal sebagai Swagger), standar terbuka untuk API, dan Skema JSON (sepenuhnya kompatibel).
Itu dapat diinstal dengan pip (penginstal package untuk Python).
pip install fastapiASGI (Asynchronous Server Gateway Interface) juga diperlukan untuk menjalankan API. Tutorial ini menggunakan Uvicorn.
pip install "uvicorn[standard]"Waktu pengkodean! (Bangun API Anda sendiri dengan FastAPI)
Contoh berikut menyiapkan API untuk menangkap HTTP POST dan GET dan hanya mengembalikan pesan untuk melihat apakah itu berfungsi (untuk melakukan ini, Anda perlu membuat file Python seperti fastapi_api.py ada).
# Import FastAPI
from fastapi import FastAPI
#create the app
app = FastAPI()
#Define your paths & methods for your API
@app.get('/getapi')
def getapi():
return {"message" : "GET API test"}
@app.post('/postapi')
def postapi():
return {"message" : "POST API test"}
Anda dapat menggunakan server uvicorn untuk menjalankan API dengan perintah berikut:
uvicorn fastapi_api:app --reloadUntuk "fastapi_api:app", fastapi_api adalah nama file Python (jangan tambahkan ".py") dan "app" adalah nama aplikasi FastAPI yang dibuat dalam kode Anda.
Trik: Gunakan opsi "reload" saat menjalankan server, karena aplikasi akan dimuat ulang setiap kali Anda mengubah dan menyimpan kode.
Hasilnya terlihat seperti ini:
Dan itu berhasil! URL API adalah 127.0.0.1:8000
penjelasan kode
Pertama, kita perlu mengimpor FastAPI.
# Import FastAPI
from fastapi import FastAPI Buat aplikasi.
app = FastAPI()Kemudian Anda perlu menentukan jalur API, seperti "127.0.0.1:8000/getapi".
@app.get('/getapi')Selain itu, untuk setiap pass, Anda perlu menentukan fungsi yang akan dipanggil saat API pass diminta.
def getapi():
return {"message" : "GET API test"}Perhatikan bahwa Anda dapat mengonfigurasi metode yang didukung oleh setiap pass (dalam contoh ini kami menentukan bahwa pass pertama mendukung metode GET dan pass kedua mendukung metode POST.
Menguji!
Sekarang Anda dapat menggunakan tool ini untuk menguji API Anda https://reqbin.com/
Berikut adalah hasil dari request GET:
Untuk request POST:
Anda bisa mendapatkan dokumentasi API interaktif (dihasilkan secara otomatis dan dilayani oleh Swagger UI) dengan membuka http://127.0.0.1:8000/docs.
Interaktif!
Anda juga dapat mencobanya (tekan tombol Try):
itu saja! Anda baru saja meluncurkan API pertama Anda :-) Ikuti saya dan tinggalkan komentar jika Anda membutuhkan lebih banyak. Beri tahu saya jika Anda ingin tutorial berikutnya.