Jika Anda telah menggunakan perangkat digital untuk mengirim dan menerima informasi, Anda telah menggunakan API. Pengembang membuat API untuk memungkinkan pengguna berinteraksi dengan data dari aplikasi mereka.

Membuat REST API adalah cara mudah untuk berbagi informasi. REST API telah menetapkan standar yang mengatur pembagian data antar perangkat. Untuk memahami cara kerja REST API, Anda dapat membuatnya dari awal.

Anda dapat menggunakan kerangka kerja Django REST untuk membuat REST API dan menggunakannya untuk menampilkan data dari database.

Menggunakan Django Dengan REST API

Kamu bisa gunakan REST API untuk mengambil data terstruktur melalui HTTP. Seperti banyak bahasa dan kerangka kerja, Django memungkinkan Anda membangun API Anda sendiri dan menggunakan yang lain.

Anda juga harus memiliki pra-instal berikut:

  1. Python versi terbaru.
  2. Versi terbaru dari pip.
  3. Pipenv (walaupun Anda bisa menggunakan venv sebagai gantinya jika Anda mau.)
  4. Versi terbaru dari Django.

Setelah Anda menginstal semua perangkat lunak penting, Anda siap untuk memulai.

instagram viewer

1. Instal Django REST Framework

kerangka kerja Django REST adalah perangkat canggih yang dapat Anda gunakan untuk membuat dan mengonfigurasi API web. Fitur-fiturnya yang dapat disesuaikan menjadikannya pilihan populer untuk membangun REST API.

Anda dapat menginstal kerangka kerja Django REST dengan perintah berikut:

pipenv Install djangorestframework

2. Buat Aplikasi Django

Instruksi berikut akan menjelaskan cara membuat aplikasi makanan untuk mengumpulkan nama dan deskripsi makanan populer Kenya. API akan mengambil permintaan dari database untuk memungkinkan pengguna berinteraksi dengan data tersebut.

Aplikasi Django dilengkapi dengan database SQLite, jadi Anda tidak perlu menginstal database lain.

Untuk membuat aplikasi Django, pertama buat proyek bernama makanan dengan perintah berikut:

django-admin memulai makanan proyek

Selanjutnya, buat aplikasi Django bernamakenyafood:

django-admin startapp kenyanfood

3. Daftarkan Pengaturan Proyek Aplikasi

Daftarkankenyafoodaplikasi dalam pengaturan proyek di bawah APLIKASI YANG DIINSTAL Himpunan. Jika Anda melewati langkah ini, Django tidak akan mengenali aplikasi. Juga, daftarkan kerangka kerja Django REST dalam pengaturan yang sama:

# Definisi aplikasi
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'kenyafood',
'rest_framework',
]

4. Daftarkan URL Aplikasi

Daftar kenyafood URL aplikasi dalam proyek urls.py berkas seperti ilustrasi di bawah ini:

dari django.contrib impor admin
dari django.urls impor jalan, termasuk
pola url = [
 jalur('admin/', admin.situs.url),
 jalur('', termasuk('kenyafood.urls')),
]

5. Buat Tampilan untuk API

Buat tampilan tiruan di aplikasi views.py file, sehingga aplikasi tidak membuang kesalahan. Pertama, impor file Tanggapan keberatandan@apiview dekorator dari kerangka Django REST.

Tanggapan membantu mengembalikan data yang disterilkan di JSON format sementara @apiview menampilkan API.

dari django.shortcuts impor memberikan
dari rest_framework.respons impor Tanggapan
dari rest_framework.decorators impor api_view
# Buat tampilan Anda di sini.
@api_view(['MENDAPATKAN'])
defmendapatkan makanan(meminta):
kembali Tanggapan()

6. Buat Jalur URL untuk Aplikasi

Buat jalur URL untuk tampilan API yang Anda buat. Titik akhir ini menampilkan kenyafooddata.

dari django.urls impor jalur
dari. impor pandangan
dari django.conf impor pengaturan
pola url = [
 jalur('', views.getFood),
 jalur('pos/', views.postFood),
]

7. Buat Model untuk Aplikasi

Kelas model aplikasi dipanggil Makanan. Seharusnya terlihat seperti ini:

dari django.db impor model
# Buat model Anda di sini.
kelasMakanan(model. Model):
 nama = model. CharField (max_length=200)
 deskripsi = model. CharField (max_length=500)

Daftarkan model di aplikasi admin.py berkas seperti yang ditunjukkan di bawah ini:

dari django.contrib impor admin
dari .model impor Makanan
# Daftarkan model Anda di sini.
admin.lokasi.daftar(Makanan)

8. Lakukan Migrasi

Berikutnya, migrasi aplikasi untuk membuat tabel di SQLite basis data. Anda dapat melakukannya dengan menggunakan perintah berikut:

pythonmengelola.pymakemigrationskenyafood

Selanjutnya, terapkan migrasi ini dengan menjalankan perintah ini:

pythonmengelola.pymigrasi

Migrasi yang berhasil akan terlihat seperti ini:

Migrasi yang berhasil berarti bahwa database telah membuat tabel untuk kenyafoodAplikasi.

9. Tambahkan Data ke Basis Data

Menggunakan Admin Django GUI untuk memasukkan data ke dalam database. Admin Django memiliki antarmuka yang bagus untuk memvisualisasikan dan mengelola data aplikasi Anda.

Sebagai alternatif, Anda dapat menggunakan shell python pada baris perintah untuk memasukkan data secara manual ke dalam database. Dalam panduan ini, Anda akan menggunakan antarmuka admin Django.

Gunakan perintah berikut untuk menyiapkan admin Django:

pythonmengelola.pycreatesuperuser

Saat diminta, masukkan milik Anda nama pengguna, email, dan kata sandi. Anda kemudian dapat membuka halaman admin menggunakan tautan di bawah ini:

http://127.0.0.1:8000/admin/

Anda akan melihat halaman login:

Setelah Anda masuk, Anda akan melihat antarmuka administrasi Django dengan Grup Dan Pengguna model. Keduanya untuk otentikasi; itu Makanan model ada di bagian bawah.

Anda dapat menambah dan menghapus Makanan item dari database dari halaman admin. Tambahkan beberapa makanan lezat Kenya, seperti Ugali, Pilau, dan Chai, ke database.

Sekarang database memiliki data, buat API

10. Serialkan Model

Serializer mengonversi model Django kompleks menjadi JSON objek, membuat data mudah dibaca di API. Serialisasi membuat data lebih mudah dibaca di API.

Buat file baru di aplikasi bernama serializer.py

dari rest_framework impor serializer
dari .model impor Makanan
kelasFoodSerializer(serializer. ModelSerializer):
kelasMeta:
 model=Makanan
 bidang=('nama','keterangan')

Anda mengimpor serializer modul dari rest_framework paket dan buat a FoodSerializer kelas yang mewarisi dari ModelSerializer kelas.

Selanjutnya, tentukan Makanan model yang ingin Anda buat bersambung dan bidang yang ingin Anda tambahkan ke API.

11. Perbarui Tampilan

Selanjutnya, perbarui tampilan API dengan serializer Dan Makanan model.

Pertama, tentukan a MENDAPATKAN metode untuk mengambil semua data dari database dengan Makanan. Objek.semua() fungsi. Kemudian buat serial data dan kembalikan sebagai respons di JSON format.

dari django.shortcuts impor memberikan
dari rest_framework.respons impor Tanggapan
dari rest_framework.decorators impor api_view
dari .model impor Makanan
dari .serializer impor FoodSerializer
# Buat tampilan Anda di sini.
@api_view(['MENDAPATKAN'])
defmendapatkan makanan(meminta):
 makanan = Makanan.objek.semua()
 serializer = FoodSerializer (makanan, banyak=BENAR)
kembali Tanggapan (serializer.data)

Kemudian, navigasikan ke tautan URL server:

https://127.0.0.1:8000/

Anda akan melihat API menampilkan data dari database:

Selamat, Anda telah membuat REST API!

12. Tambahkan Data Dengan Metode POST

Uji apakah Anda bisa menggunakan REST API untuk menambahkan data ke database.

Pertama, tentukan a POS metode dalam tampilan.

@api_view(['POS'])
defpostFood(meminta):
 serializer = FoodSerializer (data=request.data)
jikaserializer.adalah benar():
serializer.menyimpan()
kembali Tanggapan (serializer.data)

Kemudian, tambahkan jalur di aplikasi urls.py untuk membuat titik akhir untuk API POS Kegunaan.

pola url = [
 jalur('',views.getFood),
 jalur('pos/',views.postFood),
]

Selanjutnya, arahkan ke URL ini:

https://127.0.0.1:8000/post

Anda akan melihat POS titik akhir. Menambahkan data ke database di JSON format di Isi bagian dan klik POS tombol. Misalnya, tambahkan item makanan baru dengan struktur ini:

{ "nama":"Maziwa mala", "keterangan":"Susu asam" }

Anda akan melihat data ditampilkan dalam warna merah JSON format.

Sekarang, jika Anda menavigasi kembali ke MENDAPATKAN titik akhir http://127.0.0.1:8000/, Anda akan melihat makanan 'Maziwa mala,’ dan Deskripsinya ditambahkan.

Anda sekarang memiliki REST API yang dapat menampilkan dan menambahkan item ke aplikasi. Bagaimana kalau bereksperimen dengan yang lain CRUD metode? Bekerja dengan MEMPERBARUI Dan MENGHAPUS metode akan meningkatkan fungsionalitas REST API Anda.

Cara Membuat REST API Dengan Django

Anda sekarang dapat membuat REST API menggunakan Django. Pertama, buat Aplikasi dengan model, Serialkan data, dan buat fungsi tampilan. Selanjutnya, sertakan endpoint URL untuk memvisualisasikan data dalam format JSON.

Membangun API REST dengan kerangka kerja Django REST adalah cara mudah untuk berbagi data dan memberi pengguna Anda pengalaman pelanggan yang luar biasa.