python asyncio api async fastapi framework json json-schema openapi openapi3 pydantic python-types python3 redoc rest starlette swagger swagger-ui uvicorn web

9.8 KiB

Raw Blame History

İlk Adımlar

En basit FastAPI dosyası şu şekildedir:

{!../../../docs_src/first_steps/tutorial001.py!}

Bunu bir main.py dosyasına kopyalayın.

Projeyi çalıştırın:

$ 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.

!!! note uvicorn main:app komutu şunu ifade eder:

* `main`: `main.py` dosyası (the Python "module").
* `app`: `main.py` dosyası içerisinde `app = FastAPI()` satırıyla oluşturulan nesne.
* `--reload`: Kod değişikliği sonrasında sunucunun yeniden başlatılmasını sağlar. Yalnızca geliştirme için kullanın.

Çıktıda şu şekilde bir satır vardır:

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

Bu satır, yerel makinenizde uygulamanızın sunulduğu URL'yi gösterir.

Kontrol Et

Tarayıcınızda http://127.0.0.1:8000 adresini açın.

Bir JSON yanıtı göreceksiniz:

{"message": "Hello World"}

İnteraktif API dokümantasyonu

http://127.0.0.1:8000/docs adresine gidin.

Otomatik oluşturulmuş( Swagger UI tarafından sağlanan) interaktif bir API dokümanı göreceksiniz:

Alternatif API dokümantasyonu

Şimdi, http://127.0.0.1:8000/redoc adresine gidin.

Otomatik oluşturulmuş(ReDoc tarafından sağlanan) bir API dokümanı göreceksiniz:

OpenAPI

FastAPI, OpenAPI standardını kullanarak tüm API'lerinizi açıklayan bir "şema" oluşturur.

"Şema"

Bir "şema", bir şeyin tanımı veya açıklamasıdır. Soyut bir açıklamadır, uygulayan kod değildir.

API "şemaları"

Bu durumda, OpenAPI, API şemasını nasıl tanımlayacağınızı belirten şartnamelerdir.

Bu şema tanımı, API yollarınızı, aldıkları olası parametreleri vb. içerir.

Data "şema"

"Şema" terimi, JSON içeriği gibi bazı verilerin şeklini de ifade edebilir.

Bu durumda, JSON öznitelikleri ve sahip oldukları veri türleri vb. anlamına gelir.

OpenAPI and 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` kontrol et

OpenAPI şemasının nasıl göründüğünü merak ediyorsanız, FastAPI otomatik olarak tüm API'nizin açıklamalarını içeren bir JSON (şema) oluşturur.

Doğrudan şu adreste görebilirsiniz: http://127.0.0.1:8000/openapi.json.

Aşağıdaki gibi bir şeyle başlayan bir JSON gösterecektir:

{
    "openapi": "3.0.2",
    "info": {
        "title": "FastAPI",
        "version": "0.1.0"
    },
    "paths": {
        "/items/": {
            "get": {
                "responses": {
                    "200": {
                        "description": "Successful Response",
                        "content": {
                            "application/json": {



...

OpenAPI ne içindir?

OpenAPI şeması, dahili olarak bulunan iki etkileşimli dokümantasyon sistemine güç veren şeydir.

Ve tamamen OpenAPI'ye dayalı düzinelerce alternatif vardır. FastAPI ile oluşturulmuş uygulamanıza bu alternatiflerden herhangi birini kolayca ekleyebilirsiniz.

API'nizle iletişim kuran istemciler için otomatik olarak kod oluşturmak için de kullanabilirsiniz. Örneğin, frontend, mobil veya IoT uygulamaları.

Adım adım özet

Adım 1: `FastAPI`yi içe aktarın

{!../../../docs_src/first_steps/tutorial001.py!}

FastAPI, API'niz için tüm fonksiyonları sağlayan bir Python sınıfıdır.

!!! note "Teknik Detaylar" FastAPI doğrudan Starlette kalıtım alan bir sınıftır.

Tüm <a href="https://www.starlette.io/" class="external-link" target="_blank">Starlette</a> fonksiyonlarını `FastAPI` ile de kullanabilirsiniz.

Adım 2: Bir `FastAPI` örneği oluşturun

{!../../../docs_src/first_steps/tutorial001.py!}

Burada app değişkeni FastAPI sınıfının bir örneği olacaktır.

Bu tüm API'yi oluşturmak için ana etkileşim noktası olacaktır.

uvicorn komutunda atıfta bulunulan app ile aynıdır.

$ 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:

{!../../../docs_src/first_steps/tutorial002.py!}

Ve bunu main.py dosyasına koyduktan sonra uvicorn komutunu şu şekilde çağı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: Path işlemleri oluşturmak

Path

Burada "Path" URL'de ilk "" ile başlayan son bölümü ifade eder.

Yani, şu şekilde bir URL'de:

https://example.com/items/foo

... path şöyle olabilir:

/items/foo

!!! info Genellikle bir "path", "endpoint" veya "route" olarak adlandırılabilir.

Bir API oluştururken, "path", "resource" ile "concern" ayırmanın ana yoludur.

İşlemler

Burada "işlem" HTTP methodlarından birini ifade eder.

Onlardan biri:

POST
GET
PUT
DELETE

... ve daha egzotik olanları:

OPTIONS
HEAD
PATCH
TRACE

HTTP protokolünde, bu "methodlardan" birini (veya daha fazlasını) kullanarak her path ile iletişim kurabilirsiniz.

API'lerinizi oluştururkan, belirli bir işlemi gerçekleştirirken belirli HTTP methodları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'de HTTP methodlarından her birine "işlem" denir.

Bizde onlara "işlemler" diyeceğiz.

Bir Path işlem decoratorleri tanımlanmak

{!../../../docs_src/first_steps/tutorial001.py!}

@app.get("/") FastAPI'ye aşağıdaki fonksiyonun adresine giden istekleri işlemekten sorumlu olduğunu söyler:

path /
get işlemi kullanılarak

!!! info "@decorator Bilgisi" Python @something şeklinde ifadeleri "decorator" olarak adlandırır.

Decoratoru bir fonksiyonun üzerine koyarsınız. Dekoratif bir şapka gibi (Sanırım terim buradan gelmektedir).

Bir "decorator" fonksiyonu alır ve bazı işlemler gerçekleştir.

Bizim durumumzda decarator **FastAPI'ye** fonksiyonun bir `get` işlemi ile `/` pathine geldiğini söyler.

Bu **path işlem decoratordür**

Ayrıca diğer işlemleri de kullanabilirsiniz:

@app.post()
@app.put()
@app.delete()

Ve daha egzotik olanları:

@app.options()
@app.head()
@app.patch()
@app.trace()

!!! tip Her işlemi (HTTP method) istediğiniz gibi kullanmakta özgürsünüz.

**FastAPI** herhangi bir özel anlamı zorlamaz.

Buradaki bilgiler bir gereklilik değil, bir kılavuz olarak sunulmaktadır.

Örneğin, GraphQL kullanırkan normalde tüm işlemleri yalnızca `POST` işlemini kullanarak gerçekleştirirsiniz.

Adım 4: path işlem fonksiyonunu tanımlayın

Aşağıdakiler bizim path işlem fonksiyonlarımızdır:

path: /
işlem: get
function: "decorator"ün altındaki fonksiyondur (@app.get("/") altında).

{!../../../docs_src/first_steps/tutorial001.py!}

Bu bir Python fonksiyonudur.

Bir GET işlemi kullanarak "/" URL'sine bir istek geldiğinde FastAPI tarafından çağrılır.

Bu durumda bir async fonksiyonudur.

Bunu async def yerine normal bir fonksiyon olarakta tanımlayabilirsiniz.

{!../../../docs_src/first_steps/tutorial003.py!}

!!! note

Eğer farkı bilmiyorsanız, [Async: *"Acelesi var?"*](../async.md#in-a-hurry){.internal-link target=_blank} kontrol edebilirsiniz.

Adım 5: İçeriği geri döndürün

{!../../../docs_src/first_steps/tutorial001.py!}

Bir dict, list döndürebilir veya str, int gibi tekil değerler döndürebilirsiniz.

Ayrıca, Pydantic modellerini de döndürebilirsiniz. (Bununla ilgili daha sonra ayrıntılı bilgi göreceksiniz.)

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'yi içe aktarın.
Bir app örneği oluşturun.
path işlem decorator yazın. (@app.get("/") gibi)
path işlem fonksiyonu yazın. (def root(): ... gibi)
Development sunucunuzu çalıştırın. (uvicorn main:app --reload gibi)

9.8 KiB Raw Blame History