FastAPI Dokümantasyonu: Hızlı ve Kolay API Geliştirme için Nihai Kılavuz

API dokümantasyonunun karmaşıklığına hiç kapıldınız mı? Yalnız değilsiniz! İster deneyimli bir geliştirici olun ister yeni başlıyor olun, API geliştirmesinin inceliklerinde gezinmek göz korkutucu bir görev olabilir. Ancak korkmayın, çünkü bugün hayatınızı çok daha kolay hale getirmek için tasarlanmış bir araç olan FastAPI dokümantasyonuna derinlemesine dalıyoruz.

FastAPI Nedir?

FastAPI , Python 3.6+ ile standart Python tür ipuçlarını temel alarak API'ler oluşturmak için modern, hızlı (yüksek performanslı) bir web çerçevesidir. Kodunuzun sağlam ve bakımı yapılabilir kalmasını sağlarken, kullanımı kolay ve sezgisel olacak şekilde tasarlanmıştır. FastAPI'nin hızı, Node.js ve Go ile aynı seviyededir ve genellikle diğer birçok Python çerçevesinden daha hızlıdır. Bunu, eşzamansız programlama ve tür ipuçlarını kullanması sayesinde başarır.

Neden FastAPI'yi Seçmelisiniz?

API geliştirmeniz için FastAPI'yi seçmenin çeşitli avantajları vardır:

1. Hız: FastAPI, en hızlı Python web çerçevelerinden biridir.
2. Kullanım Kolaylığı: Dokümantasyon kapsamlıdır ve takip etmesi kolaydır.
3. Veri Doğrulama: Pydantic ile FastAPI, istek verilerini otomatik olarak doğrular.
4. Eşzamansız Destek: FastAPI, eşzamansız programlamayı yerel olarak destekler.
5. Otomatik Dokümantasyon: FastAPI, Swagger UI ve ReDoc kullanarak etkileşimli API dokümantasyonu oluşturur.

FastAPI'ye Başlarken

Kurulum

Her şeyden önce, uygulamanıza hizmet etmek için FastAPI ve bir ASGI sunucusu yüklemeniz gerekir. Uvicorn bunun için harika bir seçimdir.

pip install fastapi
pip install uvicorn

İlk API'nizi Oluşturma

Basit bir API oluşturmaya dalalım. main.py adlı yeni bir Python dosyası oluşturun ve aşağıdaki kodu ekleyin:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

Uygulamayı çalıştırmak için aşağıdaki komutu kullanın:

uvicorn main:app --reload

Tarayıcınızda http://127.0.0.1:8000 adresini ziyaret edin; {"Hello": "World"} görmelisiniz. Tebrikler, ilk FastAPI uygulamanızı oluşturdunuz!

Otomatik Olarak Oluşturulan Dokümantasyonu Keşfetme

FastAPI'nin öne çıkan özelliklerinden biri, otomatik olarak oluşturulan etkileşimli API dokümantasyonudur. FastAPI, varsayılan olarak iki tür dokümantasyon oluşturur:

1. Swagger UI: http://127.0.0.1:8000/docs adresinde mevcuttur
2. ReDoc: http://127.0.0.1:8000/redoc adresinde mevcuttur

Bu belgeler, API'nizi test etmek ve ekibinizle paylaşmak için inanılmaz derecede kullanışlıdır.

FastAPI'de Parametre Geçirme

FastAPI, API uç noktalarınızda parametre geçirmeyi kolaylaştırır. Parametreleri yol parametreleri, sorgu parametreleri ve istek gövdeleri gibi farklı şekillerde geçirebilirsiniz.

Yol Parametreleri

Yol parametreleri, URL yolundan çıkarılır. Örneğin, /items/{item_id} URL'sinde, item_id bir yol parametresidir.

@app.get("/items/{item_id}")
def read_item(item_id: int):
    return {"item_id": item_id}

Sorgu Parametreleri

Sorgu parametreleri, sorgu dizesinden çıkarılır. Örneğin, /items/?q=search URL'sinde, q bir sorgu parametresidir.

@app.get("/items/")
def read_item(q: str = None):
    return {"q": q}

İstek Gövdeleri

İstek gövdeleri, sunucuya veri göndermek için kullanılır. FastAPI, JSON gövdeleriyle çalışmayı kolaylaştırır.

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
def create_item(item: Item):
    return item

FastAPI Dokümantasyon En İyi Uygulamaları

Kapsamlı ve kullanıcı dostu dokümantasyon oluşturmak, herhangi bir API için esastır. FastAPI uygulamanızı belgelendirirken izlenecek bazı en iyi uygulamalar şunlardır:

Açık ve Tanımlayıcı Başlıklar Kullanın

Başlıklarınızın uç noktaları ve işlevlerini açıkça tanımladığından emin olun. Bu, kullanıcıların her bir uç noktanın amacını bir bakışta anlamasına yardımcı olur.

Ayrıntılı Açıklamalar Sağlayın

Uç noktalarınızın, parametrelerinizin ve istek/yanıt gövdelerinizin ayrıntılı açıklamalarını ekleyin. Bu, kullanıcıların API'nizi etkili bir şekilde nasıl kullanacaklarını anlamalarına yardımcı olur.

Örnekler Ekleyin

İstek ve yanıt örnekleri sağlamak, kullanıcılar için inanılmaz derecede faydalı olabilir. Örnekler, uç noktaların nasıl kullanılacağını ve karşılığında ne bekleneceğini gösterir.

FastAPI'nin Dokümantasyon Özelliklerinden Yararlanın

FastAPI, dokümantasyonunuzu geliştirmek için çeşitli yerleşik özellikler sağlar. Kapsamlı ve etkileşimli belgeler oluşturmak için bu özellikleri kullanın.

Etiketler

Uç noktalarınızı etiketler kullanarak gruplandırabilirsiniz. Etiketler, dokümantasyonunuzu düzenlemeye ve gezinmeyi kolaylaştırmaya yardımcı olur.

@app.get("/items/", tags=["items"])
def read_items():
    return ["item1", "item2"]

Özetler ve Açıklamalar

Daha fazla bağlam sağlamak için uç noktalarınıza özetler ve açıklamalar ekleyebilirsiniz.

@app.post("/items/", summary="Create an item", description="Create an item with name, description, price, and tax.")
def create_item(item: Item):
    return item

Yanıt Açıklamaları

Farklı yanıt durum kodları için açıklamaları belirtebilirsiniz.

from fastapi import HTTPException

@app.get("/items/{item_id}", response_description="The retrieved item")
def read_item(item_id: int):
    if item_id not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}

FastAPI'yi Apidog ile Entegre Etme

Artık FastAPI ve dokümantasyon özelliklerine aşina olduğunuza göre, Apidog 'un API geliştirme deneyiminizi nasıl geliştirebileceğinden bahsedelim. Apidog, API'lerinizi tasarlama, test etme ve yönetme sürecini basitleştiren hepsi bir arada bir API yönetim aracıdır.

Standart API Dokümantasyonunu Otomatik Olarak Oluşturma

Adım 1: Apidog'a Kaydolun

API dokümantasyonu oluşturmak için Apidog'u kullanmaya başlamak için, henüz yapmadıysanız bir hesap açmanız gerekir. Giriş yaptıktan sonra, Apidog'un kullanıcı dostu arayüzü sizi karşılayacaktır.

Adım 2: API İsteğinizi Oluşturma

Bir API dokümantasyon projesi, her biri belirli bir API rotasını veya işlevselliğini temsil eden çeşitli uç noktalardan oluşur. Bir uç nokta eklemek için, projeniz içindeki "+" düğmesine veya "Yeni API"ye tıklayın.

Adım 3: İstek Parametrelerini Ayarlama

Uç noktanın URL'si, açıklaması ve istek/yanıt ayrıntıları gibi ayrıntıları sağlamanız gerekir. Şimdi kritik kısım geliyor - uç noktalarınızı belgeleme. Apidog bu süreci inanılmaz derecede kolaylaştırır. Her uç nokta için şunları yapabilirsiniz:

• HTTP yöntemini belirtin (GET, POST, PUT, DELETE, vb.).
• Adlarını, türlerini ve açıklamalarını içeren istek parametrelerini tanımlayın.
• Beklenen yanıtı, durum kodları, yanıt biçimleri (JSON, XML, vb.) ve örnek yanıtlar dahil olmak üzere açıklayın.

Birçok geliştirici, API dokümantasyonu yazmaktan hoşlanmıyor ve bunu genellikle karmaşık buluyor. Ancak gerçekte, Apidog ile bunu sadece birkaç fare tıklamasıyla tamamlayabilirsiniz. Apidog'un görsel arayüzü yeni başlayanlar için uygundur ve API dokümantasyonunu koddan oluşturmaktan çok daha basittir.

Adım 4. API'nizi Oluşturun

Temel API bilgilerini tamamladığınızda, bir vaka olarak kaydetmek için tek bir tıklama yeterlidir. Doğrudan da kaydedebilirsiniz, ancak gelecekte daha kolay başvurmak için bir test durumu olarak kaydetmeniz önerilir.

Sonuç olarak, bu dört adımı izlemek, standartlaştırılmış API dokümantasyonunu zahmetsizce oluşturmanızı sağlar. Bu kolaylaştırılmış süreç yalnızca netlik ve tutarlılık sağlamakla kalmaz, aynı zamanda değerli zaman kazandırır. Otomatik dokümantasyon ile işbirliğini geliştirmek, kullanıcı etkileşimini basitleştirmek ve projelerinizi güvenle ileriye taşımak için iyi donatılmışsınız.

Apidog'da İstekler İçin Dokümantasyon Oluşturma

Apidog, API geliştiricileri için yalnızca projelerinde yaptıklarına dayanarak API dokümantasyonu oluşturmayı destekler.

Başlamak için önce "Paylaş" düğmesini (Ok 1 ile işaretlenmiş) bulun ve Ok 2 ile işaretlenmiş "+" Yeni" düğmesine basın.

Apidog, API dokümantasyonunuzu kimlerin görüntüleyebileceğini seçme ve bir dosya parolası ayarlama seçeneği sunar, böylece yalnızca seçilen kişiler veya kuruluşlar görüntüleyebilir.

API dokümantasyon adı ve dili gibi tüm gerekli alanlar doldurulduktan sonra, klavyenizdeki Enter tuşuna veya Kaydet düğmesine basın.

API Dokümantasyonunuzu Görüntüleyin veya Paylaşın

Apidog, API projenizin ayrıntılarını bir web sitesi URL'si aracılığıyla görüntülenebilen bir API dokümantasyonunda derler. Tek yapmanız gereken, Eylemler altındaki Bağlantıyı Kopyala bağlantısına tıklamak ve API Dokümantasyonunuzu görüntülemek için URL'yi favori tarayıcınıza yapıştırmak!

API'nizi Tasarlama

Apidog ile API uç noktalarınızı görsel olarak tasarlayabilir, parametreleri tanımlayabilir ve istek/yanıt şemalarını belirleyebilirsiniz. Bu görsel yaklaşım, net ve öz bir API tasarımı oluşturmayı kolaylaştırır.

API'nizi Test Etme

Apidog, API uç noktalarınızı doğrudan araç içinde test etmenize olanak tanıyan güçlü test yetenekleri sağlar. Test senaryoları oluşturabilir, çalıştırabilir ve sonuçları tek bir yerde görüntüleyebilirsiniz.

API'nizi Yönetme

Apidog ayrıca sürüm oluşturma, erişim kontrolü ve kullanım analizi gibi API'nizi yönetmeye yönelik özellikler sunar. Bu özellikler, API'nizin performansını takip etmenize ve güvenli ve güncel kalmasını sağlamanıza yardımcı olur.

Sonuç

FastAPI, Python ile yüksek performanslı API'ler oluşturmak için mükemmel bir seçimdir. Kullanım kolaylığı, otomatik dokümantasyonu ve sağlam özellikleri, onu geliştiriciler arasında favori yapar. Dokümantasyon için en iyi uygulamaları izleyerek ve Apidog gibi araçlardan yararlanarak, ihtiyaçlarınızı karşılayan güçlü ve kullanıcı dostu API'ler oluşturabilirsiniz.

Öyleyse, ne bekliyorsunuz? Bir sonraki API'nizi FastAPI ile oluşturmaya başlayın ve geliştirme sürecinizi Apidog ile geliştirin. Apidog'u bugün ücretsiz indirin ve API geliştirmenizi bir sonraki seviyeye taşıyın!