Bilgi göndermek ve almak için bir dijital cihaz kullandıysanız, bir API kullanmışsınız demektir. Geliştiriciler, kullanıcıların uygulamalarından gelen verilerle etkileşim kurmasını sağlamak için API'ler oluşturur.

REST API oluşturmak, bilgi paylaşmanın uygun bir yoludur. REST API'leri, cihazlar arasında veri paylaşımını düzenleyen tanımlı standartlara sahiptir. REST API'lerinin nasıl çalıştığını anlamak için sıfırdan bir tane oluşturabilirsiniz.

Bir REST API oluşturmak için Django REST çerçevesini kullanabilir ve bunu bir veritabanındaki verileri görüntülemek için kullanabilirsiniz.

Django'yu REST API ile Kullanmak

Yapabilirsiniz yapılandırılmış verileri getirmek için bir REST API kullanın HTTP üzerinden. Birçok dil ve çerçeve gibi, Django da kendi API'nizi oluşturmanıza ve diğerlerini kullanmanıza izin verir.

Ayrıca aşağıdakiler de önceden yüklenmiş olmalıdır:

  1. Python'un en son sürümü.
  2. pip'in son sürümü.
  3. Pipenv (ancak isterseniz venv kullanabilirsiniz.)
  4. Django'nun en son sürümü.

Gerekli tüm yazılımları yükledikten sonra, başlamaya hazırsınız.

instagram viewer

1. Django REST Çerçevesini Kurun

Django REST çerçevesi web API'leri oluşturmak ve yapılandırmak için kullanabileceğiniz güçlü bir araç takımıdır. Özelleştirilebilir özellikleri, onu REST API'leri oluşturmak için popüler bir seçim haline getirir.

Django REST çerçevesini aşağıdaki komutla kurabilirsiniz:

pipenv düzenlemek djangorestçerçevesi

2. Bir Django Uygulaması Oluşturun

Aşağıdaki talimatlar, popüler Kenya yemeklerinin adlarını ve açıklamalarını toplamak için bir yemek uygulamasının nasıl oluşturulacağını açıklayacaktır. API, kullanıcıların bu verilerle etkileşim kurmasını sağlamak için bir veritabanından istekler getirecektir.

Django uygulamaları bir SQLite veritabanı ile donatılmış olarak gelir, böylece başka bir veritabanı kurmanız gerekmez.

Bir Django uygulaması oluşturmak için önce adında bir proje oluşturun. yiyecek aşağıdaki komutla:

django-admin startproject yemeği

Ardından, adlı bir Django uygulaması oluşturun.Kenya yemeği:

django-admin startapp kenyanfood

3. Uygulama Proje Ayarlarını Kaydedin

Kayıt olKenya yemeğialtındaki proje ayarlarında uygulama YÜKLÜ UYGULAMALAR sıralamak. Bu adımı atlarsanız, Django uygulamayı tanımaz. Ayrıca Django REST çerçevesini aynı ayarlara kaydedin:

# Uygulama tanımı
INSTALED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'Kenya yemeği',
'rest_framework',
]

4. Uygulama URL'lerini Kaydet

Kayıt olmak Kenya yemeği projedeki uygulama URL'leri urls.py aşağıda gösterildiği gibi dosya:

itibaren django.contrib içe aktarmak yönetici
itibaren django.urls içe aktarmak yol, dahil
url kalıpları = [
 yol('yönetici/', admin.site.urls),
 yol('', katmak('kenyanfood.urls')),
]

5. API için bir Görünüm oluşturun

Uygulamada sahte bir görünüm oluşturun görünümler.py dosya, böylece uygulama hata atmaz. İlk olarak, içe aktarın Cevap itiraz etmek@apiview Django REST çerçevesinden dekoratör.

Cevap sterilize edilmiş verilerin geri döndürülmesine yardımcı olur JSON biçimlendirirken @apiview API'yi görüntüler.

itibaren django.kısayollar içe aktarmak işlemek
itibaren rest_framework.response içe aktarmak Cevap
itibaren rest_framework.decorators içe aktarmak api_view
# Görünümlerinizi burada oluşturun.
@api_view(['ELDE ETMEK'])
kesinyiyecek almak(rica etmek):
geri dönmek Cevap()

6. Uygulama için bir URL Yolu oluşturun

Oluşturduğunuz API görünümü için bir URL yolu oluşturun. Bu bitiş noktası, Kenya yemeğiveri.

itibaren django.urls içe aktarmak yol
itibaren. içe aktarmak Görüntüleme
itibaren django.conf içe aktarmak ayarlar
url kalıpları = [
 yol('', görünümler.getYiyecek),
 yol('postalamak/', görünümler.postYiyecek),
]

7. Uygulama için bir Model oluşturun

Uygulamanın model sınıfına denir Yiyecek. Bu şöyle görünmelidir:

itibaren django.db içe aktarmak modeller
# Modellerinizi burada oluşturun.
sınıfYiyecek(modeller. modeli):
 isim = modeller. CharField (maks_uzunluk=200)
 açıklama = modeller. CharField (maks_uzunluk=500)

Modeli uygulamada kaydedin admin.py aşağıda gösterildiği gibi dosya:

itibaren django.contrib içe aktarmak yönetici
itibaren .modeller içe aktarmak Yiyecek
# Modellerinizi buraya kaydedin.
yönetici.alan.kayıt olmak(Yiyecek)

8. Geçiş Yap

Sonraki, göç içinde tablolar oluşturmak için uygulama SQLite veri tabanı. Bunu aşağıdaki komutu kullanarak yapabilirsiniz:

pitonüstesinden gelmek.pygöç yapmakKenya yemeği

Ardından, bu komutu çalıştırarak bu geçişleri uygulayın:

pitonüstesinden gelmek.pygöç

Başarılı bir geçiş şöyle görünecektir:

Başarılı geçişler, veritabanının aşağıdakiler için tablolar oluşturduğu anlamına gelir: Kenya yemeğiUygulama.

9. Veritabanına Veri Ekleme

Kullan Django yöneticisi Veritabanına veri girmek için GUI. Django yöneticisi uygulamanızın verilerini görselleştirmek ve yönetmek için harika bir arayüze sahiptir.

Alternatif olarak, verileri veritabanına manuel olarak girmek için komut satırındaki python kabuğunu kullanabilirsiniz. Bu kılavuzda, Django yönetici arayüzünü kullanacaksınız.

Django admin'i ayarlamak için aşağıdaki komutu kullanın:

pitonüstesinden gelmek.pysüper kullanıcı oluşturur

İstendiğinde, kullanıcı adı, e-posta ve şifre. Daha sonra aşağıdaki bağlantıyı kullanarak yönetici sayfasını açabilirsiniz:

http://127.0.0.1:8000/admin/

Giriş sayfasını göreceksiniz:

Oturum açtıktan sonra, Django yönetim arayüzünü göreceksiniz. Gruplar Ve Kullanıcılar modeli. Bunların her ikisi de kimlik doğrulama içindir; the Yiyecek modeli aşağıdaki bölümdedir.

ekleyebilir ve silebilirsiniz Yiyecek yönetici sayfasından veritabanındaki öğeler. Veritabanına Ugali, Pilau ve Chai gibi bazı Kenya lezzetlerini ekleyin.

Artık veritabanında veriler olduğuna göre API'yi oluşturun

10. Modeli Serileştirin

seri hale getiriciler karmaşık Django modellerini dönüştürmek JSON API'de verilerin kolayca okunmasını sağlayan nesneler. Seri hale getirme, verileri API'de daha okunaklı hale getirir.

adlı uygulamada yeni bir dosya oluşturun. seri hale getirici.py

itibaren rest_framework içe aktarmak serileştiriciler
itibaren .modeller içe aktarmak Yiyecek
sınıfGıda Serileştiricisi(seri hale getiriciler. ModelSerializer):
sınıfMeta:
 model=Yiyecek
 alanlar=('isim','Tanım')

Siz içe aktarın serileştiriciler gelen modül rest_framework paketleyin ve oluşturun Gıda Serileştiricisi miras aldığı sınıf ModelSerializer sınıf.

Ardından, Yiyecek seri hale getirmek istediğiniz model ve API'ye eklemek istediğiniz alanlar.

11. Görünümü Güncelle

Ardından, API görünümünü şu şekilde güncelleyin: seri hale getirici Ve Yiyecek modeller.

İlk önce bir tanımla ELDE ETMEK ile veritabanından tüm verileri almak için yöntem Yiyecek. Objects.all() işlev. Ardından verileri serileştirin ve bir yanıt olarak döndürdü. JSON biçim.

itibaren django.kısayollar içe aktarmak işlemek
itibaren rest_framework.response içe aktarmak Cevap
itibaren rest_framework.decorators içe aktarmak api_view
itibaren .modeller içe aktarmak Yiyecek
itibaren .serializer içe aktarmak Gıda Serileştiricisi
# Görünümlerinizi burada oluşturun.
@api_view(['ELDE ETMEK'])
kesinyiyecek almak(rica etmek):
 yiyecek = Yiyecek.objects.all()
 serializer = FoodSerializer (yiyecek, birçok=Doğru)
geri dönmek Yanıt (serializer.data)

Ardından, sunucu URL bağlantısına gidin:

https://127.0.0.1:8000/

Veritabanındaki verileri gösteren API'yi göreceksiniz:

Tebrikler, bir REST API oluşturdunuz!

12. POST Yöntemiyle Veri Ekleme

Veritabanına veri eklemek için REST API'yi kullanıp kullanamayacağınızı test edin.

İlk önce bir tanımla POSTALAMAK görünümdeki yöntem.

@api_view(['POSTALAMAK'])
kesinyemek sonrası(rica etmek):
 serileştirici = FoodSerializer (veri=request.data)
eğerseri hale getirici.is_geçerlidir():
seri hale getirici.kaydetmek()
geri dönmek Yanıt (serializer.data)

Ardından, uygulamada bir yol ekleyin urls.py API için bir uç nokta oluşturmak için POSTALAMAK işlevsellik.

url kalıpları = [
 yol('',views.getFood),
 yol('postalamak/',views.postFood),
]

Ardından, şu URL'ye gidin:

https://127.0.0.1:8000/post

göreceksin POSTALAMAK uç nokta. Veritabanına veri ekleme JSON biçiminde İçerik bölümüne tıklayın ve POSTALAMAK düğme. Örneğin, bu yapıya sahip yeni bir gıda maddesi ekleyin:

{ "isim":"maziwa mala", "Tanım":"Bozuk süt" }

Verilerin kırmızı renkte görüntülendiğini göreceksiniz. JSON biçim.

Şimdi, şuraya geri giderseniz ELDE ETMEK bitiş noktası http://127.0.0.1:8000/, yemeği göreceksin’Maziwa mala,' ve açıklaması eklendi.

Artık öğeleri görüntüleyebilen ve uygulamaya ekleyebilen bir REST API'niz var. Diğerlerini denemeye ne dersiniz? REZİL yöntemler? İle çalışan GÜNCELLEME Ve SİLMEK yöntemler, REST API'nizin işlevselliğini artıracaktır.

Django ile REST API Nasıl Oluşturulur

Artık Django kullanarak bir REST API oluşturabilirsiniz. İlk olarak, bir model içeren bir Uygulama oluşturun, verileri seri hale getirin ve bir görüntüleme işlevi oluşturun. Ardından, verileri JSON biçiminde görselleştirmek için URL uç noktalarını ekleyin.

Django REST çerçevesiyle REST API'leri oluşturmak, verileri paylaşmanın ve kullanıcılarınıza harika bir müşteri deneyimi sunmanın uygun bir yoludur.