İlk Adımlar¶
En sade FastAPI dosyası şu şekilde görünür:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
Yukarıdaki içeriği bir main.py
dosyasına kopyalayalım.
Uygulamayı çalıştıralım:
$ uvicorn main:app --reload
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
<span style="color: green;">INFO</span>: Started reloader process [28720]
<span style="color: green;">INFO</span>: Started server process [28722]
<span style="color: green;">INFO</span>: Waiting for application startup.
<span style="color: green;">INFO</span>: Application startup complete.
"Not"
uvicorn main:app
komutunu şu şekilde açıklayabiliriz:
main
: dosya olanmain.py
(yani Python "modülü").app
: isemain.py
dosyasının içerisindeapp = FastAPI()
satırında oluşturduğumuzFastAPI
nesnesi.--reload
: kod değişikliklerinin ardından sunucuyu otomatik olarak yeniden başlatır. Bu parameteyi sadece geliştirme aşamasında kullanmalıyız.
Çıktı olarak şöyle bir satır ile karşılaşacaksınız:
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
Bu satır, yerel makinenizde uygulamanızın çalıştığı bağlantıyı gösterir.
Kontrol Edelim¶
Tarayıcınızı açıp http://127.0.0.1:8000 bağlantısına gidin.
Şu şekilde bir JSON yanıtı ile karşılaşacağız:
{"message": "Hello World"}
Etkileşimli API Dokümantasyonu¶
Şimdi http://127.0.0.1:8000/docs bağlantısını açalım.
Swagger UI tarafından sağlanan otomatik etkileşimli bir API dokümantasyonu göreceğiz:
Alternatif API Dokümantasyonu¶
Şimdi http://127.0.0.1:8000/redoc bağlantısını açalım.
ReDoc tarafından sağlanan otomatik dokümantasyonu göreceğiz:
OpenAPI¶
FastAPI, OpenAPI standardını kullanarak tüm API'ınızın tamamını tanımlayan bir "şema" oluşturur.
"Şema"¶
"Şema", bir şeyin tanımı veya açıklamasıdır. Geliştirilen koddan ziyade soyut bir açıklamadır.
API "Şeması"¶
Bu durumda, OpenAPI, API şemasını nasıl tanımlayacağınızı belirten bir şartnamedir.
Bu şema tanımı, API yollarınızla birlikte yollarınızın aldığı olası parametreler gibi tanımlamaları içerir.
Veri "Şeması"¶
"Şema" terimi, JSON içeriği gibi bazı verilerin şeklini de ifade edebilir.
Bu durumda, JSON özellikleri ve sahip oldukları veri türleri gibi anlamlarına gelir.
OpenAPI ve JSON Şema¶
OpenAPI, API'niz için bir API şeması tanımlar. Ve bu şema, JSON veri şemaları standardı olan JSON Şema kullanılarak API'niz tarafından gönderilen ve alınan verilerin tanımlarını (veya "şemalarını") içerir.
openapi.json
Dosyasına Göz At¶
Ham OpenAPI şemasının nasıl göründüğünü merak ediyorsanız, FastAPI otomatik olarak tüm API'ınızın tanımlamalarını içeren bir JSON (şeması) oluşturur.
Bu şemayı direkt olarak http://127.0.0.1:8000/openapi.json bağlantısından görüntüleyebilirsiniz.
Aşağıdaki gibi başlayan bir JSON ile karşılaşacaksınız:
{
"openapi": "3.1.0",
"info": {
"title": "FastAPI",
"version": "0.1.0"
},
"paths": {
"/items/": {
"get": {
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
...
OpenAPI Ne İşe Yarar?¶
OpenAPI şeması, FastAPI projesinde bulunan iki etkileşimli dokümantasyon sistemine güç veren şeydir.
OpenAPI'ya dayalı düzinelerce alternatif etkileşimli dokümantasyon aracı mevcuttur. FastAPI ile oluşturulmuş uygulamanıza bu alternatiflerden herhangi birini kolayca ekleyebilirsiniz.
Ayrıca, API'ınızla iletişim kuracak önyüz, mobil veya IoT uygulamaları gibi istemciler için otomatik olarak kod oluşturabilirsiniz.
Adım Adım Özetleyelim¶
Adım 1: FastAPI
yı Projemize Dahil Edelim¶
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
FastAPI
, API'niz için tüm işlevselliği sağlayan bir Python sınıfıdır.
"Teknik Detaylar"
FastAPI
doğrudan Starlette
'i miras alan bir sınıftır.
Starlette'in tüm işlevselliğini FastAPI
ile de kullanabilirsiniz.
Adım 2: Bir FastAPI
"Örneği" Oluşturalım¶
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
Burada app
değişkeni FastAPI
sınıfının bir örneği olacaktır.
Bu, tüm API'yı oluşturmak için ana etkileşim noktası olacaktır.
Bu app
değişkeni, uvicorn
komutunda atıfta bulunulan değişkenin ta kendisidir.
$ uvicorn main:app --reload
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
Uygulamanızı aşağıdaki gibi oluşturursanız:
from fastapi import FastAPI
my_awesome_api = FastAPI()
@my_awesome_api.get("/")
async def root():
return {"message": "Hello World"}
Ve bunu main.py
dosyasına yerleştirirseniz eğer uvicorn
komutunu şu şekilde çalıştırabilirsiniz:
$ uvicorn main:my_awesome_api --reload
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
Adım 3: Bir Yol Operasyonu Oluşturalım¶
Yol¶
Burada "yol" bağlantıda bulunan ilk /
ile başlayan ve sonrasında gelen kısmı ifade eder.
Yani, şu şekilde bir bağlantıda:
https://example.com/items/foo
... yol şöyle olur:
/items/foo
"Bilgi"
"Yol" genellikle "endpoint" veya "route" olarak adlandırılır.
Bir API oluştururken, "yol", "kaynaklar" ile "endişeleri" ayırmanın ana yöntemidir.
Operasyonlar¶
Burada "operasyon" HTTP "metodlarından" birini ifade eder.
Bunlardan biri:
POST
GET
PUT
DELETE
...veya daha az kullanılan diğerleri:
OPTIONS
HEAD
PATCH
TRACE
HTTP protokolünde, bu "metodlardan" birini (veya daha fazlasını) kullanarak her bir yol ile iletişim kurabilirsiniz.
API oluştururkan, belirli bir amaca hizmet eden belirli HTTP metodlarını kullanırsınız.
Normalde kullanılan:
POST
: veri oluşturmak.GET
: veri okumak.PUT
: veriyi güncellemek.DELETE
: veriyi silmek.
Bu nedenle, OpenAPI'da HTTP metodlarından her birine "operasyon" denir.
Biz de onları "operasyonlar" olarak adlandıracağız.
Bir Yol Operasyonu Dekoratörü Tanımlayalım¶
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
@app.get("/")
dekoratörü, FastAPI'a hemen altındaki fonksiyonun aşağıdaki durumlardan sorumlu olduğunu söyler:
get
operasyonu ile/
yoluna gelen istekler
"@decorator
Bilgisi"
Python'da @something
sözdizimi "dekoratör" olarak adlandırılır.
Dekoratörler, dekoratif bir şapka gibi (sanırım terim buradan geliyor) fonksiyonların üzerlerine yerleştirilirler.
Bir "dekoratör" hemen altında bulunan fonksiyonu alır ve o fonksiyon ile bazı işlemler gerçekleştirir.
Bizim durumumuzda, kullandığımız dekoratör, FastAPI'a altındaki fonksiyonun /
yoluna gelen get
metodlu isteklerden sorumlu olduğunu söyler.
Bu bir yol operasyonu dekoratörüdür.
Ayrıca diğer operasyonları da kullanabilirsiniz:
@app.post()
@app.put()
@app.delete()
Daha az kullanılanları da kullanabilirsiniz:
@app.options()
@app.head()
@app.patch()
@app.trace()
"İpucu"
Her işlemi (HTTP metod) istediğiniz gibi kullanmakta özgürsünüz.
FastAPI herhangi bir özel amacı veya anlamı olması konusunda ısrarcı olmaz.
Buradaki bilgiler bir gereklilik değil, bir kılavuz olarak sunulmaktadır.
Mesela GraphQL kullanırkan genelde tüm işlemleri yalnızca POST
operasyonunu kullanarak gerçekleştirirsiniz.
Adım 4: Yol Operasyonu Fonksiyonunu Tanımlayın¶
Aşağıdaki, bizim yol operasyonu fonksiyonumuzdur:
- yol:
/
- operasyon:
get
- fonksiyon: "dekoratör"ün (
@app.get("/")
'in) altındaki fonksiyondur.
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
Bu bir Python fonksiyonudur.
Bu fonksiyon bir GET
işlemi kullanılarak "/
" bağlantısına bir istek geldiğinde FastAPI tarafından çağrılır.
Bu durumda bu fonksiyon bir async
fonksiyondur.
Bu fonksiyonu async def
yerine normal bir fonksiyon olarak da tanımlayabilirsiniz.
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def root():
return {"message": "Hello World"}
"Not"
Eğer farkı bilmiyorsanız, Async: "Aceleniz mi var?" sayfasını kontrol edebilirsiniz.
Adım 5: İçeriği Geri Döndürün¶
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
Bir dict
, list
veya str
, int
gibi tekil değerler döndürebilirsiniz.
Ayrıca, Pydantic modelleri de döndürebilirsiniz (bu konu ileriki aşamalarda irdelenecektir).
Otomatik olarak JSON'a dönüştürülecek (ORM'ler vb. dahil) başka birçok nesne ve model vardır. En beğendiklerinizi kullanmayı deneyin, yüksek ihtimalle destekleniyordur.
Özet¶
FastAPI
'yı projemize dahil ettik.- Bir
app
örneği oluşturduk. - Bir yol operasyonu dekoratörü (
@app.get("/")
gibi) yazdık. - Bir yol operasyonu fonksiyonu (
def root(): ...
gibi) yazdık. - Geliştirme sunucumuzu (
uvicorn main:app --reload
gibi) çalıştırdık.