diff --git a/docs/de/docs/advanced/additional-responses.md b/docs/de/docs/advanced/additional-responses.md index 0f9b122516..531702bf18 100644 --- a/docs/de/docs/advanced/additional-responses.md +++ b/docs/de/docs/advanced/additional-responses.md @@ -26,7 +26,7 @@ Jedes dieser Response-`dict`s kann einen Schlüssel `model` haben, welcher ein P Um beispielsweise eine weitere Response mit dem Statuscode `404` und einem Pydantic-Modell `Message` zu deklarieren, können Sie schreiben: -{* ../../docs_src/additional_responses/tutorial001_py39.py hl[18,22] *} +{* ../../docs_src/additional_responses/tutorial001_py310.py hl[18,22] *} /// note | Hinweis @@ -203,7 +203,7 @@ Sie können beispielsweise eine Response mit dem Statuscode `404` deklarieren, d Und eine Response mit dem Statuscode `200`, die Ihr `response_model` verwendet, aber ein benutzerdefiniertes Beispiel (`example`) enthält: -{* ../../docs_src/additional_responses/tutorial003_py39.py hl[20:31] *} +{* ../../docs_src/additional_responses/tutorial003_py310.py hl[20:31] *} Es wird alles kombiniert und in Ihre OpenAPI eingebunden und in der API-Dokumentation angezeigt: diff --git a/docs/de/docs/advanced/advanced-dependencies.md b/docs/de/docs/advanced/advanced-dependencies.md index e60df28834..50b4e20ac0 100644 --- a/docs/de/docs/advanced/advanced-dependencies.md +++ b/docs/de/docs/advanced/advanced-dependencies.md @@ -18,7 +18,7 @@ Nicht die Klasse selbst (die bereits aufrufbar ist), sondern eine Instanz dieser Dazu deklarieren wir eine Methode `__call__`: -{* ../../docs_src/dependencies/tutorial011_an_py39.py hl[12] *} +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[12] *} In diesem Fall ist dieses `__call__` das, was **FastAPI** verwendet, um nach zusätzlichen Parametern und Unterabhängigkeiten zu suchen, und das ist es auch, was später aufgerufen wird, um einen Wert an den Parameter in Ihrer *Pfadoperation-Funktion* zu übergeben. @@ -26,7 +26,7 @@ In diesem Fall ist dieses `__call__` das, was **FastAPI** verwendet, um nach zus Und jetzt können wir `__init__` verwenden, um die Parameter der Instanz zu deklarieren, die wir zum „Parametrisieren“ der Abhängigkeit verwenden können: -{* ../../docs_src/dependencies/tutorial011_an_py39.py hl[9] *} +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[9] *} In diesem Fall wird **FastAPI** `__init__` nie berühren oder sich darum kümmern, wir werden es direkt in unserem Code verwenden. @@ -34,7 +34,7 @@ In diesem Fall wird **FastAPI** `__init__` nie berühren oder sich darum kümmer Wir könnten eine Instanz dieser Klasse erstellen mit: -{* ../../docs_src/dependencies/tutorial011_an_py39.py hl[18] *} +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[18] *} Und auf diese Weise können wir unsere Abhängigkeit „parametrisieren“, die jetzt `"bar"` enthält, als das Attribut `checker.fixed_content`. @@ -50,7 +50,7 @@ checker(q="somequery") ... und übergibt, was immer das als Wert dieser Abhängigkeit in unserer *Pfadoperation-Funktion* zurückgibt, als den Parameter `fixed_content_included`: -{* ../../docs_src/dependencies/tutorial011_an_py39.py hl[22] *} +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[22] *} /// tip | Tipp diff --git a/docs/de/docs/advanced/advanced-python-types.md b/docs/de/docs/advanced/advanced-python-types.md new file mode 100644 index 0000000000..aed859ceff --- /dev/null +++ b/docs/de/docs/advanced/advanced-python-types.md @@ -0,0 +1,61 @@ +# Fortgeschrittene Python-Typen { #advanced-python-types } + +Hier sind einige zusätzliche Ideen, die beim Arbeiten mit Python-Typen nützlich sein könnten. + +## `Union` oder `Optional` verwenden { #using-union-or-optional } + +Wenn Ihr Code aus irgendeinem Grund nicht `|` verwenden kann, z. B. wenn es nicht in einer Typannotation ist, sondern in etwas wie `response_model=`, können Sie anstelle des senkrechten Strichs (`|`) `Union` aus `typing` verwenden. + +Zum Beispiel könnten Sie deklarieren, dass etwas ein `str` oder `None` sein könnte: + +```python +from typing import Union + + +def say_hi(name: Union[str, None]): + print(f"Hi {name}!") +``` + +`typing` hat außerdem eine Abkürzung, um zu deklarieren, dass etwas `None` sein könnte, mit `Optional`. + +Hier ist ein Tipp aus meiner sehr **subjektiven** Perspektive: + +* 🚨 Vermeiden Sie die Verwendung von `Optional[SomeType]` +* Verwenden Sie stattdessen ✨ **`Union[SomeType, None]`** ✨. + +Beides ist äquivalent und unter der Haube identisch, aber ich würde `Union` statt `Optional` empfehlen, weil das Wort „**optional**“ implizieren könnte, dass der Wert optional ist; tatsächlich bedeutet es jedoch „es kann `None` sein“, selbst wenn es nicht optional ist und weiterhin erforderlich bleibt. + +Ich finde, `Union[SomeType, None]` ist expliziter in dem, was es bedeutet. + +Es geht nur um Wörter und Namen. Aber diese Wörter können beeinflussen, wie Sie und Ihr Team über den Code denken. + +Als Beispiel nehmen wir diese Funktion: + +```python +from typing import Optional + + +def say_hi(name: Optional[str]): + print(f"Hey {name}!") +``` + +Der Parameter `name` ist als `Optional[str]` definiert, aber er ist **nicht optional**, Sie können die Funktion nicht ohne den Parameter aufrufen: + +```Python +say_hi() # Oh nein, das löst einen Fehler aus! 😱 +``` + +Der Parameter `name` ist **weiterhin erforderlich** (nicht *optional*), weil er keinen Defaultwert hat. Dennoch akzeptiert `name` den Wert `None`: + +```Python +say_hi(name=None) # Das funktioniert, None ist gültig 🎉 +``` + +Die gute Nachricht ist: In den meisten Fällen können Sie einfach `|` verwenden, um Unions von Typen zu definieren: + +```python +def say_hi(name: str | None): + print(f"Hey {name}!") +``` + +Sie müssen sich also normalerweise keine Gedanken über Namen wie `Optional` und `Union` machen. 😎 diff --git a/docs/de/docs/advanced/async-tests.md b/docs/de/docs/advanced/async-tests.md index 7206f136fd..7702cc1c57 100644 --- a/docs/de/docs/advanced/async-tests.md +++ b/docs/de/docs/advanced/async-tests.md @@ -32,11 +32,11 @@ Betrachten wir als einfaches Beispiel eine Dateistruktur ähnlich der in [Größ Die Datei `main.py` hätte als Inhalt: -{* ../../docs_src/async_tests/app_a_py39/main.py *} +{* ../../docs_src/async_tests/app_a_py310/main.py *} Die Datei `test_main.py` hätte die Tests für `main.py`, das könnte jetzt so aussehen: -{* ../../docs_src/async_tests/app_a_py39/test_main.py *} +{* ../../docs_src/async_tests/app_a_py310/test_main.py *} ## Es ausführen { #run-it } @@ -56,7 +56,7 @@ $ pytest Der Marker `@pytest.mark.anyio` teilt pytest mit, dass diese Testfunktion asynchron aufgerufen werden soll: -{* ../../docs_src/async_tests/app_a_py39/test_main.py hl[7] *} +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[7] *} /// tip | Tipp @@ -66,7 +66,7 @@ Beachten Sie, dass die Testfunktion jetzt `async def` ist und nicht nur `def` wi Dann können wir einen `AsyncClient` mit der App erstellen und mit `await` asynchrone Requests an ihn senden. -{* ../../docs_src/async_tests/app_a_py39/test_main.py hl[9:12] *} +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[9:12] *} Das ist das Äquivalent zu: diff --git a/docs/de/docs/advanced/behind-a-proxy.md b/docs/de/docs/advanced/behind-a-proxy.md index 1c74590503..cbcdc59d4c 100644 --- a/docs/de/docs/advanced/behind-a-proxy.md +++ b/docs/de/docs/advanced/behind-a-proxy.md @@ -44,7 +44,7 @@ $ fastapi run --forwarded-allow-ips="*" Angenommen, Sie definieren eine *Pfadoperation* `/items/`: -{* ../../docs_src/behind_a_proxy/tutorial001_01_py39.py hl[6] *} +{* ../../docs_src/behind_a_proxy/tutorial001_01_py310.py hl[6] *} Wenn der Client versucht, zu `/items` zu gehen, würde er standardmäßig zu `/items/` umgeleitet. @@ -115,7 +115,7 @@ In diesem Fall würde der ursprüngliche Pfad `/app` tatsächlich unter `/api/v1 Auch wenn Ihr gesamter Code unter der Annahme geschrieben ist, dass es nur `/app` gibt. -{* ../../docs_src/behind_a_proxy/tutorial001_py39.py hl[6] *} +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[6] *} Und der Proxy würde das **Pfadpräfix** on-the-fly **„entfernen“**, bevor er den Request an den Anwendungsserver (wahrscheinlich Uvicorn via FastAPI CLI) übermittelt, dafür sorgend, dass Ihre Anwendung davon überzeugt ist, dass sie unter `/app` bereitgestellt wird, sodass Sie nicht Ihren gesamten Code dahingehend aktualisieren müssen, das Präfix `/api/v1` zu verwenden. @@ -193,7 +193,7 @@ Sie können den aktuellen `root_path` abrufen, der von Ihrer Anwendung für jede Hier fügen wir ihn, nur zu Demonstrationszwecken, in die Nachricht ein. -{* ../../docs_src/behind_a_proxy/tutorial001_py39.py hl[8] *} +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[8] *} Wenn Sie Uvicorn dann starten mit: @@ -220,7 +220,7 @@ wäre die Requests und Responses zu deklarieren. @@ -64,7 +64,7 @@ In diesem Fall können Sie einfach die Standard-`dataclasses` durch `pydantic.da 6. Hier geben wir ein Dictionary zurück, das `items` enthält, welches eine Liste von Datenklassen ist. - FastAPI ist weiterhin in der Lage, die Daten nach JSON zu serialisieren. + FastAPI ist weiterhin in der Lage, die Daten nach JSON zu Serialisieren. 7. Hier verwendet das `response_model` als Typannotation eine Liste von `Author`-Datenklassen. diff --git a/docs/de/docs/advanced/events.md b/docs/de/docs/advanced/events.md index 7e1191b55e..17d14d71c5 100644 --- a/docs/de/docs/advanced/events.md +++ b/docs/de/docs/advanced/events.md @@ -30,7 +30,7 @@ Beginnen wir mit einem Beispiel und sehen es uns dann im Detail an. Wir erstellen eine asynchrone Funktion `lifespan()` mit `yield` wie folgt: -{* ../../docs_src/events/tutorial003_py39.py hl[16,19] *} +{* ../../docs_src/events/tutorial003_py310.py hl[16,19] *} Hier simulieren wir den langsamen *Startup*, das Laden des Modells, indem wir die (Fake-)Modellfunktion vor dem `yield` in das Dictionary mit Modellen für maschinelles Lernen einfügen. Dieser Code wird ausgeführt, **bevor** die Anwendung **beginnt, Requests entgegenzunehmen**, während des *Startups*. @@ -48,7 +48,7 @@ Möglicherweise müssen Sie eine neue Version starten, oder Sie haben es einfach Das Erste, was auffällt, ist, dass wir eine asynchrone Funktion mit `yield` definieren. Das ist sehr ähnlich zu Abhängigkeiten mit `yield`. -{* ../../docs_src/events/tutorial003_py39.py hl[14:19] *} +{* ../../docs_src/events/tutorial003_py310.py hl[14:19] *} Der erste Teil der Funktion, vor dem `yield`, wird ausgeführt **bevor** die Anwendung startet. @@ -60,7 +60,7 @@ Wie Sie sehen, ist die Funktion mit einem `@asynccontextmanager` versehen. Dadurch wird die Funktion in einen sogenannten „**asynchronen Kontextmanager**“ umgewandelt. -{* ../../docs_src/events/tutorial003_py39.py hl[1,13] *} +{* ../../docs_src/events/tutorial003_py310.py hl[1,13] *} Ein **Kontextmanager** in Python ist etwas, das Sie in einer `with`-Anweisung verwenden können, zum Beispiel kann `open()` als Kontextmanager verwendet werden: @@ -82,7 +82,7 @@ In unserem obigen Codebeispiel verwenden wir ihn nicht direkt, sondern übergebe Der Parameter `lifespan` der `FastAPI`-App benötigt einen **asynchronen Kontextmanager**, wir können ihm also unseren neuen asynchronen Kontextmanager `lifespan` übergeben. -{* ../../docs_src/events/tutorial003_py39.py hl[22] *} +{* ../../docs_src/events/tutorial003_py310.py hl[22] *} ## Alternative Events (deprecatet) { #alternative-events-deprecated } @@ -104,7 +104,7 @@ Diese Funktionen können mit `async def` oder normalem `def` deklariert werden. Um eine Funktion hinzuzufügen, die vor dem Start der Anwendung ausgeführt werden soll, deklarieren Sie diese mit dem Event `startup`: -{* ../../docs_src/events/tutorial001_py39.py hl[8] *} +{* ../../docs_src/events/tutorial001_py310.py hl[8] *} In diesem Fall initialisiert die Eventhandler-Funktion `startup` die „Datenbank“ der Items (nur ein `dict`) mit einigen Werten. @@ -116,7 +116,7 @@ Und Ihre Anwendung empfängt erst dann Requests, wenn alle `startup`-Eventhandle Um eine Funktion hinzuzufügen, die beim Shutdown der Anwendung ausgeführt werden soll, deklarieren Sie sie mit dem Event `shutdown`: -{* ../../docs_src/events/tutorial002_py39.py hl[6] *} +{* ../../docs_src/events/tutorial002_py310.py hl[6] *} Hier schreibt die `shutdown`-Eventhandler-Funktion eine Textzeile `"Application shutdown"` in eine Datei `log.txt`. diff --git a/docs/de/docs/advanced/generate-clients.md b/docs/de/docs/advanced/generate-clients.md index 659343f5bc..fcb5510029 100644 --- a/docs/de/docs/advanced/generate-clients.md +++ b/docs/de/docs/advanced/generate-clients.md @@ -2,7 +2,7 @@ Da **FastAPI** auf der **OpenAPI**-Spezifikation basiert, können dessen APIs in einem standardisierten Format beschrieben werden, das viele Tools verstehen. -Dies vereinfacht es, aktuelle **Dokumentation** und Client-Bibliotheken (**SDKs**) in verschiedenen Sprachen zu generieren sowie **Test-** oder **Automatisierungs-Workflows**, die mit Ihrem Code synchron bleiben. +Dies vereinfacht es, aktuelle **Dokumentation** und Client-Bibliotheken (**SDKs**) in verschiedenen Sprachen zu generieren sowie **Test-** oder **Automatisierungs-Workflows**, die mit Ihrem Code synchron bleiben. In diesem Leitfaden erfahren Sie, wie Sie ein **TypeScript-SDK** für Ihr FastAPI-Backend generieren. @@ -40,7 +40,7 @@ Einige dieser Lösungen sind möglicherweise auch Open Source oder bieten kosten Beginnen wir mit einer einfachen FastAPI-Anwendung: -{* ../../docs_src/generate_clients/tutorial001_py39.py hl[7:9,12:13,16:17,21] *} +{* ../../docs_src/generate_clients/tutorial001_py310.py hl[7:9,12:13,16:17,21] *} Beachten Sie, dass die *Pfadoperationen* die Modelle definieren, die sie für die Request- und Response-Payload verwenden, indem sie die Modelle `Item` und `ResponseMessage` verwenden. @@ -98,7 +98,7 @@ In vielen Fällen wird Ihre FastAPI-App größer sein und Sie werden wahrscheinl Zum Beispiel könnten Sie einen Abschnitt für **Items (Artikel)** und einen weiteren Abschnitt für **Users (Benutzer)** haben, und diese könnten durch Tags getrennt sein: -{* ../../docs_src/generate_clients/tutorial002_py39.py hl[21,26,34] *} +{* ../../docs_src/generate_clients/tutorial002_py310.py hl[21,26,34] *} ### Einen TypeScript-Client mit Tags generieren { #generate-a-typescript-client-with-tags } @@ -145,7 +145,7 @@ Hier verwendet sie beispielsweise den ersten Tag (Sie werden wahrscheinlich nur Anschließend können Sie diese benutzerdefinierte Funktion als `generate_unique_id_function`-Parameter an **FastAPI** übergeben: -{* ../../docs_src/generate_clients/tutorial003_py39.py hl[6:7,10] *} +{* ../../docs_src/generate_clients/tutorial003_py310.py hl[6:7,10] *} ### Einen TypeScript-Client mit benutzerdefinierten Operation-IDs generieren { #generate-a-typescript-client-with-custom-operation-ids } @@ -167,7 +167,7 @@ Aber für den generierten Client könnten wir die OpenAPI-Operation-IDs direkt v Wir könnten das OpenAPI-JSON in eine Datei `openapi.json` herunterladen und dann mit einem Skript wie dem folgenden **den präfixierten Tag entfernen**: -{* ../../docs_src/generate_clients/tutorial004_py39.py *} +{* ../../docs_src/generate_clients/tutorial004_py310.py *} //// tab | Node.js @@ -179,7 +179,7 @@ Wir könnten das OpenAPI-JSON in eine Datei `openapi.json` herunterladen und dan Damit würden die Operation-IDs von Dingen wie `items-get_items` in `get_items` umbenannt, sodass der Client-Generator einfachere Methodennamen generieren kann. -### Einen TypeScript-Client mit der modifizierten OpenAPI generieren { #generate-a-typescript-client-with-the-preprocessed-openapi } +### Einen TypeScript-Client mit der vorverarbeiteten OpenAPI generieren { #generate-a-typescript-client-with-the-preprocessed-openapi } Da das Endergebnis nun in einer `openapi.json`-Datei vorliegt, müssen Sie Ihren Eingabeort aktualisieren: diff --git a/docs/de/docs/advanced/middleware.md b/docs/de/docs/advanced/middleware.md index ccc6a64c3b..4af583b5b1 100644 --- a/docs/de/docs/advanced/middleware.md +++ b/docs/de/docs/advanced/middleware.md @@ -57,13 +57,13 @@ Erzwingt, dass alle eingehenden hook* ## Webhooks-Schritte { #webhooks-steps } -Der Prozess besteht normalerweise darin, dass **Sie in Ihrem Code definieren**, welche Nachricht Sie senden möchten, den **Body des Requests**. +Der Prozess besteht normalerweise darin, dass **Sie in Ihrem Code definieren**, welche Nachricht Sie senden möchten, den **Requestbody**. Sie definieren auch auf irgendeine Weise, in welchen **Momenten** Ihre App diese Requests oder Events senden wird. @@ -18,7 +18,7 @@ Die gesamte **Logik** zur Registrierung der URLs für Webhooks und der Code zum ## Webhooks mit **FastAPI** und OpenAPI dokumentieren { #documenting-webhooks-with-fastapi-and-openapi } -Mit **FastAPI**, mithilfe von OpenAPI, können Sie die Namen dieser Webhooks, die Arten von HTTP-Operationen, die Ihre App senden kann (z. B. `POST`, `PUT`, usw.) und die Request**bodys** definieren, die Ihre App senden würde. +Mit **FastAPI**, mithilfe von OpenAPI, können Sie die Namen dieser Webhooks, die Arten von HTTP-Operationen, die Ihre App senden kann (z. B. `POST`, `PUT`, usw.) und die **Requestbodys** definieren, die Ihre App senden würde. Dies kann es Ihren Benutzern viel einfacher machen, **deren APIs zu implementieren**, um Ihre **Webhook**-Requests zu empfangen. Möglicherweise können diese sogar einen Teil ihres eigenen API-Codes automatisch generieren. @@ -32,7 +32,7 @@ Webhooks sind in OpenAPI 3.1.0 und höher verfügbar und werden von FastAPI `0.9 Wenn Sie eine **FastAPI**-Anwendung erstellen, gibt es ein `webhooks`-Attribut, das Sie verwenden können, um *Webhooks* zu definieren, genauso wie Sie *Pfadoperationen* definieren würden, zum Beispiel mit `@app.webhooks.post()`. -{* ../../docs_src/openapi_webhooks/tutorial001_py39.py hl[9:13,36:53] *} +{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *} Die von Ihnen definierten Webhooks landen im **OpenAPI**-Schema und der automatischen **Dokumentations-Oberfläche**. diff --git a/docs/de/docs/advanced/path-operation-advanced-configuration.md b/docs/de/docs/advanced/path-operation-advanced-configuration.md index c7ac1cf61b..a2dd212a1a 100644 --- a/docs/de/docs/advanced/path-operation-advanced-configuration.md +++ b/docs/de/docs/advanced/path-operation-advanced-configuration.md @@ -12,7 +12,7 @@ Mit dem Parameter `operation_id` können Sie die OpenAPI `operationId` festlegen Sie müssten sicherstellen, dass sie für jede Operation eindeutig ist. -{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py39.py hl[6] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py310.py hl[6] *} ### Verwendung des Namens der *Pfadoperation-Funktion* als operationId { #using-the-path-operation-function-name-as-the-operationid } @@ -20,7 +20,7 @@ Wenn Sie die Funktionsnamen Ihrer API als `operationId`s verwenden möchten, kö Sie sollten dies tun, nachdem Sie alle Ihre *Pfadoperationen* hinzugefügt haben. -{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py39.py hl[2, 12:21, 24] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py310.py hl[2, 12:21, 24] *} /// tip | Tipp @@ -40,7 +40,7 @@ Auch wenn diese sich in unterschiedlichen Modulen (Python-Dateien) befinden. Um eine *Pfadoperation* aus dem generierten OpenAPI-Schema (und damit aus den automatischen Dokumentationssystemen) auszuschließen, verwenden Sie den Parameter `include_in_schema` und setzen Sie ihn auf `False`: -{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py39.py hl[6] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *} ## Fortgeschrittene Beschreibung mittels Docstring { #advanced-description-from-docstring } @@ -92,7 +92,7 @@ Sie können das OpenAPI-Schema für eine *Pfadoperation* erweitern, indem Sie de Dieses `openapi_extra` kann beispielsweise hilfreich sein, um [OpenAPI-Erweiterungen](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions) zu deklarieren: -{* ../../docs_src/path_operation_advanced_configuration/tutorial005_py39.py hl[6] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial005_py310.py hl[6] *} Wenn Sie die automatische API-Dokumentation öffnen, wird Ihre Erweiterung am Ende der spezifischen *Pfadoperation* angezeigt. @@ -135,13 +135,13 @@ Das Request mit Ihrem eigenen Code zu lesen und zu validieren, ohne die automatischen Funktionen von FastAPI mit Pydantic zu verwenden, aber Sie könnten den Request trotzdem im OpenAPI-Schema definieren wollen. +Sie könnten sich beispielsweise dafür entscheiden, den Request mit Ihrem eigenen Code zu lesen und zu validieren, ohne FastAPIs automatische Funktionen mit Pydantic zu verwenden, aber Sie könnten den Request trotzdem im OpenAPI-Schema definieren wollen. Das könnte man mit `openapi_extra` machen: -{* ../../docs_src/path_operation_advanced_configuration/tutorial006_py39.py hl[19:36, 39:40] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial006_py310.py hl[19:36, 39:40] *} -In diesem Beispiel haben wir kein Pydantic-Modell deklariert. Tatsächlich wird der Requestbody nicht einmal als JSON geparst, sondern direkt als `bytes` gelesen und die Funktion `magic_data_reader()` wäre dafür verantwortlich, ihn in irgendeiner Weise zu parsen. +In diesem Beispiel haben wir kein Pydantic-Modell deklariert. Tatsächlich wird der Requestbody nicht einmal als JSON geparst, sondern direkt als `bytes` gelesen und die Funktion `magic_data_reader()` wäre dafür verantwortlich, ihn in irgendeiner Weise zu parsen. Dennoch können wir das zu erwartende Schema für den Requestbody deklarieren. @@ -151,9 +151,9 @@ Mit demselben Trick könnten Sie ein Pydantic-Modell verwenden, um das JSON-Sche Und Sie könnten dies auch tun, wenn der Datentyp im Request nicht JSON ist. -In der folgenden Anwendung verwenden wir beispielsweise weder die integrierte Funktionalität von FastAPI zum Extrahieren des JSON-Schemas aus Pydantic-Modellen noch die automatische Validierung für JSON. Tatsächlich deklarieren wir den Request-Content-Type als YAML und nicht als JSON: +In der folgenden Anwendung verwenden wir beispielsweise weder FastAPIs integrierte Funktionalität zum Extrahieren des JSON-Schemas aus Pydantic-Modellen noch die automatische Validierung für JSON. Tatsächlich deklarieren wir den Request-Content-Type als YAML und nicht als JSON: -{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py39.py hl[15:20, 22] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py310.py hl[15:20, 22] *} Obwohl wir nicht die standardmäßig integrierte Funktionalität verwenden, verwenden wir dennoch ein Pydantic-Modell, um das JSON-Schema für die Daten, die wir in YAML empfangen möchten, manuell zu generieren. @@ -161,7 +161,7 @@ Dann verwenden wir den Request direkt und extrahieren den Body als `bytes`. Das Und dann parsen wir in unserem Code diesen YAML-Inhalt direkt und verwenden dann wieder dasselbe Pydantic-Modell, um den YAML-Inhalt zu validieren: -{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py39.py hl[24:31] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py310.py hl[24:31] *} /// tip | Tipp diff --git a/docs/de/docs/advanced/response-change-status-code.md b/docs/de/docs/advanced/response-change-status-code.md index b209c2d671..26308b8239 100644 --- a/docs/de/docs/advanced/response-change-status-code.md +++ b/docs/de/docs/advanced/response-change-status-code.md @@ -20,7 +20,7 @@ Sie können einen Parameter vom Typ `Response` in Ihrer *Pfadoperation-Funktion* Anschließend können Sie den `status_code` in diesem *vorübergehenden* Response-Objekt festlegen. -{* ../../docs_src/response_change_status_code/tutorial001_py39.py hl[1,9,12] *} +{* ../../docs_src/response_change_status_code/tutorial001_py310.py hl[1,9,12] *} Und dann können Sie jedes benötigte Objekt zurückgeben, wie Sie es normalerweise tun würden (ein `dict`, ein Datenbankmodell usw.). diff --git a/docs/de/docs/advanced/response-cookies.md b/docs/de/docs/advanced/response-cookies.md index 87e636cfaf..bf6c40e61b 100644 --- a/docs/de/docs/advanced/response-cookies.md +++ b/docs/de/docs/advanced/response-cookies.md @@ -6,7 +6,7 @@ Sie können einen Parameter vom Typ `Response` in Ihrer *Pfadoperation-Funktion* Und dann können Sie Cookies in diesem *vorübergehenden* Response-Objekt setzen. -{* ../../docs_src/response_cookies/tutorial002_py39.py hl[1, 8:9] *} +{* ../../docs_src/response_cookies/tutorial002_py310.py hl[1, 8:9] *} Anschließend können Sie wie gewohnt jedes gewünschte Objekt zurückgeben (ein `dict`, ein Datenbankmodell, usw.). @@ -24,7 +24,7 @@ Dazu können Sie eine Response erstellen, wie unter [Eine Response direkt zurüc Setzen Sie dann Cookies darin und geben Sie sie dann zurück: -{* ../../docs_src/response_cookies/tutorial001_py39.py hl[10:12] *} +{* ../../docs_src/response_cookies/tutorial001_py310.py hl[10:12] *} /// tip | Tipp diff --git a/docs/de/docs/advanced/response-directly.md b/docs/de/docs/advanced/response-directly.md index 0a28a6d0e2..06bea4794d 100644 --- a/docs/de/docs/advanced/response-directly.md +++ b/docs/de/docs/advanced/response-directly.md @@ -54,7 +54,7 @@ Nehmen wir an, Sie möchten eine Response-Objekt festlegen. -{* ../../docs_src/response_headers/tutorial002_py39.py hl[1, 7:8] *} +{* ../../docs_src/response_headers/tutorial002_py310.py hl[1, 7:8] *} Anschließend können Sie wie gewohnt jedes gewünschte Objekt zurückgeben (ein `dict`, ein Datenbankmodell, usw.). @@ -22,7 +22,7 @@ Sie können auch Header hinzufügen, wenn Sie eine `Response` direkt zurückgebe Erstellen Sie eine Response wie in [Eine Response direkt zurückgeben](response-directly.md){.internal-link target=_blank} beschrieben und übergeben Sie die Header als zusätzlichen Parameter: -{* ../../docs_src/response_headers/tutorial001_py39.py hl[10:12] *} +{* ../../docs_src/response_headers/tutorial001_py310.py hl[10:12] *} /// note | Technische Details diff --git a/docs/de/docs/advanced/security/http-basic-auth.md b/docs/de/docs/advanced/security/http-basic-auth.md index f906ecd92b..2f66587b19 100644 --- a/docs/de/docs/advanced/security/http-basic-auth.md +++ b/docs/de/docs/advanced/security/http-basic-auth.md @@ -20,7 +20,7 @@ Wenn Sie dann den Benutzernamen und das Passwort eingeben, sendet der Browser di * Diese gibt ein Objekt vom Typ `HTTPBasicCredentials` zurück: * Es enthält den gesendeten `username` und das gesendete `password`. -{* ../../docs_src/security/tutorial006_an_py39.py hl[4,8,12] *} +{* ../../docs_src/security/tutorial006_an_py310.py hl[4,8,12] *} Wenn Sie versuchen, die URL zum ersten Mal zu öffnen (oder in der Dokumentation auf den Button „Execute“ zu klicken), wird der Browser Sie nach Ihrem Benutzernamen und Passwort fragen: @@ -40,7 +40,7 @@ Um dies zu lösen, konvertieren wir zunächst den `username` und das `password` Dann können wir `secrets.compare_digest()` verwenden, um sicherzustellen, dass `credentials.username` `"stanleyjobson"` und `credentials.password` `"swordfish"` ist. -{* ../../docs_src/security/tutorial007_an_py39.py hl[1,12:24] *} +{* ../../docs_src/security/tutorial007_an_py310.py hl[1,12:24] *} Dies wäre das gleiche wie: @@ -104,4 +104,4 @@ So ist Ihr Anwendungscode, dank der Verwendung von `secrets.compare_digest()`, v Nachdem Sie festgestellt haben, dass die Anmeldeinformationen falsch sind, geben Sie eine `HTTPException` mit dem Statuscode 401 zurück (derselbe, der auch zurückgegeben wird, wenn keine Anmeldeinformationen angegeben werden) und fügen den Header `WWW-Authenticate` hinzu, damit der Browser die Anmeldeaufforderung erneut anzeigt: -{* ../../docs_src/security/tutorial007_an_py39.py hl[26:30] *} +{* ../../docs_src/security/tutorial007_an_py310.py hl[26:30] *} diff --git a/docs/de/docs/advanced/settings.md b/docs/de/docs/advanced/settings.md index ea4540e10e..f83e635a78 100644 --- a/docs/de/docs/advanced/settings.md +++ b/docs/de/docs/advanced/settings.md @@ -46,12 +46,6 @@ $ pip install "fastapi[all]" -/// info | Info - -In Pydantic v1 war es im Hauptpackage enthalten. Jetzt wird es als unabhängiges Package verteilt, sodass Sie wählen können, ob Sie es installieren möchten oder nicht, falls Sie die Funktionalität nicht benötigen. - -/// - ### Das `Settings`-Objekt erstellen { #create-the-settings-object } Importieren Sie `BaseSettings` aus Pydantic und erstellen Sie eine Unterklasse, ganz ähnlich wie bei einem Pydantic-Modell. @@ -60,7 +54,7 @@ Auf die gleiche Weise wie bei Pydantic-Modellen deklarieren Sie Klassenattribute Sie können dieselben Validierungs-Funktionen und -Tools verwenden, die Sie für Pydantic-Modelle verwenden, z. B. verschiedene Datentypen und zusätzliche Validierungen mit `Field()`. -{* ../../docs_src/settings/tutorial001_py39.py hl[2,5:8,11] *} +{* ../../docs_src/settings/tutorial001_py310.py hl[2,5:8,11] *} /// tip | Tipp @@ -76,7 +70,7 @@ Als Nächstes werden die Daten konvertiert und validiert. Wenn Sie also dieses ` Dann können Sie das neue `settings`-Objekt in Ihrer Anwendung verwenden: -{* ../../docs_src/settings/tutorial001_py39.py hl[18:20] *} +{* ../../docs_src/settings/tutorial001_py310.py hl[18:20] *} ### Den Server ausführen { #run-the-server } @@ -110,11 +104,11 @@ Sie könnten diese Einstellungen in eine andere Moduldatei einfügen, wie Sie in Sie könnten beispielsweise eine Datei `config.py` haben mit: -{* ../../docs_src/settings/app01_py39/config.py *} +{* ../../docs_src/settings/app01_py310/config.py *} Und dann verwenden Sie diese in einer Datei `main.py`: -{* ../../docs_src/settings/app01_py39/main.py hl[3,11:13] *} +{* ../../docs_src/settings/app01_py310/main.py hl[3,11:13] *} /// tip | Tipp @@ -132,7 +126,7 @@ Dies könnte besonders beim Testen nützlich sein, da es sehr einfach ist, eine Ausgehend vom vorherigen Beispiel könnte Ihre Datei `config.py` so aussehen: -{* ../../docs_src/settings/app02_an_py39/config.py hl[10] *} +{* ../../docs_src/settings/app02_an_py310/config.py hl[10] *} Beachten Sie, dass wir jetzt keine Standardinstanz `settings = Settings()` erstellen. @@ -140,7 +134,7 @@ Beachten Sie, dass wir jetzt keine Standardinstanz `settings = Settings()` erste Jetzt erstellen wir eine Abhängigkeit, die ein neues `config.Settings()` zurückgibt. -{* ../../docs_src/settings/app02_an_py39/main.py hl[6,12:13] *} +{* ../../docs_src/settings/app02_an_py310/main.py hl[6,12:13] *} /// tip | Tipp @@ -152,13 +146,13 @@ Im Moment nehmen Sie an, dass `get_settings()` eine normale Funktion ist. Und dann können wir das von der *Pfadoperation-Funktion* als Abhängigkeit einfordern und es überall dort verwenden, wo wir es brauchen. -{* ../../docs_src/settings/app02_an_py39/main.py hl[17,19:21] *} +{* ../../docs_src/settings/app02_an_py310/main.py hl[17,19:21] *} ### Einstellungen und Tests { #settings-and-testing } Dann wäre es sehr einfach, beim Testen ein anderes Einstellungsobjekt bereitzustellen, indem man eine Abhängigkeitsüberschreibung für `get_settings` erstellt: -{* ../../docs_src/settings/app02_an_py39/test_main.py hl[9:10,13,21] *} +{* ../../docs_src/settings/app02_an_py310/test_main.py hl[9:10,13,21] *} Bei der Abhängigkeitsüberschreibung legen wir einen neuen Wert für `admin_email` fest, wenn wir das neue `Settings`-Objekt erstellen, und geben dann dieses neue Objekt zurück. @@ -199,7 +193,7 @@ APP_NAME="ChimichangApp" Und dann aktualisieren Sie Ihre `config.py` mit: -{* ../../docs_src/settings/app03_an_py39/config.py hl[9] *} +{* ../../docs_src/settings/app03_an_py310/config.py hl[9] *} /// tip | Tipp @@ -232,7 +226,7 @@ würden wir dieses Objekt für jeden Request erstellen und die `.env`-Datei für Da wir jedoch den `@lru_cache`-Dekorator oben verwenden, wird das `Settings`-Objekt nur einmal erstellt, nämlich beim ersten Aufruf. ✔️ -{* ../../docs_src/settings/app03_an_py39/main.py hl[1,11] *} +{* ../../docs_src/settings/app03_an_py310/main.py hl[1,11] *} Dann wird bei allen nachfolgenden Aufrufen von `get_settings()`, in den Abhängigkeiten für darauffolgende Requests, dasselbe Objekt zurückgegeben, das beim ersten Aufruf zurückgegeben wurde, anstatt den Code von `get_settings()` erneut auszuführen und ein neues `Settings`-Objekt zu erstellen. diff --git a/docs/de/docs/advanced/sub-applications.md b/docs/de/docs/advanced/sub-applications.md index 081574d0a9..6b862b44e0 100644 --- a/docs/de/docs/advanced/sub-applications.md +++ b/docs/de/docs/advanced/sub-applications.md @@ -10,7 +10,7 @@ Wenn Sie zwei unabhängige FastAPI-Anwendungen mit deren eigenen unabhängigen O Erstellen Sie zunächst die Hauptanwendung **FastAPI** und deren *Pfadoperationen*: -{* ../../docs_src/sub_applications/tutorial001_py39.py hl[3, 6:8] *} +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[3, 6:8] *} ### Unteranwendung { #sub-application } @@ -18,7 +18,7 @@ Erstellen Sie dann Ihre Unteranwendung und deren *Pfadoperationen*. Diese Unteranwendung ist nur eine weitere Standard-FastAPI-Anwendung, aber diese wird „gemountet“: -{* ../../docs_src/sub_applications/tutorial001_py39.py hl[11, 14:16] *} +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 14:16] *} ### Die Unteranwendung mounten { #mount-the-sub-application } @@ -26,7 +26,7 @@ Mounten Sie in Ihrer Top-Level-Anwendung `app` die Unteranwendung `subapi`. In diesem Fall wird sie im Pfad `/subapi` gemountet: -{* ../../docs_src/sub_applications/tutorial001_py39.py hl[11, 19] *} +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 19] *} ### Die automatische API-Dokumentation testen { #check-the-automatic-api-docs } diff --git a/docs/de/docs/advanced/templates.md b/docs/de/docs/advanced/templates.md index 97a45e6126..87baba3594 100644 --- a/docs/de/docs/advanced/templates.md +++ b/docs/de/docs/advanced/templates.md @@ -27,7 +27,7 @@ $ pip install jinja2 * Deklarieren Sie einen `Request`-Parameter in der *Pfadoperation*, welcher ein Template zurückgibt. * Verwenden Sie die von Ihnen erstellten `templates`, um eine `TemplateResponse` zu rendern und zurückzugeben, übergeben Sie den Namen des Templates, das Requestobjekt und ein „Kontext“-Dictionary mit Schlüssel-Wert-Paaren, die innerhalb des Jinja2-Templates verwendet werden sollen. -{* ../../docs_src/templates/tutorial001_py39.py hl[4,11,15:18] *} +{* ../../docs_src/templates/tutorial001_py310.py hl[4,11,15:18] *} /// note | Hinweis diff --git a/docs/de/docs/advanced/testing-events.md b/docs/de/docs/advanced/testing-events.md index 5b12f3f186..053aeffc8a 100644 --- a/docs/de/docs/advanced/testing-events.md +++ b/docs/de/docs/advanced/testing-events.md @@ -2,11 +2,11 @@ Wenn Sie `lifespan` in Ihren Tests ausführen müssen, können Sie den `TestClient` mit einer `with`-Anweisung verwenden: -{* ../../docs_src/app_testing/tutorial004_py39.py hl[9:15,18,27:28,30:32,41:43] *} +{* ../../docs_src/app_testing/tutorial004_py310.py hl[9:15,18,27:28,30:32,41:43] *} Sie können mehr Details unter [„Lifespan in Tests ausführen in der offiziellen Starlette-Dokumentation.“](https://www.starlette.dev/lifespan/#running-lifespan-in-tests) nachlesen. Für die deprecateten Events `startup` und `shutdown` können Sie den `TestClient` wie folgt verwenden: -{* ../../docs_src/app_testing/tutorial003_py39.py hl[9:12,20:24] *} +{* ../../docs_src/app_testing/tutorial003_py310.py hl[9:12,20:24] *} diff --git a/docs/de/docs/advanced/testing-websockets.md b/docs/de/docs/advanced/testing-websockets.md index 9ecca7a4f7..4bc46da3ea 100644 --- a/docs/de/docs/advanced/testing-websockets.md +++ b/docs/de/docs/advanced/testing-websockets.md @@ -4,7 +4,7 @@ Sie können den schon bekannten `TestClient` zum Testen von WebSockets verwenden Dazu verwenden Sie den `TestClient` in einer `with`-Anweisung, eine Verbindung zum WebSocket herstellend: -{* ../../docs_src/app_testing/tutorial002_py39.py hl[27:31] *} +{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *} /// note | Hinweis diff --git a/docs/de/docs/advanced/using-request-directly.md b/docs/de/docs/advanced/using-request-directly.md index 36d73b8067..bed1cdbea3 100644 --- a/docs/de/docs/advanced/using-request-directly.md +++ b/docs/de/docs/advanced/using-request-directly.md @@ -29,7 +29,7 @@ Angenommen, Sie möchten auf die IP-Adresse/den Host des Clients in Ihrer *Pfado Dazu müssen Sie direkt auf den Request zugreifen. -{* ../../docs_src/using_request_directly/tutorial001_py39.py hl[1,7:8] *} +{* ../../docs_src/using_request_directly/tutorial001_py310.py hl[1,7:8] *} Durch die Deklaration eines *Pfadoperation-Funktionsparameters*, dessen Typ der `Request` ist, weiß **FastAPI**, dass es den `Request` diesem Parameter übergeben soll. diff --git a/docs/de/docs/advanced/websockets.md b/docs/de/docs/advanced/websockets.md index 05ae5a4b31..b1a49c5aad 100644 --- a/docs/de/docs/advanced/websockets.md +++ b/docs/de/docs/advanced/websockets.md @@ -38,13 +38,13 @@ In der Produktion hätten Sie eine der oben genannten Optionen. Aber es ist der einfachste Weg, sich auf die Serverseite von WebSockets zu konzentrieren und ein funktionierendes Beispiel zu haben: -{* ../../docs_src/websockets/tutorial001_py39.py hl[2,6:38,41:43] *} +{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *} ## Einen `websocket` erstellen { #create-a-websocket } Erstellen Sie in Ihrer **FastAPI**-Anwendung einen `websocket`: -{* ../../docs_src/websockets/tutorial001_py39.py hl[1,46:47] *} +{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *} /// note | Technische Details @@ -58,7 +58,7 @@ Sie könnten auch `from starlette.websockets import WebSocket` verwenden. In Ihrer WebSocket-Route können Sie Nachrichten `await`en und Nachrichten senden. -{* ../../docs_src/websockets/tutorial001_py39.py hl[48:52] *} +{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *} Sie können Binär-, Text- und JSON-Daten empfangen und senden. @@ -154,7 +154,7 @@ Damit können Sie den WebSocket verbinden und dann Nachrichten senden und empfan Wenn eine WebSocket-Verbindung geschlossen wird, löst `await websocket.receive_text()` eine `WebSocketDisconnect`-Exception aus, die Sie dann wie in folgendem Beispiel abfangen und behandeln können. -{* ../../docs_src/websockets/tutorial003_py39.py hl[79:81] *} +{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *} Zum Ausprobieren: diff --git a/docs/de/docs/advanced/wsgi.md b/docs/de/docs/advanced/wsgi.md index 0090883cea..b2f170e80b 100644 --- a/docs/de/docs/advanced/wsgi.md +++ b/docs/de/docs/advanced/wsgi.md @@ -18,7 +18,7 @@ Wrappen Sie dann die WSGI-Anwendung (z. B. Flask) mit der Middleware. Und dann mounten Sie das auf einem Pfad. -{* ../../docs_src/wsgi/tutorial001_py39.py hl[1,3,23] *} +{* ../../docs_src/wsgi/tutorial001_py310.py hl[1,3,23] *} /// note | Hinweis diff --git a/docs/de/docs/alternatives.md b/docs/de/docs/alternatives.md index 4dd127dbad..b6509ec09d 100644 --- a/docs/de/docs/alternatives.md +++ b/docs/de/docs/alternatives.md @@ -20,7 +20,7 @@ Es ist das beliebteste Python-Framework und genießt großes Vertrauen. Es wird Es ist relativ eng mit relationalen Datenbanken (wie MySQL oder PostgreSQL) gekoppelt, daher ist es nicht sehr einfach, eine NoSQL-Datenbank (wie Couchbase, MongoDB, Cassandra, usw.) als Hauptspeicherengine zu verwenden. -Es wurde erstellt, um den HTML-Code im Backend zu generieren, nicht um APIs zu erstellen, die von einem modernen Frontend (wie React, Vue.js und Angular) oder von anderen Systemen (wie IoT-Geräten) verwendet werden, um mit ihm zu kommunizieren. +Es wurde erstellt, um den HTML-Code im Backend zu generieren, nicht um APIs zu erstellen, die von einem modernen Frontend (wie React, Vue.js und Angular) oder von anderen Systemen (wie IoT-Geräten) verwendet werden, um mit ihm zu kommunizieren. ### Django REST Framework { #django-rest-framework } @@ -82,7 +82,7 @@ Aus diesem Grund heißt es auf der offiziellen Website: > Requests ist eines der am häufigsten heruntergeladenen Python-Packages aller Zeiten -Die Art und Weise, wie Sie es verwenden, ist sehr einfach. Um beispielsweise einen `GET`-Request zu machen, würden Sie schreiben: +Die Art und Weise, wie Sie es verwenden, ist sehr einfach. Um beispielsweise einen `GET`-Request zu machen, würden Sie schreiben: ```Python response = requests.get("http://example.com/some/url") @@ -137,7 +137,7 @@ Es gibt mehrere Flask REST Frameworks, aber nachdem ich die Zeit und Arbeit inve ### Marshmallow { #marshmallow } -Eine der von API-Systemen benötigten Hauptfunktionen ist die Daten-„Serialisierung“, welche Daten aus dem Code (Python) entnimmt und in etwas umwandelt, was durch das Netzwerk gesendet werden kann. Beispielsweise das Konvertieren eines Objekts, welches Daten aus einer Datenbank enthält, in ein JSON-Objekt. Konvertieren von `datetime`-Objekten in Strings, usw. +Eine der von API-Systemen benötigten Hauptfunktionen ist die Daten-„Serialisierung“, welche Daten aus dem Code (Python) entnimmt und in etwas umwandelt, was durch das Netzwerk gesendet werden kann. Beispielsweise das Konvertieren eines Objekts, welches Daten aus einer Datenbank enthält, in ein JSON-Objekt. Konvertieren von `datetime`-Objekten in Strings, usw. Eine weitere wichtige Funktion, benötigt von APIs, ist die Datenvalidierung, welche sicherstellt, dass die Daten unter gegebenen Umständen gültig sind. Zum Beispiel, dass ein Feld ein `int` ist und kein zufälliger String. Das ist besonders nützlich für hereinkommende Daten. @@ -145,7 +145,7 @@ Ohne ein Datenvalidierungssystem müssten Sie alle Prüfungen manuell im Code du Für diese Funktionen wurde Marshmallow entwickelt. Es ist eine großartige Bibliothek und ich habe sie schon oft genutzt. -Aber sie wurde erstellt, bevor Typhinweise in Python existierten. Um also ein Schema zu definieren, müssen Sie bestimmte Werkzeuge und Klassen verwenden, die von Marshmallow bereitgestellt werden. +Aber sie wurde erstellt, bevor Typhinweise in Python existierten. Um also ein Schema zu definieren, müssen Sie bestimmte Werkzeuge und Klassen verwenden, die von Marshmallow bereitgestellt werden. /// check | Inspirierte **FastAPI** @@ -155,7 +155,7 @@ Code zu verwenden, um „Schemas“ zu definieren, welche Datentypen und Validie ### Webargs { #webargs } -Eine weitere wichtige Funktion, die von APIs benötigt wird, ist das Parsen von Daten aus eingehenden Requests. +Eine weitere wichtige Funktion, die von APIs benötigt wird, ist das Parsen von Daten aus eingehenden Requests. Webargs wurde entwickelt, um dieses für mehrere Frameworks, einschließlich Flask, bereitzustellen. @@ -283,7 +283,7 @@ Aus diesem Grund basiert **FastAPI** auf Starlette, da dieses das schnellste ver Falcon ist ein weiteres leistungsstarkes Python-Framework. Es ist minimalistisch konzipiert und dient als Grundlage für andere Frameworks wie Hug. -Es ist so konzipiert, dass es über Funktionen verfügt, welche zwei Parameter empfangen, einen „Request“ und eine „Response“. Dann „lesen“ Sie Teile des Requests und „schreiben“ Teile der Response. Aufgrund dieses Designs ist es nicht möglich, Request-Parameter und -Bodys mit Standard-Python-Typhinweisen als Funktionsparameter zu deklarieren. +Es ist so konzipiert, dass es über Funktionen verfügt, welche zwei Parameter empfangen, einen „Request“ und eine „Response“. Dann „lesen“ Sie Teile des Requests und „schreiben“ Teile der Response. Aufgrund dieses Designs ist es nicht möglich, Request-Parameter und -Bodys mit Standard-Python-Typhinweisen als Funktionsparameter zu deklarieren. Daher müssen Datenvalidierung, Serialisierung und Dokumentation im Code und nicht automatisch erfolgen. Oder sie müssen als Framework oberhalb von Falcon implementiert werden, so wie Hug. Dieselbe Unterscheidung findet auch in anderen Frameworks statt, die vom Design von Falcon inspiriert sind und ein Requestobjekt und ein Responseobjekt als Parameter haben. @@ -419,7 +419,7 @@ Die gesamte Datenvalidierung, Datenserialisierung und automatische Modelldokumen ### Starlette { #starlette } -Starlette ist ein leichtgewichtiges ASGI-Framework/Toolkit, welches sich ideal für die Erstellung hochperformanter asynchroner Dienste eignet. +Starlette ist ein leichtgewichtiges ASGI-Framework/Toolkit, welches sich ideal für die Erstellung hochperformanter asynchroner Dienste eignet. Es ist sehr einfach und intuitiv. Es ist so konzipiert, dass es leicht erweiterbar ist und über modulare Komponenten verfügt. diff --git a/docs/de/docs/benchmarks.md b/docs/de/docs/benchmarks.md index 09126c5d99..285d35bf93 100644 --- a/docs/de/docs/benchmarks.md +++ b/docs/de/docs/benchmarks.md @@ -23,7 +23,7 @@ Die Hierarchie ist wie folgt: * Sie würden eine Anwendung nicht direkt in Uvicorn schreiben. Das würde bedeuten, dass Ihr Code zumindest mehr oder weniger den gesamten von Starlette (oder **FastAPI**) bereitgestellten Code enthalten müsste. Und wenn Sie das täten, hätte Ihre endgültige Anwendung den gleichen Overhead wie bei der Verwendung eines Frameworks und der Minimierung Ihres Anwendungscodes und der Fehler. * Wenn Sie Uvicorn vergleichen, vergleichen Sie es mit Anwendungsservern wie Daphne, Hypercorn, uWSGI, usw. * **Starlette**: - * Wird nach Uvicorn die nächstbeste Performanz erbringen. Tatsächlich verwendet Starlette intern Uvicorn, um zu laufen. Daher kann es wahrscheinlich nur „langsamer“ als Uvicorn werden, weil mehr Code ausgeführt werden muss. + * Wird nach Uvicorn die nächstbeste Performanz erbringen. Tatsächlich verwendet Starlette Uvicorn, um zu laufen. Daher kann es wahrscheinlich nur „langsamer“ als Uvicorn werden, weil mehr Code ausgeführt werden muss. * Aber es bietet Ihnen die Werkzeuge, um einfache Webanwendungen zu erstellen, mit Routing basierend auf Pfaden, usw. * Wenn Sie Starlette vergleichen, vergleichen Sie es mit Webframeworks (oder Mikroframeworks) wie Sanic, Flask, Django, usw. * **FastAPI**: diff --git a/docs/de/docs/deployment/cloud.md b/docs/de/docs/deployment/cloud.md index ad3ff76dbf..08a554b8d6 100644 --- a/docs/de/docs/deployment/cloud.md +++ b/docs/de/docs/deployment/cloud.md @@ -1,6 +1,6 @@ # FastAPI bei Cloudanbietern deployen { #deploy-fastapi-on-cloud-providers } -Sie können praktisch **jeden Cloudanbieter** verwenden, um Ihre FastAPI-Anwendung bereitzustellen. +Sie können praktisch **jeden Cloudanbieter** verwenden, um Ihre FastAPI-Anwendung zu deployen. In den meisten Fällen bieten die großen Cloudanbieter Anleitungen zum Deployment von FastAPI an. diff --git a/docs/de/docs/deployment/docker.md b/docs/de/docs/deployment/docker.md index 1e28efe521..704311b264 100644 --- a/docs/de/docs/deployment/docker.md +++ b/docs/de/docs/deployment/docker.md @@ -14,7 +14,7 @@ Sie haben es eilig und kennen sich bereits aus? Springen Sie zum [`Dockerfile` u Dockerfile-Vorschau 👀 ```Dockerfile -FROM python:3.9 +FROM python:3.14 WORKDIR /code @@ -166,7 +166,7 @@ Erstellen Sie nun im selben Projektverzeichnis eine Datei `Dockerfile` mit: ```{ .dockerfile .annotate } # (1)! -FROM python:3.9 +FROM python:3.14 # (2)! WORKDIR /code @@ -390,7 +390,7 @@ Wenn Ihr FastAPI eine einzelne Datei ist, zum Beispiel `main.py` ohne ein `./app Dann müssten Sie nur noch die entsprechenden Pfade ändern, um die Datei im `Dockerfile` zu kopieren: ```{ .dockerfile .annotate hl_lines="10 13" } -FROM python:3.9 +FROM python:3.14 WORKDIR /code @@ -454,7 +454,7 @@ Ohne die Verwendung von Containern kann es umständlich und schwierig sein, Anwe ## Replikation – Anzahl der Prozesse { #replication-number-of-processes } -Wenn Sie einen Cluster von Maschinen mit **Kubernetes**, Docker Swarm Mode, Nomad verwenden, oder einem anderen, ähnlich komplexen System zur Verwaltung verteilter Container auf mehreren Maschinen, möchten Sie wahrscheinlich die **Replikation auf Cluster-Ebene abwickeln**, anstatt in jedem Container einen **Prozessmanager** (wie Uvicorn mit Workern) zu verwenden. +Wenn Sie einen Cluster von Maschinen mit **Kubernetes**, Docker Swarm Mode, Nomad verwenden, oder einem anderen, ähnlich komplexen System zur Verwaltung verteilter Container auf mehreren Maschinen, möchten Sie wahrscheinlich die **Replikation auf Cluster-Ebene abwickeln**, anstatt in jedem Container einen **Prozessmanager** (wie Uvicorn mit Workern) zu verwenden. Diese verteilten Containerverwaltungssysteme wie Kubernetes verfügen normalerweise über eine integrierte Möglichkeit, die **Replikation von Containern** zu handhaben und gleichzeitig **Load Balancing** für die eingehenden Requests zu unterstützen. Alles auf **Cluster-Ebene**. @@ -499,7 +499,7 @@ Natürlich gibt es **Sonderfälle**, in denen Sie **einen Container** mit mehrer In diesen Fällen können Sie die `--workers` Befehlszeilenoption verwenden, um die Anzahl der zu startenden Worker festzulegen: ```{ .dockerfile .annotate } -FROM python:3.9 +FROM python:3.14 WORKDIR /code @@ -570,7 +570,7 @@ Wenn Sie ein einfaches Setup mit einem **einzelnen Container** haben, welcher da ### Docker-Basisimage { #base-docker-image } -Es gab ein offizielles FastAPI-Docker-Image: tiangolo/uvicorn-gunicorn-fastapi. Dieses ist jedoch jetzt veraltet. ⛔️ +Es gab ein offizielles FastAPI-Docker-Image: tiangolo/uvicorn-gunicorn-fastapi. Dieses ist jedoch jetzt deprecatet. ⛔️ Sie sollten wahrscheinlich **nicht** dieses Basis-Docker-Image (oder ein anderes ähnliches) verwenden. diff --git a/docs/de/docs/deployment/https.md b/docs/de/docs/deployment/https.md index 1c4ce6b44f..08963306fb 100644 --- a/docs/de/docs/deployment/https.md +++ b/docs/de/docs/deployment/https.md @@ -65,7 +65,7 @@ Hier ist ein Beispiel, wie eine HTTPS-API aussehen könnte, Schritt für Schritt Alles beginnt wahrscheinlich damit, dass Sie einen **Domainnamen erwerben**. Anschließend konfigurieren Sie ihn in einem DNS-Server (wahrscheinlich beim selben Cloudanbieter). -Sie würden wahrscheinlich einen Cloud-Server (eine virtuelle Maschine) oder etwas Ähnliches bekommen, und dieser hätte eine feste **öffentliche IP-Adresse**. +Sie würden wahrscheinlich einen Cloud-Server (eine virtuelle Maschine) oder etwas Ähnliches bekommen, und dieser hätte eine feste **öffentliche IP-Adresse**. In dem oder den DNS-Server(n) würden Sie einen Eintrag (einen „`A record`“) konfigurieren, um mit **Ihrer Domain** auf die öffentliche **IP-Adresse Ihres Servers** zu verweisen. diff --git a/docs/de/docs/deployment/index.md b/docs/de/docs/deployment/index.md index cb3e537463..0c83cc529d 100644 --- a/docs/de/docs/deployment/index.md +++ b/docs/de/docs/deployment/index.md @@ -4,7 +4,7 @@ Das Deployment einer **FastAPI**-Anwendung ist relativ einfach. ## Was bedeutet Deployment { #what-does-deployment-mean } -**Deployment** bedeutet, die notwendigen Schritte durchzuführen, um die Anwendung **für die Endbenutzer verfügbar** zu machen. +**Deployment** bedeutet, die notwendigen Schritte durchzuführen, um die Anwendung **für die Benutzer verfügbar** zu machen. Bei einer **Web-API** bedeutet das normalerweise, diese auf einem **entfernten Rechner** zu platzieren, mit einem **Serverprogramm**, welches gute Leistung, Stabilität, usw. bietet, damit Ihre **Benutzer** auf die Anwendung effizient und ohne Unterbrechungen oder Probleme **zugreifen** können. diff --git a/docs/de/docs/deployment/server-workers.md b/docs/de/docs/deployment/server-workers.md index 7b68f1b1a6..fbc9f69067 100644 --- a/docs/de/docs/deployment/server-workers.md +++ b/docs/de/docs/deployment/server-workers.md @@ -119,7 +119,7 @@ In der Liste der Deployment-Konzepte von oben würde die Verwendung von Workern * **Sicherheit – HTTPS** * **Beim Hochfahren ausführen** -* **Neustarts** +* ***Neustarts*** * Replikation (die Anzahl der laufenden Prozesse) * **Arbeitsspeicher** * **Schritte vor dem Start** diff --git a/docs/de/docs/features.md b/docs/de/docs/features.md index 0b51e9737a..6b7b4c296e 100644 --- a/docs/de/docs/features.md +++ b/docs/de/docs/features.md @@ -6,7 +6,7 @@ ### Basiert auf offenen Standards { #based-on-open-standards } -* OpenAPI für die Erstellung von APIs, inklusive Deklarationen von Pfad-Operationen, Parametern, Requestbodys, Sicherheit, usw. +* OpenAPI für die Erstellung von APIs, inklusive Deklarationen von Pfad-Operationen, Parametern, Requestbodys, Sicherheit, usw. * Automatische Dokumentation der Datenmodelle mit JSON Schema (da OpenAPI selbst auf JSON Schema basiert). * Um diese Standards herum entworfen, nach sorgfältigem Studium. Statt einer nachträglichen Schicht darüber. * Dies ermöglicht auch automatische **Client-Code-Generierung** in vielen Sprachen. @@ -136,7 +136,7 @@ Alles als wiederverwendbare Tools und Komponenten gebaut, die einfach in Ihre Sy ### Dependency Injection { #dependency-injection } -FastAPI enthält ein extrem einfach zu verwendendes, aber extrem mächtiges Dependency Injection System. +FastAPI enthält ein extrem einfach zu verwendendes, aber extrem mächtiges Dependency Injection System. * Selbst Abhängigkeiten können Abhängigkeiten haben, woraus eine Hierarchie oder ein **„Graph“ von Abhängigkeiten** entsteht. * Alles **automatisch gehandhabt** durch das Framework. @@ -153,8 +153,8 @@ Jede Integration wurde so entworfen, dass sie so einfach zu nutzen ist (mit Abh ### Getestet { #tested } -* 100 % Testabdeckung. -* 100 % Typen annotiert. +* 100 % Testabdeckung. +* 100 % Typen annotiert. * Verwendet in Produktionsanwendungen. ## Starlette Merkmale { #starlette-features } @@ -179,7 +179,7 @@ Mit **FastAPI** bekommen Sie alles von **Starlette** (da FastAPI nur Starlette a **FastAPI** ist vollkommen kompatibel (und basiert auf) Pydantic. Das bedeutet, wenn Sie eigenen Pydantic Quellcode haben, funktioniert der. -Inklusive externer Bibliotheken, die auf Pydantic basieren, wie ORMs, ODMs für Datenbanken. +Inklusive externer Bibliotheken, die auf Pydantic basieren, wie ORMs, ODMs für Datenbanken. Daher können Sie in vielen Fällen das Objekt eines Requests **direkt zur Datenbank** schicken, weil alles automatisch validiert wird. @@ -190,7 +190,7 @@ Mit **FastAPI** bekommen Sie alle Funktionen von **Pydantic** (da FastAPI für d * **Kein Kopfzerbrechen**: * Keine neue Schemadefinition-Mikrosprache zu lernen. * Wenn Sie Pythons Typen kennen, wissen Sie, wie man Pydantic verwendet. -* Gutes Zusammenspiel mit Ihrer/Ihrem **IDE/Linter/Gehirn**: +* Gutes Zusammenspiel mit Ihrer/Ihrem **IDE/Linter/Gehirn**: * Weil Pydantics Datenstrukturen einfach nur Instanzen ihrer definierten Klassen sind; Autovervollständigung, Linting, mypy und Ihre Intuition sollten alle einwandfrei mit Ihren validierten Daten funktionieren. * Validierung von **komplexen Strukturen**: * Benutzung von hierarchischen Pydantic-Modellen, Python-`typing`s `List` und `Dict`, etc. diff --git a/docs/de/docs/history-design-future.md b/docs/de/docs/history-design-future.md index 45198ff1cb..0217f42768 100644 --- a/docs/de/docs/history-design-future.md +++ b/docs/de/docs/history-design-future.md @@ -58,7 +58,7 @@ Nachdem ich mehrere Alternativen getestet hatte, entschied ich, dass ich **Starlette** beigetragen, der anderen Schlüsselanforderung. +Während der Entwicklung habe ich auch zu **Starlette** beigetragen, die andere Schlüsselanforderung. ## Entwicklung { #development } diff --git a/docs/de/docs/how-to/authentication-error-status-code.md b/docs/de/docs/how-to/authentication-error-status-code.md index c743b54d9e..2d54926ff8 100644 --- a/docs/de/docs/how-to/authentication-error-status-code.md +++ b/docs/de/docs/how-to/authentication-error-status-code.md @@ -8,7 +8,7 @@ Aber falls Ihre Clients aus irgendeinem Grund vom alten Verhalten abhängen, kö Sie können beispielsweise eine Unterklasse von `HTTPBearer` erstellen, die einen Fehler `403 Forbidden` zurückgibt, statt des Default-`401 Unauthorized`-Fehlers: -{* ../../docs_src/authentication_error_status_code/tutorial001_an_py39.py hl[9:13] *} +{* ../../docs_src/authentication_error_status_code/tutorial001_an_py310.py hl[9:13] *} /// tip | Tipp diff --git a/docs/de/docs/how-to/conditional-openapi.md b/docs/de/docs/how-to/conditional-openapi.md index 6e665cc4c0..07573f01f9 100644 --- a/docs/de/docs/how-to/conditional-openapi.md +++ b/docs/de/docs/how-to/conditional-openapi.md @@ -29,7 +29,7 @@ Sie können problemlos dieselben Pydantic-Einstellungen verwenden, um Ihre gener Zum Beispiel: -{* ../../docs_src/conditional_openapi/tutorial001_py39.py hl[6,11] *} +{* ../../docs_src/conditional_openapi/tutorial001_py310.py hl[6,11] *} Hier deklarieren wir die Einstellung `openapi_url` mit dem gleichen Defaultwert `"/openapi.json"`. diff --git a/docs/de/docs/how-to/configure-swagger-ui.md b/docs/de/docs/how-to/configure-swagger-ui.md index 1c3f5c0c5a..efb57339c5 100644 --- a/docs/de/docs/how-to/configure-swagger-ui.md +++ b/docs/de/docs/how-to/configure-swagger-ui.md @@ -18,7 +18,7 @@ Ohne Änderung der Einstellungen ist die Syntaxhervorhebung standardmäßig akti Sie können sie jedoch deaktivieren, indem Sie `syntaxHighlight` auf `False` setzen: -{* ../../docs_src/configure_swagger_ui/tutorial001_py39.py hl[3] *} +{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *} ... und dann zeigt die Swagger-Oberfläche die Syntaxhervorhebung nicht mehr an: @@ -28,7 +28,7 @@ Sie können sie jedoch deaktivieren, indem Sie `syntaxHighlight` auf `False` set Auf die gleiche Weise könnten Sie das Theme der Syntaxhervorhebung mit dem Schlüssel `"syntaxHighlight.theme"` festlegen (beachten Sie, dass er einen Punkt in der Mitte hat): -{* ../../docs_src/configure_swagger_ui/tutorial002_py39.py hl[3] *} +{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *} Obige Konfiguration würde das Theme für die Farbe der Syntaxhervorhebung ändern: @@ -46,7 +46,7 @@ Sie können jede davon überschreiben, indem Sie im Argument `swagger_ui_paramet Um beispielsweise `deepLinking` zu deaktivieren, könnten Sie folgende Einstellungen an `swagger_ui_parameters` übergeben: -{* ../../docs_src/configure_swagger_ui/tutorial003_py39.py hl[3] *} +{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *} ## Andere Parameter der Swagger-Oberfläche { #other-swagger-ui-parameters } diff --git a/docs/de/docs/how-to/custom-docs-ui-assets.md b/docs/de/docs/how-to/custom-docs-ui-assets.md index 6b1d654adf..a34a21a31d 100644 --- a/docs/de/docs/how-to/custom-docs-ui-assets.md +++ b/docs/de/docs/how-to/custom-docs-ui-assets.md @@ -18,7 +18,7 @@ Der erste Schritt besteht darin, die automatischen Dokumentationen zu deaktivier Um diese zu deaktivieren, setzen Sie deren URLs beim Erstellen Ihrer `FastAPI`-App auf `None`: -{* ../../docs_src/custom_docs_ui/tutorial001_py39.py hl[8] *} +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[8] *} ### Die benutzerdefinierten Dokumentationen hinzufügen { #include-the-custom-docs } @@ -34,7 +34,7 @@ Sie können die internen Funktionen von FastAPI wiederverwenden, um die HTML-Sei Und ähnlich für ReDoc ... -{* ../../docs_src/custom_docs_ui/tutorial001_py39.py hl[2:6,11:19,22:24,27:33] *} +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[2:6,11:19,22:24,27:33] *} /// tip | Tipp @@ -50,7 +50,7 @@ Swagger UI erledigt das hinter den Kulissen für Sie, benötigt aber diesen „U Um nun testen zu können, ob alles funktioniert, erstellen Sie eine *Pfadoperation*: -{* ../../docs_src/custom_docs_ui/tutorial001_py39.py hl[36:38] *} +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[36:38] *} ### Es testen { #test-it } @@ -118,7 +118,7 @@ Danach könnte Ihre Dateistruktur wie folgt aussehen: * Importieren Sie `StaticFiles`. * „Mounten“ Sie eine `StaticFiles()`-Instanz in einem bestimmten Pfad. -{* ../../docs_src/custom_docs_ui/tutorial002_py39.py hl[7,11] *} +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[7,11] *} ### Die statischen Dateien testen { #test-the-static-files } @@ -144,7 +144,7 @@ Wie bei der Verwendung eines benutzerdefinierten CDN besteht der erste Schritt d Um sie zu deaktivieren, setzen Sie deren URLs beim Erstellen Ihrer `FastAPI`-App auf `None`: -{* ../../docs_src/custom_docs_ui/tutorial002_py39.py hl[9] *} +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[9] *} ### Die benutzerdefinierten Dokumentationen für statische Dateien hinzufügen { #include-the-custom-docs-for-static-files } @@ -160,7 +160,7 @@ Auch hier können Sie die internen Funktionen von FastAPI wiederverwenden, um di Und ähnlich für ReDoc ... -{* ../../docs_src/custom_docs_ui/tutorial002_py39.py hl[2:6,14:22,25:27,30:36] *} +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[2:6,14:22,25:27,30:36] *} /// tip | Tipp @@ -176,7 +176,7 @@ Swagger UI erledigt das hinter den Kulissen für Sie, benötigt aber diesen „U Um nun testen zu können, ob alles funktioniert, erstellen Sie eine *Pfadoperation*: -{* ../../docs_src/custom_docs_ui/tutorial002_py39.py hl[39:41] *} +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[39:41] *} ### Benutzeroberfläche mit statischen Dateien testen { #test-static-files-ui } diff --git a/docs/de/docs/how-to/extending-openapi.md b/docs/de/docs/how-to/extending-openapi.md index c07ed2aa08..d23dc4df0d 100644 --- a/docs/de/docs/how-to/extending-openapi.md +++ b/docs/de/docs/how-to/extending-openapi.md @@ -43,19 +43,19 @@ Fügen wir beispielsweise Requests verwendet. -{* ../../docs_src/extending_openapi/tutorial001_py39.py hl[13:14,25:26] *} +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[13:14,25:26] *} ### Die Methode überschreiben { #override-the-method } Jetzt können Sie die Methode `.openapi()` durch Ihre neue Funktion ersetzen. -{* ../../docs_src/extending_openapi/tutorial001_py39.py hl[29] *} +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[29] *} ### Es testen { #check-it } diff --git a/docs/de/docs/how-to/graphql.md b/docs/de/docs/how-to/graphql.md index 5c908cec4a..1f0c96eef2 100644 --- a/docs/de/docs/how-to/graphql.md +++ b/docs/de/docs/how-to/graphql.md @@ -35,7 +35,7 @@ Abhängig von Ihrem Anwendungsfall könnten Sie eine andere Bibliothek vorziehen Hier ist eine kleine Vorschau, wie Sie Strawberry mit FastAPI integrieren können: -{* ../../docs_src/graphql_/tutorial001_py39.py hl[3,22,25] *} +{* ../../docs_src/graphql_/tutorial001_py310.py hl[3,22,25] *} Weitere Informationen zu Strawberry finden Sie in der Strawberry-Dokumentation. diff --git a/docs/de/docs/index.md b/docs/de/docs/index.md index 3ce5cb27ff..bb28c68f70 100644 --- a/docs/de/docs/index.md +++ b/docs/de/docs/index.md @@ -40,7 +40,7 @@ Seine Schlüssel-Merkmale sind: * **Schnell**: Sehr hohe Performanz, auf Augenhöhe mit **NodeJS** und **Go** (dank Starlette und Pydantic). [Eines der schnellsten verfügbaren Python-Frameworks](#performance). * **Schnell zu entwickeln**: Erhöhen Sie die Geschwindigkeit bei der Entwicklung von Features um etwa 200 % bis 300 %. * * **Weniger Bugs**: Verringern Sie die von Menschen (Entwicklern) verursachten Fehler um etwa 40 %. * -* **Intuitiv**: Hervorragende Editor-Unterstützung. Code-Vervollständigung überall. Weniger Zeit mit Debuggen verbringen. +* **Intuitiv**: Hervorragende Editor-Unterstützung. Code-Vervollständigung überall. Weniger Zeit mit Debuggen verbringen. * **Einfach**: So konzipiert, dass es einfach zu benutzen und zu erlernen ist. Weniger Zeit mit dem Lesen von Dokumentation verbringen. * **Kurz**: Minimieren Sie die Verdoppelung von Code. Mehrere Features aus jeder Parameterdeklaration. Weniger Bugs. * **Robust**: Erhalten Sie produktionsreifen Code. Mit automatischer, interaktiver Dokumentation. @@ -363,12 +363,12 @@ item: Item ... und mit dieser einen Deklaration erhalten Sie: * Editor-Unterstützung, einschließlich: - * Code-Vervollständigung. + * Vervollständigung. * Typprüfungen. * Validierung von Daten: * Automatische und eindeutige Fehler, wenn die Daten ungültig sind. * Validierung sogar für tief verschachtelte JSON-Objekte. -* Konvertierung von Eingabedaten: Aus dem Netzwerk kommend, zu Python-Daten und -Typen. Lesen von: +* Konvertierung von Eingabedaten: Aus dem Netzwerk kommend, zu Python-Daten und -Typen. Lesen von: * JSON. * Pfad-Parametern. * Query-Parametern. @@ -376,7 +376,7 @@ item: Item * Headern. * Formularen. * Dateien. -* Konvertierung von Ausgabedaten: Konvertierung von Python-Daten und -Typen zu Netzwerkdaten (als JSON): +* Konvertierung von Ausgabedaten: Konvertierung von Python-Daten und -Typen zu Netzwerkdaten (als JSON): * Konvertieren von Python-Typen (`str`, `int`, `float`, `bool`, `list`, usw.). * `datetime`-Objekte. * `UUID`-Objekte. @@ -439,7 +439,7 @@ Für ein vollständigeres Beispiel, mit weiteren Funktionen, siehe das Dependency Injection**. +* Ein sehr leistungsfähiges und einfach zu bedienendes System für **Dependency Injection**. * Sicherheit und Authentifizierung, einschließlich Unterstützung für **OAuth2** mit **JWT-Tokens** und **HTTP Basic** Authentifizierung. * Fortgeschrittenere (aber ebenso einfache) Techniken zur Deklaration **tief verschachtelter JSON-Modelle** (dank Pydantic). * **GraphQL**-Integration mit Strawberry und anderen Bibliotheken. @@ -524,7 +524,7 @@ Verwendet von Starlette: * httpx – erforderlich, wenn Sie den `TestClient` verwenden möchten. * jinja2 – erforderlich, wenn Sie die Default-Template-Konfiguration verwenden möchten. -* python-multipart – erforderlich, wenn Sie Formulare mittels `request.form()` „parsen“ möchten. +* python-multipart – erforderlich, wenn Sie Formulare mittels `request.form()` „parsen“ möchten. Verwendet von FastAPI: diff --git a/docs/de/docs/project-generation.md b/docs/de/docs/project-generation.md index 62702d8529..2c252933d9 100644 --- a/docs/de/docs/project-generation.md +++ b/docs/de/docs/project-generation.md @@ -20,7 +20,7 @@ GitHub-Repository: „Typhinweise“ (auch „Typannotationen“ genannt). +Python hat Unterstützung für optionale „Typhinweise“ (auch „Typannotationen“ genannt). -Diese **„Typhinweise“** oder -Annotationen sind eine spezielle Syntax, die es erlaubt, den Typ einer Variablen zu deklarieren. +Diese **„Typhinweise“** oder -Annotationen sind eine spezielle Syntax, die es erlaubt, den Typ einer Variablen zu deklarieren. Durch das Deklarieren von Typen für Ihre Variablen können Editoren und Tools bessere Unterstützung bieten. @@ -22,7 +22,7 @@ Wenn Sie ein Python-Experte sind und bereits alles über Typhinweise wissen, üb Fangen wir mit einem einfachen Beispiel an: -{* ../../docs_src/python_types/tutorial001_py39.py *} +{* ../../docs_src/python_types/tutorial001_py310.py *} Dieses Programm gibt aus: @@ -34,9 +34,9 @@ Die Funktion macht Folgendes: * Nimmt einen `first_name` und `last_name`. * Schreibt den ersten Buchstaben eines jeden Wortes groß, mithilfe von `title()`. -* Verkettet sie mit einem Leerzeichen in der Mitte. +* Verkettet sie mit einem Leerzeichen in der Mitte. -{* ../../docs_src/python_types/tutorial001_py39.py hl[2] *} +{* ../../docs_src/python_types/tutorial001_py310.py hl[2] *} ### Es bearbeiten { #edit-it } @@ -78,7 +78,7 @@ Das war's. Das sind die „Typhinweise“: -{* ../../docs_src/python_types/tutorial002_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial002_py310.py hl[1] *} Das ist nicht das gleiche wie das Deklarieren von Defaultwerten, wie es hier der Fall ist: @@ -106,7 +106,7 @@ Hier können Sie durch die Optionen blättern, bis Sie diejenige finden, bei der Sehen Sie sich diese Funktion an, sie hat bereits Typhinweise: -{* ../../docs_src/python_types/tutorial003_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial003_py310.py hl[1] *} Da der Editor die Typen der Variablen kennt, erhalten Sie nicht nur Code-Vervollständigung, sondern auch eine Fehlerprüfung: @@ -114,7 +114,7 @@ Da der Editor die Typen der Variablen kennt, erhalten Sie nicht nur Code-Vervoll Jetzt, da Sie wissen, dass Sie das reparieren müssen, konvertieren Sie `age` mittels `str(age)` in einen String: -{* ../../docs_src/python_types/tutorial004_py39.py hl[2] *} +{* ../../docs_src/python_types/tutorial004_py310.py hl[2] *} ## Deklarieren von Typen { #declaring-types } @@ -133,29 +133,32 @@ Zum Beispiel diese: * `bool` * `bytes` -{* ../../docs_src/python_types/tutorial005_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial005_py310.py hl[1] *} -### Generische Typen mit Typ-Parametern { #generic-types-with-type-parameters } +### `typing`-Modul { #typing-module } -Es gibt Datenstrukturen, die andere Werte enthalten können, wie etwa `dict`, `list`, `set` und `tuple`. Die inneren Werte können auch ihren eigenen Typ haben. +Für einige zusätzliche Anwendungsfälle müssen Sie möglicherweise Dinge aus dem Standardmodul `typing` importieren. Zum Beispiel, wenn Sie deklarieren möchten, dass etwas „jeden Typ“ haben kann, können Sie `Any` aus `typing` verwenden: -Diese Typen mit inneren Typen werden „**generische**“ Typen genannt. Es ist möglich, sie mit ihren inneren Typen zu deklarieren. +```python +from typing import Any -Um diese Typen und die inneren Typen zu deklarieren, können Sie Pythons Standardmodul `typing` verwenden. Es existiert speziell für die Unterstützung dieser Typhinweise. -#### Neuere Python-Versionen { #newer-versions-of-python } +def some_function(data: Any): + print(data) +``` -Die Syntax, welche `typing` verwendet, ist **kompatibel** mit allen Versionen, von Python 3.6 aufwärts zu den neuesten, inklusive Python 3.9, Python 3.10, usw. +### Generische Typen { #generic-types } -Mit der Weiterentwicklung von Python kommen **neuere Versionen** heraus, mit verbesserter Unterstützung für Typannotationen, und in vielen Fällen müssen Sie gar nicht mehr das `typing`-Modul importieren, um Typannotationen zu schreiben. +Einige Typen können „Typ-Parameter“ in eckigen Klammern annehmen, um ihre inneren Typen zu definieren, z. B. eine „Liste von Strings“ würde als `list[str]` deklariert. -Wenn Sie eine neuere Python-Version für Ihr Projekt wählen können, werden Sie aus dieser zusätzlichen Vereinfachung Nutzen ziehen können. +Diese Typen, die Typ-Parameter annehmen können, werden **generische Typen** oder **Generics** genannt. -In der gesamten Dokumentation gibt es Beispiele, welche kompatibel mit unterschiedlichen Python-Versionen sind (wenn es Unterschiede gibt). +Sie können dieselben eingebauten Typen als Generics verwenden (mit eckigen Klammern und Typen darin): -Zum Beispiel bedeutet „**Python 3.6+**“, dass das Beispiel kompatibel mit Python 3.6 oder höher ist (inklusive 3.7, 3.8, 3.9, 3.10, usw.). Und „**Python 3.9+**“ bedeutet, es ist kompatibel mit Python 3.9 oder höher (inklusive 3.10, usw.). - -Wenn Sie über die **neueste Version von Python** verfügen, verwenden Sie die Beispiele für die neueste Version, diese werden die **beste und einfachste Syntax** haben, zum Beispiel, „**Python 3.10+**“. +* `list` +* `tuple` +* `set` +* `dict` #### Liste { #list } @@ -167,7 +170,7 @@ Als Typ nehmen Sie `list`. Da die Liste ein Typ ist, welcher innere Typen enthält, werden diese von eckigen Klammern umfasst: -{* ../../docs_src/python_types/tutorial006_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial006_py310.py hl[1] *} /// info | Info @@ -193,7 +196,7 @@ Und trotzdem weiß der Editor, dass es sich um ein `str` handelt, und bietet ent Das Gleiche gilt für die Deklaration eines Tupels – `tuple` – und einer Menge – `set`: -{* ../../docs_src/python_types/tutorial007_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial007_py310.py hl[1] *} Das bedeutet: @@ -208,7 +211,7 @@ Der erste Typ-Parameter ist für die Schlüssel des `dict`. Der zweite Typ-Parameter ist für die Werte des `dict`: -{* ../../docs_src/python_types/tutorial008_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial008_py310.py hl[1] *} Das bedeutet: @@ -216,47 +219,23 @@ Das bedeutet: * Die Schlüssel dieses `dict` sind vom Typ `str` (z. B. die Namen der einzelnen Artikel). * Die Werte dieses `dict` sind vom Typ `float` (z. B. der Preis jedes Artikels). -#### Union { #union } +#### Union { #union } Sie können deklarieren, dass eine Variable einer von **verschiedenen Typen** sein kann, zum Beispiel ein `int` oder ein `str`. -In Python 3.6 und höher (inklusive Python 3.10) können Sie den `Union`-Typ von `typing` verwenden und die möglichen Typen innerhalb der eckigen Klammern auflisten. +Um das zu definieren, verwenden Sie den vertikalen Balken (`|`), um beide Typen zu trennen. -In Python 3.10 gibt es zusätzlich eine **neue Syntax**, die es erlaubt, die möglichen Typen getrennt von einem vertikalen Balken (`|`) aufzulisten. - -//// tab | Python 3.10+ +Das wird „Union“ genannt, weil die Variable etwas aus der Vereinigung dieser beiden Typmengen sein kann. ```Python hl_lines="1" {!> ../../docs_src/python_types/tutorial008b_py310.py!} ``` -//// - -//// tab | Python 3.9+ - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial008b_py39.py!} -``` - -//// - -In beiden Fällen bedeutet das, dass `item` ein `int` oder ein `str` sein kann. +Das bedeutet, dass `item` ein `int` oder ein `str` sein könnte. #### Vielleicht `None` { #possibly-none } -Sie können deklarieren, dass ein Wert ein `str`, aber vielleicht auch `None` sein kann. - -In Python 3.6 und darüber (inklusive Python 3.10) können Sie das deklarieren, indem Sie `Optional` vom `typing` Modul importieren und verwenden. - -```Python hl_lines="1 4" -{!../../docs_src/python_types/tutorial009_py39.py!} -``` - -Wenn Sie `Optional[str]` anstelle von nur `str` verwenden, wird Ihr Editor Ihnen dabei helfen, Fehler zu erkennen, bei denen Sie annehmen könnten, dass ein Wert immer eine String (`str`) ist, obwohl er auch `None` sein könnte. - -`Optional[Something]` ist tatsächlich eine Abkürzung für `Union[Something, None]`, diese beiden sind äquivalent. - -Das bedeutet auch, dass Sie in Python 3.10 `Something | None` verwenden können: +Sie können deklarieren, dass ein Wert einen Typ haben könnte, wie `str`, dass er aber auch `None` sein könnte. //// tab | Python 3.10+ @@ -266,96 +245,7 @@ Das bedeutet auch, dass Sie in Python 3.10 `Something | None` verwenden können: //// -//// tab | Python 3.9+ - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial009_py39.py!} -``` - -//// - -//// tab | Python 3.9+ Alternative - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial009b_py39.py!} -``` - -//// - -#### `Union` oder `Optional` verwenden? { #using-union-or-optional } - -Wenn Sie eine Python-Version unterhalb 3.10 verwenden, hier ist mein sehr **subjektiver** Standpunkt dazu: - -* 🚨 Vermeiden Sie `Optional[SomeType]` -* Stattdessen ✨ **verwenden Sie `Union[SomeType, None]`** ✨. - -Beide sind äquivalent und im Hintergrund dasselbe, aber ich empfehle `Union` statt `Optional`, weil das Wort „**optional**“ impliziert, dass dieser Wert, zum Beispiel als Funktionsparameter, optional ist. Tatsächlich bedeutet es aber nur „Der Wert kann `None` sein“, selbst wenn der Wert nicht optional ist und benötigt wird. - -Ich denke, `Union[SomeType, None]` ist expliziter bezüglich seiner Bedeutung. - -Es geht nur um Worte und Namen. Aber diese Worte können beeinflussen, wie Sie und Ihre Teamkollegen über den Code denken. - -Nehmen wir zum Beispiel diese Funktion: - -{* ../../docs_src/python_types/tutorial009c_py39.py hl[1,4] *} - -Der Parameter `name` ist definiert als `Optional[str]`, aber er ist **nicht optional**, Sie können die Funktion nicht ohne diesen Parameter aufrufen: - -```Python -say_hi() # Oh, nein, das löst einen Fehler aus! 😱 -``` - -Der `name` Parameter wird **immer noch benötigt** (nicht *optional*), weil er keinen Default-Wert hat. `name` akzeptiert aber dennoch `None` als Wert: - -```Python -say_hi(name=None) # Das funktioniert, None ist gültig 🎉 -``` - -Die gute Nachricht ist, dass Sie sich darüber keine Sorgen mehr machen müssen, wenn Sie Python 3.10 verwenden, da Sie einfach `|` verwenden können, um Vereinigungen von Typen zu definieren: - -{* ../../docs_src/python_types/tutorial009c_py310.py hl[1,4] *} - -Und dann müssen Sie sich nicht mehr um Namen wie `Optional` und `Union` kümmern. 😎 - -#### Generische Typen { #generic-types } - -Diese Typen, die Typ-Parameter in eckigen Klammern akzeptieren, werden **generische Typen** oder **Generics** genannt. - -//// tab | Python 3.10+ - -Sie können die eingebauten Typen als Generics verwenden (mit eckigen Klammern und Typen darin): - -* `list` -* `tuple` -* `set` -* `dict` - -Und ebenso wie bei früheren Python-Versionen, aus dem `typing`-Modul: - -* `Union` -* `Optional` -* ... und andere. - -In Python 3.10 können Sie als Alternative zu den Generics `Union` und `Optional` den vertikalen Balken (`|`) verwenden, um Vereinigungen von Typen zu deklarieren, das ist besser und einfacher. - -//// - -//// tab | Python 3.9+ - -Sie können die eingebauten Typen als Generics verwenden (mit eckigen Klammern und Typen darin): - -* `list` -* `tuple` -* `set` -* `dict` - -Und Generics aus dem `typing`-Modul: - -* `Union` -* `Optional` -* ... und andere. - -//// +Wenn Sie `str | None` anstelle von nur `str` verwenden, wird Ihr Editor Ihnen dabei helfen, Fehler zu erkennen, bei denen Sie annehmen könnten, dass ein Wert immer ein `str` ist, obwohl er auch `None` sein könnte. ### Klassen als Typen { #classes-as-types } @@ -363,11 +253,11 @@ Sie können auch eine Klasse als Typ einer Variablen deklarieren. Nehmen wir an, Sie haben eine Klasse `Person`, mit einem Namen: -{* ../../docs_src/python_types/tutorial010_py39.py hl[1:3] *} +{* ../../docs_src/python_types/tutorial010_py310.py hl[1:3] *} Dann können Sie eine Variable vom Typ `Person` deklarieren: -{* ../../docs_src/python_types/tutorial010_py39.py hl[6] *} +{* ../../docs_src/python_types/tutorial010_py310.py hl[6] *} Und wiederum bekommen Sie die volle Editor-Unterstützung: @@ -403,19 +293,13 @@ Um mehr über Erforderliche optionale Felder mehr erfahren. - -/// - ## Typhinweise mit Metadaten-Annotationen { #type-hints-with-metadata-annotations } -Python bietet auch die Möglichkeit, **zusätzliche Metadaten** in Typhinweisen unterzubringen, mittels `Annotated`. +Python bietet auch die Möglichkeit, **zusätzliche Metadaten** in Typhinweisen unterzubringen, mittels `Annotated`. -Seit Python 3.9 ist `Annotated` ein Teil der Standardbibliothek, Sie können es von `typing` importieren. +Sie können `Annotated` von `typing` importieren. -{* ../../docs_src/python_types/tutorial013_py39.py hl[1,4] *} +{* ../../docs_src/python_types/tutorial013_py310.py hl[1,4] *} Python selbst macht nichts mit `Annotated`. Für Editoren und andere Tools ist der Typ immer noch `str`. diff --git a/docs/de/docs/translation-banner.md b/docs/de/docs/translation-banner.md new file mode 100644 index 0000000000..1801a01904 --- /dev/null +++ b/docs/de/docs/translation-banner.md @@ -0,0 +1,11 @@ +/// details | 🌐 Übersetzung durch KI und Menschen + +Diese Übersetzung wurde von KI erstellt, angeleitet von Menschen. 🤝 + +Sie könnte Fehler enthalten, etwa Missverständnisse des ursprünglichen Sinns oder unnatürliche Formulierungen, usw. 🤖 + +Sie können diese Übersetzung verbessern, indem Sie [uns helfen, die KI-LLM besser anzuleiten](https://fastapi.tiangolo.com/de/contributing/#translations). + +[Englische Version](ENGLISH_VERSION_URL) + +/// diff --git a/docs/de/docs/tutorial/background-tasks.md b/docs/de/docs/tutorial/background-tasks.md index 1d34430dc6..950174d9cb 100644 --- a/docs/de/docs/tutorial/background-tasks.md +++ b/docs/de/docs/tutorial/background-tasks.md @@ -15,7 +15,7 @@ Hierzu zählen beispielsweise: Importieren Sie zunächst `BackgroundTasks` und definieren Sie einen Parameter in Ihrer *Pfadoperation-Funktion* mit der Typdeklaration `BackgroundTasks`: -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[1,13] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[1,13] *} **FastAPI** erstellt für Sie das Objekt vom Typ `BackgroundTasks` und übergibt es als diesen Parameter. @@ -31,13 +31,13 @@ In diesem Fall schreibt die Taskfunktion in eine Datei (den Versand einer E-Mail Und da der Schreibvorgang nicht `async` und `await` verwendet, definieren wir die Funktion mit normalem `def`: -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[6:9] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[6:9] *} ## Den Hintergrundtask hinzufügen { #add-the-background-task } Übergeben Sie innerhalb Ihrer *Pfadoperation-Funktion* Ihre Taskfunktion mit der Methode `.add_task()` an das *Hintergrundtasks*-Objekt: -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[14] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[14] *} `.add_task()` erhält als Argumente: diff --git a/docs/de/docs/tutorial/bigger-applications.md b/docs/de/docs/tutorial/bigger-applications.md index d478d77c27..97fa9b81ac 100644 --- a/docs/de/docs/tutorial/bigger-applications.md +++ b/docs/de/docs/tutorial/bigger-applications.md @@ -85,7 +85,7 @@ Sie können die *Pfadoperationen* für dieses Modul mit `APIRouter` erstellen. Sie importieren ihn und erstellen eine „Instanz“ auf die gleiche Weise wie mit der Klasse `FastAPI`: -{* ../../docs_src/bigger_applications/app_an_py39/routers/users.py hl[1,3] title["app/routers/users.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *} ### *Pfadoperationen* mit `APIRouter` { #path-operations-with-apirouter } @@ -93,7 +93,7 @@ Und dann verwenden Sie ihn, um Ihre *Pfadoperationen* zu deklarieren. Verwenden Sie ihn auf die gleiche Weise wie die Klasse `FastAPI`: -{* ../../docs_src/bigger_applications/app_an_py39/routers/users.py hl[6,11,16] title["app/routers/users.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[6,11,16] title["app/routers/users.py"] *} Sie können sich `APIRouter` als eine „Mini-`FastAPI`“-Klasse vorstellen. @@ -117,7 +117,7 @@ Also fügen wir sie in ihr eigenes `dependencies`-Modul (`app/dependencies.py`) Wir werden nun eine einfache Abhängigkeit verwenden, um einen benutzerdefinierten `X-Token`-Header zu lesen: -{* ../../docs_src/bigger_applications/app_an_py39/dependencies.py hl[3,6:8] title["app/dependencies.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/dependencies.py hl[3,6:8] title["app/dependencies.py"] *} /// tip | Tipp @@ -149,7 +149,7 @@ Wir wissen, dass alle *Pfadoperationen* in diesem Modul folgendes haben: Anstatt also alles zu jeder *Pfadoperation* hinzuzufügen, können wir es dem `APIRouter` hinzufügen. -{* ../../docs_src/bigger_applications/app_an_py39/routers/items.py hl[5:10,16,21] title["app/routers/items.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[5:10,16,21] title["app/routers/items.py"] *} Da der Pfad jeder *Pfadoperation* mit `/` beginnen muss, wie in: @@ -208,7 +208,7 @@ Und wir müssen die Abhängigkeitsfunktion aus dem Modul `app.dependencies` impo Daher verwenden wir einen relativen Import mit `..` für die Abhängigkeiten: -{* ../../docs_src/bigger_applications/app_an_py39/routers/items.py hl[3] title["app/routers/items.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[3] title["app/routers/items.py"] *} #### Wie relative Importe funktionieren { #how-relative-imports-work } @@ -279,7 +279,7 @@ Wir fügen weder das Präfix `/items` noch `tags=["items"]` zu jeder *Pfadoperat Aber wir können immer noch _mehr_ `tags` hinzufügen, die auf eine bestimmte *Pfadoperation* angewendet werden, sowie einige zusätzliche `responses`, die speziell für diese *Pfadoperation* gelten: -{* ../../docs_src/bigger_applications/app_an_py39/routers/items.py hl[30:31] title["app/routers/items.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[30:31] title["app/routers/items.py"] *} /// tip | Tipp @@ -305,13 +305,13 @@ Sie importieren und erstellen wie gewohnt eine `FastAPI`-Klasse. Und wir können sogar [globale Abhängigkeiten](dependencies/global-dependencies.md){.internal-link target=_blank} deklarieren, die mit den Abhängigkeiten für jeden `APIRouter` kombiniert werden: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[1,3,7] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[1,3,7] title["app/main.py"] *} ### Den `APIRouter` importieren { #import-the-apirouter } Jetzt importieren wir die anderen Submodule, die `APIRouter` haben: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[4:5] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[4:5] title["app/main.py"] *} Da es sich bei den Dateien `app/routers/users.py` und `app/routers/items.py` um Submodule handelt, die Teil desselben Python-Packages `app` sind, können wir einen einzelnen Punkt `.` verwenden, um sie mit „relativen Imports“ zu importieren. @@ -374,13 +374,13 @@ würde der `router` von `users` den von `items` überschreiben und wir könnten Um also beide in derselben Datei verwenden zu können, importieren wir die Submodule direkt: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[5] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[5] title["app/main.py"] *} ### Die `APIRouter` für `users` und `items` inkludieren { #include-the-apirouters-for-users-and-items } Inkludieren wir nun die `router` aus diesen Submodulen `users` und `items`: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[10:11] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[10:11] title["app/main.py"] *} /// info | Info @@ -420,13 +420,13 @@ Sie enthält einen `APIRouter` mit einigen administrativen *Pfadoperationen*, di In diesem Beispiel wird es ganz einfach sein. Nehmen wir jedoch an, dass wir, da sie mit anderen Projekten in der Organisation geteilt wird, sie nicht ändern und kein `prefix`, `dependencies`, `tags`, usw. direkt zum `APIRouter` hinzufügen können: -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} Aber wir möchten immer noch ein benutzerdefiniertes `prefix` festlegen, wenn wir den `APIRouter` einbinden, sodass alle seine *Pfadoperationen* mit `/admin` beginnen, wir möchten es mit den `dependencies` sichern, die wir bereits für dieses Projekt haben, und wir möchten `tags` und `responses` hinzufügen. Wir können das alles deklarieren, ohne den ursprünglichen `APIRouter` ändern zu müssen, indem wir diese Parameter an `app.include_router()` übergeben: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[14:17] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[14:17] title["app/main.py"] *} Auf diese Weise bleibt der ursprüngliche `APIRouter` unverändert, sodass wir dieselbe `app/internal/admin.py`-Datei weiterhin mit anderen Projekten in der Organisation teilen können. @@ -447,7 +447,7 @@ Wir können *Pfadoperationen* auch direkt zur `FastAPI`-App hinzufügen. Hier machen wir es ... nur um zu zeigen, dass wir es können 🤷: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[21:23] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[21:23] title["app/main.py"] *} und es wird korrekt funktionieren, zusammen mit allen anderen *Pfadoperationen*, die mit `app.include_router()` hinzugefügt wurden. diff --git a/docs/de/docs/tutorial/body-fields.md b/docs/de/docs/tutorial/body-fields.md index b73d57d2d8..4edb22478b 100644 --- a/docs/de/docs/tutorial/body-fields.md +++ b/docs/de/docs/tutorial/body-fields.md @@ -44,7 +44,7 @@ Beachten Sie, wie jedes Attribut eines Modells mit einem Typ, Defaultwert und `F Sie können zusätzliche Information in `Field`, `Query`, `Body`, usw. deklarieren. Und es wird im generierten JSON-Schema untergebracht. -Sie werden später mehr darüber lernen, wie man zusätzliche Information unterbringt, wenn Sie lernen, Beispiele zu deklarieren. +Sie werden später in der Dokumentation mehr darüber lernen, wie man zusätzliche Information unterbringt, wenn Sie lernen, Beispiele zu deklarieren. /// warning | Achtung diff --git a/docs/de/docs/tutorial/body-multiple-params.md b/docs/de/docs/tutorial/body-multiple-params.md index daa48f23d1..60a0ceefe0 100644 --- a/docs/de/docs/tutorial/body-multiple-params.md +++ b/docs/de/docs/tutorial/body-multiple-params.md @@ -104,12 +104,6 @@ Da einfache Werte standardmäßig als Query-Parameter interpretiert werden, müs q: str | None = None ``` -Oder in Python 3.9: - -```Python -q: Union[str, None] = None -``` - Zum Beispiel: {* ../../docs_src/body_multiple_params/tutorial004_an_py310.py hl[28] *} diff --git a/docs/de/docs/tutorial/body-nested-models.md b/docs/de/docs/tutorial/body-nested-models.md index 65a5d7c1de..52b00e0369 100644 --- a/docs/de/docs/tutorial/body-nested-models.md +++ b/docs/de/docs/tutorial/body-nested-models.md @@ -163,7 +163,7 @@ images: list[Image] so wie in: -{* ../../docs_src/body_nested_models/tutorial008_py39.py hl[13] *} +{* ../../docs_src/body_nested_models/tutorial008_py310.py hl[13] *} ## Editor-Unterstützung überall { #editor-support-everywhere } @@ -193,7 +193,7 @@ Das schauen wir uns mal an. Im folgenden Beispiel akzeptieren Sie irgendein `dict`, solange es `int`-Schlüssel und `float`-Werte hat: -{* ../../docs_src/body_nested_models/tutorial009_py39.py hl[7] *} +{* ../../docs_src/body_nested_models/tutorial009_py310.py hl[7] *} /// tip | Tipp diff --git a/docs/de/docs/tutorial/body.md b/docs/de/docs/tutorial/body.md index cdf3122f2f..e1214bc538 100644 --- a/docs/de/docs/tutorial/body.md +++ b/docs/de/docs/tutorial/body.md @@ -154,7 +154,7 @@ Die Funktionsparameter werden wie folgt erkannt: FastAPI weiß, dass der Wert von `q` nicht erforderlich ist, aufgrund des definierten Defaultwertes `= None`. -Das `str | None` (Python 3.10+) oder `Union` in `Union[str, None]` (Python 3.9+) wird von FastAPI nicht verwendet, um zu bestimmen, dass der Wert nicht erforderlich ist. FastAPI weiß, dass er nicht erforderlich ist, weil er einen Defaultwert von `= None` hat. +Das `str | None` wird von FastAPI nicht verwendet, um zu bestimmen, dass der Wert nicht erforderlich ist. FastAPI weiß, dass er nicht erforderlich ist, weil er einen Defaultwert von `= None` hat. Das Hinzufügen der Typannotationen ermöglicht jedoch Ihrem Editor, Ihnen eine bessere Unterstützung zu bieten und Fehler zu erkennen. diff --git a/docs/de/docs/tutorial/cookie-param-models.md b/docs/de/docs/tutorial/cookie-param-models.md index 25718bd33a..81f7abb7de 100644 --- a/docs/de/docs/tutorial/cookie-param-models.md +++ b/docs/de/docs/tutorial/cookie-param-models.md @@ -46,7 +46,7 @@ Aber selbst wenn Sie die **Daten ausfüllen** und auf „Ausführen“ klicken, In einigen speziellen Anwendungsfällen (wahrscheinlich nicht sehr häufig) möchten Sie möglicherweise die Cookies, die Sie empfangen möchten, **einschränken**. -Ihre API hat jetzt die Macht, ihre eigene Cookie-Einwilligung zu kontrollieren. 🤪🍪 +Ihre API hat jetzt die Macht, ihre eigene Cookie-Einwilligung zu kontrollieren. 🤪🍪 Sie können die Modellkonfiguration von Pydantic verwenden, um `extra` Felder zu verbieten (`forbid`): @@ -54,9 +54,9 @@ Sie können die Modellkonfiguration von Pydantic verwenden, um `extra` Felder zu Wenn ein Client versucht, einige **zusätzliche Cookies** zu senden, erhält er eine **Error-Response**. -Arme Cookie-Banner, wie sie sich mühen, Ihre Einwilligung zu erhalten, dass die API sie ablehnen darf. 🍪 +Arme Cookie-Banner, wie sie sich mühen, Ihre Einwilligung zu erhalten, dass die API sie ablehnen darf. 🍪 -Wenn der Client beispielsweise versucht, ein `santa_tracker`-Cookie mit einem Wert von `good-list-please` zu senden, erhält der Client eine **Error-Response**, die ihm mitteilt, dass das `santa_tracker` Cookie nicht erlaubt ist: +Wenn der Client beispielsweise versucht, ein `santa_tracker`-Cookie mit einem Wert von `good-list-please` zu senden, erhält der Client eine **Error-Response**, die ihm mitteilt, dass das `santa_tracker` Cookie nicht erlaubt ist: ```json { @@ -73,4 +73,4 @@ Wenn der Client beispielsweise versucht, ein `santa_tracker`-Cookie mit einem We ## Zusammenfassung { #summary } -Sie können **Pydantic-Modelle** verwenden, um **Cookies** in **FastAPI** zu deklarieren. 😎 +Sie können **Pydantic-Modelle** verwenden, um **Cookies** in **FastAPI** zu deklarieren. 😎 diff --git a/docs/de/docs/tutorial/cors.md b/docs/de/docs/tutorial/cors.md index 81f0f36051..4e714f215e 100644 --- a/docs/de/docs/tutorial/cors.md +++ b/docs/de/docs/tutorial/cors.md @@ -46,7 +46,7 @@ Sie können auch angeben, ob Ihr Backend erlaubt: * Bestimmte HTTP-Methoden (`POST`, `PUT`) oder alle mit der Wildcard `"*"`. * Bestimmte HTTP-Header oder alle mit der Wildcard `"*"`. -{* ../../docs_src/cors/tutorial001_py39.py hl[2,6:11,13:19] *} +{* ../../docs_src/cors/tutorial001_py310.py hl[2,6:11,13:19] *} Die von der `CORSMiddleware`-Implementierung verwendeten Defaultparameter sind standardmäßig restriktiv, daher müssen Sie bestimmte Origins, Methoden oder Header ausdrücklich aktivieren, damit Browser sie in einem Cross-Domain-Kontext verwenden dürfen. diff --git a/docs/de/docs/tutorial/debugging.md b/docs/de/docs/tutorial/debugging.md index 0d12877c10..cabaf5a3a4 100644 --- a/docs/de/docs/tutorial/debugging.md +++ b/docs/de/docs/tutorial/debugging.md @@ -6,7 +6,7 @@ Sie können den Debugger in Ihrem Editor verbinden, zum Beispiel mit Visual Stud Importieren und führen Sie `uvicorn` direkt in Ihrer FastAPI-Anwendung aus: -{* ../../docs_src/debugging/tutorial001_py39.py hl[1,15] *} +{* ../../docs_src/debugging/tutorial001_py310.py hl[1,15] *} ### Über `__name__ == "__main__"` { #about-name-main } diff --git a/docs/de/docs/tutorial/dependencies/classes-as-dependencies.md b/docs/de/docs/tutorial/dependencies/classes-as-dependencies.md index 7df0842eb1..4fd8d092fc 100644 --- a/docs/de/docs/tutorial/dependencies/classes-as-dependencies.md +++ b/docs/de/docs/tutorial/dependencies/classes-as-dependencies.md @@ -101,7 +101,7 @@ Jetzt können Sie Ihre Abhängigkeit mithilfe dieser Klasse deklarieren. Beachten Sie, wie wir `CommonQueryParams` im obigen Code zweimal schreiben: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] @@ -109,7 +109,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] //// -//// tab | Python 3.9+ nicht annotiert +//// tab | Python 3.10+ nicht annotiert /// tip | Tipp @@ -137,7 +137,7 @@ Aus diesem extrahiert FastAPI die deklarierten Parameter, und dieses ist es, was In diesem Fall hat das erste `CommonQueryParams` in: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, ... @@ -145,7 +145,7 @@ commons: Annotated[CommonQueryParams, ... //// -//// tab | Python 3.9+ nicht annotiert +//// tab | Python 3.10+ nicht annotiert /// tip | Tipp @@ -163,7 +163,7 @@ commons: CommonQueryParams ... Sie könnten tatsächlich einfach schreiben: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[Any, Depends(CommonQueryParams)] @@ -171,7 +171,7 @@ commons: Annotated[Any, Depends(CommonQueryParams)] //// -//// tab | Python 3.9+ nicht annotiert +//// tab | Python 3.10+ nicht annotiert /// tip | Tipp @@ -197,7 +197,7 @@ Es wird jedoch empfohlen, den Typ zu deklarieren, da Ihr Editor so weiß, was al Aber Sie sehen, dass wir hier etwas Codeduplizierung haben, indem wir `CommonQueryParams` zweimal schreiben: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] @@ -205,7 +205,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] //// -//// tab | Python 3.9+ nicht annotiert +//// tab | Python 3.10+ nicht annotiert /// tip | Tipp @@ -225,7 +225,7 @@ In diesem speziellen Fall können Sie Folgendes tun: Anstatt zu schreiben: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] @@ -233,7 +233,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] //// -//// tab | Python 3.9+ nicht annotiert +//// tab | Python 3.10+ nicht annotiert /// tip | Tipp @@ -249,7 +249,7 @@ commons: CommonQueryParams = Depends(CommonQueryParams) ... schreiben Sie: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, Depends()] @@ -257,7 +257,7 @@ commons: Annotated[CommonQueryParams, Depends()] //// -//// tab | Python 3.9+ nicht annotiert +//// tab | Python 3.10+ nicht annotiert /// tip | Tipp diff --git a/docs/de/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md b/docs/de/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md index 59c9fcf48e..f63273f160 100644 --- a/docs/de/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md +++ b/docs/de/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md @@ -6,15 +6,15 @@ Oder die Abhängigkeit gibt keinen Wert zurück. Aber Sie müssen sie trotzdem ausführen/auflösen. -In diesen Fällen können Sie, anstatt einen Parameter der *Pfadoperation-Funktion* mit `Depends` zu deklarieren, eine `list`e von `dependencies` zum *Pfadoperation-Dekorator* hinzufügen. +In diesen Fällen können Sie, anstatt einen Parameter der *Pfadoperation-Funktion* mit `Depends` zu deklarieren, eine `list` von `dependencies` zum *Pfadoperation-Dekorator* hinzufügen. ## `dependencies` zum *Pfadoperation-Dekorator* hinzufügen { #add-dependencies-to-the-path-operation-decorator } Der *Pfadoperation-Dekorator* erhält ein optionales Argument `dependencies`. -Es sollte eine `list`e von `Depends()` sein: +Es sollte eine `list` von `Depends()` sein: -{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[19] *} +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[19] *} Diese Abhängigkeiten werden auf die gleiche Weise wie normale Abhängigkeiten ausgeführt/aufgelöst. Aber ihr Wert (falls sie einen zurückgeben) wird nicht an Ihre *Pfadoperation-Funktion* übergeben. @@ -44,13 +44,13 @@ Sie können dieselben Abhängigkeits-*Funktionen* verwenden, die Sie normalerwei Sie können Anforderungen für einen Request (wie Header) oder andere Unterabhängigkeiten deklarieren: -{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[8,13] *} +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[8,13] *} ### Exceptions auslösen { #raise-exceptions } Die Abhängigkeiten können Exceptions `raise`n, genau wie normale Abhängigkeiten: -{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[10,15] *} +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[10,15] *} ### Rückgabewerte { #return-values } @@ -58,7 +58,7 @@ Und sie können Werte zurückgeben oder nicht, die Werte werden nicht verwendet. Sie können also eine normale Abhängigkeit (die einen Wert zurückgibt), die Sie bereits an anderer Stelle verwenden, wiederverwenden, und auch wenn der Wert nicht verwendet wird, wird die Abhängigkeit ausgeführt: -{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[11,16] *} +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[11,16] *} ## Abhängigkeiten für eine Gruppe von *Pfadoperationen* { #dependencies-for-a-group-of-path-operations } diff --git a/docs/de/docs/tutorial/dependencies/dependencies-with-yield.md b/docs/de/docs/tutorial/dependencies/dependencies-with-yield.md index 0083e7e7ea..c5f2acbae5 100644 --- a/docs/de/docs/tutorial/dependencies/dependencies-with-yield.md +++ b/docs/de/docs/tutorial/dependencies/dependencies-with-yield.md @@ -1,6 +1,6 @@ # Abhängigkeiten mit `yield` { #dependencies-with-yield } -FastAPI unterstützt Abhängigkeiten, die nach Abschluss einige zusätzliche Schritte ausführen. +FastAPI unterstützt Abhängigkeiten, die einige zusätzliche Schritte nach Abschluss ausführen. Verwenden Sie dazu `yield` statt `return` und schreiben Sie die zusätzlichen Schritte / den zusätzlichen Code danach. @@ -29,15 +29,15 @@ Sie könnten damit beispielsweise eine Datenbanksession erstellen und diese nach Nur der Code vor und einschließlich der `yield`-Anweisung wird ausgeführt, bevor eine Response erzeugt wird: -{* ../../docs_src/dependencies/tutorial007_py39.py hl[2:4] *} +{* ../../docs_src/dependencies/tutorial007_py310.py hl[2:4] *} Der ge`yield`ete Wert ist das, was in *Pfadoperationen* und andere Abhängigkeiten eingefügt wird: -{* ../../docs_src/dependencies/tutorial007_py39.py hl[4] *} +{* ../../docs_src/dependencies/tutorial007_py310.py hl[4] *} Der auf die `yield`-Anweisung folgende Code wird nach der Response ausgeführt: -{* ../../docs_src/dependencies/tutorial007_py39.py hl[5:6] *} +{* ../../docs_src/dependencies/tutorial007_py310.py hl[5:6] *} /// tip | Tipp @@ -57,7 +57,7 @@ Sie können also mit `except SomeException` diese bestimmte Exception innerhalb Auf die gleiche Weise können Sie `finally` verwenden, um sicherzustellen, dass die Exit-Schritte ausgeführt werden, unabhängig davon, ob eine Exception geworfen wurde oder nicht. -{* ../../docs_src/dependencies/tutorial007_py39.py hl[3,5] *} +{* ../../docs_src/dependencies/tutorial007_py310.py hl[3,5] *} ## Unterabhängigkeiten mit `yield` { #sub-dependencies-with-yield } @@ -67,7 +67,7 @@ Sie können Unterabhängigkeiten und „Bäume“ von Unterabhängigkeiten belie Beispielsweise kann `dependency_c` von `dependency_b` und `dependency_b` von `dependency_a` abhängen: -{* ../../docs_src/dependencies/tutorial008_an_py39.py hl[6,14,22] *} +{* ../../docs_src/dependencies/tutorial008_an_py310.py hl[6,14,22] *} Und alle können `yield` verwenden. @@ -75,7 +75,7 @@ In diesem Fall benötigt `dependency_c` zum Ausführen seines Exit-Codes, dass d Und wiederum benötigt `dependency_b` den Wert von `dependency_a` (hier `dep_a` genannt) für seinen Exit-Code. -{* ../../docs_src/dependencies/tutorial008_an_py39.py hl[18:19,26:27] *} +{* ../../docs_src/dependencies/tutorial008_an_py310.py hl[18:19,26:27] *} Auf die gleiche Weise könnten Sie einige Abhängigkeiten mit `yield` und einige andere Abhängigkeiten mit `return` haben, und alle können beliebig voneinander abhängen. @@ -109,7 +109,7 @@ Aber es ist für Sie da, wenn Sie es brauchen. 🤓 /// -{* ../../docs_src/dependencies/tutorial008b_an_py39.py hl[18:22,31] *} +{* ../../docs_src/dependencies/tutorial008b_an_py310.py hl[18:22,31] *} Wenn Sie Exceptions abfangen und darauf basierend eine benutzerdefinierte Response erstellen möchten, erstellen Sie einen [benutzerdefinierten Exceptionhandler](../handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank}. @@ -117,7 +117,7 @@ Wenn Sie Exceptions abfangen und darauf basierend eine benutzerdefinierte Respon Wenn Sie eine Exception mit `except` in einer Abhängigkeit mit `yield` abfangen und sie nicht erneut auslösen (oder eine neue Exception auslösen), kann FastAPI nicht feststellen, dass es eine Exception gab, genau so wie es bei normalem Python der Fall wäre: -{* ../../docs_src/dependencies/tutorial008c_an_py39.py hl[15:16] *} +{* ../../docs_src/dependencies/tutorial008c_an_py310.py hl[15:16] *} In diesem Fall sieht der Client eine *HTTP 500 Internal Server Error*-Response, wie es sein sollte, da wir keine `HTTPException` oder Ähnliches auslösen, aber der Server hat **keine Logs** oder einen anderen Hinweis darauf, was der Fehler war. 😱 @@ -127,7 +127,7 @@ Wenn Sie eine Exception in einer Abhängigkeit mit `yield` abfangen, sollten Sie Sie können dieselbe Exception mit `raise` erneut auslösen: -{* ../../docs_src/dependencies/tutorial008d_an_py39.py hl[17] *} +{* ../../docs_src/dependencies/tutorial008d_an_py310.py hl[17] *} Jetzt erhält der Client dieselbe *HTTP 500 Internal Server Error*-Response, aber der Server enthält unseren benutzerdefinierten `InternalError` in den Logs. 😎 @@ -190,7 +190,7 @@ Normalerweise wird der Exit-Code von Abhängigkeiten mit `yield` ausgeführt **n Wenn Sie aber wissen, dass Sie die Abhängigkeit nach der Rückkehr aus der *Pfadoperation-Funktion* nicht mehr benötigen, können Sie `Depends(scope="function")` verwenden, um FastAPI mitzuteilen, dass es die Abhängigkeit nach der Rückkehr aus der *Pfadoperation-Funktion* schließen soll, jedoch **bevor** die **Response gesendet wird**. -{* ../../docs_src/dependencies/tutorial008e_an_py39.py hl[12,16] *} +{* ../../docs_src/dependencies/tutorial008e_an_py310.py hl[12,16] *} `Depends()` erhält einen `scope`-Parameter, der sein kann: @@ -268,7 +268,7 @@ In Python können Sie Kontextmanager erstellen, indem Sie Dependency Injection** System. +**FastAPI** hat ein sehr mächtiges, aber intuitives **Abhängigkeitsinjektion** System. Es ist so konzipiert, sehr einfach zu verwenden zu sein und es jedem Entwickler sehr leicht zu machen, andere Komponenten mit **FastAPI** zu integrieren. diff --git a/docs/de/docs/tutorial/dependencies/sub-dependencies.md b/docs/de/docs/tutorial/dependencies/sub-dependencies.md index d72f820dca..b01cc80a76 100644 --- a/docs/de/docs/tutorial/dependencies/sub-dependencies.md +++ b/docs/de/docs/tutorial/dependencies/sub-dependencies.md @@ -58,11 +58,11 @@ query_extractor --> query_or_cookie_extractor --> read_query Wenn eine Ihrer Abhängigkeiten mehrmals für dieselbe *Pfadoperation* deklariert wird, beispielsweise wenn mehrere Abhängigkeiten eine gemeinsame Unterabhängigkeit haben, wird **FastAPI** diese Unterabhängigkeit nur einmal pro Request aufrufen. -Und es speichert den zurückgegebenen Wert in einem „Cache“ und übergibt diesen gecachten Wert an alle „Dependanten“, die ihn in diesem spezifischen Request benötigen, anstatt die Abhängigkeit mehrmals für denselben Request aufzurufen. +Und es speichert den zurückgegebenen Wert in einem „Cache“ und übergibt diesen gecachten Wert an alle „Dependanten“, die ihn in diesem spezifischen Request benötigen, anstatt die Abhängigkeit mehrmals für denselben Request aufzurufen. In einem fortgeschrittenen Szenario, bei dem Sie wissen, dass die Abhängigkeit bei jedem Schritt (möglicherweise mehrmals) in demselben Request aufgerufen werden muss, anstatt den zwischengespeicherten Wert zu verwenden, können Sie den Parameter `use_cache=False` festlegen, wenn Sie `Depends` verwenden: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python hl_lines="1" async def needy_dependency(fresh_value: Annotated[str, Depends(get_value, use_cache=False)]): @@ -71,7 +71,7 @@ async def needy_dependency(fresh_value: Annotated[str, Depends(get_value, use_ca //// -//// tab | Python 3.9+ nicht annotiert +//// tab | Python 3.10+ nicht annotiert /// tip | Tipp diff --git a/docs/de/docs/tutorial/extra-models.md b/docs/de/docs/tutorial/extra-models.md index 889fdb9a3b..4f55f2428c 100644 --- a/docs/de/docs/tutorial/extra-models.md +++ b/docs/de/docs/tutorial/extra-models.md @@ -190,9 +190,9 @@ Aber wenn wir das in der Zuweisung `response_model=PlaneItem | CarItem` machen, Auf die gleiche Weise können Sie Responses von Listen von Objekten deklarieren. -Dafür verwenden Sie Pythons Standard-`typing.List` (oder nur `list` in Python 3.9 und höher): +Dafür verwenden Sie Pythons Standard-`list`: -{* ../../docs_src/extra_models/tutorial004_py39.py hl[18] *} +{* ../../docs_src/extra_models/tutorial004_py310.py hl[18] *} ## Response mit beliebigem `dict` { #response-with-arbitrary-dict } @@ -200,9 +200,9 @@ Sie können auch eine Response deklarieren, die ein beliebiges `dict` zurückgib Dies ist nützlich, wenn Sie die gültigen Feld-/Attributnamen nicht im Voraus kennen (die für ein Pydantic-Modell benötigt werden würden). -In diesem Fall können Sie `typing.Dict` verwenden (oder nur `dict` in Python 3.9 und höher): +In diesem Fall können Sie `dict` verwenden: -{* ../../docs_src/extra_models/tutorial005_py39.py hl[6] *} +{* ../../docs_src/extra_models/tutorial005_py310.py hl[6] *} ## Zusammenfassung { #recap } diff --git a/docs/de/docs/tutorial/first-steps.md b/docs/de/docs/tutorial/first-steps.md index 9505a0bdb7..f02fb3d433 100644 --- a/docs/de/docs/tutorial/first-steps.md +++ b/docs/de/docs/tutorial/first-steps.md @@ -2,7 +2,7 @@ Die einfachste FastAPI-Datei könnte wie folgt aussehen: -{* ../../docs_src/first_steps/tutorial001_py39.py *} +{* ../../docs_src/first_steps/tutorial001_py310.py *} Kopieren Sie das in eine Datei `main.py`. @@ -183,7 +183,7 @@ Das war's! Jetzt können Sie Ihre App unter dieser URL aufrufen. ✨ ### Schritt 1: `FastAPI` importieren { #step-1-import-fastapi } -{* ../../docs_src/first_steps/tutorial001_py39.py hl[1] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[1] *} `FastAPI` ist eine Python-Klasse, die die gesamte Funktionalität für Ihre API bereitstellt. @@ -197,7 +197,7 @@ Sie können alle Requests zuständig ist, die an: * den Pfad `/` -* unter der Verwendung der get-Operation gehen +* unter der Verwendung der get-Operation gehen /// info | `@decorator` Info @@ -320,7 +320,7 @@ Das ist unsere „**Pfadoperation-Funktion**“: * **Operation**: ist `get`. * **Funktion**: ist die Funktion direkt unter dem „Dekorator“ (unter `@app.get("/")`). -{* ../../docs_src/first_steps/tutorial001_py39.py hl[7] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[7] *} Dies ist eine Python-Funktion. @@ -332,7 +332,7 @@ In diesem Fall handelt es sich um eine `async`-Funktion. Sie könnten sie auch als normale Funktion anstelle von `async def` definieren: -{* ../../docs_src/first_steps/tutorial003_py39.py hl[7] *} +{* ../../docs_src/first_steps/tutorial003_py310.py hl[7] *} /// note | Hinweis @@ -342,7 +342,7 @@ Wenn Sie den Unterschied nicht kennen, lesen Sie [Async: *„In Eile?“*](../as ### Schritt 5: den Inhalt zurückgeben { #step-5-return-the-content } -{* ../../docs_src/first_steps/tutorial001_py39.py hl[8] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[8] *} Sie können ein `dict`, eine `list`, einzelne Werte wie `str`, `int`, usw. zurückgeben. diff --git a/docs/de/docs/tutorial/handling-errors.md b/docs/de/docs/tutorial/handling-errors.md index d890b44629..0cb0de2ca4 100644 --- a/docs/de/docs/tutorial/handling-errors.md +++ b/docs/de/docs/tutorial/handling-errors.md @@ -25,7 +25,7 @@ Um HTTP-Exceptionhandler mit den gleichen Exception-Werkzeugen von Starlette hinzufügen. +Sie können benutzerdefinierte Exceptionhandler mit den gleichen Exception-Werkzeugen von Starlette hinzufügen. Angenommen, Sie haben eine benutzerdefinierte Exception `UnicornException`, die Sie (oder eine Bibliothek, die Sie verwenden) `raise`n könnten. @@ -89,7 +89,7 @@ Und Sie möchten diese Exception global mit FastAPI handhaben. Sie könnten einen benutzerdefinierten Exceptionhandler mit `@app.exception_handler()` hinzufügen: -{* ../../docs_src/handling_errors/tutorial003_py39.py hl[5:7,13:18,24] *} +{* ../../docs_src/handling_errors/tutorial003_py310.py hl[5:7,13:18,24] *} Hier, wenn Sie `/unicorns/yolo` anfordern, wird die *Pfadoperation* eine `UnicornException` `raise`n. @@ -127,7 +127,7 @@ Um diesen zu überschreiben, importieren Sie den `RequestValidationError` und ve Der Exceptionhandler erhält einen `Request` und die Exception. -{* ../../docs_src/handling_errors/tutorial004_py39.py hl[2,14:19] *} +{* ../../docs_src/handling_errors/tutorial004_py310.py hl[2,14:19] *} Wenn Sie nun zu `/items/foo` gehen, erhalten Sie anstelle des standardmäßigen JSON-Fehlers mit: @@ -159,7 +159,7 @@ Auf die gleiche Weise können Sie den `HTTPException`-Handler überschreiben. Zum Beispiel könnten Sie eine Klartext-Response statt JSON für diese Fehler zurückgeben wollen: -{* ../../docs_src/handling_errors/tutorial004_py39.py hl[3:4,9:11,25] *} +{* ../../docs_src/handling_errors/tutorial004_py310.py hl[3:4,9:11,25] *} /// note | Technische Details @@ -183,7 +183,7 @@ Der `RequestValidationError` enthält den empfangenen `body` mit den ungültigen Sie könnten diesen während der Entwicklung Ihrer Anwendung verwenden, um den Body zu loggen und zu debuggen, ihn an den Benutzer zurückzugeben usw. -{* ../../docs_src/handling_errors/tutorial005_py39.py hl[14] *} +{* ../../docs_src/handling_errors/tutorial005_py310.py hl[14] *} Versuchen Sie nun, einen ungültigen Artikel zu senden: @@ -239,6 +239,6 @@ from starlette.exceptions import HTTPException as StarletteHTTPException Wenn Sie die Exception zusammen mit den gleichen Default-Exceptionhandlern von **FastAPI** verwenden möchten, können Sie die Default-Exceptionhandler aus `fastapi.exception_handlers` importieren und wiederverwenden: -{* ../../docs_src/handling_errors/tutorial006_py39.py hl[2:5,15,21] *} +{* ../../docs_src/handling_errors/tutorial006_py310.py hl[2:5,15,21] *} In diesem Beispiel geben Sie nur den Fehler mit einer sehr ausdrucksstarken Nachricht aus, aber Sie verstehen das Prinzip. Sie können die Exception verwenden und dann einfach die Default-Exceptionhandler wiederverwenden. diff --git a/docs/de/docs/tutorial/metadata.md b/docs/de/docs/tutorial/metadata.md index ee88a21d63..f5999a667f 100644 --- a/docs/de/docs/tutorial/metadata.md +++ b/docs/de/docs/tutorial/metadata.md @@ -18,7 +18,7 @@ Sie können die folgenden Felder festlegen, die in der OpenAPI-Spezifikation und Sie können diese wie folgt setzen: -{* ../../docs_src/metadata/tutorial001_py39.py hl[3:16, 19:32] *} +{* ../../docs_src/metadata/tutorial001_py310.py hl[3:16, 19:32] *} /// tip | Tipp @@ -36,7 +36,7 @@ Seit OpenAPI 3.1.0 und FastAPI 0.99.0 können Sie die `license_info` auch mit ei Zum Beispiel: -{* ../../docs_src/metadata/tutorial001_1_py39.py hl[31] *} +{* ../../docs_src/metadata/tutorial001_1_py310.py hl[31] *} ## Metadaten für Tags { #metadata-for-tags } @@ -58,7 +58,7 @@ Versuchen wir es mit einem Beispiel mit Tags für `users` und `items`. Erstellen Sie Metadaten für Ihre Tags und übergeben Sie diese an den Parameter `openapi_tags`: -{* ../../docs_src/metadata/tutorial004_py39.py hl[3:16,18] *} +{* ../../docs_src/metadata/tutorial004_py310.py hl[3:16,18] *} Beachten Sie, dass Sie Markdown innerhalb der Beschreibungen verwenden können. Zum Beispiel wird „login“ in Fettschrift (**login**) und „fancy“ in Kursivschrift (_fancy_) angezeigt. @@ -72,7 +72,7 @@ Sie müssen nicht für alle von Ihnen verwendeten Tags Metadaten hinzufügen. Verwenden Sie den Parameter `tags` mit Ihren *Pfadoperationen* (und `APIRouter`n), um diese verschiedenen Tags zuzuweisen: -{* ../../docs_src/metadata/tutorial004_py39.py hl[21,26] *} +{* ../../docs_src/metadata/tutorial004_py310.py hl[21,26] *} /// info | Info @@ -100,7 +100,7 @@ Sie können das aber mit dem Parameter `openapi_url` konfigurieren. Um beispielsweise festzulegen, dass es unter `/api/v1/openapi.json` bereitgestellt wird: -{* ../../docs_src/metadata/tutorial002_py39.py hl[3] *} +{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *} Wenn Sie das OpenAPI-Schema vollständig deaktivieren möchten, können Sie `openapi_url=None` festlegen, wodurch auch die Dokumentationsbenutzeroberflächen deaktiviert werden, die es verwenden. @@ -117,4 +117,4 @@ Sie können die beiden enthaltenen Dokumentationsbenutzeroberflächen konfigurie Um beispielsweise Swagger UI so einzustellen, dass sie unter `/documentation` bereitgestellt wird, und ReDoc zu deaktivieren: -{* ../../docs_src/metadata/tutorial003_py39.py hl[3] *} +{* ../../docs_src/metadata/tutorial003_py310.py hl[3] *} diff --git a/docs/de/docs/tutorial/middleware.md b/docs/de/docs/tutorial/middleware.md index 540a18c4d0..116f87d23c 100644 --- a/docs/de/docs/tutorial/middleware.md +++ b/docs/de/docs/tutorial/middleware.md @@ -31,7 +31,7 @@ Die Middleware-Funktion erhält: * Dann gibt es die von der entsprechenden *Pfadoperation* generierte `response` zurück. * Sie können die `response` dann weiter modifizieren, bevor Sie sie zurückgeben. -{* ../../docs_src/middleware/tutorial001_py39.py hl[8:9,11,14] *} +{* ../../docs_src/middleware/tutorial001_py310.py hl[8:9,11,14] *} /// tip | Tipp @@ -57,7 +57,7 @@ Und auch nachdem die `response` generiert wurde, bevor sie zurückgegeben wird. Sie könnten beispielsweise einen benutzerdefinierten Header `X-Process-Time` hinzufügen, der die Zeit in Sekunden enthält, die benötigt wurde, um den Request zu verarbeiten und eine Response zu generieren: -{* ../../docs_src/middleware/tutorial001_py39.py hl[10,12:13] *} +{* ../../docs_src/middleware/tutorial001_py310.py hl[10,12:13] *} /// tip | Tipp diff --git a/docs/de/docs/tutorial/path-operation-configuration.md b/docs/de/docs/tutorial/path-operation-configuration.md index a06c85e570..48d6d66035 100644 --- a/docs/de/docs/tutorial/path-operation-configuration.md +++ b/docs/de/docs/tutorial/path-operation-configuration.md @@ -46,7 +46,7 @@ In diesem Fall macht es Sinn, die Tags in einem `Enum` zu speichern. **FastAPI** unterstützt das auf die gleiche Weise wie einfache Strings: -{* ../../docs_src/path_operation_configuration/tutorial002b_py39.py hl[1,8:10,13,18] *} +{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *} ## Zusammenfassung und Beschreibung { #summary-and-description } @@ -56,7 +56,7 @@ Sie können eine `summary` und eine Docstring der Funktion deklarieren, und **FastAPI** wird sie daraus auslesen. +Da Beschreibungen oft mehrere Zeilen lang sind, können Sie die Beschreibung der *Pfadoperation* im Docstring der Funktion deklarieren, und **FastAPI** wird sie daraus auslesen. Sie können Markdown im Docstring schreiben, es wird korrekt interpretiert und angezeigt (unter Berücksichtigung der Einrückung des Docstring). @@ -90,9 +90,9 @@ Daher, wenn Sie keine vergeben, wird **FastAPI** automatisch eine für „Erfolg ## Eine *Pfadoperation* deprecaten { #deprecate-a-path-operation } -Wenn Sie eine *Pfadoperation* als deprecatet kennzeichnen möchten, ohne sie zu entfernen, fügen Sie den Parameter `deprecated` hinzu: +Wenn Sie eine *Pfadoperation* als deprecatet kennzeichnen möchten, ohne sie zu entfernen, fügen Sie den Parameter `deprecated` hinzu: -{* ../../docs_src/path_operation_configuration/tutorial006_py39.py hl[16] *} +{* ../../docs_src/path_operation_configuration/tutorial006_py310.py hl[16] *} Sie wird in der interaktiven Dokumentation gut sichtbar als deprecatet markiert werden: diff --git a/docs/de/docs/tutorial/path-params-numeric-validations.md b/docs/de/docs/tutorial/path-params-numeric-validations.md index 8b52e8b42f..5147a7fbc7 100644 --- a/docs/de/docs/tutorial/path-params-numeric-validations.md +++ b/docs/de/docs/tutorial/path-params-numeric-validations.md @@ -54,11 +54,11 @@ Für **FastAPI** spielt es keine Rolle. Es erkennt die Parameter anhand ihrer Na Sie können Ihre Funktion also so deklarieren: -{* ../../docs_src/path_params_numeric_validations/tutorial002_py39.py hl[7] *} +{* ../../docs_src/path_params_numeric_validations/tutorial002_py310.py hl[7] *} Aber bedenken Sie, dass Sie dieses Problem nicht haben, wenn Sie `Annotated` verwenden, da es nicht darauf ankommt, dass Sie keine Funktionsparameter-Defaultwerte für `Query()` oder `Path()` verwenden. -{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py39.py *} +{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py310.py *} ## Die Parameter sortieren, wie Sie möchten: Tricks { #order-the-parameters-as-you-need-tricks } @@ -83,13 +83,13 @@ Wenn Sie: Python wird nichts mit diesem `*` machen, aber es wird wissen, dass alle folgenden Parameter als Schlüsselwortargumente (Schlüssel-Wert-Paare) verwendet werden sollen, auch bekannt als kwargs. Selbst wenn diese keinen Defaultwert haben. -{* ../../docs_src/path_params_numeric_validations/tutorial003_py39.py hl[7] *} +{* ../../docs_src/path_params_numeric_validations/tutorial003_py310.py hl[7] *} ### Besser mit `Annotated` { #better-with-annotated } Bedenken Sie, dass Sie, wenn Sie `Annotated` verwenden, da Sie keine Funktionsparameter-Defaultwerte verwenden, dieses Problem nicht haben werden und wahrscheinlich nicht `*` verwenden müssen. -{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py310.py hl[10] *} ## Validierung von Zahlen: Größer oder gleich { #number-validations-greater-than-or-equal } @@ -97,7 +97,7 @@ Mit `Query` und `Path` (und anderen, die Sie später sehen werden) können Sie Z Hier, mit `ge=1`, muss `item_id` eine ganze Zahl sein, die „`g`reater than or `e`qual to“ (größer oder gleich) `1` ist. -{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py310.py hl[10] *} ## Validierung von Zahlen: Größer und kleiner oder gleich { #number-validations-greater-than-and-less-than-or-equal } @@ -106,7 +106,7 @@ Das Gleiche gilt für: * `gt`: `g`reater `t`han (größer als) * `le`: `l`ess than or `e`qual (kleiner oder gleich) -{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py310.py hl[10] *} ## Validierung von Zahlen: Floats, größer und kleiner { #number-validations-floats-greater-than-and-less-than } @@ -118,7 +118,7 @@ Also wäre `0.5` ein gültiger Wert. Aber `0.0` oder `0` nicht. Und das Gleiche gilt für lt. -{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py39.py hl[13] *} +{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py310.py hl[13] *} ## Zusammenfassung { #recap } diff --git a/docs/de/docs/tutorial/path-params.md b/docs/de/docs/tutorial/path-params.md index 1de4973155..41f6aea55f 100644 --- a/docs/de/docs/tutorial/path-params.md +++ b/docs/de/docs/tutorial/path-params.md @@ -2,7 +2,7 @@ Sie können Pfad-„Parameter“ oder -„Variablen“ mit der gleichen Syntax deklarieren, welche in Python-Formatstrings verwendet wird: -{* ../../docs_src/path_params/tutorial001_py39.py hl[6:7] *} +{* ../../docs_src/path_params/tutorial001_py310.py hl[6:7] *} Der Wert des Pfad-Parameters `item_id` wird Ihrer Funktion als das Argument `item_id` übergeben. @@ -16,7 +16,7 @@ Wenn Sie dieses Beispiel ausführen und auf Konversion { #data-conversion } +## Daten-Konversion { #data-conversion } Wenn Sie dieses Beispiel ausführen und Ihren Browser unter http://127.0.0.1:8000/items/3 öffnen, sehen Sie als Response: @@ -38,7 +38,7 @@ Wenn Sie dieses Beispiel ausführen und Ihren Browser unter Request automatisch „parsen“. +Sprich, mit dieser Typdeklaration wird **FastAPI** den „parsen“. /// @@ -118,13 +118,13 @@ Und Sie haben auch einen Pfad `/users/{user_id}`, um Daten über einen spezifisc Weil *Pfadoperationen* in ihrer Reihenfolge ausgewertet werden, müssen Sie sicherstellen, dass der Pfad `/users/me` vor `/users/{user_id}` deklariert wurde: -{* ../../docs_src/path_params/tutorial003_py39.py hl[6,11] *} +{* ../../docs_src/path_params/tutorial003_py310.py hl[6,11] *} Ansonsten würde der Pfad für `/users/{user_id}` auch `/users/me` auswerten, und annehmen, dass ein Parameter `user_id` mit dem Wert `"me"` übergeben wurde. Sie können eine Pfadoperation auch nicht erneut definieren: -{* ../../docs_src/path_params/tutorial003b_py39.py hl[6,11] *} +{* ../../docs_src/path_params/tutorial003b_py310.py hl[6,11] *} Die erste Definition wird immer verwendet werden, da ihr Pfad zuerst übereinstimmt. @@ -140,12 +140,11 @@ Indem Sie von `str` erben, weiß die API-Dokumentation, dass die Werte vom Typ ` Erstellen Sie dann Klassen-Attribute mit festgelegten Werten, welches die erlaubten Werte sein werden: -{* ../../docs_src/path_params/tutorial005_py39.py hl[1,6:9] *} - +{* ../../docs_src/path_params/tutorial005_py310.py hl[1,6:9] *} /// tip | Tipp -Falls Sie sich fragen, was „AlexNet“, „ResNet“ und „LeNet“ ist, das sind Namen von Modellen für maschinelles Lernen. +Falls Sie sich fragen, was „AlexNet“, „ResNet“ und „LeNet“ ist, das sind Namen von Modellen für maschinelles Lernen. /// @@ -153,7 +152,7 @@ Falls Sie sich fragen, was „AlexNet“, „ResNet“ und „LeNet“ ist, das Dann erstellen Sie einen *Pfad-Parameter*, der als Typ die gerade erstellte Enum-Klasse hat (`ModelName`): -{* ../../docs_src/path_params/tutorial005_py39.py hl[16] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[16] *} ### Die API-Dokumentation testen { #check-the-docs } @@ -169,13 +168,13 @@ Der *Pfad-Parameter* wird ein *parsen" +* Daten „parsen“ * Datenvalidierung * API-Annotationen und automatische Dokumentation diff --git a/docs/de/docs/tutorial/query-params-str-validations.md b/docs/de/docs/tutorial/query-params-str-validations.md index 8977dbcd50..865d10d13c 100644 --- a/docs/de/docs/tutorial/query-params-str-validations.md +++ b/docs/de/docs/tutorial/query-params-str-validations.md @@ -39,7 +39,7 @@ Stellen Sie sicher, dass Sie [die FastAPI-Version aktualisieren](../deployment/v /// -## Verwenden von `Annotated` im Typ für den `q`-Parameter { #use-annotated-in-the-type-for-the-q-parameter } +## `Annotated` im Typ für den `q`-Parameter verwenden { #use-annotated-in-the-type-for-the-q-parameter } Erinnern Sie sich, dass ich Ihnen zuvor in [Python-Typen-Intro](../python-types.md#type-hints-with-metadata-annotations){.internal-link target=_blank} gesagt habe, dass `Annotated` verwendet werden kann, um Metadaten zu Ihren Parametern hinzuzufügen? @@ -47,40 +47,16 @@ Jetzt ist es soweit, dies mit FastAPI zu verwenden. 🚀 Wir hatten diese Typannotation: -//// tab | Python 3.10+ - ```Python q: str | None = None ``` -//// - -//// tab | Python 3.9+ - -```Python -q: Union[str, None] = None -``` - -//// - Was wir tun werden, ist, dies mit `Annotated` zu wrappen, sodass es zu: -//// tab | Python 3.10+ - ```Python q: Annotated[str | None] = None ``` -//// - -//// tab | Python 3.9+ - -```Python -q: Annotated[Union[str, None]] = None -``` - -//// - Beide dieser Versionen bedeuten dasselbe: `q` ist ein Parameter, der ein `str` oder `None` sein kann, und standardmäßig ist er `None`. Jetzt springen wir zu den spannenden Dingen. 🎉 @@ -109,7 +85,7 @@ FastAPI wird nun: ## Alternative (alt): `Query` als Defaultwert { #alternative-old-query-as-the-default-value } -Frühere Versionen von FastAPI (vor 0.95.0) erforderten, dass Sie `Query` als den Defaultwert Ihres Parameters verwendeten, anstatt es innerhalb von `Annotated` zu platzieren. Es besteht eine hohe Wahrscheinlichkeit, dass Sie Code sehen, der es so verwendet, also werde ich es Ihnen erklären. +Frühere Versionen von FastAPI (vor 0.95.0) erforderten, dass Sie `Query` als den Defaultwert Ihres Parameters verwendeten, anstatt es innerhalb von `Annotated` zu platzieren. Es besteht eine hohe Wahrscheinlichkeit, dass Sie Code sehen, der es so verwendet, also werde ich es Ihnen erklären. /// tip | Tipp @@ -191,7 +167,7 @@ Sie können auch einen `min_length`-Parameter hinzufügen: ## Reguläre Ausdrücke hinzufügen { #add-regular-expressions } -Sie können einen regulären Ausdruck `pattern` definieren, mit dem der Parameter übereinstimmen muss: +Sie können einen regulären Ausdruck `pattern` definieren, mit dem der Parameter übereinstimmen muss: {* ../../docs_src/query_params_str_validations/tutorial004_an_py310.py hl[11] *} @@ -211,7 +187,7 @@ Natürlich können Sie Defaultwerte verwenden, die nicht `None` sind. Nehmen wir an, Sie möchten, dass der `q` Query-Parameter eine `min_length` von `3` hat und einen Defaultwert von `"fixedquery"`: -{* ../../docs_src/query_params_str_validations/tutorial005_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial005_an_py310.py hl[9] *} /// note | Hinweis @@ -241,7 +217,7 @@ q: Annotated[str | None, Query(min_length=3)] = None Wenn Sie einen Wert als erforderlich deklarieren müssen, während Sie `Query` verwenden, deklarieren Sie einfach keinen Defaultwert: -{* ../../docs_src/query_params_str_validations/tutorial006_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial006_an_py310.py hl[9] *} ### Erforderlich, kann `None` sein { #required-can-be-none } @@ -292,7 +268,7 @@ Die interaktive API-Dokumentation wird entsprechend aktualisiert, um mehrere Wer Sie können auch eine Default-`list` von Werten definieren, wenn keine bereitgestellt werden: -{* ../../docs_src/query_params_str_validations/tutorial012_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial012_an_py310.py hl[9] *} Wenn Sie zu: @@ -315,7 +291,7 @@ gehen, wird der Default für `q` sein: `["foo", "bar"]`, und Ihre Response wird Sie können auch `list` direkt verwenden, anstelle von `list[str]`: -{* ../../docs_src/query_params_str_validations/tutorial013_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial013_an_py310.py hl[9] *} /// note | Hinweis @@ -371,7 +347,7 @@ Dann können Sie ein `alias` deklarieren, und dieser Alias wird verwendet, um de Nehmen wir an, Ihnen gefällt dieser Parameter nicht mehr. -Sie müssen ihn eine Weile dort belassen, da es Clients gibt, die ihn verwenden, aber Sie möchten, dass die Dokumentation ihn klar als deprecatet anzeigt. +Sie müssen ihn eine Weile dort belassen, da es Clients gibt, die ihn verwenden, aber Sie möchten, dass die Dokumentation ihn klar als deprecatet anzeigt. Dann übergeben Sie den Parameter `deprecated=True` an `Query`: @@ -393,7 +369,7 @@ Es kann Fälle geben, in denen Sie eine **benutzerdefinierte Validierung** durch In diesen Fällen können Sie eine **benutzerdefinierte Validierungsfunktion** verwenden, die nach der normalen Validierung angewendet wird (z. B. nach der Validierung, dass der Wert ein `str` ist). -Sie können dies mit Pydantic's `AfterValidator` innerhalb von `Annotated` erreichen. +Sie können dies mit Pydantics `AfterValidator` innerhalb von `Annotated` erreichen. /// tip | Tipp @@ -401,7 +377,7 @@ Pydantic unterstützt auch ISBN-Buchnummer oder mit `imdb-` für eine IMDB-Film-URL-ID beginnt: +Zum Beispiel überprüft dieser benutzerdefinierte Validator, ob die Artikel-ID mit `isbn-` für eine ISBN-Buchnummer oder mit `imdb-` für eine IMDB-Film-URL-ID beginnt: {* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py hl[5,16:19,24] *} @@ -435,7 +411,7 @@ Haben Sie bemerkt? Eine Zeichenkette mit `value.startswith()` kann ein Tuple üb #### Ein zufälliges Item { #a-random-item } -Mit `data.items()` erhalten wir ein iterierbares Objekt mit Tupeln, die Schlüssel und Wert für jedes Dictionary-Element enthalten. +Mit `data.items()` erhalten wir ein iterierbares Objekt mit Tupeln, die Schlüssel und Wert für jedes Dictionary-Element enthalten. Wir konvertieren dieses iterierbare Objekt mit `list(data.items())` in eine richtige `list`. diff --git a/docs/de/docs/tutorial/query-params.md b/docs/de/docs/tutorial/query-params.md index 05ed3bc830..5a2a2a012e 100644 --- a/docs/de/docs/tutorial/query-params.md +++ b/docs/de/docs/tutorial/query-params.md @@ -2,7 +2,7 @@ Wenn Sie in Ihrer Funktion andere Parameter deklarieren, die nicht Teil der Pfad-Parameter sind, dann werden diese automatisch als „Query“-Parameter interpretiert. -{* ../../docs_src/query_params/tutorial001_py39.py hl[9] *} +{* ../../docs_src/query_params/tutorial001_py310.py hl[9] *} Die Query ist die Menge von Schlüssel-Wert-Paaren, die nach dem `?` in einer URL folgen und durch `&`-Zeichen getrennt sind. @@ -24,7 +24,7 @@ Aber wenn Sie sie mit Python-Typen deklarieren (im obigen Beispiel als `int`), w Die gleichen Prozesse, die für Pfad-Parameter gelten, werden auch auf Query-Parameter angewendet: * Editor Unterstützung (natürlich) -* Daten-„Parsen“ +* Daten-„Parsen“ * Datenvalidierung * Automatische Dokumentation @@ -127,7 +127,7 @@ Wenn Sie keinen spezifischen Wert haben wollen, sondern der Parameter einfach op Aber wenn Sie wollen, dass ein Query-Parameter erforderlich ist, vergeben Sie einfach keinen Defaultwert: -{* ../../docs_src/query_params/tutorial005_py39.py hl[6:7] *} +{* ../../docs_src/query_params/tutorial005_py310.py hl[6:7] *} Hier ist `needy` ein erforderlicher Query-Parameter vom Typ `str`. diff --git a/docs/de/docs/tutorial/request-files.md b/docs/de/docs/tutorial/request-files.md index 0aee898b9c..5b5f72d6db 100644 --- a/docs/de/docs/tutorial/request-files.md +++ b/docs/de/docs/tutorial/request-files.md @@ -20,13 +20,13 @@ Das liegt daran, dass hochgeladene Dateien als „Formulardaten“ gesendet werd Importieren Sie `File` und `UploadFile` von `fastapi`: -{* ../../docs_src/request_files/tutorial001_an_py39.py hl[3] *} +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[3] *} ## `File`-Parameter definieren { #define-file-parameters } Erstellen Sie Datei-Parameter, so wie Sie es auch mit `Body` und `Form` machen würden: -{* ../../docs_src/request_files/tutorial001_an_py39.py hl[9] *} +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[9] *} /// info | Info @@ -54,7 +54,7 @@ Aber es gibt viele Fälle, in denen Sie davon profitieren, `UploadFile` zu verwe Definieren Sie einen Datei-Parameter mit dem Typ `UploadFile`: -{* ../../docs_src/request_files/tutorial001_an_py39.py hl[14] *} +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[14] *} `UploadFile` zu verwenden, hat mehrere Vorzüge gegenüber `bytes`: @@ -143,7 +143,7 @@ Sie können eine Datei optional machen, indem Sie Standard-Typannotationen verwe Sie können auch `File()` mit `UploadFile` verwenden, um zum Beispiel zusätzliche Metadaten zu setzen: -{* ../../docs_src/request_files/tutorial001_03_an_py39.py hl[9,15] *} +{* ../../docs_src/request_files/tutorial001_03_an_py310.py hl[9,15] *} ## Mehrere Datei-Uploads { #multiple-file-uploads } @@ -153,7 +153,7 @@ Diese werden demselben Formularfeld zugeordnet, welches mit den Formulardaten ge Um das zu machen, deklarieren Sie eine Liste von `bytes` oder `UploadFile`s: -{* ../../docs_src/request_files/tutorial002_an_py39.py hl[10,15] *} +{* ../../docs_src/request_files/tutorial002_an_py310.py hl[10,15] *} Sie erhalten, wie deklariert, eine `list` von `bytes` oder `UploadFile`s. @@ -169,7 +169,7 @@ Sie können auch `from starlette.responses import HTMLResponse` verwenden. Und so wie zuvor können Sie `File()` verwenden, um zusätzliche Parameter zu setzen, sogar für `UploadFile`: -{* ../../docs_src/request_files/tutorial003_an_py39.py hl[11,18:20] *} +{* ../../docs_src/request_files/tutorial003_an_py310.py hl[11,18:20] *} ## Zusammenfassung { #recap } diff --git a/docs/de/docs/tutorial/request-form-models.md b/docs/de/docs/tutorial/request-form-models.md index fbc6c094c7..262a14d6db 100644 --- a/docs/de/docs/tutorial/request-form-models.md +++ b/docs/de/docs/tutorial/request-form-models.md @@ -24,7 +24,7 @@ Dies wird seit FastAPI Version `0.113.0` unterstützt. 🤓 Sie müssen nur ein **Pydantic-Modell** mit den Feldern deklarieren, die Sie als **Formularfelder** erhalten möchten, und dann den Parameter als `Form` deklarieren: -{* ../../docs_src/request_form_models/tutorial001_an_py39.py hl[9:11,15] *} +{* ../../docs_src/request_form_models/tutorial001_an_py310.py hl[9:11,15] *} **FastAPI** wird die Daten für **jedes Feld** aus den **Formulardaten** im Request **extrahieren** und Ihnen das von Ihnen definierte Pydantic-Modell übergeben. @@ -48,7 +48,7 @@ Dies wird seit FastAPI Version `0.114.0` unterstützt. 🤓 Sie können die Modellkonfiguration von Pydantic verwenden, um jegliche `extra` Felder zu `verbieten`: -{* ../../docs_src/request_form_models/tutorial002_an_py39.py hl[12] *} +{* ../../docs_src/request_form_models/tutorial002_an_py310.py hl[12] *} Wenn ein Client versucht, einige zusätzliche Daten zu senden, erhält er eine **Error-Response**. diff --git a/docs/de/docs/tutorial/request-forms-and-files.md b/docs/de/docs/tutorial/request-forms-and-files.md index cda38bcc2f..f779ff509f 100644 --- a/docs/de/docs/tutorial/request-forms-and-files.md +++ b/docs/de/docs/tutorial/request-forms-and-files.md @@ -16,13 +16,13 @@ $ pip install python-multipart ## `File` und `Form` importieren { #import-file-and-form } -{* ../../docs_src/request_forms_and_files/tutorial001_an_py39.py hl[3] *} +{* ../../docs_src/request_forms_and_files/tutorial001_an_py310.py hl[3] *} ## `File` und `Form`-Parameter definieren { #define-file-and-form-parameters } Erstellen Sie Datei- und Formularparameter, so wie Sie es auch mit `Body` oder `Query` machen würden: -{* ../../docs_src/request_forms_and_files/tutorial001_an_py39.py hl[10:12] *} +{* ../../docs_src/request_forms_and_files/tutorial001_an_py310.py hl[10:12] *} Die Datei- und Formularfelder werden als Formulardaten hochgeladen, und Sie erhalten diese Dateien und Formularfelder. diff --git a/docs/de/docs/tutorial/request-forms.md b/docs/de/docs/tutorial/request-forms.md index 5c2ace67b2..4a36dba725 100644 --- a/docs/de/docs/tutorial/request-forms.md +++ b/docs/de/docs/tutorial/request-forms.md @@ -18,17 +18,17 @@ $ pip install python-multipart Importieren Sie `Form` von `fastapi`: -{* ../../docs_src/request_forms/tutorial001_an_py39.py hl[3] *} +{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[3] *} ## `Form`-Parameter definieren { #define-form-parameters } Erstellen Sie Formular-Parameter, so wie Sie es auch mit `Body` und `Query` machen würden: -{* ../../docs_src/request_forms/tutorial001_an_py39.py hl[9] *} +{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[9] *} Zum Beispiel stellt eine der Möglichkeiten, die OAuth2-Spezifikation zu verwenden (genannt „password flow“), die Bedingung, einen `username` und ein `password` als Formularfelder zu senden. -Die Spec erfordert, dass die Felder exakt `username` und `password` genannt werden und als Formularfelder, nicht JSON, gesendet werden. +Die Spezifikation erfordert, dass die Felder exakt `username` und `password` genannt werden und als Formularfelder, nicht JSON, gesendet werden. Mit `Form` haben Sie die gleichen Konfigurationsmöglichkeiten wie mit `Body` (und `Query`, `Path`, `Cookie`), inklusive Validierung, Beispielen, einem Alias (z. B. `user-name` statt `username`), usw. diff --git a/docs/de/docs/tutorial/response-model.md b/docs/de/docs/tutorial/response-model.md index f759bb2571..99d194fe1c 100644 --- a/docs/de/docs/tutorial/response-model.md +++ b/docs/de/docs/tutorial/response-model.md @@ -183,7 +183,7 @@ Es kann Fälle geben, bei denen Sie etwas zurückgeben, das kein gültiges Pydan Der häufigste Anwendungsfall ist, wenn Sie [eine Response direkt zurückgeben, wie es später im Handbuch für fortgeschrittene Benutzer erläutert wird](../advanced/response-directly.md){.internal-link target=_blank}. -{* ../../docs_src/response_model/tutorial003_02_py39.py hl[8,10:11] *} +{* ../../docs_src/response_model/tutorial003_02_py310.py hl[8,10:11] *} Dieser einfache Anwendungsfall wird automatisch von FastAPI gehandhabt, weil die Annotation des Rückgabetyps die Klasse (oder eine Unterklasse von) `Response` ist. @@ -193,7 +193,7 @@ Und Tools werden auch glücklich sein, weil sowohl `RedirectResponse` als auch ` Sie können auch eine Unterklasse von `Response` in der Typannotation verwenden. -{* ../../docs_src/response_model/tutorial003_03_py39.py hl[8:9] *} +{* ../../docs_src/response_model/tutorial003_03_py310.py hl[8:9] *} Das wird ebenfalls funktionieren, weil `RedirectResponse` eine Unterklasse von `Response` ist, und FastAPI sich um diesen einfachen Anwendungsfall automatisch kümmert. @@ -201,7 +201,7 @@ Das wird ebenfalls funktionieren, weil `RedirectResponse` eine Unterklasse von ` Aber wenn Sie ein beliebiges anderes Objekt zurückgeben, das kein gültiger Pydantic-Typ ist (z. B. ein Datenbank-Objekt), und Sie annotieren es so in der Funktion, wird FastAPI versuchen, ein Pydantic-Responsemodell von dieser Typannotation zu erstellen, und scheitern. -Das gleiche wird passieren, wenn Sie eine Union mehrerer Typen haben, und einer oder mehrere sind nicht gültige Pydantic-Typen. Zum Beispiel funktioniert folgendes nicht 💥: +Das gleiche wird passieren, wenn Sie eine Union mehrerer Typen haben, und einer oder mehrere sind nicht gültige Pydantic-Typen. Zum Beispiel funktioniert folgendes nicht 💥: {* ../../docs_src/response_model/tutorial003_04_py310.py hl[8] *} diff --git a/docs/de/docs/tutorial/response-status-code.md b/docs/de/docs/tutorial/response-status-code.md index fd17c99336..2ed74f5901 100644 --- a/docs/de/docs/tutorial/response-status-code.md +++ b/docs/de/docs/tutorial/response-status-code.md @@ -8,7 +8,7 @@ Genauso wie Sie ein Responsemodell angeben können, können Sie auch den HTTP-St * `@app.delete()` * usw. -{* ../../docs_src/response_status_code/tutorial001_py39.py hl[6] *} +{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *} /// note | Hinweis @@ -66,7 +66,7 @@ Kurz gefasst: /// tip | Tipp -Um mehr über die einzelnen Statuscodes zu erfahren und welcher wofür verwendet wird, sehen Sie sich die MDN Dokumentation über HTTP-Statuscodes an. +Um mehr über die einzelnen Statuscodes zu erfahren und welcher wofür verwendet wird, sehen Sie sich die MDN Dokumentation über HTTP-Statuscodes an. /// @@ -74,7 +74,7 @@ Um mehr über die einzelnen Statuscodes zu erfahren und welcher wofür verwendet Lassen Sie uns das vorherige Beispiel noch einmal anschauen: -{* ../../docs_src/response_status_code/tutorial001_py39.py hl[6] *} +{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *} `201` ist der Statuscode für „Created“ („Erzeugt“). @@ -82,7 +82,7 @@ Aber Sie müssen sich nicht merken, was jeder dieser Codes bedeutet. Sie können die Annehmlichkeit von Variablen aus `fastapi.status` nutzen. -{* ../../docs_src/response_status_code/tutorial002_py39.py hl[1,6] *} +{* ../../docs_src/response_status_code/tutorial002_py310.py hl[1,6] *} Diese sind nur eine Annehmlichkeit, sie enthalten dieselbe Zahl, aber so können Sie die Autovervollständigung Ihres Editors verwenden, um sie zu finden: diff --git a/docs/de/docs/tutorial/schema-extra-example.md b/docs/de/docs/tutorial/schema-extra-example.md index 07fe8c5d92..c7b1c2b9ea 100644 --- a/docs/de/docs/tutorial/schema-extra-example.md +++ b/docs/de/docs/tutorial/schema-extra-example.md @@ -74,7 +74,7 @@ Sie können natürlich auch mehrere `examples` übergeben: Wenn Sie das tun, werden die Beispiele Teil des internen **JSON-Schemas** für diese Body-Daten. -Während dies geschrieben wird, unterstützt Swagger UI, das für die Anzeige der Dokumentations-Benutzeroberfläche zuständige Tool, jedoch nicht die Anzeige mehrerer Beispiele für die Daten in **JSON Schema**. Aber lesen Sie unten für einen Workaround weiter. +Nichtsdestotrotz unterstützt Swagger UI, das für die Anzeige der Dokumentations-Benutzeroberfläche zuständige Tool, zum Zeitpunkt der Erstellung nicht die Anzeige mehrerer Beispiele für die Daten in **JSON Schema**. Aber lesen Sie unten für einen Workaround weiter. ### OpenAPI-spezifische `examples` { #openapi-specific-examples } diff --git a/docs/de/docs/tutorial/security/first-steps.md b/docs/de/docs/tutorial/security/first-steps.md index 20fcd0c007..5806a8ea0f 100644 --- a/docs/de/docs/tutorial/security/first-steps.md +++ b/docs/de/docs/tutorial/security/first-steps.md @@ -20,7 +20,7 @@ Lassen Sie uns zunächst einfach den Code verwenden und sehen, wie er funktionie Kopieren Sie das Beispiel in eine Datei `main.py`: -{* ../../docs_src/security/tutorial001_an_py39.py *} +{* ../../docs_src/security/tutorial001_an_py310.py *} ## Ausführen { #run-it } @@ -111,7 +111,7 @@ Betrachten wir es also aus dieser vereinfachten Sicht: * Der Benutzer klickt im Frontend, um zu einem anderen Abschnitt der Frontend-Web-Anwendung zu gelangen. * Das Frontend muss weitere Daten von der API abrufen. * Es benötigt jedoch eine Authentifizierung für diesen bestimmten Endpunkt. - * Um sich also bei unserer API zu authentifizieren, sendet es einen Header `Authorization` mit dem Wert `Bearer ` plus dem Token. + * Um sich also bei unserer API zu authentifizieren, sendet es einen `Authorization`-Header mit dem Wert `Bearer ` plus dem Token. * Wenn der Token `foobar` enthielte, wäre der Inhalt des `Authorization`-Headers: `Bearer foobar`. ## **FastAPI**s `OAuth2PasswordBearer` { #fastapis-oauth2passwordbearer } @@ -134,7 +134,7 @@ In dem Fall gibt Ihnen **FastAPI** ebenfalls die Tools, die Sie zum Erstellen br Wenn wir eine Instanz der Klasse `OAuth2PasswordBearer` erstellen, übergeben wir den Parameter `tokenUrl`. Dieser Parameter enthält die URL, die der Client (das Frontend, das im Browser des Benutzers ausgeführt wird) verwendet, wenn er den `username` und das `password` sendet, um einen Token zu erhalten. -{* ../../docs_src/security/tutorial001_an_py39.py hl[8] *} +{* ../../docs_src/security/tutorial001_an_py310.py hl[8] *} /// tip | Tipp @@ -172,7 +172,7 @@ Es kann also mit `Depends` verwendet werden. Jetzt können Sie dieses `oauth2_scheme` als Abhängigkeit `Depends` übergeben. -{* ../../docs_src/security/tutorial001_an_py39.py hl[12] *} +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} Diese Abhängigkeit stellt einen `str` bereit, der dem Parameter `token` der *Pfadoperation-Funktion* zugewiesen wird. diff --git a/docs/de/docs/tutorial/security/get-current-user.md b/docs/de/docs/tutorial/security/get-current-user.md index e32e366698..cfb59ff12f 100644 --- a/docs/de/docs/tutorial/security/get-current-user.md +++ b/docs/de/docs/tutorial/security/get-current-user.md @@ -2,7 +2,7 @@ Im vorherigen Kapitel hat das Sicherheitssystem (das auf dem Dependency Injection System basiert) der *Pfadoperation-Funktion* einen `token` vom Typ `str` überreicht: -{* ../../docs_src/security/tutorial001_an_py39.py hl[12] *} +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} Aber das ist immer noch nicht so nützlich. diff --git a/docs/de/docs/tutorial/security/index.md b/docs/de/docs/tutorial/security/index.md index 39b0b93c98..6330d3d9dc 100644 --- a/docs/de/docs/tutorial/security/index.md +++ b/docs/de/docs/tutorial/security/index.md @@ -20,7 +20,7 @@ OAuth2 ist eine Spezifikation, die verschiedene Möglichkeiten zur Handhabung vo Es handelt sich um eine recht umfangreiche Spezifikation, und sie deckt mehrere komplexe Anwendungsfälle ab. -Sie umfasst Möglichkeiten zur Authentifizierung mithilfe eines „Dritten“ („third party“). +Sie umfasst Möglichkeiten zur Authentifizierung mithilfe eines „Dritten“. Das ist es, was alle diese „Login mit Facebook, Google, X (Twitter), GitHub“-Systeme unter der Haube verwenden. diff --git a/docs/de/docs/tutorial/security/oauth2-jwt.md b/docs/de/docs/tutorial/security/oauth2-jwt.md index 0d5ce587ba..6d35a1436d 100644 --- a/docs/de/docs/tutorial/security/oauth2-jwt.md +++ b/docs/de/docs/tutorial/security/oauth2-jwt.md @@ -116,7 +116,11 @@ Und eine weitere, um zu überprüfen, ob ein empfangenes Passwort mit dem gespei Und noch eine, um einen Benutzer zu authentifizieren und zurückzugeben. -{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,56:57,60:61,70:76] *} +{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,51,58:59,62:63,72:79] *} + +Wenn `authenticate_user` mit einem Benutzernamen aufgerufen wird, der in der Datenbank nicht existiert, führen wir dennoch `verify_password` gegen einen Dummy-Hash aus. + +So stellt man sicher, dass der Endpunkt ungefähr gleich viel Zeit für die Antwort benötigt, unabhängig davon, ob der Benutzername gültig ist oder nicht. Dadurch werden Timing-Angriffe verhindert, mit denen vorhandene Benutzernamen ermittelt werden könnten. /// note | Hinweis @@ -152,7 +156,7 @@ Definieren Sie ein Pydantic-Modell, das im Token-Endpunkt für die `timedelta` mit der Ablaufz Erstellen Sie einen echten JWT-Zugriffstoken und geben Sie ihn zurück. -{* ../../docs_src/security/tutorial004_an_py310.py hl[118:133] *} +{* ../../docs_src/security/tutorial004_an_py310.py hl[121:136] *} ### Technische Details zum JWT-„Subjekt“ `sub` { #technical-details-about-the-jwt-subject-sub } diff --git a/docs/de/docs/tutorial/security/simple-oauth2.md b/docs/de/docs/tutorial/security/simple-oauth2.md index 28cb83ba93..ae631f8b72 100644 --- a/docs/de/docs/tutorial/security/simple-oauth2.md +++ b/docs/de/docs/tutorial/security/simple-oauth2.md @@ -18,7 +18,7 @@ Aber für die Login-*Pfadoperation* müssen wir diese Namen verwenden, um mit de Die Spezifikation besagt auch, dass `username` und `password` als Formulardaten gesendet werden müssen (hier also kein JSON). -### `scope` { #scope } +### `scope` { #scope } Ferner sagt die Spezifikation, dass der Client ein weiteres Formularfeld "`scope`" („Geltungsbereich“) senden kann. diff --git a/docs/de/docs/tutorial/static-files.md b/docs/de/docs/tutorial/static-files.md index 9ba2501756..26e3853163 100644 --- a/docs/de/docs/tutorial/static-files.md +++ b/docs/de/docs/tutorial/static-files.md @@ -7,7 +7,7 @@ Mit `StaticFiles` können Sie statische Dateien aus einem Verzeichnis automatisc * Importieren Sie `StaticFiles`. * „Mounten“ Sie eine `StaticFiles()`-Instanz in einem bestimmten Pfad. -{* ../../docs_src/static_files/tutorial001_py39.py hl[2,6] *} +{* ../../docs_src/static_files/tutorial001_py310.py hl[2,6] *} /// note | Technische Details diff --git a/docs/de/docs/tutorial/testing.md b/docs/de/docs/tutorial/testing.md index d889b1e1fb..4fbe37279d 100644 --- a/docs/de/docs/tutorial/testing.md +++ b/docs/de/docs/tutorial/testing.md @@ -30,7 +30,7 @@ Verwenden Sie das `TestClient`-Objekt auf die gleiche Weise wie `httpx`. Schreiben Sie einfache `assert`-Anweisungen mit den Standard-Python-Ausdrücken, die Sie überprüfen müssen (wiederum, Standard-`pytest`). -{* ../../docs_src/app_testing/tutorial001_py39.py hl[2,12,15:18] *} +{* ../../docs_src/app_testing/tutorial001_py310.py hl[2,12,15:18] *} /// tip | Tipp @@ -76,7 +76,7 @@ Nehmen wir an, Sie haben eine Dateistruktur wie in [Größere Anwendungen](bigge In der Datei `main.py` haben Sie Ihre **FastAPI**-Anwendung: -{* ../../docs_src/app_testing/app_a_py39/main.py *} +{* ../../docs_src/app_testing/app_a_py310/main.py *} ### Testdatei { #testing-file } @@ -93,7 +93,7 @@ Dann könnten Sie eine Datei `test_main.py` mit Ihren Tests haben. Sie könnte s Da sich diese Datei im selben Package befindet, können Sie relative Importe verwenden, um das Objekt `app` aus dem `main`-Modul (`main.py`) zu importieren: -{* ../../docs_src/app_testing/app_a_py39/test_main.py hl[3] *} +{* ../../docs_src/app_testing/app_a_py310/test_main.py hl[3] *} ... und haben den Code für die Tests wie zuvor. diff --git a/docs/de/docs/virtual-environments.md b/docs/de/docs/virtual-environments.md index 11da496c54..621b4b1110 100644 --- a/docs/de/docs/virtual-environments.md +++ b/docs/de/docs/virtual-environments.md @@ -53,7 +53,7 @@ $ cd awesome-project ## Eine virtuelle Umgebung erstellen { #create-a-virtual-environment } -Wenn Sie zum **ersten Mal** an einem Python-Projekt arbeiten, erstellen Sie eine virtuelle Umgebung **innerhalb Ihres Projekts**. +Wenn Sie zum **ersten Mal** an einem Python-Projekt arbeiten, erstellen Sie eine virtuelle Umgebung **innerhalb Ihres Projekts**. /// tip | Tipp @@ -166,7 +166,7 @@ $ source .venv/Scripts/activate Jedes Mal, wenn Sie ein **neues Paket** in dieser Umgebung installieren, aktivieren Sie die Umgebung erneut. -So stellen Sie sicher, dass, wenn Sie ein **Terminalprogramm (CLI)** verwenden, das durch dieses Paket installiert wurde, Sie das aus Ihrer virtuellen Umgebung verwenden und nicht eines, das global installiert ist, wahrscheinlich mit einer anderen Version als der, die Sie benötigen. +So stellen Sie sicher, dass, wenn Sie ein **Terminalprogramm (CLI)** verwenden, das durch dieses Paket installiert wurde, Sie das aus Ihrer virtuellen Umgebung verwenden und nicht eines, das global installiert ist, wahrscheinlich mit einer anderen Version als der, die Sie benötigen. /// @@ -639,7 +639,7 @@ $ source .venv/Scripts/activate Dieser Befehl erstellt oder ändert einige [Umgebungsvariablen](environment-variables.md){.internal-link target=_blank}, die für die nächsten Befehle verfügbar sein werden. -Eine dieser Variablen ist die `PATH`-Variable. +Eine dieser Variablen ist die `PATH`-Umgebungsvariable. /// tip | Tipp @@ -649,7 +649,7 @@ Sie können mehr über die `PATH`-Umgebungsvariable im Abschnitt [Umgebungsvaria Das Aktivieren einer virtuellen Umgebung fügt deren Pfad `.venv/bin` (auf Linux und macOS) oder `.venv\Scripts` (auf Windows) zur `PATH`-Umgebungsvariable hinzu. -Angenommen, die `PATH`-Variable sah vor dem Aktivieren der Umgebung so aus: +Angenommen, die `PATH`-Umgebungsvariable sah vor dem Aktivieren der Umgebung so aus: //// tab | Linux, macOS @@ -678,7 +678,7 @@ Das bedeutet, dass das System nach Programmen sucht in: //// -Nach dem Aktivieren der virtuellen Umgebung würde die `PATH`-Variable folgendermaßen aussehen: +Nach dem Aktivieren der virtuellen Umgebung würde die `PATH`-Umgebungsvariable folgendermaßen aussehen: //// tab | Linux, macOS @@ -728,7 +728,7 @@ finden und dieses verwenden. //// -Ein wichtiger Punkt ist, dass es den Pfad der virtuellen Umgebung am **Anfang** der `PATH`-Variable platziert. Das System wird es **vor** allen anderen verfügbaren Pythons finden. Auf diese Weise, wenn Sie `python` ausführen, wird das Python **aus der virtuellen Umgebung** verwendet anstelle eines anderen `python` (zum Beispiel, einem `python` aus einer globalen Umgebung). +Ein wichtiger Punkt ist, dass es den Pfad der virtuellen Umgebung am **Anfang** der `PATH`-Umgebungsvariable platziert. Das System wird es **vor** allen anderen verfügbaren Pythons finden. Auf diese Weise, wenn Sie `python` ausführen, wird das Python **aus der virtuellen Umgebung** verwendet anstelle eines anderen `python` (zum Beispiel, einem `python` aus einer globalen Umgebung). Das Aktivieren einer virtuellen Umgebung ändert auch ein paar andere Dinge, aber dies ist eines der wichtigsten Dinge, die es tut. diff --git a/docs/en/docs/css/custom.css b/docs/en/docs/css/custom.css index 7c50dbd9be..dc9c7d63b4 100644 --- a/docs/en/docs/css/custom.css +++ b/docs/en/docs/css/custom.css @@ -61,6 +61,10 @@ a.internal-link::after { padding-bottom: 2em; } +.md-footer-meta .md-social { + padding-right: 4rem; +} + .user-list { display: flex; flex-wrap: wrap; diff --git a/docs/en/docs/js/init_kapa_widget.js b/docs/en/docs/js/init_kapa_widget.js new file mode 100644 index 0000000000..eaf123bf3f --- /dev/null +++ b/docs/en/docs/js/init_kapa_widget.js @@ -0,0 +1,29 @@ +document.addEventListener("DOMContentLoaded", function () { + var script = document.createElement("script"); + script.src = "https://widget.kapa.ai/kapa-widget.bundle.js"; + script.setAttribute("data-website-id", "91f47f27-b405-4299-bf5f-a1c0ec07b3cc"); + script.setAttribute("data-project-name", "FastAPI"); + script.setAttribute("data-project-color", "#009485"); + script.setAttribute("data-project-logo", "https://fastapi.tiangolo.com/img/favicon.png"); + script.setAttribute("data-bot-protection-mechanism", "hcaptcha"); + script.setAttribute("data-button-height", "3rem"); + script.setAttribute("data-button-width", "3rem"); + script.setAttribute("data-button-border-radius", "50%"); + script.setAttribute("data-button-padding", "0"); + script.setAttribute("data-button-image", "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='white' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M12 8V4H8'/%3E%3Crect width='16' height='12' x='4' y='8' rx='2'/%3E%3Cpath d='M2 14h2'/%3E%3Cpath d='M20 14h2'/%3E%3Cpath d='M15 13v2'/%3E%3Cpath d='M9 13v2'/%3E%3C/svg%3E"); + script.setAttribute("data-button-image-height", "20px"); + script.setAttribute("data-button-image-width", "20px"); + script.setAttribute("data-button-text", "Ask AI"); + script.setAttribute("data-button-text-font-size", "0.5rem"); + script.setAttribute("data-button-text-font-family", "Roboto, sans-serif"); + script.setAttribute("data-button-text-color", "#FFFFFF"); + script.setAttribute("data-modal-border-radius", "0.5rem"); + script.setAttribute("data-modal-header-bg-color", "#009485"); + script.setAttribute("data-modal-title", "FastAPI AI Assistant"); + script.setAttribute("data-modal-title-color", "#FFFFFF"); + script.setAttribute("data-modal-title-font-family", "Roboto, sans-serif"); + script.setAttribute("data-modal-example-questions", "How to define a route?,How to validate models?,How to handle responses?,How to deploy FastAPI?"); + script.setAttribute("data-modal-disclaimer", "AI-generated answers based on FastAPI [documentation](https://fastapi.tiangolo.com/) and [community discussions](https://github.com/fastapi/fastapi/discussions). Always verify important information."); + script.async = true; + document.head.appendChild(script); +}); diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md index 2f2d599dc9..34492bfc58 100644 --- a/docs/en/docs/release-notes.md +++ b/docs/en/docs/release-notes.md @@ -9,10 +9,16 @@ hide: ### Docs +* 🔥 Remove Python 3.9 specific files, no longer needed after updating translations. PR [#14931](https://github.com/fastapi/fastapi/pull/14931) by [@tiangolo](https://github.com/tiangolo). * 📝 Update docs for JWT to prevent timing attacks. PR [#14908](https://github.com/fastapi/fastapi/pull/14908) by [@tiangolo](https://github.com/tiangolo). ### Translations +* 🌐 Update translations for ko (update-all and add-missing). PR [#14923](https://github.com/fastapi/fastapi/pull/14923) by [@YuriiMotov](https://github.com/YuriiMotov). +* 🌐 Update translations for uk (add-missing). PR [#14922](https://github.com/fastapi/fastapi/pull/14922) by [@YuriiMotov](https://github.com/YuriiMotov). +* 🌐 Update translations for zh-hant (update-all and add-missing). PR [#14921](https://github.com/fastapi/fastapi/pull/14921) by [@YuriiMotov](https://github.com/YuriiMotov). +* 🌐 Update translations for fr (update-all and add-missing). PR [#14920](https://github.com/fastapi/fastapi/pull/14920) by [@YuriiMotov](https://github.com/YuriiMotov). +* 🌐 Update translations for de (update-all) . PR [#14910](https://github.com/fastapi/fastapi/pull/14910) by [@YuriiMotov](https://github.com/YuriiMotov). * 🌐 Update translations for ja (update-all). PR [#14916](https://github.com/fastapi/fastapi/pull/14916) by [@YuriiMotov](https://github.com/YuriiMotov). * 🌐 Update translations for pt (update-all). PR [#14912](https://github.com/fastapi/fastapi/pull/14912) by [@YuriiMotov](https://github.com/YuriiMotov). * 🌐 Update translations for es (update-all and add-missing). PR [#14911](https://github.com/fastapi/fastapi/pull/14911) by [@YuriiMotov](https://github.com/YuriiMotov). @@ -23,6 +29,7 @@ hide: ### Internal +* 🎨 Upgrade typing syntax for Python 3.10. PR [#14932](https://github.com/fastapi/fastapi/pull/14932) by [@tiangolo](https://github.com/tiangolo). * ⬆ Bump cryptography from 46.0.4 to 46.0.5. PR [#14892](https://github.com/fastapi/fastapi/pull/14892) by [@dependabot[bot]](https://github.com/apps/dependabot). * ⬆ Bump pillow from 12.1.0 to 12.1.1. PR [#14899](https://github.com/fastapi/fastapi/pull/14899) by [@dependabot[bot]](https://github.com/apps/dependabot). diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml index 66ad67e9d0..96ed3d5869 100644 --- a/docs/en/mkdocs.yml +++ b/docs/en/mkdocs.yml @@ -342,5 +342,6 @@ extra_css: extra_javascript: - js/termynal.js - js/custom.js +- js/init_kapa_widget.js hooks: - ../../scripts/mkdocs_hooks.py diff --git a/docs/fr/docs/_llm-test.md b/docs/fr/docs/_llm-test.md new file mode 100644 index 0000000000..4fdc677385 --- /dev/null +++ b/docs/fr/docs/_llm-test.md @@ -0,0 +1,503 @@ +# Fichier de test LLM { #llm-test-file } + +Ce document teste si le LLM, qui traduit la documentation, comprend le `general_prompt` dans `scripts/translate.py` et l’invite spécifique à la langue dans `docs/{language code}/llm-prompt.md`. L’invite spécifique à la langue est ajoutée à la fin de `general_prompt`. + +Les tests ajoutés ici seront visibles par tous les concepteurs d’invites spécifiques à chaque langue. + +Utiliser comme suit : + +* Avoir une invite spécifique à la langue - `docs/{language code}/llm-prompt.md`. +* Effectuer une nouvelle traduction de ce document dans votre langue cible souhaitée (voir par exemple la commande `translate-page` de `translate.py`). Cela créera la traduction sous `docs/{language code}/docs/_llm-test.md`. +* Vérifier si tout est correct dans la traduction. +* Si nécessaire, améliorer votre invite spécifique à la langue, l’invite générale, ou le document anglais. +* Corriger ensuite manuellement les problèmes restants dans la traduction, afin que ce soit une bonne traduction. +* Retraduire, en ayant la bonne traduction en place. Le résultat idéal serait que le LLM ne fasse plus aucun changement à la traduction. Cela signifie que l’invite générale et votre invite spécifique à la langue sont aussi bonnes que possible (il fera parfois quelques changements apparemment aléatoires, la raison étant que les LLM ne sont pas des algorithmes déterministes). + +Les tests : + +## Extraits de code { #code-snippets } + +//// tab | Test + +Ceci est un extrait de code : `foo`. Et ceci est un autre extrait de code : `bar`. Et encore un autre : `baz quux`. + +//// + +//// tab | Info + +Le contenu des extraits de code doit être laissé tel quel. + +Voir la section `### Content of code snippets` dans l’invite générale dans `scripts/translate.py`. + +//// + +## Guillemets { #quotes } + +//// tab | Test + +Hier, mon ami a écrit : « Si vous écrivez « incorrectly » correctement, vous l’avez écrit de façon incorrecte ». À quoi j’ai répondu : « Correct, mais ‘incorrectly’ est incorrectement non pas ‘« incorrectly »’ ». + +/// note | Remarque + +Le LLM traduira probablement ceci de manière erronée. Il est seulement intéressant de voir s’il conserve la traduction corrigée lors d’une retraduction. + +/// + +//// + +//// tab | Info + +Le concepteur de l’invite peut choisir s’il souhaite convertir les guillemets neutres en guillemets typographiques. Il est acceptable de les laisser tels quels. + +Voir par exemple la section `### Quotes` dans `docs/de/llm-prompt.md`. + +//// + +## Guillemets dans les extraits de code { #quotes-in-code-snippets } + +//// tab | Test + +`pip install "foo[bar]"` + +Exemples de littéraux de chaîne dans des extraits de code : `"this"`, `'that'`. + +Un exemple difficile de littéraux de chaîne dans des extraits de code : `f"I like {'oranges' if orange else "apples"}"` + +Hardcore: `Yesterday, my friend wrote: "If you spell incorrectly correctly, you have spelled it incorrectly". To which I answered: "Correct, but 'incorrectly' is incorrectly not '"incorrectly"'"` + +//// + +//// tab | Info + +... Cependant, les guillemets à l’intérieur des extraits de code doivent rester tels quels. + +//// + +## Blocs de code { #code-blocks } + +//// tab | Test + +Un exemple de code Bash ... + +```bash +# Afficher un message de bienvenue à l'univers +echo "Hello universe" +``` + +... et un exemple de code console ... + +```console +$ fastapi run main.py + FastAPI Starting server + Searching for package file structure +``` + +... et un autre exemple de code console ... + +```console +// Créer un répertoire "Code" +$ mkdir code +// Aller dans ce répertoire +$ cd code +``` + +... et un exemple de code Python ... + +```Python +wont_work() # Cela ne fonctionnera pas 😱 +works(foo="bar") # Cela fonctionne 🎉 +``` + +... et c’est tout. + +//// + +//// tab | Info + +Le code dans les blocs de code ne doit pas être modifié, à l’exception des commentaires. + +Voir la section `### Content of code blocks` dans l’invite générale dans `scripts/translate.py`. + +//// + +## Onglets et encadrés colorés { #tabs-and-colored-boxes } + +//// tab | Test + +/// info | Info +Du texte +/// + +/// note | Remarque +Du texte +/// + +/// note | Détails techniques +Du texte +/// + +/// check | Vérifications +Du texte +/// + +/// tip | Astuce +Du texte +/// + +/// warning | Alertes +Du texte +/// + +/// danger | Danger +Du texte +/// + +//// + +//// tab | Info + +Les onglets et les blocs « Info »/« Note »/« Warning »/etc. doivent avoir la traduction de leur titre ajoutée après une barre verticale (« | »). + +Voir les sections `### Special blocks` et `### Tab blocks` dans l’invite générale dans `scripts/translate.py`. + +//// + +## Liens Web et internes { #web-and-internal-links } + +//// tab | Test + +Le texte du lien doit être traduit, l’adresse du lien doit rester inchangée : + +* [Lien vers le titre ci-dessus](#code-snippets) +* [Lien interne](index.md#installation){.internal-link target=_blank} +* Lien externe +* Lien vers une feuille de style +* Lien vers un script +* Lien vers une image + +Le texte du lien doit être traduit, l’adresse du lien doit pointer vers la traduction : + +* Lien FastAPI + +//// + +//// tab | Info + +Les liens doivent être traduits, mais leur adresse doit rester inchangée. Exception faite des liens absolus vers des pages de la documentation FastAPI. Dans ce cas, il faut pointer vers la traduction. + +Voir la section `### Links` dans l’invite générale dans `scripts/translate.py`. + +//// + +## Éléments HTML « abbr » { #html-abbr-elements } + +//// tab | Test + +Voici quelques éléments entourés d’un élément HTML « abbr » (certains sont inventés) : + +### L’abbr fournit une expression complète { #the-abbr-gives-a-full-phrase } + +* GTD +* lt +* XWT +* PSGI + +### L’abbr donne une expression complète et une explication { #the-abbr-gives-a-full-phrase-and-an-explanation } + +* MDN +* I/O. + +//// + +//// tab | Info + +Les attributs « title » des éléments « abbr » sont traduits en suivant des consignes spécifiques. + +Les traductions peuvent ajouter leurs propres éléments « abbr » que le LLM ne doit pas supprimer. Par exemple pour expliquer des mots anglais. + +Voir la section `### HTML abbr elements` dans l’invite générale dans `scripts/translate.py`. + +//// + +## Éléments HTML « dfn » { #html-dfn-elements } + +* grappe +* Apprentissage profond + +## Titres { #headings } + +//// tab | Test + +### Créer une application Web - un tutoriel { #develop-a-webapp-a-tutorial } + +Bonjour. + +### Annotations de type et indications de type { #type-hints-and-annotations } + +Rebonjour. + +### Superclasses et sous-classes { #super-and-subclasses } + +Rebonjour. + +//// + +//// tab | Info + +La seule règle stricte pour les titres est que le LLM laisse la partie hachage entre accolades inchangée, ce qui garantit que les liens ne se rompent pas. + +Voir la section `### Headings` dans l’invite générale dans `scripts/translate.py`. + +Pour certaines consignes spécifiques à la langue, voir par exemple la section `### Headings` dans `docs/de/llm-prompt.md`. + +//// + +## Termes utilisés dans les documents { #terms-used-in-the-docs } + +//// tab | Test + +* vous +* votre + +* p. ex. +* etc. + +* `foo` en tant que `int` +* `bar` en tant que `str` +* `baz` en tant que `list` + +* le Tutoriel - Guide utilisateur +* le Guide utilisateur avancé +* la documentation SQLModel +* la documentation de l’API +* la documentation automatique + +* Data Science +* Apprentissage profond +* Apprentissage automatique +* Injection de dépendances +* authentification HTTP Basic +* HTTP Digest +* format ISO +* la norme JSON Schema +* le schéma JSON +* la définition de schéma +* Flux Password +* Mobile + +* déprécié +* conçu +* invalide +* à la volée +* standard +* par défaut +* sensible à la casse +* insensible à la casse + +* servir l’application +* servir la page + +* l’app +* l’application + +* la requête +* la réponse +* la réponse d’erreur + +* le chemin d’accès +* le décorateur de chemin d’accès +* la fonction de chemin d’accès + +* le corps +* le corps de la requête +* le corps de la réponse +* le corps JSON +* le corps de formulaire +* le corps de fichier +* le corps de la fonction + +* le paramètre +* le paramètre de corps +* le paramètre de chemin +* le paramètre de requête +* le paramètre de cookie +* le paramètre d’en-tête +* le paramètre de formulaire +* le paramètre de fonction + +* l’événement +* l’événement de démarrage +* le démarrage du serveur +* l’événement d’arrêt +* l’événement de cycle de vie + +* le gestionnaire +* le gestionnaire d’événements +* le gestionnaire d’exceptions +* gérer + +* le modèle +* le modèle Pydantic +* le modèle de données +* le modèle de base de données +* le modèle de formulaire +* l’objet modèle + +* la classe +* la classe de base +* la classe parente +* la sous-classe +* la classe enfant +* la classe sœur +* la méthode de classe + +* l’en-tête +* les en-têtes +* l’en-tête d’autorisation +* l’en-tête `Authorization` +* l’en-tête transféré + +* le système d’injection de dépendances +* la dépendance +* l’élément dépendable +* le dépendant + +* lié aux E/S +* lié au processeur +* concurrence +* parallélisme +* multi-traitement + +* la variable d’env +* la variable d’environnement +* le `PATH` +* la variable `PATH` + +* l’authentification +* le fournisseur d’authentification +* l’autorisation +* le formulaire d’autorisation +* le fournisseur d’autorisation +* l’utilisateur s’authentifie +* le système authentifie l’utilisateur + +* la CLI +* l’interface en ligne de commande + +* le serveur +* le client + +* le fournisseur cloud +* le service cloud + +* le développement +* les étapes de développement + +* le dict +* le dictionnaire +* l’énumération +* l’enum +* le membre d’enum + +* l’encodeur +* le décodeur +* encoder +* décoder + +* l’exception +* lever + +* l’expression +* l’instruction + +* le frontend +* le backend + +* la discussion GitHub +* le ticket GitHub + +* la performance +* l’optimisation des performances + +* le type de retour +* la valeur de retour + +* la sécurité +* le schéma de sécurité + +* la tâche +* la tâche d’arrière-plan +* la fonction de tâche + +* le template +* le moteur de templates + +* l’annotation de type +* l’annotation de type + +* le worker du serveur +* le worker Uvicorn +* le Worker Gunicorn +* le processus worker +* la classe de worker +* la charge de travail + +* le déploiement +* déployer + +* le SDK +* le kit de développement logiciel + +* le `APIRouter` +* le `requirements.txt` +* le jeton Bearer +* le changement majeur incompatible +* le bogue +* le bouton +* l’appelable +* le code +* le commit +* le gestionnaire de contexte +* la coroutine +* la session de base de données +* le disque +* le domaine +* le moteur +* le faux X +* la méthode HTTP GET +* l’élément +* la bibliothèque +* le cycle de vie +* le verrou +* le middleware +* l’application mobile +* le module +* le montage +* le réseau +* l’origine +* la surcharge +* le payload +* le processeur +* la propriété +* le proxy +* la pull request +* la requête +* la RAM +* la machine distante +* le code d’état +* la chaîne +* l’étiquette +* le framework Web +* le joker +* retourner +* valider + +//// + +//// tab | Info + +Il s’agit d’une liste non exhaustive et non normative de termes (principalement) techniques présents dans les documents. Elle peut aider le concepteur de l’invite à déterminer pour quels termes le LLM a besoin d’un coup de main. Par exemple, lorsqu’il continue de remplacer une bonne traduction par une traduction sous-optimale. Ou lorsqu’il a des difficultés à conjuguer/décliner un terme dans votre langue. + +Voir par exemple la section `### List of English terms and their preferred German translations` dans `docs/de/llm-prompt.md`. + +//// diff --git a/docs/fr/docs/about/index.md b/docs/fr/docs/about/index.md new file mode 100644 index 0000000000..f6ec12a4f8 --- /dev/null +++ b/docs/fr/docs/about/index.md @@ -0,0 +1,3 @@ +# À propos { #about } + +À propos de FastAPI, de sa conception, de ses sources d'inspiration et plus encore. 🤓 diff --git a/docs/fr/docs/advanced/additional-responses.md b/docs/fr/docs/advanced/additional-responses.md index dabcded52e..a073dec692 100644 --- a/docs/fr/docs/advanced/additional-responses.md +++ b/docs/fr/docs/advanced/additional-responses.md @@ -8,7 +8,7 @@ Si vous débutez avec **FastAPI**, vous n'en aurez peut-être pas besoin. /// -Vous pouvez déclarer des réponses supplémentaires, avec des codes HTTP, des types de médias, des descriptions, etc. +Vous pouvez déclarer des réponses supplémentaires, avec des codes d'état supplémentaires, des types de médias, des descriptions, etc. Ces réponses supplémentaires seront incluses dans le schéma OpenAPI, elles apparaîtront donc également dans la documentation de l'API. @@ -26,7 +26,7 @@ Chacun de ces `dict` de réponse peut avoir une clé `model`, contenant un modè Par exemple, pour déclarer une autre réponse avec un code HTTP `404` et un modèle Pydantic `Message`, vous pouvez écrire : -{* ../../docs_src/additional_responses/tutorial001_py39.py hl[18,22] *} +{* ../../docs_src/additional_responses/tutorial001_py310.py hl[18,22] *} /// note | Remarque @@ -203,7 +203,7 @@ Par exemple, vous pouvez déclarer une réponse avec un code HTTP `404` qui util Et une réponse avec un code HTTP `200` qui utilise votre `response_model`, mais inclut un `example` personnalisé : -{* ../../docs_src/additional_responses/tutorial003_py39.py hl[20:31] *} +{* ../../docs_src/additional_responses/tutorial003_py310.py hl[20:31] *} Tout sera combiné et inclus dans votre OpenAPI, et affiché dans la documentation de l'API : diff --git a/docs/fr/docs/advanced/additional-status-codes.md b/docs/fr/docs/advanced/additional-status-codes.md index b2befffa8d..b9c8ab1136 100644 --- a/docs/fr/docs/advanced/additional-status-codes.md +++ b/docs/fr/docs/advanced/additional-status-codes.md @@ -36,6 +36,6 @@ Pour plus de commodités, **FastAPI** fournit les objets `starlette.responses` s ## Documents OpenAPI et API { #openapi-and-api-docs } -Si vous renvoyez directement des codes HTTP et des réponses supplémentaires, ils ne seront pas inclus dans le schéma OpenAPI (la documentation de l'API), car FastAPI n'a aucun moyen de savoir à l'avance ce que vous allez renvoyer. +Si vous renvoyez directement des codes HTTP et des réponses supplémentaires, ils ne seront pas inclus dans le schéma OpenAPI (les documents de l'API), car FastAPI n'a aucun moyen de savoir à l'avance ce que vous allez renvoyer. Mais vous pouvez documenter cela dans votre code, en utilisant : [Réponses supplémentaires](additional-responses.md){.internal-link target=_blank}. diff --git a/docs/fr/docs/advanced/advanced-dependencies.md b/docs/fr/docs/advanced/advanced-dependencies.md new file mode 100644 index 0000000000..8afd58b48e --- /dev/null +++ b/docs/fr/docs/advanced/advanced-dependencies.md @@ -0,0 +1,163 @@ +# Dépendances avancées { #advanced-dependencies } + +## Dépendances paramétrées { #parameterized-dependencies } + +Toutes les dépendances que nous avons vues étaient des fonctions ou des classes fixes. + +Mais il peut y avoir des cas où vous souhaitez pouvoir définir des paramètres sur la dépendance, sans devoir déclarer de nombreuses fonctions ou classes différentes. + +Imaginons que nous voulions avoir une dépendance qui vérifie si le paramètre de requête `q` contient un contenu fixe. + +Mais nous voulons pouvoir paramétrer ce contenu fixe. + +## Une instance « callable » { #a-callable-instance } + +En Python, il existe un moyen de rendre une instance de classe « callable ». + +Pas la classe elle‑même (qui est déjà un callable), mais une instance de cette classe. + +Pour cela, nous déclarons une méthode `__call__` : + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[12] *} + +Dans ce cas, ce `__call__` est ce que **FastAPI** utilisera pour détecter des paramètres supplémentaires et des sous‑dépendances, et c’est ce qui sera appelé pour transmettre ensuite une valeur au paramètre dans votre *fonction de chemin d'accès*. + +## Paramétrer l'instance { #parameterize-the-instance } + +Et maintenant, nous pouvons utiliser `__init__` pour déclarer les paramètres de l’instance, que nous utiliserons pour « paramétrer » la dépendance : + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[9] *} + +Dans ce cas, **FastAPI** n’accèdera pas à `__init__` et ne s’en souciera pas ; nous l’utiliserons directement dans notre code. + +## Créer une instance { #create-an-instance } + +Nous pouvons créer une instance de cette classe avec : + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[18] *} + +Et de cette façon, nous pouvons « paramétrer » notre dépendance, qui contient maintenant « bar », en tant qu’attribut `checker.fixed_content`. + +## Utiliser l'instance comme dépendance { #use-the-instance-as-a-dependency } + +Ensuite, nous pourrions utiliser ce `checker` dans un `Depends(checker)`, au lieu de `Depends(FixedContentQueryChecker)`, car la dépendance est l’instance, `checker`, et non la classe elle‑même. + +Et lors de la résolution de la dépendance, **FastAPI** appellera ce `checker` comme ceci : + +```Python +checker(q="somequery") +``` + +... et passera ce que cela renvoie comme valeur de la dépendance à notre *fonction de chemin d'accès*, en tant que paramètre `fixed_content_included` : + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[22] *} + +/// tip | Astuce + +Tout cela peut sembler artificiel. Et il n’est peut‑être pas encore très clair en quoi c’est utile. + +Ces exemples sont volontairement simples, mais ils montrent comment tout cela fonctionne. + +Dans les chapitres sur la sécurité, il existe des fonctions utilitaires implémentées de la même manière. + +Si vous avez compris tout cela, vous savez déjà comment ces outils utilitaires pour la sécurité fonctionnent en interne. + +/// + +## Dépendances avec `yield`, `HTTPException`, `except` et tâches d'arrière‑plan { #dependencies-with-yield-httpexception-except-and-background-tasks } + +/// warning | Alertes + +Vous n’avez très probablement pas besoin de ces détails techniques. + +Ces détails sont utiles principalement si vous aviez une application FastAPI antérieure à la version 0.121.0 et que vous rencontrez des problèmes avec des dépendances utilisant `yield`. + +/// + +Les dépendances avec `yield` ont évolué au fil du temps pour couvrir différents cas d’utilisation et corriger certains problèmes ; voici un résumé de ce qui a changé. + +### Dépendances avec `yield` et `scope` { #dependencies-with-yield-and-scope } + +Dans la version 0.121.0, **FastAPI** a ajouté la prise en charge de `Depends(scope="function")` pour les dépendances avec `yield`. + +Avec `Depends(scope="function")`, le code d’arrêt après `yield` s’exécute immédiatement après la fin de la *fonction de chemin d'accès*, avant que la réponse ne soit renvoyée au client. + +Et lorsque vous utilisez `Depends(scope="request")` (valeur par défaut), le code d’arrêt après `yield` s’exécute après l’envoi de la réponse. + +Vous pouvez en lire davantage dans les documents pour [Dépendances avec `yield` - Sortie anticipée et `scope`](../tutorial/dependencies/dependencies-with-yield.md#early-exit-and-scope). + +### Dépendances avec `yield` et `StreamingResponse`, Détails techniques { #dependencies-with-yield-and-streamingresponse-technical-details } + +Avant FastAPI 0.118.0, si vous utilisiez une dépendance avec `yield`, elle exécutait le code d’arrêt après que la *fonction de chemin d'accès* a retourné, mais juste avant d’envoyer la réponse. + +L’objectif était d’éviter de conserver des ressources plus longtemps que nécessaire pendant que la réponse transitait sur le réseau. + +Ce changement impliquait aussi que si vous retourniez une `StreamingResponse`, le code d’arrêt de la dépendance avec `yield` aurait déjà été exécuté. + +Par exemple, si vous aviez une session de base de données dans une dépendance avec `yield`, la `StreamingResponse` ne pourrait pas utiliser cette session pendant le streaming des données, car la session aurait déjà été fermée dans le code d’arrêt après `yield`. + +Ce comportement a été annulé en 0.118.0, afin que le code d’arrêt après `yield` s’exécute après l’envoi de la réponse. + +/// info + +Comme vous le verrez ci‑dessous, c’est très similaire au comportement avant la version 0.106.0, mais avec plusieurs améliorations et corrections de bogues pour des cas limites. + +/// + +#### Cas d’utilisation avec sortie anticipée du code { #use-cases-with-early-exit-code } + +Il existe certains cas d’utilisation avec des conditions spécifiques qui pourraient bénéficier de l’ancien comportement, où le code d’arrêt des dépendances avec `yield` s’exécute avant l’envoi de la réponse. + +Par exemple, imaginez que vous ayez du code qui utilise une session de base de données dans une dépendance avec `yield` uniquement pour vérifier un utilisateur, mais que la session de base de données ne soit plus jamais utilisée dans la *fonction de chemin d'accès*, seulement dans la dépendance, et que la réponse mette longtemps à être envoyée, comme une `StreamingResponse` qui envoie les données lentement mais qui, pour une raison quelconque, n’utilise pas la base de données. + +Dans ce cas, la session de base de données serait conservée jusqu’à la fin de l’envoi de la réponse, mais si vous ne l’utilisez pas, il ne serait pas nécessaire de la conserver. + +Voici à quoi cela pourrait ressembler : + +{* ../../docs_src/dependencies/tutorial013_an_py310.py *} + +Le code d’arrêt, la fermeture automatique de la `Session` dans : + +{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[19:21] *} + +... serait exécuté après que la réponse a fini d’envoyer les données lentes : + +{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[30:38] hl[31:33] *} + +Mais comme `generate_stream()` n’utilise pas la session de base de données, il n’est pas vraiment nécessaire de garder la session ouverte pendant l’envoi de la réponse. + +Si vous avez ce cas d’utilisation spécifique avec SQLModel (ou SQLAlchemy), vous pouvez fermer explicitement la session dès que vous n’en avez plus besoin : + +{* ../../docs_src/dependencies/tutorial014_an_py310.py ln[24:28] hl[28] *} + +De cette manière, la session libérera la connexion à la base de données, afin que d’autres requêtes puissent l’utiliser. + +Si vous avez un autre cas d’utilisation qui nécessite une sortie anticipée depuis une dépendance avec `yield`, veuillez créer une Question de discussion GitHub avec votre cas spécifique et pourquoi vous bénéficieriez d’une fermeture anticipée pour les dépendances avec `yield`. + +S’il existe des cas d’utilisation convaincants pour une fermeture anticipée dans les dépendances avec `yield`, j’envisagerai d’ajouter une nouvelle façon d’y opter. + +### Dépendances avec `yield` et `except`, Détails techniques { #dependencies-with-yield-and-except-technical-details } + +Avant FastAPI 0.110.0, si vous utilisiez une dépendance avec `yield`, puis capturiez une exception avec `except` dans cette dépendance, et que vous ne relanciez pas l’exception, l’exception était automatiquement levée/transmise à tout gestionnaire d’exceptions ou au gestionnaire d’erreur interne du serveur. + +Cela a été modifié dans la version 0.110.0 pour corriger une consommation de mémoire non gérée due aux exceptions transmises sans gestionnaire (erreurs internes du serveur), et pour rendre le comportement cohérent avec celui du code Python classique. + +### Tâches d'arrière‑plan et dépendances avec `yield`, Détails techniques { #background-tasks-and-dependencies-with-yield-technical-details } + +Avant FastAPI 0.106.0, lever des exceptions après `yield` n’était pas possible, le code d’arrêt dans les dépendances avec `yield` s’exécutait après l’envoi de la réponse, donc les [Gestionnaires d'exceptions](../tutorial/handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank} avaient déjà été exécutés. + +Cela avait été conçu ainsi principalement pour permettre d’utiliser les mêmes objets « générés par yield » par les dépendances à l’intérieur de tâches d’arrière‑plan, car le code d’arrêt s’exécutait après la fin des tâches d’arrière‑plan. + +Cela a été modifié dans FastAPI 0.106.0 afin de ne pas conserver des ressources pendant l’attente de la transmission de la réponse sur le réseau. + +/// tip | Astuce + +De plus, une tâche d’arrière‑plan est normalement un ensemble de logique indépendant qui devrait être géré séparément, avec ses propres ressources (par ex. sa propre connexion à la base de données). + +Ainsi, vous aurez probablement un code plus propre. + +/// + +Si vous comptiez sur ce comportement, vous devez désormais créer les ressources pour les tâches d’arrière‑plan à l’intérieur de la tâche elle‑même, et n’utiliser en interne que des données qui ne dépendent pas des ressources des dépendances avec `yield`. + +Par exemple, au lieu d’utiliser la même session de base de données, vous créeriez une nouvelle session de base de données à l’intérieur de la tâche d’arrière‑plan, et vous obtiendriez les objets depuis la base de données en utilisant cette nouvelle session. Puis, au lieu de passer l’objet obtenu depuis la base de données en paramètre à la fonction de tâche d’arrière‑plan, vous passeriez l’identifiant (ID) de cet objet et vous obtiendriez à nouveau l’objet à l’intérieur de la fonction de la tâche d’arrière‑plan. diff --git a/docs/fr/docs/advanced/advanced-python-types.md b/docs/fr/docs/advanced/advanced-python-types.md new file mode 100644 index 0000000000..3e2d9453b6 --- /dev/null +++ b/docs/fr/docs/advanced/advanced-python-types.md @@ -0,0 +1,61 @@ +# Types Python avancés { #advanced-python-types } + +Voici quelques idées supplémentaires qui peuvent être utiles lorsque vous travaillez avec les types Python. + +## Utiliser `Union` ou `Optional` { #using-union-or-optional } + +Si votre code ne peut pas utiliser `|` pour une raison quelconque, par exemple si ce n'est pas dans une annotation de type mais dans quelque chose comme `response_model=`, au lieu d'utiliser la barre verticale (`|`) vous pouvez utiliser `Union` de `typing`. + +Par exemple, vous pourriez déclarer que quelque chose peut être un `str` ou `None` : + +```python +from typing import Union + + +def say_hi(name: Union[str, None]): + print(f"Hi {name}!") +``` + +`typing` propose également un raccourci pour déclarer que quelque chose peut être `None`, avec `Optional`. + +Voici un conseil issu de mon point de vue très subjectif : + +- 🚨 Évitez d'utiliser `Optional[SomeType]` +- À la place ✨ **utilisez `Union[SomeType, None]`** ✨. + +Les deux sont équivalents et, en interne, identiques, mais je recommande `Union` plutôt que `Optional` parce que le mot « optional » semble impliquer que la valeur est facultative, alors qu'il signifie en réalité « elle peut être `None` », même si elle n'est pas facultative et reste requise. + +Je pense que `Union[SomeType, None]` est plus explicite quant à sa signification. + +Il ne s'agit que des mots et des noms. Mais ces mots peuvent influencer la manière dont vous et vos coéquipiers pensez au code. + +À titre d'exemple, prenons cette fonction : + +```python +from typing import Optional + + +def say_hi(name: Optional[str]): + print(f"Hey {name}!") +``` + +Le paramètre `name` est défini comme `Optional[str]`, mais il n'est pas facultatif, vous ne pouvez pas appeler la fonction sans le paramètre : + +```Python +say_hi() # Oh non, cela lève une erreur ! 😱 +``` + +Le paramètre `name` est toujours requis (pas facultatif) car il n'a pas de valeur par défaut. En revanche, `name` accepte `None` comme valeur : + +```Python +say_hi(name=None) # Ceci fonctionne, None est valide 🎉 +``` + +La bonne nouvelle, c'est que, dans la plupart des cas, vous pourrez simplement utiliser `|` pour définir des unions de types : + +```python +def say_hi(name: str | None): + print(f"Hey {name}!") +``` + +Ainsi, normalement, vous n'avez pas à vous préoccuper de noms comme `Optional` et `Union`. 😎 diff --git a/docs/fr/docs/advanced/async-tests.md b/docs/fr/docs/advanced/async-tests.md new file mode 100644 index 0000000000..f9cea0ad17 --- /dev/null +++ b/docs/fr/docs/advanced/async-tests.md @@ -0,0 +1,99 @@ +# Tests asynchrones { #async-tests } + +Vous avez déjà vu comment tester vos applications **FastAPI** en utilisant le `TestClient` fourni. Jusqu'à présent, vous n'avez vu que comment écrire des tests synchrones, sans utiliser de fonctions `async`. + +Pouvoir utiliser des fonctions asynchrones dans vos tests peut être utile, par exemple lorsque vous interrogez votre base de données de manière asynchrone. Imaginez que vous vouliez tester l'envoi de requêtes à votre application FastAPI puis vérifier que votre backend a bien écrit les bonnes données dans la base, tout en utilisant une bibliothèque de base de données asynchrone. + +Voyons comment procéder. + +## pytest.mark.anyio { #pytest-mark-anyio } + +Si nous voulons appeler des fonctions asynchrones dans nos tests, nos fonctions de test doivent être asynchrones. AnyIO fournit un plug-in pratique qui nous permet d'indiquer que certaines fonctions de test doivent être appelées de manière asynchrone. + +## HTTPX { #httpx } + +Même si votre application **FastAPI** utilise des fonctions `def` normales au lieu de `async def`, c'est toujours une application `async` en interne. + +Le `TestClient` fait un peu de magie pour appeler l'application FastAPI asynchrone depuis vos fonctions de test `def` normales, en utilisant pytest standard. Mais cette magie ne fonctionne plus lorsque nous l'utilisons dans des fonctions asynchrones. En exécutant nos tests de manière asynchrone, nous ne pouvons plus utiliser le `TestClient` dans nos fonctions de test. + +Le `TestClient` est basé sur HTTPX et, heureusement, nous pouvons l'utiliser directement pour tester l'API. + +## Exemple { #example } + +Pour un exemple simple, considérons une structure de fichiers similaire à celle décrite dans [Applications plus grandes](../tutorial/bigger-applications.md){.internal-link target=_blank} et [Tests](../tutorial/testing.md){.internal-link target=_blank} : + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +│   └── test_main.py +``` + +Le fichier `main.py` contiendrait : + +{* ../../docs_src/async_tests/app_a_py310/main.py *} + +Le fichier `test_main.py` contiendrait les tests pour `main.py`, il pourrait maintenant ressembler à ceci : + +{* ../../docs_src/async_tests/app_a_py310/test_main.py *} + +## Exécuter { #run-it } + +Vous pouvez lancer vos tests comme d'habitude via : + +
+ +```console +$ pytest + +---> 100% +``` + +
+ +## En détail { #in-detail } + +Le marqueur `@pytest.mark.anyio` indique à pytest que cette fonction de test doit être appelée de manière asynchrone : + +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[7] *} + +/// tip | Astuce + +Notez que la fonction de test est maintenant `async def` au lieu de simplement `def` comme auparavant avec le `TestClient`. + +/// + +Nous pouvons ensuite créer un `AsyncClient` avec l'application et lui envoyer des requêtes asynchrones en utilisant `await`. + +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[9:12] *} + +C'est l'équivalent de : + +```Python +response = client.get('/') +``` + +... que nous utilisions pour faire nos requêtes avec le `TestClient`. + +/// tip | Astuce + +Notez que nous utilisons async/await avec le nouveau `AsyncClient` — la requête est asynchrone. + +/// + +/// warning | Alertes + +Si votre application s'appuie sur des événements de cycle de vie (lifespan), le `AsyncClient` ne déclenchera pas ces événements. Pour vous assurer qu'ils sont déclenchés, utilisez `LifespanManager` depuis florimondmanca/asgi-lifespan. + +/// + +## Autres appels de fonctions asynchrones { #other-asynchronous-function-calls } + +Comme la fonction de test est désormais asynchrone, vous pouvez également appeler (et `await`) d'autres fonctions `async` en plus d'envoyer des requêtes à votre application FastAPI dans vos tests, exactement comme vous le feriez ailleurs dans votre code. + +/// tip | Astuce + +Si vous rencontrez une erreur `RuntimeError: Task attached to a different loop` lors de l'intégration d'appels de fonctions asynchrones dans vos tests (par exemple en utilisant MotorClient de MongoDB), n'oubliez pas d'instancier les objets qui ont besoin d'une boucle d'événements uniquement dans des fonctions async, par exemple dans un callback `@app.on_event("startup")`. + +/// diff --git a/docs/fr/docs/advanced/behind-a-proxy.md b/docs/fr/docs/advanced/behind-a-proxy.md new file mode 100644 index 0000000000..4b540e1a1d --- /dev/null +++ b/docs/fr/docs/advanced/behind-a-proxy.md @@ -0,0 +1,466 @@ +# Être derrière un proxy { #behind-a-proxy } + +Dans de nombreuses situations, vous utiliserez un **proxy** comme Traefik ou Nginx devant votre application FastAPI. + +Ces proxies peuvent gérer les certificats HTTPS et d'autres aspects. + +## En-têtes transférés par le proxy { #proxy-forwarded-headers } + +Un **proxy** placé devant votre application définit normalement certains en-têtes à la volée avant d'envoyer les requêtes à votre **serveur**, afin d'indiquer au serveur que la requête a été **transférée** par le proxy, en lui donnant l'URL d'origine (publique), y compris le domaine, le fait qu'elle utilise HTTPS, etc. + +Le programme **serveur** (par exemple **Uvicorn** via **FastAPI CLI**) est capable d'interpréter ces en‑têtes, puis de transmettre ces informations à votre application. + +Mais, par sécurité, comme le serveur ne sait pas qu'il se trouve derrière un proxy de confiance, il n'interprétera pas ces en‑têtes. + +/// note | Détails techniques + +Les en-têtes du proxy sont : + +* X-Forwarded-For +* X-Forwarded-Proto +* X-Forwarded-Host + +/// + +### Activer les en-têtes transférés par le proxy { #enable-proxy-forwarded-headers } + +Vous pouvez démarrer FastAPI CLI avec l'option de CLI `--forwarded-allow-ips` et fournir les adresses IP à considérer comme fiables pour lire ces en‑têtes transférés. + +Si vous la définissez à `--forwarded-allow-ips="*"`, elle fera confiance à toutes les IP entrantes. + +Si votre **serveur** est derrière un **proxy** de confiance et que seul le proxy lui parle, cela fera accepter l'IP de ce **proxy**, quelle qu'elle soit. + +
+ +```console +$ fastapi run --forwarded-allow-ips="*" + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +### Redirections avec HTTPS { #redirects-with-https } + +Par exemple, disons que vous définissez un *chemin d'accès* `/items/` : + +{* ../../docs_src/behind_a_proxy/tutorial001_01_py310.py hl[6] *} + +Si le client essaie d'aller à `/items`, par défaut, il sera redirigé vers `/items/`. + +Mais avant de définir l'option de CLI `--forwarded-allow-ips`, il pourrait rediriger vers `http://localhost:8000/items/`. + +Mais peut‑être que votre application est hébergée à `https://mysuperapp.com`, et la redirection devrait être vers `https://mysuperapp.com/items/`. + +En définissant `--proxy-headers`, FastAPI pourra désormais rediriger vers l'emplacement correct. 😎 + +``` +https://mysuperapp.com/items/ +``` + +/// tip | Astuce + +Si vous voulez en savoir plus sur HTTPS, consultez le guide [À propos de HTTPS](../deployment/https.md){.internal-link target=_blank}. + +/// + +### Comment fonctionnent les en‑têtes transférés par le proxy { #how-proxy-forwarded-headers-work } + +Voici une représentation visuelle de la façon dont le **proxy** ajoute des en‑têtes transférés entre le client et le **serveur d'application** : + +```mermaid +sequenceDiagram + participant Client + participant Proxy as Proxy/Load Balancer + participant Server as FastAPI Server + + Client->>Proxy: HTTPS Request
Host: mysuperapp.com
Path: /items + + Note over Proxy: Proxy adds forwarded headers + + Proxy->>Server: HTTP Request
X-Forwarded-For: [client IP]
X-Forwarded-Proto: https
X-Forwarded-Host: mysuperapp.com
Path: /items + + Note over Server: Server interprets headers
(if --forwarded-allow-ips is set) + + Server->>Proxy: HTTP Response
with correct HTTPS URLs + + Proxy->>Client: HTTPS Response +``` + +Le **proxy** intercepte la requête client d'origine et ajoute les en-têtes spéciaux *forwarded* (`X-Forwarded-*`) avant de transmettre la requête au **serveur d'application**. + +Ces en‑têtes conservent des informations sur la requête d'origine qui seraient autrement perdues : + +* **X-Forwarded-For** : l'adresse IP du client d'origine +* **X-Forwarded-Proto** : le protocole d'origine (`https`) +* **X-Forwarded-Host** : l'hôte d'origine (`mysuperapp.com`) + +Lorsque **FastAPI CLI** est configurée avec `--forwarded-allow-ips`, elle fait confiance à ces en‑têtes et les utilise, par exemple pour générer les bonnes URL dans les redirections. + +## Proxy avec un préfixe de chemin supprimé { #proxy-with-a-stripped-path-prefix } + +Vous pouvez avoir un proxy qui ajoute un préfixe de chemin à votre application. + +Dans ces cas, vous pouvez utiliser `root_path` pour configurer votre application. + +Le `root_path` est un mécanisme fourni par la spécification ASGI (sur laquelle FastAPI est construit, via Starlette). + +Le `root_path` est utilisé pour gérer ces cas spécifiques. + +Et il est également utilisé en interne lors du montage de sous‑applications. + +Avoir un proxy avec un préfixe de chemin supprimé, dans ce cas, signifie que vous pourriez déclarer un chemin à `/app` dans votre code, mais ensuite, vous ajoutez une couche au‑dessus (le proxy) qui place votre application **FastAPI** sous un chemin comme `/api/v1`. + +Dans ce cas, le chemin original `/app` serait en réalité servi à `/api/v1/app`. + +Même si tout votre code est écrit en supposant qu'il n'y a que `/app`. + +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[6] *} + +Et le proxy **« stripping »** le **préfixe de chemin** à la volée avant de transmettre la requête au serveur de l'application (probablement Uvicorn via FastAPI CLI), en gardant votre application convaincue qu'elle est servie à `/app`, afin que vous n'ayez pas à mettre à jour tout votre code pour inclure le préfixe `/api/v1`. + +Jusqu'ici, tout fonctionnerait normalement. + +Mais ensuite, lorsque vous ouvrez l'interface de documentation intégrée (le frontend), elle s'attendra à obtenir le schéma OpenAPI à `/openapi.json`, au lieu de `/api/v1/openapi.json`. + +Ainsi, le frontend (qui s'exécute dans le navigateur) essaiera d'atteindre `/openapi.json` et ne pourra pas obtenir le schéma OpenAPI. + +Parce que nous avons un proxy avec un préfixe de chemin `/api/v1` pour notre application, le frontend doit récupérer le schéma OpenAPI à `/api/v1/openapi.json`. + +```mermaid +graph LR + +browser("Browser") +proxy["Proxy on http://0.0.0.0:9999/api/v1/app"] +server["Server on http://127.0.0.1:8000/app"] + +browser --> proxy +proxy --> server +``` + +/// tip | Astuce + +L'IP `0.0.0.0` est couramment utilisée pour signifier que le programme écoute sur toutes les IP disponibles de cette machine/serveur. + +/// + +L'interface de documents doit également indiquer dans le schéma OpenAPI que ce `server` d'API se trouve à `/api/v1` (derrière le proxy). Par exemple : + +```JSON hl_lines="4-8" +{ + "openapi": "3.1.0", + // Plus d'éléments ici + "servers": [ + { + "url": "/api/v1" + } + ], + "paths": { + // Plus d'éléments ici + } +} +``` + +Dans cet exemple, le « Proxy » pourrait être quelque chose comme **Traefik**. Et le serveur serait quelque chose comme FastAPI CLI avec **Uvicorn**, exécutant votre application FastAPI. + +### Fournir le `root_path` { #providing-the-root-path } + +Pour y parvenir, vous pouvez utiliser l'option de ligne de commande `--root-path` comme suit : + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Si vous utilisez Hypercorn, il dispose également de l'option `--root-path`. + +/// note | Détails techniques + +La spécification ASGI définit un `root_path` pour ce cas d'usage. + +Et l'option de ligne de commande `--root-path` fournit ce `root_path`. + +/// + +### Vérifier le `root_path` actuel { #checking-the-current-root-path } + +Vous pouvez obtenir le `root_path` actuel utilisé par votre application pour chaque requête, il fait partie du dictionnaire `scope` (qui fait partie de la spécification ASGI). + +Ici, nous l'incluons dans le message uniquement à des fins de démonstration. + +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[8] *} + +Ensuite, si vous démarrez Uvicorn avec : + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +La réponse sera semblable à : + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +### Définir le `root_path` dans l'application FastAPI { #setting-the-root-path-in-the-fastapi-app } + +Autrement, si vous n'avez pas la possibilité de fournir une option de ligne de commande comme `--root-path` ou équivalent, vous pouvez définir le paramètre `root_path` lors de la création de votre application FastAPI : + +{* ../../docs_src/behind_a_proxy/tutorial002_py310.py hl[3] *} + +Passer le `root_path` à `FastAPI` équivaut à passer l'option de ligne de commande `--root-path` à Uvicorn ou Hypercorn. + +### À propos de `root_path` { #about-root-path } + +Gardez à l'esprit que le serveur (Uvicorn) n'utilisera ce `root_path` que pour le transmettre à l'application. + +Mais si vous allez avec votre navigateur sur http://127.0.0.1:8000/app, vous verrez la réponse normale : + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +Donc, il ne s'attendra pas à être accessible à `http://127.0.0.1:8000/api/v1/app`. + +Uvicorn s'attendra à ce que le proxy accède à Uvicorn sur `http://127.0.0.1:8000/app`, et ce sera ensuite la responsabilité du proxy d'ajouter le préfixe supplémentaire `/api/v1` au‑dessus. + +## À propos des proxies avec un préfixe de chemin supprimé { #about-proxies-with-a-stripped-path-prefix } + +Gardez à l'esprit qu'un proxy avec préfixe de chemin supprimé n'est qu'une des façons de le configurer. + +Dans de nombreux cas, la valeur par défaut sera probablement que le proxy n'a pas de préfixe de chemin supprimé. + +Dans un cas comme celui‑ci (sans préfixe de chemin supprimé), le proxy écoutera sur quelque chose comme `https://myawesomeapp.com`, puis si le navigateur va sur `https://myawesomeapp.com/api/v1/app` et que votre serveur (par ex. Uvicorn) écoute sur `http://127.0.0.1:8000`, le proxy (sans préfixe de chemin supprimé) accédera à Uvicorn au même chemin : `http://127.0.0.1:8000/api/v1/app`. + +## Tester localement avec Traefik { #testing-locally-with-traefik } + +Vous pouvez facilement faire l'expérience en local avec un préfixe de chemin supprimé en utilisant Traefik. + +Téléchargez Traefik ; c'est un binaire unique, vous pouvez extraire le fichier compressé et l'exécuter directement depuis le terminal. + +Créez ensuite un fichier `traefik.toml` avec : + +```TOML hl_lines="3" +[entryPoints] + [entryPoints.http] + address = ":9999" + +[providers] + [providers.file] + filename = "routes.toml" +``` + +Cela indique à Traefik d'écouter sur le port 9999 et d'utiliser un autre fichier `routes.toml`. + +/// tip | Astuce + +Nous utilisons le port 9999 au lieu du port HTTP standard 80 afin que vous n'ayez pas à l'exécuter avec des privilèges administrateur (`sudo`). + +/// + +Créez maintenant cet autre fichier `routes.toml` : + +```TOML hl_lines="5 12 20" +[http] + [http.middlewares] + + [http.middlewares.api-stripprefix.stripPrefix] + prefixes = ["/api/v1"] + + [http.routers] + + [http.routers.app-http] + entryPoints = ["http"] + service = "app" + rule = "PathPrefix(`/api/v1`)" + middlewares = ["api-stripprefix"] + + [http.services] + + [http.services.app] + [http.services.app.loadBalancer] + [[http.services.app.loadBalancer.servers]] + url = "http://127.0.0.1:8000" +``` + +Ce fichier configure Traefik pour utiliser le préfixe de chemin `/api/v1`. + +Puis Traefik redirigera ses requêtes vers votre Uvicorn tournant sur `http://127.0.0.1:8000`. + +Démarrez maintenant Traefik : + +
+ +```console +$ ./traefik --configFile=traefik.toml + +INFO[0000] Configuration loaded from file: /home/user/awesomeapi/traefik.toml +``` + +
+ +Et démarrez maintenant votre application, en utilisant l'option `--root-path` : + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +### Vérifier les réponses { #check-the-responses } + +Maintenant, si vous allez à l'URL avec le port pour Uvicorn : http://127.0.0.1:8000/app, vous verrez la réponse normale : + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +/// tip | Astuce + +Remarquez que même si vous y accédez via `http://127.0.0.1:8000/app`, il affiche le `root_path` de `/api/v1`, repris depuis l'option `--root-path`. + +/// + +Et maintenant ouvrez l'URL avec le port pour Traefik, en incluant le préfixe de chemin : http://127.0.0.1:9999/api/v1/app. + +Nous obtenons la même réponse : + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +mais cette fois à l'URL avec le préfixe fourni par le proxy : `/api/v1`. + +Bien sûr, l'idée ici est que tout le monde accède à l'application via le proxy ; la version avec le préfixe de chemin `/api/v1` est donc la « correcte ». + +Et la version sans préfixe de chemin (`http://127.0.0.1:8000/app`), fournie directement par Uvicorn, serait exclusivement destinée au _proxy_ (Traefik) pour y accéder. + +Cela montre comment le Proxy (Traefik) utilise le préfixe de chemin et comment le serveur (Uvicorn) utilise le `root_path` fourni par l'option `--root-path`. + +### Vérifier l'interface de documentation { #check-the-docs-ui } + +Mais voici la partie intéressante. ✨ + +La manière « officielle » d'accéder à l'application serait via le proxy avec le préfixe de chemin que nous avons défini. Donc, comme on s'y attend, si vous essayez l'interface de documentation servie directement par Uvicorn, sans le préfixe de chemin dans l'URL, cela ne fonctionne pas, car elle s'attend à être accédée via le proxy. + +Vous pouvez le vérifier sur http://127.0.0.1:8000/docs : + + + +Mais si nous accédons à l'interface de documents à l'URL « officielle » en utilisant le proxy avec le port `9999`, à `/api/v1/docs`, cela fonctionne correctement ! 🎉 + +Vous pouvez le vérifier sur http://127.0.0.1:9999/api/v1/docs : + + + +Exactement comme nous le voulions. ✔️ + +C'est parce que FastAPI utilise ce `root_path` pour créer le `server` par défaut dans OpenAPI avec l'URL fournie par `root_path`. + +## Serveurs supplémentaires { #additional-servers } + +/// warning | Alertes + +Ceci est un cas d'utilisation plus avancé. N'hésitez pas à l'ignorer. + +/// + +Par défaut, **FastAPI** créera un `server` dans le schéma OpenAPI avec l'URL correspondant au `root_path`. + +Mais vous pouvez aussi fournir d'autres `servers` alternatifs, par exemple si vous voulez que la même interface de documents interagisse avec un environnement de staging et un environnement de production. + +Si vous passez une liste personnalisée de `servers` et qu'il y a un `root_path` (parce que votre API vit derrière un proxy), **FastAPI** insérera un « server » avec ce `root_path` au début de la liste. + +Par exemple : + +{* ../../docs_src/behind_a_proxy/tutorial003_py310.py hl[4:7] *} + +Générera un schéma OpenAPI comme : + +```JSON hl_lines="5-7" +{ + "openapi": "3.1.0", + // Plus d'éléments ici + "servers": [ + { + "url": "/api/v1" + }, + { + "url": "https://stag.example.com", + "description": "Staging environment" + }, + { + "url": "https://prod.example.com", + "description": "Production environment" + } + ], + "paths": { + // Plus d'éléments ici + } +} +``` + +/// tip | Astuce + +Remarquez le serveur généré automatiquement avec une valeur `url` de `/api/v1`, reprise depuis le `root_path`. + +/// + +Dans l'interface de documents sur http://127.0.0.1:9999/api/v1/docs, cela ressemblera à ceci : + + + +/// tip | Astuce + +L'interface de documents interagit avec le serveur que vous sélectionnez. + +/// + +/// note | Détails techniques + +La propriété `servers` dans la spécification OpenAPI est facultative. + +Si vous ne spécifiez pas le paramètre `servers` et que `root_path` est égal à `/`, la propriété `servers` dans le schéma OpenAPI généré sera entièrement omise par défaut, ce qui équivaut à un seul serveur avec une valeur `url` de `/`. + +/// + +### Désactiver le serveur automatique issu de `root_path` { #disable-automatic-server-from-root-path } + +Si vous ne voulez pas que **FastAPI** inclue un serveur automatique utilisant le `root_path`, vous pouvez utiliser le paramètre `root_path_in_servers=False` : + +{* ../../docs_src/behind_a_proxy/tutorial004_py310.py hl[9] *} + +et il ne l'inclura alors pas dans le schéma OpenAPI. + +## Monter une sous-application { #mounting-a-sub-application } + +Si vous avez besoin de monter une sous‑application (comme décrit dans [Sous‑applications - montages](sub-applications.md){.internal-link target=_blank}) tout en utilisant un proxy avec `root_path`, vous pouvez le faire normalement, comme vous vous y attendez. + +FastAPI utilisera intelligemment le `root_path` en interne, donc cela fonctionnera simplement. ✨ diff --git a/docs/fr/docs/advanced/custom-response.md b/docs/fr/docs/advanced/custom-response.md new file mode 100644 index 0000000000..7eab5b53fc --- /dev/null +++ b/docs/fr/docs/advanced/custom-response.md @@ -0,0 +1,312 @@ +# Réponse personnalisée - HTML, flux, fichier, autres { #custom-response-html-stream-file-others } + +Par défaut, **FastAPI** renverra les réponses en utilisant `JSONResponse`. + +Vous pouvez le remplacer en renvoyant directement une `Response` comme expliqué dans [Renvoyer directement une Response](response-directly.md){.internal-link target=_blank}. + +Mais si vous renvoyez directement une `Response` (ou n'importe quelle sous-classe, comme `JSONResponse`), les données ne seront pas automatiquement converties (même si vous déclarez un `response_model`), et la documentation ne sera pas générée automatiquement (par exemple, l'inclusion du « media type » dans l'en-tête HTTP `Content-Type` comme partie de l'OpenAPI généré). + +Vous pouvez aussi déclarer la `Response` que vous voulez utiliser (par ex. toute sous-classe de `Response`), dans le décorateur de chemin d'accès en utilisant le paramètre `response_class`. + +Le contenu que vous renvoyez depuis votre fonction de chemin d'accès sera placé à l'intérieur de cette `Response`. + +Et si cette `Response` a un « media type » JSON (`application/json`), comme c'est le cas avec `JSONResponse` et `UJSONResponse`, les données que vous renvoyez seront automatiquement converties (et filtrées) avec tout `response_model` Pydantic que vous avez déclaré dans le décorateur de chemin d'accès. + +/// note | Remarque + +Si vous utilisez une classe de réponse sans « media type », FastAPI s'attendra à ce que votre réponse n'ait pas de contenu ; il ne documentera donc pas le format de la réponse dans les documents OpenAPI générés. + +/// + +## Utiliser `ORJSONResponse` { #use-orjsonresponse } + +Par exemple, si vous cherchez à maximiser la performance, vous pouvez installer et utiliser `orjson` et définir la réponse sur `ORJSONResponse`. + +Importez la classe (sous-classe) `Response` que vous voulez utiliser et déclarez-la dans le décorateur de chemin d'accès. + +Pour de grandes réponses, renvoyer directement une `Response` est bien plus rapide que de renvoyer un dictionnaire. + +Cela vient du fait que, par défaut, FastAPI inspectera chaque élément et s'assurera qu'il est sérialisable en JSON, en utilisant le même [Encodeur compatible JSON](../tutorial/encoder.md){.internal-link target=_blank} expliqué dans le didacticiel. C'est ce qui vous permet de renvoyer des objets arbitraires, par exemple des modèles de base de données. + +Mais si vous êtes certain que le contenu que vous renvoyez est sérialisable en JSON, vous pouvez le passer directement à la classe de réponse et éviter le surcoût supplémentaire qu'aurait FastAPI en faisant passer votre contenu de retour par le `jsonable_encoder` avant de le transmettre à la classe de réponse. + +{* ../../docs_src/custom_response/tutorial001b_py310.py hl[2,7] *} + +/// info + +Le paramètre `response_class` sera aussi utilisé pour définir le « media type » de la réponse. + +Dans ce cas, l'en-tête HTTP `Content-Type` sera défini à `application/json`. + +Et il sera documenté comme tel dans OpenAPI. + +/// + +/// tip | Astuce + +`ORJSONResponse` est disponible uniquement dans FastAPI, pas dans Starlette. + +/// + +## Réponse HTML { #html-response } + +Pour renvoyer une réponse avec du HTML directement depuis **FastAPI**, utilisez `HTMLResponse`. + +- Importez `HTMLResponse`. +- Passez `HTMLResponse` comme paramètre `response_class` de votre décorateur de chemin d'accès. + +{* ../../docs_src/custom_response/tutorial002_py310.py hl[2,7] *} + +/// info + +Le paramètre `response_class` sera aussi utilisé pour définir le « media type » de la réponse. + +Dans ce cas, l'en-tête HTTP `Content-Type` sera défini à `text/html`. + +Et il sera documenté comme tel dans OpenAPI. + +/// + +### Renvoyer une `Response` { #return-a-response } + +Comme vu dans [Renvoyer directement une Response](response-directly.md){.internal-link target=_blank}, vous pouvez aussi remplacer la réponse directement dans votre chemin d'accès, en la renvoyant. + +Le même exemple ci-dessus, renvoyant une `HTMLResponse`, pourrait ressembler à : + +{* ../../docs_src/custom_response/tutorial003_py310.py hl[2,7,19] *} + +/// warning | Alertes + +Une `Response` renvoyée directement par votre fonction de chemin d'accès ne sera pas documentée dans OpenAPI (par exemple, le `Content-Type` ne sera pas documenté) et ne sera pas visible dans les documents interactifs automatiques. + +/// + +/// info + +Bien sûr, l'en-tête `Content-Type` réel, le code d'état, etc., proviendront de l'objet `Response` que vous avez renvoyé. + +/// + +### Documenter dans OpenAPI et remplacer `Response` { #document-in-openapi-and-override-response } + +Si vous voulez remplacer la réponse depuis l'intérieur de la fonction mais en même temps documenter le « media type » dans OpenAPI, vous pouvez utiliser le paramètre `response_class` ET renvoyer un objet `Response`. + +`response_class` sera alors utilisé uniquement pour documenter l'opération de chemin d'accès OpenAPI, mais votre `Response` sera utilisée telle quelle. + +#### Renvoyer directement une `HTMLResponse` { #return-an-htmlresponse-directly } + +Par exemple, cela pourrait être quelque chose comme : + +{* ../../docs_src/custom_response/tutorial004_py310.py hl[7,21,23] *} + +Dans cet exemple, la fonction `generate_html_response()` génère déjà et renvoie une `Response` au lieu de renvoyer le HTML dans une `str`. + +En renvoyant le résultat de l'appel à `generate_html_response()`, vous renvoyez déjà une `Response` qui remplacera le comportement par défaut de **FastAPI**. + +Mais comme vous avez aussi passé `HTMLResponse` dans `response_class`, **FastAPI** saura comment la documenter dans OpenAPI et les documents interactifs comme HTML avec `text/html` : + + + +## Réponses disponibles { #available-responses } + +Voici certaines des réponses disponibles. + +Gardez à l'esprit que vous pouvez utiliser `Response` pour renvoyer autre chose, ou même créer une sous-classe personnalisée. + +/// note | Détails techniques + +Vous pourriez aussi utiliser `from starlette.responses import HTMLResponse`. + +**FastAPI** fournit les mêmes `starlette.responses` sous `fastapi.responses` simplement pour votre confort de développement. Mais la plupart des réponses disponibles viennent directement de Starlette. + +/// + +### `Response` { #response } + +La classe principale `Response`, toutes les autres réponses en héritent. + +Vous pouvez la renvoyer directement. + +Elle accepte les paramètres suivants : + +- `content` - Une `str` ou des `bytes`. +- `status_code` - Un code d'état HTTP de type `int`. +- `headers` - Un `dict` de chaînes. +- `media_type` - Une `str` donnant le media type. Par exemple « text/html ». + +FastAPI (en fait Starlette) inclura automatiquement un en-tête Content-Length. Il inclura aussi un en-tête Content-Type, basé sur `media_type` et en ajoutant un charset pour les types textuels. + +{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *} + +### `HTMLResponse` { #htmlresponse } + +Prend du texte ou des octets et renvoie une réponse HTML, comme vous l'avez lu ci-dessus. + +### `PlainTextResponse` { #plaintextresponse } + +Prend du texte ou des octets et renvoie une réponse en texte brut. + +{* ../../docs_src/custom_response/tutorial005_py310.py hl[2,7,9] *} + +### `JSONResponse` { #jsonresponse } + +Prend des données et renvoie une réponse encodée en `application/json`. + +C'est la réponse par défaut utilisée dans **FastAPI**, comme vous l'avez lu ci-dessus. + +### `ORJSONResponse` { #orjsonresponse } + +Une réponse JSON alternative rapide utilisant `orjson`, comme vous l'avez lu ci-dessus. + +/// info + +Cela nécessite l'installation de `orjson`, par exemple avec `pip install orjson`. + +/// + +### `UJSONResponse` { #ujsonresponse } + +Une réponse JSON alternative utilisant `ujson`. + +/// info + +Cela nécessite l'installation de `ujson`, par exemple avec `pip install ujson`. + +/// + +/// warning | Alertes + +`ujson` est moins rigoureux que l'implémentation intégrée de Python dans sa gestion de certains cas limites. + +/// + +{* ../../docs_src/custom_response/tutorial001_py310.py hl[2,7] *} + +/// tip | Astuce + +Il est possible que `ORJSONResponse` soit une alternative plus rapide. + +/// + +### `RedirectResponse` { #redirectresponse } + +Renvoie une redirection HTTP. Utilise par défaut un code d'état 307 (Temporary Redirect). + +Vous pouvez renvoyer directement une `RedirectResponse` : + +{* ../../docs_src/custom_response/tutorial006_py310.py hl[2,9] *} + +--- + +Ou vous pouvez l'utiliser dans le paramètre `response_class` : + +{* ../../docs_src/custom_response/tutorial006b_py310.py hl[2,7,9] *} + +Si vous faites cela, vous pouvez alors renvoyer directement l'URL depuis votre fonction de chemin d'accès. + +Dans ce cas, le `status_code` utilisé sera celui par défaut pour `RedirectResponse`, c'est-à-dire `307`. + +--- + +Vous pouvez aussi utiliser le paramètre `status_code` combiné avec le paramètre `response_class` : + +{* ../../docs_src/custom_response/tutorial006c_py310.py hl[2,7,9] *} + +### `StreamingResponse` { #streamingresponse } + +Prend un générateur async ou un générateur/itérateur normal et diffuse le corps de la réponse. + +{* ../../docs_src/custom_response/tutorial007_py310.py hl[2,14] *} + +#### Utiliser `StreamingResponse` avec des objets de type fichier { #using-streamingresponse-with-file-like-objects } + +Si vous avez un objet de type fichier (par ex. l'objet renvoyé par `open()`), vous pouvez créer une fonction génératrice pour itérer sur cet objet de type fichier. + +De cette façon, vous n'avez pas à tout lire en mémoire au préalable, et vous pouvez passer cette fonction génératrice à `StreamingResponse`, puis la renvoyer. + +Cela inclut de nombreuses bibliothèques pour interagir avec du stockage cloud, du traitement vidéo, et autres. + +{* ../../docs_src/custom_response/tutorial008_py310.py hl[2,10:12,14] *} + +1. C'est la fonction génératrice. C'est une « fonction génératrice » parce qu'elle contient des instructions `yield` à l'intérieur. +2. En utilisant un bloc `with`, nous nous assurons que l'objet de type fichier est fermé après l'exécution de la fonction génératrice. Donc, après qu'elle a fini d'envoyer la réponse. +3. Ce `yield from` indique à la fonction d'itérer sur l'objet nommé `file_like`. Puis, pour chaque partie itérée, de produire cette partie comme provenant de cette fonction génératrice (`iterfile`). + + Ainsi, c'est une fonction génératrice qui transfère le travail de « génération » à autre chose en interne. + + En procédant ainsi, nous pouvons la placer dans un bloc `with` et, de cette façon, garantir que l'objet de type fichier est fermé après la fin. + +/// tip | Astuce + +Remarquez qu'ici, comme nous utilisons le `open()` standard qui ne prend pas en charge `async` et `await`, nous déclarons le chemin d'accès avec un `def` normal. + +/// + +### `FileResponse` { #fileresponse } + +Diffuse de façon asynchrone un fichier comme réponse. + +Prend un ensemble de paramètres différent à l'instanciation par rapport aux autres types de réponse : + +- `path` - Le chemin du fichier à diffuser. +- `headers` - D'éventuels en-têtes personnalisés à inclure, sous forme de dictionnaire. +- `media_type` - Une chaîne donnant le media type. Si non défini, le nom du fichier ou le chemin sera utilisé pour en déduire un media type. +- `filename` - Si défini, sera inclus dans l'en-tête `Content-Disposition` de la réponse. + +Les réponses de type fichier incluront les en-têtes appropriés `Content-Length`, `Last-Modified` et `ETag`. + +{* ../../docs_src/custom_response/tutorial009_py310.py hl[2,10] *} + +Vous pouvez aussi utiliser le paramètre `response_class` : + +{* ../../docs_src/custom_response/tutorial009b_py310.py hl[2,8,10] *} + +Dans ce cas, vous pouvez renvoyer directement le chemin du fichier depuis votre fonction de chemin d'accès. + +## Classe de réponse personnalisée { #custom-response-class } + +Vous pouvez créer votre propre classe de réponse personnalisée, héritant de `Response`, et l'utiliser. + +Par exemple, disons que vous voulez utiliser `orjson`, mais avec certains réglages personnalisés non utilisés dans la classe `ORJSONResponse` incluse. + +Disons que vous voulez renvoyer du JSON indenté et formaté, donc vous voulez utiliser l'option orjson `orjson.OPT_INDENT_2`. + +Vous pourriez créer une `CustomORJSONResponse`. L'essentiel est de créer une méthode `Response.render(content)` qui renvoie le contenu en `bytes` : + +{* ../../docs_src/custom_response/tutorial009c_py310.py hl[9:14,17] *} + +Maintenant, au lieu de renvoyer : + +```json +{"message": "Hello World"} +``` + +... cette réponse renverra : + +```json +{ + "message": "Hello World" +} +``` + +Bien sûr, vous trouverez probablement des moyens bien meilleurs de tirer parti de cela que de formater du JSON. 😉 + +## Classe de réponse par défaut { #default-response-class } + +Lors de la création d'une instance de classe **FastAPI** ou d'un `APIRouter`, vous pouvez spécifier quelle classe de réponse utiliser par défaut. + +Le paramètre qui le définit est `default_response_class`. + +Dans l'exemple ci-dessous, **FastAPI** utilisera `ORJSONResponse` par défaut, dans tous les chemins d'accès, au lieu de `JSONResponse`. + +{* ../../docs_src/custom_response/tutorial010_py310.py hl[2,4] *} + +/// tip | Astuce + +Vous pouvez toujours remplacer `response_class` dans les chemins d'accès comme auparavant. + +/// + +## Documentation supplémentaire { #additional-documentation } + +Vous pouvez aussi déclarer le media type et de nombreux autres détails dans OpenAPI en utilisant `responses` : [Réponses supplémentaires dans OpenAPI](additional-responses.md){.internal-link target=_blank}. diff --git a/docs/fr/docs/advanced/dataclasses.md b/docs/fr/docs/advanced/dataclasses.md new file mode 100644 index 0000000000..2bd77157e8 --- /dev/null +++ b/docs/fr/docs/advanced/dataclasses.md @@ -0,0 +1,95 @@ +# Utiliser des dataclasses { #using-dataclasses } + +FastAPI est construit au‑dessus de **Pydantic**, et je vous ai montré comment utiliser des modèles Pydantic pour déclarer les requêtes et les réponses. + +Mais FastAPI prend aussi en charge l'utilisation de `dataclasses` de la même manière : + +{* ../../docs_src/dataclasses_/tutorial001_py310.py hl[1,6:11,18:19] *} + +Cela fonctionne grâce à **Pydantic**, qui offre une prise en charge interne des `dataclasses`. + +Ainsi, même avec le code ci‑dessus qui n'emploie pas explicitement Pydantic, FastAPI utilise Pydantic pour convertir ces dataclasses standard en la variante de dataclasses de Pydantic. + +Et bien sûr, cela prend en charge la même chose : + +* validation des données +* sérialisation des données +* documentation des données, etc. + +Cela fonctionne de la même manière qu'avec les modèles Pydantic. Et, en réalité, c'est mis en œuvre de la même façon en interne, en utilisant Pydantic. + +/// info | Info + +Gardez à l'esprit que les dataclasses ne peuvent pas tout ce que peuvent faire les modèles Pydantic. + +Vous pourriez donc avoir encore besoin d'utiliser des modèles Pydantic. + +Mais si vous avez déjà un ensemble de dataclasses sous la main, c'est une astuce pratique pour les utiliser afin d'alimenter une API Web avec FastAPI. 🤓 + +/// + +## Utiliser des dataclasses dans `response_model` { #dataclasses-in-response-model } + +Vous pouvez aussi utiliser `dataclasses` dans le paramètre `response_model` : + +{* ../../docs_src/dataclasses_/tutorial002_py310.py hl[1,6:12,18] *} + +La dataclass sera automatiquement convertie en dataclass Pydantic. + +Ainsi, son schéma apparaîtra dans l'interface utilisateur de la documentation de l'API : + + + +## Utiliser des dataclasses dans des structures de données imbriquées { #dataclasses-in-nested-data-structures } + +Vous pouvez aussi combiner `dataclasses` avec d'autres annotations de type pour créer des structures de données imbriquées. + +Dans certains cas, vous devrez peut‑être encore utiliser la version `dataclasses` de Pydantic. Par exemple, si vous rencontrez des erreurs avec la documentation d'API générée automatiquement. + +Dans ce cas, vous pouvez simplement remplacer les `dataclasses` standard par `pydantic.dataclasses`, qui est un remplacement drop‑in : + +{* ../../docs_src/dataclasses_/tutorial003_py310.py hl[1,4,7:10,13:16,22:24,27] *} + +1. Nous continuons à importer `field` depuis les `dataclasses` standard. + +2. `pydantic.dataclasses` est un remplacement drop‑in pour `dataclasses`. + +3. La dataclass `Author` inclut une liste de dataclasses `Item`. + +4. La dataclass `Author` est utilisée comme paramètre `response_model`. + +5. Vous pouvez utiliser d'autres annotations de type standard avec des dataclasses comme corps de la requête. + + Dans ce cas, il s'agit d'une liste de dataclasses `Item`. + +6. Ici, nous renvoyons un dictionnaire qui contient `items`, qui est une liste de dataclasses. + + FastAPI est toujours capable de sérialiser les données en JSON. + +7. Ici, `response_model` utilise une annotation de type correspondant à une liste de dataclasses `Author`. + + Là encore, vous pouvez combiner `dataclasses` avec des annotations de type standard. + +8. Notez que cette *fonction de chemin d'accès* utilise un `def` classique au lieu de `async def`. + + Comme toujours, avec FastAPI vous pouvez combiner `def` et `async def` selon vos besoins. + + Si vous avez besoin d'un rappel sur quand utiliser l'un ou l'autre, consultez la section _« In a hurry? »_ dans la documentation à propos de [`async` et `await`](../async.md#in-a-hurry){.internal-link target=_blank}. + +9. Cette *fonction de chemin d'accès* ne renvoie pas des dataclasses (même si elle le pourrait), mais une liste de dictionnaires contenant des données internes. + + FastAPI utilisera le paramètre `response_model` (qui inclut des dataclasses) pour convertir la réponse. + +Vous pouvez combiner `dataclasses` avec d'autres annotations de type, selon de nombreuses combinaisons, pour former des structures de données complexes. + +Reportez‑vous aux annotations dans le code ci‑dessus pour voir plus de détails spécifiques. + +## En savoir plus { #learn-more } + +Vous pouvez aussi combiner `dataclasses` avec d'autres modèles Pydantic, en hériter, les inclure dans vos propres modèles, etc. + +Pour en savoir plus, consultez la documentation Pydantic sur les dataclasses. + +## Version { #version } + +C'est disponible depuis FastAPI version `0.67.0`. 🔖 diff --git a/docs/fr/docs/advanced/events.md b/docs/fr/docs/advanced/events.md new file mode 100644 index 0000000000..6d0907a8bc --- /dev/null +++ b/docs/fr/docs/advanced/events.md @@ -0,0 +1,165 @@ +# Événements de cycle de vie { #lifespan-events } + +Vous pouvez définir une logique (du code) qui doit être exécutée avant que l'application ne **démarre**. Cela signifie que ce code sera exécuté **une seule fois**, **avant** que l'application ne **commence à recevoir des requêtes**. + +De la même manière, vous pouvez définir une logique (du code) qui doit être exécutée lorsque l'application **s'arrête**. Dans ce cas, ce code sera exécuté **une seule fois**, **après** avoir traité potentiellement **de nombreuses requêtes**. + +Comme ce code est exécuté avant que l'application ne **commence** à recevoir des requêtes, et juste après qu'elle **termine** de les traiter, il couvre tout le **cycle de vie** de l'application (le mot « lifespan » va être important dans un instant 😉). + +Cela peut être très utile pour configurer des **ressources** dont vous avez besoin pour l'ensemble de l'application, qui sont **partagées** entre les requêtes, et/ou que vous devez **nettoyer** ensuite. Par exemple, un pool de connexions à une base de données, ou le chargement d'un modèle d'apprentissage automatique partagé. + +## Cas d'utilisation { #use-case } + +Commençons par un exemple de **cas d'utilisation**, puis voyons comment le résoudre avec ceci. + +Imaginons que vous ayez des **modèles d'apprentissage automatique** que vous souhaitez utiliser pour traiter des requêtes. 🤖 + +Les mêmes modèles sont partagés entre les requêtes, ce n'est donc pas un modèle par requête, ni un par utilisateur, ou quelque chose de similaire. + +Imaginons que le chargement du modèle puisse **prendre pas mal de temps**, car il doit lire beaucoup de **données depuis le disque**. Vous ne voulez donc pas le faire pour chaque requête. + +Vous pourriez le charger au niveau supérieur du module/fichier, mais cela signifierait aussi qu'il **chargerait le modèle** même si vous exécutez simplement un test automatisé simple ; ce test serait alors **lent** car il devrait attendre le chargement du modèle avant de pouvoir exécuter une partie indépendante du code. + +C'est ce que nous allons résoudre : chargeons le modèle avant que les requêtes ne soient traitées, mais seulement juste avant que l'application ne commence à recevoir des requêtes, pas pendant le chargement du code. + +## Cycle de vie { #lifespan } + +Vous pouvez définir cette logique de *démarrage* et d'*arrêt* en utilisant le paramètre `lifespan` de l'application `FastAPI`, et un « gestionnaire de contexte » (je vais vous montrer ce que c'est dans un instant). + +Commençons par un exemple, puis voyons-le en détail. + +Nous créons une fonction async `lifespan()` avec `yield` comme ceci : + +{* ../../docs_src/events/tutorial003_py310.py hl[16,19] *} + +Ici, nous simulons l'opération de *démarrage* coûteuse de chargement du modèle en plaçant la fonction (factice) du modèle dans le dictionnaire avec les modèles d'apprentissage automatique avant le `yield`. Ce code sera exécuté **avant** que l'application ne **commence à recevoir des requêtes**, pendant le *démarrage*. + +Puis, juste après le `yield`, nous déchargeons le modèle. Ce code sera exécuté **après** que l'application **a fini de traiter les requêtes**, juste avant l'*arrêt*. Cela pourrait, par exemple, libérer des ressources comme la mémoire ou un GPU. + +/// tip | Astuce + +L’« arrêt » se produit lorsque vous **arrêtez** l'application. + +Peut-être devez-vous démarrer une nouvelle version, ou vous en avez simplement assez de l'exécuter. 🤷 + +/// + +### Fonction de cycle de vie { #lifespan-function } + +La première chose à remarquer est que nous définissons une fonction async avec `yield`. C'est très similaire aux Dépendances avec `yield`. + +{* ../../docs_src/events/tutorial003_py310.py hl[14:19] *} + +La première partie de la fonction, avant le `yield`, sera exécutée **avant** le démarrage de l'application. + +Et la partie après le `yield` sera exécutée **après** que l'application a terminé. + +### Gestionnaire de contexte asynchrone { #async-context-manager } + +Si vous regardez, la fonction est décorée avec `@asynccontextmanager`. + +Cela convertit la fonction en quelque chose appelé un « **gestionnaire de contexte asynchrone** ». + +{* ../../docs_src/events/tutorial003_py310.py hl[1,13] *} + +Un **gestionnaire de contexte** en Python est quelque chose que vous pouvez utiliser dans une instruction `with`. Par exemple, `open()` peut être utilisé comme gestionnaire de contexte : + +```Python +with open("file.txt") as file: + file.read() +``` + +Dans les versions récentes de Python, il existe aussi un **gestionnaire de contexte asynchrone**. Vous l'utiliseriez avec `async with` : + +```Python +async with lifespan(app): + await do_stuff() +``` + +Quand vous créez un gestionnaire de contexte ou un gestionnaire de contexte asynchrone comme ci-dessus, ce qu'il fait, c'est qu'avant d'entrer dans le bloc `with`, il exécute le code avant le `yield`, et après être sorti du bloc `with`, il exécute le code après le `yield`. + +Dans notre exemple de code ci-dessus, nous ne l'utilisons pas directement, mais nous le transmettons à FastAPI pour qu'il l'utilise. + +Le paramètre `lifespan` de l'application `FastAPI` accepte un **gestionnaire de contexte asynchrone**, nous pouvons donc lui passer notre nouveau gestionnaire de contexte asynchrone `lifespan`. + +{* ../../docs_src/events/tutorial003_py310.py hl[22] *} + +## Événements alternatifs (déprécié) { #alternative-events-deprecated } + +/// warning | Alertes + +La méthode recommandée pour gérer le *démarrage* et l'*arrêt* est d'utiliser le paramètre `lifespan` de l'application `FastAPI` comme décrit ci-dessus. Si vous fournissez un paramètre `lifespan`, les gestionnaires d'événements `startup` et `shutdown` ne seront plus appelés. C'est soit tout en `lifespan`, soit tout en événements, pas les deux. + +Vous pouvez probablement passer cette partie. + +/// + +Il existe une autre manière de définir cette logique à exécuter au *démarrage* et à l'*arrêt*. + +Vous pouvez définir des gestionnaires d'événements (fonctions) qui doivent être exécutés avant le démarrage de l'application, ou lorsque l'application s'arrête. + +Ces fonctions peuvent être déclarées avec `async def` ou un `def` normal. + +### Événement `startup` { #startup-event } + +Pour ajouter une fonction qui doit être exécutée avant le démarrage de l'application, déclarez-la avec l'événement « startup » : + +{* ../../docs_src/events/tutorial001_py310.py hl[8] *} + +Dans ce cas, la fonction gestionnaire de l'événement `startup` initialisera la « base de données » des items (juste un `dict`) avec quelques valeurs. + +Vous pouvez ajouter plusieurs fonctions de gestion d'événements. + +Et votre application ne commencera pas à recevoir des requêtes avant que tous les gestionnaires de l'événement `startup` aient terminé. + +### Événement `shutdown` { #shutdown-event } + +Pour ajouter une fonction qui doit être exécutée lorsque l'application s'arrête, déclarez-la avec l'événement « shutdown » : + +{* ../../docs_src/events/tutorial002_py310.py hl[6] *} + +Ici, la fonction gestionnaire de l'événement `shutdown` écrira une ligne de texte « Application shutdown » dans un fichier `log.txt`. + +/// info + +Dans la fonction `open()`, le `mode="a"` signifie « append » (ajouter) ; la ligne sera donc ajoutée après ce qui se trouve déjà dans ce fichier, sans écraser le contenu précédent. + +/// + +/// tip | Astuce + +Notez que dans ce cas, nous utilisons une fonction Python standard `open()` qui interagit avec un fichier. + +Cela implique des E/S (input/output), qui nécessitent « d'attendre » que des choses soient écrites sur le disque. + +Mais `open()` n'utilise pas `async` et `await`. + +Nous déclarons donc la fonction gestionnaire d'événement avec un `def` standard plutôt qu'avec `async def`. + +/// + +### `startup` et `shutdown` ensemble { #startup-and-shutdown-together } + +Il y a de fortes chances que la logique de votre *démarrage* et de votre *arrêt* soit liée : vous pourriez vouloir démarrer quelque chose puis le terminer, acquérir une ressource puis la libérer, etc. + +Faire cela dans des fonctions séparées qui ne partagent pas de logique ni de variables est plus difficile, car vous devriez stocker des valeurs dans des variables globales ou recourir à des astuces similaires. + +Pour cette raison, il est désormais recommandé d'utiliser plutôt le `lifespan` comme expliqué ci-dessus. + +## Détails techniques { #technical-details } + +Juste un détail technique pour les nerds curieux. 🤓 + +Sous le capot, dans la spécification technique ASGI, cela fait partie du protocole Lifespan, et il y définit des événements appelés `startup` et `shutdown`. + +/// info + +Vous pouvez en lire plus sur les gestionnaires `lifespan` de Starlette dans la documentation « Lifespan » de Starlette. + +Y compris comment gérer l'état de cycle de vie qui peut être utilisé dans d'autres parties de votre code. + +/// + +## Sous-applications { #sub-applications } + +🚨 Gardez à l'esprit que ces événements de cycle de vie (démarrage et arrêt) ne seront exécutés que pour l'application principale, pas pour [Sous-applications - Montages](sub-applications.md){.internal-link target=_blank}. diff --git a/docs/fr/docs/advanced/generate-clients.md b/docs/fr/docs/advanced/generate-clients.md new file mode 100644 index 0000000000..6f51ac7be9 --- /dev/null +++ b/docs/fr/docs/advanced/generate-clients.md @@ -0,0 +1,208 @@ +# Générer des SDK { #generating-sdks } + +Parce que **FastAPI** est basé sur la spécification **OpenAPI**, ses API peuvent être décrites dans un format standard compris par de nombreux outils. + +Cela facilite la génération de **documentation** à jour, de bibliothèques clientes (**SDKs**) dans plusieurs langages, ainsi que de **tests** ou de **workflows d’automatisation** qui restent synchronisés avec votre code. + +Dans ce guide, vous apprendrez à générer un **SDK TypeScript** pour votre backend FastAPI. + +## Générateurs de SDK open source { #open-source-sdk-generators } + +Une option polyvalente est OpenAPI Generator, qui prend en charge **de nombreux langages de programmation** et peut générer des SDK à partir de votre spécification OpenAPI. + +Pour les **clients TypeScript**, Hey API est une solution dédiée, offrant une expérience optimisée pour l’écosystème TypeScript. + +Vous pouvez découvrir davantage de générateurs de SDK sur OpenAPI.Tools. + +/// tip | Astuce + +FastAPI génère automatiquement des spécifications **OpenAPI 3.1**, donc tout outil que vous utilisez doit prendre en charge cette version. + +/// + +## Générateurs de SDK par les sponsors de FastAPI { #sdk-generators-from-fastapi-sponsors } + +Cette section met en avant des solutions **soutenues par des fonds** et **par des entreprises** qui sponsorisent FastAPI. Ces produits offrent **des fonctionnalités supplémentaires** et **des intégrations** en plus de SDK de haute qualité générés. + +En ✨ [**sponsorisant FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨, ces entreprises contribuent à garantir que le framework et son **écosystème** restent sains et **durables**. + +Leur sponsoring démontre également un fort engagement envers la **communauté** FastAPI (vous), montrant qu’elles se soucient non seulement d’offrir un **excellent service**, mais aussi de soutenir un **framework robuste et florissant**, FastAPI. 🙇 + +Par exemple, vous pourriez essayer : + +* Speakeasy +* Stainless +* liblab + +Certaines de ces solutions peuvent aussi être open source ou proposer des niveaux gratuits, afin que vous puissiez les essayer sans engagement financier. D’autres générateurs de SDK commerciaux existent et peuvent être trouvés en ligne. 🤓 + +## Créer un SDK TypeScript { #create-a-typescript-sdk } + +Commençons par une application FastAPI simple : + +{* ../../docs_src/generate_clients/tutorial001_py310.py hl[7:9,12:13,16:17,21] *} + +Remarquez que les *chemins d'accès* définissent les modèles qu’ils utilisent pour le payload de requête et le payload de réponse, en utilisant les modèles `Item` et `ResponseMessage`. + +### Documentation de l’API { #api-docs } + +Si vous allez sur `/docs`, vous verrez qu’elle contient les **schémas** pour les données à envoyer dans les requêtes et reçues dans les réponses : + + + +Vous voyez ces schémas parce qu’ils ont été déclarés avec les modèles dans l’application. + +Ces informations sont disponibles dans le **schéma OpenAPI** de l’application, puis affichées dans la documentation de l’API. + +Ces mêmes informations issues des modèles, incluses dans OpenAPI, peuvent être utilisées pour **générer le code client**. + +### Hey API { #hey-api } + +Une fois que vous avez une application FastAPI avec les modèles, vous pouvez utiliser Hey API pour générer un client TypeScript. Le moyen le plus rapide de le faire est via npx. + +```sh +npx @hey-api/openapi-ts -i http://localhost:8000/openapi.json -o src/client +``` + +Cela générera un SDK TypeScript dans `./src/client`. + +Vous pouvez apprendre à installer `@hey-api/openapi-ts` et lire à propos du résultat généré sur leur site. + +### Utiliser le SDK { #using-the-sdk } + +Vous pouvez maintenant importer et utiliser le code client. Cela pourrait ressembler à ceci, remarquez que vous obtenez l’autocomplétion pour les méthodes : + + + +Vous obtiendrez également l’autocomplétion pour le payload à envoyer : + + + +/// tip | Astuce + +Remarquez l’autocomplétion pour `name` et `price`, qui a été définie dans l’application FastAPI, dans le modèle `Item`. + +/// + +Vous aurez des erreurs en ligne pour les données que vous envoyez : + + + +L’objet de réponse aura également l’autocomplétion : + + + +## Application FastAPI avec des tags { #fastapi-app-with-tags } + +Dans de nombreux cas, votre application FastAPI sera plus grande, et vous utiliserez probablement des tags pour séparer différents groupes de *chemins d'accès*. + +Par exemple, vous pourriez avoir une section pour les **items** et une autre section pour les **users**, et elles pourraient être séparées par des tags : + +{* ../../docs_src/generate_clients/tutorial002_py310.py hl[21,26,34] *} + +### Générer un client TypeScript avec des tags { #generate-a-typescript-client-with-tags } + +Si vous générez un client pour une application FastAPI utilisant des tags, il séparera normalement aussi le code client en fonction des tags. + +De cette façon, vous pourrez avoir les éléments ordonnés et correctement groupés côté client : + + + +Dans ce cas, vous avez : + +* `ItemsService` +* `UsersService` + +### Noms des méthodes du client { #client-method-names } + +À l’heure actuelle, les noms de méthodes générés comme `createItemItemsPost` ne sont pas très propres : + +```TypeScript +ItemsService.createItemItemsPost({name: "Plumbus", price: 5}) +``` + +... c’est parce que le générateur de client utilise l’**operation ID** interne OpenAPI pour chaque *chemin d'accès*. + +OpenAPI exige que chaque operation ID soit unique parmi tous les *chemins d'accès*, donc FastAPI utilise le **nom de la fonction**, le **chemin**, et la **méthode/opération HTTP** pour générer cet operation ID, car de cette façon il peut s’assurer que les operation IDs sont uniques. + +Mais je vais vous montrer comment améliorer cela ensuite. 🤓 + +## IDs d’opération personnalisés et meilleurs noms de méthodes { #custom-operation-ids-and-better-method-names } + +Vous pouvez **modifier** la façon dont ces operation IDs sont **générés** pour les simplifier et obtenir des **noms de méthodes plus simples** dans les clients. + +Dans ce cas, vous devez vous assurer que chaque operation ID est **unique** d’une autre manière. + +Par exemple, vous pouvez vous assurer que chaque *chemin d'accès* a un tag, puis générer l’operation ID à partir du **tag** et du **nom** du *chemin d'accès* (le nom de la fonction). + +### Fonction personnalisée de génération d’ID unique { #custom-generate-unique-id-function } + +FastAPI utilise un **ID unique** pour chaque *chemin d'accès*, qui est utilisé pour l’**operation ID** et également pour les noms des modèles personnalisés nécessaires, pour les requêtes ou les réponses. + +Vous pouvez personnaliser cette fonction. Elle prend un `APIRoute` et retourne une chaîne. + +Par exemple, ici elle utilise le premier tag (vous n’en aurez probablement qu’un) et le nom du *chemin d'accès* (le nom de la fonction). + +Vous pouvez ensuite passer cette fonction personnalisée à **FastAPI** via le paramètre `generate_unique_id_function` : + +{* ../../docs_src/generate_clients/tutorial003_py310.py hl[6:7,10] *} + +### Générer un client TypeScript avec des IDs d’opération personnalisés { #generate-a-typescript-client-with-custom-operation-ids } + +Maintenant, si vous régénérez le client, vous verrez qu’il possède des noms de méthodes améliorés : + + + +Comme vous le voyez, les noms de méthodes contiennent maintenant le tag puis le nom de la fonction ; ils n’incluent plus d’informations provenant du chemin d’URL et de l’opération HTTP. + +### Prétraiter la spécification OpenAPI pour le générateur de client { #preprocess-the-openapi-specification-for-the-client-generator } + +Le code généré contient encore des **informations dupliquées**. + +Nous savons déjà que cette méthode est liée aux **items** parce que ce mot figure dans `ItemsService` (issu du tag), mais nous avons encore le nom du tag préfixé dans le nom de la méthode. 😕 + +Nous voudrons probablement le conserver pour OpenAPI en général, car cela garantira que les operation IDs sont **uniques**. + +Mais pour le client généré, nous pourrions **modifier** les operation IDs d’OpenAPI juste avant de générer les clients, simplement pour rendre ces noms de méthodes plus agréables et **plus clairs**. + +Nous pourrions télécharger le JSON OpenAPI dans un fichier `openapi.json` puis **supprimer ce tag préfixé** avec un script comme celui-ci : + +{* ../../docs_src/generate_clients/tutorial004_py310.py *} + +//// tab | Node.js + +```Javascript +{!> ../../docs_src/generate_clients/tutorial004.js!} +``` + +//// + +Avec cela, les operation IDs seraient renommés de `items-get_items` en simplement `get_items`, de sorte que le générateur de client puisse produire des noms de méthodes plus simples. + +### Générer un client TypeScript avec l’OpenAPI prétraité { #generate-a-typescript-client-with-the-preprocessed-openapi } + +Puisque le résultat final se trouve maintenant dans un fichier `openapi.json`, vous devez mettre à jour l’emplacement d’entrée : + +```sh +npx @hey-api/openapi-ts -i ./openapi.json -o src/client +``` + +Après avoir généré le nouveau client, vous aurez désormais des **noms de méthodes propres**, avec toute l’**autocomplétion**, les **erreurs en ligne**, etc. : + + + +## Avantages { #benefits } + +En utilisant les clients générés automatiquement, vous obtiendrez de l’**autocomplétion** pour : + +* Méthodes. +* Payloads de requête dans le corps, paramètres de requête, etc. +* Payloads de réponse. + +Vous auriez également des **erreurs en ligne** pour tout. + +Et chaque fois que vous mettez à jour le code du backend et **régénérez** le frontend, il inclura les nouveaux *chemins d'accès* disponibles en tant que méthodes, supprimera les anciens, et tout autre changement sera reflété dans le code généré. 🤓 + +Cela signifie aussi que si quelque chose change, cela sera **reflété** automatiquement dans le code client. Et si vous **bâtissez** le client, il échouera en cas de **discordance** dans les données utilisées. + +Ainsi, vous **détecterez de nombreuses erreurs** très tôt dans le cycle de développement au lieu d’attendre qu’elles apparaissent pour vos utilisateurs finaux en production puis de tenter de déboguer l’origine du problème. ✨ diff --git a/docs/fr/docs/advanced/middleware.md b/docs/fr/docs/advanced/middleware.md new file mode 100644 index 0000000000..934c910411 --- /dev/null +++ b/docs/fr/docs/advanced/middleware.md @@ -0,0 +1,97 @@ +# Utiliser des middlewares avancés { #advanced-middleware } + +Dans le tutoriel principal, vous avez vu comment ajouter des [middlewares personnalisés](../tutorial/middleware.md){.internal-link target=_blank} à votre application. + +Vous avez également vu comment gérer [CORS avec le `CORSMiddleware`](../tutorial/cors.md){.internal-link target=_blank}. + +Dans cette section, nous allons voir comment utiliser d'autres middlewares. + +## Ajouter des middlewares ASGI { #adding-asgi-middlewares } + +Comme **FastAPI** est basé sur Starlette et implémente la spécification ASGI, vous pouvez utiliser n'importe quel middleware ASGI. + +Un middleware n'a pas besoin d'être conçu pour FastAPI ou Starlette pour fonctionner, tant qu'il suit la spécification ASGI. + +En général, les middlewares ASGI sont des classes qui s'attendent à recevoir une application ASGI en premier argument. + +Ainsi, dans la documentation de middlewares ASGI tiers, on vous indiquera probablement de faire quelque chose comme : + +```Python +from unicorn import UnicornMiddleware + +app = SomeASGIApp() + +new_app = UnicornMiddleware(app, some_config="rainbow") +``` + +Mais FastAPI (en fait Starlette) fournit une manière plus simple de le faire, qui garantit que les middlewares internes gèrent les erreurs serveur et que les gestionnaires d'exceptions personnalisés fonctionnent correctement. + +Pour cela, vous utilisez `app.add_middleware()` (comme dans l'exemple pour CORS). + +```Python +from fastapi import FastAPI +from unicorn import UnicornMiddleware + +app = FastAPI() + +app.add_middleware(UnicornMiddleware, some_config="rainbow") +``` + +`app.add_middleware()` reçoit une classe de middleware en premier argument, ainsi que tout argument supplémentaire à transmettre au middleware. + +## Utiliser les middlewares intégrés { #integrated-middlewares } + +**FastAPI** inclut plusieurs middlewares pour des cas d'usage courants ; voyons comment les utiliser. + +/// note | Détails techniques + +Pour les prochains exemples, vous pourriez aussi utiliser `from starlette.middleware.something import SomethingMiddleware`. + +**FastAPI** fournit plusieurs middlewares dans `fastapi.middleware` simplement pour vous faciliter la vie, en tant que développeur. Mais la plupart des middlewares disponibles viennent directement de Starlette. + +/// + +## `HTTPSRedirectMiddleware` { #httpsredirectmiddleware } + +Impose que toutes les requêtes entrantes soient soit `https`, soit `wss`. + +Toute requête entrante en `http` ou `ws` sera redirigée vers le schéma sécurisé correspondant. + +{* ../../docs_src/advanced_middleware/tutorial001_py310.py hl[2,6] *} + +## `TrustedHostMiddleware` { #trustedhostmiddleware } + +Impose que toutes les requêtes entrantes aient un en-tête `Host` correctement défini, afin de se prémunir contre les attaques de type HTTP Host Header. + +{* ../../docs_src/advanced_middleware/tutorial002_py310.py hl[2,6:8] *} + +Les arguments suivants sont pris en charge : + +- `allowed_hosts` - Une liste de noms de domaine autorisés comme noms d'hôte. Les domaines génériques tels que `*.example.com` sont pris en charge pour faire correspondre les sous-domaines. Pour autoriser n'importe quel nom d'hôte, utilisez `allowed_hosts=["*"]` ou omettez le middleware. +- `www_redirect` - Si défini à `True`, les requêtes vers les versions sans www des hôtes autorisés seront redirigées vers leurs équivalents avec www. Valeur par défaut : `True`. + +Si une requête entrante n'est pas valide, une réponse `400` sera envoyée. + +## `GZipMiddleware` { #gzipmiddleware } + +Gère les réponses GZip pour toute requête qui inclut « gzip » dans l'en-tête `Accept-Encoding`. + +Le middleware gérera les réponses standard et en streaming. + +{* ../../docs_src/advanced_middleware/tutorial003_py310.py hl[2,6] *} + +Les arguments suivants sont pris en charge : + +- `minimum_size` - Ne pas compresser en GZip les réponses dont la taille est inférieure à ce minimum en octets. Valeur par défaut : `500`. +- `compresslevel` - Utilisé pendant la compression GZip. Entier compris entre 1 et 9. Valeur par défaut : `9`. Une valeur plus faible entraîne une compression plus rapide mais des fichiers plus volumineux, tandis qu'une valeur plus élevée entraîne une compression plus lente mais des fichiers plus petits. + +## Autres middlewares { #other-middlewares } + +Il existe de nombreux autres middlewares ASGI. + +Par exemple : + +- Le `ProxyHeadersMiddleware` d'Uvicorn +- MessagePack + +Pour voir d'autres middlewares disponibles, consultez la documentation des middlewares de Starlette et la liste ASGI Awesome. diff --git a/docs/fr/docs/advanced/openapi-callbacks.md b/docs/fr/docs/advanced/openapi-callbacks.md new file mode 100644 index 0000000000..669d9447a2 --- /dev/null +++ b/docs/fr/docs/advanced/openapi-callbacks.md @@ -0,0 +1,186 @@ +# Callbacks OpenAPI { #openapi-callbacks } + +Vous pourriez créer une API avec un *chemin d'accès* qui déclenche une requête vers une *API externe* créée par quelqu'un d'autre (probablement la même personne développeuse qui utiliserait votre API). + +Le processus qui se produit lorsque votre application API appelle l’*API externe* s’appelle un « callback ». Parce que le logiciel écrit par la personne développeuse externe envoie une requête à votre API puis votre API « rappelle », en envoyant une requête à une *API externe* (probablement créée par la même personne développeuse). + +Dans ce cas, vous pourriez vouloir documenter à quoi cette API externe devrait ressembler. Quel *chemin d'accès* elle devrait avoir, quel corps elle devrait attendre, quelle réponse elle devrait renvoyer, etc. + +## Une application avec des callbacks { #an-app-with-callbacks } + +Voyons tout cela avec un exemple. + +Imaginez que vous développiez une application qui permet de créer des factures. + +Ces factures auront un `id`, un `title` (facultatif), un `customer` et un `total`. + +L’utilisateur de votre API (une personne développeuse externe) créera une facture dans votre API avec une requête POST. + +Ensuite votre API va (imaginons) : + +* Envoyer la facture à un client de la personne développeuse externe. +* Encaisser l’argent. +* Renvoyer une notification à l’utilisateur de l’API (la personne développeuse externe). + * Cela sera fait en envoyant une requête POST (depuis *votre API*) vers une *API externe* fournie par cette personne développeuse externe (c’est le « callback »). + +## L’application **FastAPI** normale { #the-normal-fastapi-app } + +Voyons d’abord à quoi ressemble l’application API normale avant d’ajouter le callback. + +Elle aura un *chemin d'accès* qui recevra un corps `Invoice`, et un paramètre de requête `callback_url` qui contiendra l’URL pour le callback. + +Cette partie est assez normale, la plupart du code vous est probablement déjà familier : + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[7:11,34:51] *} + +/// tip | Astuce + +Le paramètre de requête `callback_url` utilise un type Pydantic Url. + +/// + +La seule nouveauté est `callbacks=invoices_callback_router.routes` comme argument du *décorateur de chemin d'accès*. Nous allons voir ce que c’est ensuite. + +## Documenter le callback { #documenting-the-callback } + +Le code réel du callback dépendra fortement de votre application API. + +Et il variera probablement beaucoup d’une application à l’autre. + +Cela pourrait être seulement une ou deux lignes de code, comme : + +```Python +callback_url = "https://example.com/api/v1/invoices/events/" +httpx.post(callback_url, json={"description": "Invoice paid", "paid": True}) +``` + +Mais la partie la plus importante du callback est sans doute de vous assurer que l’utilisateur de votre API (la personne développeuse externe) implémente correctement l’*API externe*, conformément aux données que *votre API* va envoyer dans le corps de la requête du callback, etc. + +Ainsi, ce que nous allons faire ensuite, c’est ajouter le code pour documenter à quoi cette *API externe* devrait ressembler pour recevoir le callback de *votre API*. + +Cette documentation apparaîtra dans Swagger UI à `/docs` dans votre API, et permettra aux personnes développeuses externes de savoir comment construire l’*API externe*. + +Cet exemple n’implémente pas le callback lui-même (qui pourrait être une simple ligne de code), uniquement la partie documentation. + +/// tip | Astuce + +Le callback réel n’est qu’une requête HTTP. + +En implémentant vous-même le callback, vous pourriez utiliser quelque chose comme HTTPX ou Requests. + +/// + +## Écrire le code de documentation du callback { #write-the-callback-documentation-code } + +Ce code ne sera pas exécuté dans votre application, nous en avons seulement besoin pour *documenter* à quoi devrait ressembler cette *API externe*. + +Mais vous savez déjà comment créer facilement une documentation automatique pour une API avec **FastAPI**. + +Nous allons donc utiliser ce même savoir pour documenter à quoi l’*API externe* devrait ressembler ... en créant le(s) *chemin(s) d'accès* que l’API externe devrait implémenter (ceux que votre API appellera). + +/// tip | Astuce + +Lorsque vous écrivez le code pour documenter un callback, il peut être utile d’imaginer que vous êtes cette *personne développeuse externe*. Et que vous implémentez actuellement l’*API externe*, pas *votre API*. + +Adopter temporairement ce point de vue (celui de la *personne développeuse externe*) peut vous aider à trouver plus évident où placer les paramètres, le modèle Pydantic pour le corps, pour la réponse, etc., pour cette *API externe*. + +/// + +### Créer un `APIRouter` de callback { #create-a-callback-apirouter } + +Commencez par créer un nouveau `APIRouter` qui contiendra un ou plusieurs callbacks. + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[1,23] *} + +### Créer le *chemin d'accès* du callback { #create-the-callback-path-operation } + +Pour créer le *chemin d'accès* du callback, utilisez le même `APIRouter` que vous avez créé ci-dessus. + +Il devrait ressembler exactement à un *chemin d'accès* FastAPI normal : + +* Il devrait probablement déclarer le corps qu’il doit recevoir, par exemple `body: InvoiceEvent`. +* Et il pourrait aussi déclarer la réponse qu’il doit renvoyer, par exemple `response_model=InvoiceEventReceived`. + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[14:16,19:20,26:30] *} + +Il y a 2 principales différences par rapport à un *chemin d'accès* normal : + +* Il n’a pas besoin d’avoir de code réel, car votre application n’appellera jamais ce code. Il sert uniquement à documenter l’*API externe*. La fonction peut donc simplement contenir `pass`. +* Le *chemin* peut contenir une expression OpenAPI 3 (voir plus bas) où il peut utiliser des variables avec des paramètres et des parties de la requête originale envoyée à *votre API*. + +### L’expression du chemin de callback { #the-callback-path-expression } + +Le *chemin* du callback peut contenir une expression OpenAPI 3 qui peut inclure des parties de la requête originale envoyée à *votre API*. + +Dans ce cas, c’est la `str` : + +```Python +"{$callback_url}/invoices/{$request.body.id}" +``` + +Ainsi, si l’utilisateur de votre API (la personne développeuse externe) envoie une requête à *votre API* vers : + +``` +https://yourapi.com/invoices/?callback_url=https://www.external.org/events +``` + +avec un corps JSON : + +```JSON +{ + "id": "2expen51ve", + "customer": "Mr. Richie Rich", + "total": "9999" +} +``` + +alors *votre API* traitera la facture et, à un moment ultérieur, enverra une requête de callback à `callback_url` (l’*API externe*) : + +``` +https://www.external.org/events/invoices/2expen51ve +``` + +avec un corps JSON contenant quelque chose comme : + +```JSON +{ + "description": "Payment celebration", + "paid": true +} +``` + +et elle s’attendra à une réponse de cette *API externe* avec un corps JSON comme : + +```JSON +{ + "ok": true +} +``` + +/// tip | Astuce + +Remarquez que l’URL de callback utilisée contient l’URL reçue en paramètre de requête dans `callback_url` (`https://www.external.org/events`) et aussi l’`id` de la facture à l’intérieur du corps JSON (`2expen51ve`). + +/// + +### Ajouter le routeur de callback { #add-the-callback-router } + +À ce stade, vous avez le(s) *chemin(s) d'accès de callback* nécessaire(s) (celui/ceux que la *personne développeuse externe* doit implémenter dans l’*API externe*) dans le routeur de callback que vous avez créé ci-dessus. + +Utilisez maintenant le paramètre `callbacks` dans *le décorateur de chemin d'accès de votre API* pour passer l’attribut `.routes` (qui est en fait juste une `list` de routes/*chemins d'accès*) depuis ce routeur de callback : + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[33] *} + +/// tip | Astuce + +Remarquez que vous ne passez pas le routeur lui-même (`invoices_callback_router`) à `callback=`, mais l’attribut `.routes`, comme dans `invoices_callback_router.routes`. + +/// + +### Vérifier la documentation { #check-the-docs } + +Vous pouvez maintenant démarrer votre application et aller sur http://127.0.0.1:8000/docs. + +Vous verrez votre documentation incluant une section « Callbacks » pour votre *chemin d'accès* qui montre à quoi l’*API externe* devrait ressembler : + + diff --git a/docs/fr/docs/advanced/openapi-webhooks.md b/docs/fr/docs/advanced/openapi-webhooks.md new file mode 100644 index 0000000000..21b6f5f00c --- /dev/null +++ b/docs/fr/docs/advanced/openapi-webhooks.md @@ -0,0 +1,55 @@ +# Webhooks OpenAPI { #openapi-webhooks } + +Il existe des cas où vous voulez informer les utilisateurs de votre API que votre application peut appeler leur application (en envoyant une requête) avec des données, généralement pour notifier un type d'événement. + +Cela signifie qu'au lieu du processus habituel où vos utilisateurs envoient des requêtes à votre API, c'est votre API (ou votre application) qui peut envoyer des requêtes vers leur système (vers leur API, leur application). + +On appelle généralement cela un webhook. + +## Étapes des webhooks { #webhooks-steps } + +Le processus consiste généralement à définir dans votre code le message que vous enverrez, c'est-à-dire le corps de la requête. + +Vous définissez également, d'une manière ou d'une autre, à quels moments votre application enverra ces requêtes ou événements. + +Et vos utilisateurs définissent aussi, d'une manière ou d'une autre (par exemple dans un tableau de bord Web), l'URL à laquelle votre application doit envoyer ces requêtes. + +Toute la logique de gestion des URL des webhooks et le code qui envoie effectivement ces requêtes vous incombent. Vous l'implémentez comme vous le souhaitez dans votre propre code. + +## Documenter des webhooks avec FastAPI et OpenAPI { #documenting-webhooks-with-fastapi-and-openapi } + +Avec FastAPI, en utilisant OpenAPI, vous pouvez définir les noms de ces webhooks, les types d'opérations HTTP que votre application peut envoyer (par exemple `POST`, `PUT`, etc.) et les corps des requêtes que votre application enverra. + +Cela peut grandement faciliter la tâche de vos utilisateurs pour implémenter leurs API afin de recevoir vos requêtes de webhook ; ils pourront même peut-être générer automatiquement une partie de leur propre code d'API. + +/// info + +Les webhooks sont disponibles dans OpenAPI 3.1.0 et versions ultérieures, pris en charge par FastAPI `0.99.0` et versions ultérieures. + +/// + +## Créer une application avec des webhooks { #an-app-with-webhooks } + +Lorsque vous créez une application FastAPI, il existe un attribut `webhooks` que vous pouvez utiliser pour définir des webhooks, de la même manière que vous définiriez des chemins d'accès, par exemple avec `@app.webhooks.post()`. + +{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *} + +Les webhooks que vous définissez apparaîtront dans le schéma **OpenAPI** et dans l'interface de **documentation** automatique. + +/// info + +L'objet `app.webhooks` est en fait simplement un `APIRouter`, le même type que vous utiliseriez pour structurer votre application en plusieurs fichiers. + +/// + +Notez qu'avec les webhooks, vous ne déclarez pas réellement un chemin (comme `/items/`), le texte que vous y passez est simplement un identifiant du webhook (le nom de l'événement). Par exemple, dans `@app.webhooks.post("new-subscription")`, le nom du webhook est `new-subscription`. + +C'est parce qu'on s'attend à ce que vos utilisateurs définissent, par un autre moyen (par exemple un tableau de bord Web), le véritable chemin d'URL où ils souhaitent recevoir la requête de webhook. + +### Consulter la documentation { #check-the-docs } + +Vous pouvez maintenant démarrer votre application et aller sur http://127.0.0.1:8000/docs. + +Vous verrez que votre documentation contient les chemins d'accès habituels et désormais aussi des webhooks : + + diff --git a/docs/fr/docs/advanced/path-operation-advanced-configuration.md b/docs/fr/docs/advanced/path-operation-advanced-configuration.md index fc88f33633..b482f97ccc 100644 --- a/docs/fr/docs/advanced/path-operation-advanced-configuration.md +++ b/docs/fr/docs/advanced/path-operation-advanced-configuration.md @@ -12,7 +12,7 @@ Vous pouvez définir l’OpenAPI `operationId` à utiliser dans votre chemin d Vous devez vous assurer qu’il est unique pour chaque opération. -{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py39.py hl[6] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py310.py hl[6] *} ### Utiliser le nom de la fonction de chemin d’accès comme operationId { #using-the-path-operation-function-name-as-the-operationid } @@ -20,7 +20,7 @@ Si vous souhaitez utiliser les noms de fonction de vos API comme `operationId`, Vous devez le faire après avoir ajouté tous vos chemins d’accès. -{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py39.py hl[2, 12:21, 24] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py310.py hl[2, 12:21, 24] *} /// tip | Astuce @@ -40,7 +40,7 @@ Même si elles se trouvent dans des modules différents (fichiers Python). Pour exclure un chemin d’accès du schéma OpenAPI généré (et donc des systèmes de documentation automatiques), utilisez le paramètre `include_in_schema` et définissez-le à `False` : -{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py39.py hl[6] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *} ## Description avancée depuis la docstring { #advanced-description-from-docstring } @@ -92,7 +92,7 @@ Vous pouvez étendre le schéma OpenAPI pour un chemin d’accès en utilisant l Cet `openapi_extra` peut être utile, par exemple, pour déclarer des [Extensions OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions) : -{* ../../docs_src/path_operation_advanced_configuration/tutorial005_py39.py hl[6] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial005_py310.py hl[6] *} Si vous ouvrez la documentation automatique de l’API, votre extension apparaîtra en bas du chemin d’accès spécifique. @@ -139,9 +139,9 @@ Par exemple, vous pourriez décider de lire et de valider la requête avec votre Vous pourriez le faire avec `openapi_extra` : -{* ../../docs_src/path_operation_advanced_configuration/tutorial006_py39.py hl[19:36, 39:40] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial006_py310.py hl[19:36, 39:40] *} -Dans cet exemple, nous n’avons déclaré aucun modèle Pydantic. En fait, le corps de la requête n’est même pas parsé en JSON, il est lu directement en tant que `bytes`, et la fonction `magic_data_reader()` serait chargée de l’analyser d’une manière ou d’une autre. +Dans cet exemple, nous n’avons déclaré aucun modèle Pydantic. En fait, le corps de la requête n’est même pas parsé en JSON, il est lu directement en tant que `bytes`, et la fonction `magic_data_reader()` serait chargée de l’analyser d’une manière ou d’une autre. Néanmoins, nous pouvons déclarer le schéma attendu pour le corps de la requête. @@ -153,7 +153,7 @@ Et vous pourriez le faire même si le type de données dans la requête n’est Par exemple, dans cette application nous n’utilisons pas la fonctionnalité intégrée de FastAPI pour extraire le JSON Schema des modèles Pydantic ni la validation automatique pour le JSON. En fait, nous déclarons le type de contenu de la requête comme YAML, pas JSON : -{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py39.py hl[15:20, 22] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py310.py hl[15:20, 22] *} Néanmoins, bien que nous n’utilisions pas la fonctionnalité intégrée par défaut, nous utilisons toujours un modèle Pydantic pour générer manuellement le JSON Schema pour les données que nous souhaitons recevoir en YAML. @@ -161,7 +161,7 @@ Ensuite, nous utilisons directement la requête et extrayons le corps en tant qu Ensuite, dans notre code, nous analysons directement ce contenu YAML, puis nous utilisons à nouveau le même modèle Pydantic pour valider le contenu YAML : -{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py39.py hl[24:31] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py310.py hl[24:31] *} /// tip | Astuce diff --git a/docs/fr/docs/advanced/response-change-status-code.md b/docs/fr/docs/advanced/response-change-status-code.md new file mode 100644 index 0000000000..d08e870995 --- /dev/null +++ b/docs/fr/docs/advanced/response-change-status-code.md @@ -0,0 +1,31 @@ +# Réponse - Modifier le code d'état { #response-change-status-code } + +Vous avez probablement déjà lu que vous pouvez définir un [Code d'état de la réponse](../tutorial/response-status-code.md){.internal-link target=_blank} par défaut. + +Mais dans certains cas, vous devez renvoyer un code d'état différent de celui par défaut. + +## Cas d'utilisation { #use-case } + +Par exemple, imaginez que vous vouliez renvoyer par défaut un code d'état HTTP « OK » `200`. + +Mais si les données n'existent pas, vous voulez les créer et renvoyer un code d'état HTTP « CREATED » `201`. + +Mais vous souhaitez toujours pouvoir filtrer et convertir les données que vous renvoyez avec un `response_model`. + +Pour ces cas, vous pouvez utiliser un paramètre `Response`. + +## Utiliser un paramètre `Response` { #use-a-response-parameter } + +Vous pouvez déclarer un paramètre de type `Response` dans votre fonction de chemin d'accès (comme vous pouvez le faire pour les cookies et les en-têtes). + +Vous pouvez ensuite définir le `status_code` dans cet objet de réponse *temporaire*. + +{* ../../docs_src/response_change_status_code/tutorial001_py310.py hl[1,9,12] *} + +Vous pouvez ensuite renvoyer n'importe quel objet nécessaire, comme d'habitude (un `dict`, un modèle de base de données, etc.). + +Et si vous avez déclaré un `response_model`, il sera toujours utilisé pour filtrer et convertir l'objet que vous avez renvoyé. + +**FastAPI** utilisera cette réponse *temporaire* pour extraire le code d'état (ainsi que les cookies et les en-têtes), et les placera dans la réponse finale qui contient la valeur que vous avez renvoyée, filtrée par tout `response_model`. + +Vous pouvez également déclarer le paramètre `Response` dans des dépendances et y définir le code d'état. Mais gardez à l'esprit que la dernière valeur définie prévaut. diff --git a/docs/fr/docs/advanced/response-cookies.md b/docs/fr/docs/advanced/response-cookies.md new file mode 100644 index 0000000000..d3e51f3317 --- /dev/null +++ b/docs/fr/docs/advanced/response-cookies.md @@ -0,0 +1,51 @@ +# Cookies de réponse { #response-cookies } + +## Utiliser un paramètre `Response` { #use-a-response-parameter } + +Vous pouvez déclarer un paramètre de type `Response` dans votre fonction de chemin d'accès. + +Vous pouvez ensuite définir des cookies dans cet objet de réponse *temporaire*. + +{* ../../docs_src/response_cookies/tutorial002_py310.py hl[1, 8:9] *} + +Vous pouvez ensuite renvoyer n'importe quel objet dont vous avez besoin, comme d'habitude (un `dict`, un modèle de base de données, etc.). + +Et si vous avez déclaré un `response_model`, il sera toujours utilisé pour filtrer et convertir l'objet que vous avez renvoyé. + +**FastAPI** utilisera cette réponse *temporaire* pour extraire les cookies (ainsi que les en-têtes et le code d'état), et les placera dans la réponse finale qui contient la valeur que vous avez renvoyée, filtrée par tout `response_model`. + +Vous pouvez également déclarer le paramètre `Response` dans des dépendances, et y définir des cookies (et des en-têtes). + +## Renvoyer une `Response` directement { #return-a-response-directly } + +Vous pouvez également créer des cookies en renvoyant une `Response` directement dans votre code. + +Pour ce faire, vous pouvez créer une réponse comme décrit dans [Renvoyer une Response directement](response-directly.md){.internal-link target=_blank}. + +Définissez ensuite des cookies dessus, puis renvoyez-la : + +{* ../../docs_src/response_cookies/tutorial001_py310.py hl[10:12] *} + +/// tip | Astuce + +Gardez à l'esprit que si vous renvoyez une réponse directement au lieu d'utiliser le paramètre `Response`, FastAPI la renverra telle quelle. + +Vous devez donc vous assurer que vos données sont du type correct. Par exemple, qu'elles sont compatibles avec JSON si vous renvoyez une `JSONResponse`. + +Et également que vous n'envoyez pas de données qui auraient dû être filtrées par un `response_model`. + +/// + +### En savoir plus { #more-info } + +/// note | Détails techniques + +Vous pouvez également utiliser `from starlette.responses import Response` ou `from starlette.responses import JSONResponse`. + +**FastAPI** fournit les mêmes `starlette.responses` que `fastapi.responses` simplement pour votre commodité, en tant que développeur. Mais la plupart des réponses disponibles proviennent directement de Starlette. + +Et comme `Response` peut être utilisé fréquemment pour définir des en-têtes et des cookies, **FastAPI** la met également à disposition via `fastapi.Response`. + +/// + +Pour voir tous les paramètres et options disponibles, consultez la documentation de Starlette. diff --git a/docs/fr/docs/advanced/response-directly.md b/docs/fr/docs/advanced/response-directly.md index f35c39c06f..4a49518640 100644 --- a/docs/fr/docs/advanced/response-directly.md +++ b/docs/fr/docs/advanced/response-directly.md @@ -22,7 +22,7 @@ En fait, vous pouvez retourner n'importe quelle `Response` ou n'importe quelle s Et quand vous retournez une `Response`, **FastAPI** la transmet directement. -Elle ne fera aucune conversion de données avec les modèles Pydantic, elle ne convertira pas le contenu en un type quelconque. +Elle ne fera aucune conversion de données avec les modèles Pydantic, elle ne convertira pas le contenu en un type quelconque, etc. Cela vous donne beaucoup de flexibilité. Vous pouvez retourner n'importe quel type de données, surcharger n'importe quelle déclaration ou validation de données, etc. @@ -54,7 +54,7 @@ Disons que vous voulez retourner une réponse en utilisant le préfixe `X-`. + +Mais si vous avez des en-têtes personnalisés que vous voulez qu'un client dans un navigateur puisse voir, vous devez les ajouter à vos configurations CORS (en savoir plus dans [CORS (Cross-Origin Resource Sharing)](../tutorial/cors.md){.internal-link target=_blank}), en utilisant le paramètre `expose_headers` documenté dans la documentation CORS de Starlette. diff --git a/docs/fr/docs/advanced/security/http-basic-auth.md b/docs/fr/docs/advanced/security/http-basic-auth.md new file mode 100644 index 0000000000..a8742ce7c2 --- /dev/null +++ b/docs/fr/docs/advanced/security/http-basic-auth.md @@ -0,0 +1,107 @@ +# Authentification HTTP Basic { #http-basic-auth } + +Pour les cas les plus simples, vous pouvez utiliser l'authentification HTTP Basic. + +Avec l'authentification HTTP Basic, l'application attend un en-tête contenant un nom d'utilisateur et un mot de passe. + +Si elle ne le reçoit pas, elle renvoie une erreur HTTP 401 « Unauthorized ». + +Et elle renvoie un en-tête `WWW-Authenticate` avec la valeur `Basic`, et un paramètre optionnel `realm`. + +Cela indique au navigateur d'afficher l'invite intégrée pour saisir un nom d'utilisateur et un mot de passe. + +Ensuite, lorsque vous saisissez ce nom d'utilisateur et ce mot de passe, le navigateur les envoie automatiquement dans l'en-tête. + +## Authentification HTTP Basic simple { #simple-http-basic-auth } + +- Importer `HTTPBasic` et `HTTPBasicCredentials`. +- Créer un « schéma de sécurité » en utilisant `HTTPBasic`. +- Utiliser ce `security` avec une dépendance dans votre chemin d'accès. +- Cela renvoie un objet de type `HTTPBasicCredentials` : + - Il contient le `username` et le `password` envoyés. + +{* ../../docs_src/security/tutorial006_an_py310.py hl[4,8,12] *} + +Lorsque vous essayez d'ouvrir l'URL pour la première fois (ou cliquez sur le bouton « Execute » dans les documents) le navigateur vous demandera votre nom d'utilisateur et votre mot de passe : + + + +## Vérifier le nom d'utilisateur { #check-the-username } + +Voici un exemple plus complet. + +Utilisez une dépendance pour vérifier si le nom d'utilisateur et le mot de passe sont corrects. + +Pour cela, utilisez le module standard Python `secrets` pour vérifier le nom d'utilisateur et le mot de passe. + +`secrets.compare_digest()` doit recevoir des `bytes` ou une `str` ne contenant que des caractères ASCII (ceux de l'anglais), ce qui signifie qu'elle ne fonctionnerait pas avec des caractères comme `á`, comme dans `Sebastián`. + +Pour gérer cela, nous convertissons d'abord `username` et `password` en `bytes` en les encodant en UTF-8. + +Nous pouvons ensuite utiliser `secrets.compare_digest()` pour vérifier que `credentials.username` est « stanleyjobson » et que `credentials.password` est « swordfish ». + +{* ../../docs_src/security/tutorial007_an_py310.py hl[1,12:24] *} + +Cela serait équivalent à : + +```Python +if not (credentials.username == "stanleyjobson") or not (credentials.password == "swordfish"): + # Renvoyer une erreur + ... +``` + +Mais en utilisant `secrets.compare_digest()`, cela sera sécurisé contre un type d'attaques appelé « attaques par chronométrage ». + +### Attaques par chronométrage { #timing-attacks } + +Mais qu'est-ce qu'une « attaque par chronométrage » ? + +Imaginons que des attaquants essaient de deviner le nom d'utilisateur et le mot de passe. + +Ils envoient alors une requête avec un nom d'utilisateur `johndoe` et un mot de passe `love123`. + +Le code Python de votre application serait alors équivalent à quelque chose comme : + +```Python +if "johndoe" == "stanleyjobson" and "love123" == "swordfish": + ... +``` + +Mais au moment où Python compare le premier `j` de `johndoe` au premier `s` de `stanleyjobson`, il retournera `False`, car il sait déjà que ces deux chaînes ne sont pas identiques, en se disant qu'« il n'est pas nécessaire de gaspiller plus de calcul pour comparer le reste des lettres ». Et votre application dira « Nom d'utilisateur ou mot de passe incorrect ». + +Mais ensuite, les attaquants essaient avec le nom d'utilisateur `stanleyjobsox` et le mot de passe `love123`. + +Et le code de votre application fait quelque chose comme : + +```Python +if "stanleyjobsox" == "stanleyjobson" and "love123" == "swordfish": + ... +``` + +Python devra comparer tout `stanleyjobso` dans `stanleyjobsox` et `stanleyjobson` avant de réaliser que les deux chaînes ne sont pas identiques. Cela prendra donc quelques microsecondes supplémentaires pour répondre « Nom d'utilisateur ou mot de passe incorrect ». + +#### Le temps de réponse aide les attaquants { #the-time-to-answer-helps-the-attackers } + +À ce stade, en remarquant que le serveur a mis quelques microsecondes de plus à envoyer la réponse « Nom d'utilisateur ou mot de passe incorrect », les attaquants sauront qu'ils ont trouvé quelque chose de juste : certaines des premières lettres étaient correctes. + +Ils peuvent alors réessayer en sachant que c'est probablement quelque chose de plus proche de `stanleyjobsox` que de `johndoe`. + +#### Une attaque « professionnelle » { #a-professional-attack } + +Bien sûr, les attaquants n'essaieraient pas tout cela à la main ; ils écriraient un programme pour le faire, avec éventuellement des milliers ou des millions de tests par seconde. Ils obtiendraient une lettre correcte supplémentaire à la fois. + +Ce faisant, en quelques minutes ou heures, les attaquants devineraient le nom d'utilisateur et le mot de passe corrects, avec « l'aide » de notre application, simplement en se basant sur le temps de réponse. + +#### Corrigez-le avec `secrets.compare_digest()` { #fix-it-with-secrets-compare-digest } + +Mais dans notre code nous utilisons justement `secrets.compare_digest()`. + +En bref, il faudra le même temps pour comparer `stanleyjobsox` à `stanleyjobson` que pour comparer `johndoe` à `stanleyjobson`. Il en va de même pour le mot de passe. + +Ainsi, en utilisant `secrets.compare_digest()` dans le code de votre application, votre application sera protégée contre toute cette gamme d'attaques de sécurité. + +### Renvoyer l'erreur { #return-the-error } + +Après avoir détecté que les identifiants sont incorrects, renvoyez une `HTTPException` avec un code d'état 401 (le même que lorsque aucun identifiant n'est fourni) et ajoutez l'en-tête `WWW-Authenticate` pour que le navigateur affiche à nouveau l'invite de connexion : + +{* ../../docs_src/security/tutorial007_an_py310.py hl[26:30] *} diff --git a/docs/fr/docs/advanced/security/index.md b/docs/fr/docs/advanced/security/index.md new file mode 100644 index 0000000000..e84fcef626 --- /dev/null +++ b/docs/fr/docs/advanced/security/index.md @@ -0,0 +1,19 @@ +# Sécurité avancée { #advanced-security } + +## Fonctionnalités supplémentaires { #additional-features } + +Il existe des fonctionnalités supplémentaires pour gérer la sécurité en plus de celles couvertes dans le [Tutoriel - Guide utilisateur : Sécurité](../../tutorial/security/index.md){.internal-link target=_blank}. + +/// tip | Astuce + +Les sections suivantes ne sont pas nécessairement « advanced ». + +Et il est possible que, pour votre cas d’utilisation, la solution se trouve dans l’une d’entre elles. + +/// + +## Lire d’abord le tutoriel { #read-the-tutorial-first } + +Les sections suivantes partent du principe que vous avez déjà lu le [Tutoriel - Guide utilisateur : Sécurité](../../tutorial/security/index.md){.internal-link target=_blank} principal. + +Elles s’appuient toutes sur les mêmes concepts, mais permettent des fonctionnalités supplémentaires. diff --git a/docs/fr/docs/advanced/security/oauth2-scopes.md b/docs/fr/docs/advanced/security/oauth2-scopes.md new file mode 100644 index 0000000000..c890a5129d --- /dev/null +++ b/docs/fr/docs/advanced/security/oauth2-scopes.md @@ -0,0 +1,274 @@ +# Scopes OAuth2 { #oauth2-scopes } + +Vous pouvez utiliser des scopes OAuth2 directement avec **FastAPI**, ils sont intégrés pour fonctionner de manière transparente. + +Cela vous permettrait d’avoir un système d’autorisations plus fin, conforme au standard OAuth2, intégré à votre application OpenAPI (et à la documentation de l’API). + +OAuth2 avec scopes est le mécanisme utilisé par de nombreux grands fournisseurs d’authentification, comme Facebook, Google, GitHub, Microsoft, X (Twitter), etc. Ils l’utilisent pour fournir des permissions spécifiques aux utilisateurs et aux applications. + +Chaque fois que vous « log in with » Facebook, Google, GitHub, Microsoft, X (Twitter), cette application utilise OAuth2 avec scopes. + +Dans cette section, vous verrez comment gérer l’authentification et l’autorisation avec le même OAuth2 avec scopes dans votre application **FastAPI**. + +/// warning | Alertes + +C’est une section plus ou moins avancée. Si vous débutez, vous pouvez la passer. + +Vous n’avez pas nécessairement besoin des scopes OAuth2, et vous pouvez gérer l’authentification et l’autorisation comme vous le souhaitez. + +Mais OAuth2 avec scopes peut s’intégrer élégamment à votre API (avec OpenAPI) et à votre documentation d’API. + +Néanmoins, c’est toujours à vous de faire appliquer ces scopes, ou toute autre exigence de sécurité/autorisation, selon vos besoins, dans votre code. + +Dans de nombreux cas, OAuth2 avec scopes peut être excessif. + +Mais si vous savez que vous en avez besoin, ou si vous êtes curieux, continuez à lire. + +/// + +## Scopes OAuth2 et OpenAPI { #oauth2-scopes-and-openapi } + +La spécification OAuth2 définit des « scopes » comme une liste de chaînes séparées par des espaces. + +Le contenu de chacune de ces chaînes peut avoir n’importe quel format, mais ne doit pas contenir d’espaces. + +Ces scopes représentent des « permissions ». + +Dans OpenAPI (par ex. la documentation de l’API), vous pouvez définir des « schémas de sécurité ». + +Lorsqu’un de ces schémas de sécurité utilise OAuth2, vous pouvez aussi déclarer et utiliser des scopes. + +Chaque « scope » est juste une chaîne (sans espaces). + +Ils sont généralement utilisés pour déclarer des permissions de sécurité spécifiques, par exemple : + +* `users:read` ou `users:write` sont des exemples courants. +* `instagram_basic` est utilisé par Facebook / Instagram. +* `https://www.googleapis.com/auth/drive` est utilisé par Google. + +/// info + +Dans OAuth2, un « scope » est simplement une chaîne qui déclare une permission spécifique requise. + +Peu importe s’il contient d’autres caractères comme `:` ou si c’est une URL. + +Ces détails dépendent de l’implémentation. + +Pour OAuth2, ce ne sont que des chaînes. + +/// + +## Vue d’ensemble { #global-view } + +Voyons d’abord rapidement les parties qui changent par rapport aux exemples du **Tutoriel - Guide utilisateur** pour [OAuth2 avec mot de passe (et hachage), Bearer avec jetons JWT](../../tutorial/security/oauth2-jwt.md){.internal-link target=_blank}. Cette fois, en utilisant des scopes OAuth2 : + +{* ../../docs_src/security/tutorial005_an_py310.py hl[5,9,13,47,65,106,108:116,122:126,130:136,141,157] *} + +Passons maintenant en revue ces changements étape par étape. + +## Déclarer le schéma de sécurité OAuth2 { #oauth2-security-scheme } + +Le premier changement est que nous déclarons maintenant le schéma de sécurité OAuth2 avec deux scopes disponibles, `me` et `items`. + +Le paramètre `scopes` reçoit un `dict` avec chaque scope en clé et la description en valeur : + +{* ../../docs_src/security/tutorial005_an_py310.py hl[63:66] *} + +Comme nous déclarons maintenant ces scopes, ils apparaîtront dans la documentation de l’API lorsque vous vous authentifiez/autorisez. + +Et vous pourrez sélectionner à quels scopes vous souhaitez accorder l’accès : `me` et `items`. + +C’est le même mécanisme utilisé lorsque vous donnez des permissions en vous connectant avec Facebook, Google, GitHub, etc. : + + + +## Jeton JWT avec scopes { #jwt-token-with-scopes } + +Modifiez maintenant le *chemin d’accès* du jeton pour renvoyer les scopes demandés. + +Nous utilisons toujours le même `OAuth2PasswordRequestForm`. Il inclut une propriété `scopes` avec une `list` de `str`, contenant chaque scope reçu dans la requête. + +Et nous renvoyons les scopes comme partie du jeton JWT. + +/// danger | Danger + +Pour simplifier, ici nous ajoutons directement au jeton les scopes reçus. + +Mais dans votre application, pour la sécurité, vous devez vous assurer de n’ajouter que les scopes que l’utilisateur est réellement autorisé à avoir, ou ceux que vous avez prédéfinis. + +/// + +{* ../../docs_src/security/tutorial005_an_py310.py hl[157] *} + +## Déclarer des scopes dans les chemins d’accès et les dépendances { #declare-scopes-in-path-operations-and-dependencies } + +Nous déclarons maintenant que le *chemin d’accès* `/users/me/items/` nécessite le scope `items`. + +Pour cela, nous importons et utilisons `Security` depuis `fastapi`. + +Vous pouvez utiliser `Security` pour déclarer des dépendances (comme `Depends`), mais `Security` reçoit aussi un paramètre `scopes` avec une liste de scopes (chaînes). + +Dans ce cas, nous passons une fonction de dépendance `get_current_active_user` à `Security` (de la même manière que nous le ferions avec `Depends`). + +Mais nous passons aussi une `list` de scopes, ici avec un seul scope : `items` (il pourrait y en avoir plus). + +Et la fonction de dépendance `get_current_active_user` peut également déclarer des sous-dépendances, non seulement avec `Depends` mais aussi avec `Security`. En déclarant sa propre fonction de sous-dépendance (`get_current_user`), et davantage d’exigences de scopes. + +Dans ce cas, elle nécessite le scope `me` (elle pourrait en exiger plusieurs). + +/// note | Remarque + +Vous n’avez pas nécessairement besoin d’ajouter des scopes différents à différents endroits. + +Nous le faisons ici pour montrer comment **FastAPI** gère des scopes déclarés à différents niveaux. + +/// + +{* ../../docs_src/security/tutorial005_an_py310.py hl[5,141,172] *} + +/// info | Détails techniques + +`Security` est en réalité une sous-classe de `Depends`, et elle n’a qu’un paramètre supplémentaire que nous verrons plus tard. + +Mais en utilisant `Security` au lieu de `Depends`, **FastAPI** saura qu’il peut déclarer des scopes de sécurité, les utiliser en interne et documenter l’API avec OpenAPI. + +Cependant, lorsque vous importez `Query`, `Path`, `Depends`, `Security` et d’autres depuis `fastapi`, ce sont en fait des fonctions qui renvoient des classes spéciales. + +/// + +## Utiliser `SecurityScopes` { #use-securityscopes } + +Mettez maintenant à jour la dépendance `get_current_user`. + +C’est celle utilisée par les dépendances ci-dessus. + +C’est ici que nous utilisons le même schéma OAuth2 que nous avons créé auparavant, en le déclarant comme dépendance : `oauth2_scheme`. + +Comme cette fonction de dépendance n’a pas elle-même d’exigences de scope, nous pouvons utiliser `Depends` avec `oauth2_scheme`, nous n’avons pas à utiliser `Security` quand nous n’avons pas besoin de spécifier des scopes de sécurité. + +Nous déclarons également un paramètre spécial de type `SecurityScopes`, importé de `fastapi.security`. + +Cette classe `SecurityScopes` est similaire à `Request` (`Request` servait à obtenir directement l’objet requête). + +{* ../../docs_src/security/tutorial005_an_py310.py hl[9,106] *} + +## Utiliser les `scopes` { #use-the-scopes } + +Le paramètre `security_scopes` sera de type `SecurityScopes`. + +Il aura une propriété `scopes` avec une liste contenant tous les scopes requis par lui-même et par toutes les dépendances qui l’utilisent comme sous-dépendance. Cela signifie, tous les « dépendants » ... cela peut paraître déroutant, c’est expliqué à nouveau plus bas. + +L’objet `security_scopes` (de classe `SecurityScopes`) fournit aussi un attribut `scope_str` avec une chaîne unique, contenant ces scopes séparés par des espaces (nous allons l’utiliser). + +Nous créons une `HTTPException` que nous pouvons réutiliser (`raise`) plus tard à plusieurs endroits. + +Dans cette exception, nous incluons les scopes requis (le cas échéant) sous forme de chaîne séparée par des espaces (en utilisant `scope_str`). Nous plaçons cette chaîne contenant les scopes dans l’en-tête `WWW-Authenticate` (cela fait partie de la spécification). + +{* ../../docs_src/security/tutorial005_an_py310.py hl[106,108:116] *} + +## Vérifier le `username` et la structure des données { #verify-the-username-and-data-shape } + +Nous vérifions que nous obtenons un `username`, et extrayons les scopes. + +Nous validons ensuite ces données avec le modèle Pydantic (en capturant l’exception `ValidationError`), et si nous obtenons une erreur lors de la lecture du jeton JWT ou de la validation des données avec Pydantic, nous levons la `HTTPException` que nous avons créée auparavant. + +Pour cela, nous mettons à jour le modèle Pydantic `TokenData` avec une nouvelle propriété `scopes`. + +En validant les données avec Pydantic, nous pouvons nous assurer que nous avons, par exemple, exactement une `list` de `str` pour les scopes et un `str` pour le `username`. + +Au lieu, par exemple, d’un `dict`, ou autre chose, ce qui pourrait casser l’application plus tard et constituer un risque de sécurité. + +Nous vérifions également que nous avons un utilisateur avec ce nom d’utilisateur, et sinon, nous levons la même exception que précédemment. + +{* ../../docs_src/security/tutorial005_an_py310.py hl[47,117:129] *} + +## Vérifier les `scopes` { #verify-the-scopes } + +Nous vérifions maintenant que tous les scopes requis, par cette dépendance et tous les dépendants (y compris les *chemins d’accès*), sont inclus dans les scopes fournis dans le jeton reçu, sinon nous levons une `HTTPException`. + +Pour cela, nous utilisons `security_scopes.scopes`, qui contient une `list` avec tous ces scopes en `str`. + +{* ../../docs_src/security/tutorial005_an_py310.py hl[130:136] *} + +## Arbre de dépendances et scopes { #dependency-tree-and-scopes } + +Revoyons encore cet arbre de dépendances et les scopes. + +Comme la dépendance `get_current_active_user` a une sous-dépendance `get_current_user`, le scope « me » déclaré dans `get_current_active_user` sera inclus dans la liste des scopes requis dans `security_scopes.scopes` passé à `get_current_user`. + +Le *chemin d’accès* lui-même déclare également un scope, « items », il sera donc aussi présent dans la liste `security_scopes.scopes` passée à `get_current_user`. + +Voici à quoi ressemble la hiérarchie des dépendances et des scopes : + +* Le *chemin d’accès* `read_own_items` a : + * Des scopes requis `["items"]` avec la dépendance : + * `get_current_active_user` : + * La fonction de dépendance `get_current_active_user` a : + * Des scopes requis `["me"]` avec la dépendance : + * `get_current_user` : + * La fonction de dépendance `get_current_user` a : + * Aucun scope requis par elle-même. + * Une dépendance utilisant `oauth2_scheme`. + * Un paramètre `security_scopes` de type `SecurityScopes` : + * Ce paramètre `security_scopes` a une propriété `scopes` avec une `list` contenant tous les scopes déclarés ci-dessus, donc : + * `security_scopes.scopes` contiendra `["me", "items"]` pour le *chemin d’accès* `read_own_items`. + * `security_scopes.scopes` contiendra `["me"]` pour le *chemin d’accès* `read_users_me`, car il est déclaré dans la dépendance `get_current_active_user`. + * `security_scopes.scopes` contiendra `[]` (rien) pour le *chemin d’accès* `read_system_status`, car il n’a déclaré aucun `Security` avec des `scopes`, et sa dépendance, `get_current_user`, ne déclare pas non plus de `scopes`. + +/// tip | Astuce + +L’élément important et « magique » ici est que `get_current_user` aura une liste différente de `scopes` à vérifier pour chaque *chemin d’accès*. + +Tout dépend des `scopes` déclarés dans chaque *chemin d’accès* et chaque dépendance dans l’arbre de dépendances pour ce *chemin d’accès* spécifique. + +/// + +## Détails supplémentaires sur `SecurityScopes` { #more-details-about-securityscopes } + +Vous pouvez utiliser `SecurityScopes` à n’importe quel endroit, et à de multiples endroits, il n’a pas besoin d’être dans la dépendance « root ». + +Il aura toujours les scopes de sécurité déclarés dans les dépendances `Security` actuelles et tous les dépendants pour **ce** *chemin d’accès* spécifique et **cet** arbre de dépendances spécifique. + +Comme `SecurityScopes` contient tous les scopes déclarés par les dépendants, vous pouvez l’utiliser pour vérifier qu’un jeton possède les scopes requis dans une fonction de dépendance centrale, puis déclarer des exigences de scopes différentes dans différents *chemins d’accès*. + +Elles seront vérifiées indépendamment pour chaque *chemin d’accès*. + +## Tester { #check-it } + +Si vous ouvrez la documentation de l’API, vous pouvez vous authentifier et spécifier quels scopes vous voulez autoriser. + + + +Si vous ne sélectionnez aucun scope, vous serez « authenticated », mais lorsque vous essayerez d’accéder à `/users/me/` ou `/users/me/items/`, vous obtiendrez une erreur indiquant que vous n’avez pas suffisamment de permissions. Vous pourrez toujours accéder à `/status/`. + +Et si vous sélectionnez le scope `me` mais pas le scope `items`, vous pourrez accéder à `/users/me/` mais pas à `/users/me/items/`. + +C’est ce qui arriverait à une application tierce qui tenterait d’accéder à l’un de ces *chemins d’accès* avec un jeton fourni par un utilisateur, selon le nombre de permissions que l’utilisateur a accordées à l’application. + +## À propos des intégrations tierces { #about-third-party-integrations } + +Dans cet exemple, nous utilisons le flux OAuth2 « password ». + +C’est approprié lorsque nous nous connectons à notre propre application, probablement avec notre propre frontend. + +Parce que nous pouvons lui faire confiance pour recevoir le `username` et le `password`, puisque nous le contrôlons. + +Mais si vous construisez une application OAuth2 à laquelle d’autres se connecteraient (c.-à-d., si vous construisez un fournisseur d’authentification équivalent à Facebook, Google, GitHub, etc.), vous devez utiliser l’un des autres flux. + +Le plus courant est le flux implicite. + +Le plus sûr est le flux « code », mais il est plus complexe à implémenter car il nécessite plus d’étapes. Comme il est plus complexe, de nombreux fournisseurs finissent par recommander le flux implicite. + +/// note | Remarque + +Il est courant que chaque fournisseur d’authentification nomme ses flux différemment, pour en faire une partie de sa marque. + +Mais au final, ils implémentent le même standard OAuth2. + +/// + +**FastAPI** inclut des utilitaires pour tous ces flux d’authentification OAuth2 dans `fastapi.security.oauth2`. + +## `Security` dans les dépendances du décorateur `dependencies` { #security-in-decorator-dependencies } + +De la même manière que vous pouvez définir une `list` de `Depends` dans le paramètre `dependencies` du décorateur (comme expliqué dans [Dépendances dans les décorateurs de chemins d’accès](../../tutorial/dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}), vous pouvez aussi utiliser `Security` avec des `scopes` à cet endroit. diff --git a/docs/fr/docs/advanced/settings.md b/docs/fr/docs/advanced/settings.md new file mode 100644 index 0000000000..ed724bf4f6 --- /dev/null +++ b/docs/fr/docs/advanced/settings.md @@ -0,0 +1,302 @@ +# Paramètres et variables d'environnement { #settings-and-environment-variables } + +Dans de nombreux cas, votre application peut avoir besoin de paramètres ou de configurations externes, par exemple des clés secrètes, des identifiants de base de données, des identifiants pour des services d'e-mail, etc. + +La plupart de ces paramètres sont variables (peuvent changer), comme les URL de base de données. Et beaucoup peuvent être sensibles, comme les secrets. + +C'est pourquoi il est courant de les fournir via des variables d'environnement lues par l'application. + +/// tip | Astuce + +Pour comprendre les variables d'environnement, vous pouvez lire [Variables d'environnement](../environment-variables.md){.internal-link target=_blank}. + +/// + +## Types et validation { #types-and-validation } + +Ces variables d'environnement ne gèrent que des chaînes de texte, car elles sont externes à Python et doivent être compatibles avec d'autres programmes et le reste du système (et même avec différents systèmes d'exploitation, comme Linux, Windows, macOS). + +Cela signifie que toute valeur lue en Python depuis une variable d'environnement sera une `str`, et toute conversion vers un autre type ou toute validation doit être effectuée dans le code. + +## Pydantic `Settings` { #pydantic-settings } + +Heureusement, Pydantic fournit un excellent utilitaire pour gérer ces paramètres provenant des variables d'environnement avec Pydantic : gestion des paramètres. + +### Installer `pydantic-settings` { #install-pydantic-settings } + +D'abord, vous devez créer votre [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, l'activer, puis installer le paquet `pydantic-settings` : + +
+ +```console +$ pip install pydantic-settings +---> 100% +``` + +
+ +Il est également inclus lorsque vous installez les extras `all` avec : + +
+ +```console +$ pip install "fastapi[all]" +---> 100% +``` + +
+ +### Créer l'objet `Settings` { #create-the-settings-object } + +Importez `BaseSettings` depuis Pydantic et créez une sous-classe, comme pour un modèle Pydantic. + +De la même manière qu'avec les modèles Pydantic, vous déclarez des attributs de classe avec des annotations de type, et éventuellement des valeurs par défaut. + +Vous pouvez utiliser toutes les mêmes fonctionnalités et outils de validation que pour les modèles Pydantic, comme différents types de données et des validations supplémentaires avec `Field()`. + +{* ../../docs_src/settings/tutorial001_py310.py hl[2,5:8,11] *} + +/// tip | Astuce + +Si vous voulez quelque chose à copier-coller rapidement, n'utilisez pas cet exemple, utilisez le dernier ci-dessous. + +/// + +Ensuite, lorsque vous créez une instance de cette classe `Settings` (dans ce cas, l'objet `settings`), Pydantic lira les variables d'environnement de manière insensible à la casse, donc une variable en majuscules `APP_NAME` sera tout de même lue pour l'attribut `app_name`. + +Il convertira ensuite et validera les données. Ainsi, lorsque vous utilisez cet objet `settings`, vous aurez des données des types que vous avez déclarés (par exemple, `items_per_user` sera un `int`). + +### Utiliser `settings` { #use-the-settings } + +Vous pouvez ensuite utiliser le nouvel objet `settings` dans votre application : + +{* ../../docs_src/settings/tutorial001_py310.py hl[18:20] *} + +### Exécuter le serveur { #run-the-server } + +Ensuite, vous exécutez le serveur en passant les configurations comme variables d'environnement ; par exemple, vous pouvez définir un `ADMIN_EMAIL` et `APP_NAME` avec : + +
+ +```console +$ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp" fastapi run main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +/// tip | Astuce + +Pour définir plusieurs variables d'environnement pour une seule commande, séparez-les simplement par un espace et placez-les toutes avant la commande. + +/// + +Ainsi, le paramètre `admin_email` sera défini sur « deadpool@example.com ». + +Le `app_name` sera « ChimichangApp ». + +Et `items_per_user` conservera sa valeur par défaut de `50`. + +## Paramètres dans un autre module { #settings-in-another-module } + +Vous pouvez placer ces paramètres dans un autre module comme vous l'avez vu dans [Applications plus grandes - Plusieurs fichiers](../tutorial/bigger-applications.md){.internal-link target=_blank}. + +Par exemple, vous pourriez avoir un fichier `config.py` avec : + +{* ../../docs_src/settings/app01_py310/config.py *} + +Puis l'utiliser dans un fichier `main.py` : + +{* ../../docs_src/settings/app01_py310/main.py hl[3,11:13] *} + +/// tip | Astuce + +Vous aurez également besoin d'un fichier `__init__.py` comme vous l'avez vu dans [Applications plus grandes - Plusieurs fichiers](../tutorial/bigger-applications.md){.internal-link target=_blank}. + +/// + +## Paramètres dans une dépendance { #settings-in-a-dependency } + +Dans certains cas, il peut être utile de fournir les paramètres via une dépendance, au lieu d'avoir un objet global `settings` utilisé partout. + +Cela peut être particulièrement utile pendant les tests, car il est très facile de surcharger une dépendance avec vos propres paramètres personnalisés. + +### Le fichier de configuration { #the-config-file } + +En repartant de l'exemple précédent, votre fichier `config.py` pourrait ressembler à : + +{* ../../docs_src/settings/app02_an_py310/config.py hl[10] *} + +Notez que maintenant, nous ne créons pas d'instance par défaut `settings = Settings()`. + +### Le fichier principal de l'application { #the-main-app-file } + +Nous créons maintenant une dépendance qui renvoie un nouveau `config.Settings()`. + +{* ../../docs_src/settings/app02_an_py310/main.py hl[6,12:13] *} + +/// tip | Astuce + +Nous parlerons de `@lru_cache` dans un instant. + +Pour l'instant, vous pouvez supposer que `get_settings()` est une fonction normale. + +/// + +Nous pouvons ensuite l'exiger depuis la fonction de chemin d'accès comme dépendance et l'utiliser où nous en avons besoin. + +{* ../../docs_src/settings/app02_an_py310/main.py hl[17,19:21] *} + +### Paramètres et tests { #settings-and-testing } + +Il devient alors très simple de fournir un autre objet de paramètres pendant les tests en créant une surcharge de dépendance pour `get_settings` : + +{* ../../docs_src/settings/app02_an_py310/test_main.py hl[9:10,13,21] *} + +Dans la surcharge de dépendance, nous définissons une nouvelle valeur pour `admin_email` lors de la création du nouvel objet `Settings`, puis nous renvoyons ce nouvel objet. + +Nous pouvons ensuite tester qu'il est bien utilisé. + +## Lire un fichier `.env` { #reading-a-env-file } + +Si vous avez de nombreux paramètres susceptibles de beaucoup changer, peut-être selon les environnements, il peut être utile de les placer dans un fichier, puis de les lire comme s'il s'agissait de variables d'environnement. + +Cette pratique est suffisamment courante pour avoir un nom ; ces variables d'environnement sont fréquemment placées dans un fichier `.env`, et le fichier est appelé un « dotenv ». + +/// tip | Astuce + +Un fichier commençant par un point (`.`) est un fichier caché dans les systèmes de type Unix, comme Linux et macOS. + +Mais un fichier dotenv n'a pas forcément exactement ce nom de fichier. + +/// + +Pydantic prend en charge la lecture depuis ce type de fichiers en utilisant une bibliothèque externe. Vous pouvez en lire davantage ici : Pydantic Settings : prise en charge de Dotenv (.env). + +/// tip | Astuce + +Pour que cela fonctionne, vous devez exécuter `pip install python-dotenv`. + +/// + +### Le fichier `.env` { #the-env-file } + +Vous pouvez avoir un fichier `.env` avec : + +```bash +ADMIN_EMAIL="deadpool@example.com" +APP_NAME="ChimichangApp" +``` + +### Lire les paramètres depuis `.env` { #read-settings-from-env } + +Puis mettre à jour votre `config.py` avec : + +{* ../../docs_src/settings/app03_an_py310/config.py hl[9] *} + +/// tip | Astuce + +L'attribut `model_config` est utilisé uniquement pour la configuration Pydantic. Vous pouvez en lire davantage ici : Pydantic : Concepts : Configuration. + +/// + +Ici, nous définissons la configuration `env_file` à l'intérieur de votre classe Pydantic `Settings` et lui attribuons le nom du fichier dotenv que nous voulons utiliser. + +### Créer `Settings` une seule fois avec `lru_cache` { #creating-the-settings-only-once-with-lru-cache } + +Lire un fichier depuis le disque est normalement une opération coûteuse (lente), vous voudrez donc probablement le faire une seule fois puis réutiliser le même objet de paramètres, au lieu de le lire à chaque requête. + +Mais chaque fois que nous faisons : + +```Python +Settings() +``` + +un nouvel objet `Settings` serait créé, et à sa création il lirait à nouveau le fichier `.env`. + +Si la fonction de dépendance était simplement : + +```Python +def get_settings(): + return Settings() +``` + +nous créerions cet objet pour chaque requête, et nous lirions le fichier `.env` pour chaque requête. ⚠️ + +Mais comme nous utilisons le décorateur `@lru_cache` au-dessus, l'objet `Settings` sera créé une seule fois, la première fois qu'il est appelé. ✔️ + +{* ../../docs_src/settings/app03_an_py310/main.py hl[1,11] *} + +Ensuite, pour tout appel ultérieur de `get_settings()` dans les dépendances pour les requêtes suivantes, au lieu d'exécuter le code interne de `get_settings()` et de créer un nouvel objet `Settings`, il renverra le même objet que celui retourné au premier appel, encore et encore. + +#### Détails techniques de `lru_cache` { #lru-cache-technical-details } + +`@lru_cache` modifie la fonction qu'il décore pour renvoyer la même valeur que celle qui a été retournée la première fois, au lieu de la recalculer en exécutant le code de la fonction à chaque fois. + +Ainsi, la fonction située en dessous sera exécutée une fois pour chaque combinaison d'arguments. Ensuite, les valeurs renvoyées par chacune de ces combinaisons d'arguments seront réutilisées à chaque fois que la fonction sera appelée avec exactement la même combinaison d'arguments. + +Par exemple, si vous avez une fonction : + +```Python +@lru_cache +def say_hi(name: str, salutation: str = "Ms."): + return f"Hello {salutation} {name}" +``` + +votre programme pourrait s'exécuter comme ceci : + +```mermaid +sequenceDiagram + +participant code as Code +participant function as say_hi() +participant execute as Execute function + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Camila") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Camila") + function ->> code: return stored result + end + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Rick") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Rick", salutation="Mr.") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Rick") + function ->> code: return stored result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Camila") + function ->> code: return stored result + end +``` + +Dans le cas de notre dépendance `get_settings()`, la fonction ne prend même aucun argument, elle renvoie donc toujours la même valeur. + +De cette façon, elle se comporte presque comme s'il s'agissait simplement d'une variable globale. Mais comme elle utilise une fonction de dépendance, nous pouvons alors la surcharger facilement pour les tests. + +`@lru_cache` fait partie de `functools` qui fait partie de la bibliothèque standard de Python, vous pouvez en lire davantage dans la documentation Python pour `@lru_cache`. + +## Récapitulatif { #recap } + +Vous pouvez utiliser Pydantic Settings pour gérer les paramètres ou configurations de votre application, avec toute la puissance des modèles Pydantic. + +* En utilisant une dépendance, vous pouvez simplifier les tests. +* Vous pouvez utiliser des fichiers `.env`. +* Utiliser `@lru_cache` vous permet d'éviter de relire le fichier dotenv à chaque requête, tout en vous permettant de le surcharger pendant les tests. diff --git a/docs/fr/docs/advanced/sub-applications.md b/docs/fr/docs/advanced/sub-applications.md new file mode 100644 index 0000000000..777056040e --- /dev/null +++ b/docs/fr/docs/advanced/sub-applications.md @@ -0,0 +1,67 @@ +# Sous-applications - Montage { #sub-applications-mounts } + +Si vous avez besoin de deux applications FastAPI indépendantes, avec leur propre OpenAPI et leurs propres interfaces de la documentation, vous pouvez avoir une application principale et « monter » une (ou plusieurs) sous‑application(s). + +## Monter une application **FastAPI** { #mounting-a-fastapi-application } + +« Monter » signifie ajouter une application entièrement « indépendante » à un chemin spécifique, qui se chargera ensuite de tout gérer sous ce chemin, avec les _chemins d'accès_ déclarés dans cette sous‑application. + +### Application de premier niveau { #top-level-application } + +Créez d'abord l'application **FastAPI** principale (de premier niveau) et ses *chemins d'accès* : + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[3, 6:8] *} + +### Sous-application { #sub-application } + +Ensuite, créez votre sous‑application et ses *chemins d'accès*. + +Cette sous‑application est simplement une autre application FastAPI standard, mais c'est celle qui sera « montée » : + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 14:16] *} + +### Monter la sous-application { #mount-the-sub-application } + +Dans votre application de premier niveau, `app`, montez la sous‑application, `subapi`. + +Dans ce cas, elle sera montée au chemin `/subapi` : + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 19] *} + +### Vérifier la documentation API automatique { #check-the-automatic-api-docs } + +Exécutez maintenant la commande `fastapi` avec votre fichier : + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Puis ouvrez la documentation à http://127.0.0.1:8000/docs. + +Vous verrez la documentation API automatique pour l'application principale, n'incluant que ses propres _chemins d'accès_ : + + + +Ensuite, ouvrez la documentation de la sous‑application à http://127.0.0.1:8000/subapi/docs. + +Vous verrez la documentation API automatique pour la sous‑application, n'incluant que ses propres _chemins d'accès_, tous sous le préfixe de sous‑chemin correct `/subapi` : + + + +Si vous essayez d'interagir avec l'une ou l'autre des deux interfaces, elles fonctionneront correctement, car le navigateur pourra communiquer avec chaque application ou sous‑application spécifique. + +### Détails techniques : `root_path` { #technical-details-root-path } + +Lorsque vous montez une sous‑application comme ci‑dessus, FastAPI se charge de communiquer le chemin de montage à la sous‑application au moyen d'un mécanisme de la spécification ASGI appelé `root_path`. + +De cette manière, la sous‑application saura utiliser ce préfixe de chemin pour l'interface de documentation. + +La sous‑application peut également avoir ses propres sous‑applications montées et tout fonctionnera correctement, car FastAPI gère automatiquement tous ces `root_path`. + +Vous en apprendrez davantage sur `root_path` et sur la façon de l'utiliser explicitement dans la section [Derrière un proxy](behind-a-proxy.md){.internal-link target=_blank}. diff --git a/docs/fr/docs/advanced/templates.md b/docs/fr/docs/advanced/templates.md new file mode 100644 index 0000000000..7c886ab695 --- /dev/null +++ b/docs/fr/docs/advanced/templates.md @@ -0,0 +1,126 @@ +# Templates { #templates } + +Vous pouvez utiliser n'importe quel moteur de templates avec **FastAPI**. + +Un choix courant est Jinja2, le même que celui utilisé par Flask et d'autres outils. + +Il existe des utilitaires pour le configurer facilement que vous pouvez utiliser directement dans votre application **FastAPI** (fournis par Starlette). + +## Installer les dépendances { #install-dependencies } + +Vous devez créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, l'activer, puis installer `jinja2` : + +
+ +```console +$ pip install jinja2 + +---> 100% +``` + +
+ +## Utiliser `Jinja2Templates` { #using-jinja2templates } + +- Importez `Jinja2Templates`. +- Créez un objet `templates` que vous pourrez réutiliser par la suite. +- Déclarez un paramètre `Request` dans le *chemin d'accès* qui renverra un template. +- Utilisez l'objet `templates` que vous avez créé pour rendre et retourner une `TemplateResponse`, en transmettant le nom du template, l'objet de requête et un dictionnaire de « context » avec des paires clé-valeur à utiliser dans le template Jinja2. + +{* ../../docs_src/templates/tutorial001_py310.py hl[4,11,15:18] *} + +/// note | Remarque + +Avant FastAPI 0.108.0 et Starlette 0.29.0, `name` était le premier paramètre. + +De plus, auparavant, dans les versions précédentes, l'objet `request` faisait partie des paires clé-valeur du contexte pour Jinja2. + +/// + +/// tip | Astuce + +En déclarant `response_class=HTMLResponse`, l'interface de la documentation saura que la réponse sera en HTML. + +/// + +/// note | Détails techniques + +Vous pouvez aussi utiliser `from starlette.templating import Jinja2Templates`. + +**FastAPI** expose le même `starlette.templating` sous `fastapi.templating` par simple commodité pour vous, développeur. Mais la plupart des réponses disponibles proviennent directement de Starlette. C'est également le cas pour `Request` et `StaticFiles`. + +/// + +## Écrire des templates { #writing-templates } + +Vous pouvez ensuite écrire un template dans `templates/item.html`, par exemple : + +```jinja hl_lines="7" +{!../../docs_src/templates/templates/item.html!} +``` + +### Valeurs de contexte du template { #template-context-values } + +Dans le HTML qui contient : + +{% raw %} + +```jinja +Item ID: {{ id }} +``` + +{% endraw %} + +... il affichera l’`id` récupéré à partir du `dict` « context » que vous avez passé : + +```Python +{"id": id} +``` + +Par exemple, avec un ID de `42`, cela rendrait : + +```html +Item ID: 42 +``` + +### Arguments de `url_for` dans le template { #template-url-for-arguments } + +Vous pouvez aussi utiliser `url_for()` dans le template ; elle prend en paramètres les mêmes arguments que ceux utilisés par votre *fonction de chemin d'accès*. + +Ainsi, la section suivante : + +{% raw %} + +```jinja + +``` + +{% endraw %} + +... générera un lien vers la même URL que celle gérée par la *fonction de chemin d'accès* `read_item(id=id)`. + +Par exemple, avec un ID de `42`, cela rendrait : + +```html + +``` + +## Templates et fichiers statiques { #templates-and-static-files } + +Vous pouvez aussi utiliser `url_for()` dans le template, par exemple avec les `StaticFiles` que vous avez montés avec `name="static"`. + +```jinja hl_lines="4" +{!../../docs_src/templates/templates/item.html!} +``` + +Dans cet exemple, cela créera un lien vers un fichier CSS `static/styles.css` avec : + +```CSS hl_lines="4" +{!../../docs_src/templates/static/styles.css!} +``` + +Et comme vous utilisez `StaticFiles`, ce fichier CSS est servi automatiquement par votre application **FastAPI** à l’URL `/static/styles.css`. + +## En savoir plus { #more-details } + +Pour plus de détails, y compris sur la façon de tester des templates, consultez la documentation de Starlette sur les templates. diff --git a/docs/fr/docs/advanced/testing-dependencies.md b/docs/fr/docs/advanced/testing-dependencies.md new file mode 100644 index 0000000000..d6fc576bf6 --- /dev/null +++ b/docs/fr/docs/advanced/testing-dependencies.md @@ -0,0 +1,52 @@ +# Tester des dépendances avec des surcharges { #testing-dependencies-with-overrides } + +## Surcharger des dépendances pendant les tests { #overriding-dependencies-during-testing } + +Il existe des cas où vous souhaiterez surcharger une dépendance pendant les tests. + +Vous ne voulez pas exécuter la dépendance originale (ni ses éventuelles sous‑dépendances). + +À la place, vous souhaitez fournir une dépendance différente, utilisée uniquement pendant les tests (éventuellement seulement pour certains tests), et qui fournira une valeur utilisable partout où l’on utilisait celle de la dépendance originale. + +### Cas d’usage : service externe { #use-cases-external-service } + +Par exemple, vous avez un fournisseur d’authentification externe à appeler. + +Vous lui envoyez un token et il renvoie un utilisateur authentifié. + +Ce fournisseur peut vous facturer à la requête, et l’appeler peut prendre plus de temps que si vous aviez un utilisateur factice fixe pour les tests. + +Vous voudrez probablement tester le fournisseur externe une fois, mais pas nécessairement l’appeler pour chaque test exécuté. + +Dans ce cas, vous pouvez surcharger la dépendance qui appelle ce fournisseur et utiliser une dépendance personnalisée qui renvoie un utilisateur factice, uniquement pour vos tests. + +### Utiliser l’attribut `app.dependency_overrides` { #use-the-app-dependency-overrides-attribute } + +Pour ces cas, votre **FastAPI** application possède un attribut `app.dependency_overrides` ; c’est un simple `dict`. + +Pour surcharger une dépendance lors des tests, vous mettez comme clé la dépendance originale (une fonction) et comme valeur votre surcharge de dépendance (une autre fonction). + +Ensuite, **FastAPI** appellera cette surcharge au lieu de la dépendance originale. + +{* ../../docs_src/dependency_testing/tutorial001_an_py310.py hl[26:27,30] *} + +/// tip | Astuce + +Vous pouvez définir une surcharge de dépendance pour une dépendance utilisée n’importe où dans votre application **FastAPI**. + +La dépendance originale peut être utilisée dans une fonction de chemin d'accès, un décorateur de chemin d'accès (quand vous n’utilisez pas la valeur de retour), un appel à `.include_router()`, etc. + +FastAPI pourra toujours la surcharger. + +/// + +Vous pouvez ensuite réinitialiser vos surcharges (les supprimer) en affectant à `app.dependency_overrides` un `dict` vide : + +```Python +app.dependency_overrides = {} +``` +/// tip | Astuce + +Si vous souhaitez surcharger une dépendance uniquement pendant certains tests, vous pouvez définir la surcharge au début du test (dans la fonction de test) et la réinitialiser à la fin (à la fin de la fonction de test). + +/// diff --git a/docs/fr/docs/advanced/testing-events.md b/docs/fr/docs/advanced/testing-events.md new file mode 100644 index 0000000000..c4f9141b35 --- /dev/null +++ b/docs/fr/docs/advanced/testing-events.md @@ -0,0 +1,11 @@ +# Tester les événements : lifespan et startup - shutdown { #testing-events-lifespan-and-startup-shutdown } + +Lorsque vous avez besoin d'exécuter `lifespan` dans vos tests, vous pouvez utiliser `TestClient` avec une instruction `with` : + +{* ../../docs_src/app_testing/tutorial004_py310.py hl[9:15,18,27:28,30:32,41:43] *} + +Vous pouvez lire plus de détails dans [« Exécuter lifespan dans les tests sur le site de documentation officiel de Starlette. »](https://www.starlette.dev/lifespan/#running-lifespan-in-tests) + +Pour les événements dépréciés `startup` et `shutdown`, vous pouvez utiliser le `TestClient` comme suit : + +{* ../../docs_src/app_testing/tutorial003_py310.py hl[9:12,20:24] *} diff --git a/docs/fr/docs/advanced/testing-websockets.md b/docs/fr/docs/advanced/testing-websockets.md new file mode 100644 index 0000000000..e9f97ab5f2 --- /dev/null +++ b/docs/fr/docs/advanced/testing-websockets.md @@ -0,0 +1,13 @@ +# Tester les WebSockets { #testing-websockets } + +Vous pouvez utiliser le même `TestClient` pour tester les WebSockets. + +Pour cela, vous utilisez `TestClient` dans une instruction `with`, en vous connectant au WebSocket : + +{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *} + +/// note | Remarque + +Pour plus de détails, consultez la documentation de Starlette sur le test des WebSockets. + +/// diff --git a/docs/fr/docs/advanced/using-request-directly.md b/docs/fr/docs/advanced/using-request-directly.md new file mode 100644 index 0000000000..4df3f90e8b --- /dev/null +++ b/docs/fr/docs/advanced/using-request-directly.md @@ -0,0 +1,56 @@ +# Utiliser Request directement { #using-the-request-directly } + +Jusqu'à présent, vous avez déclaré les parties de la requête dont vous avez besoin, avec leurs types. + +En récupérant des données depuis : + +* Le chemin, sous forme de paramètres. +* En-têtes. +* Cookies. +* etc. + +Et ce faisant, **FastAPI** valide ces données, les convertit et génère automatiquement la documentation de votre API. + +Mais il existe des situations où vous pouvez avoir besoin d'accéder directement à l'objet `Request`. + +## Détails sur l'objet `Request` { #details-about-the-request-object } + +Comme **FastAPI** est en fait **Starlette** en dessous, avec une couche de plusieurs outils au-dessus, vous pouvez utiliser directement l'objet `Request` de Starlette lorsque vous en avez besoin. + +Cela signifie aussi que si vous récupérez des données directement à partir de l'objet `Request` (par exemple, lire le corps), elles ne seront pas validées, converties ni documentées (avec OpenAPI, pour l'interface utilisateur automatique de l'API) par FastAPI. + +En revanche, tout autre paramètre déclaré normalement (par exemple, le corps avec un modèle Pydantic) sera toujours validé, converti, annoté, etc. + +Mais il existe des cas spécifiques où il est utile d'obtenir l'objet `Request`. + +## Utiliser l'objet `Request` directement { #use-the-request-object-directly } + +Imaginons que vous souhaitiez obtenir l'adresse IP/l'hôte du client dans votre fonction de chemin d'accès. + +Pour cela, vous devez accéder directement à la requête. + +{* ../../docs_src/using_request_directly/tutorial001_py310.py hl[1,7:8] *} + +En déclarant un paramètre de fonction de chemin d'accès de type `Request`, **FastAPI** saura passer la `Request` dans ce paramètre. + +/// tip | Astuce + +Notez que, dans ce cas, nous déclarons un paramètre de chemin en plus du paramètre de requête. + +Ainsi, le paramètre de chemin sera extrait, validé, converti vers le type spécifié et annoté avec OpenAPI. + +De la même façon, vous pouvez déclarer tout autre paramètre normalement, et en plus, obtenir aussi la `Request`. + +/// + +## Documentation de `Request` { #request-documentation } + +Vous pouvez lire plus de détails sur l'objet `Request` sur le site de documentation officiel de Starlette. + +/// note | Détails techniques + +Vous pouvez également utiliser `from starlette.requests import Request`. + +**FastAPI** le fournit directement pour votre commodité, en tant que développeur. Mais il provient directement de Starlette. + +/// diff --git a/docs/fr/docs/advanced/websockets.md b/docs/fr/docs/advanced/websockets.md new file mode 100644 index 0000000000..6f5c3e7033 --- /dev/null +++ b/docs/fr/docs/advanced/websockets.md @@ -0,0 +1,186 @@ +# WebSockets { #websockets } + +Vous pouvez utiliser API WebSockets avec **FastAPI**. + +## Installer `websockets` { #install-websockets } + +Vous devez créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, l'activer, et installer `websockets` (une bibliothèque Python qui facilite l'utilisation du protocole « WebSocket ») : + +
+ +```console +$ pip install websockets + +---> 100% +``` + +
+ +## Client WebSocket { #websockets-client } + +### En production { #in-production } + +Dans votre système de production, vous avez probablement un frontend créé avec un framework moderne comme React, Vue.js ou Angular. + +Et pour communiquer en utilisant WebSockets avec votre backend, vous utiliseriez probablement les outils fournis par votre frontend. + +Ou vous pouvez avoir une application mobile native qui communique directement avec votre backend WebSocket, en code natif. + +Ou vous pouvez avoir toute autre façon de communiquer avec l'endpoint WebSocket. + +--- + +Mais pour cet exemple, nous utiliserons un document HTML très simple avec un peu de JavaScript, le tout dans une longue chaîne. + +Cela, bien entendu, n'est pas optimal et vous ne l'utiliseriez pas en production. + +En production, vous auriez l'une des options ci-dessus. + +Mais c'est la façon la plus simple de se concentrer sur la partie serveur des WebSockets et d'avoir un exemple fonctionnel : + +{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *} + +## Créer un `websocket` { #create-a-websocket } + +Dans votre application **FastAPI**, créez un `websocket` : + +{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *} + +/// note | Détails techniques + +Vous pourriez aussi utiliser `from starlette.websockets import WebSocket`. + +**FastAPI** fournit le même `WebSocket` directement, simplement pour vous faciliter la vie en tant que développeur. Mais il provient directement de Starlette. + +/// + +## Attendre des messages et envoyer des messages { #await-for-messages-and-send-messages } + +Dans votre route WebSocket, vous pouvez `await` des messages et envoyer des messages. + +{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *} + +Vous pouvez recevoir et envoyer des données binaires, texte et JSON. + +## Essayer { #try-it } + +Si votre fichier s'appelle `main.py`, exécutez votre application avec : + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Ouvrez votre navigateur à l'adresse http://127.0.0.1:8000. + +Vous verrez une page simple comme : + + + +Vous pouvez saisir des messages dans le champ de saisie et les envoyer : + + + +Et votre application **FastAPI** avec WebSockets vous répondra : + + + +Vous pouvez envoyer (et recevoir) de nombreux messages : + + + +Et tous utiliseront la même connexion WebSocket. + +## Utiliser `Depends` et autres { #using-depends-and-others } + +Dans les endpoints WebSocket, vous pouvez importer depuis `fastapi` et utiliser : + +* `Depends` +* `Security` +* `Cookie` +* `Header` +* `Path` +* `Query` + +Ils fonctionnent de la même manière que pour les autres endpoints/*chemins d'accès* FastAPI : + +{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *} + +/// info + +Comme il s'agit d'un WebSocket, il n'est pas vraiment logique de lever une `HTTPException`, nous levons plutôt une `WebSocketException`. + +Vous pouvez utiliser un code de fermeture parmi les codes valides définis dans la spécification. + +/// + +### Essayez les WebSockets avec des dépendances { #try-the-websockets-with-dependencies } + +Si votre fichier s'appelle `main.py`, exécutez votre application avec : + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Ouvrez votre navigateur à l'adresse http://127.0.0.1:8000. + +Là, vous pouvez définir : + +* « Item ID », utilisé dans le chemin. +* « Token » utilisé comme paramètre de requête. + +/// tip | Astuce + +Notez que le `token` de requête sera géré par une dépendance. + +/// + +Avec cela, vous pouvez connecter le WebSocket puis envoyer et recevoir des messages : + + + +## Gérer les déconnexions et plusieurs clients { #handling-disconnections-and-multiple-clients } + +Lorsqu'une connexion WebSocket est fermée, l'instruction `await websocket.receive_text()` lèvera une exception `WebSocketDisconnect`, que vous pouvez ensuite intercepter et gérer comme dans cet exemple. + +{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *} + +Pour l'essayer : + +* Ouvrez l'application dans plusieurs onglets du navigateur. +* Écrivez des messages depuis ceux-ci. +* Puis fermez l'un des onglets. + +Cela lèvera l'exception `WebSocketDisconnect`, et tous les autres clients recevront un message comme : + +``` +Client #1596980209979 left the chat +``` + +/// tip | Astuce + +L'application ci-dessus est un exemple minimal et simple pour montrer comment gérer et diffuser des messages à plusieurs connexions WebSocket. + +Mais gardez à l'esprit que, comme tout est géré en mémoire, dans une seule liste, cela ne fonctionnera que tant que le processus s'exécute et uniquement avec un seul processus. + +Si vous avez besoin de quelque chose de facile à intégrer avec FastAPI mais plus robuste, pris en charge par Redis, PostgreSQL ou autres, consultez encode/broadcaster. + +/// + +## Plus d'informations { #more-info } + +Pour en savoir plus sur les options, consultez la documentation de Starlette concernant : + +* La classe `WebSocket`. +* Gestion des WebSocket basée sur des classes. diff --git a/docs/fr/docs/advanced/wsgi.md b/docs/fr/docs/advanced/wsgi.md new file mode 100644 index 0000000000..fc89819d27 --- /dev/null +++ b/docs/fr/docs/advanced/wsgi.md @@ -0,0 +1,51 @@ +# Inclure WSGI - Flask, Django, autres { #including-wsgi-flask-django-others } + +Vous pouvez monter des applications WSGI comme vous l'avez vu avec [Sous-applications - Montages](sub-applications.md){.internal-link target=_blank}, [Derrière un proxy](behind-a-proxy.md){.internal-link target=_blank}. + +Pour cela, vous pouvez utiliser `WSGIMiddleware` et l'utiliser pour envelopper votre application WSGI, par exemple Flask, Django, etc. + +## Utiliser `WSGIMiddleware` { #using-wsgimiddleware } + +/// info + +Cela nécessite l'installation de `a2wsgi`, par exemple avec `pip install a2wsgi`. + +/// + +Vous devez importer `WSGIMiddleware` depuis `a2wsgi`. + +Ensuite, enveloppez l'application WSGI (par ex. Flask) avec le middleware. + +Puis, montez-la sous un chemin. + +{* ../../docs_src/wsgi/tutorial001_py310.py hl[1,3,23] *} + +/// note | Remarque + +Auparavant, il était recommandé d'utiliser `WSGIMiddleware` depuis `fastapi.middleware.wsgi`, mais il est désormais déprécié. + +Il est conseillé d'utiliser le package `a2wsgi` à la place. L'utilisation reste la même. + +Assurez-vous simplement que le package `a2wsgi` est installé et importez `WSGIMiddleware` correctement depuis `a2wsgi`. + +/// + +## Vérifiez { #check-it } + +Désormais, chaque requête sous le chemin `/v1/` sera gérée par l'application Flask. + +Et le reste sera géré par **FastAPI**. + +Si vous l'exécutez et allez à http://localhost:8000/v1/, vous verrez la réponse de Flask : + +```txt +Hello, World from Flask! +``` + +Et si vous allez à http://localhost:8000/v2, vous verrez la réponse de FastAPI : + +```JSON +{ + "message": "Hello World" +} +``` diff --git a/docs/fr/docs/alternatives.md b/docs/fr/docs/alternatives.md index 9d8d85705c..c344bd1f88 100644 --- a/docs/fr/docs/alternatives.md +++ b/docs/fr/docs/alternatives.md @@ -1,8 +1,8 @@ -# Alternatives, inspiration et comparaisons +# Alternatives, inspiration et comparaisons { #alternatives-inspiration-and-comparisons } Ce qui a inspiré **FastAPI**, comment il se compare à d'autres solutions et ce qu'il en a appris. -## Intro +## Intro { #intro } **FastAPI** n'existerait pas sans les précédentes contributions d'autres projets. @@ -13,11 +13,11 @@ fonctionnalités couvertes par **FastAPI** en utilisant de nombreux frameworks, Mais à un moment donné il n'y avait pas d'autre option que de créer quelque chose qui offrait toutes ces fonctionnalités, en reprenant et en combinant de la meilleure façon possible les meilleures idées des outils -précédents, en utilisant des fonctionnalités du langage qui n'étaient même pas disponibles auparavant (type hints depuis Python 3.6+). +précédents, en utilisant des fonctionnalités du langage qui n'étaient même pas disponibles auparavant (annotations de type depuis Python 3.6+). -## Outils précédents +## Outils précédents { #previous-tools } -### Django +### Django { #django } C'est le framework Python le plus populaire et il bénéficie d'une grande confiance. Il est utilisé pour construire des systèmes tel qu'Instagram. @@ -26,18 +26,18 @@ Il est relativement fortement couplé aux bases de données relationnelles (comm n'est pas très facile d'utiliser une base de données NoSQL (comme Couchbase, MongoDB, Cassandra, etc.) comme principal moyen de stockage. -Il a été créé pour générer le HTML en backend, pas pour créer des API consommées par un frontend moderne (comme React, Vue.js et Angular) ou par d'autres systèmes (comme les appareils IoT) communiquant avec lui. +Il a été créé pour générer le HTML en backend, pas pour créer des API consommées par un frontend moderne (comme React, Vue.js et Angular) ou par d'autres systèmes (comme les appareils IoT) communiquant avec lui. -### Django REST Framework +### Django REST Framework { #django-rest-framework } Django REST framework a été conçu comme une boîte à outils flexible permettant de construire des API Web à partir de Django, afin d'améliorer ses capacités en matière d'API. Il est utilisé par de nombreuses entreprises, dont Mozilla, Red Hat et Eventbrite. Il s'agissait de l'un des premiers exemples de **documentation automatique pour API**, et c'est précisément l'une des -premières idées qui a inspiré "la recherche de" **FastAPI**. +premières idées qui a inspiré « la recherche de » **FastAPI**. -/// note +/// note | Remarque Django REST framework a été créé par Tom Christie. Le créateur de Starlette et Uvicorn, sur lesquels **FastAPI** est basé. @@ -49,9 +49,9 @@ Avoir une interface de documentation automatique de l'API. /// -### Flask +### Flask { #flask } -Flask est un "micro-framework", il ne comprend pas d'intégrations de bases de données ni beaucoup de choses qui sont fournies par défaut dans Django. +Flask est un « micro‑framework », il ne comprend pas d'intégrations de bases de données ni beaucoup de choses qui sont fournies par défaut dans Django. Cette simplicité et cette flexibilité permettent d'utiliser des bases de données NoSQL comme principal système de stockage de données. @@ -60,20 +60,20 @@ technique par moments. Il est aussi couramment utilisé pour d'autres applications qui n'ont pas nécessairement besoin d'une base de données, de gestion des utilisateurs ou de l'une des nombreuses fonctionnalités préinstallées dans Django. Bien que beaucoup de ces fonctionnalités puissent être ajoutées avec des plug-ins. -Ce découplage des parties, et le fait d'être un "micro-framework" qui puisse être étendu pour couvrir exactement ce +Ce découplage des parties, et le fait d'être un « micro‑framework » qui puisse être étendu pour couvrir exactement ce qui est nécessaire, était une caractéristique clé que je voulais conserver. -Compte tenu de la simplicité de Flask, il semblait bien adapté à la création d'API. La prochaine chose à trouver était un "Django REST Framework" pour Flask. +Compte tenu de la simplicité de Flask, il semblait bien adapté à la création d'API. La prochaine chose à trouver était un « Django REST Framework » pour Flask. /// check | A inspiré **FastAPI** à -Être un micro-framework. Il est donc facile de combiner les outils et les pièces nécessaires. +Être un micro‑framework. Il est donc facile de combiner les outils et les pièces nécessaires. Proposer un système de routage simple et facile à utiliser. /// -### Requests +### Requests { #requests } **FastAPI** n'est pas réellement une alternative à **Requests**. Leur cadre est très différent. @@ -97,7 +97,7 @@ La façon dont vous l'utilisez est très simple. Par exemple, pour faire une req response = requests.get("http://example.com/some/url") ``` -En contrepartie l'API _des opérations de chemin_ de FastAPI pourrait ressembler à ceci : +L’opération de chemin d'accès correspondante dans **FastAPI** pourrait ressembler à ceci : ```Python hl_lines="1" @app.get("/some/url") @@ -109,13 +109,13 @@ Notez les similitudes entre `requests.get(...)` et `@app.get(...)`. /// check | A inspiré **FastAPI** à -Avoir une API simple et intuitive. - -Utiliser les noms de méthodes HTTP (opérations) directement, de manière simple et intuitive. \* Avoir des valeurs par défaut raisonnables, mais des personnalisations puissantes. +* Avoir une API simple et intuitive. +* Utiliser les noms de méthodes HTTP (opérations) directement, de manière simple et intuitive. +* Avoir des valeurs par défaut raisonnables, mais des personnalisations puissantes. /// -### Swagger / OpenAPI +### Swagger / OpenAPI { #swagger-openapi } La principale fonctionnalité que j'ai emprunté à Django REST Framework était la documentation automatique des API. @@ -126,7 +126,7 @@ Swagger pour une API permettrait d'utiliser cette interface utilisateur web auto À un moment donné, Swagger a été cédé à la Fondation Linux, puis a été rebaptisé OpenAPI. -C'est pourquoi, lorsqu'on parle de la version 2.0, il est courant de dire "Swagger", et pour la version 3+ "OpenAPI". +C'est pourquoi, lorsqu'on parle de la version 2.0, il est courant de dire « Swagger », et pour la version 3+ « OpenAPI ». /// check | A inspiré **FastAPI** à @@ -141,16 +141,15 @@ Ces deux-là ont été choisis parce qu'ils sont populaires et stables, mais en /// -### Frameworks REST pour Flask +### Frameworks REST pour Flask { #flask-rest-frameworks } Il y a plusieurs frameworks REST pour Flask, mais après avoir investi du temps et du travail pour les étudier, j'ai découvert que le développement de beaucoup d'entre eux sont suspendus ou abandonnés, avec plusieurs problèmes permanents qui les rendent inadaptés. -### Marshmallow +### Marshmallow { #marshmallow } -L'une des principales fonctionnalités nécessaires aux systèmes API est la "sérialisation" des données, qui consiste à prendre les données du code (Python) et à +L'une des principales fonctionnalités nécessaires aux systèmes API est la « sérialisation » des données, qui consiste à prendre les données du code (Python) et à les convertir en quelque chose qui peut être envoyé sur le réseau. Par exemple, convertir un objet contenant des données provenant d'une base de données en un objet JSON. Convertir des objets `datetime` en strings, etc. @@ -163,19 +162,17 @@ Sans un système de validation des données, vous devriez effectuer toutes les v Ces fonctionnalités sont ce pourquoi Marshmallow a été construit. C'est une excellente bibliothèque, et je l'ai déjà beaucoup utilisée. -Mais elle a été créée avant que les type hints n'existent en Python. Ainsi, pour définir chaque schéma, vous devez utiliser des utilitaires et des classes spécifiques fournies par Marshmallow. +Mais elle a été créée avant que les annotations de type n'existent en Python. Ainsi, pour définir chaque schéma, vous devez utiliser des utilitaires et des classes spécifiques fournies par Marshmallow. /// check | A inspiré **FastAPI** à -Utilisez du code pour définir des "schémas" qui fournissent automatiquement les types de données et la validation. +Utilisez du code pour définir des « schémas » qui fournissent automatiquement les types de données et la validation. /// -### Webargs +### Webargs { #webargs } -Une autre grande fonctionnalité requise par les API est le parsing des données provenant des requêtes entrantes. +Une autre grande fonctionnalité requise par les API est l’analyse des données provenant des requêtes entrantes. Webargs est un outil qui a été créé pour fournir cela par-dessus plusieurs frameworks, dont Flask. @@ -195,7 +192,7 @@ Disposer d'une validation automatique des données des requêtes entrantes. /// -### APISpec +### APISpec { #apispec } Marshmallow et Webargs fournissent la validation, l'analyse et la sérialisation en tant que plug-ins. @@ -225,7 +222,7 @@ Supporter la norme ouverte pour les API, OpenAPI. /// -### Flask-apispec +### Flask-apispec { #flask-apispec } C'est un plug-in pour Flask, qui relie Webargs, Marshmallow et APISpec. @@ -240,11 +237,11 @@ Cette combinaison de Flask, Flask-apispec avec Marshmallow et Webargs était ma Son utilisation a conduit à la création de plusieurs générateurs Flask full-stack. Ce sont les principales stacks que j'ai (ainsi que plusieurs équipes externes) utilisées jusqu'à présent : -- https://github.com/tiangolo/full-stack -- https://github.com/tiangolo/full-stack-flask-couchbase -- https://github.com/tiangolo/full-stack-flask-couchdb +* https://github.com/tiangolo/full-stack +* https://github.com/tiangolo/full-stack-flask-couchbase +* https://github.com/tiangolo/full-stack-flask-couchdb -Ces mêmes générateurs full-stack ont servi de base aux [Générateurs de projets pour **FastAPI**](project-generation.md){.internal-link target=\_blank}. +Ces mêmes générateurs full-stack ont servi de base aux [Générateurs de projets pour **FastAPI**](project-generation.md){.internal-link target=_blank}. /// info @@ -258,15 +255,15 @@ Générer le schéma OpenAPI automatiquement, à partir du même code qui défin /// -### NestJS (et Angular) +### NestJS (et Angular) { #nestjs-and-angular } Ce n'est même pas du Python, NestJS est un framework JavaScript (TypeScript) NodeJS inspiré d'Angular. Il réalise quelque chose de similaire à ce qui peut être fait avec Flask-apispec. -Il possède un système d'injection de dépendances intégré, inspiré d'Angular 2. Il nécessite de pré-enregistrer les "injectables" (comme tous les autres systèmes d'injection de dépendances que je connais), donc, cela ajoute à la verbosité et à la répétition du code. +Il possède un système d'injection de dépendances intégré, inspiré d'Angular 2. Il nécessite de pré-enregistrer les « injectables » (comme tous les autres systèmes d'injection de dépendances que je connais), donc, cela ajoute à la verbosité et à la répétition du code. -Comme les paramètres sont décrits avec des types TypeScript (similaires aux type hints de Python), la prise en charge +Comme les paramètres sont décrits avec des types TypeScript (similaires aux annotations de type de Python), la prise en charge par l'éditeur est assez bonne. Mais comme les données TypeScript ne sont pas préservées après la compilation en JavaScript, il ne peut pas compter sur les types pour définir la validation, la sérialisation et la documentation en même temps. En raison de cela et de certaines décisions de conception, pour obtenir la validation, la sérialisation et la génération automatique de schémas, il est nécessaire d'ajouter des décorateurs à de nombreux endroits. Cela devient donc assez verbeux. @@ -281,7 +278,7 @@ Disposer d'un puissant système d'injection de dépendances. Trouver un moyen de /// -### Sanic +### Sanic { #sanic } C'était l'un des premiers frameworks Python extrêmement rapides basés sur `asyncio`. Il a été conçu pour être très similaire à Flask. @@ -301,14 +298,12 @@ C'est pourquoi **FastAPI** est basé sur Starlette, car il s'agit du framework l /// -### Falcon +### Falcon { #falcon } Falcon est un autre framework Python haute performance, il est conçu pour être minimal, et est utilisé comme fondation pour d'autres frameworks comme Hug. -Il utilise le standard précédent pour les frameworks web Python (WSGI) qui est synchrone, donc il ne peut pas gérer les WebSockets et d'autres cas d'utilisation. Néanmoins, il offre de très bonnes performances. - -Il est conçu pour avoir des fonctions qui reçoivent deux paramètres, une "requête" et une "réponse". Ensuite, vous -"lisez" des parties de la requête et "écrivez" des parties dans la réponse. En raison de cette conception, il n'est +Il est conçu pour avoir des fonctions qui reçoivent deux paramètres, une « requête » et une « réponse ». Ensuite, vous +« lisez » des parties de la requête et « écrivez » des parties dans la réponse. En raison de cette conception, il n'est pas possible de déclarer des paramètres de requête et des corps avec des indications de type Python standard comme paramètres de fonction. Ainsi, la validation, la sérialisation et la documentation des données doivent être effectuées dans le code, et non pas automatiquement. Ou bien elles doivent être implémentées comme un framework au-dessus de Falcon, comme Hug. Cette même distinction se retrouve dans d'autres frameworks qui s'inspirent de la conception de Falcon, qui consiste à avoir un objet de requête et un objet de réponse comme paramètres. @@ -323,20 +318,20 @@ Bien que dans FastAPI, il est facultatif, et est utilisé principalement pour d /// -### Molten +### Molten { #molten } J'ai découvert Molten lors des premières étapes de développement de **FastAPI**. Et il a des idées assez similaires : -- Basé sur les type hints Python. -- Validation et documentation via ces types. -- Système d'injection de dépendances. +* Basé sur les annotations de type Python. +* Validation et documentation via ces types. +* Système d'injection de dépendances. Il n'utilise pas une librairie tiers de validation, sérialisation et de documentation tel que Pydantic, il utilise son propre système. Ainsi, ces définitions de types de données ne sont pas réutilisables aussi facilement. -Il nécessite une configuration un peu plus verbeuse. Et comme il est basé sur WSGI (au lieu dASGI), il n'est pas +Il nécessite une configuration un peu plus verbeuse. Et comme il est basé sur WSGI (au lieu d'ASGI), il n'est pas conçu pour profiter des hautes performances fournies par des outils comme Uvicorn, Starlette et Sanic. -Le système d'injection de dépendances exige le pré-enregistrement des dépendances et les dépendances sont résolues sur la base des types déclarés. Ainsi, il n'est pas possible de déclarer plus d'un "composant" qui fournit un certain type. +Le système d'injection de dépendances exige le pré-enregistrement des dépendances et les dépendances sont résolues sur la base des types déclarés. Ainsi, il n'est pas possible de déclarer plus d'un « composant » qui fournit un certain type. Les routes sont déclarées à un seul endroit, en utilisant des fonctions déclarées à d'autres endroits (au lieu d'utiliser des décorateurs qui peuvent être placés juste au-dessus de la fonction qui gère l'endpoint). Cette @@ -345,15 +340,15 @@ qui sont relativement fortement couplées. /// check | A inspiré **FastAPI** à -Définir des validations supplémentaires pour les types de données utilisant la valeur "par défaut" des attributs du modèle. Ceci améliore le support de l'éditeur, et n'était pas disponible dans Pydantic auparavant. +Définir des validations supplémentaires pour les types de données utilisant la valeur « par défaut » des attributs du modèle. Ceci améliore le support de l'éditeur, et n'était pas disponible dans Pydantic auparavant. Cela a en fait inspiré la mise à jour de certaines parties de Pydantic, afin de supporter le même style de déclaration de validation (toute cette fonctionnalité est maintenant déjà disponible dans Pydantic). /// -### Hug +### Hug { #hug } -Hug a été l'un des premiers frameworks à implémenter la déclaration des types de paramètres d'API en utilisant les type hints Python. C'était une excellente idée qui a inspiré d'autres outils à faire de même. +Hug a été l'un des premiers frameworks à implémenter la déclaration des types de paramètres d'API en utilisant les annotations de type Python. C'était une excellente idée qui a inspiré d'autres outils à faire de même. Il utilisait des types personnalisés dans ses déclarations au lieu des types Python standard, mais c'était tout de même un énorme pas en avant. @@ -372,28 +367,28 @@ Hug a été créé par Timothy Crosley, le créateur de APIStar (<= 0.5) +### APIStar (<= 0.5) { #apistar-0-5 } Juste avant de décider de développer **FastAPI**, j'ai trouvé le serveur **APIStar**. Il contenait presque tout ce que je recherchais et avait un beau design. -C'était l'une des premières implémentations d'un framework utilisant les type hints Python pour déclarer les paramètres +C'était l'une des premières implémentations d'un framework utilisant les annotations de type Python pour déclarer les paramètres et les requêtes que j'ai vues (avant NestJS et Molten). Je l'ai trouvé plus ou moins en même temps que Hug. Mais APIStar utilisait le standard OpenAPI. -Il disposait de la validation automatique, sérialisation des données et d'une génération de schéma OpenAPI basée sur les mêmes type hints à plusieurs endroits. +Il disposait de la validation automatique, sérialisation des données et d'une génération de schéma OpenAPI basée sur les mêmes annotations de type à plusieurs endroits. -La définition du schéma de corps de requête n'utilisait pas les mêmes type hints Python que Pydantic, il était un peu plus proche de Marshmallow, donc le support de l'éditeur n'était pas aussi bon, mais APIStar était quand même la meilleure option disponible. +La définition du schéma de corps de requête n'utilisait pas les mêmes annotations de type Python que Pydantic, il était un peu plus proche de Marshmallow, donc le support de l'éditeur n'était pas aussi bon, mais APIStar était quand même la meilleure option disponible. Il avait les meilleures performances d'après les benchmarks de l'époque (seulement surpassé par Starlette). @@ -429,20 +424,20 @@ Et après avoir longtemps cherché un framework similaire et testé de nombreuse Puis APIStar a cessé d'exister en tant que serveur et Starlette a été créé, et a constitué une meilleure base pour un tel système. Ce fut l'inspiration finale pour construire **FastAPI**. -Je considère **FastAPI** comme un "successeur spirituel" d'APIStar, tout en améliorant et en augmentant les fonctionnalités, le système de typage et d'autres parties, sur la base des enseignements tirés de tous ces outils précédents. +Je considère **FastAPI** comme un « successeur spirituel » d'APIStar, tout en améliorant et en augmentant les fonctionnalités, le système de typage et d'autres parties, sur la base des enseignements tirés de tous ces outils précédents. /// -## Utilisés par **FastAPI** +## Utilisés par **FastAPI** { #used-by-fastapi } -### Pydantic +### Pydantic { #pydantic } -Pydantic est une bibliothèque permettant de définir la validation, la sérialisation et la documentation des données (à l'aide de JSON Schema) en se basant sur les Python type hints. +Pydantic est une bibliothèque permettant de définir la validation, la sérialisation et la documentation des données (à l'aide de JSON Schema) en se basant sur les annotations de type Python. Cela le rend extrêmement intuitif. Il est comparable à Marshmallow. Bien qu'il soit plus rapide que Marshmallow dans les benchmarks. Et comme il est -basé sur les mêmes type hints Python, le support de l'éditeur est grand. +basé sur les mêmes annotations de type Python, le support de l'éditeur est grand. /// check | **FastAPI** l'utilise pour @@ -452,9 +447,9 @@ Gérer toute la validation des données, leur sérialisation et la documentation /// -### Starlette +### Starlette { #starlette } -Starlette est un framework/toolkit léger ASGI, qui est idéal pour construire des services asyncio performants. +Starlette est un framework/toolkit léger ASGI, qui est idéal pour construire des services asyncio performants. Il est très simple et intuitif. Il est conçu pour être facilement extensible et avoir des composants modulaires. @@ -462,29 +457,28 @@ Il offre : - Des performances vraiment impressionnantes. - Le support des WebSockets. -- Le support de GraphQL. - Les tâches d'arrière-plan. - Les événements de démarrage et d'arrêt. -- Un client de test basé sur request. +- Un client de test basé sur HTTPX. - CORS, GZip, fichiers statiques, streaming des réponses. - Le support des sessions et des cookies. - Une couverture de test à 100 %. - 100 % de la base de code avec des annotations de type. -- Zéro forte dépendance à d'autres packages. +- Peu de dépendances strictes. Starlette est actuellement le framework Python le plus rapide testé. Seulement dépassé par Uvicorn, qui n'est pas un framework, mais un serveur. -Starlette fournit toutes les fonctionnalités de base d'un micro-framework web. +Starlette fournit toutes les fonctionnalités de base d'un micro‑framework web. Mais il ne fournit pas de validation automatique des données, de sérialisation ou de documentation. -C'est l'une des principales choses que **FastAPI** ajoute par-dessus, le tout basé sur les type hints Python (en utilisant Pydantic). Cela, plus le système d'injection de dépendances, les utilitaires de sécurité, la génération de schémas OpenAPI, etc. +C'est l'une des principales choses que **FastAPI** ajoute par-dessus, le tout basé sur les annotations de type Python (en utilisant Pydantic). Cela, plus le système d'injection de dépendances, les utilitaires de sécurité, la génération de schémas OpenAPI, etc. /// note | Détails techniques -ASGI est une nouvelle "norme" développée par les membres de l'équipe principale de Django. Il ne s'agit pas encore d'une "norme Python" (un PEP), bien qu'ils soient en train de le faire. +ASGI est une nouvelle « norme » développée par les membres de l'équipe principale de Django. Il ne s'agit pas encore d'une « norme Python » (un PEP), bien qu'ils soient en train de le faire. -Néanmoins, il est déjà utilisé comme "standard" par plusieurs outils. Cela améliore grandement l'interopérabilité, puisque vous pouvez remplacer Uvicorn par n'importe quel autre serveur ASGI (comme Daphne ou Hypercorn), ou vous pouvez ajouter des outils compatibles ASGI, comme `python-socketio`. +Néanmoins, il est déjà utilisé comme « standard » par plusieurs outils. Cela améliore grandement l'interopérabilité, puisque vous pouvez remplacer Uvicorn par n'importe quel autre serveur ASGI (comme Daphne ou Hypercorn), ou vous pouvez ajouter des outils compatibles ASGI, comme `python-socketio`. /// @@ -498,7 +492,7 @@ Ainsi, tout ce que vous pouvez faire avec Starlette, vous pouvez le faire direct /// -### Uvicorn +### Uvicorn { #uvicorn } Uvicorn est un serveur ASGI rapide comme l'éclair, basé sur uvloop et httptools. @@ -511,12 +505,12 @@ C'est le serveur recommandé pour Starlette et **FastAPI**. Le serveur web principal pour exécuter les applications **FastAPI**. -Vous pouvez le combiner avec Gunicorn, pour avoir un serveur multi-processus asynchrone. +Vous pouvez également utiliser l'option de ligne de commande `--workers` pour avoir un serveur multi‑processus asynchrone. Pour plus de détails, consultez la section [Déploiement](deployment/index.md){.internal-link target=_blank}. /// -## Benchmarks et vitesse +## Benchmarks et vitesse { #benchmarks-and-speed } -Pour comprendre, comparer et voir la différence entre Uvicorn, Starlette et FastAPI, consultez la section sur les [Benchmarks](benchmarks.md){.internal-link target=\_blank}. +Pour comprendre, comparer et voir la différence entre Uvicorn, Starlette et FastAPI, consultez la section sur les [Benchmarks](benchmarks.md){.internal-link target=_blank}. diff --git a/docs/fr/docs/async.md b/docs/fr/docs/async.md index 1437ae5176..72923e03b0 100644 --- a/docs/fr/docs/async.md +++ b/docs/fr/docs/async.md @@ -1,17 +1,18 @@ -# Concurrence et les mots-clés async et await +# Concurrence et async / await { #concurrency-and-async-await } -Cette page vise à fournir des détails sur la syntaxe `async def` pour les *fonctions de chemins* et quelques rappels sur le code asynchrone, la concurrence et le parallélisme. +Détails sur la syntaxe `async def` pour les *fonctions de chemin d'accès* et quelques rappels sur le code asynchrone, la concurrence et le parallélisme. -## Vous êtes pressés ? +## Vous êtes pressés ? { #in-a-hurry } -TL;DR : +TL;DR : Si vous utilisez des bibliothèques tierces qui nécessitent d'être appelées avec `await`, telles que : ```Python results = await some_library() ``` -Alors, déclarez vos *fonctions de chemins* avec `async def` comme ceci : + +Alors, déclarez vos *fonctions de chemin d'accès* avec `async def` comme ceci : ```Python hl_lines="2" @app.get('/') @@ -20,7 +21,7 @@ async def read_results(): return results ``` -/// note +/// note | Remarque Vous pouvez uniquement utiliser `await` dans les fonctions créées avec `async def`. @@ -28,7 +29,7 @@ Vous pouvez uniquement utiliser `await` dans les fonctions créées avec `async --- -Si vous utilisez une bibliothèque externe qui communique avec quelque chose (une BDD, une API, un système de fichiers, etc.) et qui ne supporte pas l'utilisation d'`await` (ce qui est actuellement le cas pour la majorité des bibliothèques de BDD), alors déclarez vos *fonctions de chemin* normalement, avec le classique `def`, comme ceci : +Si vous utilisez une bibliothèque externe qui communique avec quelque chose (une base de données, une API, le système de fichiers, etc.) et qui ne supporte pas l'utilisation d'`await` (ce qui est actuellement le cas pour la majorité des bibliothèques de base de données), alors déclarez vos *fonctions de chemin d'accès* normalement, avec le classique `def`, comme ceci : ```Python hl_lines="2" @app.get('/') @@ -39,7 +40,7 @@ def results(): --- -Si votre application n'a pas à communiquer avec une bibliothèque externe et pas à attendre de réponse, utilisez `async def`. +Si votre application n'a pas à communiquer avec une autre chose et à attendre sa réponse, utilisez `async def`, même si vous n'avez pas besoin d'utiliser `await` à l'intérieur. --- @@ -47,15 +48,15 @@ Si vous ne savez pas, utilisez seulement `def` comme vous le feriez habituelleme --- -**Note** : vous pouvez mélanger `def` et `async def` dans vos *fonctions de chemin* autant que nécessaire, **FastAPI** saura faire ce qu'il faut avec. +Note : vous pouvez mélanger `def` et `async def` dans vos *fonctions de chemin d'accès* autant que nécessaire, et définir chacune avec l’option la plus adaptée pour vous. FastAPI fera ce qu'il faut avec elles. -Au final, peu importe le cas parmi ceux ci-dessus, **FastAPI** fonctionnera de manière asynchrone et sera extrêmement rapide. +Au final, peu importe le cas parmi ceux ci-dessus, FastAPI fonctionnera de manière asynchrone et sera extrêmement rapide. -Mais si vous suivez bien les instructions ci-dessus, alors **FastAPI** pourra effectuer quelques optimisations et ainsi améliorer les performances. +Mais si vous suivez bien les instructions ci-dessus, il pourra effectuer quelques optimisations et ainsi améliorer les performances. -## Détails techniques +## Détails techniques { #technical-details } -Les versions modernes de Python supportent le **code asynchrone** grâce aux **"coroutines"** avec les syntaxes **`async` et `await`**. +Les versions modernes de Python supportent le **code asynchrone** grâce aux **« coroutines »** avec les syntaxes **`async` et `await`**. Analysons les différentes parties de cette phrase dans les sections suivantes : @@ -63,46 +64,46 @@ Analysons les différentes parties de cette phrase dans les sections suivantes : * **`async` et `await`** * **Coroutines** -## Code asynchrone +## Code asynchrone { #asynchronous-code } -Faire du code asynchrone signifie que le langage 💬 est capable de dire à l'ordinateur / au programme 🤖 qu'à un moment du code, il 🤖 devra attendre que *quelque chose d'autre* se termine autre part. Disons que ce *quelque chose d'autre* est appelé "fichier-lent" 📝. +Faire du code asynchrone signifie que le langage 💬 est capable de dire à l'ordinateur / au programme 🤖 qu'à un moment du code, il 🤖 devra attendre que *quelque chose d'autre* se termine autre part. Disons que ce *quelque chose d'autre* est appelé « slow-file » 📝. -Donc, pendant ce temps, l'ordinateur pourra effectuer d'autres tâches, pendant que "fichier-lent" 📝 se termine. +Donc, pendant ce temps, l'ordinateur pourra effectuer d'autres tâches, pendant que « slow-file » 📝 se termine. Ensuite l'ordinateur / le programme 🤖 reviendra à chaque fois qu'il en a la chance que ce soit parce qu'il attend à nouveau, ou car il 🤖 a fini tout le travail qu'il avait à faire. Il 🤖 regardera donc si les tâches qu'il attend ont terminé d'être effectuées. -Ensuite, il 🤖 prendra la première tâche à finir (disons, notre "fichier-lent" 📝) et continuera à faire avec cette dernière ce qu'il était censé. +Ensuite, il 🤖 prendra la première tâche à finir (disons, notre « slow-file » 📝) et continuera à faire avec cette dernière ce qu'il était censé. -Ce "attendre quelque chose d'autre" fait généralement référence à des opérations I/O qui sont relativement "lentes" (comparées à la vitesse du processeur et de la mémoire RAM) telles qu'attendre que : +Ce « attendre quelque chose d'autre » fait généralement référence à des opérations I/O qui sont relativement « lentes » (comparées à la vitesse du processeur et de la mémoire RAM) telles qu'attendre que : * de la donnée soit envoyée par le client à travers le réseau * de la donnée envoyée depuis votre programme soit reçue par le client à travers le réseau * le contenu d'un fichier sur le disque soit lu par le système et passé à votre programme * le contenu que votre programme a passé au système soit écrit sur le disque * une opération effectuée à distance par une API se termine -* une opération en BDD se termine -* une requête à une BDD renvoie un résultat +* une opération en base de données se termine +* une requête à une base de données renvoie un résultat * etc. -Le temps d'exécution étant consommé majoritairement par l'attente d'opérations I/O on appelle ceci des opérations "I/O bound". +Le temps d'exécution étant consommé majoritairement par l'attente d'opérations I/O, on appelle ceci des opérations « I/O bound ». -Ce concept se nomme l'"asynchronisme" car l'ordinateur / le programme n'a pas besoin d'être "synchronisé" avec la tâche, attendant le moment exact où cette dernière se terminera en ne faisant rien, pour être capable de récupérer le résultat de la tâche et l'utiliser dans la suite des opérations. +Ce concept se nomme « asynchrone » car l'ordinateur / le programme n'a pas besoin d'être « synchronisé » avec la tâche, attendant le moment exact où cette dernière se terminera en ne faisant rien, pour être capable de récupérer le résultat de la tâche et l'utiliser dans la suite des opérations. -À la place, en étant "asynchrone", une fois terminée, une tâche peut légèrement attendre (quelques microsecondes) que l'ordinateur / le programme finisse ce qu'il était en train de faire, et revienne récupérer le résultat. +À la place, en étant « asynchrone », une fois terminée, une tâche peut légèrement attendre (quelques microsecondes) que l'ordinateur / le programme finisse ce qu'il était en train de faire, et revienne récupérer le résultat. -Pour parler de tâches "synchrones" (en opposition à "asynchrones"), on utilise souvent le terme "séquentiel", car l'ordinateur / le programme va effectuer toutes les étapes d'une tâche séquentiellement avant de passer à une autre tâche, même si ces étapes impliquent de l'attente. +Pour parler de tâches « synchrones » (en opposition à « asynchrones »), on utilise souvent le terme « séquentiel », car l'ordinateur / le programme va effectuer toutes les étapes d'une tâche séquentiellement avant de passer à une autre tâche, même si ces étapes impliquent de l'attente. -### Concurrence et Burgers +### Concurrence et Burgers { #concurrency-and-burgers } -L'idée de code **asynchrone** décrite ci-dessus est parfois aussi appelée **"concurrence"**. Ce qui est différent du **"parallélisme"**. +L'idée de code **asynchrone** décrite ci-dessus est parfois aussi appelée **« concurrence »**. Ce qui est différent du **« parallélisme »**. -La **concurrence** et le **parallélisme** sont tous deux liés à l'idée de "différentes choses arrivant plus ou moins au même moment". +La **concurrence** et le **parallélisme** sont tous deux liés à l'idée de « différentes choses arrivant plus ou moins au même moment ». Mais les détails entre la **concurrence** et le **parallélisme** diffèrent sur de nombreux points. Pour expliquer la différence, voici une histoire de burgers : -#### Burgers concurrents +### Burgers concurrents { #concurrent-burgers } Vous amenez votre crush 😍 dans votre fast food 🍔 favori, et faites la queue pendant que le serveur 💁 prend les commandes des personnes devant vous. @@ -122,13 +123,13 @@ Le serveur 💁 vous donne le numéro assigné à votre commande. -Pendant que vous attendez, vous allez choisir une table avec votre crush 😍, vous discutez avec votre crush 😍 pendant un long moment (les burgers étant "magnifiques" ils sont très longs à préparer ✨🍔✨). +Pendant que vous attendez, vous allez choisir une table avec votre crush 😍, vous discutez avec votre crush 😍 pendant un long moment (les burgers étant « magnifiques » ils sont très longs à préparer ✨🍔✨). Pendant que vous êtes assis à table, en attendant que les burgers 🍔 soient prêts, vous pouvez passer ce temps à admirer à quel point votre crush 😍 est géniale, mignonne et intelligente ✨😍✨. -Pendant que vous discutez avec votre crush 😍, de temps en temps vous jetez un coup d'oeil au nombre affiché au-dessus du comptoir pour savoir si c'est à votre tour d'être servis. +Pendant que vous discutez avec votre crush 😍, de temps en temps vous jetez un coup d’œil au nombre affiché au-dessus du comptoir pour savoir si c'est à votre tour d'être servis. Jusqu'au moment où c'est (enfin) votre tour. Vous allez au comptoir, récupérez vos burgers 🍔 et revenez à votre table. @@ -148,23 +149,23 @@ Illustrations proposées par @@ -212,7 +213,7 @@ Illustrations proposées par (tout ça grâce à Starlette). +Et comme on peut avoir du parallélisme et de l'asynchronicité en même temps, on obtient des performances plus hautes que la plupart des frameworks NodeJS testés et égales à celles du Go, qui est un langage compilé plus proche du C (tout ça grâce à Starlette). -### Est-ce que la concurrence est mieux que le parallélisme ? +### Est-ce que la concurrence est mieux que le parallélisme ? { #is-concurrency-better-than-parallelism } Nope ! C'est ça la morale de l'histoire. @@ -276,11 +277,11 @@ Mais dans ce cas, si pouviez amener 8 ex-serveurs/cuisiniers/devenus-nettoyeurs Dans ce scénario, chacun des nettoyeurs (vous y compris) serait un processeur, faisant sa partie du travail. -Et comme la plupart du temps d'exécution est pris par du "vrai" travail (et non de l'attente), et que le travail dans un ordinateur est fait par un CPU, ce sont des problèmes dits "CPU bound". +Et comme la plupart du temps d'exécution est pris par du « vrai » travail (et non de l'attente), et que le travail dans un ordinateur est fait par un CPU, ce sont des problèmes dits « CPU bound ». --- -Des exemples communs d'opérations "CPU bounds" sont les procédés qui requièrent des traitements mathématiques complexes. +Des exemples communs d'opérations « CPU bound » sont les procédés qui requièrent des traitements mathématiques complexes. Par exemple : @@ -289,19 +290,19 @@ Par exemple : * L'apprentissage automatique (ou **Machine Learning**) : cela nécessite de nombreuses multiplications de matrices et vecteurs. Imaginez une énorme feuille de calcul remplie de nombres que vous multiplierez entre eux tous au même moment. * L'apprentissage profond (ou **Deep Learning**) : est un sous-domaine du **Machine Learning**, donc les mêmes raisons s'appliquent. Avec la différence qu'il n'y a pas une unique feuille de calcul de nombres à multiplier, mais une énorme quantité d'entre elles, et dans de nombreux cas, on utilise un processeur spécial pour construire et / ou utiliser ces modèles. -### Concurrence + Parallélisme : Web + Machine Learning +### Concurrence + Parallélisme : Web + Machine Learning { #concurrency-parallelism-web-machine-learning } Avec **FastAPI** vous pouvez bénéficier de la concurrence qui est très courante en développement web (c'est l'attrait principal de NodeJS). -Mais vous pouvez aussi profiter du parallélisme et multiprocessing afin de gérer des charges **CPU bound** qui sont récurrentes dans les systèmes de *Machine Learning*. +Mais vous pouvez aussi profiter du parallélisme et du multiprocessing (plusieurs processus s'exécutant en parallèle) afin de gérer des charges **CPU bound** qui sont récurrentes dans les systèmes de *Machine Learning*. Ça, ajouté au fait que Python soit le langage le plus populaire pour la **Data Science**, le **Machine Learning** et surtout le **Deep Learning**, font de **FastAPI** un très bon choix pour les APIs et applications de **Data Science** / **Machine Learning**. Pour comprendre comment mettre en place ce parallélisme en production, allez lire la section [Déploiement](deployment/index.md){.internal-link target=_blank}. -## `async` et `await` +## `async` et `await` { #async-and-await } -Les versions modernes de Python ont une manière très intuitive de définir le code asynchrone, tout en gardant une apparence de code "séquentiel" classique en laissant Python faire l'attente pour vous au bon moment. +Les versions modernes de Python ont une manière très intuitive de définir le code asynchrone, tout en gardant une apparence de code « séquentiel » classique en laissant Python faire l'attente pour vous au bon moment. Pour une opération qui nécessite de l'attente avant de donner un résultat et qui supporte ces nouvelles fonctionnalités Python, vous pouvez l'utiliser comme tel : @@ -319,12 +320,12 @@ async def get_burgers(number: int): return burgers ``` -...et non `def` : +... et non `def` : ```Python hl_lines="2" # Ceci n'est pas asynchrone def get_sequential_burgers(number: int): - # Opérations asynchrones pour créer les burgers + # Opérations séquentielles pour créer les burgers return burgers ``` @@ -339,7 +340,7 @@ burgers = get_burgers(2) --- -Donc, si vous utilisez une bibliothèque qui nécessite que ses fonctions soient appelées avec `await`, vous devez définir la *fonction de chemin* en utilisant `async def` comme dans : +Donc, si vous utilisez une bibliothèque qui nécessite que ses fonctions soient appelées avec `await`, vous devez définir la *fonction de chemin d'accès* en utilisant `async def` comme dans : ```Python hl_lines="2-3" @app.get('/burgers') @@ -348,52 +349,61 @@ async def read_burgers(): return burgers ``` -### Plus de détails techniques +### Plus de détails techniques { #more-technical-details } Vous avez donc compris que `await` peut seulement être utilisé dans des fonctions définies avec `async def`. Mais en même temps, les fonctions définies avec `async def` doivent être appelées avec `await` et donc dans des fonctions définies elles aussi avec `async def`. -Vous avez donc remarqué ce paradoxe d'oeuf et de la poule, comment appelle-t-on la première fonction `async` ? +Vous avez donc remarqué ce paradoxe d'œuf et de la poule, comment appelle-t-on la première fonction `async` ? -Si vous utilisez **FastAPI**, pas besoin de vous en inquiéter, car cette "première" fonction sera votre *fonction de chemin* ; et **FastAPI** saura comment arriver au résultat attendu. +Si vous utilisez **FastAPI**, pas besoin de vous en inquiéter, car cette « première » fonction sera votre *fonction de chemin d'accès* ; et **FastAPI** saura comment arriver au résultat attendu. -Mais si vous utilisez `async` / `await` sans **FastAPI**, allez jetez un coup d'oeil à la documentation officielle de Python. +Mais si vous souhaitez utiliser `async` / `await` sans FastAPI, vous pouvez également le faire. -### Autres formes de code asynchrone +### Écrire votre propre code async { #write-your-own-async-code } + +Starlette (et **FastAPI**) s’appuie sur AnyIO, ce qui le rend compatible à la fois avec la bibliothèque standard asyncio de Python et avec Trio. + +En particulier, vous pouvez utiliser directement AnyIO pour vos cas d’usage de concurrence avancés qui nécessitent des schémas plus élaborés dans votre propre code. + +Et même si vous n’utilisiez pas FastAPI, vous pourriez aussi écrire vos propres applications async avec AnyIO pour une grande compatibilité et pour bénéficier de ses avantages (par ex. la « structured concurrency »). + +J’ai créé une autre bibliothèque au-dessus d’AnyIO, comme une fine surcouche, pour améliorer un peu les annotations de type et obtenir une meilleure **autocomplétion**, des **erreurs en ligne**, etc. Elle propose également une introduction et un tutoriel accessibles pour vous aider à **comprendre** et écrire **votre propre code async** : Asyncer. Elle sera particulièrement utile si vous devez **combiner du code async avec du code classique** (bloquant/synchrone). + +### Autres formes de code asynchrone { #other-forms-of-asynchronous-code } L'utilisation d'`async` et `await` est relativement nouvelle dans ce langage. Mais cela rend la programmation asynchrone bien plus simple. -Cette même syntaxe (ou presque) était aussi incluse dans les versions modernes de Javascript (dans les versions navigateur et NodeJS). +Cette même syntaxe (ou presque) a aussi été incluse récemment dans les versions modernes de JavaScript (dans les navigateurs et NodeJS). Mais avant ça, gérer du code asynchrone était bien plus complexe et difficile. -Dans les versions précédentes de Python, vous auriez utilisé des *threads* ou Gevent. Mais le code aurait été bien plus difficile à comprendre, débugger, et concevoir. +Dans les versions précédentes de Python, vous auriez utilisé des threads ou Gevent. Mais le code aurait été bien plus difficile à comprendre, débugger, et concevoir. -Dans les versions précédentes de Javascript NodeJS / Navigateur, vous auriez utilisé des "callbacks". Menant potentiellement à ce que l'on appelle le "callback hell". +Dans les versions précédentes de JavaScript côté navigateur / NodeJS, vous auriez utilisé des « callbacks ». Menant potentiellement à ce que l'on appelle le « callback hell ». +## Coroutines { #coroutines } -## Coroutines +« Coroutine » est juste un terme élaboré pour désigner ce qui est retourné par une fonction définie avec `async def`. Python sait que c'est comme une fonction classique qui va démarrer à un moment et terminer à un autre, mais qu'elle peut aussi être mise en pause ⏸, du moment qu'il y a un `await` dans son contenu. -**Coroutine** est juste un terme élaboré pour désigner ce qui est retourné par une fonction définie avec `async def`. Python sait que c'est comme une fonction classique qui va démarrer à un moment et terminer à un autre, mais qu'elle peut aussi être mise en pause ⏸, du moment qu'il y a un `await` dans son contenu. +Mais toutes ces fonctionnalités d'utilisation de code asynchrone avec `async` et `await` sont souvent résumées comme l'utilisation des « coroutines ». On peut comparer cela à la principale fonctionnalité clé de Go, les « Goroutines ». -Mais toutes ces fonctionnalités d'utilisation de code asynchrone avec `async` et `await` sont souvent résumées comme l'utilisation des *coroutines*. On peut comparer cela à la principale fonctionnalité clé de Go, les "Goroutines". - -## Conclusion +## Conclusion { #conclusion } Reprenons la phrase du début de la page : -> Les versions modernes de Python supportent le **code asynchrone** grâce aux **"coroutines"** avec les syntaxes **`async` et `await`**. +> Les versions modernes de Python supportent le **code asynchrone** grâce aux **« coroutines »** avec les syntaxes **`async` et `await`**. Ceci devrait être plus compréhensible désormais. ✨ -Tout ceci est donc ce qui donne sa force à **FastAPI** (à travers Starlette) et lui permet d'avoir des performances aussi impressionnantes. +Tout ceci est donc ce qui donne sa force à FastAPI (à travers Starlette) et lui permet d'avoir une performance aussi impressionnante. -## Détails très techniques +## Détails très techniques { #very-technical-details } -/// warning | Attention ! +/// warning | Alertes Vous pouvez probablement ignorer cela. @@ -403,32 +413,32 @@ Si vous avez de bonnes connaissances techniques (coroutines, threads, code bloqu /// -### Fonctions de chemin +### Fonctions de chemin d'accès { #path-operation-functions } -Quand vous déclarez une *fonction de chemin* avec un `def` normal et non `async def`, elle est exécutée dans un groupe de threads (threadpool) externe qui est ensuite attendu, plutôt que d'être appelée directement (car cela bloquerait le serveur). +Quand vous déclarez une *fonction de chemin d'accès* avec un `def` normal et non `async def`, elle est exécutée dans un groupe de threads (threadpool) externe qui est ensuite attendu, plutôt que d'être appelée directement (car cela bloquerait le serveur). -Si vous venez d'un autre framework asynchrone qui ne fonctionne pas comme de la façon décrite ci-dessus et que vous êtes habitués à définir des *fonctions de chemin* basiques avec un simple `def` pour un faible gain de performance (environ 100 nanosecondes), veuillez noter que dans **FastAPI**, l'effet serait plutôt contraire. Dans ces cas-là, il vaut mieux utiliser `async def` à moins que votre *fonction de chemin* utilise du code qui effectue des opérations I/O bloquantes. +Si vous venez d'un autre framework asynchrone qui ne fonctionne pas comme de la façon décrite ci-dessus et que vous êtes habitué à définir des *fonctions de chemin d'accès* basiques et purement calculatoires avec un simple `def` pour un faible gain de performance (environ 100 nanosecondes), veuillez noter que dans **FastAPI**, l'effet serait plutôt contraire. Dans ces cas-là, il vaut mieux utiliser `async def` à moins que votre *fonction de chemin d'accès* utilise du code qui effectue des opérations I/O bloquantes. Au final, dans les deux situations, il est fort probable que **FastAPI** soit tout de même [plus rapide](index.md#performance){.internal-link target=_blank} que (ou au moins de vitesse égale à) votre framework précédent. -### Dépendances +### Dépendances { #dependencies } -La même chose s'applique aux dépendances. Si une dépendance est définie avec `def` plutôt que `async def`, elle est exécutée dans la threadpool externe. +La même chose s'applique aux [dépendances](tutorial/dependencies/index.md){.internal-link target=_blank}. Si une dépendance est définie avec `def` plutôt que `async def`, elle est exécutée dans la threadpool externe. -### Sous-dépendances +### Sous-dépendances { #sub-dependencies } -Vous pouvez avoir de multiples dépendances et sous-dépendances dépendant les unes des autres (en tant que paramètres de la définition de la *fonction de chemin*), certaines créées avec `async def` et d'autres avec `def`. Cela fonctionnerait aussi, et celles définies avec un simple `def` seraient exécutées sur un thread externe (venant de la threadpool) plutôt que d'être "attendues". +Vous pouvez avoir de multiples dépendances et [sous-dépendances](tutorial/dependencies/sub-dependencies.md){.internal-link target=_blank} dépendant les unes des autres (en tant que paramètres de la définition de la *fonction de chemin d'accès*), certaines créées avec `async def` et d'autres avec `def`. Cela fonctionnerait aussi, et celles définies avec un simple `def` seraient exécutées sur un thread externe (venant de la threadpool) plutôt que d'être « attendues ». -### Autres fonctions utilitaires +### Autres fonctions utilitaires { #other-utility-functions } -Toute autre fonction utilitaire que vous appelez directement peut être créée avec un classique `def` ou avec `async def` et **FastAPI** n'aura pas d'impact sur la façon dont vous l'appelez. +Toute autre fonction utilitaire que vous appelez directement peut être créée avec un classique `def` ou avec `async def` et FastAPI n'aura pas d'impact sur la façon dont vous l'appelez. -Contrairement aux fonctions que **FastAPI** appelle pour vous : les *fonctions de chemin* et dépendances. +Contrairement aux fonctions que FastAPI appelle pour vous : les *fonctions de chemin d'accès* et dépendances. -Si votre fonction utilitaire est une fonction classique définie avec `def`, elle sera appelée directement (telle qu'écrite dans votre code), pas dans une threadpool, si la fonction est définie avec `async def` alors vous devrez attendre (avec `await`) que cette fonction se termine avant de passer à la suite du code. +Si votre fonction utilitaire est une fonction classique définie avec `def`, elle sera appelée directement (telle qu'écrite dans votre code), pas dans une threadpool ; si la fonction est définie avec `async def` alors vous devrez attendre (avec `await`) que cette fonction se termine avant de passer à la suite du code. --- Encore une fois, ce sont des détails très techniques qui peuvent être utiles si vous venez ici les chercher. -Sinon, les instructions de la section Vous êtes pressés ? ci-dessus sont largement suffisantes. +Sinon, les instructions de la section Vous êtes pressés ? ci-dessus sont largement suffisantes. diff --git a/docs/fr/docs/deployment/cloud.md b/docs/fr/docs/deployment/cloud.md new file mode 100644 index 0000000000..798a72a746 --- /dev/null +++ b/docs/fr/docs/deployment/cloud.md @@ -0,0 +1,24 @@ +# Déployer FastAPI sur des fournisseurs cloud { #deploy-fastapi-on-cloud-providers } + +Vous pouvez utiliser pratiquement n'importe quel fournisseur cloud pour déployer votre application FastAPI. + +Dans la plupart des cas, les principaux fournisseurs cloud proposent des guides pour déployer FastAPI avec leurs services. + +## FastAPI Cloud { #fastapi-cloud } + +**FastAPI Cloud** est créée par le même auteur et l'équipe à l'origine de **FastAPI**. + +Elle simplifie le processus de **création**, de **déploiement** et **d'accès** à une API avec un effort minimal. + +Elle apporte la même **expérience développeur** que celle de la création d'applications avec FastAPI au **déploiement** de celles-ci dans le cloud. 🎉 + +FastAPI Cloud est le sponsor principal et le financeur des projets open source *FastAPI and friends*. ✨ + +## Fournisseurs cloud - Sponsors { #cloud-providers-sponsors } + +D'autres fournisseurs cloud ✨ [**parrainent FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨ également. 🙇 + +Vous pouvez également envisager ces fournisseurs pour suivre leurs guides et essayer leurs services : + +* Render +* Railway diff --git a/docs/fr/docs/deployment/concepts.md b/docs/fr/docs/deployment/concepts.md new file mode 100644 index 0000000000..59b8ddd1b9 --- /dev/null +++ b/docs/fr/docs/deployment/concepts.md @@ -0,0 +1,321 @@ +# Concepts de déploiement { #deployments-concepts } + +Lorsque vous déployez une application **FastAPI**, ou en fait n'importe quel type de web API, il existe plusieurs concepts qui vous importent probablement, et en les utilisant vous pouvez trouver la manière la **plus appropriée** de **déployer votre application**. + +Parmi les concepts importants, on trouve : + +* Sécurité - HTTPS +* Exécuter au démarrage +* Redémarrages +* Réplication (le nombre de processus en cours d'exécution) +* Mémoire +* Étapes préalables avant de démarrer + +Nous allons voir comment ils affectent les **déploiements**. + +Au final, l'objectif ultime est de pouvoir **servir vos clients d'API** de manière **sécurisée**, d'**éviter les interruptions**, et d'utiliser les **ressources de calcul** (par exemple des serveurs/VM distants) aussi efficacement que possible. 🚀 + +Je vais vous en dire un peu plus ici sur ces **concepts**, ce qui devrait vous donner l'**intuition** nécessaire pour décider comment déployer votre API dans des environnements très différents, voire même dans des environnements **futurs** qui n'existent pas encore. + +En tenant compte de ces concepts, vous serez en mesure **d'évaluer et de concevoir** la meilleure façon de déployer **vos propres API**. + +Dans les chapitres suivants, je vous donnerai des **recettes concrètes** pour déployer des applications FastAPI. + +Mais pour l'instant, voyons ces **idées conceptuelles** importantes. Ces concepts s'appliquent aussi à tout autre type de web API. 💡 + +## Sécurité - HTTPS { #security-https } + +Dans le [chapitre précédent à propos de HTTPS](https.md){.internal-link target=_blank}, nous avons vu comment HTTPS fournit le chiffrement pour votre API. + +Nous avons également vu que HTTPS est normalement fourni par un composant **externe** à votre serveur d'application, un **TLS Termination Proxy**. + +Et il doit y avoir quelque chose chargé de **renouveler les certificats HTTPS** ; cela peut être le même composant ou quelque chose de différent. + +### Exemples d’outils pour HTTPS { #example-tools-for-https } + +Parmi les outils que vous pourriez utiliser comme TLS Termination Proxy : + +* Traefik + * Gère automatiquement le renouvellement des certificats ✨ +* Caddy + * Gère automatiquement le renouvellement des certificats ✨ +* Nginx + * Avec un composant externe comme Certbot pour le renouvellement des certificats +* HAProxy + * Avec un composant externe comme Certbot pour le renouvellement des certificats +* Kubernetes avec un Ingress Controller comme Nginx + * Avec un composant externe comme cert-manager pour le renouvellement des certificats +* Pris en charge en interne par un fournisseur cloud dans le cadre de ses services (lisez ci-dessous 👇) + +Une autre option consiste à utiliser un **service cloud** qui fait davantage de travail, y compris la mise en place de HTTPS. Il peut avoir certaines restrictions ou vous facturer davantage, etc. Mais dans ce cas, vous n'auriez pas à configurer vous‑même un TLS Termination Proxy. + +Je vous montrerai des exemples concrets dans les prochains chapitres. + +--- + +Les concepts suivants à considérer concernent tous le programme qui exécute votre API réelle (par ex. Uvicorn). + +## Programme et processus { #program-and-process } + +Nous allons beaucoup parler du « **processus** » en cours d'exécution, il est donc utile d'être clair sur ce que cela signifie, et sur la différence avec le mot « **programme** ». + +### Qu'est-ce qu'un programme { #what-is-a-program } + +Le mot **programme** est couramment utilisé pour décrire plusieurs choses : + +* Le **code** que vous écrivez, les **fichiers Python**. +* Le **fichier** qui peut être **exécuté** par le système d'exploitation, par exemple : `python`, `python.exe` ou `uvicorn`. +* Un programme particulier lorsqu'il **s'exécute** sur le système d'exploitation, utilisant le CPU et stockant des choses en mémoire. On appelle aussi cela un **processus**. + +### Qu'est-ce qu'un processus { #what-is-a-process } + +Le mot **processus** est normalement utilisé de manière plus spécifique, en ne se référant qu'à l'élément qui s'exécute dans le système d'exploitation (comme dans le dernier point ci‑dessus) : + +* Un programme particulier lorsqu'il **s'exécute** sur le système d'exploitation. + * Cela ne se réfère ni au fichier, ni au code ; cela se réfère **spécifiquement** à l'élément qui est **exécuté** et géré par le système d'exploitation. +* N'importe quel programme, n'importe quel code, **ne peut faire des choses** que lorsqu'il est **exécuté**. Donc, lorsqu'il y a un **processus en cours**. +* Le processus peut être **arrêté** (ou « tué ») par vous ou par le système d'exploitation. À ce moment‑là, il cesse de s'exécuter/d'être exécuté, et il **ne peut plus rien faire**. +* Chaque application que vous avez en cours d'exécution sur votre ordinateur a un processus derrière elle, chaque programme lancé, chaque fenêtre, etc. Et il y a normalement de nombreux processus exécutés **en même temps** tant qu'un ordinateur est allumé. +* Il peut y avoir **plusieurs processus** du **même programme** exécutés simultanément. + +Si vous ouvrez le « gestionnaire des tâches » ou le « moniteur système » (ou des outils similaires) de votre système d'exploitation, vous verrez nombre de ces processus en cours d'exécution. + +Et, par exemple, vous verrez probablement qu'il y a plusieurs processus exécutant le même navigateur (Firefox, Chrome, Edge, etc.). Ils exécutent normalement un processus par onglet, plus quelques processus supplémentaires. + + + +--- + +Maintenant que nous connaissons la différence entre les termes **processus** et **programme**, continuons à parler des déploiements. + +## Exécuter au démarrage { #running-on-startup } + +Dans la plupart des cas, lorsque vous créez une web API, vous voulez qu'elle **tourne en permanence**, sans interruption, afin que vos clients puissent toujours y accéder. Bien sûr, sauf si vous avez une raison spécifique de ne vouloir l'exécuter que dans certaines situations, mais la plupart du temps vous la voulez constamment en cours et **disponible**. + +### Sur un serveur distant { #in-a-remote-server } + +Lorsque vous configurez un serveur distant (un serveur cloud, une machine virtuelle, etc.), la chose la plus simple à faire est d'utiliser `fastapi run` (qui utilise Uvicorn) ou quelque chose de similaire, manuellement, de la même manière que lorsque vous développez en local. + +Et cela fonctionnera et sera utile **pendant le développement**. + +Mais si votre connexion au serveur est coupée, le **processus en cours** va probablement s'arrêter. + +Et si le serveur est redémarré (par exemple après des mises à jour, ou des migrations chez le fournisseur cloud) vous **ne le remarquerez probablement pas**. Et à cause de cela, vous ne saurez même pas que vous devez redémarrer le processus manuellement. Ainsi, votre API restera tout simplement à l'arrêt. 😱 + +### Lancer automatiquement au démarrage { #run-automatically-on-startup } + +En général, vous voudrez probablement que le programme serveur (par ex. Uvicorn) soit démarré automatiquement au démarrage du serveur, et sans aucune **intervention humaine**, afin d'avoir en permanence un processus exécutant votre API (par ex. Uvicorn exécutant votre app FastAPI). + +### Programme séparé { #separate-program } + +Pour y parvenir, vous aurez normalement un **programme séparé** qui s'assure que votre application est lancée au démarrage. Et dans de nombreux cas, il s'assurera également que d'autres composants ou applications sont également lancés, par exemple une base de données. + +### Exemples d’outils pour lancer au démarrage { #example-tools-to-run-at-startup } + +Voici quelques exemples d'outils capables de faire ce travail : + +* Docker +* Kubernetes +* Docker Compose +* Docker en mode Swarm +* Systemd +* Supervisor +* Pris en charge en interne par un fournisseur cloud dans le cadre de ses services +* Autres ... + +Je vous donnerai des exemples plus concrets dans les prochains chapitres. + +## Redémarrages { #restarts } + +De la même manière que vous voulez vous assurer que votre application est lancée au démarrage, vous voulez probablement aussi vous assurer qu'elle est **redémarrée** après des échecs. + +### Nous faisons des erreurs { #we-make-mistakes } + +Nous, humains, faisons des **erreurs**, tout le temps. Les logiciels ont presque *toujours* des **bugs** cachés à différents endroits. 🐛 + +Et nous, développeurs, continuons à améliorer le code au fur et à mesure que nous trouvons ces bugs et que nous implémentons de nouvelles fonctionnalités (en ajoutant éventuellement de nouveaux bugs aussi 😅). + +### Petites erreurs gérées automatiquement { #small-errors-automatically-handled } + +Lors de la création de web API avec FastAPI, s'il y a une erreur dans notre code, FastAPI la contiendra normalement à la seule requête qui a déclenché l'erreur. 🛡 + +Le client recevra un **500 Internal Server Error** pour cette requête, mais l'application continuera de fonctionner pour les requêtes suivantes au lieu de simplement s'effondrer complètement. + +### Erreurs plus importantes - plantages { #bigger-errors-crashes } + +Néanmoins, il peut y avoir des cas où nous écrivons du code qui **fait planter l'application entière**, faisant planter Uvicorn et Python. 💥 + +Et malgré cela, vous ne voudrez probablement pas que l'application reste à l'arrêt parce qu'il y a eu une erreur à un endroit ; vous voudrez probablement qu'elle **continue de tourner**, au moins pour les *chemins d'accès* qui ne sont pas cassés. + +### Redémarrer après un plantage { #restart-after-crash } + +Mais dans ces cas avec de très mauvaises erreurs qui font planter le **processus** en cours, vous voudrez un composant externe chargé de **redémarrer** le processus, au moins quelques fois ... + +/// tip | Astuce + +... Bien que si l'application entière **plante immédiatement**, il n'est probablement pas logique de continuer à la redémarrer indéfiniment. Mais dans ces cas, vous le remarquerez probablement pendant le développement, ou au moins juste après le déploiement. + +Concentrons‑nous donc sur les cas principaux, où elle pourrait planter entièrement dans certaines situations particulières **à l'avenir**, et où il est toujours logique de la redémarrer. + +/// + +Vous voudrez probablement que l'élément chargé de redémarrer votre application soit un **composant externe**, car à ce stade, l'application elle‑même avec Uvicorn et Python a déjà planté, donc il n'y a rien dans le même code de la même app qui pourrait y faire quoi que ce soit. + +### Exemples d’outils pour redémarrer automatiquement { #example-tools-to-restart-automatically } + +Dans la plupart des cas, le même outil qui est utilisé pour **lancer le programme au démarrage** est également utilisé pour gérer les **redémarrages** automatiques. + +Par exemple, cela peut être géré par : + +* Docker +* Kubernetes +* Docker Compose +* Docker en mode Swarm +* Systemd +* Supervisor +* Pris en charge en interne par un fournisseur cloud dans le cadre de ses services +* Autres ... + +## Réplication - Processus et mémoire { #replication-processes-and-memory } + +Avec une application FastAPI, en utilisant un programme serveur comme la commande `fastapi` qui exécute Uvicorn, l'exécuter une fois dans **un processus** peut servir plusieurs clients simultanément. + +Mais dans de nombreux cas, vous voudrez exécuter plusieurs processus de travail en même temps. + +### Multiples processus - Workers { #multiple-processes-workers } + +Si vous avez plus de clients que ce qu'un seul processus peut gérer (par exemple si la machine virtuelle n'est pas très grande) et que vous avez **plusieurs cœurs** dans le CPU du serveur, alors vous pouvez avoir **plusieurs processus** exécutant la même application simultanément, et distribuer toutes les requêtes entre eux. + +Quand vous exécutez **plusieurs processus** du même programme d'API, on les appelle couramment des **workers**. + +### Processus workers et ports { #worker-processes-and-ports } + +Rappelez‑vous, d'après les documents [À propos de HTTPS](https.md){.internal-link target=_blank}, qu'un seul processus peut écouter une combinaison de port et d'adresse IP sur un serveur ? + +C'est toujours vrai. + +Donc, pour pouvoir avoir **plusieurs processus** en même temps, il doit y avoir un **seul processus à l'écoute sur un port** qui transmet ensuite la communication à chaque processus worker d'une manière ou d'une autre. + +### Mémoire par processus { #memory-per-process } + +Maintenant, lorsque le programme charge des choses en mémoire, par exemple, un modèle de machine learning dans une variable, ou le contenu d'un gros fichier dans une variable, tout cela **consomme une partie de la mémoire (RAM)** du serveur. + +Et plusieurs processus **ne partagent normalement pas de mémoire**. Cela signifie que chaque processus en cours a ses propres éléments, variables et mémoire. Et si vous consommez une grande quantité de mémoire dans votre code, **chaque processus** consommera une quantité équivalente de mémoire. + +### Mémoire du serveur { #server-memory } + +Par exemple, si votre code charge un modèle de Machine Learning de **1 Go**, lorsque vous exécutez un processus avec votre API, il consommera au moins 1 Go de RAM. Et si vous démarrez **4 processus** (4 workers), chacun consommera 1 Go de RAM. Donc au total, votre API consommera **4 Go de RAM**. + +Et si votre serveur distant ou votre machine virtuelle n'a que 3 Go de RAM, essayer de charger plus de 4 Go de RAM posera problème. 🚨 + +### Multiples processus - Un exemple { #multiple-processes-an-example } + +Dans cet exemple, il y a un **processus gestionnaire** qui démarre et contrôle deux **processus workers**. + +Ce processus gestionnaire serait probablement celui qui écoute sur le **port** de l'IP. Et il transmettrait toute la communication aux processus workers. + +Ces processus workers seraient ceux qui exécutent votre application, ils effectueraient les calculs principaux pour recevoir une **requête** et renvoyer une **réponse**, et ils chargeraient tout ce que vous mettez dans des variables en RAM. + + + +Et bien sûr, la même machine aurait probablement **d'autres processus** en cours d'exécution également, en plus de votre application. + +Un détail intéressant est que le pourcentage de **CPU utilisé** par chaque processus peut **varier** fortement dans le temps, mais la **mémoire (RAM)** reste normalement plus ou moins **stable**. + +Si vous avez une API qui effectue une quantité comparable de calculs à chaque fois et que vous avez beaucoup de clients, alors l'**utilisation du CPU** sera probablement *également stable* (au lieu de monter et descendre rapidement en permanence). + +### Exemples d’outils et de stratégies de réplication { #examples-of-replication-tools-and-strategies } + +Il peut y avoir plusieurs approches pour y parvenir, et je vous en dirai plus sur des stratégies spécifiques dans les prochains chapitres, par exemple en parlant de Docker et des conteneurs. + +La principale contrainte à considérer est qu'il doit y avoir un **seul** composant gérant le **port** sur l'**IP publique**. Et il doit ensuite avoir un moyen de **transmettre** la communication aux **processus/workers** répliqués. + +Voici quelques combinaisons et stratégies possibles : + +* **Uvicorn** avec `--workers` + * Un **gestionnaire de processus** Uvicorn écouterait sur l'**IP** et le **port**, et il démarrerait **plusieurs processus workers Uvicorn**. +* **Kubernetes** et autres systèmes **de conteneurs** distribués + * Quelque chose dans la couche **Kubernetes** écouterait sur l'**IP** et le **port**. La réplication se ferait en ayant **plusieurs conteneurs**, chacun avec **un processus Uvicorn** en cours. +* **Services cloud** qui s'en chargent pour vous + * Le service cloud **gérera probablement la réplication pour vous**. Il vous permettra éventuellement de définir **un processus à exécuter**, ou une **image de conteneur** à utiliser ; dans tous les cas, ce sera très probablement **un seul processus Uvicorn**, et le service cloud sera chargé de le répliquer. + +/// tip | Astuce + +Ne vous inquiétez pas si certains de ces éléments concernant les **conteneurs**, Docker ou Kubernetes ne sont pas encore très clairs. + +Je vous en dirai plus sur les images de conteneurs, Docker, Kubernetes, etc. dans un chapitre à venir : [FastAPI dans des conteneurs - Docker](docker.md){.internal-link target=_blank}. + +/// + +## Étapes préalables avant de démarrer { #previous-steps-before-starting } + +Il existe de nombreux cas où vous souhaitez effectuer certaines étapes **avant de démarrer** votre application. + +Par exemple, vous pourriez vouloir exécuter des **migrations de base de données**. + +Mais dans la plupart des cas, vous voudrez effectuer ces étapes **une seule fois**. + +Vous voudrez donc avoir un **processus unique** pour effectuer ces **étapes préalables**, avant de démarrer l'application. + +Et vous devez vous assurer que c'est un processus unique qui exécute ces étapes préalables *même si*, ensuite, vous démarrez **plusieurs processus** (plusieurs workers) pour l'application elle‑même. Si ces étapes étaient exécutées par **plusieurs processus**, ils **dupliqueraient** le travail en l'exécutant **en parallèle**, et si les étapes étaient délicates comme une migration de base de données, elles pourraient entrer en conflit les unes avec les autres. + +Bien sûr, il y a des cas où il n'y a aucun problème à exécuter les étapes préalables plusieurs fois ; dans ce cas, c'est beaucoup plus simple à gérer. + +/// tip | Astuce + +Gardez aussi à l'esprit que selon votre configuration, dans certains cas vous **n'aurez peut‑être même pas besoin d'étapes préalables** avant de démarrer votre application. + +Dans ce cas, vous n'auriez pas à vous soucier de tout cela. 🤷 + +/// + +### Exemples de stratégies pour les étapes préalables { #examples-of-previous-steps-strategies } + +Cela **dépendra fortement** de la manière dont vous **déployez votre système**, et sera probablement lié à votre manière de démarrer les programmes, de gérer les redémarrages, etc. + +Voici quelques idées possibles : + +* Un « Init Container » dans Kubernetes qui s'exécute avant votre conteneur d'application +* Un script bash qui exécute les étapes préalables puis démarre votre application + * Vous aurez toujours besoin d'un moyen de démarrer/redémarrer *ce* script bash, de détecter les erreurs, etc. + +/// tip | Astuce + +Je vous donnerai des exemples plus concrets pour faire cela avec des conteneurs dans un chapitre à venir : [FastAPI dans des conteneurs - Docker](docker.md){.internal-link target=_blank}. + +/// + +## Utilisation des ressources { #resource-utilization } + +Votre ou vos serveurs constituent une **ressource** que vos programmes peuvent consommer ou **utiliser** : le temps de calcul des CPU et la mémoire RAM disponible. + +Quelle quantité des ressources système voulez‑vous consommer/utiliser ? Il peut être facile de penser « pas beaucoup », mais en réalité, vous voudrez probablement consommer **le plus possible sans planter**. + +Si vous payez pour 3 serveurs mais que vous n'utilisez qu'un petit peu de leur RAM et CPU, vous **gaspillez probablement de l'argent** 💸, et **gaspillez probablement l'électricité des serveurs** 🌎, etc. + +Dans ce cas, il pourrait être préférable de n'avoir que 2 serveurs et d'utiliser un pourcentage plus élevé de leurs ressources (CPU, mémoire, disque, bande passante réseau, etc.). + +À l'inverse, si vous avez 2 serveurs et que vous utilisez **100 % de leur CPU et de leur RAM**, à un moment donné un processus demandera plus de mémoire, et le serveur devra utiliser le disque comme « mémoire » (ce qui peut être des milliers de fois plus lent), voire **planter**. Ou un processus pourrait avoir besoin de faire un calcul et devrait attendre que le CPU soit à nouveau libre. + +Dans ce cas, il serait préférable d'obtenir **un serveur supplémentaire** et d'y exécuter certains processus afin qu'ils aient tous **suffisamment de RAM et de temps CPU**. + +Il est également possible que, pour une raison quelconque, vous ayez un **pic** d'utilisation de votre API. Peut‑être qu'elle devient virale, ou peut‑être que d'autres services ou bots commencent à l'utiliser. Et vous voudrez peut‑être disposer de ressources supplémentaires pour être en sécurité dans ces cas. + +Vous pouvez définir un **chiffre arbitraire** comme cible, par exemple **entre 50 % et 90 %** d'utilisation des ressources. L'idée est que ce sont probablement les principaux éléments que vous voudrez mesurer et utiliser pour ajuster vos déploiements. + +Vous pouvez utiliser des outils simples comme `htop` pour voir le CPU et la RAM utilisés sur votre serveur ou la quantité utilisée par chaque processus. Ou vous pouvez utiliser des outils de supervision plus complexes, éventuellement distribués sur plusieurs serveurs, etc. + +## Récapitulatif { #recap } + +Vous venez de lire ici certains des principaux concepts que vous devrez probablement garder à l'esprit lorsque vous décidez comment déployer votre application : + +* Sécurité - HTTPS +* Exécuter au démarrage +* Redémarrages +* Réplication (le nombre de processus en cours d'exécution) +* Mémoire +* Étapes préalables avant de démarrer + +Comprendre ces idées et comment les appliquer devrait vous donner l'intuition nécessaire pour prendre toutes les décisions lors de la configuration et de l'ajustement de vos déploiements. 🤓 + +Dans les sections suivantes, je vous donnerai des exemples plus concrets de stratégies possibles à suivre. 🚀 diff --git a/docs/fr/docs/deployment/docker.md b/docs/fr/docs/deployment/docker.md index ec30f96079..2d86d4a402 100644 --- a/docs/fr/docs/deployment/docker.md +++ b/docs/fr/docs/deployment/docker.md @@ -14,7 +14,7 @@ Vous êtes pressé et vous connaissez déjà tout ça ? Allez directement au [`D Aperçu du Dockerfile 👀 ```Dockerfile -FROM python:3.9 +FROM python:3.14 WORKDIR /code @@ -166,7 +166,7 @@ Maintenant, dans le même répertoire de projet, créez un fichier `Dockerfile` ```{ .dockerfile .annotate } # (1)! -FROM python:3.9 +FROM python:3.14 # (2)! WORKDIR /code @@ -390,7 +390,7 @@ Si votre FastAPI est un seul fichier, par exemple `main.py` sans répertoire `./ Vous n'auriez alors qu'à changer les chemins correspondants pour copier le fichier dans le `Dockerfile` : ```{ .dockerfile .annotate hl_lines="10 13" } -FROM python:3.9 +FROM python:3.14 WORKDIR /code @@ -454,7 +454,7 @@ Sans utiliser de conteneurs, faire en sorte que les applications s'exécutent au ## Réplication - Nombre de processus { #replication-number-of-processes } -Si vous avez un cluster de machines avec **Kubernetes**, Docker Swarm Mode, Nomad, ou un autre système complexe similaire pour gérer des conteneurs distribués sur plusieurs machines, alors vous voudrez probablement **gérer la réplication** au **niveau du cluster** plutôt que d'utiliser un **gestionnaire de processus** (comme Uvicorn avec workers) dans chaque conteneur. +Si vous avez un cluster de machines avec **Kubernetes**, Docker Swarm Mode, Nomad, ou un autre système complexe similaire pour gérer des conteneurs distribués sur plusieurs machines, alors vous voudrez probablement **gérer la réplication** au **niveau du cluster** plutôt que d'utiliser un **gestionnaire de processus** (comme Uvicorn avec workers) dans chaque conteneur. L'un de ces systèmes de gestion de conteneurs distribués comme Kubernetes dispose normalement d'une manière intégrée de gérer la **réplication des conteneurs** tout en supportant l'**équilibrage de charge** des requêtes entrantes. Le tout au **niveau du cluster**. @@ -499,7 +499,7 @@ Bien sûr, il existe des **cas particuliers** où vous pourriez vouloir avoir ** Dans ces cas, vous pouvez utiliser l'option de ligne de commande `--workers` pour définir le nombre de workers que vous souhaitez exécuter : ```{ .dockerfile .annotate } -FROM python:3.9 +FROM python:3.14 WORKDIR /code diff --git a/docs/fr/docs/deployment/fastapicloud.md b/docs/fr/docs/deployment/fastapicloud.md new file mode 100644 index 0000000000..72f275cf6f --- /dev/null +++ b/docs/fr/docs/deployment/fastapicloud.md @@ -0,0 +1,65 @@ +# FastAPI Cloud { #fastapi-cloud } + +Vous pouvez déployer votre application FastAPI sur FastAPI Cloud avec une **seule commande**, allez vous inscrire sur la liste d’attente si ce n’est pas déjà fait. 🚀 + +## Se connecter { #login } + +Vous devez vous assurer que vous avez déjà un compte **FastAPI Cloud** (nous vous avons invité depuis la liste d’attente 😉). + +Connectez-vous ensuite : + +
+ +```console +$ fastapi login + +You are logged in to FastAPI Cloud 🚀 +``` + +
+ +## Déployer { #deploy } + +Déployez maintenant votre application, avec une **seule commande** : + +
+ +```console +$ fastapi deploy + +Deploying to FastAPI Cloud... + +✅ Deployment successful! + +🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev +``` + +
+ +C’est tout ! Vous pouvez maintenant accéder à votre application à cette URL. ✨ + +## À propos de FastAPI Cloud { #about-fastapi-cloud } + +**FastAPI Cloud** est développé par le même auteur et la même équipe à l’origine de **FastAPI**. + +Cela simplifie le processus de **création**, de **déploiement** et **d’accès** à une API avec un effort minimal. + +Cela apporte la même **expérience développeur** que pour créer des applications avec FastAPI au **déploiement** dans le cloud. 🎉 + +Cela prend également en charge la plupart des éléments nécessaires lors du déploiement d’une application, notamment : + +* HTTPS +* Réplication, avec mise à l’échelle automatique basée sur les requêtes +* etc. + +FastAPI Cloud est le sponsor principal et le financeur des projets open source *FastAPI and friends*. ✨ + +## Déployer sur d’autres fournisseurs cloud { #deploy-to-other-cloud-providers } + +FastAPI est open source et basé sur des standards. Vous pouvez déployer des applications FastAPI sur n’importe quel fournisseur cloud de votre choix. + +Suivez les guides de votre fournisseur cloud pour déployer des applications FastAPI avec eux. 🤓 + +## Déployer votre propre serveur { #deploy-your-own-server } + +Je vous expliquerai également plus loin dans ce guide de **Déploiement** tous les détails, afin que vous compreniez ce qui se passe, ce qui doit être fait, et comment déployer des applications FastAPI par vous-même, y compris sur vos propres serveurs. 🤓 diff --git a/docs/fr/docs/deployment/https.md b/docs/fr/docs/deployment/https.md index 74d38cdb9f..1b3c7be56c 100644 --- a/docs/fr/docs/deployment/https.md +++ b/docs/fr/docs/deployment/https.md @@ -65,7 +65,7 @@ Voici un exemple de ce à quoi pourrait ressembler une API HTTPS, étape par ét Tout commencerait probablement par le fait que vous **acquériez** un **nom de domaine**. Ensuite, vous le configureriez dans un serveur DNS (possiblement le même que votre fournisseur cloud). -Vous obtiendriez probablement un serveur cloud (une machine virtuelle) ou quelque chose de similaire, et il aurait une adresse IP **publique** fixe. +Vous obtiendriez probablement un serveur cloud (une machine virtuelle) ou quelque chose de similaire, et il aurait une adresse IP publique fixe. Dans le ou les serveurs DNS, vous configureriez un enregistrement (un « `A record` ») pour faire pointer **votre domaine** vers l'**adresse IP publique de votre serveur**. diff --git a/docs/fr/docs/deployment/server-workers.md b/docs/fr/docs/deployment/server-workers.md new file mode 100644 index 0000000000..338a5003d5 --- /dev/null +++ b/docs/fr/docs/deployment/server-workers.md @@ -0,0 +1,139 @@ +# Workers du serveur - Uvicorn avec workers { #server-workers-uvicorn-with-workers } + +Reprenons ces concepts de déploiement vus précédemment : + +* Sécurité - HTTPS +* Exécution au démarrage +* Redémarrages +* Réplication (le nombre de processus en cours d'exécution) +* Mémoire +* Étapes préalables avant le démarrage + +Jusqu'à présent, avec tous les tutoriels dans les documents, vous avez probablement exécuté un programme serveur, par exemple avec la commande `fastapi`, qui lance Uvicorn en exécutant un seul processus. + +Lors du déploiement d'applications, vous voudrez probablement avoir une réplication de processus pour tirer parti de plusieurs cœurs et pouvoir gérer davantage de requêtes. + +Comme vous l'avez vu dans le chapitre précédent sur les [Concepts de déploiement](concepts.md){.internal-link target=_blank}, il existe plusieurs stratégies possibles. + +Ici, je vais vous montrer comment utiliser Uvicorn avec des processus workers en utilisant la commande `fastapi` ou directement la commande `uvicorn`. + +/// info | Info + +Si vous utilisez des conteneurs, par exemple avec Docker ou Kubernetes, je vous en dirai plus à ce sujet dans le prochain chapitre : [FastAPI dans des conteneurs - Docker](docker.md){.internal-link target=_blank}. + +En particulier, lorsque vous exécutez sur Kubernetes, vous ne voudrez probablement pas utiliser de workers et plutôt exécuter un seul processus Uvicorn par conteneur, mais je vous en parlerai plus en détail dans ce chapitre. + +/// + +## Utiliser plusieurs workers { #multiple-workers } + +Vous pouvez démarrer plusieurs workers avec l'option de ligne de commande `--workers` : + +//// tab | `fastapi` + +Si vous utilisez la commande `fastapi` : + +
+ +```console +$ fastapi run --workers 4 main.py + + FastAPI Starting production server 🚀 + + Searching for package file structure from directories with + __init__.py files + Importing from /home/user/code/awesomeapp + + module 🐍 main.py + + code Importing the FastAPI app object from the module with the + following code: + + from main import app + + app Using import string: main:app + + server Server started at http://0.0.0.0:8000 + server Documentation at http://0.0.0.0:8000/docs + + Logs: + + INFO Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to + quit) + INFO Started parent process [27365] + INFO Started server process [27368] + INFO Started server process [27369] + INFO Started server process [27370] + INFO Started server process [27367] + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Application startup complete. + INFO Application startup complete. + INFO Application startup complete. + INFO Application startup complete. +``` + +
+ +//// + +//// tab | `uvicorn` + +Si vous préférez utiliser directement la commande `uvicorn` : + +
+ +```console +$ uvicorn main:app --host 0.0.0.0 --port 8080 --workers 4 +INFO: Uvicorn running on http://0.0.0.0:8080 (Press CTRL+C to quit) +INFO: Started parent process [27365] +INFO: Started server process [27368] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27369] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27370] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27367] +INFO: Waiting for application startup. +INFO: Application startup complete. +``` + +
+ +//// + +La seule option nouvelle ici est `--workers` qui indique à Uvicorn de démarrer 4 processus workers. + +Vous pouvez aussi voir qu'il affiche le PID de chaque processus, `27365` pour le processus parent (c'est le gestionnaire de processus) et un pour chaque processus worker : `27368`, `27369`, `27370` et `27367`. + +## Concepts de déploiement { #deployment-concepts } + +Ici, vous avez vu comment utiliser plusieurs workers pour paralléliser l'exécution de l'application, tirer parti de plusieurs cœurs du CPU et être en mesure de servir davantage de requêtes. + +Dans la liste des concepts de déploiement ci-dessus, l'utilisation de workers aide principalement à la partie réplication, et un peu aux redémarrages, mais vous devez toujours vous occuper des autres : + +* Sécurité - HTTPS +* Exécution au démarrage +* ***Redémarrages*** +* Réplication (le nombre de processus en cours d'exécution) +* Mémoire +* Étapes préalables avant le démarrage + +## Conteneurs et Docker { #containers-and-docker } + +Dans le prochain chapitre sur [FastAPI dans des conteneurs - Docker](docker.md){.internal-link target=_blank}, j'expliquerai quelques stratégies que vous pourriez utiliser pour gérer les autres concepts de déploiement. + +Je vous montrerai comment créer votre propre image à partir de zéro pour exécuter un seul processus Uvicorn. C'est un processus simple et c'est probablement ce que vous voudrez faire lorsque vous utilisez un système distribué de gestion de conteneurs comme Kubernetes. + +## Récapitulatif { #recap } + +Vous pouvez utiliser plusieurs processus workers avec l'option CLI `--workers` des commandes `fastapi` ou `uvicorn` pour tirer parti des CPU multicœurs, et exécuter plusieurs processus en parallèle. + +Vous pourriez utiliser ces outils et idées si vous mettez en place votre propre système de déploiement tout en prenant vous-même en charge les autres concepts de déploiement. + +Consultez le prochain chapitre pour en savoir plus sur FastAPI avec des conteneurs (par exemple Docker et Kubernetes). Vous verrez que ces outils offrent aussi des moyens simples de résoudre les autres concepts de déploiement. ✨ diff --git a/docs/fr/docs/environment-variables.md b/docs/fr/docs/environment-variables.md new file mode 100644 index 0000000000..57479852ae --- /dev/null +++ b/docs/fr/docs/environment-variables.md @@ -0,0 +1,298 @@ +# Variables d'environnement { #environment-variables } + +/// tip | Astuce + +Si vous savez déjà ce que sont les « variables d'environnement » et comment les utiliser, vous pouvez passer cette section. + +/// + +Une variable d'environnement (également appelée « env var ») est une variable qui vit en dehors du code Python, dans le système d'exploitation, et qui peut être lue par votre code Python (ou par d'autres programmes également). + +Les variables d'environnement peuvent être utiles pour gérer des **paramètres** d'application, dans le cadre de l'**installation** de Python, etc. + +## Créer et utiliser des variables d'environnement { #create-and-use-env-vars } + +Vous pouvez créer et utiliser des variables d'environnement dans le **shell (terminal)**, sans avoir besoin de Python : + +//// tab | Linux, macOS, Windows Bash + +
+ +```console +// Vous pouvez créer une variable d'environnement MY_NAME avec +$ export MY_NAME="Wade Wilson" + +// Vous pouvez ensuite l'utiliser avec d'autres programmes, par exemple +$ echo "Hello $MY_NAME" + +Hello Wade Wilson +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +// Créer une variable d'environnement MY_NAME +$ $Env:MY_NAME = "Wade Wilson" + +// L'utiliser avec d'autres programmes, par exemple +$ echo "Hello $Env:MY_NAME" + +Hello Wade Wilson +``` + +
+ +//// + +## Lire des variables d'environnement en Python { #read-env-vars-in-python } + +Vous pouvez également créer des variables d'environnement **en dehors** de Python, dans le terminal (ou par tout autre moyen), puis les **lire en Python**. + +Par exemple, vous pouvez avoir un fichier `main.py` contenant : + +```Python hl_lines="3" +import os + +name = os.getenv("MY_NAME", "World") +print(f"Hello {name} from Python") +``` + +/// tip | Astuce + +Le deuxième argument de `os.getenv()` est la valeur par défaut à retourner. + +S'il n'est pas fourni, c'est `None` par défaut ; ici, nous fournissons `"World"` comme valeur par défaut à utiliser. + +/// + +Vous pouvez ensuite exécuter ce programme Python : + +//// tab | Linux, macOS, Windows Bash + +
+ +```console +// Ici, nous ne définissons pas encore la variable d'environnement +$ python main.py + +// Comme nous ne l'avons pas définie, nous obtenons la valeur par défaut + +Hello World from Python + +// Mais si nous créons d'abord une variable d'environnement +$ export MY_NAME="Wade Wilson" + +// Puis que nous relançons le programme +$ python main.py + +// Il peut maintenant lire la variable d'environnement + +Hello Wade Wilson from Python +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +// Ici, nous ne définissons pas encore la variable d'environnement +$ python main.py + +// Comme nous ne l'avons pas définie, nous obtenons la valeur par défaut + +Hello World from Python + +// Mais si nous créons d'abord une variable d'environnement +$ $Env:MY_NAME = "Wade Wilson" + +// Puis que nous relançons le programme +$ python main.py + +// Il peut maintenant lire la variable d'environnement + +Hello Wade Wilson from Python +``` + +
+ +//// + +Comme les variables d'environnement peuvent être définies en dehors du code, mais lues par le code, et qu'elles n'ont pas besoin d'être stockées (validées dans `git`) avec le reste des fichiers, il est courant de les utiliser pour les configurations ou les **paramètres**. + +Vous pouvez également créer une variable d'environnement uniquement pour l'**invocation d'un programme spécifique**, qui ne sera disponible que pour ce programme et uniquement pendant sa durée d'exécution. + +Pour cela, créez-la juste avant le programme, sur la même ligne : + +
+ +```console +// Créer en ligne une variable d'environnement MY_NAME pour cet appel de programme +$ MY_NAME="Wade Wilson" python main.py + +// Il peut maintenant lire la variable d'environnement + +Hello Wade Wilson from Python + +// La variable d'environnement n'existe plus ensuite +$ python main.py + +Hello World from Python +``` + +
+ +/// tip | Astuce + +Vous pouvez en lire davantage sur The Twelve-Factor App : Config. + +/// + +## Gérer les types et la validation { #types-and-validation } + +Ces variables d'environnement ne peuvent gérer que des **chaînes de texte**, car elles sont externes à Python et doivent être compatibles avec les autres programmes et le reste du système (et même avec différents systèmes d'exploitation, comme Linux, Windows, macOS). + +Cela signifie que **toute valeur** lue en Python à partir d'une variable d'environnement **sera une `str`**, et que toute conversion vers un autre type ou toute validation doit être effectuée dans le code. + +Vous en apprendrez davantage sur l'utilisation des variables d'environnement pour gérer les **paramètres d'application** dans le [Guide utilisateur avancé - Paramètres et variables d'environnement](./advanced/settings.md){.internal-link target=_blank}. + +## Variable d'environnement `PATH` { #path-environment-variable } + +Il existe une **variable d'environnement spéciale** appelée **`PATH`** qui est utilisée par les systèmes d'exploitation (Linux, macOS, Windows) pour trouver les programmes à exécuter. + +La valeur de la variable `PATH` est une longue chaîne composée de répertoires séparés par deux-points `:` sous Linux et macOS, et par point-virgule `;` sous Windows. + +Par exemple, la variable d'environnement `PATH` peut ressembler à ceci : + +//// tab | Linux, macOS + +```plaintext +/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin +``` + +Cela signifie que le système doit rechercher les programmes dans les répertoires : + +* `/usr/local/bin` +* `/usr/bin` +* `/bin` +* `/usr/sbin` +* `/sbin` + +//// + +//// tab | Windows + +```plaintext +C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32 +``` + +Cela signifie que le système doit rechercher les programmes dans les répertoires : + +* `C:\Program Files\Python312\Scripts` +* `C:\Program Files\Python312` +* `C:\Windows\System32` + +//// + +Lorsque vous tapez une **commande** dans le terminal, le système d'exploitation **cherche** le programme dans **chacun de ces répertoires** listés dans la variable d'environnement `PATH`. + +Par exemple, lorsque vous tapez `python` dans le terminal, le système d'exploitation cherche un programme nommé `python` dans le **premier répertoire** de cette liste. + +S'il le trouve, alors il **l'utilise**. Sinon, il continue à chercher dans les **autres répertoires**. + +### Installer Python et mettre à jour `PATH` { #installing-python-and-updating-the-path } + +Lorsque vous installez Python, il est possible que l'on vous demande si vous souhaitez mettre à jour la variable d'environnement `PATH`. + +//// tab | Linux, macOS + +Supposons que vous installiez Python et qu'il se retrouve dans un répertoire `/opt/custompython/bin`. + +Si vous acceptez de mettre à jour la variable d'environnement `PATH`, l'installateur ajoutera `/opt/custompython/bin` à la variable d'environnement `PATH`. + +Cela pourrait ressembler à ceci : + +```plaintext +/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/custompython/bin +``` + +Ainsi, lorsque vous tapez `python` dans le terminal, le système trouvera le programme Python dans `/opt/custompython/bin` (le dernier répertoire) et utilisera celui-là. + +//// + +//// tab | Windows + +Supposons que vous installiez Python et qu'il se retrouve dans un répertoire `C:\opt\custompython\bin`. + +Si vous acceptez de mettre à jour la variable d'environnement `PATH`, l'installateur ajoutera `C:\opt\custompython\bin` à la variable d'environnement `PATH`. + +```plaintext +C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32;C:\opt\custompython\bin +``` + +Ainsi, lorsque vous tapez `python` dans le terminal, le système trouvera le programme Python dans `C:\opt\custompython\bin` (le dernier répertoire) et utilisera celui-là. + +//// + +Ainsi, si vous tapez : + +
+ +```console +$ python +``` + +
+ +//// tab | Linux, macOS + +Le système va **trouver** le programme `python` dans `/opt/custompython/bin` et l'exécuter. + +Cela reviendrait à peu près à taper : + +
+ +```console +$ /opt/custompython/bin/python +``` + +
+ +//// + +//// tab | Windows + +Le système va **trouver** le programme `python` dans `C:\opt\custompython\bin\python` et l'exécuter. + +Cela reviendrait à peu près à taper : + +
+ +```console +$ C:\opt\custompython\bin\python +``` + +
+ +//// + +Ces informations vous seront utiles lors de l'apprentissage des [Environnements virtuels](virtual-environments.md){.internal-link target=_blank}. + +## Conclusion { #conclusion } + +Avec cela, vous devriez avoir une compréhension de base de ce que sont les **variables d'environnement** et de la façon de les utiliser en Python. + +Vous pouvez également en lire davantage sur la page Wikipédia dédiée aux variables d'environnement. + +Dans de nombreux cas, il n'est pas évident de voir immédiatement en quoi les variables d'environnement seraient utiles et applicables. Mais elles réapparaissent dans de nombreux scénarios lorsque vous développez, il est donc bon de les connaître. + +Par exemple, vous aurez besoin de ces informations dans la section suivante, sur les [Environnements virtuels](virtual-environments.md). diff --git a/docs/fr/docs/fastapi-cli.md b/docs/fr/docs/fastapi-cli.md new file mode 100644 index 0000000000..9f31e8a2f6 --- /dev/null +++ b/docs/fr/docs/fastapi-cli.md @@ -0,0 +1,75 @@ +# FastAPI CLI { #fastapi-cli } + +**FastAPI CLI** est un programme en ligne de commande que vous pouvez utiliser pour servir votre application FastAPI, gérer votre projet FastAPI, et plus encore. + +Lorsque vous installez FastAPI (par exemple avec `pip install "fastapi[standard]"`), cela inclut un package appelé `fastapi-cli` ; ce package fournit la commande `fastapi` dans le terminal. + +Pour exécuter votre application FastAPI en développement, vous pouvez utiliser la commande `fastapi dev` : + +
+ +```console +$ fastapi dev main.py + + FastAPI Starting development server 🚀 + + Searching for package file structure from directories with + __init__.py files + Importing from /home/user/code/awesomeapp + + module 🐍 main.py + + code Importing the FastAPI app object from the module with the + following code: + + from main import app + + app Using import string: main:app + + server Server started at http://127.0.0.1:8000 + server Documentation at http://127.0.0.1:8000/docs + + tip Running in development mode, for production use: + fastapi run + + Logs: + + INFO Will watch for changes in these directories: + ['/home/user/code/awesomeapp'] + INFO Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to + quit) + INFO Started reloader process [383138] using WatchFiles + INFO Started server process [383153] + INFO Waiting for application startup. + INFO Application startup complete. +``` + +
+ +Le programme en ligne de commande nommé `fastapi` est **FastAPI CLI**. + +FastAPI CLI prend le chemin vers votre programme Python (par exemple `main.py`), détecte automatiquement l’instance `FastAPI` (généralement nommée `app`), détermine la procédure d’importation correcte, puis la sert. + +Pour la production, vous utiliserez plutôt `fastapi run`. 🚀 + +En interne, **FastAPI CLI** utilise Uvicorn, un serveur ASGI haute performance, prêt pour la production. 😎 + +## `fastapi dev` { #fastapi-dev } + +L’exécution de `fastapi dev` lance le mode développement. + +Par défaut, l’**auto-reload** est activé et recharge automatiquement le serveur lorsque vous modifiez votre code. Cela consomme des ressources et peut être moins stable que lorsqu’il est désactivé. Vous devez l’utiliser uniquement pour le développement. Il écoute aussi sur l’adresse IP `127.0.0.1`, qui est l’adresse IP permettant à votre machine de communiquer uniquement avec elle‑même (`localhost`). + +## `fastapi run` { #fastapi-run } + +Exécuter `fastapi run` démarre FastAPI en mode production par défaut. + +Par défaut, l’**auto-reload** est désactivé. Il écoute aussi sur l’adresse IP `0.0.0.0`, ce qui signifie toutes les adresses IP disponibles ; de cette manière, il sera accessible publiquement à toute personne pouvant communiquer avec la machine. C’est ainsi que vous l’exécutez normalement en production, par exemple dans un conteneur. + +Dans la plupart des cas, vous avez (et devez avoir) un « termination proxy » au‑dessus qui gère le HTTPS pour vous ; cela dépend de la façon dont vous déployez votre application : votre fournisseur peut le faire pour vous, ou vous devrez le configurer vous‑même. + +/// tip | Astuce + +Vous pouvez en savoir plus à ce sujet dans la [documentation de déploiement](deployment/index.md){.internal-link target=_blank}. + +/// diff --git a/docs/fr/docs/features.md b/docs/fr/docs/features.md index bc63e11b47..e5e809940a 100644 --- a/docs/fr/docs/features.md +++ b/docs/fr/docs/features.md @@ -1,43 +1,43 @@ -# Fonctionnalités +# Fonctionnalités { #features } -## Fonctionnalités de FastAPI +## Fonctionnalités de FastAPI { #fastapi-features } -**FastAPI** vous offre ceci: +**FastAPI** vous offre les éléments suivants : -### Basé sur des standards ouverts +### Basé sur des standards ouverts { #based-on-open-standards } -* OpenAPI pour la création d'API, incluant la déclaration de path operations, paramètres, corps de requêtes, sécurité, etc. -* Documentation automatique des modèles de données avec JSON Schema (comme OpenAPI est aussi basée sur JSON Schema). -* Conçue avec ces standards après une analyse méticuleuse. Plutôt qu'en rajoutant des surcouches après coup. -* Cela permet d'utiliser de la **génération automatique de code client** dans beaucoup de langages. +* OpenAPI pour la création d'API, incluant la déclaration de chemin opérations, paramètres, corps de requêtes, sécurité, etc. +* Documentation automatique des modèles de données avec JSON Schema (puisque OpenAPI est lui-même basé sur JSON Schema). +* Conçu autour de ces standards, après une étude méticuleuse. Plutôt qu'une couche ajoutée après coup. +* Cela permet également d'utiliser la **génération automatique de code client** dans de nombreux langages. -### Documentation automatique +### Documentation automatique { #automatic-docs } -Documentation d'API interactive et interface web d'exploration. Comme le framework est basé sur OpenAPI, de nombreuses options sont disponibles. Deux d'entre-elles sont incluses par défaut. +Documentation d'API interactive et interfaces web d'exploration. Comme le framework est basé sur OpenAPI, plusieurs options existent, 2 incluses par défaut. -* Swagger UI, propose une documentation interactive. Vous permet de directement tester l'API depuis votre navigateur. +* Swagger UI, avec exploration interactive, appelez et testez votre API directement depuis le navigateur. ![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-03-swagger-02.png) -* Une autre documentation d'API est fournie par ReDoc. +* Documentation d'API alternative avec ReDoc. ![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png) -### Faite en python moderne +### Uniquement du Python moderne { #just-modern-python } -Tout est basé sur la déclaration de type standard de **Python 3.8** (grâce à Pydantic). Pas de nouvelles syntaxes à apprendre. Juste du Python standard et moderne. +Tout est basé sur les déclarations de **types Python** standard (grâce à Pydantic). Aucune nouvelle syntaxe à apprendre. Juste du Python moderne standard. -Si vous souhaitez un rappel de 2 minutes sur l'utilisation des types en Python (même si vous ne comptez pas utiliser FastAPI), jetez un oeil au tutoriel suivant: [Python Types](python-types.md){.internal-link target=_blank}. +Si vous avez besoin d'un rappel de 2 minutes sur l'utilisation des types en Python (même si vous n'utilisez pas FastAPI), consultez le court tutoriel : [Types Python](python-types.md){.internal-link target=_blank}. -Vous écrivez du python standard avec des annotations de types: +Vous écrivez du Python standard avec des types : ```Python from datetime import date from pydantic import BaseModel -# Déclare une variable comme étant une str -# et profitez de l'aide de votre IDE dans cette fonction +# Déclarez une variable comme étant une str +# et profitez de l'aide de l'éditeur dans cette fonction def main(user_id: str): return user_id @@ -48,7 +48,8 @@ class User(BaseModel): name: str joined: date ``` -Qui peuvent ensuite être utilisés comme cela: + +Qui peuvent ensuite être utilisés comme ceci : ```Python my_user: User = User(id=3, name="John Doe", joined="2018-07-19") @@ -64,138 +65,137 @@ my_second_user: User = User(**second_user_data) /// info -`**second_user_data` signifie: +`**second_user_data` signifie : -Utilise les clés et valeurs du dictionnaire `second_user_data` directement comme des arguments clé-valeur. C'est équivalent à: `User(id=4, name="Mary", joined="2018-11-30")` +Passez les clés et valeurs du dictionnaire `second_user_data` directement comme arguments clé-valeur, équivalent à : `User(id=4, name="Mary", joined="2018-11-30")` /// -### Support d'éditeurs +### Support des éditeurs { #editor-support } -Tout le framework a été conçu pour être facile et intuitif d'utilisation, toutes les décisions de design ont été testées sur de nombreux éditeurs avant même de commencer le développement final afin d'assurer la meilleure expérience de développement possible. +Tout le framework a été conçu pour être facile et intuitif à utiliser, toutes les décisions ont été testées sur plusieurs éditeurs avant même de commencer le développement, pour assurer la meilleure expérience de développement. -Dans le dernier sondage effectué auprès de développeurs python il était clair que la fonctionnalité la plus utilisée est "l’autocomplétion". +Dans les enquêtes auprès des développeurs Python, il est clair que l’une des fonctionnalités les plus utilisées est « autocomplétion ». -Tout le framework **FastAPI** a été conçu avec cela en tête. L'autocomplétion fonctionne partout. +L'ensemble du framework **FastAPI** est conçu pour satisfaire cela. L'autocomplétion fonctionne partout. -Vous devrez rarement revenir à la documentation. +Vous aurez rarement besoin de revenir aux documents. -Voici comment votre éditeur peut vous aider: +Voici comment votre éditeur peut vous aider : -* dans Visual Studio Code: +* dans Visual Studio Code : ![editor support](https://fastapi.tiangolo.com/img/vscode-completion.png) -* dans PyCharm: +* dans PyCharm : ![editor support](https://fastapi.tiangolo.com/img/pycharm-completion.png) -Vous aurez des propositions de complétion que vous n'auriez jamais imaginées. Par exemple la clé `prix` dans le corps d'un document JSON (qui est peut-être imbriqué) venant d'une requête. +Vous obtiendrez de l'autocomplétion dans du code que vous auriez pu considérer impossible auparavant. Par exemple, la clé `price` à l'intérieur d'un corps JSON (qui aurait pu être imbriqué) provenant d'une requête. -Plus jamais vous ne vous tromperez en tapant le nom d'une clé, vous ne ferez des aller-retour entre votre code et la documentation ou vous ne scrollerez de haut en bas afin d'enfin savoir si vous devez taper `username` ou `user_name`. +Fini de taper des noms de clés erronés, de faire des allers-retours entre les documents, ou de faire défiler vers le haut et vers le bas pour savoir si vous avez finalement utilisé `username` ou `user_name`. -### Court +### Court { #short } -Des **valeurs par défaut** sont définies pour tout, des configurations optionnelles sont présentent partout. Tous ces paramètres peuvent être ajustés afin de faire ce que vous voulez et définir l'API dont vous avez besoin. +Des **valeurs par défaut** sensées pour tout, avec des configurations optionnelles partout. Tous les paramètres peuvent être ajustés finement pour faire ce dont vous avez besoin et définir l'API dont vous avez besoin. -Mais, **tout fonctionne** par défaut. +Mais par défaut, tout **« just works »**. -### Validation +### Validation { #validation } -* Validation pour la plupart (ou tous?) les **types de données** Python incluant: +* Validation pour la plupart (ou tous ?) des **types de données** Python, y compris : * objets JSON (`dict`). - * listes JSON (`list`) définissant des types d'éléments. - * Champs String (`str`), définition de longueur minimum ou maximale. - * Nombres (`int`, `float`) avec valeur minimale and maximale, etc. + * tableaux JSON (`list`) définissant les types d'éléments. + * champs String (`str`), définition des longueurs minimale et maximale. + * nombres (`int`, `float`) avec valeurs minimale et maximale, etc. -* Validation pour des types plus exotiques, tel que: +* Validation pour des types plus exotiques, comme : * URL. * Email. * UUID. - * ...et autres. + * ... et autres. -Toutes les validations sont gérées par le bien établi et robuste **Pydantic**. +Toutes les validations sont gérées par le **Pydantic** bien établi et robuste. -### Sécurité et authentification +### Sécurité et authentification { #security-and-authentication } -La sécurité et l'authentification sont intégrées. Sans aucun compromis avec les bases de données ou les modèles de données. +Sécurité et authentification intégrées. Sans aucun compromis avec les bases de données ou les modèles de données. -Tous les protocoles de sécurités sont définis dans OpenAPI, incluant: +Tous les schémas de sécurité définis dans OpenAPI, y compris : * HTTP Basic. -* **OAuth2** (aussi avec **JWT tokens**). Jetez un oeil au tutoriel [OAuth2 avec JWT](tutorial/security/oauth2-jwt.md){.internal-link target=_blank}. -* Clés d'API dans: - * Le header. - * Les paramètres de requêtes. - * Les cookies, etc. +* **OAuth2** (également avec des **tokens JWT**). Consultez le tutoriel [OAuth2 avec JWT](tutorial/security/oauth2-jwt.md){.internal-link target=_blank}. +* Clés d'API dans : + * les en-têtes. + * les paramètres de requête. + * les cookies, etc. -Plus toutes les fonctionnalités de sécurités venant de Starlette (incluant les **cookies de sessions**). +Plus toutes les fonctionnalités de sécurité de Starlette (y compris les **cookies de session**). -Le tout conçu en composant réutilisable facilement intégrable à vos systèmes, data stores, base de données relationnelle ou NoSQL, etc. +Le tout construit comme des outils et composants réutilisables, faciles à intégrer à vos systèmes, magasins de données, bases de données relationnelles et NoSQL, etc. -### Injection de dépendances +### Injection de dépendances { #dependency-injection } -FastAPI contient un système simple mais extrêmement puissant d'Injection de Dépendances. +FastAPI inclut un système d’Injection de dépendances extrêmement simple à utiliser, mais extrêmement puissant. -* Même les dépendances peuvent avoir des dépendances, créant une hiérarchie ou un **"graph" de dépendances** -* Tout est **automatiquement géré** par le framework -* Toutes les dépendances peuvent exiger des données d'une requêtes et **Augmenter les contraintes d'un path operation** et de la documentation automatique. -* **Validation automatique** même pour les paramètres de *path operation* définis dans les dépendances. -* Supporte les systèmes d'authentification d'utilisateurs complexes, les **connexions de base de données**, etc. -* **Aucun compromis** avec les bases de données, les frontends, etc. Mais une intégration facile avec n'importe lequel d'entre eux. +* Même les dépendances peuvent avoir des dépendances, créant une hiérarchie ou un **« graphe » de dépendances**. +* Le tout **géré automatiquement** par le framework. +* Toutes les dépendances peuvent exiger des données des requêtes et **augmenter les contraintes du chemin d'accès** ainsi que la documentation automatique. +* **Validation automatique** même pour les paramètres de *chemin d'accès* définis dans les dépendances. +* Prise en charge des systèmes d'authentification d'utilisateurs complexes, des **connexions de base de données**, etc. +* **Aucun compromis** avec les bases de données, les frontends, etc. Mais une intégration facile avec tous. -### "Plug-ins" illimités +### « Plug-ins » illimités { #unlimited-plug-ins } -Ou, en d'autres termes, pas besoin d'eux, importez le code que vous voulez et utilisez le. +Ou, autrement dit, pas besoin d'eux, importez et utilisez le code dont vous avez besoin. -Tout intégration est conçue pour être si simple à utiliser (avec des dépendances) que vous pouvez créer un "plug-in" pour votre application en deux lignes de code utilisant la même syntaxe que celle de vos *path operations* +Toute intégration est conçue pour être si simple à utiliser (avec des dépendances) que vous pouvez créer un « plug-in » pour votre application en 2 lignes de code en utilisant la même structure et la même syntaxe que pour vos *chemins d'accès*. -### Testé +### Testé { #tested } -* 100% de couverture de test. -* 100% d'annotations de type dans le code. -* Utilisé dans des applications mises en production. +* 100 % de couverture de test. +* 100 % de base de code annotée avec des types. +* Utilisé dans des applications en production. -## Fonctionnalités de Starlette +## Fonctionnalités de Starlette { #starlette-features } -**FastAPI** est complètement compatible (et basé sur) Starlette. Le code utilisant Starlette que vous ajouterez fonctionnera donc aussi. +**FastAPI** est entièrement compatible avec (et basé sur) Starlette. Donc, tout code Starlette additionnel que vous avez fonctionnera aussi. -En fait, `FastAPI` est un sous composant de `Starlette`. Donc, si vous savez déjà comment utiliser Starlette, la plupart des fonctionnalités fonctionneront de la même manière. +`FastAPI` est en fait une sous-classe de `Starlette`. Ainsi, si vous connaissez ou utilisez déjà Starlette, la plupart des fonctionnalités fonctionneront de la même manière. -Avec **FastAPI** vous aurez toutes les fonctionnalités de **Starlette** (FastAPI est juste Starlette sous stéroïdes): +Avec **FastAPI** vous obtenez toutes les fonctionnalités de **Starlette** (puisque FastAPI est juste Starlette sous stéroïdes) : -* Des performances vraiment impressionnantes. C'est l'un des framework Python les plus rapide, à égalité avec **NodeJS** et **GO**. -* Le support des **WebSockets**. -* Le support de **GraphQL**. -* Les tâches d'arrière-plan. -* Des évènements de démarrages et d'arrêt. -* Un client de test basé sur `request` -* **CORS**, GZip, Static Files, Streaming responses. -* Le support des **Sessions et Cookies**. -* Une couverture de test à 100 %. -* 100 % de la base de code avec des annotations de type. +* Des performances vraiment impressionnantes. C'est l’un des frameworks Python les plus rapides disponibles, à l’égal de **NodeJS** et **Go**. +* Prise en charge des **WebSocket**. +* Tâches d'arrière-plan dans le processus. +* Évènements de démarrage et d'arrêt. +* Client de test basé sur HTTPX. +* **CORS**, GZip, fichiers statiques, réponses en streaming. +* Prise en charge des **Sessions et Cookies**. +* Couverture de test à 100 %. +* Base de code annotée à 100 % avec des types. -## Fonctionnalités de Pydantic +## Fonctionnalités de Pydantic { #pydantic-features } -**FastAPI** est totalement compatible avec (et basé sur) Pydantic. Le code utilisant Pydantic que vous ajouterez fonctionnera donc aussi. +**FastAPI** est entièrement compatible avec (et basé sur) Pydantic. Donc, tout code Pydantic additionnel que vous avez fonctionnera aussi. -Inclus des librairies externes basées, aussi, sur Pydantic, servent d'ORMs, ODMs pour les bases de données. +Y compris des bibliothèques externes également basées sur Pydantic, servant d’ORM, d’ODM pour les bases de données. -Cela signifie aussi que, dans la plupart des cas, vous pouvez fournir l'objet reçu d'une requête **directement à la base de données**, comme tout est validé automatiquement. +Cela signifie également que, dans de nombreux cas, vous pouvez passer l'objet que vous recevez d'une requête **directement à la base de données**, puisque tout est validé automatiquement. -Inversement, dans la plupart des cas vous pourrez juste envoyer l'objet récupéré de la base de données **directement au client** +L’inverse est également vrai, dans de nombreux cas, vous pouvez simplement passer l'objet que vous récupérez de la base de données **directement au client**. -Avec **FastAPI** vous aurez toutes les fonctionnalités de **Pydantic** (comme FastAPI est basé sur Pydantic pour toutes les manipulations de données): +Avec **FastAPI** vous obtenez toutes les fonctionnalités de **Pydantic** (puisque FastAPI est basé sur Pydantic pour toute la gestion des données) : -* **Pas de prise de tête**: - * Pas de nouveau langage de définition de schéma à apprendre. - * Si vous connaissez le typage en python vous savez comment utiliser Pydantic. -* Aide votre **IDE/linter/cerveau**: - * Parce que les structures de données de pydantic consistent seulement en une instance de classe que vous définissez; l'auto-complétion, le linting, mypy et votre intuition devrait être largement suffisante pour valider vos données. -* Valide les **structures complexes**: - * Utilise les modèles hiérarchique de Pydantic, le `typage` Python pour les `Lists`, `Dict`, etc. - * Et les validateurs permettent aux schémas de données complexes d'être clairement et facilement définis, validés et documentés sous forme d'un schéma JSON. - * Vous pouvez avoir des objets **JSON fortement imbriqués** tout en ayant, pour chacun, de la validation et des annotations. -* **Renouvelable**: - * Pydantic permet de définir de nouveaux types de données ou vous pouvez étendre la validation avec des méthodes sur un modèle décoré avec le décorateur de validation -* 100% de couverture de test. +* **Pas de prise de tête** : + * Pas de micro-langage de définition de schéma à apprendre. + * Si vous connaissez les types Python vous savez utiliser Pydantic. +* Fonctionne bien avec votre **IDE/linter/cerveau** : + * Parce que les structures de données de Pydantic sont simplement des instances de classes que vous définissez ; l'autocomplétion, le linting, mypy et votre intuition devraient tous bien fonctionner avec vos données validées. +* Valider des **structures complexes** : + * Utilisation de modèles Pydantic hiérarchiques, de `List` et `Dict` du `typing` Python, etc. + * Et les validateurs permettent de définir, vérifier et documenter clairement et facilement des schémas de données complexes en tant que JSON Schema. + * Vous pouvez avoir des objets **JSON fortement imbriqués** et les faire tous valider et annoter. +* **Extensible** : + * Pydantic permet de définir des types de données personnalisés ou vous pouvez étendre la validation avec des méthodes sur un modèle décoré avec le décorateur de validation. +* Couverture de test à 100 %. diff --git a/docs/fr/docs/help-fastapi.md b/docs/fr/docs/help-fastapi.md index 9b75f463b9..08d9a7a723 100644 --- a/docs/fr/docs/help-fastapi.md +++ b/docs/fr/docs/help-fastapi.md @@ -1,103 +1,255 @@ -# Help FastAPI - Obtenir de l'aide +# Aider FastAPI - Obtenir de l'aide { #help-fastapi-get-help } Aimez-vous **FastAPI** ? -Vous souhaitez aider FastAPI, les autres utilisateurs et l'auteur ? +Souhaitez-vous aider FastAPI, les autres utilisateurs et l'auteur ? -Ou souhaitez-vous obtenir de l'aide avec le **FastAPI** ? +Ou souhaitez-vous obtenir de l'aide avec **FastAPI** ? Il existe des moyens très simples d'aider (plusieurs ne nécessitent qu'un ou deux clics). -Il existe également plusieurs façons d'obtenir de l'aide. +Et il existe aussi plusieurs façons d'obtenir de l'aide. -## Star **FastAPI** sur GitHub +## S'abonner à la newsletter { #subscribe-to-the-newsletter } -Vous pouvez "star" FastAPI dans GitHub (en cliquant sur le bouton étoile en haut à droite) : https://github.com/fastapi/fastapi. ⭐️ +Vous pouvez vous abonner à la (peu fréquente) [newsletter **FastAPI and friends**](newsletter.md){.internal-link target=_blank} pour rester informé à propos : -En ajoutant une étoile, les autres utilisateurs pourront la trouver plus facilement et constater qu'elle a déjà été utile à d'autres. +* Nouvelles sur FastAPI et ses amis 🚀 +* Guides 📝 +* Fonctionnalités ✨ +* Changements majeurs 🚨 +* Astuces et conseils ✅ -## Watch le dépôt GitHub pour les releases +## Suivre FastAPI sur X (Twitter) { #follow-fastapi-on-x-twitter } -Vous pouvez "watch" FastAPI dans GitHub (en cliquant sur le bouton "watch" en haut à droite) : https://github.com/fastapi/fastapi. 👀 +Suivez @fastapi sur **X (Twitter)** pour obtenir les dernières nouvelles sur **FastAPI**. 🐦 -Vous pouvez y sélectionner "Releases only". +## Mettre une étoile à **FastAPI** sur GitHub { #star-fastapi-in-github } -Ainsi, vous recevrez des notifications (dans votre courrier électronique) chaque fois qu'il y aura une nouvelle version de **FastAPI** avec des corrections de bugs et de nouvelles fonctionnalités. +Vous pouvez « star » FastAPI sur GitHub (en cliquant sur le bouton étoile en haut à droite) : https://github.com/fastapi/fastapi. ⭐️ -## Se rapprocher de l'auteur +En ajoutant une étoile, les autres utilisateurs pourront le trouver plus facilement et voir qu'il a déjà été utile à d'autres. -Vous pouvez vous rapprocher de moi (Sebastián Ramírez / `tiangolo`), l'auteur. +## Suivre le dépôt GitHub pour les releases { #watch-the-github-repository-for-releases } -Vous pouvez : +Vous pouvez « watch » FastAPI sur GitHub (en cliquant sur le bouton « watch » en haut à droite) : https://github.com/fastapi/fastapi. 👀 + +Vous pouvez y sélectionner « Releases only ». + +Ainsi, vous recevrez des notifications (par e‑mail) chaque fois qu'il y aura une nouvelle release (une nouvelle version) de **FastAPI** avec des corrections de bugs et de nouvelles fonctionnalités. + +## Entrer en contact avec l'auteur { #connect-with-the-author } + +Vous pouvez entrer en contact avec moi (Sebastián Ramírez / `tiangolo`), l'auteur. + +Vous pouvez : * Me suivre sur **GitHub**. * Voir d'autres projets Open Source que j'ai créés et qui pourraient vous aider. - * Suivez-moi pour voir quand je crée un nouveau projet Open Source. -* Me suivre sur **X (Twitter)**. - * Dites-moi comment vous utilisez FastAPI (j'adore entendre ça). - * Entendre quand je fais des annonces ou que je lance de nouveaux outils. -* Vous connectez à moi sur **LinkedIn**. - * Etre notifié quand je fais des annonces ou que je lance de nouveaux outils (bien que j'utilise plus souvent X (Twitter) 🤷‍♂). -* Lire ce que j’écris (ou me suivre) sur **Dev.to** ou **Medium**. - * Lire d'autres idées, articles, et sur les outils que j'ai créés. - * Suivez-moi pour lire quand je publie quelque chose de nouveau. + * Me suivre pour voir quand je crée un nouveau projet Open Source. +* Me suivre sur **X (Twitter)** ou sur Mastodon. + * Me dire comment vous utilisez FastAPI (j'adore l'entendre). + * Être informé quand je fais des annonces ou publie de nouveaux outils. + * Vous pouvez aussi suivre @fastapi sur X (Twitter) (un compte séparé). +* Me suivre sur **LinkedIn**. + * Être informé quand je fais des annonces ou publie de nouveaux outils (même si j'utilise plus souvent X (Twitter) 🤷‍♂). +* Lire ce que j'écris (ou me suivre) sur **Dev.to** ou **Medium**. + * Lire d'autres idées, des articles, et découvrir des outils que j'ai créés. + * Me suivre pour lire quand je publie quelque chose de nouveau. -## Tweeter sur **FastAPI** +## Tweeter à propos de **FastAPI** { #tweet-about-fastapi } -Tweetez à propos de **FastAPI** et faites-moi savoir, ainsi qu'aux autres, pourquoi vous aimez ça. 🎉 +Tweetez à propos de **FastAPI** et faites savoir à moi et aux autres pourquoi vous l'appréciez. 🎉 -J'aime entendre parler de l'utilisation du **FastAPI**, de ce que vous avez aimé dedans, dans quel projet/entreprise l'utilisez-vous, etc. +J'adore entendre comment **FastAPI** est utilisé, ce que vous avez aimé, dans quel projet/quelle entreprise vous l'utilisez, etc. -## Voter pour FastAPI +## Voter pour FastAPI { #vote-for-fastapi } * Votez pour **FastAPI** sur Slant. -* Votez pour **FastAPI** sur AlternativeTo. -* Votez pour **FastAPI** sur awesome-rest. +* Votez pour **FastAPI** sur AlternativeTo. +* Indiquez que vous utilisez **FastAPI** sur StackShare. -## Aider les autres à résoudre les problèmes dans GitHub +## Aider les autres avec des questions sur GitHub { #help-others-with-questions-in-github } -Vous pouvez voir les problèmes existants et essayer d'aider les autres, la plupart du temps il s'agit de questions dont vous connaissez peut-être déjà la réponse. 🤓 +Vous pouvez essayer d'aider les autres avec leurs questions dans : -## Watch le dépôt GitHub +* GitHub Discussions +* GitHub Issues -Vous pouvez "watch" FastAPI dans GitHub (en cliquant sur le bouton "watch" en haut à droite) : https://github.com/fastapi/fastapi. 👀 +Dans de nombreux cas, vous connaissez peut-être déjà la réponse à ces questions. 🤓 -Si vous sélectionnez "Watching" au lieu de "Releases only", vous recevrez des notifications lorsque quelqu'un crée une nouvelle Issue. +Si vous aidez beaucoup de personnes avec leurs questions, vous deviendrez un [Expert FastAPI](fastapi-people.md#fastapi-experts){.internal-link target=_blank} officiel. 🎉 -Vous pouvez alors essayer de les aider à résoudre ces problèmes. +N'oubliez pas, le point le plus important est : essayez d'être aimable. Les gens viennent avec leurs frustrations et, dans bien des cas, ne posent pas la question de la meilleure façon, mais faites de votre mieux pour rester aimable. 🤗 -## Créer une Issue +L'idée est que la communauté **FastAPI** soit bienveillante et accueillante. En même temps, n'acceptez pas l'intimidation ni les comportements irrespectueux envers les autres. Nous devons prendre soin les uns des autres. -Vous pouvez créer une Issue dans le dépôt GitHub, par exemple pour : +--- -* Poser une question ou s'informer sur un problème. -* Suggérer une nouvelle fonctionnalité. +Voici comment aider les autres avec des questions (dans les discussions ou les issues) : -**Note** : si vous créez un problème, alors je vais vous demander d'aider aussi les autres. 😉 +### Comprendre la question { #understand-the-question } -## Créer une Pull Request +* Vérifiez si vous comprenez quel est l’**objectif** et le cas d'utilisation de la personne qui pose la question. -Vous pouvez créer une Pull Request, par exemple : +* Ensuite, vérifiez si la question (la grande majorité sont des questions) est **claire**. -* Pour corriger une faute de frappe que vous avez trouvée sur la documentation. +* Dans de nombreux cas, la question porte sur une solution imaginaire de l'utilisateur, mais il pourrait y en avoir une **meilleure**. Si vous comprenez mieux le problème et le cas d'utilisation, vous pourriez suggérer une **solution alternative** plus adaptée. + +* Si vous ne comprenez pas la question, demandez plus de **détails**. + +### Reproduire le problème { #reproduce-the-problem } + +Dans la plupart des cas et pour la plupart des questions, il y a quelque chose lié au **code original** de la personne. + +Dans de nombreux cas, elle ne copiera qu'un fragment de code, mais ce n'est pas suffisant pour **reproduire le problème**. + +* Vous pouvez leur demander de fournir un exemple minimal, complet et vérifiable, que vous pouvez **copier‑coller** et exécuter localement pour voir la même erreur ou le même comportement qu'ils observent, ou pour mieux comprendre leur cas d'utilisation. + +* Si vous vous sentez très généreux, vous pouvez essayer de **créer un tel exemple** vous‑même, simplement à partir de la description du problème. Gardez simplement à l'esprit que cela peut prendre beaucoup de temps et qu'il peut être préférable de leur demander d'abord de clarifier le problème. + +### Suggérer des solutions { #suggest-solutions } + +* Après avoir compris la question, vous pouvez leur donner une **réponse** possible. + +* Dans de nombreux cas, il est préférable de comprendre leur **problème sous‑jacent ou cas d'utilisation**, car il pourrait exister une meilleure façon de le résoudre que ce qu'ils essaient de faire. + +### Demander la clôture { #ask-to-close } + +S'ils répondent, il y a de fortes chances que vous ayez résolu leur problème, bravo, **vous êtes un héros** ! 🦸 + +* Maintenant, si cela a résolu leur problème, vous pouvez leur demander de : + + * Dans GitHub Discussions : marquer le commentaire comme **réponse**. + * Dans GitHub Issues : **fermer** l'issue. + +## Suivre le dépôt GitHub { #watch-the-github-repository } + +Vous pouvez « watch » FastAPI sur GitHub (en cliquant sur le bouton « watch » en haut à droite) : https://github.com/fastapi/fastapi. 👀 + +Si vous sélectionnez « Watching » au lieu de « Releases only », vous recevrez des notifications lorsque quelqu'un crée une nouvelle issue ou question. Vous pouvez aussi préciser que vous ne souhaitez être notifié que pour les nouvelles issues, ou les discussions, ou les PR, etc. + +Vous pouvez alors essayer de les aider à résoudre ces questions. + +## Poser des questions { #ask-questions } + +Vous pouvez créer une nouvelle question dans le dépôt GitHub, par exemple pour : + +* Poser une **question** ou demander à propos d'un **problème**. +* Suggérer une nouvelle **fonctionnalité**. + +**Remarque** : si vous le faites, je vais vous demander d'aider aussi les autres. 😉 + +## Relire des Pull Requests { #review-pull-requests } + +Vous pouvez m'aider à relire les pull requests des autres. + +Encore une fois, essayez autant que possible d'être aimable. 🤗 + +--- + +Voici ce à garder à l'esprit et comment relire une pull request : + +### Comprendre le problème { #understand-the-problem } + +* D'abord, assurez‑vous de **comprendre le problème** que la pull request essaie de résoudre. Il peut y avoir une discussion plus longue dans une GitHub Discussion ou une issue. + +* Il y a aussi de bonnes chances que la pull request ne soit pas réellement nécessaire parce que le problème peut être résolu d'une **autre manière**. Vous pouvez alors le suggérer ou poser la question. + +### Ne pas s'inquiéter du style { #dont-worry-about-style } + +* Ne vous souciez pas trop des choses comme les styles de messages de commit, je ferai un squash and merge en personnalisant le commit manuellement. + +* Ne vous inquiétez pas non plus des règles de style, il existe déjà des outils automatisés qui vérifient cela. + +Et s'il y a d'autres besoins de style ou de cohérence, je le demanderai directement, ou j'ajouterai des commits par‑dessus avec les changements nécessaires. + +### Vérifier le code { #check-the-code } + +* Vérifiez et lisez le code, voyez s'il a du sens, **exécutez‑le localement** et voyez s'il résout effectivement le problème. + +* Ensuite, **commentez** en disant que vous l'avez fait, c'est ainsi que je saurai que vous l'avez vraiment vérifié. + +/// info + +Malheureusement, je ne peux pas simplement faire confiance aux PR qui ont juste plusieurs approbations. + +Plusieurs fois, il est arrivé qu'il y ait des PR avec 3, 5 ou plus approbations, probablement parce que la description est attrayante, mais lorsque je vérifie les PR, elles sont en fait cassées, ont un bug, ou ne résolvent pas le problème qu'elles prétendent résoudre. 😅 + +Donc, il est vraiment important que vous lisiez et exécutiez le code, et que vous me le disiez dans les commentaires. 🤓 + +/// + +* Si la PR peut être simplifiée d'une certaine manière, vous pouvez le demander, mais il n'est pas nécessaire d'être trop pointilleux, il peut y avoir beaucoup de points de vue subjectifs (et j'aurai les miens aussi 🙈), donc il est préférable de vous concentrer sur les choses fondamentales. + +### Tests { #tests } + +* Aidez‑moi à vérifier que la PR a des **tests**. + +* Vérifiez que les tests **échouent** avant la PR. 🚨 + +* Puis vérifiez que les tests **réussissent** après la PR. ✅ + +* Beaucoup de PR n'ont pas de tests, vous pouvez leur **rappeler** d'ajouter des tests, ou même **suggérer** des tests vous‑même. C'est l'une des choses qui consomment le plus de temps et vous pouvez beaucoup aider. + +* Commentez aussi ce que vous avez essayé, ainsi je saurai que vous l'avez vérifié. 🤓 + +## Créer une Pull Request { #create-a-pull-request } + +Vous pouvez [contribuer](contributing.md){.internal-link target=_blank} au code source avec des Pull Requests, par exemple : + +* Corriger une coquille que vous avez trouvée dans la documentation. +* Partager un article, une vidéo ou un podcast que vous avez créé ou trouvé à propos de FastAPI en modifiant ce fichier. + * Vous devez vous assurer d'ajouter votre lien au début de la section correspondante. +* Aider à [traduire la documentation](contributing.md#translations){.internal-link target=_blank} dans votre langue. + * Vous pouvez aussi aider à relire les traductions créées par d'autres. * Proposer de nouvelles sections de documentation. -* Pour corriger une Issue/Bug existant. -* Pour ajouter une nouvelle fonctionnalité. +* Corriger une issue/un bug existant. + * Vous devez ajouter des tests. +* Ajouter une nouvelle fonctionnalité. + * Vous devez ajouter des tests. + * Vous devez ajouter de la documentation si c'est pertinent. -## Parrainer l'auteur +## Aider à maintenir FastAPI { #help-maintain-fastapi } -Vous pouvez également soutenir financièrement l'auteur (moi) via GitHub sponsors. +Aidez‑moi à maintenir **FastAPI** ! 🤓 -Là, vous pourriez m'offrir un café ☕️ pour me remercier 😄. +Il y a beaucoup de travail à faire, et pour la plupart, **VOUS** pouvez le faire. -## Sponsoriser les outils qui font fonctionner FastAPI +Les principales tâches que vous pouvez faire dès maintenant sont : -Comme vous l'avez vu dans la documentation, FastAPI se tient sur les épaules des géants, Starlette et Pydantic. +* [Aider les autres avec des questions sur GitHub](#help-others-with-questions-in-github){.internal-link target=_blank} (voir la section ci‑dessus). +* [Relire des Pull Requests](#review-pull-requests){.internal-link target=_blank} (voir la section ci‑dessus). -Vous pouvez également parrainer : +Ces deux tâches sont celles qui **consomment le plus de temps**. C'est le travail principal de la maintenance de FastAPI. -* Samuel Colvin (Pydantic) -* Encode (Starlette, Uvicorn) +Si vous pouvez m'aider avec cela, **vous m'aidez à maintenir FastAPI** et à vous assurer qu'il continue **d'avancer plus vite et mieux**. 🚀 + +## Rejoindre le chat { #join-the-chat } + +Rejoignez le 👥 serveur Discord 👥 et échangez avec d'autres membres de la communauté FastAPI. + +/// tip | Astuce + +Pour les questions, posez‑les dans GitHub Discussions, vous avez bien plus de chances de recevoir de l'aide par les [Experts FastAPI](fastapi-people.md#fastapi-experts){.internal-link target=_blank}. + +Utilisez le chat uniquement pour d'autres conversations générales. + +/// + +### N'utilisez pas le chat pour les questions { #dont-use-the-chat-for-questions } + +Gardez à l'esprit que, comme les chats permettent une « conversation libre », il est facile de poser des questions trop générales et plus difficiles à répondre ; vous pourriez donc ne pas recevoir de réponses. + +Sur GitHub, le modèle vous guidera pour rédiger la bonne question afin que vous puissiez plus facilement obtenir une bonne réponse, ou même résoudre le problème vous‑même avant de demander. Et sur GitHub, je peux m'assurer de toujours tout répondre, même si cela prend du temps. Je ne peux pas personnellement faire cela avec les systèmes de chat. 😅 + +Les conversations dans les systèmes de chat ne sont pas non plus aussi facilement recherchables que sur GitHub, donc les questions et réponses peuvent se perdre dans la conversation. Et seules celles sur GitHub comptent pour devenir un [Expert FastAPI](fastapi-people.md#fastapi-experts){.internal-link target=_blank}, vous aurez donc très probablement plus d'attention sur GitHub. + +D'un autre côté, il y a des milliers d'utilisateurs dans les systèmes de chat, il y a donc de fortes chances que vous trouviez presque toujours quelqu'un avec qui parler. 😄 + +## Sponsoriser l'auteur { #sponsor-the-author } + +Si votre **produit/entreprise** dépend de **FastAPI** ou y est lié et que vous souhaitez atteindre ses utilisateurs, vous pouvez sponsoriser l'auteur (moi) via GitHub sponsors. Selon le niveau, vous pourriez obtenir des avantages supplémentaires, comme un badge dans la documentation. 🎁 --- diff --git a/docs/fr/docs/history-design-future.md b/docs/fr/docs/history-design-future.md index 15be545ee6..300f2e0f5c 100644 --- a/docs/fr/docs/history-design-future.md +++ b/docs/fr/docs/history-design-future.md @@ -1,4 +1,4 @@ -# Histoire, conception et avenir +# Histoire, conception et avenir { #history-design-and-future } Il y a quelque temps, un utilisateur de **FastAPI** a demandé : @@ -6,7 +6,7 @@ Il y a quelque temps, @@ -28,7 +28,7 @@ Mais à un moment donné, il n'y avait pas d'autre option que de créer quelque -## Recherche +## Recherche { #investigation } En utilisant toutes les alternatives précédentes, j'ai eu la chance d'apprendre de toutes, de prendre des idées, et de les combiner de la meilleure façon que j'ai pu trouver pour moi-même et les équipes de développeurs avec lesquelles j'ai travaillé. @@ -38,9 +38,9 @@ De plus, la meilleure approche était d'utiliser des normes déjà existantes. Ainsi, avant même de commencer à coder **FastAPI**, j'ai passé plusieurs mois à étudier les spécifications d'OpenAPI, JSON Schema, OAuth2, etc. Comprendre leurs relations, leurs similarités et leurs différences. -## Conception +## Conception { #design } -Ensuite, j'ai passé du temps à concevoir l'"API" de développeur que je voulais avoir en tant qu'utilisateur (en tant que développeur utilisant FastAPI). +Ensuite, j'ai passé du temps à concevoir l'« API » de développeur que je voulais avoir en tant qu'utilisateur (en tant que développeur utilisant FastAPI). J'ai testé plusieurs idées dans les éditeurs Python les plus populaires : PyCharm, VS Code, les éditeurs basés sur Jedi. @@ -48,11 +48,11 @@ D'après la dernière **Pydantic** pour ses avantages. @@ -60,11 +60,11 @@ J'y ai ensuite contribué, pour le rendre entièrement compatible avec JSON Sche Pendant le développement, j'ai également contribué à **Starlette**, l'autre exigence clé. -## Développement +## Développement { #development } Au moment où j'ai commencé à créer **FastAPI** lui-même, la plupart des pièces étaient déjà en place, la conception était définie, les exigences et les outils étaient prêts, et la connaissance des normes et des spécifications était claire et fraîche. -## Futur +## Futur { #future } À ce stade, il est déjà clair que **FastAPI** et ses idées sont utiles pour de nombreuses personnes. @@ -76,4 +76,4 @@ Mais il y a encore de nombreuses améliorations et fonctionnalités à venir. **FastAPI** a un grand avenir devant lui. -Et [votre aide](help-fastapi.md){.internal-link target=\_blank} est grandement appréciée. +Et [votre aide](help-fastapi.md){.internal-link target=_blank} est grandement appréciée. diff --git a/docs/fr/docs/how-to/authentication-error-status-code.md b/docs/fr/docs/how-to/authentication-error-status-code.md new file mode 100644 index 0000000000..b8e87ee71e --- /dev/null +++ b/docs/fr/docs/how-to/authentication-error-status-code.md @@ -0,0 +1,17 @@ +# Utiliser les anciens codes d'erreur d'authentification 403 { #use-old-403-authentication-error-status-codes } + +Avant FastAPI version `0.122.0`, lorsque les utilitaires de sécurité intégrés renvoyaient une erreur au client après un échec d'authentification, ils utilisaient le code d'état HTTP `403 Forbidden`. + +À partir de FastAPI version `0.122.0`, ils utilisent le code d'état HTTP plus approprié `401 Unauthorized`, et renvoient un en-tête `WWW-Authenticate` pertinent dans la réponse, conformément aux spécifications HTTP, RFC 7235, RFC 9110. + +Mais si, pour une raison quelconque, vos clients dépendent de l'ancien comportement, vous pouvez y revenir en surchargeant la méthode `make_not_authenticated_error` dans vos classes de sécurité. + +Par exemple, vous pouvez créer une sous-classe de `HTTPBearer` qui renvoie une erreur `403 Forbidden` au lieu de l'erreur par défaut `401 Unauthorized` : + +{* ../../docs_src/authentication_error_status_code/tutorial001_an_py310.py hl[9:13] *} + +/// tip | Astuce + +Remarquez que la fonction renvoie l'instance de l'exception, elle ne la lève pas. La levée est effectuée dans le reste du code interne. + +/// diff --git a/docs/fr/docs/how-to/conditional-openapi.md b/docs/fr/docs/how-to/conditional-openapi.md new file mode 100644 index 0000000000..61aa187cc5 --- /dev/null +++ b/docs/fr/docs/how-to/conditional-openapi.md @@ -0,0 +1,56 @@ +# Configurer OpenAPI de manière conditionnelle { #conditional-openapi } + +Si nécessaire, vous pouvez utiliser des paramètres et des variables d'environnement pour configurer OpenAPI de manière conditionnelle selon l'environnement, et même le désactiver complètement. + +## À propos de la sécurité, des API et de la documentation { #about-security-apis-and-docs } + +Masquer vos interfaces utilisateur de la documentation en production ne devrait pas être la manière de protéger votre API. + +Cela n'ajoute aucune sécurité supplémentaire à votre API, les *chemins d'accès* resteront disponibles là où ils se trouvent. + +S'il y a une faille de sécurité dans votre code, elle existera toujours. + +Masquer la documentation rend simplement plus difficile la compréhension de la manière d'interagir avec votre API et pourrait aussi rendre son débogage en production plus difficile. Cela pourrait être considéré simplement comme une forme de Sécurité par l'obscurité. + +Si vous voulez sécuriser votre API, il y a plusieurs meilleures approches possibles, par exemple : + +* Vous devez vous assurer d'avoir des modèles Pydantic bien définis pour le corps de la requête et la réponse. +* Configurez toutes les autorisations et tous les rôles nécessaires à l'aide de dépendances. +* Ne stockez jamais de mots de passe en clair, seulement des hachages de mots de passe. +* Implémentez et utilisez des outils cryptographiques reconnus, comme pwdlib et des jetons JWT, ... etc. +* Ajoutez des contrôles d'autorisation plus granulaires avec des scopes OAuth2 lorsque nécessaire. +* ... etc. + +Néanmoins, vous pourriez avoir un cas d'utilisation très spécifique où vous devez vraiment désactiver la documentation de l'API pour un certain environnement (par exemple pour la production) ou selon des configurations provenant de variables d'environnement. + +## Configurer OpenAPI de manière conditionnelle avec des paramètres et des variables d'environnement { #conditional-openapi-from-settings-and-env-vars } + +Vous pouvez facilement utiliser les mêmes paramètres Pydantic pour configurer votre OpenAPI généré et les interfaces utilisateur de la documentation. + +Par exemple : + +{* ../../docs_src/conditional_openapi/tutorial001_py310.py hl[6,11] *} + +Ici nous déclarons le paramètre `openapi_url` avec la même valeur par défaut `"/openapi.json"`. + +Nous l'utilisons ensuite lors de la création de l'application `FastAPI`. + +Vous pouvez alors désactiver OpenAPI (y compris les interfaces utilisateur de la documentation) en définissant la variable d'environnement `OPENAPI_URL` sur la chaîne vide, comme ceci : + +
+ +```console +$ OPENAPI_URL= uvicorn main:app + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Ensuite, si vous allez aux URL `/openapi.json`, `/docs` ou `/redoc`, vous obtiendrez simplement une erreur `404 Not Found` comme : + +```JSON +{ + "detail": "Not Found" +} +``` diff --git a/docs/fr/docs/how-to/configure-swagger-ui.md b/docs/fr/docs/how-to/configure-swagger-ui.md new file mode 100644 index 0000000000..73d0f00e81 --- /dev/null +++ b/docs/fr/docs/how-to/configure-swagger-ui.md @@ -0,0 +1,70 @@ +# Configurer Swagger UI { #configure-swagger-ui } + +Vous pouvez configurer des paramètres supplémentaires de Swagger UI. + +Pour les configurer, passez l'argument `swagger_ui_parameters` lors de la création de l'objet d'application `FastAPI()` ou à la fonction `get_swagger_ui_html()`. + +`swagger_ui_parameters` reçoit un dictionnaire avec les configurations passées directement à Swagger UI. + +FastAPI convertit les configurations en **JSON** pour les rendre compatibles avec JavaScript, car c'est ce dont Swagger UI a besoin. + +## Désactiver la coloration syntaxique { #disable-syntax-highlighting } + +Par exemple, vous pourriez désactiver la coloration syntaxique dans Swagger UI. + +Sans modifier les paramètres, la coloration syntaxique est activée par défaut : + + + +Mais vous pouvez la désactiver en définissant `syntaxHighlight` à `False` : + +{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *} + +... et ensuite Swagger UI n'affichera plus la coloration syntaxique : + + + +## Modifier le thème { #change-the-theme } + +De la même manière, vous pouvez définir le thème de la coloration syntaxique avec la clé « syntaxHighlight.theme » (remarquez le point au milieu) : + +{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *} + +Cette configuration modifierait le thème de couleurs de la coloration syntaxique : + + + +## Modifier les paramètres Swagger UI par défaut { #change-default-swagger-ui-parameters } + +FastAPI inclut des paramètres de configuration par défaut adaptés à la plupart des cas d'utilisation. + +Il inclut ces configurations par défaut : + +{* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *} + +Vous pouvez remplacer n'importe lequel d'entre eux en définissant une valeur différente dans l'argument `swagger_ui_parameters`. + +Par exemple, pour désactiver `deepLinking`, vous pourriez passer ces paramètres à `swagger_ui_parameters` : + +{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *} + +## Autres paramètres de Swagger UI { #other-swagger-ui-parameters } + +Pour voir toutes les autres configurations possibles que vous pouvez utiliser, lisez la documentation officielle des paramètres de Swagger UI. + +## Paramètres JavaScript uniquement { #javascript-only-settings } + +Swagger UI permet également d'autres configurations qui sont des objets réservés à JavaScript (par exemple, des fonctions JavaScript). + +FastAPI inclut aussi ces paramètres `presets` réservés à JavaScript : + +```JavaScript +presets: [ + SwaggerUIBundle.presets.apis, + SwaggerUIBundle.SwaggerUIStandalonePreset +] +``` + +Ce sont des objets **JavaScript**, pas des chaînes, vous ne pouvez donc pas les passer directement depuis du code Python. + +Si vous devez utiliser des configurations réservées à JavaScript comme celles-ci, vous pouvez utiliser l'une des méthodes ci-dessus. Surchargez entièrement le *chemin d'accès* Swagger UI et écrivez manuellement tout JavaScript nécessaire. diff --git a/docs/fr/docs/how-to/custom-docs-ui-assets.md b/docs/fr/docs/how-to/custom-docs-ui-assets.md new file mode 100644 index 0000000000..d239a9696a --- /dev/null +++ b/docs/fr/docs/how-to/custom-docs-ui-assets.md @@ -0,0 +1,185 @@ +# Héberger en propre les ressources statiques de l’UI des docs personnalisées { #custom-docs-ui-static-assets-self-hosting } + +Les documents de l’API utilisent **Swagger UI** et **ReDoc**, et chacune nécessite des fichiers JavaScript et CSS. + +Par défaut, ces fichiers sont servis depuis un CDN. + +Mais il est possible de le personnaliser : vous pouvez définir un CDN spécifique, ou servir vous‑même les fichiers. + +## Configurer un CDN personnalisé pour JavaScript et CSS { #custom-cdn-for-javascript-and-css } + +Supposons que vous souhaitiez utiliser un autre CDN, par exemple vous voulez utiliser `https://unpkg.com/`. + +Cela peut être utile si, par exemple, vous vivez dans un pays qui restreint certaines URL. + +### Désactiver les docs automatiques { #disable-the-automatic-docs } + +La première étape consiste à désactiver les docs automatiques, car par défaut elles utilisent le CDN par défaut. + +Pour les désactiver, définissez leurs URL sur `None` lors de la création de votre application `FastAPI` : + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[8] *} + +### Inclure les docs personnalisées { #include-the-custom-docs } + +Vous pouvez maintenant créer les chemins d'accès pour les docs personnalisées. + +Vous pouvez réutiliser les fonctions internes de FastAPI pour créer les pages HTML de la documentation et leur passer les arguments nécessaires : + +- `openapi_url` : l’URL où la page HTML des docs peut récupérer le schéma OpenAPI de votre API. Vous pouvez utiliser ici l’attribut `app.openapi_url`. +- `title` : le titre de votre API. +- `oauth2_redirect_url` : vous pouvez utiliser `app.swagger_ui_oauth2_redirect_url` ici pour utiliser la valeur par défaut. +- `swagger_js_url` : l’URL où la page HTML de Swagger UI peut récupérer le fichier **JavaScript**. C’est l’URL du CDN personnalisé. +- `swagger_css_url` : l’URL où la page HTML de Swagger UI peut récupérer le fichier **CSS**. C’est l’URL du CDN personnalisé. + +Et de même pour ReDoc ... + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[2:6,11:19,22:24,27:33] *} + +/// tip | Astuce + +Le chemin d'accès pour `swagger_ui_redirect` est un assistant lorsque vous utilisez OAuth2. + +Si vous intégrez votre API à un fournisseur OAuth2, vous pourrez vous authentifier et revenir aux docs de l’API avec les identifiants acquis. Et interagir avec elle en utilisant la véritable authentification OAuth2. + +Swagger UI s’en chargera en arrière‑plan pour vous, mais il a besoin de cet assistant « redirect ». + +/// + +### Créer un chemin d'accès pour tester { #create-a-path-operation-to-test-it } + +Maintenant, pour pouvoir vérifier que tout fonctionne, créez un chemin d'accès : + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[36:38] *} + +### Tester { #test-it } + +Vous devriez maintenant pouvoir aller à vos docs sur http://127.0.0.1:8000/docs, puis recharger la page : elle chargera ces ressources depuis le nouveau CDN. + +## Héberger en propre JavaScript et CSS pour les docs { #self-hosting-javascript-and-css-for-docs } + +Héberger vous‑même le JavaScript et le CSS peut être utile si, par exemple, votre application doit continuer de fonctionner même hors ligne, sans accès Internet ouvert, ou sur un réseau local. + +Vous verrez ici comment servir ces fichiers vous‑même, dans la même application FastAPI, et configurer les docs pour les utiliser. + +### Structure des fichiers du projet { #project-file-structure } + +Supposons que la structure de vos fichiers de projet ressemble à ceci : + +``` +. +├── app +│ ├── __init__.py +│ ├── main.py +``` + +Créez maintenant un répertoire pour stocker ces fichiers statiques. + +Votre nouvelle structure de fichiers pourrait ressembler à ceci : + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +└── static/ +``` + +### Télécharger les fichiers { #download-the-files } + +Téléchargez les fichiers statiques nécessaires aux docs et placez‑les dans ce répertoire `static/`. + +Vous pouvez probablement cliquer avec le bouton droit sur chaque lien et choisir une option similaire à « Enregistrer le lien sous ... ». + +**Swagger UI** utilise les fichiers : + +- `swagger-ui-bundle.js` +- `swagger-ui.css` + +Et **ReDoc** utilise le fichier : + +- `redoc.standalone.js` + +Après cela, votre structure de fichiers pourrait ressembler à : + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +└── static + ├── redoc.standalone.js + ├── swagger-ui-bundle.js + └── swagger-ui.css +``` + +### Servir les fichiers statiques { #serve-the-static-files } + +- Importer `StaticFiles`. +- « Monter » une instance `StaticFiles()` sur un chemin spécifique. + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[7,11] *} + +### Tester les fichiers statiques { #test-the-static-files } + +Démarrez votre application et rendez‑vous sur http://127.0.0.1:8000/static/redoc.standalone.js. + +Vous devriez voir un très long fichier JavaScript pour **ReDoc**. + +Il pourrait commencer par quelque chose comme : + +```JavaScript +/*! For license information please see redoc.standalone.js.LICENSE.txt */ +!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("null")): +... +``` + +Cela confirme que vous parvenez à servir des fichiers statiques depuis votre application et que vous avez placé les fichiers statiques des docs au bon endroit. + +Nous pouvons maintenant configurer l’application pour utiliser ces fichiers statiques pour les docs. + +### Désactiver les docs automatiques pour les fichiers statiques { #disable-the-automatic-docs-for-static-files } + +Comme lors de l’utilisation d’un CDN personnalisé, la première étape consiste à désactiver les docs automatiques, car elles utilisent un CDN par défaut. + +Pour les désactiver, définissez leurs URL sur `None` lors de la création de votre application `FastAPI` : + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[9] *} + +### Inclure les docs personnalisées pour les fichiers statiques { #include-the-custom-docs-for-static-files } + +Et comme avec un CDN personnalisé, vous pouvez maintenant créer les chemins d'accès pour les docs personnalisées. + +Là encore, vous pouvez réutiliser les fonctions internes de FastAPI pour créer les pages HTML de la documentation et leur passer les arguments nécessaires : + +- `openapi_url` : l’URL où la page HTML des docs peut récupérer le schéma OpenAPI de votre API. Vous pouvez utiliser ici l’attribut `app.openapi_url`. +- `title` : le titre de votre API. +- `oauth2_redirect_url` : vous pouvez utiliser `app.swagger_ui_oauth2_redirect_url` ici pour utiliser la valeur par défaut. +- `swagger_js_url` : l’URL où la page HTML de Swagger UI peut récupérer le fichier **JavaScript**. **C’est celui que votre propre application sert désormais**. +- `swagger_css_url` : l’URL où la page HTML de Swagger UI peut récupérer le fichier **CSS**. **C’est celui que votre propre application sert désormais**. + +Et de même pour ReDoc ... + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[2:6,14:22,25:27,30:36] *} + +/// tip | Astuce + +Le chemin d'accès pour `swagger_ui_redirect` est un assistant lorsque vous utilisez OAuth2. + +Si vous intégrez votre API à un fournisseur OAuth2, vous pourrez vous authentifier et revenir aux docs de l’API avec les identifiants acquis. Et interagir avec elle en utilisant la véritable authentification OAuth2. + +Swagger UI s’en chargera en arrière‑plan pour vous, mais il a besoin de cet assistant « redirect ». + +/// + +### Créer un chemin d'accès pour tester les fichiers statiques { #create-a-path-operation-to-test-static-files } + +Maintenant, pour pouvoir vérifier que tout fonctionne, créez un chemin d'accès : + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[39:41] *} + +### Tester l’UI avec des fichiers statiques { #test-static-files-ui } + +Vous devriez maintenant pouvoir couper votre Wi‑Fi, aller à vos docs sur http://127.0.0.1:8000/docs et recharger la page. + +Et même sans Internet, vous pourrez voir la documentation de votre API et interagir avec elle. diff --git a/docs/fr/docs/how-to/custom-request-and-route.md b/docs/fr/docs/how-to/custom-request-and-route.md new file mode 100644 index 0000000000..506187d9f6 --- /dev/null +++ b/docs/fr/docs/how-to/custom-request-and-route.md @@ -0,0 +1,109 @@ +# Personnaliser les classes Request et APIRoute { #custom-request-and-apiroute-class } + +Dans certains cas, vous pouvez vouloir surcharger la logique utilisée par les classes `Request` et `APIRoute`. + +En particulier, cela peut être une bonne alternative à une logique dans un middleware. + +Par exemple, si vous voulez lire ou manipuler le corps de la requête avant qu'il ne soit traité par votre application. + +/// danger | Danger + +Ceci est une fonctionnalité « avancée ». + +Si vous débutez avec **FastAPI**, vous pouvez ignorer cette section. + +/// + +## Cas d'utilisation { #use-cases } + +Voici quelques cas d'utilisation : + +* Convertir des corps de requête non JSON en JSON (par exemple `msgpack`). +* Décompresser des corps de requête compressés en gzip. +* Journaliser automatiquement tous les corps de requête. + +## Gérer les encodages personnalisés du corps de la requête { #handling-custom-request-body-encodings } + +Voyons comment utiliser une sous-classe personnalisée de `Request` pour décompresser des requêtes gzip. + +Et une sous-classe d'`APIRoute` pour utiliser cette classe de requête personnalisée. + +### Créer une classe `GzipRequest` personnalisée { #create-a-custom-gziprequest-class } + +/// tip | Astuce + +Il s'agit d'un exemple simplifié pour montrer le fonctionnement ; si vous avez besoin de la prise en charge de Gzip, vous pouvez utiliser le [`GzipMiddleware`](../advanced/middleware.md#gzipmiddleware){.internal-link target=_blank} fourni. + +/// + +Commencez par créer une classe `GzipRequest`, qui va surcharger la méthode `Request.body()` pour décompresser le corps en présence d'un en-tête approprié. + +S'il n'y a pas `gzip` dans l'en-tête, elle n'essaiera pas de décompresser le corps. + +De cette manière, la même classe de route peut gérer des requêtes gzip compressées ou non compressées. + +{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[9:16] *} + +### Créer une classe `GzipRoute` personnalisée { #create-a-custom-gziproute-class } + +Ensuite, nous créons une sous-classe personnalisée de `fastapi.routing.APIRoute` qui utilisera `GzipRequest`. + +Cette fois, elle va surcharger la méthode `APIRoute.get_route_handler()`. + +Cette méthode renvoie une fonction. Et c'est cette fonction qui recevra une requête et retournera une réponse. + +Ici, nous l'utilisons pour créer une `GzipRequest` à partir de la requête originale. + +{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[19:27] *} + +/// note | Détails techniques + +Un `Request` possède un attribut `request.scope`, qui n'est qu'un `dict` Python contenant les métadonnées liées à la requête. + +Un `Request` a également un `request.receive`, qui est une fonction pour « recevoir » le corps de la requête. + +Le `dict` `scope` et la fonction `receive` font tous deux partie de la spécification ASGI. + +Et ces deux éléments, `scope` et `receive`, sont ce dont on a besoin pour créer une nouvelle instance de `Request`. + +Pour en savoir plus sur `Request`, consultez la documentation de Starlette sur les requêtes. + +/// + +La seule chose que fait différemment la fonction renvoyée par `GzipRequest.get_route_handler`, c'est de convertir la `Request` en `GzipRequest`. + +Ce faisant, notre `GzipRequest` se chargera de décompresser les données (si nécessaire) avant de les transmettre à nos *chemins d'accès*. + +Après cela, toute la logique de traitement est identique. + +Mais grâce à nos modifications dans `GzipRequest.body`, le corps de la requête sera automatiquement décompressé lorsque **FastAPI** le chargera, si nécessaire. + +## Accéder au corps de la requête dans un gestionnaire d'exceptions { #accessing-the-request-body-in-an-exception-handler } + +/// tip | Astuce + +Pour résoudre ce même problème, il est probablement beaucoup plus simple d'utiliser `body` dans un gestionnaire personnalisé pour `RequestValidationError` ([Gérer les erreurs](../tutorial/handling-errors.md#use-the-requestvalidationerror-body){.internal-link target=_blank}). + +Mais cet exemple reste valable et montre comment interagir avec les composants internes. + +/// + +Nous pouvons également utiliser cette même approche pour accéder au corps de la requête dans un gestionnaire d'exceptions. + +Il suffit de traiter la requête dans un bloc `try`/`except` : + +{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[14,16] *} + +Si une exception se produit, l'instance de `Request` sera toujours dans la portée, ce qui nous permet de lire et d'utiliser le corps de la requête lors du traitement de l'erreur : + +{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[17:19] *} + +## Utiliser une classe `APIRoute` personnalisée dans un routeur { #custom-apiroute-class-in-a-router } + +Vous pouvez également définir le paramètre `route_class` d'un `APIRouter` : + +{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[26] *} + +Dans cet exemple, les *chemins d'accès* sous le `router` utiliseront la classe personnalisée `TimedRoute`, et auront un en-tête supplémentaire `X-Response-Time` dans la réponse avec le temps nécessaire pour générer la réponse : + +{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[13:20] *} diff --git a/docs/fr/docs/how-to/extending-openapi.md b/docs/fr/docs/how-to/extending-openapi.md new file mode 100644 index 0000000000..1c540ea6c7 --- /dev/null +++ b/docs/fr/docs/how-to/extending-openapi.md @@ -0,0 +1,80 @@ +# Étendre OpenAPI { #extending-openapi } + +Il existe des cas où vous pouvez avoir besoin de modifier le schéma OpenAPI généré. + +Dans cette section, vous verrez comment faire. + +## Le processus normal { #the-normal-process } + +Le processus normal (par défaut) est le suivant. + +Une application (instance) `FastAPI` a une méthode `.openapi()` censée retourner le schéma OpenAPI. + +Lors de la création de l'objet application, un *chemin d'accès* pour `/openapi.json` (ou pour l'URL que vous avez définie dans votre `openapi_url`) est enregistré. + +Il renvoie simplement une réponse JSON avec le résultat de la méthode `.openapi()` de l'application. + +Par défaut, la méthode `.openapi()` vérifie la propriété `.openapi_schema` pour voir si elle contient des données et les renvoie. + +Sinon, elle les génère à l'aide de la fonction utilitaire `fastapi.openapi.utils.get_openapi`. + +Et cette fonction `get_openapi()` reçoit comme paramètres : + +* `title` : Le titre OpenAPI, affiché dans les documents. +* `version` : La version de votre API, p. ex. `2.5.0`. +* `openapi_version` : La version de la spécification OpenAPI utilisée. Par défaut, la plus récente : `3.1.0`. +* `summary` : Un court résumé de l'API. +* `description` : La description de votre API ; elle peut inclure du markdown et sera affichée dans la documentation. +* `routes` : Une liste de routes ; chacune correspond à un *chemin d'accès* enregistré. Elles sont extraites de `app.routes`. + +/// info + +Le paramètre `summary` est disponible à partir d'OpenAPI 3.1.0, pris en charge par FastAPI 0.99.0 et versions ultérieures. + +/// + +## Remplacer les valeurs par défaut { #overriding-the-defaults } + +En vous appuyant sur les informations ci-dessus, vous pouvez utiliser la même fonction utilitaire pour générer le schéma OpenAPI et remplacer chaque partie dont vous avez besoin. + +Par exemple, ajoutons l’extension OpenAPI de ReDoc pour inclure un logo personnalisé. + +### **FastAPI** normal { #normal-fastapi } + +Tout d’abord, écrivez votre application **FastAPI** comme d’habitude : + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[1,4,7:9] *} + +### Générer le schéma OpenAPI { #generate-the-openapi-schema } + +Ensuite, utilisez la même fonction utilitaire pour générer le schéma OpenAPI, dans une fonction `custom_openapi()` : + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[2,15:21] *} + +### Modifier le schéma OpenAPI { #modify-the-openapi-schema } + +Vous pouvez maintenant ajouter l’extension ReDoc, en ajoutant un `x-logo` personnalisé à l’« objet » `info` dans le schéma OpenAPI : + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[22:24] *} + +### Mettre en cache le schéma OpenAPI { #cache-the-openapi-schema } + +Vous pouvez utiliser la propriété `.openapi_schema` comme « cache » pour stocker votre schéma généré. + +Ainsi, votre application n’aura pas à générer le schéma à chaque fois qu’un utilisateur ouvre les documents de votre API. + +Il ne sera généré qu’une seule fois, puis le même schéma en cache sera utilisé pour les requêtes suivantes. + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[13:14,25:26] *} + +### Remplacer la méthode { #override-the-method } + +Vous pouvez maintenant remplacer la méthode `.openapi()` par votre nouvelle fonction. + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[29] *} + +### Vérifier { #check-it } + +Une fois que vous allez sur http://127.0.0.1:8000/redoc, vous verrez que vous utilisez votre logo personnalisé (dans cet exemple, le logo de **FastAPI**) : + + diff --git a/docs/fr/docs/how-to/general.md b/docs/fr/docs/how-to/general.md new file mode 100644 index 0000000000..09d4498aca --- /dev/null +++ b/docs/fr/docs/how-to/general.md @@ -0,0 +1,39 @@ +# Général - Guides pratiques - Recettes { #general-how-to-recipes } + +Voici plusieurs renvois vers d'autres endroits de la documentation, pour des questions générales ou fréquentes. + +## Filtrer des données - Sécurité { #filter-data-security } + +Pour vous assurer que vous ne renvoyez pas plus de données que nécessaire, lisez la documentation [Tutoriel - Modèle de réponse - Type de retour](../tutorial/response-model.md){.internal-link target=_blank}. + +## Étiquettes de documentation - OpenAPI { #documentation-tags-openapi } + +Pour ajouter des étiquettes à vos *chemins d'accès* et les regrouper dans l'interface utilisateur de la documentation, lisez la documentation [Tutoriel - Configurations de chemin d'accès - Tags](../tutorial/path-operation-configuration.md#tags){.internal-link target=_blank}. + +## Résumé et description de la documentation - OpenAPI { #documentation-summary-and-description-openapi } + +Pour ajouter un résumé et une description à vos *chemins d'accès* et les afficher dans l'interface utilisateur de la documentation, lisez la documentation [Tutoriel - Configurations de chemin d'accès - Résumé et description](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank}. + +## Description de la réponse dans la documentation - OpenAPI { #documentation-response-description-openapi } + +Pour définir la description de la réponse, affichée dans l'interface utilisateur de la documentation, lisez la documentation [Tutoriel - Configurations de chemin d'accès - Description de la réponse](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank}. + +## Déprécier un *chemin d'accès* dans la documentation - OpenAPI { #documentation-deprecate-a-path-operation-openapi } + +Pour déprécier un *chemin d'accès* et l'indiquer dans l'interface utilisateur de la documentation, lisez la documentation [Tutoriel - Configurations de chemin d'accès - Déprécier un chemin d'accès](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank}. + +## Convertir n'importe quelles données au format compatible JSON { #convert-any-data-to-json-compatible } + +Pour convertir des données vers un format compatible JSON, lisez la documentation [Tutoriel - Encodeur compatible JSON](../tutorial/encoder.md){.internal-link target=_blank}. + +## Métadonnées OpenAPI - Documentation { #openapi-metadata-docs } + +Pour ajouter des métadonnées à votre schéma OpenAPI, y compris une licence, une version, un contact, etc., lisez la documentation [Tutoriel - Métadonnées et URLs de la documentation](../tutorial/metadata.md){.internal-link target=_blank}. + +## URL OpenAPI personnalisée { #openapi-custom-url } + +Pour personnaliser l'URL OpenAPI (ou la supprimer), lisez la documentation [Tutoriel - Métadonnées et URLs de la documentation](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}. + +## URL de la documentation OpenAPI { #openapi-docs-urls } + +Pour mettre à jour les URL utilisées pour les interfaces utilisateur de documentation générées automatiquement, lisez la documentation [Tutoriel - Métadonnées et URLs de la documentation](../tutorial/metadata.md#docs-urls){.internal-link target=_blank}. diff --git a/docs/fr/docs/how-to/graphql.md b/docs/fr/docs/how-to/graphql.md new file mode 100644 index 0000000000..59cd1590f3 --- /dev/null +++ b/docs/fr/docs/how-to/graphql.md @@ -0,0 +1,60 @@ +# GraphQL { #graphql } + +Comme **FastAPI** est basé sur la norme **ASGI**, il est très facile d'intégrer toute bibliothèque **GraphQL** également compatible avec ASGI. + +Vous pouvez combiner des *chemins d'accès* FastAPI classiques avec GraphQL dans la même application. + +/// tip | Astuce + +**GraphQL** résout des cas d'utilisation très spécifiques. + +Il présente des **avantages** et des **inconvénients** par rapport aux **API web** classiques. + +Assurez-vous d'évaluer si les **bénéfices** pour votre cas d'utilisation compensent les **inconvénients**. 🤓 + +/// + +## Bibliothèques GraphQL { #graphql-libraries } + +Voici quelques bibliothèques **GraphQL** qui prennent en charge **ASGI**. Vous pouvez les utiliser avec **FastAPI** : + +* Strawberry 🍓 + * Avec la documentation pour FastAPI +* Ariadne + * Avec la documentation pour FastAPI +* Tartiflette + * Avec Tartiflette ASGI pour fournir l'intégration ASGI +* Graphene + * Avec starlette-graphene3 + +## GraphQL avec Strawberry { #graphql-with-strawberry } + +Si vous avez besoin ou souhaitez travailler avec **GraphQL**, **Strawberry** est la bibliothèque **recommandée** car sa conception est la plus proche de celle de **FastAPI**, tout est basé sur des **annotations de type**. + +Selon votre cas d'utilisation, vous pourriez préférer une autre bibliothèque, mais si vous me le demandiez, je vous suggérerais probablement d'essayer **Strawberry**. + +Voici un petit aperçu de la manière dont vous pouvez intégrer Strawberry avec FastAPI : + +{* ../../docs_src/graphql_/tutorial001_py310.py hl[3,22,25] *} + +Vous pouvez en apprendre davantage sur Strawberry dans la documentation de Strawberry. + +Et également la documentation sur Strawberry avec FastAPI. + +## Ancien `GraphQLApp` de Starlette { #older-graphqlapp-from-starlette } + +Les versions précédentes de Starlette incluaient une classe `GraphQLApp` pour s'intégrer à Graphene. + +Elle a été dépréciée dans Starlette, mais si vous avez du code qui l'utilisait, vous pouvez facilement **migrer** vers starlette-graphene3, qui couvre le même cas d'utilisation et propose une **interface presque identique**. + +/// tip | Astuce + +Si vous avez besoin de GraphQL, je vous recommande tout de même de regarder Strawberry, car il est basé sur des annotations de type plutôt que sur des classes et types personnalisés. + +/// + +## En savoir plus { #learn-more } + +Vous pouvez en apprendre davantage sur **GraphQL** dans la documentation officielle de GraphQL. + +Vous pouvez également en lire davantage sur chacune des bibliothèques décrites ci-dessus via leurs liens. diff --git a/docs/fr/docs/how-to/index.md b/docs/fr/docs/how-to/index.md new file mode 100644 index 0000000000..03736fa43f --- /dev/null +++ b/docs/fr/docs/how-to/index.md @@ -0,0 +1,13 @@ +# Comment faire - Recettes { #how-to-recipes } + +Vous trouverez ici différentes recettes ou des guides « comment faire » pour **plusieurs sujets**. + +La plupart de ces idées sont plus ou moins **indépendantes**, et dans la plupart des cas vous n'avez besoin de les étudier que si elles s'appliquent directement à **votre projet**. + +Si quelque chose vous paraît intéressant et utile pour votre projet, allez-y et consultez-le ; sinon, vous pouvez probablement simplement les ignorer. + +/// tip | Astuce + +Si vous voulez **apprendre FastAPI** de façon structurée (recommandé), allez lire le [Tutoriel - Guide utilisateur](../tutorial/index.md){.internal-link target=_blank} chapitre par chapitre à la place. + +/// diff --git a/docs/fr/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md b/docs/fr/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md new file mode 100644 index 0000000000..681cf697bb --- /dev/null +++ b/docs/fr/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md @@ -0,0 +1,135 @@ +# Migrer de Pydantic v1 à Pydantic v2 { #migrate-from-pydantic-v1-to-pydantic-v2 } + +Si vous avez une ancienne application FastAPI, vous utilisez peut-être Pydantic version 1. + +FastAPI version 0.100.0 prenait en charge soit Pydantic v1 soit v2. Il utilisait celle que vous aviez installée. + +FastAPI version 0.119.0 a introduit une prise en charge partielle de Pydantic v1 depuis l'intérieur de Pydantic v2 (comme `pydantic.v1`), pour faciliter la migration vers v2. + +FastAPI 0.126.0 a supprimé la prise en charge de Pydantic v1, tout en continuant à prendre en charge `pydantic.v1` pendant un certain temps. + +/// warning | Alertes + +L'équipe Pydantic a arrêté la prise en charge de Pydantic v1 pour les dernières versions de Python, à partir de Python 3.14. + +Cela inclut `pydantic.v1`, qui n'est plus pris en charge à partir de Python 3.14. + +Si vous souhaitez utiliser les dernières fonctionnalités de Python, vous devez vous assurer que vous utilisez Pydantic v2. + +/// + +Si vous avez une ancienne application FastAPI avec Pydantic v1, je vais vous montrer comment la migrer vers Pydantic v2, et les fonctionnalités de FastAPI 0.119.0 pour vous aider à une migration progressive. + +## Guide officiel { #official-guide } + +Pydantic propose un Guide de migration officiel de la v1 à la v2. + +Il inclut aussi ce qui a changé, comment les validations sont désormais plus correctes et strictes, les pièges possibles, etc. + +Vous pouvez le lire pour mieux comprendre ce qui a changé. + +## Tests { #tests } + +Vous devez vous assurer d'avoir des [tests](../tutorial/testing.md){.internal-link target=_blank} pour votre application et de les exécuter en intégration continue (CI). + +De cette façon, vous pouvez effectuer la mise à niveau et vous assurer que tout fonctionne toujours comme prévu. + +## `bump-pydantic` { #bump-pydantic } + +Dans de nombreux cas, lorsque vous utilisez des modèles Pydantic classiques sans personnalisations, vous pourrez automatiser la majeure partie du processus de migration de Pydantic v1 à Pydantic v2. + +Vous pouvez utiliser `bump-pydantic` de la même équipe Pydantic. + +Cet outil vous aidera à modifier automatiquement la majeure partie du code à adapter. + +Après cela, vous pouvez exécuter les tests et vérifier que tout fonctionne. Si c'est le cas, vous avez terminé. 😎 + +## Pydantic v1 dans v2 { #pydantic-v1-in-v2 } + +Pydantic v2 inclut tout Pydantic v1 sous la forme du sous-module `pydantic.v1`. Mais cela n'est plus pris en charge dans les versions au-delà de Python 3.13. + +Cela signifie que vous pouvez installer la dernière version de Pydantic v2 et importer/utiliser les anciens composants de Pydantic v1 depuis ce sous-module, comme si vous aviez l'ancien Pydantic v1 installé. + +{* ../../docs_src/pydantic_v1_in_v2/tutorial001_an_py310.py hl[1,4] *} + +### Prise en charge de FastAPI pour Pydantic v1 dans v2 { #fastapi-support-for-pydantic-v1-in-v2 } + +Depuis FastAPI 0.119.0, il existe également une prise en charge partielle de Pydantic v1 depuis l'intérieur de Pydantic v2, pour faciliter la migration vers v2. + +Vous pouvez donc mettre à niveau Pydantic vers la dernière version 2 et modifier les imports pour utiliser le sous-module `pydantic.v1`, et dans de nombreux cas cela fonctionnera tel quel. + +{* ../../docs_src/pydantic_v1_in_v2/tutorial002_an_py310.py hl[2,5,15] *} + +/// warning | Alertes + +Gardez à l'esprit que, puisque l'équipe Pydantic ne prend plus en charge Pydantic v1 dans les versions récentes de Python à partir de Python 3.14, l'utilisation de `pydantic.v1` n'est pas non plus prise en charge à partir de Python 3.14. + +/// + +### Pydantic v1 et v2 dans la même application { #pydantic-v1-and-v2-on-the-same-app } + +Pydantic ne prend pas en charge le fait d'avoir un modèle Pydantic v2 contenant des champs eux-mêmes définis comme des modèles Pydantic v1, et inversement. + +```mermaid +graph TB + subgraph "❌ Not Supported" + direction TB + subgraph V2["Pydantic v2 Model"] + V1Field["Pydantic v1 Model"] + end + subgraph V1["Pydantic v1 Model"] + V2Field["Pydantic v2 Model"] + end + end + + style V2 fill:#f9fff3 + style V1 fill:#fff6f0 + style V1Field fill:#fff6f0 + style V2Field fill:#f9fff3 +``` + +... mais vous pouvez avoir des modèles séparés utilisant Pydantic v1 et v2 dans la même application. + +```mermaid +graph TB + subgraph "✅ Supported" + direction TB + subgraph V2["Pydantic v2 Model"] + V2Field["Pydantic v2 Model"] + end + subgraph V1["Pydantic v1 Model"] + V1Field["Pydantic v1 Model"] + end + end + + style V2 fill:#f9fff3 + style V1 fill:#fff6f0 + style V1Field fill:#fff6f0 + style V2Field fill:#f9fff3 +``` + +Dans certains cas, il est même possible d'avoir des modèles Pydantic v1 et v2 dans le même chemin d'accès de votre application FastAPI : + +{* ../../docs_src/pydantic_v1_in_v2/tutorial003_an_py310.py hl[2:3,6,12,21:22] *} + +Dans l'exemple ci-dessus, le modèle d'entrée est un modèle Pydantic v1 et le modèle de sortie (défini dans `response_model=ItemV2`) est un modèle Pydantic v2. + +### Paramètres Pydantic v1 { #pydantic-v1-parameters } + +Si vous devez utiliser certains des outils spécifiques à FastAPI pour les paramètres comme `Body`, `Query`, `Form`, etc., avec des modèles Pydantic v1, vous pouvez les importer depuis `fastapi.temp_pydantic_v1_params` le temps de terminer la migration vers Pydantic v2 : + +{* ../../docs_src/pydantic_v1_in_v2/tutorial004_an_py310.py hl[4,18] *} + +### Migrer par étapes { #migrate-in-steps } + +/// tip | Astuce + +Essayez d'abord avec `bump-pydantic` ; si vos tests passent et que cela fonctionne, vous avez tout terminé en une seule commande. ✨ + +/// + +Si `bump-pydantic` ne fonctionne pas pour votre cas d'usage, vous pouvez utiliser la prise en charge des modèles Pydantic v1 et v2 dans la même application pour effectuer la migration vers Pydantic v2 progressivement. + +Vous pouvez d'abord mettre à niveau Pydantic pour utiliser la dernière version 2 et modifier les imports pour utiliser `pydantic.v1` pour tous vos modèles. + +Ensuite, vous pouvez commencer à migrer vos modèles de Pydantic v1 vers v2 par groupes, par étapes progressives. 🚶 diff --git a/docs/fr/docs/how-to/separate-openapi-schemas.md b/docs/fr/docs/how-to/separate-openapi-schemas.md new file mode 100644 index 0000000000..fd767d7388 --- /dev/null +++ b/docs/fr/docs/how-to/separate-openapi-schemas.md @@ -0,0 +1,102 @@ +# Séparer les schémas OpenAPI pour l'entrée et la sortie ou non { #separate-openapi-schemas-for-input-and-output-or-not } + +Depuis la sortie de **Pydantic v2**, l'OpenAPI généré est un peu plus précis et **correct** qu'avant. 😎 + +En fait, dans certains cas, il y aura même **deux schémas JSON** dans OpenAPI pour le même modèle Pydantic, pour l'entrée et pour la sortie, selon s'ils ont des **valeurs par défaut**. + +Voyons comment cela fonctionne et comment le modifier si vous devez le faire. + +## Utiliser des modèles Pydantic pour l'entrée et la sortie { #pydantic-models-for-input-and-output } + +Supposons que vous ayez un modèle Pydantic avec des valeurs par défaut, comme celui‑ci : + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *} + +### Modèle pour l'entrée { #model-for-input } + +Si vous utilisez ce modèle en entrée comme ici : + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *} + +... alors, le champ `description` ne sera **pas requis**. Parce qu'il a une valeur par défaut de `None`. + +### Modèle d'entrée dans les documents { #input-model-in-docs } + +Vous pouvez le confirmer dans les documents, le champ `description` n'a pas d'**astérisque rouge**, il n'est pas indiqué comme requis : + +
+ +
+ +### Modèle pour la sortie { #model-for-output } + +Mais si vous utilisez le même modèle en sortie, comme ici : + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py hl[19] *} + +... alors, comme `description` a une valeur par défaut, si vous ne retournez rien pour ce champ, il aura tout de même cette **valeur par défaut**. + +### Modèle pour les données de réponse en sortie { #model-for-output-response-data } + +Si vous interagissez avec les documents et vérifiez la réponse, même si le code n'a rien ajouté dans l'un des champs `description`, la réponse JSON contient la valeur par défaut (`null`) : + +
+ +
+ +Cela signifie qu'il aura **toujours une valeur**, simplement, parfois la valeur pourra être `None` (ou `null` en JSON). + +Cela signifie que les clients utilisant votre API n'ont pas à vérifier si la valeur existe ou non, ils peuvent **supposer que le champ sera toujours présent**, mais que, dans certains cas, il aura la valeur par défaut `None`. + +La manière de décrire cela dans OpenAPI est de marquer ce champ comme **requis**, car il sera toujours présent. + +Pour cette raison, le schéma JSON d'un modèle peut être différent selon qu'il est utilisé pour **l'entrée ou la sortie** : + +- pour **l'entrée**, `description` ne sera **pas requis** +- pour **la sortie**, il sera **requis** (et éventuellement `None`, ou en termes JSON, `null`) + +### Modèle de sortie dans les documents { #model-for-output-in-docs } + +Vous pouvez également vérifier le modèle de sortie dans les documents, **à la fois** `name` et `description` sont marqués comme **requis** avec un **astérisque rouge** : + +
+ +
+ +### Modèle pour l'entrée et la sortie dans les documents { #model-for-input-and-output-in-docs } + +Et si vous consultez tous les schémas disponibles (schémas JSON) dans OpenAPI, vous verrez qu'il y en a deux, un `Item-Input` et un `Item-Output`. + +Pour `Item-Input`, `description` n'est **pas requis**, il n'a pas d'astérisque rouge. + +Mais pour `Item-Output`, `description` est **requis**, il a un astérisque rouge. + +
+ +
+ +Avec cette fonctionnalité de **Pydantic v2**, la documentation de votre API est plus **précise**, et si vous avez des clients et SDKs générés automatiquement, ils seront eux aussi plus précis, avec une meilleure **expérience développeur** et davantage de cohérence. 🎉 + +## Ne pas séparer les schémas { #do-not-separate-schemas } + +Il existe des cas où vous pourriez vouloir avoir le **même schéma pour l'entrée et la sortie**. + +Le cas d'usage principal est probablement que vous avez déjà du code client/SDKs générés automatiquement et que vous ne souhaitez pas encore mettre à jour tout ce code client/ces SDKs générés automatiquement ; vous le ferez sans doute à un moment donné, mais peut‑être pas tout de suite. + +Dans ce cas, vous pouvez désactiver cette fonctionnalité dans **FastAPI**, avec le paramètre `separate_input_output_schemas=False`. + +/// info | info + +La prise en charge de `separate_input_output_schemas` a été ajoutée dans FastAPI `0.102.0`. 🤓 + +/// + +{* ../../docs_src/separate_openapi_schemas/tutorial002_py310.py hl[10] *} + +### Utiliser le même schéma pour les modèles d'entrée et de sortie dans les documents { #same-schema-for-input-and-output-models-in-docs } + +Désormais, il n'y aura qu'un seul schéma pour l'entrée et la sortie du modèle, uniquement `Item`, et `description` ne sera pas requis : + +
+ +
diff --git a/docs/fr/docs/how-to/testing-database.md b/docs/fr/docs/how-to/testing-database.md new file mode 100644 index 0000000000..3179bc4c6b --- /dev/null +++ b/docs/fr/docs/how-to/testing-database.md @@ -0,0 +1,7 @@ +# Tester une base de données { #testing-a-database } + +Vous pouvez étudier les bases de données, SQL et SQLModel dans les documents SQLModel. 🤓 + +Il existe un mini tutoriel sur l'utilisation de SQLModel avec FastAPI. ✨ + +Ce tutoriel comprend une section sur les tests des bases de données SQL. 😎 diff --git a/docs/fr/docs/index.md b/docs/fr/docs/index.md index 2aeaa1c692..bf4446b940 100644 --- a/docs/fr/docs/index.md +++ b/docs/fr/docs/index.md @@ -40,7 +40,7 @@ Les principales fonctionnalités sont : * **Rapide** : très hautes performances, au niveau de **NodeJS** et **Go** (grâce à Starlette et Pydantic). [L'un des frameworks Python les plus rapides](#performance). * **Rapide à coder** : augmente la vitesse de développement des fonctionnalités d'environ 200 % à 300 %. * * **Moins de bugs** : réduit d'environ 40 % les erreurs induites par le développeur. * -* **Intuitif** : excellente compatibilité avec les éditeurs. Autocomplétion partout. Moins de temps passé à déboguer. +* **Intuitif** : excellente compatibilité avec les éditeurs. Autocomplétion partout. Moins de temps passé à déboguer. * **Facile** : conçu pour être facile à utiliser et à apprendre. Moins de temps passé à lire les documents. * **Concis** : diminue la duplication de code. Plusieurs fonctionnalités à partir de chaque déclaration de paramètre. Moins de bugs. * **Robuste** : obtenez un code prêt pour la production. Avec une documentation interactive automatique. @@ -368,7 +368,7 @@ item: Item * La validation des données : * des erreurs automatiques et claires lorsque les données ne sont pas valides. * une validation même pour les objets JSON profondément imbriqués. -* Conversion des données d'entrée : venant du réseau vers les données et types Python. Lecture depuis : +* Conversion des données d'entrée : venant du réseau vers les données et types Python. Lecture depuis : * JSON. * Paramètres de chemin. * Paramètres de requête. @@ -376,7 +376,7 @@ item: Item * En-têtes. * Formulaires. * Fichiers. -* Conversion des données de sortie : conversion des données et types Python en données réseau (au format JSON) : +* Conversion des données de sortie : conversion des données et types Python en données réseau (au format JSON) : * Conversion des types Python (`str`, `int`, `float`, `bool`, `list`, etc). * Objets `datetime`. * Objets `UUID`. @@ -439,7 +439,7 @@ Pour un exemple plus complet comprenant plus de fonctionnalités, voir le d'injection de dépendances** très puissant et facile à utiliser. +* Un système **d'injection de dépendances** très puissant et facile à utiliser. * Sécurité et authentification, y compris la prise en charge de **OAuth2** avec des **JWT tokens** et l'authentification **HTTP Basic**. * Des techniques plus avancées (mais tout aussi faciles) pour déclarer des **modèles JSON profondément imbriqués** (grâce à Pydantic). * Intégration **GraphQL** avec Strawberry et d'autres bibliothèques. @@ -524,7 +524,7 @@ Utilisées par Starlette : * httpx - Obligatoire si vous souhaitez utiliser le `TestClient`. * jinja2 - Obligatoire si vous souhaitez utiliser la configuration de template par défaut. -* python-multipart - Obligatoire si vous souhaitez prendre en charge l’« parsing » de formulaires avec `request.form()`. +* python-multipart - Obligatoire si vous souhaitez prendre en charge l’« parsing » de formulaires avec `request.form()`. Utilisées par FastAPI : diff --git a/docs/fr/docs/learn/index.md b/docs/fr/docs/learn/index.md index 5526877038..e595ecf789 100644 --- a/docs/fr/docs/learn/index.md +++ b/docs/fr/docs/learn/index.md @@ -2,4 +2,4 @@ Voici les sections introductives et les tutoriels pour apprendre **FastAPI**. -Vous pouvez considérer ceci comme un **livre**, un **cours**, la **méthode officielle** et recommandée pour apprendre FastAPI. 😎 +Vous pouvez considérer ceci comme un **livre**, un **cours**, la méthode **officielle** et recommandée pour apprendre FastAPI. 😎 diff --git a/docs/fr/docs/python-types.md b/docs/fr/docs/python-types.md index f393b0f5c1..770f1514ac 100644 --- a/docs/fr/docs/python-types.md +++ b/docs/fr/docs/python-types.md @@ -1,8 +1,8 @@ # Introduction aux types Python { #python-types-intro } -Python prend en charge des « type hints » (aussi appelées « annotations de type ») facultatives. +Python prend en charge des « annotations de type » (aussi appelées « type hints ») facultatives. -Ces « type hints » ou annotations sont une syntaxe spéciale qui permet de déclarer le type d'une variable. +Ces **« annotations de type »** sont une syntaxe spéciale qui permet de déclarer le type d'une variable. En déclarant les types de vos variables, les éditeurs et outils peuvent vous offrir un meilleur support. @@ -22,7 +22,7 @@ Si vous êtes un expert Python, et que vous savez déjà tout sur les annotation Commençons par un exemple simple : -{* ../../docs_src/python_types/tutorial001_py39.py *} +{* ../../docs_src/python_types/tutorial001_py310.py *} Exécuter ce programme affiche : @@ -34,9 +34,9 @@ La fonction fait ce qui suit : * Prend un `first_name` et un `last_name`. * Convertit la première lettre de chacun en majuscule avec `title()`. -* Concatène ces deux valeurs avec un espace au milieu. +* Concatène ces deux valeurs avec un espace au milieu. -{* ../../docs_src/python_types/tutorial001_py39.py hl[2] *} +{* ../../docs_src/python_types/tutorial001_py310.py hl[2] *} ### Modifier le code { #edit-it } @@ -78,7 +78,7 @@ C'est tout. Ce sont les « annotations de type » : -{* ../../docs_src/python_types/tutorial002_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial002_py310.py hl[1] *} Ce n'est pas la même chose que de déclarer des valeurs par défaut, ce qui serait : @@ -106,7 +106,7 @@ Avec cela, vous pouvez faire défiler en voyant les options, jusqu'à trouver ce Regardez cette fonction, elle a déjà des annotations de type : -{* ../../docs_src/python_types/tutorial003_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial003_py310.py hl[1] *} Comme l'éditeur connaît les types des variables, vous n'obtenez pas seulement l'autocomplétion, vous obtenez aussi des vérifications d'erreurs : @@ -114,7 +114,7 @@ Comme l'éditeur connaît les types des variables, vous n'obtenez pas seulement Vous savez maintenant qu'il faut corriger, convertir `age` en chaîne avec `str(age)` : -{* ../../docs_src/python_types/tutorial004_py39.py hl[2] *} +{* ../../docs_src/python_types/tutorial004_py310.py hl[2] *} ## Déclarer des types { #declaring-types } @@ -133,29 +133,32 @@ Vous pouvez utiliser, par exemple : * `bool` * `bytes` -{* ../../docs_src/python_types/tutorial005_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial005_py310.py hl[1] *} -### Types génériques avec paramètres de type { #generic-types-with-type-parameters } +### Module `typing` { #typing-module } -Il existe certaines structures de données qui peuvent contenir d'autres valeurs, comme `dict`, `list`, `set` et `tuple`. Et les valeurs internes peuvent aussi avoir leur propre type. +Pour certains cas d'utilisation supplémentaires, vous pourriez avoir besoin d'importer certains éléments depuis le module standard `typing`, par exemple lorsque vous voulez déclarer que quelque chose a « n'importe quel type », vous pouvez utiliser `Any` depuis `typing` : -Ces types qui ont des types internes sont appelés types « génériques ». Et il est possible de les déclarer, même avec leurs types internes. +```python +from typing import Any -Pour déclarer ces types et les types internes, vous pouvez utiliser le module standard Python `typing`. Il existe spécifiquement pour prendre en charge ces annotations de type. -#### Versions plus récentes de Python { #newer-versions-of-python } +def some_function(data: Any): + print(data) +``` -La syntaxe utilisant `typing` est compatible avec toutes les versions, de Python 3.6 aux plus récentes, y compris Python 3.9, Python 3.10, etc. +### Types génériques { #generic-types } -Au fur et à mesure que Python évolue, les versions plus récentes apportent un meilleur support pour ces annotations de type et dans de nombreux cas vous n'aurez même pas besoin d'importer et d'utiliser le module `typing` pour les déclarer. +Certains types peuvent prendre des « paramètres de type » entre crochets, pour définir leurs types internes, par exemple une « liste de chaînes » se déclarerait `list[str]`. -Si vous pouvez choisir une version plus récente de Python pour votre projet, vous pourrez profiter de cette simplicité supplémentaire. +Ces types qui peuvent prendre des paramètres de type sont appelés des **types génériques** ou **Generics**. -Dans toute la documentation, il y a des exemples compatibles avec chaque version de Python (lorsqu'il y a une différence). +Vous pouvez utiliser les mêmes types intégrés comme génériques (avec des crochets et des types à l'intérieur) : -Par exemple « Python 3.6+ » signifie que c'est compatible avec Python 3.6 ou supérieur (y compris 3.7, 3.8, 3.9, 3.10, etc.). Et « Python 3.9+ » signifie que c'est compatible avec Python 3.9 ou supérieur (y compris 3.10, etc). - -Si vous pouvez utiliser les dernières versions de Python, utilisez les exemples pour la dernière version, ils auront la meilleure et la plus simple syntaxe, par exemple, « Python 3.10+ ». +* `list` +* `tuple` +* `set` +* `dict` #### Liste { #list } @@ -167,9 +170,9 @@ Comme type, mettez `list`. Comme la liste est un type qui contient des types internes, mettez-les entre crochets : -{* ../../docs_src/python_types/tutorial006_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial006_py310.py hl[1] *} -/// info +/// info | Info Ces types internes entre crochets sont appelés « paramètres de type ». @@ -193,7 +196,7 @@ Et pourtant, l'éditeur sait que c'est un `str` et fournit le support approprié Vous feriez la même chose pour déclarer des `tuple` et des `set` : -{* ../../docs_src/python_types/tutorial007_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial007_py310.py hl[1] *} Cela signifie : @@ -208,7 +211,7 @@ Le premier paramètre de type est pour les clés du `dict`. Le second paramètre de type est pour les valeurs du `dict` : -{* ../../docs_src/python_types/tutorial008_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial008_py310.py hl[1] *} Cela signifie : @@ -218,46 +221,22 @@ Cela signifie : #### Union { #union } -Vous pouvez déclarer qu'une variable peut être de plusieurs types, par exemple, un `int` ou un `str`. +Vous pouvez déclarer qu'une variable peut être **plusieurs types**, par exemple, un `int` ou un `str`. -Dans Python 3.6 et supérieur (y compris Python 3.10), vous pouvez utiliser le type `Union` de `typing` et mettre entre crochets les types possibles à accepter. +Pour le définir, vous utilisez la barre verticale (`|`) pour séparer les deux types. -Dans Python 3.10, il existe aussi une nouvelle syntaxe où vous pouvez mettre les types possibles séparés par une barre verticale (`|`). - -//// tab | Python 3.10+ +C'est ce qu'on appelle une « union », car la variable peut être n'importe quoi dans l'union de ces deux ensembles de types. ```Python hl_lines="1" {!> ../../docs_src/python_types/tutorial008b_py310.py!} ``` -//// - -//// tab | Python 3.9+ - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial008b_py39.py!} -``` - -//// - -Dans les deux cas, cela signifie que `item` peut être un `int` ou un `str`. +Cela signifie que `item` peut être un `int` ou un `str`. #### Possiblement `None` { #possibly-none } Vous pouvez déclarer qu'une valeur peut avoir un type, comme `str`, mais qu'elle peut aussi être `None`. -Dans Python 3.6 et supérieur (y compris Python 3.10), vous pouvez le déclarer en important et en utilisant `Optional` depuis le module `typing`. - -```Python hl_lines="1 4" -{!../../docs_src/python_types/tutorial009_py39.py!} -``` - -Utiliser `Optional[str]` au lieu de simplement `str` permettra à l'éditeur de vous aider à détecter des erreurs où vous supposeriez qu'une valeur est toujours un `str`, alors qu'elle pourrait en fait aussi être `None`. - -`Optional[Something]` est en réalité un raccourci pour `Union[Something, None]`, ils sont équivalents. - -Cela signifie aussi que dans Python 3.10, vous pouvez utiliser `Something | None` : - //// tab | Python 3.10+ ```Python hl_lines="1" @@ -266,96 +245,7 @@ Cela signifie aussi que dans Python 3.10, vous pouvez utiliser `Something | None //// -//// tab | Python 3.9+ - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial009_py39.py!} -``` - -//// - -//// tab | Python 3.9+ alternative - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial009b_py39.py!} -``` - -//// - -#### Utiliser `Union` ou `Optional` { #using-union-or-optional } - -Si vous utilisez une version de Python inférieure à 3.10, voici un conseil de mon point de vue très **subjectif** : - -* 🚨 Évitez d'utiliser `Optional[SomeType]` -* À la place ✨ **utilisez `Union[SomeType, None]`** ✨. - -Les deux sont équivalents et sous le capot ce sont les mêmes, mais je recommanderais `Union` plutôt que `Optional` parce que le mot « facultatif » semble impliquer que la valeur est optionnelle, alors que cela signifie en fait « elle peut être `None` », même si elle n'est pas facultative et est toujours requise. - -Je pense que `Union[SomeType, None]` est plus explicite sur ce que cela signifie. - -Il ne s'agit que des mots et des noms. Mais ces mots peuvent influencer la manière dont vous et vos coéquipiers pensez au code. - -Par exemple, prenons cette fonction : - -{* ../../docs_src/python_types/tutorial009c_py39.py hl[1,4] *} - -Le paramètre `name` est défini comme `Optional[str]`, mais il n'est pas facultatif, vous ne pouvez pas appeler la fonction sans le paramètre : - -```Python -say_hi() # Oh non, cela lève une erreur ! 😱 -``` - -Le paramètre `name` est toujours requis (pas « optionnel ») parce qu'il n'a pas de valeur par défaut. Néanmoins, `name` accepte `None` comme valeur : - -```Python -say_hi(name=None) # Cela fonctionne, None est valide 🎉 -``` - -La bonne nouvelle est que, dès que vous êtes sur Python 3.10, vous n'avez plus à vous en soucier, car vous pourrez simplement utiliser `|` pour définir des unions de types : - -{* ../../docs_src/python_types/tutorial009c_py310.py hl[1,4] *} - -Et alors vous n'aurez plus à vous soucier de noms comme `Optional` et `Union`. 😎 - -#### Types génériques { #generic-types } - -Ces types qui prennent des paramètres de type entre crochets sont appelés des **types génériques** ou **Generics**, par exemple : - -//// tab | Python 3.10+ - -Vous pouvez utiliser les mêmes types intégrés comme génériques (avec des crochets et des types à l'intérieur) : - -* `list` -* `tuple` -* `set` -* `dict` - -Et, comme avec les versions précédentes de Python, depuis le module `typing` : - -* `Union` -* `Optional` -* ... et d'autres. - -Dans Python 3.10, comme alternative à l'utilisation des génériques `Union` et `Optional`, vous pouvez utiliser la barre verticale (`|`) pour déclarer des unions de types, c'est bien mieux et plus simple. - -//// - -//// tab | Python 3.9+ - -Vous pouvez utiliser les mêmes types intégrés comme génériques (avec des crochets et des types à l'intérieur) : - -* `list` -* `tuple` -* `set` -* `dict` - -Et des génériques depuis le module `typing` : - -* `Union` -* `Optional` -* ... et d'autres. - -//// +Utiliser `str | None` au lieu de simplement `str` permettra à l'éditeur de vous aider à détecter des erreurs où vous supposeriez qu'une valeur est toujours un `str`, alors qu'elle pourrait en fait aussi être `None`. ### Classes en tant que types { #classes-as-types } @@ -363,19 +253,19 @@ Vous pouvez aussi déclarer une classe comme type d'une variable. Disons que vous avez une classe `Person`, avec un nom : -{* ../../docs_src/python_types/tutorial010_py39.py hl[1:3] *} +{* ../../docs_src/python_types/tutorial010_py310.py hl[1:3] *} Vous pouvez ensuite déclarer une variable de type `Person` : -{* ../../docs_src/python_types/tutorial010_py39.py hl[6] *} +{* ../../docs_src/python_types/tutorial010_py310.py hl[6] *} Et là encore, vous obtenez tout le support de l'éditeur : -Remarquez que cela signifie « `one_person` est une instance de la classe `Person` ». +Remarquez que cela signifie « `one_person` est une **instance** de la classe `Person` ». -Cela ne signifie pas « `one_person` est la classe appelée `Person` ». +Cela ne signifie pas « `one_person` est la **classe** appelée `Person` ». ## Modèles Pydantic { #pydantic-models } @@ -393,7 +283,7 @@ Un exemple tiré de la documentation officielle de Pydantic : {* ../../docs_src/python_types/tutorial011_py310.py *} -/// info +/// info | Info Pour en savoir plus à propos de Pydantic, consultez sa documentation. @@ -403,33 +293,27 @@ Pour en savoir plus à propos de champs Optionals requis. - -/// - ## Annotations de type avec métadonnées { #type-hints-with-metadata-annotations } -Python dispose également d'une fonctionnalité qui permet de mettre des **métadonnées supplémentaires** dans ces annotations de type en utilisant `Annotated`. +Python dispose également d'une fonctionnalité qui permet de mettre des **métadonnées supplémentaires** dans ces annotations de type en utilisant `Annotated`. -Depuis Python 3.9, `Annotated` fait partie de la bibliothèque standard, vous pouvez donc l'importer depuis `typing`. +Vous pouvez importer `Annotated` depuis `typing`. -{* ../../docs_src/python_types/tutorial013_py39.py hl[1,4] *} +{* ../../docs_src/python_types/tutorial013_py310.py hl[1,4] *} Python lui-même ne fait rien avec ce `Annotated`. Et pour les éditeurs et autres outils, le type est toujours `str`. Mais vous pouvez utiliser cet espace dans `Annotated` pour fournir à **FastAPI** des métadonnées supplémentaires sur la façon dont vous voulez que votre application se comporte. -L'important à retenir est que le premier paramètre de type que vous passez à `Annotated` est le type réel. Le reste n'est que des métadonnées pour d'autres outils. +L'important à retenir est que **le premier « paramètre de type »** que vous passez à `Annotated` est le **type réel**. Le reste n'est que des métadonnées pour d'autres outils. Pour l'instant, vous avez juste besoin de savoir que `Annotated` existe, et que c'est du Python standard. 😎 -Plus tard, vous verrez à quel point cela peut être puissant. +Plus tard, vous verrez à quel point cela peut être **puissant**. /// tip | Astuce -Le fait que ce soit du Python standard signifie que vous bénéficierez toujours de la meilleure expérience développeur possible dans votre éditeur, avec les outils que vous utilisez pour analyser et refactoriser votre code, etc. ✨ +Le fait que ce soit du **Python standard** signifie que vous bénéficierez toujours de la **meilleure expérience développeur possible** dans votre éditeur, avec les outils que vous utilisez pour analyser et refactoriser votre code, etc. ✨ Et aussi que votre code sera très compatible avec de nombreux autres outils et bibliothèques Python. 🚀 @@ -457,7 +341,7 @@ Tout cela peut sembler abstrait. Ne vous inquiétez pas. Vous verrez tout cela e L'important est qu'en utilisant les types standards de Python, en un seul endroit (au lieu d'ajouter plus de classes, de décorateurs, etc.), **FastAPI** fera une grande partie du travail pour vous. -/// info +/// info | Info Si vous avez déjà parcouru tout le tutoriel et êtes revenu pour en voir plus sur les types, une bonne ressource est l'« aide-mémoire » de `mypy`. diff --git a/docs/fr/docs/resources/index.md b/docs/fr/docs/resources/index.md new file mode 100644 index 0000000000..e62db346da --- /dev/null +++ b/docs/fr/docs/resources/index.md @@ -0,0 +1,3 @@ +# Ressources { #resources } + +Ressources supplémentaires, liens externes et plus encore. ✈️ diff --git a/docs/fr/docs/translation-banner.md b/docs/fr/docs/translation-banner.md new file mode 100644 index 0000000000..9eaedf1b1b --- /dev/null +++ b/docs/fr/docs/translation-banner.md @@ -0,0 +1,11 @@ +/// details | 🌐 Traduction par IA et humains + +Cette traduction a été réalisée par une IA guidée par des humains. 🤝 + +Elle peut contenir des erreurs d'interprétation du sens original, ou paraître peu naturelle, etc. 🤖 + +Vous pouvez améliorer cette traduction en [nous aidant à mieux guider le LLM d'IA](https://fastapi.tiangolo.com/fr/contributing/#translations). + +[Version anglaise](ENGLISH_VERSION_URL) + +/// diff --git a/docs/fr/docs/tutorial/background-tasks.md b/docs/fr/docs/tutorial/background-tasks.md index ed7494669f..a8444ba27a 100644 --- a/docs/fr/docs/tutorial/background-tasks.md +++ b/docs/fr/docs/tutorial/background-tasks.md @@ -15,12 +15,14 @@ Cela comprend, par exemple : Pour commencer, importez `BackgroundTasks` et définissez un paramètre dans votre *fonction de chemin d'accès* avec `BackgroundTasks` comme type déclaré. -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[1,13] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[1,13] *} **FastAPI** créera l'objet de type `BackgroundTasks` pour vous et le passera comme paramètre. ## Créer une fonction de tâche { #create-a-task-function } +Créez une fonction à exécuter comme tâche d'arrière-plan. + Une fonction à exécuter comme tâche d'arrière-plan est juste une fonction standard qui peut recevoir des paramètres. Elle peut être une fonction asynchrone (`async def`) ou une fonction normale (`def`), **FastAPI** saura la gérer correctement. @@ -29,13 +31,13 @@ Dans cet exemple, la fonction de tâche écrira dans un fichier (afin de simuler L'opération d'écriture n'utilisant ni `async` ni `await`, on définit la fonction avec un `def` normal. -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[6:9] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[6:9] *} ## Ajouter une tâche d'arrière-plan { #add-the-background-task } Dans votre *fonction de chemin d'accès*, passez votre fonction de tâche à l'objet de type `BackgroundTasks` (`background_tasks` ici) grâce à la méthode `.add_task()` : -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[14] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[14] *} `.add_task()` reçoit comme arguments : diff --git a/docs/fr/docs/tutorial/bigger-applications.md b/docs/fr/docs/tutorial/bigger-applications.md new file mode 100644 index 0000000000..0659622366 --- /dev/null +++ b/docs/fr/docs/tutorial/bigger-applications.md @@ -0,0 +1,504 @@ +# Créer des applications plus grandes - Plusieurs fichiers { #bigger-applications-multiple-files } + +Si vous créez une application ou une API web, il est rare que vous puissiez tout mettre dans un seul fichier. + +**FastAPI** fournit un outil pratique pour structurer votre application tout en conservant toute la flexibilité. + +/// info + +Si vous venez de Flask, cela équivaut aux Blueprints de Flask. + +/// + +## Exemple de structure de fichiers { #an-example-file-structure } + +Supposons que vous ayez une structure de fichiers comme ceci : + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +│   ├── dependencies.py +│   └── routers +│   │ ├── __init__.py +│   │ ├── items.py +│   │ └── users.py +│   └── internal +│   ├── __init__.py +│   └── admin.py +``` + +/// tip | Astuce + +Il y a plusieurs fichiers `__init__.py` : un dans chaque répertoire ou sous-répertoire. + +C'est cela qui permet d'importer du code d'un fichier dans un autre. + +Par exemple, dans `app/main.py` vous pourriez avoir une ligne comme : + +``` +from app.routers import items +``` + +/// + +* Le répertoire `app` contient tout. Et il a un fichier vide `app/__init__.py`, c'est donc un « package Python » (une collection de « modules Python ») : `app`. +* Il contient un fichier `app/main.py`. Comme il se trouve dans un package Python (un répertoire avec un fichier `__init__.py`), c'est un « module » de ce package : `app.main`. +* Il y a aussi un fichier `app/dependencies.py`, tout comme `app/main.py`, c'est un « module » : `app.dependencies`. +* Il y a un sous-répertoire `app/routers/` avec un autre fichier `__init__.py`, c'est donc un « sous-package Python » : `app.routers`. +* Le fichier `app/routers/items.py` est dans un package, `app/routers/`, c'est donc un sous-module : `app.routers.items`. +* De même pour `app/routers/users.py`, c'est un autre sous-module : `app.routers.users`. +* Il y a aussi un sous-répertoire `app/internal/` avec un autre fichier `__init__.py`, c'est donc un autre « sous-package Python » : `app.internal`. +* Et le fichier `app/internal/admin.py` est un autre sous-module : `app.internal.admin`. + + + +La même structure de fichiers avec des commentaires : + +```bash +. +├── app # "app" est un package Python +│   ├── __init__.py # ce fichier fait de "app" un "package Python" +│   ├── main.py # module "main", ex. import app.main +│   ├── dependencies.py # module "dependencies", ex. import app.dependencies +│   └── routers # "routers" est un "sous-package Python" +│   │ ├── __init__.py # fait de "routers" un "sous-package Python" +│   │ ├── items.py # sous-module "items", ex. import app.routers.items +│   │ └── users.py # sous-module "users", ex. import app.routers.users +│   └── internal # "internal" est un "sous-package Python" +│   ├── __init__.py # fait de "internal" un "sous-package Python" +│   └── admin.py # sous-module "admin", ex. import app.internal.admin +``` + +## `APIRouter` { #apirouter } + +Supposons que le fichier dédié à la gestion des utilisateurs soit le sous-module `/app/routers/users.py`. + +Vous voulez séparer les *chemins d'accès* liés à vos utilisateurs du reste du code pour le garder organisé. + +Mais cela fait toujours partie de la même application/API web **FastAPI** (cela fait partie du même « package Python »). + +Vous pouvez créer les *chemins d'accès* pour ce module à l'aide de `APIRouter`. + +### Importer `APIRouter` { #import-apirouter } + +Vous l'importez et créez une « instance » de la même manière que vous le feriez avec la classe `FastAPI` : + +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *} + +### Déclarer des *chemins d'accès* avec `APIRouter` { #path-operations-with-apirouter } + +Puis vous l'utilisez pour déclarer vos *chemins d'accès*. + +Utilisez-le de la même manière que vous utiliseriez la classe `FastAPI` : + +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[6,11,16] title["app/routers/users.py"] *} + +Vous pouvez considérer `APIRouter` comme une « mini `FastAPI` ». + +Toutes les mêmes options sont prises en charge. + +Tous les mêmes `parameters`, `responses`, `dependencies`, `tags`, etc. + +/// tip | Astuce + +Dans cet exemple, la variable s'appelle `router`, mais vous pouvez la nommer comme vous le souhaitez. + +/// + +Nous allons inclure ce `APIRouter` dans l'application principale `FastAPI`, mais d'abord, examinons les dépendances et un autre `APIRouter`. + +## Gérer les dépendances { #dependencies } + +Nous voyons que nous allons avoir besoin de certaines dépendances utilisées à plusieurs endroits de l'application. + +Nous les mettons donc dans leur propre module `dependencies` (`app/dependencies.py`). + +Nous allons maintenant utiliser une dépendance simple pour lire un en-tête personnalisé `X-Token` : + +{* ../../docs_src/bigger_applications/app_an_py310/dependencies.py hl[3,6:8] title["app/dependencies.py"] *} + +/// tip | Astuce + +Nous utilisons un en-tête inventé pour simplifier cet exemple. + +Mais dans les cas réels, vous obtiendrez de meilleurs résultats en utilisant les [utilitaires de sécurité](security/index.md){.internal-link target=_blank} intégrés. + +/// + +## Créer un autre module avec `APIRouter` { #another-module-with-apirouter } + +Supposons que vous ayez également les endpoints dédiés à la gestion des « items » de votre application dans le module `app/routers/items.py`. + +Vous avez des *chemins d'accès* pour : + +* `/items/` +* `/items/{item_id}` + +C'est exactement la même structure que pour `app/routers/users.py`. + +Mais nous voulons être plus malins et simplifier un peu le code. + +Nous savons que tous les *chemins d'accès* de ce module ont les mêmes éléments : + +* Préfixe de chemin `prefix` : `/items`. +* `tags` : (un seul tag : `items`). +* `responses` supplémentaires. +* `dependencies` : ils ont tous besoin de la dépendance `X-Token` que nous avons créée. + +Donc, au lieu d'ajouter tout cela à chaque *chemin d'accès*, nous pouvons l'ajouter au `APIRouter`. + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[5:10,16,21] title["app/routers/items.py"] *} + +Comme le chemin de chaque *chemin d'accès* doit commencer par `/`, comme dans : + +```Python hl_lines="1" +@router.get("/{item_id}") +async def read_item(item_id: str): + ... +``` + +... le préfixe ne doit pas inclure un `/` final. + +Ainsi, le préfixe dans ce cas est `/items`. + +Nous pouvons également ajouter une liste de `tags` et des `responses` supplémentaires qui seront appliqués à tous les *chemins d'accès* inclus dans ce routeur. + +Et nous pouvons ajouter une liste de `dependencies` qui seront ajoutées à tous les *chemins d'accès* du routeur et seront exécutées/résolues pour chaque requête qui leur est faite. + +/// tip | Astuce + +Notez que, tout comme pour les [dépendances dans les décorateurs de *chemin d'accès*](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, aucune valeur ne sera transmise à votre *fonction de chemin d'accès*. + +/// + +Le résultat final est que les chemins d'item sont désormais : + +* `/items/` +* `/items/{item_id}` + +... comme prévu. + +* Ils seront marqués avec une liste de tags qui contient une seule chaîne « items ». + * Ces « tags » sont particulièrement utiles pour les systèmes de documentation interactive automatique (utilisant OpenAPI). +* Ils incluront tous les `responses` prédéfinies. +* Tous ces *chemins d'accès* auront la liste des `dependencies` évaluées/exécutées avant eux. + * Si vous déclarez également des dépendances dans un *chemin d'accès* spécifique, **elles seront aussi exécutées**. + * Les dépendances du routeur sont exécutées en premier, puis les [`dependencies` dans le décorateur](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, puis les dépendances des paramètres normaux. + * Vous pouvez également ajouter des [`Security` dependencies avec des `scopes`](../advanced/security/oauth2-scopes.md){.internal-link target=_blank}. + +/// tip | Astuce + +Avoir des `dependencies` dans le `APIRouter` peut servir, par exemple, à exiger une authentification pour tout un groupe de *chemins d'accès*. Même si les dépendances ne sont pas ajoutées individuellement à chacun d'eux. + +/// + +/// check | Vérifications + +Les paramètres `prefix`, `tags`, `responses` et `dependencies` sont (comme dans de nombreux autres cas) simplement une fonctionnalité de **FastAPI** pour vous aider à éviter la duplication de code. + +/// + +### Importer les dépendances { #import-the-dependencies } + +Ce code se trouve dans le module `app.routers.items`, le fichier `app/routers/items.py`. + +Et nous devons récupérer la fonction de dépendance depuis le module `app.dependencies`, le fichier `app/dependencies.py`. + +Nous utilisons donc un import relatif avec `..` pour les dépendances : + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[3] title["app/routers/items.py"] *} + +#### Comprendre le fonctionnement des imports relatifs { #how-relative-imports-work } + +/// tip | Astuce + +Si vous savez parfaitement comment fonctionnent les imports, passez à la section suivante ci-dessous. + +/// + +Un seul point `.`, comme dans : + +```Python +from .dependencies import get_token_header +``` + +signifierait : + +* En partant du même package dans lequel vit ce module (le fichier `app/routers/items.py`) (le répertoire `app/routers/`)... +* trouver le module `dependencies` (un fichier imaginaire `app/routers/dependencies.py`)... +* et en importer la fonction `get_token_header`. + +Mais ce fichier n'existe pas, nos dépendances sont dans un fichier `app/dependencies.py`. + +Rappelez-vous à quoi ressemble la structure de notre app/fichiers : + + + +--- + +Les deux points `..`, comme dans : + +```Python +from ..dependencies import get_token_header +``` + +veulent dire : + +* En partant du même package dans lequel vit ce module (le fichier `app/routers/items.py`) (le répertoire `app/routers/`)... +* aller au package parent (le répertoire `app/`)... +* et là, trouver le module `dependencies` (le fichier `app/dependencies.py`)... +* et en importer la fonction `get_token_header`. + +Cela fonctionne correctement ! 🎉 + +--- + +De la même manière, si nous avions utilisé trois points `...`, comme dans : + +```Python +from ...dependencies import get_token_header +``` + +cela voudrait dire : + +* En partant du même package dans lequel vit ce module (le fichier `app/routers/items.py`) (le répertoire `app/routers/`)... +* aller au package parent (le répertoire `app/`)... +* puis aller au parent de ce package (il n'y a pas de package parent, `app` est le niveau supérieur 😱)... +* et là, trouver le module `dependencies` (le fichier `app/dependencies.py`)... +* et en importer la fonction `get_token_header`. + +Cela ferait référence à un package au-dessus de `app/`, avec son propre fichier `__init__.py`, etc. Mais nous n'avons pas cela. Donc, cela lèverait une erreur dans notre exemple. 🚨 + +Mais maintenant vous savez comment cela fonctionne, vous pouvez donc utiliser des imports relatifs dans vos propres applications, aussi complexes soient-elles. 🤓 + +### Ajouter des `tags`, `responses` et `dependencies` personnalisés { #add-some-custom-tags-responses-and-dependencies } + +Nous n'ajoutons pas le préfixe `/items` ni `tags=["items"]` à chaque *chemin d'accès* parce que nous les avons ajoutés au `APIRouter`. + +Mais nous pouvons toujours ajouter _davantage_ de `tags` qui seront appliqués à un *chemin d'accès* spécifique, ainsi que des `responses` supplémentaires propres à ce *chemin d'accès* : + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[30:31] title["app/routers/items.py"] *} + +/// tip | Astuce + +Ce dernier *chemin d'accès* aura la combinaison de tags : `["items", "custom"]`. + +Et il aura également les deux réponses dans la documentation, une pour `404` et une pour `403`. + +/// + +## Créer l'application `FastAPI` principale { #the-main-fastapi } + +Voyons maintenant le module `app/main.py`. + +C'est ici que vous importez et utilisez la classe `FastAPI`. + +Ce sera le fichier principal de votre application qui reliera tout ensemble. + +Et comme la plupart de votre logique vivra désormais dans son propre module, le fichier principal sera assez simple. + +### Importer `FastAPI` { #import-fastapi } + +Vous importez et créez une classe `FastAPI` comme d'habitude. + +Et nous pouvons même déclarer des [dépendances globales](dependencies/global-dependencies.md){.internal-link target=_blank} qui seront combinées avec les dépendances de chaque `APIRouter` : + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[1,3,7] title["app/main.py"] *} + +### Importer les `APIRouter` { #import-the-apirouter } + +Nous importons maintenant les autres sous-modules qui ont des `APIRouter` : + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[4:5] title["app/main.py"] *} + +Comme les fichiers `app/routers/users.py` et `app/routers/items.py` sont des sous-modules qui font partie du même package Python `app`, nous pouvons utiliser un seul point `.` pour les importer en utilisant des « imports relatifs ». + +### Comprendre le fonctionnement de l'import { #how-the-importing-works } + +La section : + +```Python +from .routers import items, users +``` + +signifie : + +* En partant du même package dans lequel vit ce module (le fichier `app/main.py`) (le répertoire `app/`)... +* chercher le sous-package `routers` (le répertoire `app/routers/`)... +* et en importer le sous-module `items` (le fichier `app/routers/items.py`) et `users` (le fichier `app/routers/users.py`)... + +Le module `items` aura une variable `router` (`items.router`). C'est celle que nous avons créée dans le fichier `app/routers/items.py`, c'est un objet `APIRouter`. + +Nous faisons ensuite la même chose pour le module `users`. + +Nous pourrions aussi les importer ainsi : + +```Python +from app.routers import items, users +``` + +/// info + +La première version est un « import relatif » : + +```Python +from .routers import items, users +``` + +La deuxième version est un « import absolu » : + +```Python +from app.routers import items, users +``` + +Pour en savoir plus sur les Packages et Modules Python, lisez la documentation officielle de Python sur les modules. + +/// + +### Éviter les collisions de noms { #avoid-name-collisions } + +Nous importons le sous-module `items` directement, au lieu d'importer uniquement sa variable `router`. + +C'est parce que nous avons également une autre variable nommée `router` dans le sous-module `users`. + +Si nous les avions importées l'une après l'autre, comme : + +```Python +from .routers.items import router +from .routers.users import router +``` + +le `router` de `users` écraserait celui de `items` et nous ne pourrions pas les utiliser en même temps. + +Donc, pour pouvoir utiliser les deux dans le même fichier, nous importons directement les sous-modules : + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[5] title["app/main.py"] *} + +### Inclure les `APIRouter` pour `users` et `items` { #include-the-apirouters-for-users-and-items } + +Incluons maintenant les `router` des sous-modules `users` et `items` : + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[10:11] title["app/main.py"] *} + +/// info + +`users.router` contient le `APIRouter` à l'intérieur du fichier `app/routers/users.py`. + +Et `items.router` contient le `APIRouter` à l'intérieur du fichier `app/routers/items.py`. + +/// + +Avec `app.include_router()`, nous pouvons ajouter chaque `APIRouter` à l'application principale `FastAPI`. + +Cela inclura toutes les routes de ce routeur comme faisant partie de l'application. + +/// note | Détails techniques + +En interne, cela créera en fait un *chemin d'accès* pour chaque *chemin d'accès* qui a été déclaré dans le `APIRouter`. + +Donc, en coulisses, cela fonctionnera comme si tout faisait partie d'une seule et même application. + +/// + +/// check | Vérifications + +Vous n'avez pas à vous soucier de la performance lors de l'inclusion de routeurs. + +Cela prendra des microsecondes et ne se produira qu'au démarrage. + +Donc cela n'affectera pas la performance. ⚡ + +/// + +### Inclure un `APIRouter` avec un `prefix`, des `tags`, des `responses` et des `dependencies` personnalisés { #include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies } + +Imaginons maintenant que votre organisation vous ait fourni le fichier `app/internal/admin.py`. + +Il contient un `APIRouter` avec quelques *chemins d'accès* d'administration que votre organisation partage entre plusieurs projets. + +Pour cet exemple, il sera très simple. Mais supposons que, parce qu'il est partagé avec d'autres projets de l'organisation, nous ne puissions pas le modifier et ajouter un `prefix`, des `dependencies`, des `tags`, etc. directement au `APIRouter` : + +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} + +Mais nous voulons quand même définir un `prefix` personnalisé lors de l'inclusion du `APIRouter` afin que tous ses *chemins d'accès* commencent par `/admin`, nous voulons le sécuriser avec les `dependencies` que nous avons déjà pour ce projet, et nous voulons inclure des `tags` et des `responses`. + +Nous pouvons déclarer tout cela sans avoir à modifier le `APIRouter` d'origine en passant ces paramètres à `app.include_router()` : + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[14:17] title["app/main.py"] *} + +De cette façon, le `APIRouter` original restera inchangé, afin que nous puissions toujours partager ce même fichier `app/internal/admin.py` avec d'autres projets de l'organisation. + +Le résultat est que, dans notre application, chacun des *chemins d'accès* du module `admin` aura : + +* Le préfixe `/admin`. +* Le tag `admin`. +* La dépendance `get_token_header`. +* La réponse `418`. 🍵 + +Mais cela n'affectera que ce `APIRouter` dans notre application, pas dans tout autre code qui l'utilise. + +Ainsi, par exemple, d'autres projets pourraient utiliser le même `APIRouter` avec une méthode d'authentification différente. + +### Inclure un *chemin d'accès* { #include-a-path-operation } + +Nous pouvons également ajouter des *chemins d'accès* directement à l'application `FastAPI`. + +Ici, nous le faisons... juste pour montrer que nous le pouvons 🤷 : + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[21:23] title["app/main.py"] *} + +et cela fonctionnera correctement, avec tous les autres *chemins d'accès* ajoutés avec `app.include_router()`. + +/// info | Détails très techniques + +Note : c'est un détail très technique que vous pouvez probablement **simplement ignorer**. + +--- + +Les `APIRouter` ne sont pas « montés », ils ne sont pas isolés du reste de l'application. + +C'est parce que nous voulons inclure leurs *chemins d'accès* dans le schéma OpenAPI et les interfaces utilisateur. + +Comme nous ne pouvons pas simplement les isoler et les « monter » indépendamment du reste, les *chemins d'accès* sont « clonés » (recréés), pas inclus directement. + +/// + +## Consulter la documentation API automatique { #check-the-automatic-api-docs } + +Maintenant, exécutez votre application : + +
+ +```console +$ fastapi dev app/main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Et ouvrez les documents à http://127.0.0.1:8000/docs. + +Vous verrez la documentation API automatique, incluant les chemins de tous les sous-modules, utilisant les bons chemins (et préfixes) et les bons tags : + + + +## Inclure le même routeur plusieurs fois avec des `prefix` différents { #include-the-same-router-multiple-times-with-different-prefix } + +Vous pouvez aussi utiliser `.include_router()` plusieurs fois avec le même routeur en utilisant des préfixes différents. + +Cela peut être utile, par exemple, pour exposer la même API sous des préfixes différents, p. ex. `/api/v1` et `/api/latest`. + +C'est un usage avancé dont vous n'aurez peut-être pas vraiment besoin, mais il est là au cas où. + +## Inclure un `APIRouter` dans un autre { #include-an-apirouter-in-another } + +De la même manière que vous pouvez inclure un `APIRouter` dans une application `FastAPI`, vous pouvez inclure un `APIRouter` dans un autre `APIRouter` en utilisant : + +```Python +router.include_router(other_router) +``` + +Vous devez vous assurer de le faire avant d'inclure `router` dans l'application `FastAPI`, afin que les *chemins d'accès* de `other_router` soient également inclus. diff --git a/docs/fr/docs/tutorial/body-fields.md b/docs/fr/docs/tutorial/body-fields.md new file mode 100644 index 0000000000..9830292c90 --- /dev/null +++ b/docs/fr/docs/tutorial/body-fields.md @@ -0,0 +1,61 @@ +# Corps - Champs { #body-fields } + +De la même manière que vous pouvez déclarer des validations supplémentaires et des métadonnées dans les paramètres d'une fonction de chemin d'accès avec `Query`, `Path` et `Body`, vous pouvez déclarer des validations et des métadonnées à l'intérieur des modèles Pydantic en utilisant `Field` de Pydantic. + +## Importer `Field` { #import-field } + +D'abord, vous devez l'importer : + +{* ../../docs_src/body_fields/tutorial001_an_py310.py hl[4] *} + + +/// warning | Alertes + +Notez que `Field` est importé directement depuis `pydantic`, et non depuis `fastapi` comme le sont les autres (`Query`, `Path`, `Body`, etc.). + +/// + +## Déclarer les attributs du modèle { #declare-model-attributes } + +Vous pouvez ensuite utiliser `Field` avec des attributs de modèle : + +{* ../../docs_src/body_fields/tutorial001_an_py310.py hl[11:14] *} + +`Field` fonctionne de la même manière que `Query`, `Path` et `Body`, il dispose des mêmes paramètres, etc. + +/// note | Détails techniques + +En réalité, `Query`, `Path` et d'autres que vous verrez ensuite créent des objets de sous-classes d'une classe commune `Param`, qui est elle-même une sous-classe de la classe `FieldInfo` de Pydantic. + +Et `Field` de Pydantic renvoie également une instance de `FieldInfo`. + +`Body` renvoie aussi directement des objets d'une sous-classe de `FieldInfo`. Et il y en a d'autres que vous verrez plus tard qui sont des sous-classes de la classe `Body`. + +Rappelez-vous que lorsque vous importez `Query`, `Path` et d'autres depuis `fastapi`, ce sont en réalité des fonctions qui renvoient des classes spéciales. + +/// + +/// tip | Astuce + +Remarquez comment chaque attribut de modèle avec un type, une valeur par défaut et `Field` a la même structure qu'un paramètre de fonction de chemin d'accès, avec `Field` au lieu de `Path`, `Query` et `Body`. + +/// + +## Ajouter des informations supplémentaires { #add-extra-information } + +Vous pouvez déclarer des informations supplémentaires dans `Field`, `Query`, `Body`, etc. Elles seront incluses dans le JSON Schema généré. + +Vous en apprendrez davantage sur l'ajout d'informations supplémentaires plus loin dans les documents, lorsque vous apprendrez à déclarer des exemples. + +/// warning | Alertes + +Les clés supplémentaires passées à `Field` seront également présentes dans le schéma OpenAPI résultant pour votre application. +Comme ces clés ne font pas nécessairement partie de la spécification OpenAPI, certains outils OpenAPI, par exemple [le validateur OpenAPI](https://validator.swagger.io/), peuvent ne pas fonctionner avec votre schéma généré. + +/// + +## Récapitulatif { #recap } + +Vous pouvez utiliser `Field` de Pydantic pour déclarer des validations supplémentaires et des métadonnées pour les attributs de modèle. + +Vous pouvez également utiliser des arguments nommés supplémentaires pour transmettre des métadonnées JSON Schema additionnelles. diff --git a/docs/fr/docs/tutorial/body-multiple-params.md b/docs/fr/docs/tutorial/body-multiple-params.md index 92ca2afc36..1c1ab0fcac 100644 --- a/docs/fr/docs/tutorial/body-multiple-params.md +++ b/docs/fr/docs/tutorial/body-multiple-params.md @@ -104,12 +104,6 @@ Comme, par défaut, les valeurs singulières sont interprétées comme des param q: str | None = None ``` -Ou en Python 3.9 : - -```Python -q: Union[str, None] = None -``` - Par exemple : {* ../../docs_src/body_multiple_params/tutorial004_an_py310.py hl[28] *} diff --git a/docs/fr/docs/tutorial/body-nested-models.md b/docs/fr/docs/tutorial/body-nested-models.md new file mode 100644 index 0000000000..dccfdb6c5d --- /dev/null +++ b/docs/fr/docs/tutorial/body-nested-models.md @@ -0,0 +1,220 @@ +# Corps - Modèles imbriqués { #body-nested-models } + +Avec FastAPI, vous pouvez définir, valider, documenter et utiliser des modèles imbriqués à n'importe quelle profondeur (grâce à Pydantic). + +## Déclarer des champs de liste { #list-fields } + +Vous pouvez définir un attribut comme étant un sous-type. Par exemple, une `list` Python : + +{* ../../docs_src/body_nested_models/tutorial001_py310.py hl[12] *} + +Cela fera de `tags` une liste, bien que le type des éléments de la liste ne soit pas déclaré. + +## Champs de liste avec paramètre de type { #list-fields-with-type-parameter } + +Mais Python a une manière spécifique de déclarer des listes avec des types internes, ou « paramètres de type » : + +### Déclarer une `list` avec un paramètre de type { #declare-a-list-with-a-type-parameter } + +Pour déclarer des types qui ont des paramètres de type (types internes), comme `list`, `dict`, `tuple`, +passez le(s) type(s) interne(s) comme « paramètres de type » à l'aide de crochets : `[` et `]` + +```Python +my_list: list[str] +``` + +C'est simplement la syntaxe Python standard pour les déclarations de type. + +Utilisez cette même syntaxe standard pour les attributs de modèles avec des types internes. + +Ainsi, dans notre exemple, nous pouvons faire de `tags` spécifiquement une « liste de chaînes » : + +{* ../../docs_src/body_nested_models/tutorial002_py310.py hl[12] *} + +## Types set { #set-types } + +Mais en y réfléchissant, nous réalisons que les tags ne devraient pas se répéter, ce seraient probablement des chaînes uniques. + +Et Python dispose d'un type de données spécial pour les ensembles d'éléments uniques, le `set`. + +Nous pouvons alors déclarer `tags` comme un set de chaînes : + +{* ../../docs_src/body_nested_models/tutorial003_py310.py hl[12] *} + +Avec cela, même si vous recevez une requête contenant des doublons, elle sera convertie en un set d'éléments uniques. + +Et chaque fois que vous renverrez ces données, même si la source contenait des doublons, elles seront renvoyées sous la forme d'un set d'éléments uniques. + +Elles seront également annotées / documentées en conséquence. + +## Modèles imbriqués { #nested-models } + +Chaque attribut d'un modèle Pydantic a un type. + +Mais ce type peut lui-même être un autre modèle Pydantic. + +Ainsi, vous pouvez déclarer des « objets » JSON profondément imbriqués avec des noms d'attributs, des types et des validations spécifiques. + +Tout cela, de manière arbitrairement imbriquée. + +### Définir un sous-modèle { #define-a-submodel } + +Par exemple, nous pouvons définir un modèle `Image` : + +{* ../../docs_src/body_nested_models/tutorial004_py310.py hl[7:9] *} + +### Utiliser le sous-modèle comme type { #use-the-submodel-as-a-type } + +Nous pouvons ensuite l'utiliser comme type d'un attribut : + +{* ../../docs_src/body_nested_models/tutorial004_py310.py hl[18] *} + +Cela signifie que FastAPI attendrait un corps similaire à : + +```JSON +{ + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2, + "tags": ["rock", "metal", "bar"], + "image": { + "url": "http://example.com/baz.jpg", + "name": "The Foo live" + } +} +``` + +Là encore, avec cette simple déclaration, avec FastAPI vous obtenez : + +- Prise en charge par l'éditeur (autocomplétion, etc.), même pour les modèles imbriqués +- Conversion des données +- Validation des données +- Documentation automatique + +## Types spéciaux et validation { #special-types-and-validation } + +Outre les types singuliers normaux comme `str`, `int`, `float`, etc. vous pouvez utiliser des types singuliers plus complexes qui héritent de `str`. + +Pour voir toutes les options dont vous disposez, consultez l’aperçu des types de Pydantic. Vous verrez quelques exemples au chapitre suivant. + +Par exemple, comme dans le modèle `Image` nous avons un champ `url`, nous pouvons le déclarer comme instance de `HttpUrl` de Pydantic au lieu de `str` : + +{* ../../docs_src/body_nested_models/tutorial005_py310.py hl[2,8] *} + +La chaîne sera vérifiée comme URL valide et documentée comme telle dans JSON Schema / OpenAPI. + +## Attributs avec des listes de sous-modèles { #attributes-with-lists-of-submodels } + +Vous pouvez également utiliser des modèles Pydantic comme sous-types de `list`, `set`, etc. : + +{* ../../docs_src/body_nested_models/tutorial006_py310.py hl[18] *} + +Cela attendra (convertira, validera, documentera, etc.) un corps JSON comme : + +```JSON hl_lines="11" +{ + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2, + "tags": [ + "rock", + "metal", + "bar" + ], + "images": [ + { + "url": "http://example.com/baz.jpg", + "name": "The Foo live" + }, + { + "url": "http://example.com/dave.jpg", + "name": "The Baz" + } + ] +} +``` +/// info + +Remarquez que la clé `images` contient maintenant une liste d'objets image. + +/// + +## Modèles profondément imbriqués { #deeply-nested-models } + +Vous pouvez définir des modèles imbriqués à une profondeur arbitraire : + +{* ../../docs_src/body_nested_models/tutorial007_py310.py hl[7,12,18,21,25] *} + +/// info + +Remarquez que `Offer` a une liste d’`Item`, qui à leur tour ont une liste optionnelle d’`Image`. + +/// + +## Corps de listes pures { #bodies-of-pure-lists } + +Si la valeur de premier niveau du corps JSON attendu est un `array` JSON (une `list` Python), vous pouvez déclarer le type dans le paramètre de la fonction, de la même manière que dans les modèles Pydantic : + +```Python +images: list[Image] +``` + +comme : + +{* ../../docs_src/body_nested_models/tutorial008_py310.py hl[13] *} + +## Bénéficier de la prise en charge de l'éditeur partout { #editor-support-everywhere } + +Et vous bénéficiez de la prise en charge de l'éditeur partout. + +Même pour les éléments à l'intérieur des listes : + + + +Vous ne pourriez pas obtenir ce type de prise en charge de l'éditeur si vous travailliez directement avec des `dict` au lieu de modèles Pydantic. + +Mais vous n'avez pas à vous en soucier non plus, les `dict` entrants sont convertis automatiquement et votre sortie est également convertie automatiquement en JSON. + +## Corps de `dict` arbitraires { #bodies-of-arbitrary-dicts } + +Vous pouvez également déclarer un corps comme un `dict` avec des clés d’un certain type et des valeurs d’un autre type. + +De cette façon, vous n'avez pas besoin de savoir à l'avance quels sont les noms de champs/attributs valides (comme ce serait le cas avec des modèles Pydantic). + +Cela serait utile si vous voulez recevoir des clés que vous ne connaissez pas à l'avance. + +--- + +Un autre cas utile est lorsque vous souhaitez avoir des clés d'un autre type (par exemple `int`). + +C'est ce que nous allons voir ici. + +Dans ce cas, vous accepteriez n'importe quel `dict` tant qu'il a des clés `int` avec des valeurs `float` : + +{* ../../docs_src/body_nested_models/tutorial009_py310.py hl[7] *} + +/// tip | Astuce + +Gardez à l'esprit que JSON ne prend en charge que des `str` comme clés. + +Mais Pydantic dispose d'une conversion automatique des données. + +Cela signifie que, même si vos clients d'API ne peuvent envoyer que des chaînes comme clés, tant que ces chaînes contiennent des entiers purs, Pydantic les convertira et les validera. + +Et le `dict` que vous recevez dans `weights` aura en réalité des clés `int` et des valeurs `float`. + +/// + +## Récapitulatif { #recap } + +Avec FastAPI, vous bénéficiez de la flexibilité maximale fournie par les modèles Pydantic, tout en gardant votre code simple, concis et élégant. + +Mais avec tous les avantages : + +- Prise en charge par l'éditeur (autocomplétion partout !) +- Conversion des données (a.k.a. parsing / sérialisation) +- Validation des données +- Documentation des schémas +- Documentation automatique diff --git a/docs/fr/docs/tutorial/body-updates.md b/docs/fr/docs/tutorial/body-updates.md new file mode 100644 index 0000000000..36ad12681c --- /dev/null +++ b/docs/fr/docs/tutorial/body-updates.md @@ -0,0 +1,100 @@ +# Corps - Mises à jour { #body-updates } + +## Mettre à jour en remplaçant avec `PUT` { #update-replacing-with-put } + +Pour mettre à jour un élément, vous pouvez utiliser l’opération HTTP `PUT`. + +Vous pouvez utiliser le `jsonable_encoder` pour convertir les données d’entrée en données pouvant être stockées au format JSON (par exemple, avec une base de données NoSQL). Par exemple, convertir `datetime` en `str`. + +{* ../../docs_src/body_updates/tutorial001_py310.py hl[28:33] *} + +On utilise `PUT` pour recevoir des données qui doivent remplacer les données existantes. + +### Avertissement concernant le remplacement { #warning-about-replacing } + +Cela signifie que si vous souhaitez mettre à jour l’élément `bar` avec `PUT` et un corps contenant : + +```Python +{ + "name": "Barz", + "price": 3, + "description": None, +} +``` + +comme il n’inclut pas l’attribut déjà enregistré « tax »: 20.2, le modèle d’entrée prendrait la valeur par défaut « tax »: 10.5. + +Et les données seraient enregistrées avec cette « nouvelle » `tax` de `10.5`. + +## Effectuer des mises à jour partielles avec `PATCH` { #partial-updates-with-patch } + +Vous pouvez également utiliser l’opération HTTP `PATCH` pour mettre à jour des données de manière partielle. + +Cela signifie que vous pouvez n’envoyer que les données que vous souhaitez mettre à jour, en laissant le reste intact. + +/// note | Remarque + +`PATCH` est moins utilisé et moins connu que `PUT`. + +Et de nombreuses équipes n’utilisent que `PUT`, même pour les mises à jour partielles. + +Vous êtes libre de les utiliser comme vous le souhaitez, **FastAPI** n’impose aucune restriction. + +Mais ce guide vous montre, plus ou moins, la façon dont ils sont censés être utilisés. + +/// + +### Utiliser le paramètre `exclude_unset` de Pydantic { #using-pydantics-exclude-unset-parameter } + +Si vous souhaitez recevoir des mises à jour partielles, il est très utile d’utiliser le paramètre `exclude_unset` dans la méthode `.model_dump()` du modèle Pydantic. + +Comme `item.model_dump(exclude_unset=True)`. + +Cela génère un `dict` ne contenant que les données définies lors de la création du modèle `item`, en excluant les valeurs par défaut. + +Vous pouvez ensuite l’utiliser pour produire un `dict` avec uniquement les données définies (envoyées dans la requête), en omettant les valeurs par défaut : + +{* ../../docs_src/body_updates/tutorial002_py310.py hl[32] *} + +### Utiliser le paramètre `update` de Pydantic { #using-pydantics-update-parameter } + +Vous pouvez maintenant créer une copie du modèle existant avec `.model_copy()`, et passer le paramètre `update` avec un `dict` contenant les données à mettre à jour. + +Comme `stored_item_model.model_copy(update=update_data)` : + +{* ../../docs_src/body_updates/tutorial002_py310.py hl[33] *} + +### Récapitulatif des mises à jour partielles { #partial-updates-recap } + +En résumé, pour appliquer des mises à jour partielles, vous procédez ainsi : + +* (Optionnel) utilisez `PATCH` au lieu de `PUT`. +* Récupérez les données stockées. +* Placez ces données dans un modèle Pydantic. +* Générez un `dict` sans valeurs par défaut à partir du modèle d’entrée (en utilisant `exclude_unset`). + * De cette façon, vous mettez à jour uniquement les valeurs effectivement définies par l’utilisateur, au lieu d’écraser des valeurs déjà stockées par des valeurs par défaut de votre modèle. +* Créez une copie du modèle stocké, en mettant à jour ses attributs avec les mises à jour partielles reçues (en utilisant le paramètre `update`). +* Convertissez le modèle copié en quelque chose qui peut être stocké dans votre base de données (par exemple en utilisant le `jsonable_encoder`). + * Cela est comparable à l’utilisation à nouveau de la méthode `.model_dump()` du modèle, mais cela vérifie (et convertit) les valeurs vers des types pouvant être convertis en JSON, par exemple `datetime` en `str`. +* Enregistrez les données dans votre base de données. +* Retournez le modèle mis à jour. + +{* ../../docs_src/body_updates/tutorial002_py310.py hl[28:35] *} + +/// tip | Astuce + +Vous pouvez en réalité utiliser cette même technique avec une opération HTTP `PUT`. + +Mais l’exemple ici utilise `PATCH` car il a été créé pour ces cas d’usage. + +/// + +/// note | Remarque + +Remarquez que le modèle d’entrée est toujours validé. + +Ainsi, si vous souhaitez recevoir des mises à jour partielles pouvant omettre tous les attributs, vous devez disposer d’un modèle avec tous les attributs marqués comme optionnels (avec des valeurs par défaut ou `None`). + +Pour distinguer les modèles avec toutes les valeurs optionnelles pour les mises à jour et les modèles avec des valeurs requises pour la création, vous pouvez utiliser les idées décrites dans [Modèles supplémentaires](extra-models.md){.internal-link target=_blank}. + +/// diff --git a/docs/fr/docs/tutorial/body.md b/docs/fr/docs/tutorial/body.md index ca115fabc7..a8703e030d 100644 --- a/docs/fr/docs/tutorial/body.md +++ b/docs/fr/docs/tutorial/body.md @@ -10,7 +10,7 @@ Pour déclarer un corps de **requête**, on utilise les modèles de -Et seront aussi utilisés dans chaque *opération de chemin* de la documentation utilisant ces modèles : +Et seront aussi utilisés dans chaque *chemin d'accès* de la documentation utilisant ces modèles : @@ -115,7 +115,7 @@ Ce qui améliore le support pour les modèles Pydantic avec : * de l'autocomplétion * des vérifications de type -* du « refactoring » (ou remaniement de code) +* du « refactoring » * de la recherche * des inspections @@ -129,7 +129,7 @@ Dans la fonction, vous pouvez accéder à tous les attributs de l'objet du modè ## Corps de la requête + paramètres de chemin { #request-body-path-parameters } -Vous pouvez déclarer des paramètres de chemin et un corps de requête pour la même *opération de chemin*. +Vous pouvez déclarer des paramètres de chemin et un corps de requête pour la même *chemin d'accès*. **FastAPI** est capable de reconnaître que les paramètres de la fonction qui correspondent aux paramètres de chemin doivent être **récupérés depuis le chemin**, et que les paramètres de fonctions déclarés comme modèles Pydantic devraient être **récupérés depuis le corps de la requête**. @@ -137,7 +137,7 @@ Vous pouvez déclarer des paramètres de chemin et un corps de requête pour la ## Corps de la requête + paramètres de chemin et de requête { #request-body-path-query-parameters } -Vous pouvez aussi déclarer un **corps**, et des paramètres de **chemin** et de **requête** dans la même *opération de chemin*. +Vous pouvez aussi déclarer un **corps**, et des paramètres de **chemin** et de **requête** dans la même *chemin d'accès*. **FastAPI** saura reconnaître chacun d'entre eux et récupérer la bonne donnée au bon endroit. @@ -153,7 +153,7 @@ Les paramètres de la fonction seront reconnus comme tel : **FastAPI** saura que la valeur de `q` n'est pas requise grâce à la valeur par défaut `= None`. -L'annotation de type `str | None` (Python 3.10+) ou `Union` dans `Union[str, None]` (Python 3.9+) n'est pas utilisée par **FastAPI** pour déterminer que la valeur n'est pas requise, il le saura parce qu'elle a une valeur par défaut `= None`. +L'annotation de type `str | None` n'est pas utilisée par **FastAPI** pour déterminer que la valeur n'est pas requise, il le saura parce qu'elle a une valeur par défaut `= None`. Mais ajouter ces annotations de type permettra à votre éditeur de vous offrir un meilleur support et de détecter des erreurs. diff --git a/docs/fr/docs/tutorial/cookie-param-models.md b/docs/fr/docs/tutorial/cookie-param-models.md new file mode 100644 index 0000000000..c6fc2f8262 --- /dev/null +++ b/docs/fr/docs/tutorial/cookie-param-models.md @@ -0,0 +1,76 @@ +# Modèles de paramètres de cookies { #cookie-parameter-models } + +Si vous avez un groupe de **cookies** liés, vous pouvez créer un **modèle Pydantic** pour les déclarer. 🍪 + +Cela vous permet de **réutiliser le modèle** à **plusieurs endroits** et aussi de déclarer des validations et des métadonnées pour tous les paramètres en une seule fois. 😎 + +/// note | Remarque + +Ceci est pris en charge depuis la version `0.115.0` de FastAPI. 🤓 + +/// + +/// tip | Astuce + +Cette même technique s'applique à `Query`, `Cookie` et `Header`. 😎 + +/// + +## Déclarer des cookies avec un modèle Pydantic { #cookies-with-a-pydantic-model } + +Déclarez les paramètres de **cookie** dont vous avez besoin dans un **modèle Pydantic**, puis déclarez le paramètre comme `Cookie` : + +{* ../../docs_src/cookie_param_models/tutorial001_an_py310.py hl[9:12,16] *} + +**FastAPI** va **extraire** les données pour **chaque champ** à partir des **cookies** reçus dans la requête et vous fournir le modèle Pydantic que vous avez défini. + +## Consulter la documentation { #check-the-docs } + +Vous pouvez voir les cookies définis dans l'interface de la documentation à `/docs` : + +
+ +
+ +/// info + +Gardez à l'esprit que, comme les **navigateurs gèrent les cookies** de manière particulière et en arrière-plan, ils **n'autorisent pas** facilement **JavaScript** à y accéder. + +Si vous allez dans **l'interface de la documentation de l'API** à `/docs`, vous pourrez voir la **documentation** des cookies pour vos *chemins d'accès*. + +Mais même si vous **remplissez les données** et cliquez sur « Execute », comme l'interface de la documentation fonctionne avec **JavaScript**, les cookies ne seront pas envoyés et vous verrez un **message d'erreur** comme si vous n'aviez saisi aucune valeur. + +/// + +## Interdire les cookies supplémentaires { #forbid-extra-cookies } + +Dans certains cas d'utilisation particuliers (probablement peu courants), vous pourriez vouloir **restreindre** les cookies que vous souhaitez recevoir. + +Votre API a désormais le pouvoir de contrôler son propre consentement aux cookies. 🤪🍪 + +Vous pouvez utiliser la configuration du modèle de Pydantic pour `forbid` tout champ `extra` : + +{* ../../docs_src/cookie_param_models/tutorial002_an_py310.py hl[10] *} + +Si un client tente d'envoyer des **cookies supplémentaires**, il recevra une **réponse d'erreur**. + +Pauvres bannières de cookies, avec tous leurs efforts pour obtenir votre consentement pour que l'API pour le rejeter. 🍪 + +Par exemple, si le client tente d'envoyer un cookie `santa_tracker` avec la valeur `good-list-please`, il recevra une **réponse d'erreur** lui indiquant que le `santa_tracker` le cookie n'est pas autorisé : + +```json +{ + "detail": [ + { + "type": "extra_forbidden", + "loc": ["cookie", "santa_tracker"], + "msg": "Extra inputs are not permitted", + "input": "good-list-please", + } + ] +} +``` + +## Récapitulatif { #summary } + +Vous pouvez utiliser des **modèles Pydantic** pour déclarer des **cookies** dans **FastAPI**. 😎 diff --git a/docs/fr/docs/tutorial/cookie-params.md b/docs/fr/docs/tutorial/cookie-params.md new file mode 100644 index 0000000000..8f77d35dca --- /dev/null +++ b/docs/fr/docs/tutorial/cookie-params.md @@ -0,0 +1,45 @@ +# Paramètres de cookie { #cookie-parameters } + +Vous pouvez définir des paramètres de cookie de la même manière que vous définissez les paramètres `Query` et `Path`. + +## Importer `Cookie` { #import-cookie } + +Commencez par importer `Cookie` : + +{* ../../docs_src/cookie_params/tutorial001_an_py310.py hl[3] *} + +## Déclarer des paramètres `Cookie` { #declare-cookie-parameters } + +Déclarez ensuite les paramètres de cookie en utilisant la même structure qu'avec `Path` et `Query`. + +Vous pouvez définir la valeur par défaut ainsi que tous les paramètres supplémentaires de validation ou d'annotation : + +{* ../../docs_src/cookie_params/tutorial001_an_py310.py hl[9] *} + +/// note | Détails techniques + +`Cookie` est une classe « sœur » de `Path` et `Query`. Elle hérite également de la même classe commune `Param`. + +Mais rappelez-vous que lorsque vous importez `Query`, `Path`, `Cookie` et d'autres depuis `fastapi`, il s'agit en réalité de fonctions qui renvoient des classes spéciales. + +/// + +/// info + +Pour déclarer des cookies, vous devez utiliser `Cookie`, sinon les paramètres seraient interprétés comme des paramètres de requête. + +/// + +/// info + +Gardez à l'esprit que, comme **les navigateurs gèrent les cookies** de manière particulière et en coulisses, ils **n'autorisent pas** facilement **JavaScript** à y accéder. + +Si vous allez dans l'**interface de la documentation de l'API** à `/docs`, vous pourrez voir la **documentation** des cookies pour vos *chemins d'accès*. + +Mais même si vous **renseignez les données** et cliquez sur « Execute », comme l'interface de documentation fonctionne avec **JavaScript**, les cookies ne seront pas envoyés et vous verrez un message **d'erreur** comme si vous n'aviez saisi aucune valeur. + +/// + +## Récapitulatif { #recap } + +Déclarez les cookies avec `Cookie`, en utilisant le même schéma commun que `Query` et `Path`. diff --git a/docs/fr/docs/tutorial/cors.md b/docs/fr/docs/tutorial/cors.md new file mode 100644 index 0000000000..3ae7de07ca --- /dev/null +++ b/docs/fr/docs/tutorial/cors.md @@ -0,0 +1,88 @@ +# CORS (Partage des ressources entre origines) { #cors-cross-origin-resource-sharing } + +
CORS ou « Cross-Origin Resource Sharing » fait référence aux situations où un frontend exécuté dans un navigateur contient du code JavaScript qui communique avec un backend, et où le backend se trouve dans une « origine » différente de celle du frontend. + +## Origine { #origin } + +Une origine est la combinaison du protocole (`http`, `https`), du domaine (`myapp.com`, `localhost`, `localhost.tiangolo.com`) et du port (`80`, `443`, `8080`). + +Ainsi, toutes celles-ci sont des origines différentes : + +* `http://localhost` +* `https://localhost` +* `http://localhost:8080` + +Même si elles sont toutes sur `localhost`, elles utilisent des protocoles ou des ports différents, ce sont donc des « origines » différentes. + +## Étapes { #steps } + +Disons donc que vous avez un frontend exécuté dans votre navigateur à `http://localhost:8080`, et que son JavaScript essaie de communiquer avec un backend exécuté à `http://localhost` (comme nous ne spécifions pas de port, le navigateur supposera le port par défaut `80`). + +Le navigateur enverra alors une requête HTTP `OPTIONS` au backend `:80`, et si le backend envoie les en-têtes appropriés autorisant la communication depuis cette origine différente (`http://localhost:8080`), alors le navigateur `:8080` permettra au JavaScript du frontend d’envoyer sa requête au backend `:80`. + +Pour y parvenir, le backend `:80` doit disposer d’une liste « d’origines autorisées ». + +Dans ce cas, la liste devrait inclure `http://localhost:8080` pour que le frontend `:8080` fonctionne correctement. + +## Caractères génériques { #wildcards } + +Il est également possible de déclarer la liste comme « * » (un « wildcard ») pour indiquer que toutes sont autorisées. + +Mais cela n’autorisera que certains types de communication, en excluant tout ce qui implique des informations d’identification : cookies, en-têtes Authorization comme ceux utilisés avec les Bearer Tokens, etc. + +Ainsi, pour que tout fonctionne correctement, il est préférable d’indiquer explicitement les origines autorisées. + +## Utiliser `CORSMiddleware` { #use-corsmiddleware } + +Vous pouvez le configurer dans votre application **FastAPI** à l’aide de `CORSMiddleware`. + +* Importer `CORSMiddleware`. +* Créer une liste d’origines autorisées (sous forme de chaînes). +* L’ajouter comme « middleware » à votre application **FastAPI**. + +Vous pouvez également spécifier si votre backend autorise : + +* Les informations d’identification (en-têtes Authorization, cookies, etc.). +* Des méthodes HTTP spécifiques (`POST`, `PUT`) ou toutes avec le caractère générique « * ». +* Des en-têtes HTTP spécifiques ou tous avec le caractère générique « * ». + +{* ../../docs_src/cors/tutorial001_py310.py hl[2,6:11,13:19] *} + +Les paramètres utilisés par défaut par l’implémentation de `CORSMiddleware` sont restrictifs, vous devez donc activer explicitement des origines, méthodes ou en-têtes particuliers afin que les navigateurs soient autorisés à les utiliser dans un contexte inter‑domaine. + +Les arguments suivants sont pris en charge : + +* `allow_origins` - Une liste d’origines autorisées à effectuer des requêtes cross-origin. Par ex. `['https://example.org', 'https://www.example.org']`. Vous pouvez utiliser `['*']` pour autoriser n’importe quelle origine. +* `allow_origin_regex` - Une chaîne regex pour faire correspondre les origines autorisées à effectuer des requêtes cross-origin. Par ex. `'https://.*\.example\.org'`. +* `allow_methods` - Une liste de méthodes HTTP qui doivent être autorisées pour les requêtes cross-origin. Par défaut `['GET']`. Vous pouvez utiliser `['*']` pour autoriser toutes les méthodes standard. +* `allow_headers` - Une liste d’en-têtes HTTP de requête qui doivent être pris en charge pour les requêtes cross-origin. Par défaut `[]`. Vous pouvez utiliser `['*']` pour autoriser tous les en-têtes. Les en-têtes `Accept`, `Accept-Language`, `Content-Language` et `Content-Type` sont toujours autorisés pour les requêtes CORS simples. +* `allow_credentials` - Indique que les cookies doivent être pris en charge pour les requêtes cross-origin. Par défaut `False`. + + Aucun de `allow_origins`, `allow_methods` et `allow_headers` ne peut être défini à `['*']` si `allow_credentials` est défini à `True`. Ils doivent tous être spécifiés explicitement. + +* `expose_headers` - Indique les en-têtes de réponse qui doivent être accessibles au navigateur. Par défaut `[]`. +* `max_age` - Définit un temps maximum (en secondes) pendant lequel les navigateurs peuvent mettre en cache les réponses CORS. Par défaut `600`. + +Le middleware répond à deux types particuliers de requêtes HTTP ... + +### Requêtes CORS de pré‑vérification { #cors-preflight-requests } + +Il s’agit de toute requête `OPTIONS` avec les en-têtes `Origin` et `Access-Control-Request-Method`. + +Dans ce cas, le middleware interceptera la requête entrante et répondra avec les en-têtes CORS appropriés, et soit une réponse `200`, soit `400` à titre informatif. + +### Requêtes simples { #simple-requests } + +Toute requête avec un en-tête `Origin`. Dans ce cas, le middleware laissera passer la requête normalement, mais inclura les en-têtes CORS appropriés dans la réponse. + +## En savoir plus { #more-info } + +Pour plus d’informations sur CORS, consultez la documentation CORS de Mozilla. + +/// note | Détails techniques + +Vous pouvez également utiliser `from starlette.middleware.cors import CORSMiddleware`. + +**FastAPI** fournit plusieurs middlewares dans `fastapi.middleware` uniquement pour votre confort, en tant que développeur. Mais la plupart des middlewares disponibles proviennent directement de Starlette. + +/// diff --git a/docs/fr/docs/tutorial/debugging.md b/docs/fr/docs/tutorial/debugging.md index a88fa2b23f..d69e6a3bae 100644 --- a/docs/fr/docs/tutorial/debugging.md +++ b/docs/fr/docs/tutorial/debugging.md @@ -6,7 +6,7 @@ Vous pouvez connecter le débogueur da Dans votre application FastAPI, importez et exécutez directement `uvicorn` : -{* ../../docs_src/debugging/tutorial001_py39.py hl[1,15] *} +{* ../../docs_src/debugging/tutorial001_py310.py hl[1,15] *} ### À propos de `__name__ == "__main__"` { #about-name-main } @@ -87,7 +87,7 @@ Parce que vous exécutez le serveur Uvicorn directement depuis votre code, vous Par exemple, dans Visual Studio Code, vous pouvez : - Allez dans le panneau « Debug ». -- « Add configuration... ». +- « Add configuration ... ». - Sélectionnez « Python ». - Lancez le débogueur avec l'option « Python: Current File (Integrated Terminal) ». @@ -102,7 +102,7 @@ Voici à quoi cela pourrait ressembler : Si vous utilisez Pycharm, vous pouvez : - Ouvrez le menu « Run ». -- Sélectionnez l'option « Debug... ». +- Sélectionnez l'option « Debug ... ». - Un menu contextuel s'affiche alors. - Sélectionnez le fichier à déboguer (dans ce cas, `main.py`). diff --git a/docs/fr/docs/tutorial/dependencies/classes-as-dependencies.md b/docs/fr/docs/tutorial/dependencies/classes-as-dependencies.md new file mode 100644 index 0000000000..69bc6008ad --- /dev/null +++ b/docs/fr/docs/tutorial/dependencies/classes-as-dependencies.md @@ -0,0 +1,288 @@ +# Utiliser des classes comme dépendances { #classes-as-dependencies } + +Avant d'aller plus loin dans le système d'**Injection de dépendances**, mettons à niveau l'exemple précédent. + +## Un `dict` de l'exemple précédent { #a-dict-from-the-previous-example } + +Dans l'exemple précédent, nous renvoyions un `dict` depuis notre dépendance (« dependable ») : + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[9] *} + +Mais nous recevons alors un `dict` dans le paramètre `commons` de la fonction de chemin d'accès. + +Et les éditeurs ne peuvent pas apporter beaucoup d'assistance (comme l'autocomplétion) pour les `dict`, car ils ne peuvent pas connaître leurs clés ni les types de valeurs. + +Nous pouvons faire mieux ... + +## Ce qui fait d'un objet une dépendance { #what-makes-a-dependency } + +Jusqu'à présent, vous avez vu des dépendances déclarées sous forme de fonctions. + +Mais ce n'est pas la seule manière de déclarer des dépendances (même si c'est probablement la plus courante). + +L'élément clé est qu'une dépendance doit être un « callable ». + +Un « callable » en Python est tout ce que Python peut « appeler » comme une fonction. + +Ainsi, si vous avez un objet `something` (qui n'est peut‑être pas une fonction) et que vous pouvez « l'appeler » (l'exécuter) comme : + +```Python +something() +``` + +ou + +```Python +something(some_argument, some_keyword_argument="foo") +``` + +alors c'est un « callable ». + +## Utiliser des classes comme dépendances { #classes-as-dependencies_1 } + +Vous remarquerez que pour créer une instance d'une classe Python, vous utilisez la même syntaxe. + +Par exemple : + +```Python +class Cat: + def __init__(self, name: str): + self.name = name + + +fluffy = Cat(name="Mr Fluffy") +``` + +Dans ce cas, `fluffy` est une instance de la classe `Cat`. + +Et pour créer `fluffy`, vous « appelez » `Cat`. + +Donc, une classe Python est aussi un « callable ». + +Ainsi, avec **FastAPI**, vous pouvez utiliser une classe Python comme dépendance. + +Ce que **FastAPI** vérifie réellement, c'est qu'il s'agit d'un « callable » (fonction, classe ou autre) et des paramètres qui y sont définis. + +Si vous passez un « callable » comme dépendance dans **FastAPI**, il en analysera les paramètres et les traitera de la même manière que les paramètres d'une fonction de chemin d'accès. Y compris les sous‑dépendances. + +Cela s'applique également aux callables sans aucun paramètre. Comme ce serait le cas pour des fonctions de chemin d'accès sans paramètres. + +Nous pouvons alors remplacer la dépendance « dependable » `common_parameters` ci‑dessus par la classe `CommonQueryParams` : + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[11:15] *} + +Faites attention à la méthode `__init__` utilisée pour créer l'instance de la classe : + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[12] *} + +... il a les mêmes paramètres que notre précédent `common_parameters` : + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[8] *} + +Ce sont ces paramètres que **FastAPI** utilisera pour « résoudre » la dépendance. + +Dans les deux cas, il y aura : + +- Un paramètre de requête optionnel `q` qui est un `str`. +- Un paramètre de requête `skip` qui est un `int`, avec une valeur par défaut de `0`. +- Un paramètre de requête `limit` qui est un `int`, avec une valeur par défaut de `100`. + +Dans les deux cas, les données seront converties, validées, documentées dans le schéma OpenAPI, etc. + +## Utiliser { #use-it } + +Vous pouvez maintenant déclarer votre dépendance en utilisant cette classe. + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[19] *} + +**FastAPI** appelle la classe `CommonQueryParams`. Cela crée une « instance » de cette classe et l'instance sera passée comme paramètre `commons` à votre fonction. + +## Annotation de type vs `Depends` { #type-annotation-vs-depends } + +Remarquez que nous écrivons `CommonQueryParams` deux fois dans le code ci‑dessus : + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ sans Annotated + +/// tip | Astuce + +Privilégiez la version avec `Annotated` si possible. + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +Le dernier `CommonQueryParams`, dans : + +```Python +... Depends(CommonQueryParams) +``` + +... est ce que **FastAPI** utilisera réellement pour savoir quelle est la dépendance. + +C'est à partir de celui‑ci que FastAPI extraira les paramètres déclarés et c'est ce que FastAPI appellera effectivement. + +--- + +Dans ce cas, le premier `CommonQueryParams`, dans : + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, ... +``` + +//// + +//// tab | Python 3.10+ sans Annotated + +/// tip | Astuce + +Privilégiez la version avec `Annotated` si possible. + +/// + +```Python +commons: CommonQueryParams ... +``` + +//// + +... n'a aucune signification particulière pour **FastAPI**. FastAPI ne l'utilisera pas pour la conversion des données, la validation, etc. (car il utilise `Depends(CommonQueryParams)` pour cela). + +Vous pourriez en fait écrire simplement : + +//// tab | Python 3.10+ + +```Python +commons: Annotated[Any, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ sans Annotated + +/// tip | Astuce + +Privilégiez la version avec `Annotated` si possible. + +/// + +```Python +commons = Depends(CommonQueryParams) +``` + +//// + +... comme dans : + +{* ../../docs_src/dependencies/tutorial003_an_py310.py hl[19] *} + +Mais il est recommandé de déclarer le type ; ainsi, votre éditeur saura ce qui sera passé comme paramètre `commons`, et pourra vous aider avec l'autocomplétion, les vérifications de type, etc. : + + + +## Raccourci { #shortcut } + +Mais vous voyez qu'il y a ici de la duplication de code : nous écrivons `CommonQueryParams` deux fois : + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ sans Annotated + +/// tip | Astuce + +Privilégiez la version avec `Annotated` si possible. + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +**FastAPI** fournit un raccourci pour ces cas, lorsque la dépendance est spécifiquement une classe que **FastAPI** va « appeler » pour créer une instance de la classe elle‑même. + +Pour ces cas précis, vous pouvez faire ce qui suit : + +Au lieu d'écrire : + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ sans Annotated + +/// tip | Astuce + +Privilégiez la version avec `Annotated` si possible. + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +... vous écrivez : + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends()] +``` + +//// + +//// tab | Python 3.10+ sans Annotated + +/// tip | Astuce + +Privilégiez la version avec `Annotated` si possible. + +/// + +```Python +commons: CommonQueryParams = Depends() +``` + +//// + +Vous déclarez la dépendance comme type du paramètre et vous utilisez `Depends()` sans aucun paramètre, au lieu d'avoir à réécrire la classe entière à l'intérieur de `Depends(CommonQueryParams)`. + +Le même exemple ressemblerait alors à ceci : + +{* ../../docs_src/dependencies/tutorial004_an_py310.py hl[19] *} + +... et **FastAPI** saura quoi faire. + +/// tip | Astuce + +Si cela vous semble plus déroutant qu'utile, ignorez‑le, vous n'en avez pas besoin. + +Ce n'est qu'un raccourci. Parce que **FastAPI** tient à vous aider à minimiser la duplication de code. + +/// diff --git a/docs/fr/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md b/docs/fr/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md new file mode 100644 index 0000000000..bf697fe8de --- /dev/null +++ b/docs/fr/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md @@ -0,0 +1,69 @@ +# Gérer les dépendances dans les décorateurs de chemins d'accès { #dependencies-in-path-operation-decorators } + +Dans certains cas, vous n'avez pas vraiment besoin de la valeur de retour d'une dépendance dans votre *fonction de chemin d'accès*. + +Ou la dépendance ne retourne aucune valeur. + +Mais vous avez quand même besoin qu'elle soit exécutée/résolue. + +Dans ces cas, au lieu de déclarer un paramètre de *fonction de chemin d'accès* avec `Depends`, vous pouvez ajouter une `list` de `dependencies` au *décorateur de chemin d'accès*. + +## Ajouter `dependencies` au *décorateur de chemin d'accès* { #add-dependencies-to-the-path-operation-decorator } + +Le *décorateur de chemin d'accès* accepte un argument optionnel `dependencies`. + +Il doit s'agir d'une `list` de `Depends()` : + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[19] *} + +Ces dépendances seront exécutées/résolues de la même manière que des dépendances normales. Mais leur valeur (si elles en retournent une) ne sera pas transmise à votre *fonction de chemin d'accès*. + +/// tip | Astuce + +Certains éditeurs vérifient les paramètres de fonction non utilisés et les signalent comme des erreurs. + +En utilisant ces `dependencies` dans le *décorateur de chemin d'accès*, vous pouvez vous assurer qu'elles sont exécutées tout en évitant des erreurs de l'éditeur/des outils. + +Cela peut également éviter toute confusion pour les nouveaux développeurs qui voient un paramètre inutilisé dans votre code et pourraient penser qu'il est superflu. + +/// + +/// info | Info + +Dans cet exemple, nous utilisons des en-têtes personnalisés fictifs `X-Key` et `X-Token`. + +Mais dans des cas réels, lors de l'implémentation de la sécurité, vous tirerez davantage d'avantages en utilisant les [utilitaires de sécurité (chapitre suivant)](../security/index.md){.internal-link target=_blank} intégrés. + +/// + +## Gérer les erreurs et les valeurs de retour des dépendances { #dependencies-errors-and-return-values } + +Vous pouvez utiliser les mêmes *fonctions* de dépendance que d'habitude. + +### Définir les exigences des dépendances { #dependency-requirements } + +Elles peuvent déclarer des exigences pour la requête (comme des en-têtes) ou d'autres sous-dépendances : + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[8,13] *} + +### Lever des exceptions { #raise-exceptions } + +Ces dépendances peuvent `raise` des exceptions, comme des dépendances normales : + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[10,15] *} + +### Gérer les valeurs de retour { #return-values } + +Elles peuvent retourner des valeurs ou non, ces valeurs ne seront pas utilisées. + +Vous pouvez donc réutiliser une dépendance normale (qui retourne une valeur) que vous utilisez déjà ailleurs ; même si la valeur n'est pas utilisée, la dépendance sera exécutée : + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[11,16] *} + +## Définir des dépendances pour un groupe de chemins d'accès { #dependencies-for-a-group-of-path-operations } + +Plus tard, en lisant comment structurer des applications plus grandes ([Applications plus grandes - Plusieurs fichiers](../../tutorial/bigger-applications.md){.internal-link target=_blank}), éventuellement avec plusieurs fichiers, vous apprendrez à déclarer un unique paramètre `dependencies` pour un groupe de *chemins d'accès*. + +## Définir des dépendances globales { #global-dependencies } + +Ensuite, nous verrons comment ajouter des dépendances à l'application `FastAPI` entière, afin qu'elles s'appliquent à chaque *chemin d'accès*. diff --git a/docs/fr/docs/tutorial/dependencies/dependencies-with-yield.md b/docs/fr/docs/tutorial/dependencies/dependencies-with-yield.md new file mode 100644 index 0000000000..3f06df7674 --- /dev/null +++ b/docs/fr/docs/tutorial/dependencies/dependencies-with-yield.md @@ -0,0 +1,289 @@ +# Utiliser des dépendances avec `yield` { #dependencies-with-yield } + +FastAPI prend en charge des dépendances qui effectuent des étapes supplémentaires après l'exécution. + +Pour cela, utilisez `yield` au lieu de `return`, et écrivez les étapes supplémentaires (code) après. + +/// tip | Astuce + +Vous devez vous assurer d'utiliser `yield` une seule fois par dépendance. + +/// + +/// note | Détails techniques + +Toute fonction valide à utiliser avec : + +* `@contextlib.contextmanager` ou +* `@contextlib.asynccontextmanager` + +sera valide comme dépendance **FastAPI**. + +En fait, FastAPI utilise ces deux décorateurs en interne. + +/// + +## Créer une dépendance de base de données avec `yield` { #a-database-dependency-with-yield } + +Par exemple, vous pouvez l'utiliser pour créer une session de base de données et la fermer après la fin. + +Seul le code précédant et incluant l'instruction `yield` est exécuté avant la création de la réponse : + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[2:4] *} + +La valeur transmise par `yield` est celle qui est injectée dans les *chemins d'accès* et autres dépendances : + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[4] *} + +Le code suivant l'instruction `yield` est exécuté après la réponse : + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[5:6] *} + +/// tip | Astuce + +Vous pouvez utiliser des fonctions `async` ou des fonctions classiques. + +**FastAPI** fera ce qu'il faut dans chaque cas, comme avec des dépendances normales. + +/// + +## Créer une dépendance avec `yield` et `try` { #a-dependency-with-yield-and-try } + +Si vous utilisez un bloc `try` dans une dépendance avec `yield`, vous recevrez toute exception qui a été levée lors de l'utilisation de la dépendance. + +Par exemple, si à un moment donné, dans une autre dépendance ou dans un *chemin d'accès*, un code a effectué un « rollback » de transaction de base de données ou a créé une autre exception, vous recevrez l'exception dans votre dépendance. + +Vous pouvez donc rechercher cette exception spécifique dans la dépendance avec `except SomeException`. + +De la même manière, vous pouvez utiliser `finally` pour vous assurer que les étapes de sortie sont exécutées, qu'il y ait eu une exception ou non. + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[3,5] *} + +## Utiliser des sous-dépendances avec `yield` { #sub-dependencies-with-yield } + +Vous pouvez avoir des sous-dépendances et des « arbres » de sous-dépendances de toute taille et forme, et certaines ou toutes peuvent utiliser `yield`. + +**FastAPI** s'assurera que le « code de sortie » dans chaque dépendance avec `yield` est exécuté dans le bon ordre. + +Par exemple, `dependency_c` peut dépendre de `dependency_b`, et `dependency_b` de `dependency_a` : + +{* ../../docs_src/dependencies/tutorial008_an_py310.py hl[6,14,22] *} + +Et elles peuvent toutes utiliser `yield`. + +Dans ce cas, `dependency_c`, pour exécuter son code de sortie, a besoin que la valeur de `dependency_b` (appelée ici `dep_b`) soit toujours disponible. + +Et, à son tour, `dependency_b` a besoin que la valeur de `dependency_a` (appelée ici `dep_a`) soit disponible pour son code de sortie. + +{* ../../docs_src/dependencies/tutorial008_an_py310.py hl[18:19,26:27] *} + +De la même manière, vous pouvez avoir certaines dépendances avec `yield` et d'autres avec `return`, et faire en sorte que certaines dépendent des autres. + +Et vous pouvez avoir une seule dépendance qui exige plusieurs autres dépendances avec `yield`, etc. + +Vous pouvez combiner les dépendances comme vous le souhaitez. + +**FastAPI** s'assurera que tout est exécuté dans le bon ordre. + +/// note | Détails techniques + +Cela fonctionne grâce aux gestionnaires de contexte de Python. + +**FastAPI** les utilise en interne pour y parvenir. + +/// + +## Utiliser des dépendances avec `yield` et `HTTPException` { #dependencies-with-yield-and-httpexception } + +Vous avez vu que vous pouvez utiliser des dépendances avec `yield` et avoir des blocs `try` qui tentent d'exécuter du code puis exécutent du code de sortie après `finally`. + +Vous pouvez également utiliser `except` pour intercepter l'exception qui a été levée et faire quelque chose avec. + +Par exemple, vous pouvez lever une autre exception, comme `HTTPException`. + +/// tip | Astuce + +C'est une technique plutôt avancée, et dans la plupart des cas vous n'en aurez pas vraiment besoin, car vous pouvez lever des exceptions (y compris `HTTPException`) depuis le reste de votre code applicatif, par exemple, dans la *fonction de chemin d'accès*. + +Mais elle est à votre disposition si vous en avez besoin. 🤓 + +/// + +{* ../../docs_src/dependencies/tutorial008b_an_py310.py hl[18:22,31] *} + +Si vous souhaitez intercepter des exceptions et créer une réponse personnalisée en fonction de cela, créez un [Gestionnaire d'exceptions personnalisé](../handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank}. + +## Utiliser des dépendances avec `yield` et `except` { #dependencies-with-yield-and-except } + +Si vous interceptez une exception avec `except` dans une dépendance avec `yield` et que vous ne la relancez pas (ou que vous ne levez pas une nouvelle exception), FastAPI ne pourra pas remarquer qu'il y a eu une exception, de la même manière que cela se produirait avec Python classique : + +{* ../../docs_src/dependencies/tutorial008c_an_py310.py hl[15:16] *} + +Dans ce cas, le client verra une réponse *HTTP 500 Internal Server Error* comme il se doit, étant donné que nous ne levons pas de `HTTPException` ou similaire, mais le serveur **n'aura aucun logs** ni aucune autre indication de l'erreur. 😱 + +### Toujours `raise` dans les dépendances avec `yield` et `except` { #always-raise-in-dependencies-with-yield-and-except } + +Si vous interceptez une exception dans une dépendance avec `yield`, à moins de lever une autre `HTTPException` ou similaire, **vous devez relancer l'exception d'origine**. + +Vous pouvez relancer la même exception avec `raise` : + +{* ../../docs_src/dependencies/tutorial008d_an_py310.py hl[17] *} + +À présent, le client recevra la même réponse *HTTP 500 Internal Server Error*, mais le serveur aura notre `InternalError` personnalisé dans les logs. 😎 + +## Comprendre l'exécution des dépendances avec `yield` { #execution-of-dependencies-with-yield } + +La séquence d'exécution ressemble plus ou moins à ce diagramme. Le temps s'écoule de haut en bas. Et chaque colonne représente une des parties qui interagit ou exécute du code. + +```mermaid +sequenceDiagram + +participant client as Client +participant handler as Exception handler +participant dep as Dep with yield +participant operation as Path Operation +participant tasks as Background tasks + + Note over client,operation: Can raise exceptions, including HTTPException + client ->> dep: Start request + Note over dep: Run code up to yield + opt raise Exception + dep -->> handler: Raise Exception + handler -->> client: HTTP error response + end + dep ->> operation: Run dependency, e.g. DB session + opt raise + operation -->> dep: Raise Exception (e.g. HTTPException) + opt handle + dep -->> dep: Can catch exception, raise a new HTTPException, raise other exception + end + handler -->> client: HTTP error response + end + + operation ->> client: Return response to client + Note over client,operation: Response is already sent, can't change it anymore + opt Tasks + operation -->> tasks: Send background tasks + end + opt Raise other exception + tasks -->> tasks: Handle exceptions in the background task code + end +``` + +/// info + +Une **seule réponse** sera envoyée au client. Il peut s'agir d'une des réponses d'erreur ou de la réponse provenant du *chemin d'accès*. + +Après l'envoi de l'une de ces réponses, aucune autre réponse ne peut être envoyée. + +/// + +/// tip | Astuce + +Si vous levez une exception dans le code de la *fonction de chemin d'accès*, elle sera transmise aux dépendances avec `yield`, y compris `HTTPException`. Dans la plupart des cas, vous voudrez relancer cette même exception ou en lever une nouvelle depuis la dépendance avec `yield` pour vous assurer qu'elle est correctement gérée. + +/// + +## Utiliser la sortie anticipée et `scope` { #early-exit-and-scope } + +Normalement, le code de sortie des dépendances avec `yield` est exécuté **après la réponse** envoyée au client. + +Mais si vous savez que vous n'aurez pas besoin d'utiliser la dépendance après être revenu de la *fonction de chemin d'accès*, vous pouvez utiliser `Depends(scope="function")` pour indiquer à FastAPI qu'il doit fermer la dépendance après le retour de la *fonction de chemin d'accès*, mais **avant** que la **réponse ne soit envoyée**. + +{* ../../docs_src/dependencies/tutorial008e_an_py310.py hl[12,16] *} + +`Depends()` reçoit un paramètre `scope` qui peut être : + +* « function » : démarrer la dépendance avant la *fonction de chemin d'accès* qui gère la requête, terminer la dépendance après la fin de la *fonction de chemin d'accès*, mais **avant** que la réponse ne soit renvoyée au client. Ainsi, la fonction de dépendance sera exécutée **autour** de la *fonction de chemin d'accès*. +* « request » : démarrer la dépendance avant la *fonction de chemin d'accès* qui gère la requête (similaire à l'utilisation de « function »), mais terminer **après** que la réponse a été renvoyée au client. Ainsi, la fonction de dépendance sera exécutée **autour** du cycle **requête** et réponse. + +S'il n'est pas spécifié et que la dépendance utilise `yield`, le `scope` sera par défaut « request ». + +### Définir `scope` pour les sous-dépendances { #scope-for-sub-dependencies } + +Lorsque vous déclarez une dépendance avec un `scope="request"` (par défaut), toute sous-dépendance doit également avoir un `scope` de « request ». + +Mais une dépendance avec un `scope` de « function » peut avoir des dépendances avec un `scope` de « function » et un `scope` de « request ». + +Cela vient du fait que toute dépendance doit pouvoir exécuter son code de sortie avant ses sous-dépendances, car elle pourrait encore avoir besoin de les utiliser pendant son code de sortie. + +```mermaid +sequenceDiagram + +participant client as Client +participant dep_req as Dep scope="request" +participant dep_func as Dep scope="function" +participant operation as Path Operation + + client ->> dep_req: Start request + Note over dep_req: Run code up to yield + dep_req ->> dep_func: Pass dependency + Note over dep_func: Run code up to yield + dep_func ->> operation: Run path operation with dependency + operation ->> dep_func: Return from path operation + Note over dep_func: Run code after yield + Note over dep_func: ✅ Dependency closed + dep_func ->> client: Send response to client + Note over client: Response sent + Note over dep_req: Run code after yield + Note over dep_req: ✅ Dependency closed +``` + +## Utiliser des dépendances avec `yield`, `HTTPException`, `except` et Background Tasks { #dependencies-with-yield-httpexception-except-and-background-tasks } + +Les dépendances avec `yield` ont évolué au fil du temps pour couvrir différents cas d'utilisation et corriger certains problèmes. + +Si vous souhaitez voir ce qui a changé dans différentes versions de FastAPI, vous pouvez en savoir plus dans le guide avancé, dans [Dépendances avancées - Dépendances avec `yield`, `HTTPException`, `except` et Background Tasks](../../advanced/advanced-dependencies.md#dependencies-with-yield-httpexception-except-and-background-tasks){.internal-link target=_blank}. +## Gestionnaires de contexte { #context-managers } + +### Que sont les « Context Managers » { #what-are-context-managers } + +Les « Context Managers » sont des objets Python que vous pouvez utiliser dans une instruction `with`. + +Par exemple, vous pouvez utiliser `with` pour lire un fichier : + +```Python +with open("./somefile.txt") as f: + contents = f.read() + print(contents) +``` + +En coulisse, `open("./somefile.txt")` crée un objet appelé « Context Manager ». + +Lorsque le bloc `with` se termine, il s'assure de fermer le fichier, même s'il y a eu des exceptions. + +Lorsque vous créez une dépendance avec `yield`, **FastAPI** créera en interne un gestionnaire de contexte pour celle-ci et le combinera avec d'autres outils associés. + +### Utiliser des gestionnaires de contexte dans des dépendances avec `yield` { #using-context-managers-in-dependencies-with-yield } + +/// warning | Alertes + +C'est, plus ou moins, une idée « avancée ». + +Si vous débutez avec **FastAPI**, vous voudrez peut-être l'ignorer pour le moment. + +/// + +En Python, vous pouvez créer des gestionnaires de contexte en créant une classe avec deux méthodes : `__enter__()` et `__exit__()`. + +Vous pouvez également les utiliser dans des dépendances **FastAPI** avec `yield` en utilisant +des instructions `with` ou `async with` à l'intérieur de la fonction de dépendance : + +{* ../../docs_src/dependencies/tutorial010_py310.py hl[1:9,13] *} + +/// tip | Astuce + +Une autre façon de créer un gestionnaire de contexte consiste à utiliser : + +* `@contextlib.contextmanager` ou +* `@contextlib.asynccontextmanager` + +pour décorer une fonction avec un unique `yield`. + +C'est ce que **FastAPI** utilise en interne pour les dépendances avec `yield`. + +Mais vous n'avez pas à utiliser ces décorateurs pour les dépendances FastAPI (et vous ne devriez pas). + +FastAPI le fera pour vous en interne. + +/// diff --git a/docs/fr/docs/tutorial/dependencies/global-dependencies.md b/docs/fr/docs/tutorial/dependencies/global-dependencies.md new file mode 100644 index 0000000000..2c418ee4a1 --- /dev/null +++ b/docs/fr/docs/tutorial/dependencies/global-dependencies.md @@ -0,0 +1,15 @@ +# Dépendances globales { #global-dependencies } + +Pour certains types d'applications, vous pourriez vouloir ajouter des dépendances à l'application entière. + +Comme vous pouvez [ajouter des `dependencies` aux *décorateurs de chemin d'accès*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, vous pouvez les ajouter à l'application `FastAPI`. + +Dans ce cas, elles seront appliquées à tous les *chemins d'accès* de l'application : + +{* ../../docs_src/dependencies/tutorial012_an_py310.py hl[17] *} + +Et toutes les idées de la section sur [l'ajout de `dependencies` aux *décorateurs de chemin d'accès*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank} s'appliquent toujours, mais dans ce cas à tous les *chemins d'accès* de l'application. + +## Dépendances pour des groupes de *chemins d'accès* { #dependencies-for-groups-of-path-operations } + +Plus tard, en lisant comment structurer des applications plus grandes ([Applications plus grandes - Plusieurs fichiers](../../tutorial/bigger-applications.md){.internal-link target=_blank}), éventuellement avec plusieurs fichiers, vous apprendrez comment déclarer un unique paramètre `dependencies` pour un groupe de *chemins d'accès*. diff --git a/docs/fr/docs/tutorial/dependencies/index.md b/docs/fr/docs/tutorial/dependencies/index.md new file mode 100644 index 0000000000..8fad77f62a --- /dev/null +++ b/docs/fr/docs/tutorial/dependencies/index.md @@ -0,0 +1,250 @@ +# Dépendances { #dependencies } + +**FastAPI** dispose d’un système d’**Injection de dépendances** très puissant mais intuitif. + +Il est conçu pour être très simple à utiliser, et pour faciliter l’intégration d’autres composants à **FastAPI** pour n’importe quel développeur. + +## Qu’est-ce que « l’injection de dépendances » { #what-is-dependency-injection } + +L’**« injection de dépendances »** signifie, en programmation, qu’il existe un moyen pour votre code (dans ce cas, vos fonctions de chemins d’accès) de déclarer ce dont il a besoin pour fonctionner et utiliser : « dépendances ». + +Ensuite, ce système (dans ce cas **FastAPI**) se charge de faire tout le nécessaire pour fournir à votre code ces dépendances requises (« injecter » les dépendances). + +C’est très utile lorsque vous avez besoin de : + +* Avoir de la logique partagée (la même logique de code encore et encore). +* Partager des connexions à la base de données. +* Imposer la sécurité, l’authentification, des exigences de rôles, etc. +* Et bien d’autres choses ... + +Tout cela, en minimisant la répétition de code. + +## Premiers pas { #first-steps } + +Voyons un exemple très simple. Il sera tellement simple qu’il n’est pas très utile, pour l’instant. + +Mais de cette façon nous pouvons nous concentrer sur le fonctionnement du système d’**injection de dépendances**. + +### Créer une dépendance, ou « dependable » { #create-a-dependency-or-dependable } + +Concentrons-nous d’abord sur la dépendance. + +C’est simplement une fonction qui peut prendre tous les mêmes paramètres qu’une fonction de chemin d’accès peut prendre : + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[8:9] *} + +C’est tout. + +**2 lignes**. + +Et elle a la même forme et structure que toutes vos fonctions de chemins d’accès. + +Vous pouvez la considérer comme une fonction de chemin d’accès sans le « décorateur » (sans le `@app.get("/some-path")`). + +Et elle peut retourner tout ce que vous voulez. + +Dans ce cas, cette dépendance attend : + +* Un paramètre de requête optionnel `q` qui est une `str`. +* Un paramètre de requête optionnel `skip` qui est un `int`, et vaut `0` par défaut. +* Un paramètre de requête optionnel `limit` qui est un `int`, et vaut `100` par défaut. + +Puis elle retourne simplement un `dict` contenant ces valeurs. + +/// info | Info + +FastAPI a ajouté la prise en charge de `Annotated` (et a commencé à le recommander) dans la version 0.95.0. + +Si vous avez une version plus ancienne, vous obtiendrez des erreurs en essayant d’utiliser `Annotated`. + +Vous devez vous assurer de [mettre à niveau la version de FastAPI](../../deployment/versions.md#upgrading-the-fastapi-versions){.internal-link target=_blank} vers au moins la 0.95.1 avant d’utiliser `Annotated`. + +/// + +### Importer `Depends` { #import-depends } + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[3] *} + +### Déclarer la dépendance, dans le « dependant » { #declare-the-dependency-in-the-dependant } + +De la même manière que vous utilisez `Body`, `Query`, etc. avec les paramètres de votre fonction de chemin d’accès, utilisez `Depends` avec un nouveau paramètre : + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[13,18] *} + +Même si vous utilisez `Depends` dans les paramètres de votre fonction de la même façon que `Body`, `Query`, etc., `Depends` fonctionne un peu différemment. + +Vous ne donnez à `Depends` qu’un seul paramètre. + +Ce paramètre doit être quelque chose comme une fonction. + +Vous ne l’appelez pas directement (n’ajoutez pas de parenthèses à la fin), vous le passez simplement en paramètre à `Depends()`. + +Et cette fonction prend des paramètres de la même manière que les fonctions de chemins d’accès. + +/// tip | Astuce + +Vous verrez quelles autres « choses », en plus des fonctions, peuvent être utilisées comme dépendances dans le prochain chapitre. + +/// + +Chaque fois qu’une nouvelle requête arrive, **FastAPI** se charge de : + +* Appeler votre fonction de dépendance (« dependable ») avec les bons paramètres. +* Récupérer le résultat de votre fonction. +* Affecter ce résultat au paramètre dans votre fonction de chemin d’accès. + +```mermaid +graph TB + +common_parameters(["common_parameters"]) +read_items["/items/"] +read_users["/users/"] + +common_parameters --> read_items +common_parameters --> read_users +``` + +De cette façon vous écrivez le code partagé une seule fois et **FastAPI** se charge de l’appeler pour vos chemins d’accès. + +/// check | Vérifications + +Notez que vous n’avez pas à créer une classe spéciale et à la passer quelque part à **FastAPI** pour l’« enregistrer » ou quoi que ce soit de similaire. + +Vous la passez simplement à `Depends` et **FastAPI** sait faire le reste. + +/// + +## Partager des dépendances `Annotated` { #share-annotated-dependencies } + +Dans les exemples ci-dessus, vous voyez qu’il y a un tout petit peu de **duplication de code**. + +Lorsque vous devez utiliser la dépendance `common_parameters()`, vous devez écrire tout le paramètre avec l’annotation de type et `Depends()` : + +```Python +commons: Annotated[dict, Depends(common_parameters)] +``` + +Mais comme nous utilisons `Annotated`, nous pouvons stocker cette valeur `Annotated` dans une variable et l’utiliser à plusieurs endroits : + +{* ../../docs_src/dependencies/tutorial001_02_an_py310.py hl[12,16,21] *} + +/// tip | Astuce + +C’est simplement du Python standard, cela s’appelle un « alias de type », ce n’est en fait pas spécifique à **FastAPI**. + +Mais comme **FastAPI** est basé sur les standards Python, y compris `Annotated`, vous pouvez utiliser cette astuce dans votre code. 😎 + +/// + +Les dépendances continueront de fonctionner comme prévu, et la **meilleure partie** est que **l’information de type sera conservée**, ce qui signifie que votre éditeur pourra continuer à vous fournir **l’autocomplétion**, **des erreurs en ligne**, etc. Idem pour d’autres outils comme `mypy`. + +Cela sera particulièrement utile lorsque vous l’utiliserez dans une **grande base de code** où vous utilisez **les mêmes dépendances** encore et encore dans **de nombreux chemins d’accès**. + +## Utiliser `async` ou non { #to-async-or-not-to-async } + +Comme les dépendances seront aussi appelées par **FastAPI** (tout comme vos fonctions de chemins d’accès), les mêmes règles s’appliquent lors de la définition de vos fonctions. + +Vous pouvez utiliser `async def` ou un `def` normal. + +Et vous pouvez déclarer des dépendances avec `async def` à l’intérieur de fonctions de chemins d’accès `def` normales, ou des dépendances `def` à l’intérieur de fonctions de chemins d’accès `async def`, etc. + +Peu importe. **FastAPI** saura quoi faire. + +/// note | Remarque + +Si vous ne savez pas, consultez la section [Async : *« Pressé ? »*](../../async.md#in-a-hurry){.internal-link target=_blank} à propos de `async` et `await` dans la documentation. + +/// + +## Intégrer à OpenAPI { #integrated-with-openapi } + +Toutes les déclarations de requête, validations et exigences de vos dépendances (et sous-dépendances) seront intégrées dans le même schéma OpenAPI. + +Ainsi, la documentation interactive contiendra aussi toutes les informations issues de ces dépendances : + + + +## Utilisation simple { #simple-usage } + +Si vous y regardez de près, les fonctions de chemins d’accès sont déclarées pour être utilisées chaque fois qu’un « chemin » et une « opération » correspondent, puis **FastAPI** se charge d’appeler la fonction avec les bons paramètres, en extrayant les données de la requête. + +En réalité, tous (ou la plupart) des frameworks web fonctionnent de cette manière. + +Vous n’appelez jamais ces fonctions directement. Elles sont appelées par votre framework (dans ce cas, **FastAPI**). + +Avec le système d’injection de dépendances, vous pouvez aussi indiquer à **FastAPI** que votre fonction de chemin d’accès « dépend » également d’autre chose qui doit être exécuté avant votre fonction de chemin d’accès, et **FastAPI** se chargera de l’exécuter et d’« injecter » les résultats. + +D’autres termes courants pour cette même idée « d’injection de dépendances » sont : + +* ressources +* fournisseurs +* services +* injectables +* composants + +## Plug-ins **FastAPI** { #fastapi-plug-ins } + +Les intégrations et « plug-ins » peuvent être construits en utilisant le système d’**injection de dépendances**. Mais en réalité, il n’y a **pas besoin de créer des « plug-ins »**, car en utilisant des dépendances il est possible de déclarer un nombre infini d’intégrations et d’interactions qui deviennent disponibles pour vos fonctions de chemins d’accès. + +Et les dépendances peuvent être créées de manière très simple et intuitive, ce qui vous permet d’importer juste les packages Python dont vous avez besoin, et de les intégrer à vos fonctions d’API en quelques lignes de code, *littéralement*. + +Vous verrez des exemples de cela dans les prochains chapitres, à propos des bases de données relationnelles et NoSQL, de la sécurité, etc. + +## Compatibilité **FastAPI** { #fastapi-compatibility } + +La simplicité du système d’injection de dépendances rend **FastAPI** compatible avec : + +* toutes les bases de données relationnelles +* les bases de données NoSQL +* les packages externes +* les API externes +* les systèmes d’authentification et d’autorisation +* les systèmes de supervision d’usage d’API +* les systèmes d’injection de données de réponse +* etc. + +## Simple et puissant { #simple-and-powerful } + +Bien que le système hiérarchique d’injection de dépendances soit très simple à définir et à utiliser, il reste très puissant. + +Vous pouvez définir des dépendances qui, à leur tour, peuvent définir leurs propres dépendances. + +Au final, un arbre hiérarchique de dépendances est construit, et le système d’**injection de dépendances** se charge de résoudre toutes ces dépendances pour vous (et leurs sous-dépendances) et de fournir (injecter) les résultats à chaque étape. + +Par exemple, supposons que vous ayez 4 endpoints d’API (chemins d’accès) : + +* `/items/public/` +* `/items/private/` +* `/users/{user_id}/activate` +* `/items/pro/` + +alors vous pourriez ajouter différentes exigences d’autorisations pour chacun d’eux uniquement avec des dépendances et des sous-dépendances : + +```mermaid +graph TB + +current_user(["current_user"]) +active_user(["active_user"]) +admin_user(["admin_user"]) +paying_user(["paying_user"]) + +public["/items/public/"] +private["/items/private/"] +activate_user["/users/{user_id}/activate"] +pro_items["/items/pro/"] + +current_user --> active_user +active_user --> admin_user +active_user --> paying_user + +current_user --> public +active_user --> private +admin_user --> activate_user +paying_user --> pro_items +``` + +## Intégrer à **OpenAPI** { #integrated-with-openapi_1 } + +Toutes ces dépendances, tout en déclarant leurs exigences, ajoutent également des paramètres, des validations, etc. à vos chemins d’accès. + +**FastAPI** se chargera d’ajouter le tout au schéma OpenAPI, afin que cela apparaisse dans les systèmes de documentation interactive. diff --git a/docs/fr/docs/tutorial/dependencies/sub-dependencies.md b/docs/fr/docs/tutorial/dependencies/sub-dependencies.md new file mode 100644 index 0000000000..473ff02ba8 --- /dev/null +++ b/docs/fr/docs/tutorial/dependencies/sub-dependencies.md @@ -0,0 +1,105 @@ +# Sous-dépendances { #sub-dependencies } + +Vous pouvez créer des dépendances qui ont des sous-dépendances. + +Elles peuvent être aussi profondes que nécessaire. + +**FastAPI** se chargera de les résoudre. + +## Créer une première dépendance « dependable » { #first-dependency-dependable } + +Vous pouvez créer une première dépendance (« dependable ») comme : + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[8:9] *} + +Elle déclare un paramètre de requête optionnel `q` de type `str`, puis le retourne simplement. + +C'est assez simple (pas très utile), mais cela nous aidera à nous concentrer sur le fonctionnement des sous-dépendances. + +## Créer une seconde dépendance, « dependable » et « dependant » { #second-dependency-dependable-and-dependant } + +Vous pouvez ensuite créer une autre fonction de dépendance (un « dependable ») qui, en même temps, déclare sa propre dépendance (elle est donc aussi un « dependant ») : + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[13] *} + +Concentrons-nous sur les paramètres déclarés : + +- Même si cette fonction est elle‑même une dépendance (« dependable »), elle déclare aussi une autre dépendance (elle « dépend » d'autre chose). + - Elle dépend de `query_extractor` et affecte la valeur renvoyée au paramètre `q`. +- Elle déclare également un cookie `last_query` optionnel, de type `str`. + - Si l'utilisateur n'a fourni aucune requête `q`, nous utilisons la dernière requête utilisée, que nous avons enregistrée auparavant dans un cookie. + +## Utiliser la dépendance { #use-the-dependency } + +Nous pouvons ensuite utiliser la dépendance avec : + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[23] *} + +/// info + +Notez que nous ne déclarons qu'une seule dépendance dans la *fonction de chemin d'accès*, `query_or_cookie_extractor`. + +Mais **FastAPI** saura qu'il doit d'abord résoudre `query_extractor`, pour passer ses résultats à `query_or_cookie_extractor` lors de son appel. + +/// + +```mermaid +graph TB + +query_extractor(["query_extractor"]) +query_or_cookie_extractor(["query_or_cookie_extractor"]) + +read_query["/items/"] + +query_extractor --> query_or_cookie_extractor --> read_query +``` + +## Utiliser la même dépendance plusieurs fois { #using-the-same-dependency-multiple-times } + +Si l'une de vos dépendances est déclarée plusieurs fois pour le même *chemin d'accès*, par exemple si plusieurs dépendances ont une sous-dépendance commune, **FastAPI** saura n'appeler cette sous-dépendance qu'une seule fois par requête. + +Et il enregistrera la valeur renvoyée dans un « cache » et la transmettra à tous les « dependants » qui en ont besoin dans cette requête spécifique, au lieu d'appeler la dépendance plusieurs fois pour la même requête. + +Dans un scénario avancé où vous savez que vous avez besoin que la dépendance soit appelée à chaque étape (éventuellement plusieurs fois) dans la même requête au lieu d'utiliser la valeur « mise en cache », vous pouvez définir le paramètre `use_cache=False` lors de l'utilisation de `Depends` : + +//// tab | Python 3.10+ + +```Python hl_lines="1" +async def needy_dependency(fresh_value: Annotated[str, Depends(get_value, use_cache=False)]): + return {"fresh_value": fresh_value} +``` + +//// + +//// tab | Python 3.10+ non annoté + +/// tip | Astuce + +Privilégiez la version `Annotated` si possible. + +/// + +```Python hl_lines="1" +async def needy_dependency(fresh_value: str = Depends(get_value, use_cache=False)): + return {"fresh_value": fresh_value} +``` + +//// + +## Récapituler { #recap } + +En dehors de tout le jargon utilisé ici, le système d'**injection de dépendances** est assez simple. + +Ce ne sont que des fonctions qui ressemblent aux *fonctions de chemin d'accès*. + +Mais il est très puissant et vous permet de déclarer des « graphes » (arbres) de dépendances imbriquées aussi profondément que vous le souhaitez. + +/// tip | Astuce + +Tout cela peut ne pas sembler très utile avec ces exemples simples. + +Mais vous verrez à quel point c'est utile dans les chapitres sur la **sécurité**. + +Et vous verrez aussi la quantité de code que cela vous fera économiser. + +/// diff --git a/docs/fr/docs/tutorial/encoder.md b/docs/fr/docs/tutorial/encoder.md new file mode 100644 index 0000000000..f94be429ca --- /dev/null +++ b/docs/fr/docs/tutorial/encoder.md @@ -0,0 +1,35 @@ +# Encodeur compatible JSON { #json-compatible-encoder } + +Il existe des cas où vous pourriez avoir besoin de convertir un type de données (comme un modèle Pydantic) en quelque chose de compatible avec JSON (comme un `dict`, `list`, etc.). + +Par exemple, si vous devez le stocker dans une base de données. + +Pour cela, **FastAPI** fournit une fonction `jsonable_encoder()`. + +## Utiliser `jsonable_encoder` { #using-the-jsonable-encoder } + +Imaginons que vous ayez une base de données `fake_db` qui ne reçoit que des données compatibles JSON. + +Par exemple, elle ne reçoit pas d'objets `datetime`, car ceux-ci ne sont pas compatibles avec JSON. + +Ainsi, un objet `datetime` doit être converti en une `str` contenant les données au format ISO. + +De la même manière, cette base de données n'accepterait pas un modèle Pydantic (un objet avec des attributs), seulement un `dict`. + +Vous pouvez utiliser `jsonable_encoder` pour cela. + +Elle reçoit un objet, comme un modèle Pydantic, et renvoie une version compatible JSON : + +{* ../../docs_src/encoder/tutorial001_py310.py hl[4,21] *} + +Dans cet exemple, elle convertirait le modèle Pydantic en `dict`, et le `datetime` en `str`. + +Le résultat de son appel est quelque chose qui peut être encodé avec la fonction standard de Python `json.dumps()`. + +Elle ne renvoie pas une grande `str` contenant les données au format JSON (sous forme de chaîne). Elle renvoie une structure de données standard de Python (par ex. un `dict`) avec des valeurs et sous-valeurs toutes compatibles avec JSON. + +/// note | Remarque + +`jsonable_encoder` est en fait utilisée par **FastAPI** en interne pour convertir des données. Mais elle est utile dans de nombreux autres scénarios. + +/// diff --git a/docs/fr/docs/tutorial/extra-data-types.md b/docs/fr/docs/tutorial/extra-data-types.md new file mode 100644 index 0000000000..edaa7bd4c3 --- /dev/null +++ b/docs/fr/docs/tutorial/extra-data-types.md @@ -0,0 +1,62 @@ +# Types de données supplémentaires { #extra-data-types } + +Jusqu'à présent, vous avez utilisé des types de données courants, comme : + +* `int` +* `float` +* `str` +* `bool` + +Mais vous pouvez aussi utiliser des types de données plus complexes. + +Et vous bénéficierez toujours des mêmes fonctionnalités que jusqu'à présent : + +* Excellente prise en charge dans l'éditeur. +* Conversion des données à partir des requêtes entrantes. +* Conversion des données pour les données de réponse. +* Validation des données. +* Annotations et documentation automatiques. + +## Autres types de données { #other-data-types } + +Voici quelques types de données supplémentaires que vous pouvez utiliser : + +* `UUID` : + * Un « identifiant universel unique » standard, couramment utilisé comme ID dans de nombreuses bases de données et systèmes. + * Dans les requêtes et les réponses, il sera représenté sous forme de `str`. +* `datetime.datetime` : + * Un `datetime.datetime` Python. + * Dans les requêtes et les réponses, il sera représenté sous forme de `str` au format ISO 8601, par exemple : `2008-09-15T15:53:00+05:00`. +* `datetime.date` : + * `datetime.date` Python. + * Dans les requêtes et les réponses, il sera représenté sous forme de `str` au format ISO 8601, par exemple : `2008-09-15`. +* `datetime.time` : + * Un `datetime.time` Python. + * Dans les requêtes et les réponses, il sera représenté sous forme de `str` au format ISO 8601, par exemple : `14:23:55.003`. +* `datetime.timedelta` : + * Un `datetime.timedelta` Python. + * Dans les requêtes et les réponses, il sera représenté sous forme de `float` de secondes totales. + * Pydantic permet aussi de le représenter sous la forme d'un « encodage de différence de temps ISO 8601 », voir la documentation pour plus d'informations. +* `frozenset` : + * Dans les requêtes et les réponses, traité de la même manière qu'un `set` : + * Dans les requêtes, une liste sera lue, les doublons éliminés, puis convertie en `set`. + * Dans les réponses, le `set` sera converti en `list`. + * Le schéma généré indiquera que les valeurs du `set` sont uniques (en utilisant `uniqueItems` de JSON Schema). +* `bytes` : + * `bytes` Python standard. + * Dans les requêtes et les réponses, traité comme une `str`. + * Le schéma généré indiquera qu'il s'agit d'une `str` avec le « format » `binary`. +* `Decimal` : + * `Decimal` Python standard. + * Dans les requêtes et les réponses, géré de la même manière qu'un `float`. +* Vous pouvez consulter tous les types de données Pydantic valides ici : Types de données Pydantic. + +## Exemple { #example } + +Voici un exemple de *chemin d'accès* avec des paramètres utilisant certains des types ci-dessus. + +{* ../../docs_src/extra_data_types/tutorial001_an_py310.py hl[1,3,12:16] *} + +Notez que les paramètres à l'intérieur de la fonction ont leur type de données naturel et que vous pouvez, par exemple, effectuer des manipulations de dates normales, comme : + +{* ../../docs_src/extra_data_types/tutorial001_an_py310.py hl[18:19] *} diff --git a/docs/fr/docs/tutorial/extra-models.md b/docs/fr/docs/tutorial/extra-models.md new file mode 100644 index 0000000000..1f9eb15616 --- /dev/null +++ b/docs/fr/docs/tutorial/extra-models.md @@ -0,0 +1,211 @@ +# Modèles supplémentaires { #extra-models } + +En poursuivant l'exemple précédent, il est courant d'avoir plusieurs modèles liés. + +C'est particulièrement vrai pour les modèles d'utilisateur, car : + +* Le modèle d'entrée doit pouvoir contenir un mot de passe. +* Le modèle de sortie ne doit pas avoir de mot de passe. +* Le modèle de base de données devra probablement avoir un mot de passe haché. + +/// danger | Danger + +Ne stockez jamais les mots de passe des utilisateurs en clair. Stockez toujours un « hachage sécurisé » que vous pourrez ensuite vérifier. + +Si vous ne savez pas ce que c'est, vous apprendrez ce qu'est un « hachage de mot de passe » dans les [chapitres sur la sécurité](security/simple-oauth2.md#password-hashing){.internal-link target=_blank}. + +/// + +## Utiliser plusieurs modèles { #multiple-models } + +Voici une idée générale de l'apparence des modèles avec leurs champs de mot de passe et les endroits où ils sont utilisés : + +{* ../../docs_src/extra_models/tutorial001_py310.py hl[7,9,14,20,22,27:28,31:33,38:39] *} + +### À propos de `**user_in.model_dump()` { #about-user-in-model-dump } + +#### La méthode `.model_dump()` de Pydantic { #pydantics-model-dump } + +`user_in` est un modèle Pydantic de classe `UserIn`. + +Les modèles Pydantic ont une méthode `.model_dump()` qui renvoie un `dict` avec les données du modèle. + +Ainsi, si nous créons un objet Pydantic `user_in` comme : + +```Python +user_in = UserIn(username="john", password="secret", email="john.doe@example.com") +``` + +et que nous appelons ensuite : + +```Python +user_dict = user_in.model_dump() +``` + +nous avons maintenant un `dict` avec les données dans la variable `user_dict` (c'est un `dict` au lieu d'un objet modèle Pydantic). + +Et si nous appelons : + +```Python +print(user_dict) +``` + +nous obtiendrions un `dict` Python contenant : + +```Python +{ + 'username': 'john', + 'password': 'secret', + 'email': 'john.doe@example.com', + 'full_name': None, +} +``` + +#### Déballer un `dict` { #unpacking-a-dict } + +Si nous prenons un `dict` comme `user_dict` et que nous le passons à une fonction (ou une classe) avec `**user_dict`, Python va « déballer » ce `dict`. Il passera les clés et valeurs de `user_dict` directement comme arguments nommés. + +Ainsi, en reprenant `user_dict` ci-dessus, écrire : + +```Python +UserInDB(**user_dict) +``` + +aurait pour résultat quelque chose d'équivalent à : + +```Python +UserInDB( + username="john", + password="secret", + email="john.doe@example.com", + full_name=None, +) +``` + +Ou plus exactement, en utilisant `user_dict` directement, quels que soient ses contenus futurs : + +```Python +UserInDB( + username = user_dict["username"], + password = user_dict["password"], + email = user_dict["email"], + full_name = user_dict["full_name"], +) +``` + +#### Créer un modèle Pydantic à partir du contenu d'un autre { #a-pydantic-model-from-the-contents-of-another } + +Comme dans l'exemple ci-dessus nous avons obtenu `user_dict` depuis `user_in.model_dump()`, ce code : + +```Python +user_dict = user_in.model_dump() +UserInDB(**user_dict) +``` + +serait équivalent à : + +```Python +UserInDB(**user_in.model_dump()) +``` + +... parce que `user_in.model_dump()` est un `dict`, et nous demandons ensuite à Python de « déballer » ce `dict` en le passant à `UserInDB` précédé de `**`. + +Ainsi, nous obtenons un modèle Pydantic à partir des données d'un autre modèle Pydantic. + +#### Déballer un `dict` et ajouter des mots-clés supplémentaires { #unpacking-a-dict-and-extra-keywords } + +Et en ajoutant ensuite l'argument nommé supplémentaire `hashed_password=hashed_password`, comme ici : + +```Python +UserInDB(**user_in.model_dump(), hashed_password=hashed_password) +``` + +... revient à : + +```Python +UserInDB( + username = user_dict["username"], + password = user_dict["password"], + email = user_dict["email"], + full_name = user_dict["full_name"], + hashed_password = hashed_password, +) +``` + +/// warning | Alertes + +Les fonctions auxiliaires `fake_password_hasher` et `fake_save_user` ne servent qu'à démontrer un flux de données possible, mais elles n'offrent évidemment aucune sécurité réelle. + +/// + +## Réduire la duplication { #reduce-duplication } + +Réduire la duplication de code est l'une des idées centrales de **FastAPI**. + +La duplication de code augmente les risques de bogues, de problèmes de sécurité, de désynchronisation du code (lorsque vous mettez à jour un endroit mais pas les autres), etc. + +Et ces modèles partagent beaucoup de données et dupliquent des noms et types d'attributs. + +Nous pouvons faire mieux. + +Nous pouvons déclarer un modèle `UserBase` qui sert de base à nos autres modèles. Ensuite, nous pouvons créer des sous-classes de ce modèle qui héritent de ses attributs (déclarations de type, validation, etc.). + +Toutes les conversions de données, validations, documentation, etc., fonctionneront comme d'habitude. + +De cette façon, nous pouvons ne déclarer que les différences entre les modèles (avec `password` en clair, avec `hashed_password` et sans mot de passe) : + +{* ../../docs_src/extra_models/tutorial002_py310.py hl[7,13:14,17:18,21:22] *} + +## `Union` ou `anyOf` { #union-or-anyof } + +Vous pouvez déclarer qu'une réponse est l'`Union` de deux types ou plus, ce qui signifie que la réponse peut être n'importe lequel d'entre eux. + +Cela sera défini dans OpenAPI avec `anyOf`. + +Pour ce faire, utilisez l'annotation de type Python standard `typing.Union` : + +/// note | Remarque + +Lors de la définition d'une `Union`, incluez d'abord le type le plus spécifique, suivi du type le moins spécifique. Dans l'exemple ci-dessous, le type le plus spécifique `PlaneItem` précède `CarItem` dans `Union[PlaneItem, CarItem]`. + +/// + +{* ../../docs_src/extra_models/tutorial003_py310.py hl[1,14:15,18:20,33] *} + +### `Union` en Python 3.10 { #union-in-python-3-10 } + +Dans cet exemple, nous passons `Union[PlaneItem, CarItem]` comme valeur de l'argument `response_model`. + +Comme nous le passons comme valeur d'un argument au lieu de l'utiliser dans une annotation de type, nous devons utiliser `Union` même en Python 3.10. + +S'il s'agissait d'une annotation de type, nous pourrions utiliser la barre verticale, comme : + +```Python +some_variable: PlaneItem | CarItem +``` + +Mais si nous écrivons cela dans l'affectation `response_model=PlaneItem | CarItem`, nous obtiendrons une erreur, car Python essaierait d'effectuer une « opération invalide » entre `PlaneItem` et `CarItem` au lieu de l'interpréter comme une annotation de type. + +## Liste de modèles { #list-of-models } + +De la même manière, vous pouvez déclarer des réponses contenant des listes d'objets. + +Pour cela, utilisez le `list` Python standard : + +{* ../../docs_src/extra_models/tutorial004_py310.py hl[18] *} + +## Réponse avec un `dict` arbitraire { #response-with-arbitrary-dict } + +Vous pouvez également déclarer une réponse en utilisant un simple `dict` arbitraire, en déclarant uniquement le type des clés et des valeurs, sans utiliser de modèle Pydantic. + +C'est utile si vous ne connaissez pas à l'avance les noms de champs/attributs valides (qui seraient nécessaires pour un modèle Pydantic). + +Dans ce cas, vous pouvez utiliser `dict` : + +{* ../../docs_src/extra_models/tutorial005_py310.py hl[6] *} + +## Récapitulatif { #recap } + +Utilisez plusieurs modèles Pydantic et héritez librement selon chaque cas. + +Vous n'avez pas besoin d'avoir un seul modèle de données par entité si cette entité doit pouvoir avoir différents « états ». Comme pour l'« entité » utilisateur, avec un état incluant `password`, `password_hash` et sans mot de passe. diff --git a/docs/fr/docs/tutorial/first-steps.md b/docs/fr/docs/tutorial/first-steps.md index b2693b3e5a..ae23584688 100644 --- a/docs/fr/docs/tutorial/first-steps.md +++ b/docs/fr/docs/tutorial/first-steps.md @@ -1,8 +1,8 @@ -# Démarrage { #first-steps } +# Démarrer { #first-steps } Le fichier **FastAPI** le plus simple possible pourrait ressembler à ceci : -{* ../../docs_src/first_steps/tutorial001_py39.py *} +{* ../../docs_src/first_steps/tutorial001_py310.py *} Copiez cela dans un fichier `main.py`. @@ -56,7 +56,7 @@ INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) Cette ligne montre l’URL où votre application est servie, sur votre machine locale. -### Vérifiez { #check-it } +### Vérifier { #check-it } Ouvrez votre navigateur à l’adresse http://127.0.0.1:8000. @@ -183,7 +183,7 @@ C’est tout ! Vous pouvez maintenant accéder à votre application à cette URL ### Étape 1 : importer `FastAPI` { #step-1-import-fastapi } -{* ../../docs_src/first_steps/tutorial001_py39.py hl[1] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[1] *} `FastAPI` est une classe Python qui fournit toutes les fonctionnalités nécessaires à votre API. @@ -197,7 +197,7 @@ Vous pouvez donc aussi utiliser toutes les fonctionnalités de get opération +* en utilisant une get opération -/// info | `@décorateur` Info +/// info | `@decorator` Info Cette syntaxe `@something` en Python est appelée un « décorateur ». @@ -320,7 +320,7 @@ Voici notre « fonction de chemin d’accès » : * **opération** : `get`. * **fonction** : la fonction sous le « décorateur » (sous `@app.get("/")`). -{* ../../docs_src/first_steps/tutorial001_py39.py hl[7] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[7] *} C’est une fonction Python. @@ -332,9 +332,9 @@ Dans ce cas, c’est une fonction `async`. Vous pouvez aussi la définir comme une fonction normale au lieu de `async def` : -{* ../../docs_src/first_steps/tutorial003_py39.py hl[7] *} +{* ../../docs_src/first_steps/tutorial003_py310.py hl[7] *} -/// note +/// note | Remarque Si vous ne connaissez pas la différence, consultez [Asynchrone : « Pressé ? »](../async.md#in-a-hurry){.internal-link target=_blank}. @@ -342,7 +342,7 @@ Si vous ne connaissez pas la différence, consultez [Asynchrone : « Pressé ? ### Étape 5 : retourner le contenu { #step-5-return-the-content } -{* ../../docs_src/first_steps/tutorial001_py39.py hl[8] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[8] *} Vous pouvez retourner un `dict`, une `list`, des valeurs uniques comme `str`, `int`, etc. diff --git a/docs/fr/docs/tutorial/handling-errors.md b/docs/fr/docs/tutorial/handling-errors.md new file mode 100644 index 0000000000..38935c21cc --- /dev/null +++ b/docs/fr/docs/tutorial/handling-errors.md @@ -0,0 +1,244 @@ +# Gérer les erreurs { #handling-errors } + +Il existe de nombreuses situations où vous devez signaler une erreur à un client qui utilise votre API. + +Ce client peut être un navigateur avec un frontend, un code d'un tiers, un appareil IoT, etc. + +Vous pourriez avoir besoin d'indiquer au client que : + +* Le client n'a pas les privilèges suffisants pour cette opération. +* Le client n'a pas accès à cette ressource. +* L'élément auquel le client tentait d'accéder n'existe pas. +* etc. + +Dans ces cas, vous retournez normalement un **code d'état HTTP** dans la plage de **400** (de 400 à 499). + +C'est similaire aux codes d'état HTTP 200 (de 200 à 299). Ces codes « 200 » signifient que, d'une certaine manière, la requête a été un « succès ». + +Les codes d'état dans la plage des 400 signifient qu'il y a eu une erreur côté client. + +Vous souvenez-vous de toutes ces erreurs **« 404 Not Found »** (et des blagues) ? + +## Utiliser `HTTPException` { #use-httpexception } + +Pour renvoyer au client des réponses HTTP avec des erreurs, vous utilisez `HTTPException`. + +### Importer `HTTPException` { #import-httpexception } + +{* ../../docs_src/handling_errors/tutorial001_py310.py hl[1] *} + +### Lever une `HTTPException` dans votre code { #raise-an-httpexception-in-your-code } + +`HTTPException` est une exception Python normale avec des données supplémentaires pertinentes pour les API. + +Comme il s'agit d'une exception Python, vous ne la `return` pas, vous la `raise`. + +Cela signifie aussi que si vous êtes dans une fonction utilitaire appelée depuis votre fonction de chemin d'accès, et que vous levez la `HTTPException` à l'intérieur de cette fonction utilitaire, le reste du code de la fonction de chemin d'accès ne s'exécutera pas : la requête sera immédiatement interrompue et l'erreur HTTP issue de la `HTTPException` sera envoyée au client. + +L'avantage de lever une exception plutôt que de retourner une valeur apparaîtra plus clairement dans la section sur les Dépendances et la Sécurité. + +Dans cet exemple, lorsque le client demande un élément par un ID qui n'existe pas, levez une exception avec un code d'état `404` : + +{* ../../docs_src/handling_errors/tutorial001_py310.py hl[11] *} + +### Réponse résultante { #the-resulting-response } + +Si le client demande `http://example.com/items/foo` (un `item_id` « foo »), il recevra un code d'état HTTP 200 et une réponse JSON : + +```JSON +{ + "item": "The Foo Wrestlers" +} +``` + +Mais si le client demande `http://example.com/items/bar` (un `item_id` inexistant « bar »), il recevra un code d'état HTTP 404 (l'erreur « not found ») et une réponse JSON : + +```JSON +{ + "detail": "Item not found" +} +``` + +/// tip | Astuce + +Lorsque vous levez une `HTTPException`, vous pouvez passer n'importe quelle valeur convertible en JSON comme paramètre `detail`, pas uniquement un `str`. + +Vous pouvez passer un `dict`, une `list`, etc. + +Elles sont gérées automatiquement par **FastAPI** et converties en JSON. + +/// + +## Ajouter des en-têtes personnalisés { #add-custom-headers } + +Dans certaines situations, il est utile de pouvoir ajouter des en-têtes personnalisés à l'erreur HTTP. Par exemple, pour certains types de sécurité. + +Vous n'aurez probablement pas besoin de l'utiliser directement dans votre code. + +Mais si vous en aviez besoin pour un scénario avancé, vous pouvez ajouter des en-têtes personnalisés : + +{* ../../docs_src/handling_errors/tutorial002_py310.py hl[14] *} + +## Installer des gestionnaires d'exception personnalisés { #install-custom-exception-handlers } + +Vous pouvez ajouter des gestionnaires d'exception personnalisés avec les mêmes utilitaires d'exception de Starlette. + +Supposons que vous ayez une exception personnalisée `UnicornException` que vous (ou une bibliothèque que vous utilisez) pourriez `raise`. + +Et vous souhaitez gérer cette exception globalement avec FastAPI. + +Vous pouvez ajouter un gestionnaire d'exception personnalisé avec `@app.exception_handler()` : + +{* ../../docs_src/handling_errors/tutorial003_py310.py hl[5:7,13:18,24] *} + +Ici, si vous appelez `/unicorns/yolo`, le chemin d'accès va `raise` une `UnicornException`. + +Mais elle sera gérée par `unicorn_exception_handler`. + +Ainsi, vous recevrez une erreur propre, avec un code d'état HTTP `418` et un contenu JSON : + +```JSON +{"message": "Oops! yolo did something. There goes a rainbow..."} +``` + +/// note | Détails techniques + +Vous pourriez aussi utiliser `from starlette.requests import Request` et `from starlette.responses import JSONResponse`. + +**FastAPI** fournit les mêmes `starlette.responses` sous `fastapi.responses` par simple commodité pour vous, développeur. Mais la plupart des réponses disponibles proviennent directement de Starlette. Il en va de même pour `Request`. + +/// + +## Remplacer les gestionnaires d'exception par défaut { #override-the-default-exception-handlers } + +**FastAPI** fournit des gestionnaires d'exception par défaut. + +Ces gestionnaires se chargent de renvoyer les réponses JSON par défaut lorsque vous `raise` une `HTTPException` et lorsque la requête contient des données invalides. + +Vous pouvez remplacer ces gestionnaires d'exception par les vôtres. + +### Remplacer les exceptions de validation de la requête { #override-request-validation-exceptions } + +Lorsqu'une requête contient des données invalides, **FastAPI** lève en interne une `RequestValidationError`. + +Et il inclut également un gestionnaire d'exception par défaut pour cela. + +Pour la remplacer, importez `RequestValidationError` et utilisez-la avec `@app.exception_handler(RequestValidationError)` pour décorer le gestionnaire d'exception. + +Le gestionnaire d'exception recevra une `Request` et l'exception. + +{* ../../docs_src/handling_errors/tutorial004_py310.py hl[2,14:19] *} + +À présent, si vous allez sur `/items/foo`, au lieu d'obtenir l'erreur JSON par défaut suivante : + +```JSON +{ + "detail": [ + { + "loc": [ + "path", + "item_id" + ], + "msg": "value is not a valid integer", + "type": "type_error.integer" + } + ] +} +``` + +vous obtiendrez une version texte, avec : + +``` +Validation errors: +Field: ('path', 'item_id'), Error: Input should be a valid integer, unable to parse string as an integer +``` + +### Remplacer le gestionnaire d'erreurs `HTTPException` { #override-the-httpexception-error-handler } + +De la même manière, vous pouvez remplacer le gestionnaire de `HTTPException`. + +Par exemple, vous pourriez vouloir renvoyer une réponse en texte brut au lieu de JSON pour ces erreurs : + +{* ../../docs_src/handling_errors/tutorial004_py310.py hl[3:4,9:11,25] *} + +/// note | Détails techniques + +Vous pourriez aussi utiliser `from starlette.responses import PlainTextResponse`. + +**FastAPI** fournit les mêmes `starlette.responses` sous `fastapi.responses` par simple commodité pour vous, le développeur. Mais la plupart des réponses disponibles proviennent directement de Starlette. + +/// + +/// warning | Alertes + +Gardez à l'esprit que la `RequestValidationError` contient l'information du nom de fichier et de la ligne où l'erreur de validation se produit, afin que vous puissiez l'afficher dans vos journaux avec les informations pertinentes si vous le souhaitez. + +Mais cela signifie que si vous vous contentez de la convertir en chaîne et de renvoyer cette information directement, vous pourriez divulguer un peu d'information sur votre système. C'est pourquoi, ici, le code extrait et affiche chaque erreur indépendamment. + +/// + +### Utiliser le corps de `RequestValidationError` { #use-the-requestvalidationerror-body } + +La `RequestValidationError` contient le `body` qu'elle a reçu avec des données invalides. + +Vous pouvez l'utiliser pendant le développement de votre application pour journaliser le corps et le déboguer, le renvoyer à l'utilisateur, etc. + +{* ../../docs_src/handling_errors/tutorial005_py310.py hl[14] *} + +Essayez maintenant d'envoyer un élément invalide comme : + +```JSON +{ + "title": "towel", + "size": "XL" +} +``` + +Vous recevrez une réponse vous indiquant que les données sont invalides et contenant le corps reçu : + +```JSON hl_lines="12-15" +{ + "detail": [ + { + "loc": [ + "body", + "size" + ], + "msg": "value is not a valid integer", + "type": "type_error.integer" + } + ], + "body": { + "title": "towel", + "size": "XL" + } +} +``` + +#### `HTTPException` de FastAPI vs `HTTPException` de Starlette { #fastapis-httpexception-vs-starlettes-httpexception } + +**FastAPI** a sa propre `HTTPException`. + +Et la classe d'erreur `HTTPException` de **FastAPI** hérite de la classe d'erreur `HTTPException` de Starlette. + +La seule différence est que la `HTTPException` de **FastAPI** accepte toute donnée sérialisable en JSON pour le champ `detail`, tandis que la `HTTPException` de Starlette n'accepte que des chaînes. + +Ainsi, vous pouvez continuer à lever la `HTTPException` de **FastAPI** normalement dans votre code. + +Mais lorsque vous enregistrez un gestionnaire d'exception, vous devez l'enregistrer pour la `HTTPException` de Starlette. + +De cette façon, si une partie du code interne de Starlette, ou une extension ou un plug-in Starlette, lève une `HTTPException` de Starlette, votre gestionnaire pourra l'intercepter et la traiter. + +Dans cet exemple, afin de pouvoir avoir les deux `HTTPException` dans le même code, les exceptions de Starlette sont renommées en `StarletteHTTPException` : + +```Python +from starlette.exceptions import HTTPException as StarletteHTTPException +``` + +### Réutiliser les gestionnaires d'exception de **FastAPI** { #reuse-fastapis-exception-handlers } + +Si vous souhaitez utiliser l'exception avec les mêmes gestionnaires d'exception par défaut de **FastAPI**, vous pouvez importer et réutiliser les gestionnaires d'exception par défaut depuis `fastapi.exception_handlers` : + +{* ../../docs_src/handling_errors/tutorial006_py310.py hl[2:5,15,21] *} + +Dans cet exemple, vous vous contentez d'afficher l'erreur avec un message très expressif, mais vous voyez l'idée. Vous pouvez utiliser l'exception puis simplement réutiliser les gestionnaires d'exception par défaut. diff --git a/docs/fr/docs/tutorial/header-param-models.md b/docs/fr/docs/tutorial/header-param-models.md new file mode 100644 index 0000000000..8fc1a3d366 --- /dev/null +++ b/docs/fr/docs/tutorial/header-param-models.md @@ -0,0 +1,72 @@ +# Modèles de paramètres d'en-tête { #header-parameter-models } + +Si vous avez un groupe de **paramètres d'en-tête** liés, vous pouvez créer un **modèle Pydantic** pour les déclarer. + +Cela vous permet de **réutiliser le modèle** à **plusieurs endroits** et aussi de déclarer des validations et des métadonnées pour tous les paramètres en une seule fois. 😎 + +/// note | Remarque + +Cela est pris en charge depuis la version `0.115.0` de FastAPI. 🤓 + +/// + +## Paramètres d'en-tête avec un modèle Pydantic { #header-parameters-with-a-pydantic-model } + +Déclarez les **paramètres d'en-tête** dont vous avez besoin dans un **modèle Pydantic**, puis déclarez le paramètre comme `Header` : + +{* ../../docs_src/header_param_models/tutorial001_an_py310.py hl[9:14,18] *} + +**FastAPI** extrait les données de **chaque champ** depuis les **en-têtes** de la requête et vous fournit le modèle Pydantic que vous avez défini. + +## Consulter la documentation { #check-the-docs } + +Vous pouvez voir les en-têtes requis dans l'interface de la documentation à `/docs` : + +
+ +
+ +## Interdire les en-têtes supplémentaires { #forbid-extra-headers } + +Dans certains cas d'utilisation particuliers (probablement pas très courants), vous pourriez vouloir **restreindre** les en-têtes que vous souhaitez recevoir. + +Vous pouvez utiliser la configuration du modèle de Pydantic pour `forbid` tout champ `extra` : + +{* ../../docs_src/header_param_models/tutorial002_an_py310.py hl[10] *} + +Si un client essaie d'envoyer des **en-têtes supplémentaires**, il recevra une **réponse d'erreur**. + +Par exemple, si le client essaie d'envoyer un en-tête `tool` avec la valeur `plumbus`, il recevra une **réponse d'erreur** lui indiquant que le paramètre d'en-tête `tool` n'est pas autorisé : + +```json +{ + "detail": [ + { + "type": "extra_forbidden", + "loc": ["header", "tool"], + "msg": "Extra inputs are not permitted", + "input": "plumbus", + } + ] +} +``` + +## Désactiver convert_underscores { #disable-convert-underscores } + +Comme pour les paramètres d'en-tête classiques, lorsque vous avez des caractères de soulignement dans les noms de paramètres, ils sont **automatiquement convertis en tirets**. + +Par exemple, si vous avez un paramètre d'en-tête `save_data` dans le code, l'en-tête HTTP attendu sera `save-data`, et il apparaîtra ainsi dans la documentation. + +Si, pour une raison quelconque, vous devez désactiver cette conversion automatique, vous pouvez aussi le faire pour les modèles Pydantic de paramètres d'en-tête. + +{* ../../docs_src/header_param_models/tutorial003_an_py310.py hl[19] *} + +/// warning | Alertes + +Avant de définir `convert_underscores` à `False`, gardez à l'esprit que certains proxys et serveurs HTTP interdisent l'utilisation d'en-têtes contenant des underscores. + +/// + +## Résumé { #summary } + +Vous pouvez utiliser des **modèles Pydantic** pour déclarer des **en-têtes** dans **FastAPI**. 😎 diff --git a/docs/fr/docs/tutorial/header-params.md b/docs/fr/docs/tutorial/header-params.md new file mode 100644 index 0000000000..608559c858 --- /dev/null +++ b/docs/fr/docs/tutorial/header-params.md @@ -0,0 +1,91 @@ +# Paramètres d'en-tête { #header-parameters } + +Vous pouvez définir des paramètres `Header` de la même manière que vous définissez des paramètres `Query`, `Path` et `Cookie`. + +## Importer `Header` { #import-header } + +Commencez par importer `Header` : + +{* ../../docs_src/header_params/tutorial001_an_py310.py hl[3] *} + +## Déclarer des paramètres `Header` { #declare-header-parameters } + +Déclarez ensuite les paramètres d'en-tête en utilisant la même structure qu'avec `Path`, `Query` et `Cookie`. + +Vous pouvez définir la valeur par défaut ainsi que tous les paramètres supplémentaires de validation ou d'annotation : + +{* ../../docs_src/header_params/tutorial001_an_py310.py hl[9] *} + +/// note | Détails techniques + +`Header` est une classe « sœur » de `Path`, `Query` et `Cookie`. Elle hérite également de la même classe commune `Param`. + +Mais rappelez-vous que lorsque vous importez `Query`, `Path`, `Header` et d'autres depuis `fastapi`, ce sont en réalité des fonctions qui renvoient des classes spéciales. + +/// + +/// info + +Pour déclarer des en-têtes, vous devez utiliser `Header`, sinon les paramètres seraient interprétés comme des paramètres de requête. + +/// + +## Conversion automatique { #automatic-conversion } + +`Header` offre un peu de fonctionnalité supplémentaire par rapport à `Path`, `Query` et `Cookie`. + +La plupart des en-têtes standards sont séparés par un caractère « trait d'union », également appelé « signe moins » (`-`). + +Mais une variable comme `user-agent` est invalide en Python. + +Ainsi, par défaut, `Header` convertit les caractères des noms de paramètres du tiret bas (`_`) en trait d'union (`-`) pour extraire et documenter les en-têtes. + +De plus, les en-têtes HTTP ne sont pas sensibles à la casse, vous pouvez donc les déclarer avec le style Python standard (aussi appelé « snake_case »). + +Vous pouvez donc utiliser `user_agent` comme vous le feriez normalement dans du code Python, au lieu d'avoir à mettre des majuscules aux premières lettres comme `User_Agent` ou quelque chose de similaire. + +Si, pour une raison quelconque, vous devez désactiver la conversion automatique des traits bas en traits d'union, définissez le paramètre `convert_underscores` de `Header` sur `False` : + +{* ../../docs_src/header_params/tutorial002_an_py310.py hl[10] *} + +/// warning | Alertes + +Avant de définir `convert_underscores` sur `False`, gardez à l'esprit que certains proxies et serveurs HTTP interdisent l'utilisation d'en-têtes contenant des traits bas. + +/// + +## Gérer les en-têtes dupliqués { #duplicate-headers } + +Il est possible de recevoir des en-têtes en double. Autrement dit, le même en-tête avec plusieurs valeurs. + +Vous pouvez définir ces cas à l'aide d'une liste dans la déclaration de type. + +Vous recevrez toutes les valeurs de l'en-tête dupliqué sous forme de `list` Python. + +Par exemple, pour déclarer un en-tête `X-Token` qui peut apparaître plusieurs fois, vous pouvez écrire : + +{* ../../docs_src/header_params/tutorial003_an_py310.py hl[9] *} + +Si vous communiquez avec ce *chemin d'accès* en envoyant deux en-têtes HTTP comme : + +``` +X-Token: foo +X-Token: bar +``` + +La réponse ressemblerait à ceci : + +```JSON +{ + "X-Token values": [ + "bar", + "foo" + ] +} +``` + +## Récapitulatif { #recap } + +Déclarez les en-têtes avec `Header`, en suivant le même modèle que pour `Query`, `Path` et `Cookie`. + +Et ne vous souciez pas des traits bas dans vos variables, **FastAPI** s'occupe de les convertir. diff --git a/docs/fr/docs/tutorial/metadata.md b/docs/fr/docs/tutorial/metadata.md new file mode 100644 index 0000000000..3ea3865bab --- /dev/null +++ b/docs/fr/docs/tutorial/metadata.md @@ -0,0 +1,120 @@ +# Métadonnées et URL des documents { #metadata-and-docs-urls } + +Vous pouvez personnaliser plusieurs configurations de métadonnées dans votre application **FastAPI**. + +## Métadonnées pour l'API { #metadata-for-api } + +Vous pouvez définir les champs suivants qui sont utilisés dans la spécification OpenAPI et les interfaces utilisateur de documentation automatique de l’API : + +| Paramètre | Type | Description | +|------------|------|-------------| +| `title` | `str` | Le titre de l’API. | +| `summary` | `str` | Un court résumé de l’API. Disponible depuis OpenAPI 3.1.0, FastAPI 0.99.0. | +| `description` | `str` | Une brève description de l’API. Elle peut utiliser Markdown. | +| `version` | `string` | La version de l’API. C’est la version de votre propre application, pas d’OpenAPI. Par exemple `2.5.0`. | +| `terms_of_service` | `str` | Une URL vers les Conditions d’utilisation de l’API. Le cas échéant, il doit s’agir d’une URL. | +| `contact` | `dict` | Les informations de contact pour l’API exposée. Cela peut contenir plusieurs champs.
champs de contact
ParamètreTypeDescription
namestrLe nom identifiant de la personne/organisation de contact.
urlstrL’URL pointant vers les informations de contact. DOIT être au format d’une URL.
emailstrL’adresse e-mail de la personne/organisation de contact. DOIT être au format d’une adresse e-mail.
| +| `license_info` | `dict` | Les informations de licence pour l’API exposée. Cela peut contenir plusieurs champs.
champs de license_info
ParamètreTypeDescription
namestrOBLIGATOIRE (si un license_info est défini). Le nom de la licence utilisée pour l’API.
identifierstrUne expression de licence SPDX pour l’API. Le champ identifier est mutuellement exclusif du champ url. Disponible depuis OpenAPI 3.1.0, FastAPI 0.99.0.
urlstrUne URL vers la licence utilisée pour l’API. DOIT être au format d’une URL.
| + +Vous pouvez les définir comme suit : + +{* ../../docs_src/metadata/tutorial001_py310.py hl[3:16, 19:32] *} + +/// tip | Astuce + +Vous pouvez écrire du Markdown dans le champ `description` et il sera rendu dans la sortie. + +/// + +Avec cette configuration, les documents API automatiques ressembleraient à : + + + +## Identifiant de licence { #license-identifier } + +Depuis OpenAPI 3.1.0 et FastAPI 0.99.0, vous pouvez également définir `license_info` avec un `identifier` au lieu d’une `url`. + +Par exemple : + +{* ../../docs_src/metadata/tutorial001_1_py310.py hl[31] *} + +## Métadonnées pour les tags { #metadata-for-tags } + +Vous pouvez également ajouter des métadonnées supplémentaires pour les différents tags utilisés pour regrouper vos chemins d'accès avec le paramètre `openapi_tags`. + +Il prend une liste contenant un dictionnaire pour chaque tag. + +Chaque dictionnaire peut contenir : + +* `name` (**requis**) : un `str` avec le même nom de tag que vous utilisez dans le paramètre `tags` de vos *chemins d'accès* et `APIRouter`s. +* `description` : un `str` avec une courte description pour le tag. Il peut contenir du Markdown et sera affiché dans l’interface utilisateur de la documentation. +* `externalDocs` : un `dict` décrivant une documentation externe avec : + * `description` : un `str` avec une courte description pour la documentation externe. + * `url` (**requis**) : un `str` avec l’URL de la documentation externe. + +### Créer des métadonnées pour les tags { #create-metadata-for-tags } + +Essayons cela avec un exemple de tags pour `users` et `items`. + +Créez des métadonnées pour vos tags et transmettez-les au paramètre `openapi_tags` : + +{* ../../docs_src/metadata/tutorial004_py310.py hl[3:16,18] *} + +Notez que vous pouvez utiliser Markdown à l’intérieur des descriptions, par exemple « login » sera affiché en gras (**login**) et « fancy » sera affiché en italique (_fancy_). + +/// tip | Astuce + +Vous n’avez pas à ajouter des métadonnées pour tous les tags que vous utilisez. + +/// + +### Utiliser vos tags { #use-your-tags } + +Utilisez le paramètre `tags` avec vos *chemins d'accès* (et `APIRouter`s) pour les affecter à différents tags : + +{* ../../docs_src/metadata/tutorial004_py310.py hl[21,26] *} + +/// info + +En savoir plus sur les tags dans [Configuration de chemins d'accès](path-operation-configuration.md#tags){.internal-link target=_blank}. + +/// + +### Consultez les documents { #check-the-docs } + +Désormais, si vous consultez les documents, ils afficheront toutes les métadonnées supplémentaires : + + + +### Définir l’ordre des tags { #order-of-tags } + +L’ordre de chaque dictionnaire de métadonnées de tag définit également l’ordre affiché dans l’interface utilisateur de la documentation. + +Par exemple, même si `users` viendrait après `items` par ordre alphabétique, il est affiché avant, car nous avons ajouté ses métadonnées comme premier dictionnaire de la liste. + +## URL OpenAPI { #openapi-url } + +Par défaut, le schéma OpenAPI est servi à `/openapi.json`. + +Mais vous pouvez le configurer avec le paramètre `openapi_url`. + +Par exemple, pour qu’il soit servi à `/api/v1/openapi.json` : + +{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *} + +Si vous souhaitez désactiver complètement le schéma OpenAPI, vous pouvez définir `openapi_url=None`, cela désactivera également les interfaces utilisateur de la documentation qui l’utilisent. + +## URL des documents { #docs-urls } + +Vous pouvez configurer les deux interfaces utilisateur de documentation incluses : + +* **Swagger UI** : servie à `/docs`. + * Vous pouvez définir son URL avec le paramètre `docs_url`. + * Vous pouvez la désactiver en définissant `docs_url=None`. +* **ReDoc** : servie à `/redoc`. + * Vous pouvez définir son URL avec le paramètre `redoc_url`. + * Vous pouvez la désactiver en définissant `redoc_url=None`. + +Par exemple, pour que Swagger UI soit servi à `/documentation` et désactiver ReDoc : + +{* ../../docs_src/metadata/tutorial003_py310.py hl[3] *} diff --git a/docs/fr/docs/tutorial/middleware.md b/docs/fr/docs/tutorial/middleware.md new file mode 100644 index 0000000000..6cbbc3e456 --- /dev/null +++ b/docs/fr/docs/tutorial/middleware.md @@ -0,0 +1,95 @@ +# Middleware { #middleware } + +Vous pouvez ajouter des middlewares aux applications **FastAPI**. + +Un « middleware » est une fonction qui agit sur chaque **requête** avant qu’elle ne soit traitée par un *chemin d'accès* spécifique. Et aussi sur chaque **réponse** avant son renvoi. + +* Il intercepte chaque **requête** qui parvient à votre application. +* Il peut alors faire quelque chose avec cette **requête** ou exécuter tout code nécessaire. +* Ensuite, il transmet la **requête** pour qu’elle soit traitée par le reste de l’application (par un *chemin d'accès*). +* Puis il récupère la **réponse** générée par l’application (par un *chemin d'accès*). +* Il peut faire quelque chose avec cette **réponse** ou exécuter tout code nécessaire. +* Enfin, il renvoie la **réponse**. + +/// note | Détails techniques + +Si vous avez des dépendances avec `yield`, le code de sortie s’exécutera après le middleware. + +S’il y avait des tâches d’arrière-plan (présentées dans la section [Tâches d’arrière-plan](background-tasks.md){.internal-link target=_blank}, que vous verrez plus tard), elles s’exécuteront après tous les middlewares. + +/// + +## Créer un middleware { #create-a-middleware } + +Pour créer un middleware, utilisez le décorateur `@app.middleware("http")` au-dessus d’une fonction. + +La fonction de middleware reçoit : + +* La `request`. +* Une fonction `call_next` qui recevra la `request` en paramètre. + * Cette fonction transmettra la `request` au *chemin d'accès* correspondant. + * Puis elle renverra la `response` générée par le *chemin d'accès* correspondant. +* Vous pouvez ensuite modifier la `response` avant de la renvoyer. + +{* ../../docs_src/middleware/tutorial001_py310.py hl[8:9,11,14] *} + +/// tip | Astuce + +Gardez à l’esprit que des en-têtes propriétaires personnalisés peuvent être ajoutés en utilisant le préfixe `X-`. + +Mais si vous avez des en-têtes personnalisés que vous voulez rendre visibles pour un client dans un navigateur, vous devez les ajouter à votre configuration CORS ([CORS (Partage des ressources entre origines)](cors.md){.internal-link target=_blank}) en utilisant le paramètre `expose_headers` documenté dans la documentation CORS de Starlette. + +/// + +/// note | Détails techniques + +Vous pourriez aussi utiliser `from starlette.requests import Request`. + +**FastAPI** le fournit pour votre confort de développeur. Mais cela provient directement de Starlette. + +/// + +### Avant et après la `response` { #before-and-after-the-response } + +Vous pouvez ajouter du code à exécuter avec la `request`, avant que tout *chemin d'accès* ne la reçoive. + +Et aussi après que la `response` a été générée, avant de la renvoyer. + +Par exemple, vous pourriez ajouter un en-tête personnalisé `X-Process-Time` contenant le temps en secondes nécessaire pour traiter la requête et générer une réponse : + +{* ../../docs_src/middleware/tutorial001_py310.py hl[10,12:13] *} + +/// tip | Astuce + +Ici, nous utilisons `time.perf_counter()` au lieu de `time.time()` car cela peut être plus précis pour ces cas d’usage. 🤓 + +/// + +## Ordre d’exécution de plusieurs middlewares { #multiple-middleware-execution-order } + +Quand vous ajoutez plusieurs middlewares en utilisant soit le décorateur `@app.middleware()`, soit la méthode `app.add_middleware()`, chaque nouveau middleware enveloppe l’application, formant une pile. Le dernier middleware ajouté est le plus externe, et le premier est le plus interne. + +Sur le chemin de la requête, le plus externe s’exécute en premier. + +Sur le chemin de la réponse, il s’exécute en dernier. + +Par exemple : + +```Python +app.add_middleware(MiddlewareA) +app.add_middleware(MiddlewareB) +``` + +Cela aboutit à l’ordre d’exécution suivant : + +* **Requête** : MiddlewareB → MiddlewareA → route + +* **Réponse** : route → MiddlewareA → MiddlewareB + +Ce comportement d’empilement garantit que les middlewares s’exécutent dans un ordre prévisible et contrôlable. + +## Autres middlewares { #other-middlewares } + +Vous pouvez en lire davantage sur d’autres middlewares dans le [Guide de l’utilisateur avancé : Middleware avancé](../advanced/middleware.md){.internal-link target=_blank}. + +Vous verrez comment gérer CORS avec un middleware dans la section suivante. diff --git a/docs/fr/docs/tutorial/path-operation-configuration.md b/docs/fr/docs/tutorial/path-operation-configuration.md new file mode 100644 index 0000000000..f8041fa691 --- /dev/null +++ b/docs/fr/docs/tutorial/path-operation-configuration.md @@ -0,0 +1,107 @@ +# Configurer les chemins d'accès { #path-operation-configuration } + +Vous pouvez passer plusieurs paramètres à votre *décorateur de chemin d'accès* pour le configurer. + +/// warning | Alertes + +Notez que ces paramètres sont passés directement au *décorateur de chemin d'accès*, et non à votre *fonction de chemin d'accès*. + +/// + +## Définir le code d'état de la réponse { #response-status-code } + +Vous pouvez définir le `status_code` (HTTP) à utiliser dans la réponse de votre *chemin d'accès*. + +Vous pouvez passer directement le code `int`, comme `404`. + +Mais si vous ne vous souvenez pas à quoi correspond chaque code numérique, vous pouvez utiliser les constantes abrégées dans `status` : + +{* ../../docs_src/path_operation_configuration/tutorial001_py310.py hl[1,15] *} + +Ce code d'état sera utilisé dans la réponse et ajouté au schéma OpenAPI. + +/// note | Détails techniques + +Vous pouvez également utiliser `from starlette import status`. + +**FastAPI** fournit le même `starlette.status` sous le nom `fastapi.status` pour votre commodité, en tant que développeur. Mais cela provient directement de Starlette. + +/// + +## Ajouter des tags { #tags } + +Vous pouvez ajouter des tags à votre *chemin d'accès*, en passant le paramètre `tags` avec une `list` de `str` (généralement un seul `str`) : + +{* ../../docs_src/path_operation_configuration/tutorial002_py310.py hl[15,20,25] *} + +Ils seront ajoutés au schéma OpenAPI et utilisés par les interfaces de documentation automatiques : + + + +### Utiliser des tags avec Enum { #tags-with-enums } + +Si vous avez une grande application, vous pourriez finir par accumuler **plusieurs tags**, et vous voudrez vous assurer d'utiliser toujours le **même tag** pour les *chemins d'accès* associés. + +Dans ces cas, il peut être judicieux de stocker les tags dans un `Enum`. + +**FastAPI** le prend en charge de la même manière qu'avec des chaînes simples : + +{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *} + +## Ajouter un résumé et une description { #summary-and-description } + +Vous pouvez ajouter un `summary` et une `description` : + +{* ../../docs_src/path_operation_configuration/tutorial003_py310.py hl[17:18] *} + +## Utiliser la description depuis la docstring { #description-from-docstring } + +Comme les descriptions ont tendance à être longues et à couvrir plusieurs lignes, vous pouvez déclarer la description du *chemin d'accès* dans la docstring de la fonction et **FastAPI** la lira à partir de là. + +Vous pouvez écrire Markdown dans la docstring, il sera interprété et affiché correctement (en tenant compte de l'indentation de la docstring). + +{* ../../docs_src/path_operation_configuration/tutorial004_py310.py hl[17:25] *} + +Elle sera utilisée dans les documents interactifs : + + + +## Définir la description de la réponse { #response-description } + +Vous pouvez spécifier la description de la réponse avec le paramètre `response_description` : + +{* ../../docs_src/path_operation_configuration/tutorial005_py310.py hl[18] *} + +/// info + +Notez que `response_description` se réfère spécifiquement à la réponse, tandis que `description` se réfère au *chemin d'accès* en général. + +/// + +/// check | Vérifications + +OpenAPI spécifie que chaque *chemin d'accès* requiert une description de réponse. + +Donc, si vous n'en fournissez pas, **FastAPI** en générera automatiquement une « Réponse réussie ». + +/// + + + +## Déprécier un *chemin d'accès* { #deprecate-a-path-operation } + +Si vous devez marquer un *chemin d'accès* comme déprécié, sans pour autant le supprimer, passez le paramètre `deprecated` : + +{* ../../docs_src/path_operation_configuration/tutorial006_py310.py hl[16] *} + +Il sera clairement marqué comme déprécié dans les documents interactifs : + + + +Voyez à quoi ressemblent les *chemins d'accès* dépréciés et non dépréciés : + + + +## Récapitulatif { #recap } + +Vous pouvez facilement configurer et ajouter des métadonnées à vos *chemins d'accès* en passant des paramètres aux *décorateurs de chemin d'accès*. diff --git a/docs/fr/docs/tutorial/path-params-numeric-validations.md b/docs/fr/docs/tutorial/path-params-numeric-validations.md index c80710777f..2dbaaa8cae 100644 --- a/docs/fr/docs/tutorial/path-params-numeric-validations.md +++ b/docs/fr/docs/tutorial/path-params-numeric-validations.md @@ -54,11 +54,11 @@ Cela n'a pas d'importance pour **FastAPI**. Il détectera les paramètres par le Ainsi, vous pouvez déclarer votre fonction comme suit : -{* ../../docs_src/path_params_numeric_validations/tutorial002_py39.py hl[7] *} +{* ../../docs_src/path_params_numeric_validations/tutorial002_py310.py hl[7] *} Mais gardez à l'esprit que si vous utilisez `Annotated`, vous n'aurez pas ce problème, cela n'aura pas d'importance car vous n'utilisez pas les valeurs par défaut des paramètres de fonction pour `Query()` ou `Path()`. -{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py39.py *} +{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py310.py *} ## Ordonner les paramètres comme vous le souhaitez, astuces { #order-the-parameters-as-you-need-tricks } @@ -81,15 +81,15 @@ Si vous voulez : Passez `*`, comme premier paramètre de la fonction. -Python ne fera rien avec ce `*`, mais il saura que tous les paramètres suivants doivent être appelés comme arguments "mots-clés" (paires clé-valeur), également connus sous le nom de kwargs. Même s'ils n'ont pas de valeur par défaut. +Python ne fera rien avec ce `*`, mais il saura que tous les paramètres suivants doivent être appelés comme arguments « mots-clés » (paires clé-valeur), également connus sous le nom de kwargs. Même s'ils n'ont pas de valeur par défaut. -{* ../../docs_src/path_params_numeric_validations/tutorial003_py39.py hl[7] *} +{* ../../docs_src/path_params_numeric_validations/tutorial003_py310.py hl[7] *} ### Mieux avec `Annotated` { #better-with-annotated } Gardez à l'esprit que si vous utilisez `Annotated`, comme vous n'utilisez pas les valeurs par défaut des paramètres de fonction, vous n'aurez pas ce problème, et vous n'aurez probablement pas besoin d'utiliser `*`. -{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py310.py hl[10] *} ## Validations numériques : supérieur ou égal { #number-validations-greater-than-or-equal } @@ -97,7 +97,7 @@ Avec `Query` et `Path` (et d'autres que vous verrez plus tard) vous pouvez décl Ici, avec `ge=1`, `item_id` devra être un nombre entier « `g`reater than or `e`qual » à `1`. -{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py310.py hl[10] *} ## Validations numériques : supérieur et inférieur ou égal { #number-validations-greater-than-and-less-than-or-equal } @@ -106,7 +106,7 @@ La même chose s'applique pour : * `gt` : `g`reater `t`han * `le` : `l`ess than or `e`qual -{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py310.py hl[10] *} ## Validations numériques : flottants, supérieur et inférieur { #number-validations-floats-greater-than-and-less-than } @@ -118,7 +118,7 @@ Ainsi, `0.5` serait une valeur valide. Mais `0.0` ou `0` ne le serait pas. Et la même chose pour lt. -{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py39.py hl[13] *} +{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py310.py hl[13] *} ## Pour résumer { #recap } diff --git a/docs/fr/docs/tutorial/path-params.md b/docs/fr/docs/tutorial/path-params.md index 3b2955a95d..985eff6354 100644 --- a/docs/fr/docs/tutorial/path-params.md +++ b/docs/fr/docs/tutorial/path-params.md @@ -2,7 +2,7 @@ Vous pouvez déclarer des « paramètres » ou « variables » de chemin avec la même syntaxe utilisée par les chaînes de format Python : -{* ../../docs_src/path_params/tutorial001_py39.py hl[6:7] *} +{* ../../docs_src/path_params/tutorial001_py310.py hl[6:7] *} La valeur du paramètre de chemin `item_id` sera transmise à votre fonction dans l'argument `item_id`. @@ -16,7 +16,7 @@ Donc, si vous exécutez cet exemple et allez sur Conversion de données { #data-conversion } +## Conversion de données { #data-conversion } Si vous exécutez cet exemple et ouvrez votre navigateur sur http://127.0.0.1:8000/items/3, vous verrez comme réponse : @@ -38,7 +38,7 @@ Si vous exécutez cet exemple et ouvrez votre navigateur sur « parsing » de la requête. +Ainsi, avec cette déclaration de type, **FastAPI** vous fournit automatiquement le « parsing » de la requête. /// @@ -118,19 +118,19 @@ Et vous pouvez aussi avoir un chemin `/users/{user_id}` pour récupérer des don Comme les *chemins d'accès* sont évalués dans l'ordre, vous devez vous assurer que le chemin `/users/me` est déclaré avant celui de `/users/{user_id}` : -{* ../../docs_src/path_params/tutorial003_py39.py hl[6,11] *} +{* ../../docs_src/path_params/tutorial003_py310.py hl[6,11] *} Sinon, le chemin `/users/{user_id}` correspondrait aussi à `/users/me`, « pensant » qu'il reçoit un paramètre `user_id` avec la valeur « me ». De même, vous ne pouvez pas redéfinir un chemin d'accès : -{* ../../docs_src/path_params/tutorial003b_py39.py hl[6,11] *} +{* ../../docs_src/path_params/tutorial003b_py310.py hl[6,11] *} Le premier sera toujours utilisé puisque le chemin correspond en premier. ## Valeurs prédéfinies { #predefined-values } -Si vous avez un *chemin d'accès* qui reçoit un *paramètre de chemin*, mais que vous voulez que les valeurs possibles de ce *paramètre de chemin* soient prédéfinies, vous pouvez utiliser une `Enum` Python standard. +Si vous avez un *chemin d'accès* qui reçoit un *paramètre de chemin*, mais que vous voulez que les valeurs possibles de ce *paramètre de chemin* soient prédéfinies, vous pouvez utiliser une `Enum` Python standard. ### Créer une classe `Enum` { #create-an-enum-class } @@ -140,11 +140,11 @@ En héritant de `str`, la documentation de l'API saura que les valeurs doivent Créez ensuite des attributs de classe avec des valeurs fixes, qui seront les valeurs valides disponibles : -{* ../../docs_src/path_params/tutorial005_py39.py hl[1,6:9] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[1,6:9] *} /// tip | Astuce -Si vous vous demandez, « AlexNet », « ResNet » et « LeNet » sont juste des noms de modèles de Machine Learning. +Si vous vous demandez, « AlexNet », « ResNet » et « LeNet » sont juste des noms de modèles de Machine Learning. /// @@ -152,7 +152,7 @@ Si vous vous demandez, « AlexNet », « ResNet » et « LeNet » sont juste des Créez ensuite un *paramètre de chemin* avec une annotation de type utilisant la classe d'énumération que vous avez créée (`ModelName`) : -{* ../../docs_src/path_params/tutorial005_py39.py hl[16] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[16] *} ### Consulter la documentation { #check-the-docs } @@ -168,13 +168,13 @@ La valeur du *paramètre de chemin* sera un *membre d'énumération*. Vous pouvez le comparer avec le *membre d'énumération* dans votre enum `ModelName` : -{* ../../docs_src/path_params/tutorial005_py39.py hl[17] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[17] *} #### Obtenir la *valeur de l'énumération* { #get-the-enumeration-value } Vous pouvez obtenir la valeur réelle (une `str` dans ce cas) avec `model_name.value`, ou en général, `votre_membre_d_enum.value` : -{* ../../docs_src/path_params/tutorial005_py39.py hl[20] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[20] *} /// tip | Astuce @@ -188,7 +188,7 @@ Vous pouvez retourner des *membres d'énumération* depuis votre *chemin d'accè Ils seront convertis vers leurs valeurs correspondantes (des chaînes de caractères ici) avant d'être renvoyés au client : -{* ../../docs_src/path_params/tutorial005_py39.py hl[18,21,23] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[18,21,23] *} Dans votre client, vous recevrez une réponse JSON comme : @@ -227,7 +227,7 @@ Dans ce cas, le nom du paramètre est `file_path`, et la dernière partie, `:pat Vous pouvez donc l'utiliser ainsi : -{* ../../docs_src/path_params/tutorial004_py39.py hl[6] *} +{* ../../docs_src/path_params/tutorial004_py310.py hl[6] *} /// tip | Astuce @@ -242,7 +242,7 @@ Dans ce cas, l'URL serait : `/files//home/johndoe/myfile.txt`, avec un double sl Avec **FastAPI**, en utilisant des déclarations de type Python courtes, intuitives et standard, vous obtenez : * Support de l'éditeur : vérifications d'erreurs, autocomplétion, etc. -* Données « parsing » +* Données « parsing » * Validation de données * Annotations d'API et documentation automatique diff --git a/docs/fr/docs/tutorial/query-param-models.md b/docs/fr/docs/tutorial/query-param-models.md new file mode 100644 index 0000000000..b9bb1d1378 --- /dev/null +++ b/docs/fr/docs/tutorial/query-param-models.md @@ -0,0 +1,68 @@ +# Modèles de paramètres de requête { #query-parameter-models } + +Si vous avez un groupe de paramètres de requête liés, vous pouvez créer un modèle Pydantic pour les déclarer. + +Cela vous permet de réutiliser le modèle à plusieurs endroits et aussi de déclarer des validations et des métadonnées pour tous les paramètres en une seule fois. 😎 + +/// note | Remarque + +Pris en charge depuis FastAPI version `0.115.0`. 🤓 + +/// + +## Déclarer des paramètres de requête avec un modèle Pydantic { #query-parameters-with-a-pydantic-model } + +Déclarez les paramètres de requête dont vous avez besoin dans un modèle Pydantic, puis déclarez le paramètre en tant que `Query` : + +{* ../../docs_src/query_param_models/tutorial001_an_py310.py hl[9:13,17] *} + +FastAPI extrait les données pour chaque champ à partir des paramètres de requête de la requête et vous fournit le modèle Pydantic que vous avez défini. + +## Consulter les documents { #check-the-docs } + +Vous pouvez voir les paramètres de requête dans l'interface des documents à `/docs` : + +
+ +
+ +## Interdire des paramètres de requête supplémentaires { #forbid-extra-query-parameters } + +Dans certains cas d'utilisation particuliers (probablement peu courants), vous pouvez vouloir restreindre les paramètres de requête que vous souhaitez recevoir. + +Vous pouvez utiliser la configuration du modèle Pydantic pour `forbid` tout champ `extra` : + +{* ../../docs_src/query_param_models/tutorial002_an_py310.py hl[10] *} + +Si un client tente d'envoyer des données supplémentaires dans les paramètres de requête, il recevra une réponse d'erreur. + +Par exemple, si le client tente d'envoyer un paramètre de requête `tool` avec la valeur `plumbus`, comme : + +```http +https://example.com/items/?limit=10&tool=plumbus +``` + +Il recevra une réponse d'erreur lui indiquant que le paramètre de requête `tool` n'est pas autorisé : + +```json +{ + "detail": [ + { + "type": "extra_forbidden", + "loc": ["query", "tool"], + "msg": "Extra inputs are not permitted", + "input": "plumbus" + } + ] +} +``` + +## Résumé { #summary } + +Vous pouvez utiliser des modèles Pydantic pour déclarer des paramètres de requête dans FastAPI. 😎 + +/// tip | Astuce + +Alerte spoiler : vous pouvez aussi utiliser des modèles Pydantic pour déclarer des cookies et des en-têtes, mais vous lirez cela plus tard dans le tutoriel. 🤫 + +/// diff --git a/docs/fr/docs/tutorial/query-params-str-validations.md b/docs/fr/docs/tutorial/query-params-str-validations.md index 544d10328e..17b751f239 100644 --- a/docs/fr/docs/tutorial/query-params-str-validations.md +++ b/docs/fr/docs/tutorial/query-params-str-validations.md @@ -47,40 +47,16 @@ C’est le moment de l’utiliser avec FastAPI. 🚀 Nous avions cette annotation de type : -//// tab | Python 3.10+ - ```Python q: str | None = None ``` -//// - -//// tab | Python 3.9+ - -```Python -q: Union[str, None] = None -``` - -//// - Ce que nous allons faire, c’est l’englober avec `Annotated`, de sorte que cela devienne : -//// tab | Python 3.10+ - ```Python q: Annotated[str | None] = None ``` -//// - -//// tab | Python 3.9+ - -```Python -q: Annotated[Union[str, None]] = None -``` - -//// - Les deux versions signifient la même chose, `q` est un paramètre qui peut être une `str` ou `None`, et par défaut, c’est `None`. Passons maintenant aux choses amusantes. 🎉 @@ -109,7 +85,7 @@ FastAPI va maintenant : ## Alternative (ancienne) : `Query` comme valeur par défaut { #alternative-old-query-as-the-default-value } -Les versions précédentes de FastAPI (avant 0.95.0) exigeaient d’utiliser `Query` comme valeur par défaut de votre paramètre, au lieu de le mettre dans `Annotated`. Il y a de fortes chances que vous voyiez du code qui l’utilise encore, je vais donc vous l’expliquer. +Les versions précédentes de FastAPI (avant 0.95.0) exigeaient d’utiliser `Query` comme valeur par défaut de votre paramètre, au lieu de le mettre dans `Annotated`. Il y a de fortes chances que vous voyiez du code qui l’utilise encore, je vais donc vous l’expliquer. /// tip | Astuce @@ -191,7 +167,7 @@ Vous pouvez également ajouter un paramètre `min_length` : ## Ajouter des expressions régulières { #add-regular-expressions } -Vous pouvez définir un `pattern` d’expression régulière auquel le paramètre doit correspondre : +Vous pouvez définir un `pattern` d’expression régulière auquel le paramètre doit correspondre : {* ../../docs_src/query_params_str_validations/tutorial004_an_py310.py hl[11] *} @@ -211,7 +187,7 @@ Vous pouvez, bien sûr, utiliser des valeurs par défaut autres que `None`. Disons que vous voulez déclarer le paramètre de requête `q` avec un `min_length` de `3`, et avec une valeur par défaut de « fixedquery » : -{* ../../docs_src/query_params_str_validations/tutorial005_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial005_an_py310.py hl[9] *} /// note | Remarque @@ -241,7 +217,7 @@ q: Annotated[str | None, Query(min_length=3)] = None Donc, lorsque vous avez besoin de déclarer une valeur comme requise tout en utilisant `Query`, vous pouvez simplement ne pas déclarer de valeur par défaut : -{* ../../docs_src/query_params_str_validations/tutorial006_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial006_an_py310.py hl[9] *} ### Requis, peut valoir `None` { #required-can-be-none } @@ -292,7 +268,7 @@ L’interface de documentation interactive de l’API sera mise à jour en cons Vous pouvez également définir une `list` de valeurs par défaut si aucune n’est fournie : -{* ../../docs_src/query_params_str_validations/tutorial012_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial012_an_py310.py hl[9] *} Si vous allez à : @@ -315,7 +291,7 @@ la valeur par défaut de `q` sera : `["foo", "bar"]` et votre réponse sera : Vous pouvez aussi utiliser `list` directement au lieu de `list[str]` : -{* ../../docs_src/query_params_str_validations/tutorial013_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial013_an_py310.py hl[9] *} /// note | Remarque @@ -371,7 +347,7 @@ Vous pouvez alors déclarer un `alias`, et cet alias sera utilisé pour trouver Disons que vous n’aimez plus ce paramètre. -Vous devez le laisser là quelque temps car des clients l’utilisent, mais vous voulez que les documents l’affichent clairement comme déprécié. +Vous devez le laisser là quelque temps car des clients l’utilisent, mais vous voulez que les documents l’affichent clairement comme déprécié. Passez alors le paramètre `deprecated=True` à `Query` : @@ -401,7 +377,7 @@ Pydantic a aussi
ISBN ou par `imdb-` pour un ID d’URL de film IMDB : +Par exemple, ce validateur personnalisé vérifie que l’ID d’item commence par `isbn-` pour un numéro de livre ISBN ou par `imdb-` pour un ID d’URL de film IMDB : {* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py hl[5,16:19,24] *} @@ -435,7 +411,7 @@ Avez-vous remarqué ? Une chaîne utilisant `value.startswith()` peut prendre un #### Un élément aléatoire { #a-random-item } -Avec `data.items()` nous obtenons un objet itérable avec des tuples contenant la clé et la valeur pour chaque élément du dictionnaire. +Avec `data.items()` nous obtenons un objet itérable avec des tuples contenant la clé et la valeur pour chaque élément du dictionnaire. Nous convertissons cet objet itérable en une `list` propre avec `list(data.items())`. diff --git a/docs/fr/docs/tutorial/query-params.md b/docs/fr/docs/tutorial/query-params.md index 1a4880ced3..01540ad17c 100644 --- a/docs/fr/docs/tutorial/query-params.md +++ b/docs/fr/docs/tutorial/query-params.md @@ -2,7 +2,7 @@ Quand vous déclarez d'autres paramètres de fonction qui ne font pas partie des paramètres de chemin, ils sont automatiquement interprétés comme des paramètres de « query ». -{* ../../docs_src/query_params/tutorial001_py39.py hl[9] *} +{* ../../docs_src/query_params/tutorial001_py310.py hl[9] *} La query est l'ensemble des paires clé-valeur placées après le `?` dans une URL, séparées par des caractères `&`. @@ -24,7 +24,7 @@ Mais lorsque vous les déclarez avec des types Python (dans l'exemple ci-dessus, Tous les mêmes processus qui s'appliquaient aux paramètres de chemin s'appliquent aussi aux paramètres de requête : * Prise en charge de l'éditeur (évidemment) -* « parsing » des données +* « parsing » des données * Validation des données * Documentation automatique @@ -67,7 +67,7 @@ Dans ce cas, le paramètre de fonction `q` sera optionnel et vaudra `None` par d /// check | Vérifications -Notez également que FastAPI est suffisamment intelligent pour remarquer que le paramètre de chemin `item_id` est un paramètre de chemin et que `q` ne l'est pas, c'est donc un paramètre de requête. +Notez également que **FastAPI** est suffisamment intelligent pour remarquer que le paramètre de chemin `item_id` est un paramètre de chemin et que `q` ne l'est pas, c'est donc un paramètre de requête. /// @@ -127,7 +127,7 @@ Si vous ne voulez pas leur donner de valeur spécifique mais simplement les rend Mais si vous voulez rendre un paramètre de requête obligatoire, vous pouvez simplement ne déclarer aucune valeur par défaut : -{* ../../docs_src/query_params/tutorial005_py39.py hl[6:7] *} +{* ../../docs_src/query_params/tutorial005_py310.py hl[6:7] *} Ici, le paramètre de requête `needy` est un paramètre de requête requis de type `str`. diff --git a/docs/fr/docs/tutorial/request-files.md b/docs/fr/docs/tutorial/request-files.md new file mode 100644 index 0000000000..01a0b72eb9 --- /dev/null +++ b/docs/fr/docs/tutorial/request-files.md @@ -0,0 +1,176 @@ +# Envoyer des fichiers { #request-files } + +Vous pouvez définir des fichiers à téléverser par le client en utilisant `File`. + +/// info + +Pour recevoir des fichiers téléversés, installez d'abord `python-multipart`. + +Assurez-vous de créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, de l'activer, puis d'installer le paquet, par exemple : + +```console +$ pip install python-multipart +``` + +C'est parce que les fichiers téléversés sont envoyés en « données de formulaire ». + +/// + +## Importer `File` { #import-file } + +Importez `File` et `UploadFile` depuis `fastapi` : + +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[3] *} + +## Définir des paramètres `File` { #define-file-parameters } + +Créez des paramètres de fichier de la même manière que pour `Body` ou `Form` : + +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[9] *} + +/// info + +`File` est une classe qui hérite directement de `Form`. + +Mais souvenez-vous que lorsque vous importez `Query`, `Path`, `File` et d'autres depuis `fastapi`, ce sont en réalité des fonctions qui renvoient des classes spéciales. + +/// + +/// tip | Astuce + +Pour déclarer des fichiers dans le corps de la requête, vous devez utiliser `File`, sinon les paramètres seraient interprétés comme des paramètres de requête ou des paramètres de corps (JSON). + +/// + +Les fichiers seront téléversés en « données de formulaire ». + +Si vous déclarez le type de votre paramètre de *fonction de chemin d'accès* comme `bytes`, **FastAPI** lira le fichier pour vous et vous recevrez le contenu sous forme de `bytes`. + +Gardez à l'esprit que cela signifie que tout le contenu sera stocké en mémoire. Cela fonctionnera bien pour de petits fichiers. + +Mais dans plusieurs cas, vous pourriez bénéficier de l'utilisation d'`UploadFile`. + +## Paramètres de fichier avec `UploadFile` { #file-parameters-with-uploadfile } + +Définissez un paramètre de fichier de type `UploadFile` : + +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[14] *} + +Utiliser `UploadFile` présente plusieurs avantages par rapport à `bytes` : + +- Vous n'avez pas besoin d'utiliser `File()` comme valeur par défaut du paramètre. +- Il utilise un fichier « spooled » : + - Un fichier stocké en mémoire jusqu'à une taille maximale, puis, au-delà de cette limite, stocké sur le disque. +- Cela fonctionne donc bien pour des fichiers volumineux comme des images, des vidéos, de gros binaires, etc., sans consommer toute la mémoire. +- Vous pouvez obtenir des métadonnées à partir du fichier téléversé. +- Il offre une interface `async` de type file-like. +- Il expose un véritable objet Python `SpooledTemporaryFile` que vous pouvez passer directement à d'autres bibliothèques qui attendent un objet « file-like ». + +### `UploadFile` { #uploadfile } + +`UploadFile` a les attributs suivants : + +- `filename` : une `str` contenant le nom de fichier original téléversé (par ex. `myimage.jpg`). +- `content_type` : une `str` avec le type de contenu (type MIME / type média) (par ex. `image/jpeg`). +- `file` : un `SpooledTemporaryFile` (un objet de type fichier). C'est l'objet fichier Python réel que vous pouvez passer directement à d'autres fonctions ou bibliothèques qui attendent un objet « file-like ». + +`UploadFile` a les méthodes `async` suivantes. Elles appellent toutes les méthodes correspondantes du fichier sous-jacent (en utilisant le `SpooledTemporaryFile` interne). + +- `write(data)` : écrit `data` (`str` ou `bytes`) dans le fichier. +- `read(size)` : lit `size` (`int`) octets/caractères du fichier. +- `seek(offset)` : se déplace à la position d'octet `offset` (`int`) dans le fichier. + - Par ex., `await myfile.seek(0)` irait au début du fichier. + - C'est particulièrement utile si vous exécutez `await myfile.read()` une fois puis devez relire le contenu. +- `close()` : ferme le fichier. + +Comme toutes ces méthodes sont `async`, vous devez les « await ». + +Par exemple, à l'intérieur d'une *fonction de chemin d'accès* `async`, vous pouvez obtenir le contenu avec : + +```Python +contents = await myfile.read() +``` + +Si vous êtes dans une *fonction de chemin d'accès* `def` normale, vous pouvez accéder directement à `UploadFile.file`, par exemple : + +```Python +contents = myfile.file.read() +``` + +/// note | Détails techniques `async` + +Lorsque vous utilisez les méthodes `async`, **FastAPI** exécute les méthodes de fichier dans un pool de threads et les attend. + +/// + +/// note | Détails techniques Starlette + +L'`UploadFile` de **FastAPI** hérite directement de l'`UploadFile` de **Starlette**, mais ajoute certaines parties nécessaires pour le rendre compatible avec **Pydantic** et les autres parties de FastAPI. + +/// + +## Qu'est-ce que les « données de formulaire » { #what-is-form-data } + +La façon dont les formulaires HTML (`
`) envoient les données au serveur utilise normalement un encodage « spécial » pour ces données, différent de JSON. + +**FastAPI** s'assure de lire ces données au bon endroit plutôt que depuis JSON. + +/// note | Détails techniques + +Les données des formulaires sont normalement encodées avec le « type de média » `application/x-www-form-urlencoded` lorsqu'elles n'incluent pas de fichiers. + +Mais lorsque le formulaire inclut des fichiers, il est encodé en `multipart/form-data`. Si vous utilisez `File`, **FastAPI** saura qu'il doit récupérer les fichiers depuis la partie appropriée du corps. + +Si vous souhaitez en savoir plus sur ces encodages et les champs de formulaire, consultez la MDN Web Docs pour POST. + +/// + +/// warning | Alertes + +Vous pouvez déclarer plusieurs paramètres `File` et `Form` dans un *chemin d'accès*, mais vous ne pouvez pas également déclarer des champs `Body` que vous vous attendez à recevoir en JSON, car la requête aura le corps encodé en `multipart/form-data` au lieu de `application/json`. + +Ce n'est pas une limitation de **FastAPI**, cela fait partie du protocole HTTP. + +/// + +## Téléversement de fichier facultatif { #optional-file-upload } + +Vous pouvez rendre un fichier facultatif en utilisant des annotations de type standard et en définissant une valeur par défaut à `None` : + +{* ../../docs_src/request_files/tutorial001_02_an_py310.py hl[9,17] *} + +## `UploadFile` avec des métadonnées supplémentaires { #uploadfile-with-additional-metadata } + +Vous pouvez aussi utiliser `File()` avec `UploadFile`, par exemple pour définir des métadonnées supplémentaires : + +{* ../../docs_src/request_files/tutorial001_03_an_py310.py hl[9,15] *} + +## Téléverser plusieurs fichiers { #multiple-file-uploads } + +Il est possible de téléverser plusieurs fichiers en même temps. + +Ils seraient associés au même « champ de formulaire » envoyé en « données de formulaire ». + +Pour cela, déclarez une `list` de `bytes` ou d'`UploadFile` : + +{* ../../docs_src/request_files/tutorial002_an_py310.py hl[10,15] *} + +Vous recevrez, comme déclaré, une `list` de `bytes` ou d'`UploadFile`. + +/// note | Détails techniques + +Vous pourriez aussi utiliser `from starlette.responses import HTMLResponse`. + +**FastAPI** fournit les mêmes `starlette.responses` sous `fastapi.responses` simplement pour votre convenance en tant que développeur. Mais la plupart des réponses disponibles proviennent directement de Starlette. + +/// + +### Téléversements multiples avec métadonnées supplémentaires { #multiple-file-uploads-with-additional-metadata } + +Et de la même manière que précédemment, vous pouvez utiliser `File()` pour définir des paramètres supplémentaires, même pour `UploadFile` : + +{* ../../docs_src/request_files/tutorial003_an_py310.py hl[11,18:20] *} + +## Récapitulatif { #recap } + +Utilisez `File`, `bytes` et `UploadFile` pour déclarer des fichiers à téléverser dans la requête, envoyés en « données de formulaire ». diff --git a/docs/fr/docs/tutorial/request-form-models.md b/docs/fr/docs/tutorial/request-form-models.md new file mode 100644 index 0000000000..3fbac9c74a --- /dev/null +++ b/docs/fr/docs/tutorial/request-form-models.md @@ -0,0 +1,78 @@ +# Modèles de formulaire { #form-models } + +Vous pouvez utiliser des **modèles Pydantic** pour déclarer des **champs de formulaire** dans FastAPI. + +/// info + +Pour utiliser les formulaires, installez d'abord `python-multipart`. + +Assurez-vous de créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, de l'activer, puis d'installer le paquet, par exemple : + +```console +$ pip install python-multipart +``` + +/// + +/// note | Remarque + +Ceci est pris en charge depuis la version `0.113.0` de FastAPI. 🤓 + +/// + +## Modèles Pydantic pour les formulaires { #pydantic-models-for-forms } + +Vous avez simplement besoin de déclarer un **modèle Pydantic** avec les champs que vous souhaitez recevoir comme **champs de formulaire**, puis de déclarer le paramètre comme `Form` : + +{* ../../docs_src/request_form_models/tutorial001_an_py310.py hl[9:11,15] *} + +**FastAPI** va **extraire** les données pour **chaque champ** à partir des **données de formulaire** de la requête et vous fournir le modèle Pydantic que vous avez défini. + +## Consulter les documents { #check-the-docs } + +Vous pouvez le vérifier dans l'interface des documents à `/docs` : + +
+ +
+ +## Interdire les champs de formulaire supplémentaires { #forbid-extra-form-fields } + +Dans certains cas d'utilisation particuliers (probablement peu courants), vous pourriez vouloir **restreindre** les champs de formulaire à ceux déclarés dans le modèle Pydantic, et **interdire** tout champ **supplémentaire**. + +/// note | Remarque + +Ceci est pris en charge depuis la version `0.114.0` de FastAPI. 🤓 + +/// + +Vous pouvez utiliser la configuration du modèle Pydantic pour `forbid` tout champ `extra` : + +{* ../../docs_src/request_form_models/tutorial002_an_py310.py hl[12] *} + +Si un client tente d'envoyer des données supplémentaires, il recevra une **réponse d'erreur**. + +Par exemple, si le client essaie d'envoyer les champs de formulaire : + +* `username`: `Rick` +* `password`: `Portal Gun` +* `extra`: `Mr. Poopybutthole` + +Il recevra une réponse d'erreur lui indiquant que le champ `extra` n'est pas autorisé : + +```json +{ + "detail": [ + { + "type": "extra_forbidden", + "loc": ["body", "extra"], + "msg": "Extra inputs are not permitted", + "input": "Mr. Poopybutthole" + } + ] +} +``` + +## Résumer { #summary } + +Vous pouvez utiliser des modèles Pydantic pour déclarer des champs de formulaire dans FastAPI. 😎 diff --git a/docs/fr/docs/tutorial/request-forms-and-files.md b/docs/fr/docs/tutorial/request-forms-and-files.md new file mode 100644 index 0000000000..6774eec8e4 --- /dev/null +++ b/docs/fr/docs/tutorial/request-forms-and-files.md @@ -0,0 +1,41 @@ +# Utiliser des formulaires et des fichiers de requête { #request-forms-and-files } + +Vous pouvez définir des fichiers et des champs de formulaire en même temps à l'aide de `File` et `Form`. + +/// info + +Pour recevoir des fichiers téléversés et/ou des données de formulaire, installez d'abord `python-multipart`. + +Vous devez créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, l'activer, puis installer ce paquet, par exemple : + +```console +$ pip install python-multipart +``` + +/// + +## Importer `File` et `Form` { #import-file-and-form } + +{* ../../docs_src/request_forms_and_files/tutorial001_an_py310.py hl[3] *} + +## Définir des paramètres `File` et `Form` { #define-file-and-form-parameters } + +Créez des paramètres de fichier et de formulaire de la même manière que pour `Body` ou `Query` : + +{* ../../docs_src/request_forms_and_files/tutorial001_an_py310.py hl[10:12] *} + +Les fichiers et les champs de formulaire seront téléversés en tant que données de formulaire et vous les recevrez. + +Et vous pouvez déclarer certains fichiers comme `bytes` et d'autres comme `UploadFile`. + +/// warning | Alertes + +Vous pouvez déclarer plusieurs paramètres `File` et `Form` dans un *chemin d'accès*, mais vous ne pouvez pas aussi déclarer des champs `Body` que vous vous attendez à recevoir en JSON, car la requête aura le corps encodé en `multipart/form-data` au lieu de `application/json`. + +Ce n'est pas une limitation de **FastAPI**, cela fait partie du protocole HTTP. + +/// + +## Récapitulatif { #recap } + +Utilisez `File` et `Form` ensemble lorsque vous devez recevoir des données et des fichiers dans la même requête. diff --git a/docs/fr/docs/tutorial/request-forms.md b/docs/fr/docs/tutorial/request-forms.md new file mode 100644 index 0000000000..cea47c93e6 --- /dev/null +++ b/docs/fr/docs/tutorial/request-forms.md @@ -0,0 +1,73 @@ +# Données de formulaire { #form-data } + +Lorsque vous devez recevoir des champs de formulaire au lieu de JSON, vous pouvez utiliser `Form`. + +/// info + +Pour utiliser les formulaires, installez d'abord `python-multipart`. + +Assurez-vous de créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, de l'activer, puis d'installer ce paquet, par exemple : + +```console +$ pip install python-multipart +``` + +/// + +## Importer `Form` { #import-form } + +Importez `Form` depuis `fastapi` : + +{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[3] *} + +## Définir les paramètres `Form` { #define-form-parameters } + +Créez des paramètres de formulaire comme vous le feriez pour `Body` ou `Query` : + +{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[9] *} + +Par exemple, dans l'une des manières dont la spécification OAuth2 peut être utilisée (appelée « password flow »), il est requis d'envoyer un `username` et un `password` comme champs de formulaire. + +La spécification exige que les champs soient exactement nommés `username` et `password`, et qu'ils soient envoyés en tant que champs de formulaire, pas en JSON. + +Avec `Form`, vous pouvez déclarer les mêmes configurations que pour `Body` (ainsi que `Query`, `Path`, `Cookie`), y compris la validation, des exemples, un alias (p. ex. `user-name` au lieu de `username`), etc. + +/// info + +`Form` est une classe qui hérite directement de `Body`. + +/// + +/// tip | Astuce + +Pour déclarer des corps de formulaire, vous devez utiliser `Form` explicitement, car sinon les paramètres seraient interprétés comme des paramètres de requête ou des paramètres de corps (JSON). + +/// + +## À propos des « champs de formulaire » { #about-form-fields } + +La manière dont les formulaires HTML (`
`) envoient les données au serveur utilise normalement un encodage « spécial » pour ces données, différent de JSON. + +**FastAPI** s'assure de lire ces données au bon endroit au lieu de JSON. + +/// note | Détails techniques + +Les données issues des formulaires sont normalement encodées avec le « type de média » `application/x-www-form-urlencoded`. + +Mais lorsque le formulaire inclut des fichiers, il est encodé en `multipart/form-data`. Vous lirez la gestion des fichiers dans le chapitre suivant. + +Si vous voulez en savoir plus sur ces encodages et les champs de formulaire, consultez la MDN web docs pour POST. + +/// + +/// warning | Alertes + +Vous pouvez déclarer plusieurs paramètres `Form` dans un chemin d'accès, mais vous ne pouvez pas aussi déclarer des champs `Body` que vous vous attendez à recevoir en JSON, car la requête aura le corps encodé en `application/x-www-form-urlencoded` au lieu de `application/json`. + +Ce n'est pas une limitation de **FastAPI**, cela fait partie du protocole HTTP. + +/// + +## Récapitulatif { #recap } + +Utilisez `Form` pour déclarer les paramètres d'entrée des données de formulaire. diff --git a/docs/fr/docs/tutorial/response-model.md b/docs/fr/docs/tutorial/response-model.md new file mode 100644 index 0000000000..337b1aa485 --- /dev/null +++ b/docs/fr/docs/tutorial/response-model.md @@ -0,0 +1,343 @@ +# Modèle de réponse - Type de retour { #response-model-return-type } + +Vous pouvez déclarer le type utilisé pour la réponse en annotant le **type de retour** de la *fonction de chemin d'accès*. + +Vous pouvez utiliser des **annotations de type** de la même manière que pour les données d'entrée dans les **paramètres** de fonction. Vous pouvez utiliser des modèles Pydantic, des listes, des dictionnaires, des valeurs scalaires comme des entiers, des booléens, etc. + +{* ../../docs_src/response_model/tutorial001_01_py310.py hl[16,21] *} + +FastAPI utilisera ce type de retour pour : + +* **Valider** les données renvoyées. + * Si les données sont invalides (par exemple, il manque un champ), cela signifie que le code de *votre* application est défectueux, qu'il ne renvoie pas ce qu'il devrait, et un erreur serveur sera renvoyée au lieu de renvoyer des données incorrectes. De cette façon, vous et vos clients pouvez être certains de recevoir les données attendues et avec la structure attendue. +* Ajouter un **JSON Schema** pour la réponse, dans l’OpenAPI du *chemin d'accès*. + * Ceci sera utilisé par la **documentation automatique**. + * Ceci sera également utilisé par les outils de génération automatique de code client. + +Mais surtout : + +* Il **limitera et filtrera** les données de sortie à ce qui est défini dans le type de retour. + * C'est particulièrement important pour la **sécurité**, nous verrons cela plus bas. + +## Paramètre `response_model` { #response-model-parameter } + +Il existe des cas où vous devez ou souhaitez renvoyer des données qui ne correspondent pas exactement à ce que déclare le type. + +Par exemple, vous pourriez vouloir **renvoyer un dictionnaire** ou un objet de base de données, mais **le déclarer comme un modèle Pydantic**. Ainsi, le modèle Pydantic ferait toute la documentation des données, la validation, etc. pour l'objet que vous avez renvoyé (par exemple un dictionnaire ou un objet de base de données). + +Si vous ajoutez l'annotation du type de retour, les outils et éditeurs se plaindront avec une (juste) erreur vous indiquant que votre fonction renvoie un type (par exemple un dict) différent de ce que vous avez déclaré (par exemple un modèle Pydantic). + +Dans ces cas, vous pouvez utiliser le paramètre `response_model` du *décorateur de chemin d'accès* au lieu du type de retour. + +Vous pouvez utiliser le paramètre `response_model` dans n'importe lequel des *chemins d'accès* : + +* `@app.get()` +* `@app.post()` +* `@app.put()` +* `@app.delete()` +* etc. + +{* ../../docs_src/response_model/tutorial001_py310.py hl[17,22,24:27] *} + +/// note | Remarque + +Notez que `response_model` est un paramètre de la méthode « decorator » (`get`, `post`, etc.). Pas de votre *fonction de chemin d'accès*, comme tous les paramètres et le corps. + +/// + +`response_model` reçoit le même type que vous déclareriez pour un champ de modèle Pydantic, il peut donc s'agir d'un modèle Pydantic, mais il peut aussi être, par exemple, une `list` de modèles Pydantic, comme `List[Item]`. + +FastAPI utilisera ce `response_model` pour toute la documentation des données, la validation, etc. et aussi pour **convertir et filtrer les données de sortie** selon sa déclaration de type. + +/// tip | Astuce + +Si vous avez des vérifications de type strictes dans votre éditeur, mypy, etc., vous pouvez déclarer le type de retour de la fonction en `Any`. + +Ainsi, vous indiquez à l'éditeur que vous renvoyez intentionnellement n'importe quoi. Mais FastAPI effectuera quand même la documentation, la validation, le filtrage, etc. des données avec `response_model`. + +/// + +### Priorité de `response_model` { #response-model-priority } + +Si vous déclarez à la fois un type de retour et un `response_model`, c'est `response_model` qui aura la priorité et sera utilisé par FastAPI. + +De cette manière, vous pouvez ajouter des annotations de type correctes à vos fonctions même si vous renvoyez un type différent du modèle de réponse, pour qu'il soit utilisé par l'éditeur et des outils comme mypy. Et vous pouvez toujours laisser FastAPI faire la validation des données, la documentation, etc. avec `response_model`. + +Vous pouvez également utiliser `response_model=None` pour désactiver la création d’un modèle de réponse pour ce *chemin d'accès* ; vous pourriez en avoir besoin si vous ajoutez des annotations de type pour des choses qui ne sont pas des champs valides Pydantic, vous verrez un exemple de cela dans une des sections ci-dessous. + +## Renvoyer les mêmes données d'entrée { #return-the-same-input-data } + +Ici, nous déclarons un modèle `UserIn`, il contiendra un mot de passe en clair : + +{* ../../docs_src/response_model/tutorial002_py310.py hl[7,9] *} + +/// info | Info + +Pour utiliser `EmailStr`, installez d'abord `email-validator`. + +Assurez-vous de créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, de l'activer, puis de l'installer, par exemple : + +```console +$ pip install email-validator +``` + +ou avec : + +```console +$ pip install "pydantic[email]" +``` + +/// + +Et nous utilisons ce modèle pour déclarer notre entrée et le même modèle pour déclarer notre sortie : + +{* ../../docs_src/response_model/tutorial002_py310.py hl[16] *} + +Désormais, chaque fois qu'un navigateur crée un utilisateur avec un mot de passe, l'API renverra le même mot de passe dans la réponse. + +Dans ce cas, cela peut ne pas poser de problème, car c'est le même utilisateur qui envoie le mot de passe. + +Mais si nous utilisons le même modèle pour un autre *chemin d'accès*, nous pourrions envoyer les mots de passe de nos utilisateurs à tous les clients. + +/// danger | Danger + +Ne stockez jamais le mot de passe en clair d'un utilisateur et ne l'envoyez pas dans une réponse de cette manière, à moins de connaître tous les écueils et de savoir exactement ce que vous faites. + +/// + +## Ajouter un modèle de sortie { #add-an-output-model } + +Nous pouvons à la place créer un modèle d'entrée avec le mot de passe en clair et un modèle de sortie sans celui-ci : + +{* ../../docs_src/response_model/tutorial003_py310.py hl[9,11,16] *} + +Ici, même si notre *fonction de chemin d'accès* renvoie le même utilisateur d'entrée qui contient le mot de passe : + +{* ../../docs_src/response_model/tutorial003_py310.py hl[24] *} + +... nous avons déclaré `response_model` comme étant notre modèle `UserOut`, qui n'inclut pas le mot de passe : + +{* ../../docs_src/response_model/tutorial003_py310.py hl[22] *} + +Ainsi, **FastAPI** se chargera de filtrer toutes les données qui ne sont pas déclarées dans le modèle de sortie (en utilisant Pydantic). + +### `response_model` ou type de retour { #response-model-or-return-type } + +Dans ce cas, comme les deux modèles sont différents, si nous annotions le type de retour de la fonction en `UserOut`, l’éditeur et les outils se plaindraient que nous renvoyons un type invalide, car ce sont des classes différentes. + +C'est pourquoi, dans cet exemple, nous devons le déclarer dans le paramètre `response_model`. + +... mais continuez à lire ci-dessous pour voir comment contourner cela. + +## Type de retour et filtrage des données { #return-type-and-data-filtering } + +Continuons l'exemple précédent. Nous voulions **annoter la fonction avec un type**, mais nous voulions pouvoir renvoyer depuis la fonction quelque chose qui inclut **plus de données**. + +Nous voulons que FastAPI continue de **filtrer** les données à l’aide du modèle de réponse. Ainsi, même si la fonction renvoie plus de données, la réponse n’inclura que les champs déclarés dans le modèle de réponse. + +Dans l'exemple précédent, comme les classes étaient différentes, nous avons dû utiliser le paramètre `response_model`. Mais cela signifie aussi que nous ne bénéficions pas de la prise en charge de l'éditeur et des outils pour la vérification du type de retour de la fonction. + +Mais dans la plupart des cas où nous avons besoin de quelque chose comme cela, nous voulons que le modèle **filtre/supprime** simplement une partie des données comme dans cet exemple. + +Et dans ces cas, nous pouvons utiliser des classes et l'héritage pour tirer parti des **annotations de type** de fonction afin d'obtenir une meilleure prise en charge dans l'éditeur et les outils, tout en bénéficiant du **filtrage de données** de FastAPI. + +{* ../../docs_src/response_model/tutorial003_01_py310.py hl[7:10,13:14,18] *} + +Avec cela, nous obtenons la prise en charge des outils, des éditeurs et de mypy car ce code est correct en termes de types, et nous bénéficions également du filtrage des données par FastAPI. + +Comment cela fonctionne-t-il ? Voyons cela. 🤓 + +### Annotations de type et outils { #type-annotations-and-tooling } + +Voyons d'abord comment les éditeurs, mypy et autres outils considèreraient cela. + +`BaseUser` a les champs de base. Puis `UserIn` hérite de `BaseUser` et ajoute le champ `password`, il inclura donc tous les champs des deux modèles. + +Nous annotons le type de retour de la fonction en `BaseUser`, mais nous renvoyons en réalité une instance de `UserIn`. + +L’éditeur, mypy et d'autres outils ne s’en plaindront pas car, en termes de typage, `UserIn` est une sous-classe de `BaseUser`, ce qui signifie que c’est un type *valide* lorsque ce qui est attendu est n'importe quoi de type `BaseUser`. + +### Filtrage des données par FastAPI { #fastapi-data-filtering } + +Maintenant, pour FastAPI, il verra le type de retour et s'assurera que ce que vous renvoyez inclut **uniquement** les champs qui sont déclarés dans le type. + +FastAPI fait plusieurs choses en interne avec Pydantic pour s'assurer que ces mêmes règles d'héritage de classes ne sont pas utilisées pour le filtrage des données renvoyées, sinon vous pourriez finir par renvoyer beaucoup plus de données que prévu. + +De cette façon, vous obtenez le meilleur des deux mondes : annotations de type avec **prise en charge par les outils** et **filtrage des données**. + +## Le voir dans la documentation { #see-it-in-the-docs } + +Dans la documentation automatique, vous pouvez vérifier que le modèle d'entrée et le modèle de sortie auront chacun leur propre JSON Schema : + + + +Et les deux modèles seront utilisés pour la documentation API interactive : + + + +## Autres annotations de type de retour { #other-return-type-annotations } + +Il peut y avoir des cas où vous renvoyez quelque chose qui n'est pas un champ Pydantic valide et vous l'annotez dans la fonction, uniquement pour obtenir la prise en charge fournie par les outils (l’éditeur, mypy, etc.). + +### Renvoyer directement une Response { #return-a-response-directly } + +Le cas le plus courant serait [de renvoyer directement une Response comme expliqué plus loin dans la documentation avancée](../advanced/response-directly.md){.internal-link target=_blank}. + +{* ../../docs_src/response_model/tutorial003_02_py310.py hl[8,10:11] *} + +Ce cas simple est géré automatiquement par FastAPI car l'annotation du type de retour est la classe (ou une sous-classe de) `Response`. + +Et les outils seront également satisfaits car `RedirectResponse` et `JSONResponse` sont des sous-classes de `Response`, donc l'annotation de type est correcte. + +### Annoter une sous-classe de Response { #annotate-a-response-subclass } + +Vous pouvez aussi utiliser une sous-classe de `Response` dans l'annotation de type : + +{* ../../docs_src/response_model/tutorial003_03_py310.py hl[8:9] *} + +Cela fonctionnera également car `RedirectResponse` est une sous-classe de `Response`, et FastAPI gérera automatiquement ce cas simple. + +### Annotations de type de retour invalides { #invalid-return-type-annotations } + +Mais lorsque vous renvoyez un autre objet arbitraire qui n'est pas un type Pydantic valide (par exemple un objet de base de données) et que vous l'annotez ainsi dans la fonction, FastAPI essaiera de créer un modèle de réponse Pydantic à partir de cette annotation de type, et échouera. + +Il en serait de même si vous aviez quelque chose comme une union entre différents types dont un ou plusieurs ne sont pas des types Pydantic valides, par exemple ceci échouerait 💥 : + +{* ../../docs_src/response_model/tutorial003_04_py310.py hl[8] *} + +... cela échoue parce que l'annotation de type n'est pas un type Pydantic et n'est pas juste une unique classe `Response` ou une sous-classe, c'est une union (l'un des deux) entre une `Response` et un `dict`. + +### Désactiver le modèle de réponse { #disable-response-model } + +En reprenant l'exemple ci-dessus, vous pourriez ne pas vouloir avoir la validation par défaut des données, la documentation, le filtrage, etc. effectués par FastAPI. + +Mais vous pourriez vouloir tout de même conserver l’annotation du type de retour dans la fonction pour bénéficier de la prise en charge des outils comme les éditeurs et les vérificateurs de type (par exemple mypy). + +Dans ce cas, vous pouvez désactiver la génération du modèle de réponse en définissant `response_model=None` : + +{* ../../docs_src/response_model/tutorial003_05_py310.py hl[7] *} + +Cela fera en sorte que FastAPI ignore la génération du modèle de réponse et vous permettra ainsi d’avoir toutes les annotations de type de retour dont vous avez besoin sans que cela n’affecte votre application FastAPI. 🤓 + +## Paramètres d'encodage du modèle de réponse { #response-model-encoding-parameters } + +Votre modèle de réponse peut avoir des valeurs par défaut, par exemple : + +{* ../../docs_src/response_model/tutorial004_py310.py hl[9,11:12] *} + +* `description: Union[str, None] = None` (ou `str | None = None` en Python 3.10) a une valeur par défaut `None`. +* `tax: float = 10.5` a une valeur par défaut `10.5`. +* `tags: List[str] = []` a une valeur par défaut de liste vide : `[]`. + +mais vous pourriez vouloir les omettre du résultat si elles n'ont pas été réellement stockées. + +Par exemple, si vous avez des modèles avec de nombreux attributs optionnels dans une base NoSQL, mais que vous ne voulez pas envoyer de très longues réponses JSON remplies de valeurs par défaut. + +### Utiliser le paramètre `response_model_exclude_unset` { #use-the-response-model-exclude-unset-parameter } + +Vous pouvez définir le paramètre du *décorateur de chemin d'accès* `response_model_exclude_unset=True` : + +{* ../../docs_src/response_model/tutorial004_py310.py hl[22] *} + +et ces valeurs par défaut ne seront pas incluses dans la réponse, uniquement les valeurs effectivement définies. + +Ainsi, si vous envoyez une requête à ce *chemin d'accès* pour l'article avec l'ID `foo`, la réponse (sans les valeurs par défaut) sera : + +```JSON +{ + "name": "Foo", + "price": 50.2 +} +``` + +/// info | Info + +Vous pouvez également utiliser : + +* `response_model_exclude_defaults=True` +* `response_model_exclude_none=True` + +comme décrit dans la documentation Pydantic pour `exclude_defaults` et `exclude_none`. + +/// + +#### Données avec des valeurs pour des champs avec des valeurs par défaut { #data-with-values-for-fields-with-defaults } + +Mais si vos données ont des valeurs pour les champs du modèle avec des valeurs par défaut, comme l'article avec l'ID `bar` : + +```Python hl_lines="3 5" +{ + "name": "Bar", + "description": "The bartenders", + "price": 62, + "tax": 20.2 +} +``` + +elles seront incluses dans la réponse. + +#### Données avec les mêmes valeurs que les valeurs par défaut { #data-with-the-same-values-as-the-defaults } + +Si les données ont les mêmes valeurs que les valeurs par défaut, comme l'article avec l'ID `baz` : + +```Python hl_lines="3 5-6" +{ + "name": "Baz", + "description": None, + "price": 50.2, + "tax": 10.5, + "tags": [] +} +``` + +FastAPI est suffisamment intelligent (en fait, Pydantic l’est) pour comprendre que, même si `description`, `tax` et `tags` ont les mêmes valeurs que les valeurs par défaut, elles ont été définies explicitement (au lieu d'être prises depuis les valeurs par défaut). + +Elles seront donc incluses dans la réponse JSON. + +/// tip | Astuce + +Notez que les valeurs par défaut peuvent être n'importe quoi, pas seulement `None`. + +Elles peuvent être une liste (`[]`), un `float` de `10.5`, etc. + +/// + +### `response_model_include` et `response_model_exclude` { #response-model-include-and-response-model-exclude } + +Vous pouvez également utiliser les paramètres du *décorateur de chemin d'accès* `response_model_include` et `response_model_exclude`. + +Ils prennent un `set` de `str` avec les noms des attributs à inclure (en omettant le reste) ou à exclure (en incluant le reste). + +Cela peut être utilisé comme un raccourci rapide si vous n'avez qu'un seul modèle Pydantic et que vous souhaitez supprimer certaines données de la sortie. + +/// tip | Astuce + +Mais il est toujours recommandé d'utiliser les idées ci-dessus, en utilisant plusieurs classes, plutôt que ces paramètres. + +En effet, le JSON Schema généré dans l’OpenAPI de votre application (et la documentation) restera celui du modèle complet, même si vous utilisez `response_model_include` ou `response_model_exclude` pour omettre certains attributs. + +Cela s'applique également à `response_model_by_alias` qui fonctionne de manière similaire. + +/// + +{* ../../docs_src/response_model/tutorial005_py310.py hl[29,35] *} + +/// tip | Astuce + +La syntaxe `{"name", "description"}` crée un `set` avec ces deux valeurs. + +Elle est équivalente à `set(["name", "description"])`. + +/// + +#### Utiliser des `list` au lieu de `set` { #using-lists-instead-of-sets } + +Si vous oubliez d'utiliser un `set` et utilisez une `list` ou un `tuple` à la place, FastAPI le convertira quand même en `set` et cela fonctionnera correctement : + +{* ../../docs_src/response_model/tutorial006_py310.py hl[29,35] *} + +## Récapitulatif { #recap } + +Utilisez le paramètre du *décorateur de chemin d'accès* `response_model` pour définir les modèles de réponse et surtout pour garantir que les données privées sont filtrées. + +Utilisez `response_model_exclude_unset` pour ne renvoyer que les valeurs définies explicitement. diff --git a/docs/fr/docs/tutorial/response-status-code.md b/docs/fr/docs/tutorial/response-status-code.md new file mode 100644 index 0000000000..388a53b3df --- /dev/null +++ b/docs/fr/docs/tutorial/response-status-code.md @@ -0,0 +1,101 @@ +# Code d'état de la réponse { #response-status-code } + +De la même manière que vous pouvez spécifier un modèle de réponse, vous pouvez également déclarer le code d'état HTTP utilisé pour la réponse avec le paramètre `status_code` dans n'importe lequel des chemins d'accès : + +* `@app.get()` +* `@app.post()` +* `@app.put()` +* `@app.delete()` +* etc. + +{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *} + +/// note | Remarque + +Remarquez que `status_code` est un paramètre de la méthode « decorator » (`get`, `post`, etc.). Pas de votre fonction de chemin d'accès, comme tous les paramètres et le corps. + +/// + +Le paramètre `status_code` reçoit un nombre correspondant au code d'état HTTP. + +/// info + +`status_code` peut aussi recevoir un `IntEnum`, comme le `http.HTTPStatus` de Python. + +/// + +Il va : + +* Renvoyer ce code d'état dans la réponse. +* Le documenter comme tel dans le schéma OpenAPI (et donc dans les interfaces utilisateur) : + + + +/// note | Remarque + +Certains codes de réponse (voir la section suivante) indiquent que la réponse n'a pas de corps. + +FastAPI le sait et produira une documentation OpenAPI indiquant qu'il n'y a pas de corps de réponse. + +/// + +## À propos des codes d'état HTTP { #about-http-status-codes } + +/// note | Remarque + +Si vous savez déjà ce que sont les codes d'état HTTP, passez à la section suivante. + +/// + +En HTTP, vous envoyez un code d'état numérique de 3 chiffres dans la réponse. + +Ces codes d'état ont un nom associé pour les reconnaître, mais la partie importante est le nombre. + +En bref : + +* `100 - 199` sont pour « Information ». Vous les utilisez rarement directement. Les réponses avec ces codes d'état ne peuvent pas avoir de corps. +* **`200 - 299`** sont pour les réponses de « Succès ». Ce sont celles que vous utiliserez le plus. + * `200` est le code d'état par défaut, ce qui signifie que tout était « OK ». + * Un autre exemple est `201`, « Créé ». Il est couramment utilisé après la création d'un nouvel enregistrement dans la base de données. + * Un cas particulier est `204`, « Aucun contenu ». Cette réponse est utilisée lorsqu'il n'y a aucun contenu à renvoyer au client ; la réponse ne doit donc pas avoir de corps. +* **`300 - 399`** sont pour la « Redirection ». Les réponses avec ces codes d'état peuvent avoir ou non un corps, sauf `304`, « Non modifié », qui ne doit pas en avoir. +* **`400 - 499`** sont pour les réponses d'« Erreur côté client ». C'est probablement le deuxième type que vous utiliserez le plus. + * Un exemple est `404`, pour une réponse « Non trouvé ». + * Pour des erreurs génériques du client, vous pouvez simplement utiliser `400`. +* `500 - 599` sont pour les erreurs côté serveur. Vous ne les utilisez presque jamais directement. Lorsqu'un problème survient quelque part dans le code de votre application ou sur le serveur, il renverra automatiquement l'un de ces codes d'état. + +/// tip | Astuce + +Pour en savoir plus sur chaque code d'état et à quoi il correspond, consultez la MDN documentation about HTTP status codes. + +/// + +## Raccourci pour se souvenir des noms { #shortcut-to-remember-the-names } + +Reprenons l'exemple précédent : + +{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *} + +`201` est le code d'état pour « Créé ». + +Mais vous n'avez pas à mémoriser la signification de chacun de ces codes. + +Vous pouvez utiliser les variables pratiques de `fastapi.status`. + +{* ../../docs_src/response_status_code/tutorial002_py310.py hl[1,6] *} + +Elles ne sont qu'une commodité, elles contiennent le même nombre, mais de cette façon vous pouvez utiliser l'autocomplétion de l'éditeur pour les trouver : + + + +/// note | Détails techniques + +Vous pourriez aussi utiliser `from starlette import status`. + +FastAPI fournit le même `starlette.status` que `fastapi.status`, uniquement pour votre commodité de développeur. Mais cela vient directement de Starlette. + +/// + +## Modifier la valeur par défaut { #changing-the-default } + +Plus tard, dans le [Guide utilisateur avancé](../advanced/response-change-status-code.md){.internal-link target=_blank}, vous verrez comment renvoyer un code d'état différent de celui par défaut que vous déclarez ici. diff --git a/docs/fr/docs/tutorial/schema-extra-example.md b/docs/fr/docs/tutorial/schema-extra-example.md new file mode 100644 index 0000000000..d4403c779b --- /dev/null +++ b/docs/fr/docs/tutorial/schema-extra-example.md @@ -0,0 +1,202 @@ +# Déclarer des exemples de données de requête { #declare-request-example-data } + +Vous pouvez déclarer des exemples des données que votre application peut recevoir. + +Voici plusieurs façons de le faire. + +## Ajouter des données JSON Schema supplémentaires dans les modèles Pydantic { #extra-json-schema-data-in-pydantic-models } + +Vous pouvez déclarer `examples` pour un modèle Pydantic qui seront ajoutés au JSON Schema généré. + +{* ../../docs_src/schema_extra_example/tutorial001_py310.py hl[13:24] *} + +Ces informations supplémentaires seront ajoutées telles quelles au **JSON Schema** de sortie pour ce modèle, et elles seront utilisées dans la documentation de l'API. + +Vous pouvez utiliser l'attribut `model_config` qui accepte un `dict` comme décrit dans Documentation de Pydantic : Configuration. + +Vous pouvez définir `"json_schema_extra"` avec un `dict` contenant toutes les données supplémentaires que vous souhaitez voir apparaître dans le JSON Schema généré, y compris `examples`. + +/// tip | Astuce + +Vous pouvez utiliser la même technique pour étendre le JSON Schema et ajouter vos propres informations supplémentaires personnalisées. + +Par exemple, vous pourriez l'utiliser pour ajouter des métadonnées pour une interface utilisateur frontend, etc. + +/// + +/// info + +OpenAPI 3.1.0 (utilisé depuis FastAPI 0.99.0) a ajouté la prise en charge de `examples`, qui fait partie du standard **JSON Schema**. + +Avant cela, seule la clé `example` avec un exemple unique était prise en charge. Elle l'est toujours par OpenAPI 3.1.0, mais elle est dépréciée et ne fait pas partie du standard JSON Schema. Vous êtes donc encouragé à migrer de `example` vers `examples`. 🤓 + +Vous pouvez en lire davantage à la fin de cette page. + +/// + +## Arguments supplémentaires de `Field` { #field-additional-arguments } + +Lorsque vous utilisez `Field()` avec des modèles Pydantic, vous pouvez également déclarer des `examples` supplémentaires : + +{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *} + +## `examples` dans JSON Schema - OpenAPI { #examples-in-json-schema-openapi } + +En utilisant l'un des éléments suivants : + +* `Path()` +* `Query()` +* `Header()` +* `Cookie()` +* `Body()` +* `Form()` +* `File()` + +vous pouvez également déclarer un groupe de `examples` avec des informations supplémentaires qui seront ajoutées à leurs **JSON Schemas** à l'intérieur d'**OpenAPI**. + +### `Body` avec `examples` { #body-with-examples } + +Ici, nous passons `examples` contenant un exemple des données attendues dans `Body()` : + +{* ../../docs_src/schema_extra_example/tutorial003_an_py310.py hl[22:29] *} + +### Exemple dans l'interface des documents { #example-in-the-docs-ui } + +Avec l'une des méthodes ci-dessus, cela ressemblerait à ceci dans le `/docs` : + + + +### `Body` avec plusieurs `examples` { #body-with-multiple-examples } + +Vous pouvez bien sûr aussi passer plusieurs `examples` : + +{* ../../docs_src/schema_extra_example/tutorial004_an_py310.py hl[23:38] *} + +Lorsque vous faites cela, les exemples feront partie du **JSON Schema** interne pour ces données de corps. + +Néanmoins, au moment de la rédaction, Swagger UI, l'outil chargé d'afficher l'interface des documents, ne prend pas en charge l'affichage de plusieurs exemples pour les données dans **JSON Schema**. Mais lisez ci-dessous pour un contournement. + +### `examples` spécifiques à OpenAPI { #openapi-specific-examples } + +Avant que **JSON Schema** ne prenne en charge `examples`, OpenAPI prenait déjà en charge un autre champ également appelé `examples`. + +Ce `examples` **spécifique à OpenAPI** se trouve dans une autre section de la spécification OpenAPI. Il se trouve dans les **détails de chaque *chemin d'accès***, et non à l'intérieur de chaque JSON Schema. + +Et Swagger UI prend en charge ce champ particulier `examples` depuis un certain temps. Vous pouvez donc l'utiliser pour **afficher** différents **exemples dans l'interface des documents**. + +La forme de ce champ `examples` spécifique à OpenAPI est un `dict` avec **plusieurs exemples** (au lieu d'une `list`), chacun avec des informations supplémentaires qui seront également ajoutées à **OpenAPI**. + +Cela ne va pas à l'intérieur de chaque JSON Schema contenu dans OpenAPI, cela se place à l'extérieur, directement dans le *chemin d'accès*. + +### Utiliser le paramètre `openapi_examples` { #using-the-openapi-examples-parameter } + +Vous pouvez déclarer le `examples` spécifique à OpenAPI dans FastAPI avec le paramètre `openapi_examples` pour : + +* `Path()` +* `Query()` +* `Header()` +* `Cookie()` +* `Body()` +* `Form()` +* `File()` + +Les clés du `dict` identifient chaque exemple, et chaque valeur est un autre `dict`. + +Chaque `dict` d'exemple spécifique dans `examples` peut contenir : + +* `summary` : une courte description de l'exemple. +* `description` : une description longue qui peut contenir du texte Markdown. +* `value` : c'est l'exemple réel affiché, par ex. un `dict`. +* `externalValue` : alternative à `value`, une URL pointant vers l'exemple. Cependant, cela pourrait ne pas être pris en charge par autant d'outils que `value`. + +Vous pouvez l'utiliser ainsi : + +{* ../../docs_src/schema_extra_example/tutorial005_an_py310.py hl[23:49] *} + +### Exemples OpenAPI dans l'interface des documents { #openapi-examples-in-the-docs-ui } + +Avec `openapi_examples` ajouté à `Body()`, le `/docs` ressemblerait à : + + + +## Détails techniques { #technical-details } + +/// tip | Astuce + +Si vous utilisez déjà **FastAPI** en version **0.99.0 ou supérieure**, vous pouvez probablement **passer** ces détails. + +Ils sont plus pertinents pour les versions plus anciennes, avant que OpenAPI 3.1.0 ne soit disponible. + +Vous pouvez considérer ceci comme une courte leçon d'histoire d'OpenAPI et de JSON Schema. 🤓 + +/// + +/// warning | Alertes + +Ce sont des détails très techniques au sujet des standards **JSON Schema** et **OpenAPI**. + +Si les idées ci-dessus fonctionnent déjà pour vous, cela pourrait suffire, et vous n'avez probablement pas besoin de ces détails, n'hésitez pas à les ignorer. + +/// + +Avant OpenAPI 3.1.0, OpenAPI utilisait une version plus ancienne et modifiée de **JSON Schema**. + +JSON Schema n'avait pas `examples`, donc OpenAPI a ajouté son propre champ `example` à sa version modifiée. + +OpenAPI a également ajouté les champs `example` et `examples` à d'autres parties de la spécification : + +* `Parameter Object` (dans la spécification) qui était utilisé par les éléments FastAPI : + * `Path()` + * `Query()` + * `Header()` + * `Cookie()` +* `Request Body Object`, dans le champ `content`, sur le `Media Type Object` (dans la spécification) qui était utilisé par les éléments FastAPI : + * `Body()` + * `File()` + * `Form()` + +/// info + +Ce paramètre `examples` ancien et spécifique à OpenAPI est désormais `openapi_examples` depuis FastAPI `0.103.0`. + +/// + +### Le champ `examples` de JSON Schema { #json-schemas-examples-field } + +Ensuite, JSON Schema a ajouté un champ `examples` dans une nouvelle version de la spécification. + +Puis le nouveau OpenAPI 3.1.0 s'est basé sur la dernière version (JSON Schema 2020-12) qui incluait ce nouveau champ `examples`. + +Et désormais, ce nouveau champ `examples` a priorité sur l'ancien champ unique (et personnalisé) `example`, qui est maintenant déprécié. + +Ce nouveau champ `examples` dans JSON Schema est **juste une `list`** d'exemples, et non pas un dict avec des métadonnées supplémentaires comme dans les autres endroits d'OpenAPI (décrits ci-dessus). + +/// info + +Même après la sortie d'OpenAPI 3.1.0 avec cette nouvelle intégration plus simple avec JSON Schema, pendant un temps, Swagger UI, l'outil qui fournit la documentation automatique, ne prenait pas en charge OpenAPI 3.1.0 (il le fait depuis la version 5.0.0 🎉). + +À cause de cela, les versions de FastAPI antérieures à 0.99.0 utilisaient encore des versions d'OpenAPI inférieures à 3.1.0. + +/// + +### `examples` avec Pydantic et FastAPI { #pydantic-and-fastapi-examples } + +Lorsque vous ajoutez `examples` dans un modèle Pydantic, en utilisant `schema_extra` ou `Field(examples=["something"])`, cet exemple est ajouté au **JSON Schema** de ce modèle Pydantic. + +Et ce **JSON Schema** du modèle Pydantic est inclus dans l'**OpenAPI** de votre API, puis il est utilisé dans l'interface de la documentation. + +Dans les versions de FastAPI antérieures à 0.99.0 (0.99.0 et supérieures utilisent le nouveau OpenAPI 3.1.0), lorsque vous utilisiez `example` ou `examples` avec l'une des autres utilitaires (`Query()`, `Body()`, etc.), ces exemples n'étaient pas ajoutés au JSON Schema qui décrit ces données (pas même à la version de JSON Schema propre à OpenAPI), ils étaient ajoutés directement à la déclaration du *chemin d'accès* dans OpenAPI (en dehors des parties d'OpenAPI qui utilisent JSON Schema). + +Mais maintenant que FastAPI 0.99.0 et supérieures utilisent OpenAPI 3.1.0, qui utilise JSON Schema 2020-12, et Swagger UI 5.0.0 et supérieures, tout est plus cohérent et les exemples sont inclus dans JSON Schema. + +### Swagger UI et `examples` spécifiques à OpenAPI { #swagger-ui-and-openapi-specific-examples } + +Comme Swagger UI ne prenait pas en charge plusieurs exemples JSON Schema (au 2023-08-26), les utilisateurs n'avaient pas de moyen d'afficher plusieurs exemples dans les documents. + +Pour résoudre cela, FastAPI `0.103.0` a **ajouté la prise en charge** de la déclaration du même ancien champ `examples` **spécifique à OpenAPI** avec le nouveau paramètre `openapi_examples`. 🤓 + +### Résumé { #summary } + +Je disais que je n'aimais pas trop l'histoire ... et me voilà maintenant à donner des leçons d'« tech history ». 😅 + +En bref, **mettez à niveau vers FastAPI 0.99.0 ou supérieur**, et les choses sont bien plus **simples, cohérentes et intuitives**, et vous n'avez pas besoin de connaître tous ces détails historiques. 😎 diff --git a/docs/fr/docs/tutorial/security/first-steps.md b/docs/fr/docs/tutorial/security/first-steps.md new file mode 100644 index 0000000000..8c4eb50d76 --- /dev/null +++ b/docs/fr/docs/tutorial/security/first-steps.md @@ -0,0 +1,203 @@ +# Sécurité - Premiers pas { #security-first-steps } + +Imaginons que vous ayez votre API de **backend** sur un certain domaine. + +Et vous avez un **frontend** sur un autre domaine ou dans un chemin différent du même domaine (ou dans une application mobile). + +Et vous voulez que le **frontend** puisse s'authentifier auprès du **backend**, en utilisant un **username** et un **password**. + +Nous pouvons utiliser **OAuth2** pour construire cela avec **FastAPI**. + +Mais épargnons-vous le temps de lire toute la spécification complète juste pour trouver les petites informations dont vous avez besoin. + +Utilisons les outils fournis par **FastAPI** pour gérer la sécurité. + +## Voir à quoi cela ressemble { #how-it-looks } + +Commençons par utiliser le code et voir comment cela fonctionne, puis nous reviendrons pour comprendre ce qui se passe. + +## Créer `main.py` { #create-main-py } + +Copiez l'exemple dans un fichier `main.py` : + +{* ../../docs_src/security/tutorial001_an_py310.py *} + +## Exécuter { #run-it } + +/// info + +Le package `python-multipart` est installé automatiquement avec **FastAPI** lorsque vous exécutez la commande `pip install "fastapi[standard]"`. + +Cependant, si vous utilisez la commande `pip install fastapi`, le package `python-multipart` n'est pas inclus par défaut. + +Pour l'installer manuellement, vous devez vous assurer de créer un [environnement virtuel](../../virtual-environments.md){.internal-link target=_blank}, de l'activer, puis de l'installer avec : + +```console +$ pip install python-multipart +``` + +Cela est dû au fait que **OAuth2** utilise des « form data » pour envoyer le `username` et le `password`. + +/// + +Exécutez l'exemple avec : + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +## Vérifier { #check-it } + +Allez à la documentation interactive à l'adresse : http://127.0.0.1:8000/docs. + +Vous verrez quelque chose comme ceci : + + + +/// check | Bouton « Authorize » ! + +Vous avez déjà un tout nouveau bouton « Authorize ». + +Et votre *chemin d'accès* a un petit cadenas dans le coin supérieur droit sur lequel vous pouvez cliquer. + +/// + +Et si vous cliquez dessus, vous obtenez un petit formulaire d'autorisation pour saisir un `username` et un `password` (et d'autres champs optionnels) : + + + +/// note | Remarque + +Peu importe ce que vous saisissez dans le formulaire, cela ne fonctionnera pas encore. Mais nous y viendrons. + +/// + +Ce n'est bien sûr pas le frontend pour les utilisateurs finaux, mais c'est un excellent outil automatique pour documenter de manière interactive toute votre API. + +Il peut être utilisé par l'équipe frontend (qui peut aussi être vous-même). + +Il peut être utilisé par des applications et des systèmes tiers. + +Et il peut aussi être utilisé par vous-même, pour déboguer, vérifier et tester la même application. + +## Le flux `password` { #the-password-flow } + +Revenons un peu en arrière et comprenons de quoi il s'agit. + +Le « flux » `password` est l'une des manières (« flows ») définies dans OAuth2 pour gérer la sécurité et l'authentification. + +OAuth2 a été conçu pour que le backend ou l'API puisse être indépendant du serveur qui authentifie l'utilisateur. + +Mais dans ce cas, la même application **FastAPI** gérera l'API et l'authentification. + +Voyons cela selon ce point de vue simplifié : + +- L'utilisateur saisit le `username` et le `password` dans le frontend, puis appuie sur Entrée. +- Le frontend (exécuté dans le navigateur de l'utilisateur) envoie ce `username` et ce `password` vers une URL spécifique de notre API (déclarée avec `tokenUrl="token"`). +- L'API vérifie ce `username` et ce `password`, et répond avec un « token » (nous n'avons encore rien implémenté de tout cela). + - Un « token » n'est qu'une chaîne contenant des informations que nous pouvons utiliser plus tard pour vérifier cet utilisateur. + - Normalement, un token est configuré pour expirer après un certain temps. + - Ainsi, l'utilisateur devra se reconnecter à un moment donné. + - Et si le token est volé, le risque est moindre. Ce n'est pas une clé permanente qui fonctionnerait indéfiniment (dans la plupart des cas). +- Le frontend stocke ce token temporairement quelque part. +- L'utilisateur clique dans le frontend pour aller vers une autre section de l'application web frontend. +- Le frontend doit récupérer d'autres données depuis l'API. + - Mais cela nécessite une authentification pour cet endpoint spécifique. + - Donc, pour s'authentifier auprès de notre API, il envoie un en-tête `Authorization` avec une valeur `Bearer ` suivie du token. + - Si le token contient `foobar`, le contenu de l'en-tête `Authorization` serait : `Bearer foobar`. + +## Le `OAuth2PasswordBearer` de **FastAPI** { #fastapis-oauth2passwordbearer } + +**FastAPI** fournit plusieurs outils, à différents niveaux d'abstraction, pour implémenter ces fonctionnalités de sécurité. + +Dans cet exemple, nous allons utiliser **OAuth2**, avec le flux **Password**, en utilisant un token **Bearer**. Nous le faisons avec la classe `OAuth2PasswordBearer`. + +/// info + +Un token « bearer » n'est pas la seule option. + +Mais c'est la meilleure pour notre cas d'utilisation. + +Et cela pourrait être la meilleure pour la plupart des cas, sauf si vous êtes expert en OAuth2 et savez exactement pourquoi une autre option convient mieux à vos besoins. + +Dans ce cas, **FastAPI** vous fournit aussi les outils pour la construire. + +/// + +Lorsque nous créons une instance de la classe `OAuth2PasswordBearer`, nous passons le paramètre `tokenUrl`. Ce paramètre contient l'URL que le client (le frontend s'exécutant dans le navigateur de l'utilisateur) utilisera pour envoyer le `username` et le `password` afin d'obtenir un token. + +{* ../../docs_src/security/tutorial001_an_py310.py hl[8] *} + +/// tip | Astuce + +Ici `tokenUrl="token"` fait référence à une URL relative `token` que nous n'avons pas encore créée. Comme c'est une URL relative, elle est équivalente à `./token`. + +Parce que nous utilisons une URL relative, si votre API se trouvait à `https://example.com/`, alors elle ferait référence à `https://example.com/token`. Mais si votre API se trouvait à `https://example.com/api/v1/`, alors elle ferait référence à `https://example.com/api/v1/token`. + +Utiliser une URL relative est important pour vous assurer que votre application continue de fonctionner même dans un cas d'usage avancé comme [Derrière un proxy](../../advanced/behind-a-proxy.md){.internal-link target=_blank}. + +/// + +Ce paramètre ne crée pas cet endpoint / *chemin d'accès*, mais déclare que l'URL `/token` sera celle que le client doit utiliser pour obtenir le token. Cette information est utilisée dans OpenAPI, puis dans les systèmes de documentation API interactifs. + +Nous créerons bientôt aussi le véritable chemin d'accès. + +/// info + +Si vous êtes un « Pythonista » très strict, vous pourriez ne pas apprécier le style du nom de paramètre `tokenUrl` au lieu de `token_url`. + +C'est parce qu'il utilise le même nom que dans la spécification OpenAPI. Ainsi, si vous devez approfondir l'un de ces schémas de sécurité, vous pouvez simplement copier-coller pour trouver plus d'informations à ce sujet. + +/// + +La variable `oauth2_scheme` est une instance de `OAuth2PasswordBearer`, mais c'est aussi un « callable ». + +Elle pourrait être appelée ainsi : + +```Python +oauth2_scheme(some, parameters) +``` + +Ainsi, elle peut être utilisée avec `Depends`. + +### Utiliser { #use-it } + +Vous pouvez maintenant passer ce `oauth2_scheme` en dépendance avec `Depends`. + +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} + +Cette dépendance fournira une `str` qui est affectée au paramètre `token` de la fonction de *chemin d'accès*. + +**FastAPI** saura qu'il peut utiliser cette dépendance pour définir un « schéma de sécurité » dans le schéma OpenAPI (et la documentation API automatique). + +/// info | Détails techniques + +**FastAPI** saura qu'il peut utiliser la classe `OAuth2PasswordBearer` (déclarée dans une dépendance) pour définir le schéma de sécurité dans OpenAPI parce qu'elle hérite de `fastapi.security.oauth2.OAuth2`, qui hérite à son tour de `fastapi.security.base.SecurityBase`. + +Tous les utilitaires de sécurité qui s'intègrent à OpenAPI (et à la documentation API automatique) héritent de `SecurityBase`, c'est ainsi que **FastAPI** sait comment les intégrer dans OpenAPI. + +/// + +## Ce que cela fait { #what-it-does } + +Il va chercher dans la requête cet en-tête `Authorization`, vérifier si la valeur est `Bearer ` plus un token, et renverra le token en tant que `str`. + +S'il ne voit pas d'en-tête `Authorization`, ou si la valeur n'a pas de token `Bearer `, il répondra directement avec une erreur de code d'état 401 (`UNAUTHORIZED`). + +Vous n'avez même pas à vérifier si le token existe pour renvoyer une erreur. Vous pouvez être sûr que si votre fonction est exécutée, elle aura une `str` dans ce token. + +Vous pouvez déjà l'essayer dans la documentation interactive : + + + +Nous ne vérifions pas encore la validité du token, mais c'est déjà un début. + +## Récapitulatif { #recap } + +Ainsi, en seulement 3 ou 4 lignes supplémentaires, vous disposez déjà d'une forme primitive de sécurité. diff --git a/docs/fr/docs/tutorial/security/get-current-user.md b/docs/fr/docs/tutorial/security/get-current-user.md new file mode 100644 index 0000000000..5f73efea9c --- /dev/null +++ b/docs/fr/docs/tutorial/security/get-current-user.md @@ -0,0 +1,105 @@ +# Obtenir l'utilisateur actuel { #get-current-user } + +Dans le chapitre précédent, le système de sécurité (basé sur le système d'injection de dépendances) fournissait à la *fonction de chemin d'accès* un `token` en tant que `str` : + +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} + +Mais ce n'est pas encore très utile. + +Faisons en sorte qu'il nous fournisse l'utilisateur actuel. + +## Créer un modèle d'utilisateur { #create-a-user-model } + +Commençons par créer un modèle d'utilisateur Pydantic. + +De la même manière que nous utilisons Pydantic pour déclarer des corps de requête, nous pouvons l'utiliser ailleurs : + +{* ../../docs_src/security/tutorial002_an_py310.py hl[5,12:6] *} + +## Créer une dépendance `get_current_user` { #create-a-get-current-user-dependency } + +Créons une dépendance `get_current_user`. + +Rappelez-vous que les dépendances peuvent avoir des sous-dépendances ? + +`get_current_user` aura une dépendance avec le même `oauth2_scheme` que nous avons créé précédemment. + +Comme nous le faisions auparavant directement dans le *chemin d'accès*, notre nouvelle dépendance `get_current_user` recevra un `token` en tant que `str` de la sous-dépendance `oauth2_scheme` : + +{* ../../docs_src/security/tutorial002_an_py310.py hl[25] *} + +## Récupérer l'utilisateur { #get-the-user } + +`get_current_user` utilisera une fonction utilitaire (factice) que nous avons créée, qui prend un token en `str` et retourne notre modèle Pydantic `User` : + +{* ../../docs_src/security/tutorial002_an_py310.py hl[19:22,26:27] *} + +## Injecter l'utilisateur actuel { #inject-the-current-user } + +Nous pouvons donc utiliser le même `Depends` avec notre `get_current_user` dans le *chemin d'accès* : + +{* ../../docs_src/security/tutorial002_an_py310.py hl[31] *} + +Remarquez que nous déclarons le type de `current_user` comme le modèle Pydantic `User`. + +Cela nous aidera dans la fonction avec toute l'autocomplétion et les vérifications de type. + +/// tip | Astuce + +Vous vous souvenez peut-être que les corps de requête sont également déclarés avec des modèles Pydantic. + +Ici, **FastAPI** ne s'y trompera pas car vous utilisez `Depends`. + +/// + +/// check | Vérifications + +La manière dont ce système de dépendances est conçu nous permet d'avoir différentes dépendances (différents « dependables ») qui retournent toutes un modèle `User`. + +Nous ne sommes pas limités à une seule dépendance pouvant retourner ce type de données. + +/// + +## Autres modèles { #other-models } + +Vous pouvez maintenant obtenir l'utilisateur actuel directement dans les *fonctions de chemin d'accès* et gérer les mécanismes de sécurité au niveau de l'**Injection de dépendances**, en utilisant `Depends`. + +Et vous pouvez utiliser n'importe quel modèle ou données pour les exigences de sécurité (dans ce cas, un modèle Pydantic `User`). + +Mais vous n'êtes pas limité à un modèle, une classe ou un type de données spécifique. + +Voulez-vous avoir un `id` et `email` et ne pas avoir de `username` dans votre modèle ? Bien sûr. Vous pouvez utiliser ces mêmes outils. + +Voulez-vous simplement avoir un `str` ? Ou juste un `dict` ? Ou directement une instance d'un modèle de classe de base de données ? Tout fonctionne de la même manière. + +Vous n'avez en fait pas d'utilisateurs qui se connectent à votre application, mais des robots, bots ou d'autres systèmes, qui n'ont qu'un jeton d'accès ? Là encore, tout fonctionne de la même façon. + +Utilisez simplement tout type de modèle, toute sorte de classe, tout type de base de données dont vous avez besoin pour votre application. **FastAPI** vous couvre avec le système d'injection de dépendances. + +## Taille du code { #code-size } + +Cet exemple peut sembler verbeux. Gardez à l'esprit que nous mélangeons sécurité, modèles de données, fonctions utilitaires et *chemins d'accès* dans le même fichier. + +Mais voici le point clé. + +La partie sécurité et injection de dépendances est écrite une seule fois. + +Et vous pouvez la rendre aussi complexe que vous le souhaitez. Et malgré tout, ne l'écrire qu'une seule fois, en un seul endroit. Avec toute la flexibilité. + +Mais vous pouvez avoir des milliers d'endpoints (*chemins d'accès*) utilisant le même système de sécurité. + +Et tous (ou seulement une partie d'entre eux, si vous le souhaitez) peuvent profiter de la réutilisation de ces dépendances ou de toute autre dépendance que vous créez. + +Et tous ces milliers de *chemins d'accès* peuvent tenir en seulement 3 lignes : + +{* ../../docs_src/security/tutorial002_an_py310.py hl[30:32] *} + +## Récapitulatif { #recap } + +Vous pouvez désormais obtenir l'utilisateur actuel directement dans votre *fonction de chemin d'accès*. + +Nous avons déjà fait la moitié du chemin. + +Il nous suffit d'ajouter un *chemin d'accès* pour que l'utilisateur/client envoie effectivement le `username` et le `password`. + +C'est pour la suite. diff --git a/docs/fr/docs/tutorial/security/index.md b/docs/fr/docs/tutorial/security/index.md new file mode 100644 index 0000000000..6de75aed61 --- /dev/null +++ b/docs/fr/docs/tutorial/security/index.md @@ -0,0 +1,106 @@ +# Sécurité { #security } + +Il existe de nombreuses façons de gérer la sécurité, l'authentification et l'autorisation. + +Et c'est normalement un sujet complexe et « difficile ». + +Dans de nombreux frameworks et systèmes, le simple fait de gérer la sécurité et l'authentification demande beaucoup d'efforts et de code (dans de nombreux cas, cela peut représenter 50 % ou plus de tout le code écrit). + +**FastAPI** fournit plusieurs outils pour vous aider à gérer la **Sécurité** facilement, rapidement, de manière standard, sans avoir à étudier et apprendre toutes les spécifications de sécurité. + +Mais d'abord, voyons quelques notions. + +## Pressé ? { #in-a-hurry } + +Si ces termes ne vous intéressent pas et que vous avez simplement besoin d'ajouter une sécurité avec une authentification basée sur un nom d'utilisateur et un mot de passe immédiatement, passez aux chapitres suivants. + +## OAuth2 { #oauth2 } + +OAuth2 est une spécification qui définit plusieurs façons de gérer l'authentification et l'autorisation. + +C'est une spécification assez vaste qui couvre plusieurs cas d'utilisation complexes. + +Elle inclut des moyens de s'authentifier en utilisant un « tiers ». + +C'est ce que tous les systèmes avec « connexion avec Facebook, Google, X (Twitter), GitHub » utilisent en arrière-plan. + +### OAuth 1 { #oauth-1 } + +Il y a eu un OAuth 1, très différent d'OAuth2, et plus complexe, car il incluait des spécifications directes sur la manière de chiffrer la communication. + +Il n'est plus très populaire ni utilisé de nos jours. + +OAuth2 ne spécifie pas comment chiffrer la communication ; il suppose que votre application est servie en HTTPS. + +/// tip | Astuce + +Dans la section sur le déploiement, vous verrez comment configurer HTTPS gratuitement, en utilisant Traefik et Let's Encrypt. + +/// + +## OpenID Connect { #openid-connect } + +OpenID Connect est une autre spécification, basée sur **OAuth2**. + +Elle étend simplement OAuth2 en précisant certains points relativement ambigus dans OAuth2, afin d'essayer de la rendre plus interopérable. + +Par exemple, la connexion Google utilise OpenID Connect (qui, en arrière-plan, utilise OAuth2). + +Mais la connexion Facebook ne prend pas en charge OpenID Connect. Elle a sa propre variante d'OAuth2. + +### OpenID (pas « OpenID Connect ») { #openid-not-openid-connect } + +Il y avait aussi une spécification « OpenID ». Elle essayait de résoudre la même chose qu'**OpenID Connect**, mais n'était pas basée sur OAuth2. + +C'était donc un système totalement distinct. + +Il n'est plus très populaire ni utilisé de nos jours. + +## OpenAPI { #openapi } + +OpenAPI (précédemment connu sous le nom de Swagger) est la spécification ouverte pour construire des API (désormais partie de la Linux Foundation). + +**FastAPI** est basé sur **OpenAPI**. + +C'est ce qui rend possibles plusieurs interfaces de documentation interactive automatiques, la génération de code, etc. + +OpenAPI propose une manière de définir plusieurs « schémas » de sécurité. + +En les utilisant, vous pouvez tirer parti de tous ces outils basés sur des standards, y compris ces systèmes de documentation interactive. + +OpenAPI définit les schémas de sécurité suivants : + +* `apiKey` : une clé spécifique à l'application qui peut provenir : + * D'un paramètre de requête. + * D'un en-tête. + * D'un cookie. +* `http` : des systèmes d'authentification HTTP standards, notamment : + * `bearer` : un en-tête `Authorization` avec une valeur `Bearer ` plus un jeton. Hérité d'OAuth2. + * Authentification HTTP Basic. + * HTTP Digest, etc. +* `oauth2` : toutes les méthodes OAuth2 pour gérer la sécurité (appelées « flows »). + * Plusieurs de ces flows conviennent pour construire un fournisseur d'authentification OAuth 2.0 (comme Google, Facebook, X (Twitter), GitHub, etc.) : + * `implicit` + * `clientCredentials` + * `authorizationCode` + * Mais il existe un « flow » spécifique qui peut parfaitement être utilisé pour gérer l'authentification directement dans la même application : + * `password` : certains des prochains chapitres couvriront des exemples à ce sujet. +* `openIdConnect` : propose un moyen de définir comment découvrir automatiquement les données d'authentification OAuth2. + * Cette découverte automatique est ce qui est défini dans la spécification OpenID Connect. + + +/// tip | Astuce + +Intégrer d'autres fournisseurs d'authentification/autorisation comme Google, Facebook, X (Twitter), GitHub, etc. est également possible et relativement facile. + +Le problème le plus complexe est de construire un fournisseur d'authentification/autorisation comme ceux-là, mais **FastAPI** vous donne les outils pour le faire facilement, tout en effectuant le gros du travail pour vous. + +/// + +## Outils **FastAPI** { #fastapi-utilities } + +FastAPI propose plusieurs outils pour chacun de ces schémas de sécurité dans le module fastapi.security qui simplifient l'utilisation de ces mécanismes de sécurité. + +Dans les prochains chapitres, vous verrez comment ajouter de la sécurité à votre API en utilisant ces outils fournis par **FastAPI**. + +Et vous verrez aussi comment cela s'intègre automatiquement au système de documentation interactive. diff --git a/docs/fr/docs/tutorial/security/oauth2-jwt.md b/docs/fr/docs/tutorial/security/oauth2-jwt.md new file mode 100644 index 0000000000..d35530fc9c --- /dev/null +++ b/docs/fr/docs/tutorial/security/oauth2-jwt.md @@ -0,0 +1,277 @@ +# OAuth2 avec mot de passe (et hachage), Bearer avec des jetons JWT { #oauth2-with-password-and-hashing-bearer-with-jwt-tokens } + +Maintenant que nous avons tout le flux de sécurité, rendons réellement l'application sécurisée, en utilisant des jetons JWT et un hachage de mot de passe sécurisé. + +Ce code est utilisable dans votre application, enregistrez les hachages de mots de passe dans votre base de données, etc. + +Nous allons repartir d'où nous nous sommes arrêtés dans le chapitre précédent et l'enrichir. + +## À propos de JWT { #about-jwt } + +JWT signifie « JSON Web Tokens ». + +C'est une norme pour coder un objet JSON dans une longue chaîne compacte sans espaces. Cela ressemble à ceci : + +``` +eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c +``` + +Il n'est pas chiffré ; ainsi, n'importe qui peut récupérer les informations à partir de son contenu. + +Mais il est signé. Ainsi, quand vous recevez un jeton que vous avez émis, vous pouvez vérifier que vous l'avez bien émis. + +De cette façon, vous pouvez créer un jeton avec une expiration d'une semaine, par exemple. Et quand l'utilisateur revient le lendemain avec ce jeton, vous savez qu'il est toujours connecté à votre système. + +Après une semaine, le jeton aura expiré et l'utilisateur ne sera pas autorisé et devra se reconnecter pour obtenir un nouveau jeton. Et si l'utilisateur (ou un tiers) essayait de modifier le jeton pour changer l'expiration, vous pourriez le détecter, car les signatures ne correspondraient pas. + +Si vous voulez expérimenter avec des jetons JWT et voir comment ils fonctionnent, consultez https://jwt.io. + +## Installer `PyJWT` { #install-pyjwt } + +Nous devons installer `PyJWT` pour générer et vérifier les jetons JWT en Python. + +Assurez-vous de créer un [environnement virtuel](../../virtual-environments.md){.internal-link target=_blank}, de l'activer, puis d'installer `pyjwt` : + +
+ +```console +$ pip install pyjwt + +---> 100% +``` + +
+ +/// info + +Si vous prévoyez d'utiliser des algorithmes de signature numérique comme RSA ou ECDSA, vous devez installer la dépendance de bibliothèque de cryptographie `pyjwt[crypto]`. + +Vous pouvez en lire davantage dans la documentation d'installation de PyJWT. + +/// + +## Hachage de mot de passe { #password-hashing } + +« Hachage » signifie convertir un contenu (un mot de passe dans ce cas) en une séquence d'octets (juste une chaîne) qui ressemble à du charabia. + +Chaque fois que vous fournissez exactement le même contenu (exactement le même mot de passe), vous obtenez exactement le même charabia. + +Mais vous ne pouvez pas convertir le charabia en sens inverse vers le mot de passe. + +### Pourquoi utiliser le hachage de mot de passe { #why-use-password-hashing } + +Si votre base de données est volée, le voleur n'aura pas les mots de passe en clair de vos utilisateurs, seulement les hachages. + +Ainsi, le voleur ne pourra pas essayer d'utiliser ce mot de passe dans un autre système (comme beaucoup d'utilisateurs utilisent le même mot de passe partout, ce serait dangereux). + +## Installer `pwdlib` { #install-pwdlib } + +pwdlib est un excellent package Python pour gérer les hachages de mots de passe. + +Il prend en charge de nombreux algorithmes de hachage sécurisés et des utilitaires pour travailler avec eux. + +L'algorithme recommandé est « Argon2 ». + +Assurez-vous de créer un [environnement virtuel](../../virtual-environments.md){.internal-link target=_blank}, de l'activer, puis d'installer pwdlib avec Argon2 : + +
+ +```console +$ pip install "pwdlib[argon2]" + +---> 100% +``` + +
+ +/// tip | Astuce + +Avec `pwdlib`, vous pouvez même le configurer pour pouvoir lire des mots de passe créés par **Django**, un plug-in de sécurité **Flask** ou bien d'autres. + +Ainsi, vous seriez par exemple en mesure de partager les mêmes données d'une application Django dans une base de données avec une application FastAPI. Ou de migrer progressivement une application Django en utilisant la même base de données. + +Et vos utilisateurs pourraient se connecter depuis votre application Django ou depuis votre application **FastAPI**, en même temps. + +/// + +## Hacher et vérifier les mots de passe { #hash-and-verify-the-passwords } + +Importez les outils nécessaires depuis `pwdlib`. + +Créez une instance PasswordHash avec les réglages recommandés ; elle sera utilisée pour hacher et vérifier les mots de passe. + +/// tip | Astuce + +pwdlib prend également en charge l'algorithme de hachage bcrypt, mais n'inclut pas les algorithmes hérités. Pour travailler avec des hachages obsolètes, il est recommandé d'utiliser la bibliothèque passlib. + +Par exemple, vous pourriez l'utiliser pour lire et vérifier des mots de passe générés par un autre système (comme Django), mais hacher tous les nouveaux mots de passe avec un autre algorithme comme Argon2 ou Bcrypt. + +Et rester compatible avec tous en même temps. + +/// + +Créez une fonction utilitaire pour hacher un mot de passe fourni par l'utilisateur. + +Et une autre pour vérifier si un mot de passe reçu correspond au hachage stocké. + +Et une autre pour authentifier et renvoyer un utilisateur. + +{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,51,58:59,62:63,72:79] *} + +Lorsque `authenticate_user` est appelée avec un nom d'utilisateur qui n'existe pas dans la base de données, nous exécutons tout de même `verify_password` contre un hachage factice. + +Cela garantit que le point de terminaison met approximativement le même temps à répondre que le nom d'utilisateur soit valide ou non, empêchant des **attaques temporelles** qui pourraient être utilisées pour énumérer les noms d'utilisateur existants. + +/// note | Remarque + +Si vous consultez la nouvelle (fausse) base de données `fake_users_db`, vous verrez à quoi ressemble maintenant le mot de passe haché : `"$argon2id$v=19$m=65536,t=3,p=4$wagCPXjifgvUFBzq4hqe3w$CYaIb8sB+wtD+Vu/P4uod1+Qof8h+1g7bbDlBID48Rc"`. + +/// + +## Gérer les jetons JWT { #handle-jwt-tokens } + +Importez les modules installés. + +Créez une clé secrète aléatoire qui sera utilisée pour signer les jetons JWT. + +Pour générer une clé secrète aléatoire sécurisée, utilisez la commande : + +
+ +```console +$ openssl rand -hex 32 + +09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7 +``` + +
+ +Et copiez la sortie dans la variable `SECRET_KEY` (n'utilisez pas celle de l'exemple). + +Créez une variable `ALGORITHM` avec l'algorithme utilisé pour signer le jeton JWT, et définissez-la à `"HS256"`. + +Créez une variable pour l'expiration du jeton. + +Définissez un modèle Pydantic qui sera utilisé dans le point de terminaison du jeton pour la réponse. + +Créez une fonction utilitaire pour générer un nouveau jeton d'accès. + +{* ../../docs_src/security/tutorial004_an_py310.py hl[4,7,13:15,29:31,82:90] *} + +## Mettre à jour les dépendances { #update-the-dependencies } + +Mettez à jour `get_current_user` pour recevoir le même jeton qu'auparavant, mais cette fois en utilisant des jetons JWT. + +Décodez le jeton reçu, vérifiez-le, et renvoyez l'utilisateur courant. + +Si le jeton est invalide, renvoyez immédiatement une erreur HTTP. + +{* ../../docs_src/security/tutorial004_an_py310.py hl[93:110] *} + +## Mettre à jour le *chemin d'accès* `/token` { #update-the-token-path-operation } + +Créez un `timedelta` avec la durée d'expiration du jeton. + +Créez un véritable jeton d'accès JWT et renvoyez-le. + +{* ../../docs_src/security/tutorial004_an_py310.py hl[121:136] *} + +### Détails techniques au sujet du « subject » JWT `sub` { #technical-details-about-the-jwt-subject-sub } + +La spécification JWT indique qu'il existe une clé `sub`, contenant le sujet du jeton. + +Son utilisation est facultative, mais c'est là que vous placeriez l'identifiant de l'utilisateur ; nous l'utilisons donc ici. + +Les JWT peuvent être utilisés pour d'autres choses que l'identification d'un utilisateur et l'autorisation d'effectuer des opérations directement sur votre API. + +Par exemple, vous pourriez identifier une « voiture » ou un « article de blog ». + +Vous pourriez ensuite ajouter des permissions sur cette entité, comme « conduire » (pour la voiture) ou « modifier » (pour le blog). + +Vous pourriez alors donner ce jeton JWT à un utilisateur (ou un bot), et il pourrait l'utiliser pour effectuer ces actions (conduire la voiture, ou modifier l'article de blog) sans même avoir besoin d'avoir un compte, uniquement avec le jeton JWT que votre API a généré pour cela. + +En utilisant ces idées, les JWT peuvent servir à des scénarios bien plus sophistiqués. + +Dans ces cas, plusieurs de ces entités peuvent avoir le même identifiant, disons `foo` (un utilisateur `foo`, une voiture `foo`, et un article de blog `foo`). + +Donc, pour éviter les collisions d'identifiants, lors de la création du jeton JWT pour l'utilisateur, vous pouvez préfixer la valeur de la clé `sub`, par exemple avec `username:`. Ainsi, dans cet exemple, la valeur de `sub` aurait pu être : `username:johndoe`. + +L'important à garder à l'esprit est que la clé `sub` doit contenir un identifiant unique dans toute l'application, et ce doit être une chaîne de caractères. + +## Vérifier { #check-it } + +Lancez le serveur et allez à la documentation : http://127.0.0.1:8000/docs. + +Vous verrez l'interface utilisateur suivante : + + + +Autorisez l'application de la même manière qu'auparavant. + +En utilisant les identifiants : + +Nom d'utilisateur : `johndoe` +Mot de passe : `secret` + +/// check | Vérifications + +Remarquez qu'à aucun endroit du code le mot de passe en clair « secret » n'apparaît, nous n'avons que la version hachée. + +/// + + + +Appelez le point de terminaison `/users/me/`, vous obtiendrez la réponse suivante : + +```JSON +{ + "username": "johndoe", + "email": "johndoe@example.com", + "full_name": "John Doe", + "disabled": false +} +``` + + + +Si vous ouvrez les outils de développement, vous pouvez voir que les données envoyées n'incluent que le jeton ; le mot de passe n'est envoyé que dans la première requête pour authentifier l'utilisateur et obtenir ce jeton d'accès, mais plus ensuite : + + + +/// note | Remarque + +Remarquez l'en-tête `Authorization`, avec une valeur qui commence par `Bearer `. + +/// + +## Utilisation avancée avec `scopes` { #advanced-usage-with-scopes } + +OAuth2 comporte la notion de « scopes ». + +Vous pouvez les utiliser pour ajouter un ensemble spécifique d'autorisations à un jeton JWT. + +Vous pouvez ensuite donner ce jeton directement à un utilisateur ou à un tiers, pour interagir avec votre API avec un ensemble de restrictions. + +Vous pouvez apprendre à les utiliser et comment ils sont intégrés à **FastAPI** plus tard dans le **Guide de l'utilisateur avancé**. + +## Récapitulatif { #recap } + +Avec ce que vous avez vu jusqu'à présent, vous pouvez configurer une application **FastAPI** sécurisée en utilisant des standards comme OAuth2 et JWT. + +Dans presque n'importe quel framework, la gestion de la sécurité devient assez rapidement un sujet plutôt complexe. + +De nombreux packages qui la simplifient beaucoup doivent faire de nombreux compromis avec le modèle de données, la base de données et les fonctionnalités disponibles. Et certains de ces packages qui simplifient trop les choses comportent en fait des failles de sécurité sous-jacentes. + +--- + +**FastAPI** ne fait aucun compromis avec une base de données, un modèle de données ni un outil. + +Il vous donne toute la flexibilité pour choisir ceux qui conviennent le mieux à votre projet. + +Et vous pouvez utiliser directement de nombreux packages bien maintenus et largement utilisés comme `pwdlib` et `PyJWT`, car **FastAPI** n'exige aucun mécanisme complexe pour intégrer des packages externes. + +Mais il vous fournit les outils pour simplifier le processus autant que possible sans compromettre la flexibilité, la robustesse ou la sécurité. + +Et vous pouvez utiliser et implémenter des protocoles sécurisés et standard, comme OAuth2, de manière relativement simple. + +Vous pouvez en apprendre davantage dans le **Guide de l'utilisateur avancé** sur la façon d'utiliser les « scopes » OAuth2, pour un système d'autorisations plus fin, en suivant ces mêmes standards. OAuth2 avec scopes est le mécanisme utilisé par de nombreux grands fournisseurs d'authentification, comme Facebook, Google, GitHub, Microsoft, X (Twitter), etc., pour autoriser des applications tierces à interagir avec leurs API au nom de leurs utilisateurs. diff --git a/docs/fr/docs/tutorial/security/simple-oauth2.md b/docs/fr/docs/tutorial/security/simple-oauth2.md new file mode 100644 index 0000000000..662444753b --- /dev/null +++ b/docs/fr/docs/tutorial/security/simple-oauth2.md @@ -0,0 +1,289 @@ +# OAuth2 simple avec Password et Bearer { #simple-oauth2-with-password-and-bearer } + +Construisons maintenant à partir du chapitre précédent et ajoutons les éléments manquants pour avoir un flux de sécurité complet. + +## Obtenir `username` et `password` { #get-the-username-and-password } + +Nous allons utiliser les utilitaires de sécurité de **FastAPI** pour obtenir `username` et `password`. + +OAuth2 spécifie que lorsqu'on utilise le « password flow » (ce que nous utilisons), le client/utilisateur doit envoyer des champs `username` et `password` en tant que données de formulaire. + +Et la spécification indique que les champs doivent porter exactement ces noms. Ainsi, `user-name` ou `email` ne fonctionneraient pas. + +Mais ne vous inquiétez pas, vous pouvez l'afficher comme vous le souhaitez à vos utilisateurs finaux dans le frontend. + +Et vos modèles de base de données peuvent utiliser les noms que vous voulez. + +Mais pour le chemin d'accès de connexion, nous devons utiliser ces noms pour être compatibles avec la spécification (et pouvoir, par exemple, utiliser le système de documentation API intégré). + +La spécification précise également que `username` et `password` doivent être envoyés en données de formulaire (donc pas de JSON ici). + +### `scope` { #scope } + +La spécification indique aussi que le client peut envoyer un autre champ de formulaire « scope ». + +Le nom du champ de formulaire est `scope` (au singulier), mais il s'agit en fait d'une longue chaîne contenant des « scopes » séparés par des espaces. + +Chaque « scope » n'est qu'une chaîne (sans espaces). + +Ils sont normalement utilisés pour déclarer des permissions de sécurité spécifiques, par exemple : + +* `users:read` ou `users:write` sont des exemples courants. +* `instagram_basic` est utilisé par Facebook / Instagram. +* `https://www.googleapis.com/auth/drive` est utilisé par Google. + +/// info + +En OAuth2, un « scope » est simplement une chaîne qui déclare une permission spécifique requise. + +Peu importe s'il contient d'autres caractères comme `:` ou si c'est une URL. + +Ces détails dépendent de l'implémentation. + +Pour OAuth2, ce ne sont que des chaînes. + +/// + +## Écrire le code pour obtenir `username` et `password` { #code-to-get-the-username-and-password } + +Utilisons maintenant les utilitaires fournis par **FastAPI** pour gérer cela. + +### `OAuth2PasswordRequestForm` { #oauth2passwordrequestform } + +Tout d'abord, importez `OAuth2PasswordRequestForm`, et utilisez-la en tant que dépendance avec `Depends` dans le chemin d'accès pour `/token` : + +{* ../../docs_src/security/tutorial003_an_py310.py hl[4,78] *} + +`OAuth2PasswordRequestForm` est une dépendance de classe qui déclare un corps de formulaire avec : + +* Le `username`. +* Le `password`. +* Un champ optionnel `scope` sous forme d'une grande chaîne, composée de chaînes séparées par des espaces. +* Un `grant_type` optionnel. + +/// tip | Astuce + +La spécification OAuth2 exige en réalité un champ `grant_type` avec la valeur fixe `password`, mais `OAuth2PasswordRequestForm` ne l'impose pas. + +Si vous avez besoin de l'imposer, utilisez `OAuth2PasswordRequestFormStrict` au lieu de `OAuth2PasswordRequestForm`. + +/// + +* Un `client_id` optionnel (nous n'en avons pas besoin pour notre exemple). +* Un `client_secret` optionnel (nous n'en avons pas besoin pour notre exemple). + +/// info + +La classe `OAuth2PasswordRequestForm` n'est pas une classe spéciale pour **FastAPI** comme l'est `OAuth2PasswordBearer`. + +`OAuth2PasswordBearer` indique à **FastAPI** qu'il s'agit d'un schéma de sécurité. Il est donc ajouté de cette façon à OpenAPI. + +Mais `OAuth2PasswordRequestForm` est simplement une dépendance de classe que vous auriez pu écrire vous‑même, ou vous auriez pu déclarer des paramètres `Form` directement. + +Mais comme c'est un cas d'usage courant, elle est fournie directement par **FastAPI**, simplement pour vous faciliter la vie. + +/// + +### Utiliser les données du formulaire { #use-the-form-data } + +/// tip | Astuce + +L'instance de la classe de dépendance `OAuth2PasswordRequestForm` n'aura pas d'attribut `scope` contenant la longue chaîne séparée par des espaces ; elle aura plutôt un attribut `scopes` avec la liste réelle des chaînes pour chaque scope envoyé. + +Nous n'utilisons pas `scopes` dans cet exemple, mais la fonctionnalité est disponible si vous en avez besoin. + +/// + +Récupérez maintenant les données utilisateur depuis la (fausse) base de données, en utilisant le `username` du champ de formulaire. + +S'il n'existe pas d'utilisateur, nous renvoyons une erreur indiquant « Incorrect username or password ». + +Pour l'erreur, nous utilisons l'exception `HTTPException` : + +{* ../../docs_src/security/tutorial003_an_py310.py hl[3,79:81] *} + +### Vérifier le mot de passe { #check-the-password } + +À ce stade, nous avons les données utilisateur depuis notre base, mais nous n'avons pas encore vérifié le mot de passe. + +Mettons d'abord ces données dans le modèle Pydantic `UserInDB`. + +Vous ne devez jamais enregistrer des mots de passe en clair ; nous allons donc utiliser le système (factice) de hachage de mot de passe. + +Si les mots de passe ne correspondent pas, nous renvoyons la même erreur. + +#### Hachage de mot de passe { #password-hashing } + +Le « hachage » signifie : convertir un contenu (un mot de passe, dans ce cas) en une séquence d'octets (juste une chaîne) qui ressemble à du charabia. + +Chaque fois que vous fournissez exactement le même contenu (exactement le même mot de passe), vous obtenez exactement le même charabia. + +Mais vous ne pouvez pas convertir ce charabia pour retrouver le mot de passe. + +##### Pourquoi utiliser le hachage de mot de passe { #why-use-password-hashing } + +Si votre base de données est volée, le voleur n'aura pas les mots de passe en clair de vos utilisateurs, seulement les hachages. + +Ainsi, il ne pourra pas essayer d'utiliser ces mêmes mots de passe dans un autre système (comme beaucoup d'utilisateurs utilisent le même mot de passe partout, ce serait dangereux). + +{* ../../docs_src/security/tutorial003_an_py310.py hl[82:85] *} + +#### À propos de `**user_dict` { #about-user-dict } + +`UserInDB(**user_dict)` signifie : + +Passez les clés et valeurs de `user_dict` directement comme arguments clé‑valeur, équivalent à : + +```Python +UserInDB( + username = user_dict["username"], + email = user_dict["email"], + full_name = user_dict["full_name"], + disabled = user_dict["disabled"], + hashed_password = user_dict["hashed_password"], +) +``` + +/// info + +Pour une explication plus complète de `**user_dict`, consultez [la documentation pour **Modèles supplémentaires**](../extra-models.md#about-user-in-dict){.internal-link target=_blank}. + +/// + +## Renvoyer le jeton { #return-the-token } + +La réponse de l'endpoint `token` doit être un objet JSON. + +Il doit contenir un `token_type`. Dans notre cas, comme nous utilisons des jetons « Bearer », le type de jeton doit être « bearer ». + +Et il doit contenir un `access_token`, avec une chaîne contenant notre jeton d'accès. + +Pour cet exemple simple, nous allons faire quelque chose de complètement non sécurisé et renvoyer le même `username` comme jeton. + +/// tip | Astuce + +Dans le prochain chapitre, vous verrez une véritable implémentation sécurisée, avec du hachage de mot de passe et des jetons JWT. + +Mais pour l'instant, concentrons‑nous sur les détails spécifiques dont nous avons besoin. + +/// + +{* ../../docs_src/security/tutorial003_an_py310.py hl[87] *} + +/// tip | Astuce + +D'après la spécification, vous devez renvoyer un JSON avec un `access_token` et un `token_type`, comme dans cet exemple. + +C'est quelque chose que vous devez faire vous‑même dans votre code, et vous devez vous assurer d'utiliser ces clés JSON. + +C'est presque la seule chose que vous devez vous rappeler de faire correctement vous‑même pour être conforme aux spécifications. + +Pour le reste, **FastAPI** s'en charge pour vous. + +/// + +## Mettre à jour les dépendances { #update-the-dependencies } + +Nous allons maintenant mettre à jour nos dépendances. + +Nous voulons obtenir `current_user` uniquement si cet utilisateur est actif. + +Nous créons donc une dépendance supplémentaire `get_current_active_user` qui utilise à son tour `get_current_user` comme dépendance. + +Ces deux dépendances renverront simplement une erreur HTTP si l'utilisateur n'existe pas, ou s'il est inactif. + +Ainsi, dans notre endpoint, nous n'obtiendrons un utilisateur que si l'utilisateur existe, a été correctement authentifié et est actif : + +{* ../../docs_src/security/tutorial003_an_py310.py hl[58:66,69:74,94] *} + +/// info + +L'en‑tête supplémentaire `WWW-Authenticate` avec la valeur `Bearer` que nous renvoyons ici fait également partie de la spécification. + +Il est prévu qu'un code d'état HTTP (d'erreur) 401 « UNAUTHORIZED » renvoie également un en‑tête `WWW-Authenticate`. + +Dans le cas des jetons bearer (notre cas), la valeur de cet en‑tête doit être `Bearer`. + +Vous pouvez en réalité omettre cet en‑tête supplémentaire et cela fonctionnerait quand même. + +Mais il est fourni ici pour être conforme aux spécifications. + +De plus, il peut exister des outils qui l'attendent et l'utilisent (maintenant ou à l'avenir) et cela pourrait vous être utile, à vous ou à vos utilisateurs, maintenant ou à l'avenir. + +C'est l'avantage des standards ... + +/// + +## Voir en action { #see-it-in-action } + +Ouvrez la documentation interactive : http://127.0.0.1:8000/docs. + +### S'authentifier { #authenticate } + +Cliquez sur le bouton « Authorize ». + +Utilisez les identifiants : + +Utilisateur : `johndoe` + +Mot de passe : `secret` + + + +Après vous être authentifié dans le système, vous verrez ceci : + + + +### Obtenir vos propres données utilisateur { #get-your-own-user-data } + +Utilisez maintenant l'opération `GET` avec le chemin `/users/me`. + +Vous obtiendrez les données de votre utilisateur, par exemple : + +```JSON +{ + "username": "johndoe", + "email": "johndoe@example.com", + "full_name": "John Doe", + "disabled": false, + "hashed_password": "fakehashedsecret" +} +``` + + + +Si vous cliquez sur l'icône de cadenas et vous vous déconnectez, puis réessayez la même opération, vous obtiendrez une erreur HTTP 401 : + +```JSON +{ + "detail": "Not authenticated" +} +``` + +### Utilisateur inactif { #inactive-user } + +Essayez maintenant avec un utilisateur inactif, authentifiez‑vous avec : + +Utilisateur : `alice` + +Mot de passe : `secret2` + +Et essayez d'utiliser l'opération `GET` avec le chemin `/users/me`. + +Vous obtiendrez une erreur « Inactive user », par exemple : + +```JSON +{ + "detail": "Inactive user" +} +``` + +## Récapitulatif { #recap } + +Vous avez maintenant les outils pour implémenter un système de sécurité complet basé sur `username` et `password` pour votre API. + +En utilisant ces outils, vous pouvez rendre le système de sécurité compatible avec n'importe quelle base de données et avec n'importe quel modèle d'utilisateur ou de données. + +Le seul détail manquant est qu'il n'est pas encore réellement « sécurisé ». + +Dans le prochain chapitre, vous verrez comment utiliser une bibliothèque de hachage de mot de passe sécurisée et des jetons JWT. diff --git a/docs/fr/docs/tutorial/sql-databases.md b/docs/fr/docs/tutorial/sql-databases.md new file mode 100644 index 0000000000..75f9ae14fc --- /dev/null +++ b/docs/fr/docs/tutorial/sql-databases.md @@ -0,0 +1,357 @@ +# Bases de données SQL (relationnelles) { #sql-relational-databases } + +**FastAPI** ne vous oblige pas à utiliser une base de données SQL (relationnelle). Mais vous pouvez utiliser **n'importe quelle base de données** que vous voulez. + +Ici, nous allons voir un exemple utilisant SQLModel. + +**SQLModel** est construit au-dessus de SQLAlchemy et de Pydantic. Il a été créé par le même auteur que **FastAPI** pour être l'accord parfait pour les applications FastAPI qui ont besoin d'utiliser des **bases de données SQL**. + +/// tip | Astuce + +Vous pouvez utiliser toute autre bibliothèque SQL ou NoSQL que vous voulez (dans certains cas appelées « ORMs »), FastAPI ne vous impose rien. 😎 + +/// + +Comme SQLModel est basé sur SQLAlchemy, vous pouvez facilement utiliser **toute base prise en charge** par SQLAlchemy (ce qui les rend également prises en charge par SQLModel), comme : + +* PostgreSQL +* MySQL +* SQLite +* Oracle +* Microsoft SQL Server, etc. + +Dans cet exemple, nous utiliserons **SQLite**, car il utilise un seul fichier et Python a un support intégré. Ainsi, vous pouvez copier cet exemple et l'exécuter tel quel. + +Plus tard, pour votre application de production, vous voudrez peut-être utiliser un serveur de base de données comme **PostgreSQL**. + +/// tip | Astuce + +Il existe un générateur de projet officiel avec **FastAPI** et **PostgreSQL**, incluant un frontend et plus d'outils : https://github.com/fastapi/full-stack-fastapi-template + +/// + +Il s'agit d'un tutoriel très simple et court ; si vous souhaitez apprendre sur les bases de données en général, sur SQL, ou des fonctionnalités plus avancées, allez voir la documentation SQLModel. + +## Installer `SQLModel` { #install-sqlmodel } + +D'abord, assurez-vous de créer votre [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, de l'activer, puis d'installer `sqlmodel` : + +
+ +```console +$ pip install sqlmodel +---> 100% +``` + +
+ +## Créer l'application avec un modèle unique { #create-the-app-with-a-single-model } + +Nous allons d'abord créer la première version la plus simple de l'application avec un seul modèle **SQLModel**. + +Ensuite, nous l'améliorerons en augmentant la sécurité et la polyvalence avec **plusieurs modèles** ci-dessous. 🤓 + +### Créer les modèles { #create-models } + +Importez `SQLModel` et créez un modèle de base de données : + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[1:11] hl[7:11] *} + +La classe `Hero` est très similaire à un modèle Pydantic (en fait, en dessous, c'est réellement un modèle Pydantic). + +Il y a quelques différences : + +* `table=True` indique à SQLModel qu'il s'agit d'un *modèle de table*, il doit représenter une **table** dans la base SQL, ce n'est pas seulement un *modèle de données* (comme le serait n'importe quelle autre classe Pydantic classique). + +* `Field(primary_key=True)` indique à SQLModel que `id` est la **clé primaire** dans la base SQL (vous pouvez en savoir plus sur les clés primaires SQL dans la documentation SQLModel). + + Remarque : nous utilisons `int | None` pour le champ clé primaire afin qu'en Python nous puissions *créer un objet sans `id`* (`id=None`), en supposant que la base *le génère à l'enregistrement*. SQLModel comprend que la base fournira l'`id` et *définit la colonne comme un `INTEGER` non nul* dans le schéma de base. Voir la documentation SQLModel sur les clés primaires pour plus de détails. + +* `Field(index=True)` indique à SQLModel qu'il doit créer un **index SQL** pour cette colonne, ce qui permettra des recherches plus rapides dans la base lors de la lecture de données filtrées par cette colonne. + + SQLModel saura que quelque chose déclaré comme `str` sera une colonne SQL de type `TEXT` (ou `VARCHAR`, selon la base). + +### Créer un engine { #create-an-engine } + +Un `engine` SQLModel (en dessous c'est en fait un `engine` SQLAlchemy) est ce qui **détient les connexions** à la base de données. + +Vous devez avoir **un seul objet `engine`** pour tout votre code afin de se connecter à la même base. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[14:18] hl[14:15,17:18] *} + +L'utilisation de `check_same_thread=False` permet à FastAPI d'utiliser la même base SQLite dans différents threads. C'est nécessaire car **une seule requête** peut utiliser **plus d'un thread** (par exemple dans des dépendances). + +Ne vous inquiétez pas, avec la structure du code, nous nous assurerons d'utiliser **une seule *session* SQLModel par requête** plus loin, c'est en fait ce que `check_same_thread` essaie d'assurer. + +### Créer les tables { #create-the-tables } + +Nous ajoutons ensuite une fonction qui utilise `SQLModel.metadata.create_all(engine)` pour **créer les tables** pour tous les *modèles de table*. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[21:22] hl[21:22] *} + +### Créer une dépendance de session { #create-a-session-dependency } + +Une **`Session`** est ce qui stocke les **objets en mémoire** et suit les modifications nécessaires des données, puis **utilise l'`engine`** pour communiquer avec la base. + +Nous allons créer une **dépendance** FastAPI avec `yield` qui fournira une nouvelle `Session` pour chaque requête. C'est ce qui garantit que nous utilisons une seule session par requête. 🤓 + +Puis nous créons une dépendance `Annotated` `SessionDep` pour simplifier le reste du code qui utilisera cette dépendance. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[25:30] hl[25:27,30] *} + +### Créer les tables de base au démarrage { #create-database-tables-on-startup } + +Nous allons créer les tables de base de données au démarrage de l'application. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[32:37] hl[35:37] *} + +Ici, nous créons les tables lors d'un événement de démarrage de l'application. + +En production, vous utiliseriez probablement un script de migration qui s'exécute avant de démarrer votre application. 🤓 + +/// tip | Astuce + +SQLModel aura des utilitaires de migration enveloppant Alembic, mais pour l'instant, vous pouvez utiliser Alembic directement. + +/// + +### Créer un héros { #create-a-hero } + +Comme chaque modèle SQLModel est aussi un modèle Pydantic, vous pouvez l'utiliser dans les mêmes **annotations de type** que vous utiliseriez pour des modèles Pydantic. + +Par exemple, si vous déclarez un paramètre de type `Hero`, il sera lu depuis le **corps JSON**. + +De la même manière, vous pouvez le déclarer comme **type de retour** de la fonction, et alors la forme des données apparaîtra dans l'UI automatique de documentation de l'API. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[40:45] hl[40:45] *} + +Ici, nous utilisons la dépendance `SessionDep` (une `Session`) pour ajouter le nouveau `Hero` à l'instance de `Session`, valider les changements dans la base, rafraîchir les données dans `hero`, puis le retourner. + +### Lire les héros { #read-heroes } + +Nous pouvons **lire** des `Hero` depuis la base en utilisant un `select()`. Nous pouvons inclure une `limit` et un `offset` pour paginer les résultats. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[48:55] hl[51:52,54] *} + +### Lire un héros { #read-one-hero } + +Nous pouvons **lire** un seul `Hero`. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[58:63] hl[60] *} + +### Supprimer un héros { #delete-a-hero } + +Nous pouvons aussi **supprimer** un `Hero`. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[66:73] hl[71] *} + +### Exécuter l'application { #run-the-app } + +Vous pouvez exécuter l'application : + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Ensuite, allez sur l'UI `/docs`, vous verrez que **FastAPI** utilise ces **modèles** pour **documenter** l'API, et les utilisera aussi pour **sérialiser** et **valider** les données. + +
+ +
+ +## Mettre à jour l'application avec plusieurs modèles { #update-the-app-with-multiple-models } + +Maintenant, **refactorisons** un peu cette application pour augmenter la **sécurité** et la **polyvalence**. + +Si vous vérifiez l'application précédente, dans l'UI vous pouvez voir que, jusqu'à présent, elle laisse le client décider de l'`id` du `Hero` à créer. 😱 + +Nous ne devrions pas laisser cela se produire, ils pourraient écraser un `id` que nous avons déjà attribué dans la base. Décider de l'`id` doit être fait par le **backend** ou la **base**, **pas par le client**. + +De plus, nous créons un `secret_name` pour le héros, mais jusqu'ici, nous le renvoyons partout, ce n'est pas très « secret » ... 😅 + +Nous allons corriger ces choses en ajoutant quelques **modèles supplémentaires**. C'est là que SQLModel brille. ✨ + +### Créer plusieurs modèles { #create-multiple-models } + +Dans **SQLModel**, toute classe de modèle qui a `table=True` est un **modèle de table**. + +Et toute classe de modèle qui n'a pas `table=True` est un **modèle de données**, ceux-ci sont en réalité juste des modèles Pydantic (avec deux petites fonctionnalités en plus). 🤓 + +Avec SQLModel, nous pouvons utiliser **l'héritage** pour **éviter de dupliquer** tous les champs dans tous les cas. + +#### `HeroBase` - la classe de base { #herobase-the-base-class } + +Commençons avec un modèle `HeroBase` qui a tous les **champs partagés** par tous les modèles : + +* `name` +* `age` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:9] hl[7:9] *} + +#### `Hero` - le *modèle de table* { #hero-the-table-model } + +Créons ensuite `Hero`, le *modèle de table* proprement dit, avec les **champs supplémentaires** qui ne sont pas toujours dans les autres modèles : + +* `id` +* `secret_name` + +Comme `Hero` hérite de `HeroBase`, il **a aussi** les **champs** déclarés dans `HeroBase`, donc tous les champs de `Hero` sont : + +* `id` +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:14] hl[12:14] *} + +#### `HeroPublic` - le *modèle de données* public { #heropublic-the-public-data-model } + +Ensuite, nous créons un modèle `HeroPublic`, c'est celui qui sera **retourné** aux clients de l'API. + +Il a les mêmes champs que `HeroBase`, il n'inclura donc pas `secret_name`. + +Enfin, l'identité de nos héros est protégée ! 🥷 + +Il redéclare aussi `id: int`. Ce faisant, nous faisons un **contrat** avec les clients de l'API, afin qu'ils puissent toujours s'attendre à ce que `id` soit présent et soit un `int` (il ne sera jamais `None`). + +/// tip | Astuce + +Avoir le modèle de retour qui garantit qu'une valeur est toujours disponible et toujours `int` (pas `None`) est très utile pour les clients de l'API, ils peuvent écrire un code beaucoup plus simple avec cette certitude. + +De plus, les **clients générés automatiquement** auront des interfaces plus simples, afin que les développeurs qui communiquent avec votre API puissent travailler bien plus facilement avec votre API. 😎 + +/// + +Tous les champs de `HeroPublic` sont les mêmes que dans `HeroBase`, avec `id` déclaré comme `int` (pas `None`) : + +* `id` +* `name` +* `age` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:18] hl[17:18] *} + +#### `HeroCreate` - le *modèle de données* pour créer un héros { #herocreate-the-data-model-to-create-a-hero } + +Nous créons maintenant un modèle `HeroCreate`, c'est celui qui **validera** les données provenant des clients. + +Il a les mêmes champs que `HeroBase`, et il a aussi `secret_name`. + +Maintenant, lorsque les clients **créent un nouveau héros**, ils enverront `secret_name`, il sera stocké dans la base, mais ces noms secrets ne seront pas renvoyés dans l'API aux clients. + +/// tip | Astuce + +C'est ainsi que vous géreriez les **mots de passe**. Les recevoir, mais ne pas les renvoyer dans l'API. + +Vous **hacherez** aussi les valeurs des mots de passe avant de les stocker, **ne les stockez jamais en texte en clair**. + +/// + +Les champs de `HeroCreate` sont : + +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:22] hl[21:22] *} + +#### `HeroUpdate` - le *modèle de données* pour mettre à jour un héros { #heroupdate-the-data-model-to-update-a-hero } + +Nous n'avions pas de moyen de **mettre à jour un héros** dans la version précédente de l'application, mais maintenant avec **plusieurs modèles**, nous pouvons le faire. 🎉 + +Le *modèle de données* `HeroUpdate` est un peu spécial, il a **tous les mêmes champs** qui seraient nécessaires pour créer un nouveau héros, mais tous les champs sont **optionnels** (ils ont tous une valeur par défaut). Ainsi, lorsque vous mettez à jour un héros, vous pouvez n'envoyer que les champs que vous souhaitez mettre à jour. + +Comme tous les **champs changent réellement** (le type inclut désormais `None` et ils ont maintenant une valeur par défaut de `None`), nous devons les **redéclarer**. + +Nous n'avons pas vraiment besoin d'hériter de `HeroBase` puisque nous redéclarons tous les champs. Je le laisse hériter juste pour la cohérence, mais ce n'est pas nécessaire. C'est plutôt une question de goût personnel. 🤷 + +Les champs de `HeroUpdate` sont : + +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:28] hl[25:28] *} + +### Créer avec `HeroCreate` et retourner un `HeroPublic` { #create-with-herocreate-and-return-a-heropublic } + +Maintenant que nous avons **plusieurs modèles**, nous pouvons mettre à jour les parties de l'application qui les utilisent. + +Nous recevons dans la requête un *modèle de données* `HeroCreate`, et à partir de celui-ci, nous créons un *modèle de table* `Hero`. + +Ce nouveau *modèle de table* `Hero` aura les champs envoyés par le client, et aura aussi un `id` généré par la base. + +Nous retournons ensuite le même *modèle de table* `Hero` tel quel depuis la fonction. Mais comme nous déclarons le `response_model` avec le *modèle de données* `HeroPublic`, **FastAPI** utilisera `HeroPublic` pour valider et sérialiser les données. + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[56:62] hl[56:58] *} + +/// tip | Astuce + +Nous utilisons maintenant `response_model=HeroPublic` au lieu de l'**annotation de type de retour** `-> HeroPublic` car la valeur que nous renvoyons n'est en réalité *pas* un `HeroPublic`. + +Si nous avions déclaré `-> HeroPublic`, votre éditeur et votre linter se plaindraient (à juste titre) que vous retournez un `Hero` au lieu d'un `HeroPublic`. + +En le déclarant dans `response_model`, nous disons à **FastAPI** de faire son travail, sans interférer avec les annotations de type et l'aide de votre éditeur et d'autres outils. + +/// + +### Lire des héros avec `HeroPublic` { #read-heroes-with-heropublic } + +Nous pouvons faire la même chose qu'avant pour **lire** des `Hero`, à nouveau, nous utilisons `response_model=list[HeroPublic]` pour garantir que les données sont correctement validées et sérialisées. + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[65:72] hl[65] *} + +### Lire un héros avec `HeroPublic` { #read-one-hero-with-heropublic } + +Nous pouvons **lire** un héros unique : + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[75:80] hl[77] *} + +### Mettre à jour un héros avec `HeroUpdate` { #update-a-hero-with-heroupdate } + +Nous pouvons **mettre à jour un héros**. Pour cela, nous utilisons une opération HTTP `PATCH`. + +Et dans le code, nous obtenons un `dict` avec toutes les données envoyées par le client, **uniquement les données envoyées par le client**, en excluant toute valeur qui serait là simplement parce que c'est la valeur par défaut. Pour ce faire, nous utilisons `exclude_unset=True`. C'est l'astuce principale. 🪄 + +Nous utilisons ensuite `hero_db.sqlmodel_update(hero_data)` pour mettre à jour `hero_db` avec les données de `hero_data`. + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[83:93] hl[83:84,88:89] *} + +### Supprimer un héros (bis) { #delete-a-hero-again } + +**Supprimer** un héros reste pratiquement identique. + +Nous n'allons pas céder à l'envie de tout refactoriser pour celui-ci. 😅 + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[96:103] hl[101] *} + +### Exécuter l'application à nouveau { #run-the-app-again } + +Vous pouvez exécuter l'application à nouveau : + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Si vous allez sur l'UI `/docs` de l'API, vous verrez qu'elle est maintenant à jour, et qu'elle n'attendra plus de recevoir l'`id` du client lors de la création d'un héros, etc. + +
+ +
+ +## Récapitulatif { #recap } + +Vous pouvez utiliser **SQLModel** pour interagir avec une base SQL et simplifier le code avec des *modèles de données* et des *modèles de table*. + +Vous pouvez en apprendre beaucoup plus dans la documentation **SQLModel**, il y a un mini tutoriel plus long sur l'utilisation de SQLModel avec **FastAPI**. 🚀 diff --git a/docs/fr/docs/tutorial/static-files.md b/docs/fr/docs/tutorial/static-files.md new file mode 100644 index 0000000000..3928fed9bc --- /dev/null +++ b/docs/fr/docs/tutorial/static-files.md @@ -0,0 +1,40 @@ +# Fichiers statiques { #static-files } + +Vous pouvez servir des fichiers statiques automatiquement à partir d'un répertoire en utilisant `StaticFiles`. + +## Utiliser `StaticFiles` { #use-staticfiles } + +- Importer `StaticFiles`. +- « Mount » une instance `StaticFiles()` sur un chemin spécifique. + +{* ../../docs_src/static_files/tutorial001_py310.py hl[2,6] *} + +/// note | Détails techniques + +Vous pouvez également utiliser `from starlette.staticfiles import StaticFiles`. + +**FastAPI** fournit le même `starlette.staticfiles` sous le nom `fastapi.staticfiles` uniquement pour votre commodité, en tant que développeur. Mais cela provient en réalité directement de Starlette. + +/// + +### Qu'est-ce que « Mounting » { #what-is-mounting } + +« Mounting » signifie ajouter une application complète « indépendante » sur un chemin spécifique, qui se chargera ensuite de gérer tous les sous-chemins. + +Cela diffère de l'utilisation d'un `APIRouter`, car une application montée est complètement indépendante. L'OpenAPI et les documents de votre application principale n'incluront rien provenant de l'application montée, etc. + +Vous pouvez en lire davantage à ce sujet dans le [Guide utilisateur avancé](../advanced/index.md){.internal-link target=_blank}. + +## Détails { #details } + +Le premier `"/static"` fait référence au sous-chemin sur lequel cette « sous-application » sera « montée ». Ainsi, tout chemin qui commence par `"/static"` sera géré par elle. + +Le `directory="static"` fait référence au nom du répertoire qui contient vos fichiers statiques. + +Le `name="static"` lui donne un nom utilisable en interne par **FastAPI**. + +Tous ces paramètres peuvent être différents de « `static` », adaptez-les aux besoins et aux détails spécifiques de votre propre application. + +## Plus d'informations { #more-info } + +Pour plus de détails et d'options, consultez la documentation de Starlette sur les fichiers statiques. diff --git a/docs/fr/docs/tutorial/testing.md b/docs/fr/docs/tutorial/testing.md new file mode 100644 index 0000000000..8a609b644d --- /dev/null +++ b/docs/fr/docs/tutorial/testing.md @@ -0,0 +1,193 @@ +# Tester { #testing } + +Grâce à Starlette, tester des applications **FastAPI** est simple et agréable. + +C’est basé sur HTTPX, dont la conception s’inspire de Requests, ce qui le rend très familier et intuitif. + +Avec cela, vous pouvez utiliser pytest directement avec **FastAPI**. + +## Utiliser `TestClient` { #using-testclient } + +/// info + +Pour utiliser `TestClient`, installez d’abord `httpx`. + +Vous devez créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, l’activer, puis y installer le paquet, par exemple : + +```console +$ pip install httpx +``` + +/// + +Importez `TestClient`. + +Créez un `TestClient` en lui passant votre application **FastAPI**. + +Créez des fonctions dont le nom commence par `test_` (c’est la convention standard de `pytest`). + +Utilisez l’objet `TestClient` de la même manière que vous utilisez `httpx`. + +Écrivez de simples instructions `assert` avec les expressions Python standard que vous devez vérifier (là encore, standard `pytest`). + +{* ../../docs_src/app_testing/tutorial001_py310.py hl[2,12,15:18] *} + +/// tip | Astuce + +Remarquez que les fonctions de test sont des `def` normales, pas des `async def`. + +Et les appels au client sont aussi des appels normaux, sans utiliser `await`. + +Cela vous permet d’utiliser `pytest` directement sans complications. + +/// + +/// note | Détails techniques + +Vous pouvez aussi utiliser `from starlette.testclient import TestClient`. + +**FastAPI** fournit le même `starlette.testclient` sous le nom `fastapi.testclient` uniquement pour votre commodité, en tant que développeur. Mais cela vient directement de Starlette. + +/// + +/// tip | Astuce + +Si vous souhaitez appeler des fonctions `async` dans vos tests en dehors de l’envoi de requêtes à votre application FastAPI (par exemple des fonctions de base de données asynchrones), consultez les [Tests asynchrones](../advanced/async-tests.md){.internal-link target=_blank} dans le tutoriel avancé. + +/// + +## Séparer les tests { #separating-tests } + +Dans une application réelle, vous auriez probablement vos tests dans un fichier différent. + +Et votre application **FastAPI** pourrait aussi être composée de plusieurs fichiers/modules, etc. + +### Fichier d’application **FastAPI** { #fastapi-app-file } + +Supposons que vous ayez une structure de fichiers comme décrit dans [Applications plus grandes](bigger-applications.md){.internal-link target=_blank} : + +``` +. +├── app +│   ├── __init__.py +│   └── main.py +``` + +Dans le fichier `main.py`, vous avez votre application **FastAPI** : + + +{* ../../docs_src/app_testing/app_a_py310/main.py *} + +### Fichier de test { #testing-file } + +Vous pourriez alors avoir un fichier `test_main.py` avec vos tests. Il pourrait vivre dans le même package Python (le même répertoire avec un fichier `__init__.py`) : + +``` hl_lines="5" +. +├── app +│   ├── __init__.py +│   ├── main.py +│   └── test_main.py +``` + +Comme ce fichier se trouve dans le même package, vous pouvez utiliser des imports relatifs pour importer l’objet `app` depuis le module `main` (`main.py`) : + +{* ../../docs_src/app_testing/app_a_py310/test_main.py hl[3] *} + + +… et avoir le code des tests comme précédemment. + +## Tester : exemple étendu { #testing-extended-example } + +Étendons maintenant cet exemple et ajoutons plus de détails pour voir comment tester différentes parties. + +### Fichier d’application **FastAPI** étendu { #extended-fastapi-app-file } + +Continuons avec la même structure de fichiers qu’auparavant : + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +│   └── test_main.py +``` + +Supposons que désormais le fichier `main.py` avec votre application **FastAPI** contienne d’autres **chemins d’accès**. + +Il a une opération `GET` qui pourrait renvoyer une erreur. + +Il a une opération `POST` qui pourrait renvoyer plusieurs erreurs. + +Les deux chemins d’accès requièrent un en-tête `X-Token`. + +{* ../../docs_src/app_testing/app_b_an_py310/main.py *} + +### Fichier de test étendu { #extended-testing-file } + +Vous pourriez ensuite mettre à jour `test_main.py` avec les tests étendus : + +{* ../../docs_src/app_testing/app_b_an_py310/test_main.py *} + + +Chaque fois que vous avez besoin que le client transmette des informations dans la requête et que vous ne savez pas comment faire, vous pouvez chercher (Google) comment le faire avec `httpx`, ou même comment le faire avec `requests`, puisque la conception de HTTPX est basée sur celle de Requests. + +Ensuite, vous faites simplement la même chose dans vos tests. + +Par exemple : + +* Pour passer un paramètre de chemin ou un paramètre de requête, ajoutez-le directement à l’URL. +* Pour passer un corps JSON, passez un objet Python (par exemple un `dict`) au paramètre `json`. +* Si vous devez envoyer des *Form Data* au lieu de JSON, utilisez le paramètre `data` à la place. +* Pour passer des en-têtes, utilisez un `dict` dans le paramètre `headers`. +* Pour les cookies, un `dict` dans le paramètre `cookies`. + +Pour plus d’informations sur la manière de transmettre des données au backend (en utilisant `httpx` ou le `TestClient`), consultez la documentation HTTPX. + +/// info + +Notez que le `TestClient` reçoit des données qui peuvent être converties en JSON, pas des modèles Pydantic. + +Si vous avez un modèle Pydantic dans votre test et que vous souhaitez envoyer ses données à l’application pendant les tests, vous pouvez utiliser le `jsonable_encoder` décrit dans [Encodeur compatible JSON](encoder.md){.internal-link target=_blank}. + +/// + +## Exécuter { #run-it } + +Après cela, vous avez simplement besoin d’installer `pytest`. + +Vous devez créer un [environnement virtuel](../virtual-environments.md){.internal-link target=_blank}, l’activer, puis y installer le paquet, par exemple : + +
+ +```console +$ pip install pytest + +---> 100% +``` + +
+ +Il détectera automatiquement les fichiers et les tests, les exécutera et vous communiquera les résultats. + +Exécutez les tests avec : + +
+ +```console +$ pytest + +================ test session starts ================ +platform linux -- Python 3.6.9, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 +rootdir: /home/user/code/superawesome-cli/app +plugins: forked-1.1.3, xdist-1.31.0, cov-2.8.1 +collected 6 items + +---> 100% + +test_main.py ...... [100%] + +================= 1 passed in 0.03s ================= +``` + +
diff --git a/docs/fr/docs/virtual-environments.md b/docs/fr/docs/virtual-environments.md new file mode 100644 index 0000000000..86b5faadce --- /dev/null +++ b/docs/fr/docs/virtual-environments.md @@ -0,0 +1,864 @@ +# Environnements virtuels { #virtual-environments } + +Lorsque vous travaillez sur des projets Python, vous devriez probablement utiliser un environnement virtuel (ou un mécanisme similaire) pour isoler les packages que vous installez pour chaque projet. + +/// info + +Si vous connaissez déjà les environnements virtuels, comment les créer et les utiliser, vous pouvez passer cette section. 🤓 + +/// + +/// tip | Astuce + +Un environnement virtuel est différent d’une variable d’environnement. + +Une variable d’environnement est une variable du système qui peut être utilisée par des programmes. + +Un environnement virtuel est un répertoire contenant certains fichiers. + +/// + +/// info + +Cette page vous apprendra à utiliser les environnements virtuels et à comprendre leur fonctionnement. + +Si vous êtes prêt à adopter un outil qui gère tout pour vous (y compris l’installation de Python), essayez uv. + +/// + +## Créer un projet { #create-a-project } + +Commencez par créer un répertoire pour votre projet. + +Ce que je fais généralement, c’est créer un répertoire nommé `code` dans mon répertoire personnel/utilisateur. + +Et à l’intérieur, je crée un répertoire par projet. + +
+ +```console +// Aller au répertoire personnel +$ cd +// Créer un répertoire pour tous vos projets de code +$ mkdir code +// Entrer dans ce répertoire code +$ cd code +// Créer un répertoire pour ce projet +$ mkdir awesome-project +// Entrer dans ce répertoire de projet +$ cd awesome-project +``` + +
+ +## Créer un environnement virtuel { #create-a-virtual-environment } + +Lorsque vous commencez à travailler sur un projet Python pour la première fois, créez un environnement virtuel dans votre projet. + +/// tip | Astuce + +Vous n’avez besoin de faire cela qu’une seule fois par projet, pas à chaque fois que vous travaillez. + +/// + +//// tab | `venv` + +Pour créer un environnement virtuel, vous pouvez utiliser le module `venv` fourni avec Python. + +
+ +```console +$ python -m venv .venv +``` + +
+ +/// details | Que signifie cette commande + +* `python` : utiliser le programme nommé `python` +* `-m` : appeler un module comme un script, nous préciserons ensuite quel module +* `venv` : utiliser le module nommé `venv` qui est normalement installé avec Python +* `.venv` : créer l’environnement virtuel dans le nouveau répertoire `.venv` + +/// + +//// + +//// tab | `uv` + +Si vous avez installé `uv`, vous pouvez l’utiliser pour créer un environnement virtuel. + +
+ +```console +$ uv venv +``` + +
+ +/// tip | Astuce + +Par défaut, `uv` créera un environnement virtuel dans un répertoire appelé `.venv`. + +Mais vous pouvez le personnaliser en passant un argument supplémentaire avec le nom du répertoire. + +/// + +//// + +Cette commande crée un nouvel environnement virtuel dans un répertoire appelé `.venv`. + +/// details | `.venv` ou autre nom + +Vous pourriez créer l’environnement virtuel dans un autre répertoire, mais il est d’usage de l’appeler `.venv`. + +/// + +## Activer l’environnement virtuel { #activate-the-virtual-environment } + +Activez le nouvel environnement virtuel afin que toute commande Python que vous exécutez ou tout package que vous installez l’utilise. + +/// tip | Astuce + +Faites cela à chaque fois que vous démarrez une nouvelle session de terminal pour travailler sur le projet. + +/// + +//// tab | Linux, macOS + +
+ +```console +$ source .venv/bin/activate +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +$ .venv\Scripts\Activate.ps1 +``` + +
+ +//// + +//// tab | Windows Bash + +Ou si vous utilisez Bash pour Windows (par exemple Git Bash) : + +
+ +```console +$ source .venv/Scripts/activate +``` + +
+ +//// + +/// tip | Astuce + +Chaque fois que vous installez un nouveau package dans cet environnement, activez de nouveau l’environnement. + +Vous vous assurez ainsi que si vous utilisez un programme de terminal (CLI) installé par ce package, vous utilisez celui de votre environnement virtuel et non un autre qui pourrait être installé globalement, probablement avec une version différente de celle dont vous avez besoin. + +/// + +## Vérifier que l’environnement virtuel est actif { #check-the-virtual-environment-is-active } + +Vérifiez que l’environnement virtuel est actif (la commande précédente a fonctionné). + +/// tip | Astuce + +C’est facultatif, mais c’est une bonne manière de vérifier que tout fonctionne comme prévu et que vous utilisez l’environnement virtuel voulu. + +/// + +//// tab | Linux, macOS, Windows Bash + +
+ +```console +$ which python + +/home/user/code/awesome-project/.venv/bin/python +``` + +
+ +S’il affiche le binaire `python` à `.venv/bin/python`, dans votre projet (dans cet exemple `awesome-project`), alors cela a fonctionné. 🎉 + +//// + +//// tab | Windows PowerShell + +
+ +```console +$ Get-Command python + +C:\Users\user\code\awesome-project\.venv\Scripts\python +``` + +
+ +S’il affiche le binaire `python` à `.venv\Scripts\python`, dans votre projet (dans cet exemple `awesome-project`), alors cela a fonctionné. 🎉 + +//// + +## Mettre à niveau `pip` { #upgrade-pip } + +/// tip | Astuce + +Si vous utilisez `uv`, vous l’utiliserez pour installer des éléments à la place de `pip`, vous n’avez donc pas besoin de mettre `pip` à niveau. 😎 + +/// + +Si vous utilisez `pip` pour installer des packages (il est fourni par défaut avec Python), vous devez le mettre à niveau vers la dernière version. + +Beaucoup d’erreurs exotiques lors de l’installation d’un package se résolvent simplement en mettant d’abord `pip` à niveau. + +/// tip | Astuce + +Vous feriez normalement cela une seule fois, juste après avoir créé l’environnement virtuel. + +/// + +Vous devez vous assurer que l’environnement virtuel est actif (avec la commande ci-dessus), puis exécuter : + +
+ +```console +$ python -m pip install --upgrade pip + +---> 100% +``` + +
+ +/// tip | Astuce + +Parfois, vous pourriez obtenir une erreur **`No module named pip`** en essayant de mettre à niveau pip. + +Si cela arrive, installez et mettez à niveau pip avec la commande ci-dessous : + +
+ +```console +$ python -m ensurepip --upgrade + +---> 100% +``` + +
+ +Cette commande installera pip s’il n’est pas déjà installé et garantit aussi que la version de pip installée est au moins aussi récente que celle disponible dans `ensurepip`. + +/// + +## Ajouter `.gitignore` { #add-gitignore } + +Si vous utilisez Git (vous devriez), ajoutez un fichier `.gitignore` pour exclure tout ce qui se trouve dans votre `.venv` de Git. + +/// tip | Astuce + +Si vous avez utilisé `uv` pour créer l’environnement virtuel, il l’a déjà fait pour vous, vous pouvez passer cette étape. 😎 + +/// + +/// tip | Astuce + +Faites cela une seule fois, juste après avoir créé l’environnement virtuel. + +/// + +
+ +```console +$ echo "*" > .venv/.gitignore +``` + +
+ +/// details | Que signifie cette commande + +* `echo "*"` : va « afficher » le texte `*` dans le terminal (la partie suivante change un peu cela) +* `>` : tout ce qui est affiché dans le terminal par la commande à gauche de `>` ne doit pas être affiché mais écrit dans le fichier à droite de `>` +* `.gitignore` : le nom du fichier dans lequel le texte doit être écrit + +Et `*` signifie pour Git « tout ». Ainsi, il ignorera tout dans le répertoire `.venv`. + +Cette commande créera un fichier `.gitignore` avec le contenu : + +```gitignore +* +``` + +/// + +## Installer des packages { #install-packages } + +Après avoir activé l’environnement, vous pouvez y installer des packages. + +/// tip | Astuce + +Faites cela une seule fois lorsque vous installez ou mettez à niveau les packages nécessaires à votre projet. + +Si vous devez mettre à niveau une version ou ajouter un nouveau package, vous le referez. + +/// + +### Installer des packages directement { #install-packages-directly } + +Si vous êtes pressé et ne souhaitez pas utiliser un fichier pour déclarer les dépendances de votre projet, vous pouvez les installer directement. + +/// tip | Astuce + +C’est une très bonne idée de placer les packages et leurs versions nécessaires à votre programme dans un fichier (par exemple `requirements.txt` ou `pyproject.toml`). + +/// + +//// tab | `pip` + +
+ +```console +$ pip install "fastapi[standard]" + +---> 100% +``` + +
+ +//// + +//// tab | `uv` + +Si vous avez `uv` : + +
+ +```console +$ uv pip install "fastapi[standard]" +---> 100% +``` + +
+ +//// + +### Installer depuis `requirements.txt` { #install-from-requirements-txt } + +Si vous avez un `requirements.txt`, vous pouvez maintenant l’utiliser pour installer ses packages. + +//// tab | `pip` + +
+ +```console +$ pip install -r requirements.txt +---> 100% +``` + +
+ +//// + +//// tab | `uv` + +Si vous avez `uv` : + +
+ +```console +$ uv pip install -r requirements.txt +---> 100% +``` + +
+ +//// + +/// details | `requirements.txt` + +Un `requirements.txt` avec quelques packages pourrait ressembler à : + +```requirements.txt +fastapi[standard]==0.113.0 +pydantic==2.8.0 +``` + +/// + +## Exécuter votre programme { #run-your-program } + +Après avoir activé l’environnement virtuel, vous pouvez exécuter votre programme, et il utilisera le Python de votre environnement virtuel avec les packages que vous y avez installés. + +
+ +```console +$ python main.py + +Hello World +``` + +
+ +## Configurer votre éditeur { #configure-your-editor } + +Vous utiliserez probablement un éditeur, assurez-vous de le configurer pour utiliser le même environnement virtuel que vous avez créé (il le détectera probablement automatiquement) afin d’avoir l’autocomplétion et les erreurs inline. + +Par exemple : + +* VS Code +* PyCharm + +/// tip | Astuce + +Vous devez normalement faire cela une seule fois, lorsque vous créez l’environnement virtuel. + +/// + +## Désactiver l’environnement virtuel { #deactivate-the-virtual-environment } + +Une fois que vous avez fini de travailler sur votre projet, vous pouvez désactiver l’environnement virtuel. + +
+ +```console +$ deactivate +``` + +
+ +Ainsi, lorsque vous exécutez `python`, il n’essaiera pas de l’exécuter depuis cet environnement virtuel avec les packages qui y sont installés. + +## Prêt à travailler { #ready-to-work } + +Vous êtes maintenant prêt à commencer à travailler sur votre projet. + + + +/// tip | Astuce + +Voulez-vous comprendre tout ce qui précède ? + +Continuez la lecture. 👇🤓 + +/// + +## Pourquoi des environnements virtuels { #why-virtual-environments } + +Pour travailler avec FastAPI, vous devez installer Python. + +Ensuite, vous devrez installer FastAPI et tout autre package que vous souhaitez utiliser. + +Pour installer des packages, vous utiliseriez normalement la commande `pip` fournie avec Python (ou des alternatives similaires). + +Néanmoins, si vous utilisez simplement `pip` directement, les packages seraient installés dans votre environnement Python global (l’installation globale de Python). + +### Le problème { #the-problem } + +Alors, quel est le problème d’installer des packages dans l’environnement Python global ? + +À un moment donné, vous finirez probablement par écrire de nombreux programmes différents qui dépendent de packages différents. Et certains de ces projets sur lesquels vous travaillez dépendront de versions différentes du même package. 😱 + +Par exemple, vous pourriez créer un projet appelé `philosophers-stone`, ce programme dépend d’un autre package appelé **`harry`, en version `1`**. Vous devez donc installer `harry`. + +```mermaid +flowchart LR + stone(philosophers-stone) -->|requires| harry-1[harry v1] +``` + +Puis, plus tard, vous créez un autre projet appelé `prisoner-of-azkaban`, et ce projet dépend aussi de `harry`, mais il a besoin de **`harry` en version `3`**. + +```mermaid +flowchart LR + azkaban(prisoner-of-azkaban) --> |requires| harry-3[harry v3] +``` + +Mais maintenant, le problème est que, si vous installez les packages globalement (dans l’environnement global) au lieu de dans un environnement virtuel local, vous devrez choisir quelle version de `harry` installer. + +Si vous voulez exécuter `philosophers-stone`, vous devrez d’abord installer `harry` en version `1`, par exemple avec : + +
+ +```console +$ pip install "harry==1" +``` + +
+ +Et vous vous retrouverez avec `harry` en version `1` installé dans votre environnement Python global. + +```mermaid +flowchart LR + subgraph global[global env] + harry-1[harry v1] + end + subgraph stone-project[philosophers-stone project] + stone(philosophers-stone) -->|requires| harry-1 + end +``` + +Mais si vous voulez ensuite exécuter `prisoner-of-azkaban`, vous devrez désinstaller `harry` version `1` et installer `harry` version `3` (ou bien installer la version `3` désinstallerait automatiquement la version `1`). + +
+ +```console +$ pip install "harry==3" +``` + +
+ +Et vous vous retrouverez alors avec `harry` version `3` installé dans votre environnement Python global. + +Et si vous essayez d’exécuter à nouveau `philosophers-stone`, il y a une chance que cela ne fonctionne pas car il a besoin de `harry` version `1`. + +```mermaid +flowchart LR + subgraph global[global env] + harry-1[harry v1] + style harry-1 fill:#ccc,stroke-dasharray: 5 5 + harry-3[harry v3] + end + subgraph stone-project[philosophers-stone project] + stone(philosophers-stone) -.-x|⛔️| harry-1 + end + subgraph azkaban-project[prisoner-of-azkaban project] + azkaban(prisoner-of-azkaban) --> |requires| harry-3 + end +``` + +/// tip | Astuce + +Il est très courant que les packages Python fassent de leur mieux pour éviter les changements cassants dans les nouvelles versions, mais il vaut mieux jouer la sécurité et installer de nouvelles versions intentionnellement et lorsque vous pouvez exécuter les tests pour vérifier que tout fonctionne correctement. + +/// + +Maintenant, imaginez cela avec beaucoup d’autres packages dont tous vos projets dépendent. C’est très difficile à gérer. Et vous finiriez probablement par exécuter certains projets avec des versions incompatibles des packages, sans savoir pourquoi quelque chose ne fonctionne pas. + +De plus, selon votre système d’exploitation (par exemple Linux, Windows, macOS), il se peut qu’il soit livré avec Python déjà installé. Et dans ce cas, il avait probablement des packages préinstallés avec des versions spécifiques nécessaires à votre système. Si vous installez des packages dans l’environnement Python global, vous pourriez finir par casser certains des programmes fournis avec votre système d’exploitation. + +## Où les packages sont-ils installés { #where-are-packages-installed } + +Lorsque vous installez Python, il crée des répertoires avec des fichiers sur votre ordinateur. + +Certains de ces répertoires sont chargés de contenir tous les packages que vous installez. + +Lorsque vous exécutez : + +
+ +```console +// Ne l’exécutez pas maintenant, c’est juste un exemple 🤓 +$ pip install "fastapi[standard]" +---> 100% +``` + +
+ +Cela téléchargera un fichier compressé avec le code de FastAPI, normalement depuis PyPI. + +Il téléchargera également des fichiers pour d’autres packages dont FastAPI dépend. + +Ensuite, il extraira tous ces fichiers et les placera dans un répertoire de votre ordinateur. + +Par défaut, il placera ces fichiers téléchargés et extraits dans le répertoire fourni avec votre installation de Python, c’est l’environnement global. + +## Qu’est-ce qu’un environnement virtuel { #what-are-virtual-environments } + +La solution aux problèmes posés par le fait d’avoir tous les packages dans l’environnement global est d’utiliser un environnement virtuel pour chaque projet sur lequel vous travaillez. + +Un environnement virtuel est un répertoire, très similaire à celui global, où vous pouvez installer les packages pour un projet. + +De cette manière, chaque projet aura son propre environnement virtuel (répertoire `.venv`) avec ses propres packages. + +```mermaid +flowchart TB + subgraph stone-project[philosophers-stone project] + stone(philosophers-stone) --->|requires| harry-1 + subgraph venv1[.venv] + harry-1[harry v1] + end + end + subgraph azkaban-project[prisoner-of-azkaban project] + azkaban(prisoner-of-azkaban) --->|requires| harry-3 + subgraph venv2[.venv] + harry-3[harry v3] + end + end + stone-project ~~~ azkaban-project +``` + +## Que signifie activer un environnement virtuel { #what-does-activating-a-virtual-environment-mean } + +Lorsque vous activez un environnement virtuel, par exemple avec : + +//// tab | Linux, macOS + +
+ +```console +$ source .venv/bin/activate +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +$ .venv\Scripts\Activate.ps1 +``` + +
+ +//// + +//// tab | Windows Bash + +Ou si vous utilisez Bash pour Windows (par exemple Git Bash) : + +
+ +```console +$ source .venv/Scripts/activate +``` + +
+ +//// + +Cette commande créera ou modifiera certaines [variables d’environnement](environment-variables.md){.internal-link target=_blank} qui seront disponibles pour les prochaines commandes. + +L’une de ces variables est la variable `PATH`. + +/// tip | Astuce + +Vous pouvez en savoir plus sur la variable d’environnement `PATH` dans la section [Variables d’environnement](environment-variables.md#path-environment-variable){.internal-link target=_blank}. + +/// + +Activer un environnement virtuel ajoute son chemin `.venv/bin` (sur Linux et macOS) ou `.venv\Scripts` (sur Windows) à la variable d’environnement `PATH`. + +Disons qu’avant d’activer l’environnement, la variable `PATH` ressemblait à ceci : + +//// tab | Linux, macOS + +```plaintext +/usr/bin:/bin:/usr/sbin:/sbin +``` + +Cela signifie que le système chercherait des programmes dans : + +* `/usr/bin` +* `/bin` +* `/usr/sbin` +* `/sbin` + +//// + +//// tab | Windows + +```plaintext +C:\Windows\System32 +``` + +Cela signifie que le système chercherait des programmes dans : + +* `C:\Windows\System32` + +//// + +Après avoir activé l’environnement virtuel, la variable `PATH` ressemblerait à quelque chose comme ceci : + +//// tab | Linux, macOS + +```plaintext +/home/user/code/awesome-project/.venv/bin:/usr/bin:/bin:/usr/sbin:/sbin +``` + +Cela signifie que le système commencera maintenant par chercher des programmes dans : + +```plaintext +/home/user/code/awesome-project/.venv/bin +``` + +avant de chercher dans les autres répertoires. + +Ainsi, lorsque vous tapez `python` dans le terminal, le système trouvera le programme Python dans + +```plaintext +/home/user/code/awesome-project/.venv/bin/python +``` + +et utilisera celui-ci. + +//// + +//// tab | Windows + +```plaintext +C:\Users\user\code\awesome-project\.venv\Scripts;C:\Windows\System32 +``` + +Cela signifie que le système commencera maintenant par chercher des programmes dans : + +```plaintext +C:\Users\user\code\awesome-project\.venv\Scripts +``` + +avant de chercher dans les autres répertoires. + +Ainsi, lorsque vous tapez `python` dans le terminal, le système trouvera le programme Python dans + +```plaintext +C:\Users\user\code\awesome-project\.venv\Scripts\python +``` + +et utilisera celui-ci. + +//// + +Un détail important est qu’il placera le chemin de l’environnement virtuel au début de la variable `PATH`. Le système le trouvera avant de trouver tout autre Python disponible. Ainsi, lorsque vous exécutez `python`, il utilisera le Python de l’environnement virtuel au lieu de tout autre `python` (par exemple, un `python` d’un environnement global). + +Activer un environnement virtuel change aussi deux ou trois autres choses, mais c’est l’un des points les plus importants. + +## Vérifier un environnement virtuel { #checking-a-virtual-environment } + +Lorsque vous vérifiez si un environnement virtuel est actif, par exemple avec : + +//// tab | Linux, macOS, Windows Bash + +
+ +```console +$ which python + +/home/user/code/awesome-project/.venv/bin/python +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +$ Get-Command python + +C:\Users\user\code\awesome-project\.venv\Scripts\python +``` + +
+ +//// + +Cela signifie que le programme `python` qui sera utilisé est celui dans l’environnement virtuel. + +Vous utilisez `which` sous Linux et macOS et `Get-Command` sous Windows PowerShell. + +La façon dont cette commande fonctionne est qu’elle va vérifier la variable d’environnement `PATH`, en parcourant chaque chemin dans l’ordre, à la recherche du programme nommé `python`. Une fois trouvé, elle vous affichera le chemin vers ce programme. + +La partie la plus importante est que lorsque vous appelez `python`, c’est exactement « `python` » qui sera exécuté. + +Ainsi, vous pouvez confirmer si vous êtes dans le bon environnement virtuel. + +/// tip | Astuce + +Il est facile d’activer un environnement virtuel, d’obtenir un Python, puis d’aller vers un autre projet. + +Et le second projet ne fonctionnerait pas parce que vous utilisez le Python incorrect, provenant d’un environnement virtuel d’un autre projet. + +Il est utile de pouvoir vérifier quel `python` est utilisé. 🤓 + +/// + +## Pourquoi désactiver un environnement virtuel { #why-deactivate-a-virtual-environment } + +Par exemple, vous pourriez travailler sur un projet `philosophers-stone`, activer cet environnement virtuel, installer des packages et travailler avec cet environnement. + +Puis vous souhaitez travailler sur un autre projet `prisoner-of-azkaban`. + +Vous allez vers ce projet : + +
+ +```console +$ cd ~/code/prisoner-of-azkaban +``` + +
+ +Si vous ne désactivez pas l’environnement virtuel de `philosophers-stone`, lorsque vous exécutez `python` dans le terminal, il essaiera d’utiliser le Python de `philosophers-stone`. + +
+ +```console +$ cd ~/code/prisoner-of-azkaban + +$ python main.py + +// Erreur lors de l'import de sirius, il n'est pas installé 😱 +Traceback (most recent call last): + File "main.py", line 1, in + import sirius +``` + +
+ +Mais si vous désactivez l’environnement virtuel et activez le nouveau pour `prisoner-of-askaban`, alors lorsque vous exécuterez `python`, il utilisera le Python de l’environnement virtuel de `prisoner-of-azkaban`. + +
+ +```console +$ cd ~/code/prisoner-of-azkaban + +// Vous n’avez pas besoin d’être dans l’ancien répertoire pour désactiver, vous pouvez le faire où que vous soyez, même après être allé dans l’autre projet 😎 +$ deactivate + +// Activer l’environnement virtuel dans prisoner-of-azkaban/.venv 🚀 +$ source .venv/bin/activate + +// Maintenant, lorsque vous exécutez python, il trouvera le package sirius installé dans cet environnement virtuel ✨ +$ python main.py + +I solemnly swear 🐺 +``` + +
+ +## Alternatives { #alternatives } + +Ceci est un guide simple pour vous lancer et vous montrer comment tout fonctionne en dessous. + +Il existe de nombreuses alternatives pour gérer les environnements virtuels, les dépendances de packages (requirements), les projets. + +Lorsque vous êtes prêt et souhaitez utiliser un outil pour gérer l’ensemble du projet, les dépendances, les environnements virtuels, etc., je vous suggère d’essayer uv. + +`uv` peut faire beaucoup de choses, il peut : + +* Installer Python pour vous, y compris différentes versions +* Gérer l’environnement virtuel pour vos projets +* Installer des packages +* Gérer les dépendances de packages et leurs versions pour votre projet +* Vous assurer d’avoir un ensemble exact de packages et de versions à installer, y compris leurs dépendances, afin que vous puissiez être certain d’exécuter votre projet en production exactement comme sur votre ordinateur pendant le développement, cela s’appelle le locking +* Et bien d’autres choses + +## Conclusion { #conclusion } + +Si vous avez lu et compris tout cela, vous en savez maintenant bien plus sur les environnements virtuels que beaucoup de développeurs. 🤓 + +Connaître ces détails vous sera très probablement utile à l’avenir lorsque vous déboguerez quelque chose qui semble complexe, mais vous saurez comment tout fonctionne en dessous. 😎 diff --git a/docs/ko/docs/_llm-test.md b/docs/ko/docs/_llm-test.md index 272af763a5..92bfb83f62 100644 --- a/docs/ko/docs/_llm-test.md +++ b/docs/ko/docs/_llm-test.md @@ -35,7 +35,7 @@ //// tab | 테스트 -어제 제 친구가 이렇게 썼습니다: "If you spell incorrectly correctly, you have spelled it incorrectly". 이에 저는 이렇게 답했습니다: "Correct, but 'incorrectly' is incorrectly not '"incorrectly"'"". +어제 제 친구가 이렇게 썼습니다: "If you spell incorrectly correctly, you have spelled it incorrectly". 이에 저는 이렇게 답했습니다: "Correct, but 'incorrectly' is incorrectly not '"incorrectly"'". /// note | 참고 @@ -256,15 +256,15 @@ works(foo="bar") # 이건 동작합니다 🎉 //// tab | 테스트 -* 당신 -* 당신의 +* 여러분 +* 여러분의 * 예: (e.g.) * 등 (etc.) -* `int`로서의 `foo` -* `str`로서의 `bar` -* `list`로서의 `baz` +* `foo`로서의 `int` +* `bar`로서의 `str` +* `baz`로서의 `list` * 튜토리얼 - 사용자 가이드 * 고급 사용자 가이드 diff --git a/docs/ko/docs/advanced/additional-responses.md b/docs/ko/docs/advanced/additional-responses.md index a6f51f5b93..2ed6bc3fcf 100644 --- a/docs/ko/docs/advanced/additional-responses.md +++ b/docs/ko/docs/advanced/additional-responses.md @@ -26,7 +26,7 @@ 예를 들어, 상태 코드 `404`와 Pydantic 모델 `Message`를 사용하는 다른 응답을 선언하려면 다음과 같이 작성할 수 있습니다: -{* ../../docs_src/additional_responses/tutorial001_py39.py hl[18,22] *} +{* ../../docs_src/additional_responses/tutorial001_py310.py hl[18,22] *} /// note | 참고 @@ -203,7 +203,7 @@ 또한 `response_model`을 사용하는 상태 코드 `200` 응답을 선언하되, 커스텀 `example`을 포함할 수도 있습니다: -{* ../../docs_src/additional_responses/tutorial003_py39.py hl[20:31] *} +{* ../../docs_src/additional_responses/tutorial003_py310.py hl[20:31] *} 이 모든 내용은 OpenAPI에 결합되어 포함되고, API 문서에 표시됩니다: diff --git a/docs/ko/docs/advanced/additional-status-codes.md b/docs/ko/docs/advanced/additional-status-codes.md index 64a7eabd5e..e3c898044e 100644 --- a/docs/ko/docs/advanced/additional-status-codes.md +++ b/docs/ko/docs/advanced/additional-status-codes.md @@ -1,14 +1,14 @@ # 추가 상태 코드 { #additional-status-codes } -기본적으로 **FastAPI**는 응답을 `JSONResponse`를 사용하여 반환하며, *경로 작업(path operation)*에서 반환한 내용을 해당 `JSONResponse` 안에 넣어 반환합니다. +기본적으로 **FastAPI**는 응답을 `JSONResponse`를 사용하여 반환하며, *경로 처리*에서 반환한 내용을 해당 `JSONResponse` 안에 넣어 반환합니다. -기본 상태 코드 또는 *경로 작업*에서 설정한 상태 코드를 사용합니다. +기본 상태 코드 또는 *경로 처리*에서 설정한 상태 코드를 사용합니다. ## 추가 상태 코드 { #additional-status-codes_1 } 기본 상태 코드와 별도로 추가 상태 코드를 반환하려면 `JSONResponse`와 같이 `Response`를 직접 반환하고 추가 상태 코드를 직접 설정할 수 있습니다. -예를 들어 항목을 업데이트할 수 있는 *경로 작업*이 있고 성공 시 200 “OK”의 HTTP 상태 코드를 반환한다고 가정해 보겠습니다. +예를 들어 항목을 업데이트할 수 있는 *경로 처리*가 있고 성공 시 200 “OK”의 HTTP 상태 코드를 반환한다고 가정해 보겠습니다. 하지만 새로운 항목을 허용하기를 원할 것입니다. 그리고 항목이 이전에 존재하지 않았다면 이를 생성하고 HTTP 상태 코드 201 "Created"를 반환합니다. @@ -16,7 +16,7 @@ {* ../../docs_src/additional_status_codes/tutorial001_an_py310.py hl[4,25] *} -/// warning | 경고 +/// warning 위의 예제처럼 `Response`를 직접 반환하면 바로 반환됩니다. diff --git a/docs/ko/docs/advanced/advanced-dependencies.md b/docs/ko/docs/advanced/advanced-dependencies.md index fe16062586..eb5d35d957 100644 --- a/docs/ko/docs/advanced/advanced-dependencies.md +++ b/docs/ko/docs/advanced/advanced-dependencies.md @@ -18,7 +18,7 @@ Python에는 클래스의 인스턴스를 "호출 가능"하게 만드는 방법 이를 위해 `__call__` 메서드를 선언합니다: -{* ../../docs_src/dependencies/tutorial011_an_py39.py hl[12] *} +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[12] *} 이 경우, **FastAPI**는 추가 매개변수와 하위 의존성을 확인하기 위해 `__call__`을 사용하게 되며, 나중에 *경로 처리 함수*에서 매개변수에 값을 전달할 때 이를 호출하게 됩니다. @@ -27,7 +27,7 @@ Python에는 클래스의 인스턴스를 "호출 가능"하게 만드는 방법 이제 `__init__`을 사용하여 의존성을 "매개변수화"할 수 있는 인스턴스의 매개변수를 선언할 수 있습니다: -{* ../../docs_src/dependencies/tutorial011_an_py39.py hl[9] *} +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[9] *} 이 경우, **FastAPI**는 `__init__`에 전혀 관여하지 않으며, 우리는 이 메서드를 코드에서 직접 사용하게 됩니다. @@ -35,7 +35,7 @@ Python에는 클래스의 인스턴스를 "호출 가능"하게 만드는 방법 다음과 같이 이 클래스의 인스턴스를 생성할 수 있습니다: -{* ../../docs_src/dependencies/tutorial011_an_py39.py hl[18] *} +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[18] *} 이렇게 하면 `checker.fixed_content` 속성에 `"bar"`라는 값을 담아 의존성을 "매개변수화"할 수 있습니다. @@ -51,7 +51,7 @@ checker(q="somequery") ...그리고 이때 반환되는 값을 *경로 처리 함수*의 의존성 값으로, `fixed_content_included` 매개변수에 전달합니다: -{* ../../docs_src/dependencies/tutorial011_an_py39.py hl[22] *} +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[22] *} /// tip | 팁 diff --git a/docs/ko/docs/advanced/advanced-python-types.md b/docs/ko/docs/advanced/advanced-python-types.md new file mode 100644 index 0000000000..0bd8aa5433 --- /dev/null +++ b/docs/ko/docs/advanced/advanced-python-types.md @@ -0,0 +1,61 @@ +# 고급 Python 타입 { #advanced-python-types } + +Python 타입을 다룰 때 유용할 수 있는 몇 가지 추가 아이디어를 소개합니다. + +## `Union` 또는 `Optional` 사용 { #using-union-or-optional } + +어떤 이유로 코드에서 `|`를 사용할 수 없다면, 예를 들어 타입 어노테이션이 아니라 `response_model=` 같은 곳이라면, 파이프 문자(`|`) 대신 `typing`의 `Union`을 사용할 수 있습니다. + +예를 들어, 어떤 값이 `str` 또는 `None`이 될 수 있다고 선언할 수 있습니다: + +```python +from typing import Union + + +def say_hi(name: Union[str, None]): + print(f"Hi {name}!") +``` + +`typing`에는 `None`이 될 수 있음을 선언하는 축약형으로 `Optional`도 있습니다. + +아주 개인적인 관점에서의 팁입니다: + +- 🚨 `Optional[SomeType]` 사용은 피하세요 +- 대신 ✨ **`Union[SomeType, None]`를 사용하세요** ✨. + +둘은 동등하며 내부적으로도 같습니다. 하지만 단어 "optional"은 값이 선택 사항이라는 인상을 주는 반면, 실제 의미는 "값이 `None`이 될 수 있다"는 뜻입니다. 값이 선택 사항이 아니라 여전히 필수인 경우에도 그렇습니다. + +`Union[SomeType, None]`가 의미를 더 명확하게 드러낸다고 생각합니다. + +이는 단지 단어와 명칭의 문제입니다. 하지만 이런 단어가 여러분과 팀원이 코드를 어떻게 생각하는지에 영향을 줄 수 있습니다. + +예를 들어, 다음 함수를 보세요: + +```python +from typing import Optional + + +def say_hi(name: Optional[str]): + print(f"Hey {name}!") +``` + +매개변수 `name`은 `Optional[str]`로 정의되어 있지만, 사실 선택적이지 않습니다. 이 매개변수 없이 함수를 호출할 수 없습니다: + +```Python +say_hi() # 이런, 에러가 발생합니다! 😱 +``` + +`name` 매개변수는 기본값이 없기 때문에 여전히 필수입니다(선택적이 아님). 대신, `name`에는 `None`을 전달할 수 있습니다: + +```Python +say_hi(name=None) # 작동합니다. None은 유효합니다 🎉 +``` + +좋은 소식은, 대부분의 경우 타입의 합집합을 정의할 때 그냥 `|`를 사용할 수 있다는 점입니다: + +```python +def say_hi(name: str | None): + print(f"Hey {name}!") +``` + +그래서 보통은 `Optional`과 `Union` 같은 이름에 대해 걱정하지 않으셔도 됩니다. 😎 diff --git a/docs/ko/docs/advanced/async-tests.md b/docs/ko/docs/advanced/async-tests.md index 6c85936812..0479ac41d1 100644 --- a/docs/ko/docs/advanced/async-tests.md +++ b/docs/ko/docs/advanced/async-tests.md @@ -32,11 +32,11 @@ `main.py` 파일은 다음과 같습니다: -{* ../../docs_src/async_tests/app_a_py39/main.py *} +{* ../../docs_src/async_tests/app_a_py310/main.py *} `test_main.py` 파일에는 `main.py`에 대한 테스트가 있으며, 이제 다음과 같이 보일 수 있습니다: -{* ../../docs_src/async_tests/app_a_py39/test_main.py *} +{* ../../docs_src/async_tests/app_a_py310/test_main.py *} ## 실행하기 { #run-it } @@ -56,7 +56,7 @@ $ pytest `@pytest.mark.anyio` 마커는 pytest에게 이 테스트 함수가 비동기로 호출되어야 한다고 알려줍니다: -{* ../../docs_src/async_tests/app_a_py39/test_main.py hl[7] *} +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[7] *} /// tip | 팁 @@ -66,7 +66,7 @@ $ pytest 그 다음 앱으로 `AsyncClient`를 만들고, `await`를 사용해 비동기 요청을 보낼 수 있습니다. -{* ../../docs_src/async_tests/app_a_py39/test_main.py hl[9:12] *} +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[9:12] *} 이는 다음과 동등합니다: diff --git a/docs/ko/docs/advanced/behind-a-proxy.md b/docs/ko/docs/advanced/behind-a-proxy.md index 92bddac51a..825592c060 100644 --- a/docs/ko/docs/advanced/behind-a-proxy.md +++ b/docs/ko/docs/advanced/behind-a-proxy.md @@ -44,7 +44,7 @@ $ fastapi run --forwarded-allow-ips="*" 예를 들어, *경로 처리* `/items/`를 정의했다고 해봅시다: -{* ../../docs_src/behind_a_proxy/tutorial001_01_py39.py hl[6] *} +{* ../../docs_src/behind_a_proxy/tutorial001_01_py310.py hl[6] *} 클라이언트가 `/items`로 접근하면, 기본적으로 `/items/`로 리디렉션됩니다. @@ -115,7 +115,7 @@ sequenceDiagram 코드는 모두 `/app`만 있다고 가정하고 작성되어 있는데도 말입니다. -{* ../../docs_src/behind_a_proxy/tutorial001_py39.py hl[6] *} +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[6] *} 그리고 프록시는 요청을 앱 서버(아마 FastAPI CLI를 통해 실행되는 Uvicorn)로 전달하기 전에, 동적으로 **경로 접두사**를 **"제거"**합니다. 그래서 애플리케이션은 여전히 `/app`에서 서비스된다고 믿게 되고, 코드 전체를 `/api/v1` 접두사를 포함하도록 수정할 필요가 없어집니다. @@ -193,7 +193,7 @@ ASGI 사양은 이 사용 사례를 위해 `root_path`를 정의합니다. 여기서는 데모 목적을 위해 메시지에 포함하고 있습니다. -{* ../../docs_src/behind_a_proxy/tutorial001_py39.py hl[8] *} +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[8] *} 그 다음 Uvicorn을 다음과 같이 시작하면: @@ -220,7 +220,7 @@ $ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 또는 `--root-path` 같은 커맨드 라인 옵션(또는 동등한 방법)을 제공할 수 없는 경우, FastAPI 앱을 생성할 때 `root_path` 파라미터를 설정할 수 있습니다: -{* ../../docs_src/behind_a_proxy/tutorial002_py39.py hl[3] *} +{* ../../docs_src/behind_a_proxy/tutorial002_py310.py hl[3] *} `FastAPI`에 `root_path`를 전달하는 것은 Uvicorn이나 Hypercorn에 커맨드 라인 옵션 `--root-path`를 전달하는 것과 동일합니다. @@ -400,7 +400,7 @@ $ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 예: -{* ../../docs_src/behind_a_proxy/tutorial003_py39.py hl[4:7] *} +{* ../../docs_src/behind_a_proxy/tutorial003_py310.py hl[4:7] *} 다음과 같은 OpenAPI 스키마를 생성합니다: @@ -455,7 +455,7 @@ OpenAPI 사양에서 `servers` 속성은 선택 사항입니다. **FastAPI**가 `root_path`를 사용한 자동 server를 포함하지 않게 하려면, `root_path_in_servers=False` 파라미터를 사용할 수 있습니다: -{* ../../docs_src/behind_a_proxy/tutorial004_py39.py hl[9] *} +{* ../../docs_src/behind_a_proxy/tutorial004_py310.py hl[9] *} 그러면 OpenAPI 스키마에 포함되지 않습니다. diff --git a/docs/ko/docs/advanced/custom-response.md b/docs/ko/docs/advanced/custom-response.md index 55dc2a4be1..6d54eaf2b1 100644 --- a/docs/ko/docs/advanced/custom-response.md +++ b/docs/ko/docs/advanced/custom-response.md @@ -30,7 +30,7 @@ 하지만 반환하는 내용이 **JSON으로 직렬화 가능**하다고 확신하는 경우, 해당 내용을 응답 클래스에 직접 전달할 수 있으며, FastAPI가 반환 내용을 `jsonable_encoder`를 통해 처리한 뒤 응답 클래스에 전달하는 오버헤드를 피할 수 있습니다. -{* ../../docs_src/custom_response/tutorial001b_py39.py hl[2,7] *} +{* ../../docs_src/custom_response/tutorial001b_py310.py hl[2,7] *} /// info | 정보 @@ -55,7 +55,7 @@ * `HTMLResponse`를 임포트 합니다. * *경로 처리 데코레이터*의 `response_class` 매개변수로 `HTMLResponse`를 전달합니다. -{* ../../docs_src/custom_response/tutorial002_py39.py hl[2,7] *} +{* ../../docs_src/custom_response/tutorial002_py310.py hl[2,7] *} /// info | 정보 @@ -73,7 +73,7 @@ 위의 예제와 동일하게 `HTMLResponse`를 반환하는 코드는 다음과 같을 수 있습니다: -{* ../../docs_src/custom_response/tutorial003_py39.py hl[2,7,19] *} +{* ../../docs_src/custom_response/tutorial003_py310.py hl[2,7,19] *} /// warning | 경고 @@ -97,7 +97,7 @@ 예를 들어, 다음과 같이 작성할 수 있습니다: -{* ../../docs_src/custom_response/tutorial004_py39.py hl[7,21,23] *} +{* ../../docs_src/custom_response/tutorial004_py310.py hl[7,21,23] *} 이 예제에서, `generate_html_response()` 함수는 HTML을 `str`로 반환하는 대신 이미 `Response`를 생성하고 반환합니다. @@ -136,7 +136,7 @@ FastAPI (실제로는 Starlette)가 자동으로 Content-Length 헤더를 포함시킵니다. 또한 `media_type`에 기반하여 Content-Type 헤더를 포함하며, 텍스트 타입의 경우 문자 집합을 추가 합니다. -{* ../../docs_src/response_directly/tutorial002_py39.py hl[1,18] *} +{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *} ### `HTMLResponse` { #htmlresponse } @@ -146,7 +146,7 @@ FastAPI (실제로는 Starlette)가 자동으로 Content-Length 헤더를 포함 텍스트 또는 바이트를 받아 일반 텍스트 응답을 반환합니다. -{* ../../docs_src/custom_response/tutorial005_py39.py hl[2,7,9] *} +{* ../../docs_src/custom_response/tutorial005_py310.py hl[2,7,9] *} ### `JSONResponse` { #jsonresponse } @@ -180,7 +180,7 @@ FastAPI (실제로는 Starlette)가 자동으로 Content-Length 헤더를 포함 /// -{* ../../docs_src/custom_response/tutorial001_py39.py hl[2,7] *} +{* ../../docs_src/custom_response/tutorial001_py310.py hl[2,7] *} /// tip | 팁 @@ -194,14 +194,14 @@ HTTP 리디렉션 응답을 반환합니다. 기본적으로 상태 코드는 30 `RedirectResponse`를 직접 반환할 수 있습니다. -{* ../../docs_src/custom_response/tutorial006_py39.py hl[2,9] *} +{* ../../docs_src/custom_response/tutorial006_py310.py hl[2,9] *} --- 또는 `response_class` 매개변수에서 사용할 수도 있습니다: -{* ../../docs_src/custom_response/tutorial006b_py39.py hl[2,7,9] *} +{* ../../docs_src/custom_response/tutorial006b_py310.py hl[2,7,9] *} 이 경우, *경로 처리* 함수에서 URL을 직접 반환할 수 있습니다. @@ -211,13 +211,13 @@ HTTP 리디렉션 응답을 반환합니다. 기본적으로 상태 코드는 30 `status_code` 매개변수를 `response_class` 매개변수와 함께 사용할 수도 있습니다: -{* ../../docs_src/custom_response/tutorial006c_py39.py hl[2,7,9] *} +{* ../../docs_src/custom_response/tutorial006c_py310.py hl[2,7,9] *} ### `StreamingResponse` { #streamingresponse } 비동기 제너레이터 또는 일반 제너레이터/이터레이터를 받아 응답 본문을 스트리밍 합니다. -{* ../../docs_src/custom_response/tutorial007_py39.py hl[2,14] *} +{* ../../docs_src/custom_response/tutorial007_py310.py hl[2,14] *} #### 파일과 같은 객체를 사용한 `StreamingResponse` { #using-streamingresponse-with-file-like-objects } @@ -227,7 +227,7 @@ HTTP 리디렉션 응답을 반환합니다. 기본적으로 상태 코드는 30 이 방식은 클라우드 스토리지, 비디오 처리 등의 다양한 라이브러리와 함께 사용할 수 있습니다. -{* ../../docs_src/custom_response/tutorial008_py39.py hl[2,10:12,14] *} +{* ../../docs_src/custom_response/tutorial008_py310.py hl[2,10:12,14] *} 1. 이것이 제너레이터 함수입니다. `yield` 문을 포함하고 있으므로 "제너레이터 함수"입니다. 2. `with` 블록을 사용함으로써, 제너레이터 함수가 완료된 후 파일과 같은 객체가 닫히도록 합니다. 즉, 응답 전송이 끝난 후 닫힙니다. @@ -256,11 +256,11 @@ HTTP 리디렉션 응답을 반환합니다. 기본적으로 상태 코드는 30 파일 응답에는 적절한 `Content-Length`, `Last-Modified`, 및 `ETag` 헤더가 포함됩니다. -{* ../../docs_src/custom_response/tutorial009_py39.py hl[2,10] *} +{* ../../docs_src/custom_response/tutorial009_py310.py hl[2,10] *} 또한 `response_class` 매개변수를 사용할 수도 있습니다: -{* ../../docs_src/custom_response/tutorial009b_py39.py hl[2,8,10] *} +{* ../../docs_src/custom_response/tutorial009b_py310.py hl[2,8,10] *} 이 경우, 경로 처리 함수에서 파일 경로를 직접 반환할 수 있습니다. @@ -274,7 +274,7 @@ HTTP 리디렉션 응답을 반환합니다. 기본적으로 상태 코드는 30 `CustomORJSONResponse`를 생성할 수 있습니다. 여기서 핵심은 `Response.render(content)` 메서드를 생성하여 내용을 `bytes`로 반환하는 것입니다: -{* ../../docs_src/custom_response/tutorial009c_py39.py hl[9:14,17] *} +{* ../../docs_src/custom_response/tutorial009c_py310.py hl[9:14,17] *} 이제 다음 대신: @@ -300,7 +300,7 @@ HTTP 리디렉션 응답을 반환합니다. 기본적으로 상태 코드는 30 아래 예제에서 **FastAPI**는 모든 *경로 처리*에서 기본적으로 `JSONResponse` 대신 `ORJSONResponse`를 사용합니다. -{* ../../docs_src/custom_response/tutorial010_py39.py hl[2,4] *} +{* ../../docs_src/custom_response/tutorial010_py310.py hl[2,4] *} /// tip | 팁 diff --git a/docs/ko/docs/advanced/dataclasses.md b/docs/ko/docs/advanced/dataclasses.md index 92ad5545b3..0210812b6e 100644 --- a/docs/ko/docs/advanced/dataclasses.md +++ b/docs/ko/docs/advanced/dataclasses.md @@ -64,7 +64,7 @@ dataclass는 자동으로 Pydantic dataclass로 변환됩니다. 6. 여기서는 dataclasses 리스트인 `items`를 포함하는 딕셔너리를 반환합니다. - FastAPI는 여전히 데이터를 JSON으로 serializing할 수 있습니다. + FastAPI는 여전히 데이터를 JSON으로 직렬화할 수 있습니다. 7. 여기서 `response_model`은 `Author` dataclasses 리스트에 대한 타입 애너테이션을 사용합니다. diff --git a/docs/ko/docs/advanced/events.md b/docs/ko/docs/advanced/events.md index 35223eaf39..f1dd8397a0 100644 --- a/docs/ko/docs/advanced/events.md +++ b/docs/ko/docs/advanced/events.md @@ -30,7 +30,7 @@ `yield`를 사용해 비동기 함수 `lifespan()`을 다음과 같이 생성합니다: -{* ../../docs_src/events/tutorial003_py39.py hl[16,19] *} +{* ../../docs_src/events/tutorial003_py310.py hl[16,19] *} 여기서는 `yield` 이전에 (가짜) 모델 함수를 머신러닝 모델이 들어 있는 딕셔너리에 넣어 모델을 로드하는 비용이 큰 *시작* 작업을 시뮬레이션합니다. 이 코드는 애플리케이션이 **요청을 받기 시작하기 전**, *시작* 동안에 실행됩니다. @@ -48,7 +48,7 @@ 먼저 주목할 점은 `yield`를 사용하여 비동기 함수를 정의하고 있다는 것입니다. 이는 `yield`를 사용하는 의존성과 매우 유사합니다. -{* ../../docs_src/events/tutorial003_py39.py hl[14:19] *} +{* ../../docs_src/events/tutorial003_py310.py hl[14:19] *} 함수의 첫 번째 부분, 즉 `yield` 이전의 코드는 애플리케이션이 시작되기 **전에** 실행됩니다. @@ -60,7 +60,7 @@ 이는 함수를 "**비동기 컨텍스트 매니저**"라고 불리는 것으로 변환합니다. -{* ../../docs_src/events/tutorial003_py39.py hl[1,13] *} +{* ../../docs_src/events/tutorial003_py310.py hl[1,13] *} 파이썬에서 **컨텍스트 매니저**는 `with` 문에서 사용할 수 있는 것입니다. 예를 들어, `open()`은 컨텍스트 매니저로 사용할 수 있습니다: @@ -82,7 +82,7 @@ async with lifespan(app): `FastAPI` 앱의 `lifespan` 매개변수는 **비동기 컨텍스트 매니저**를 받으므로, 새 `lifespan` 비동기 컨텍스트 매니저를 전달할 수 있습니다. -{* ../../docs_src/events/tutorial003_py39.py hl[22] *} +{* ../../docs_src/events/tutorial003_py310.py hl[22] *} ## 대체 이벤트(사용 중단) { #alternative-events-deprecated } @@ -104,7 +104,7 @@ async with lifespan(app): 애플리케이션이 시작되기 전에 실행되어야 하는 함수를 추가하려면, `"startup"` 이벤트로 선언합니다: -{* ../../docs_src/events/tutorial001_py39.py hl[8] *} +{* ../../docs_src/events/tutorial001_py310.py hl[8] *} 이 경우, `startup` 이벤트 핸들러 함수는 "database"(그냥 `dict`) 항목을 일부 값으로 초기화합니다. @@ -116,7 +116,7 @@ async with lifespan(app): 애플리케이션이 종료될 때 실행되어야 하는 함수를 추가하려면, `"shutdown"` 이벤트로 선언합니다: -{* ../../docs_src/events/tutorial002_py39.py hl[6] *} +{* ../../docs_src/events/tutorial002_py310.py hl[6] *} 여기서 `shutdown` 이벤트 핸들러 함수는 텍스트 한 줄 `"Application shutdown"`을 `log.txt` 파일에 기록합니다. diff --git a/docs/ko/docs/advanced/generate-clients.md b/docs/ko/docs/advanced/generate-clients.md index 1def3efe12..3cfbb75784 100644 --- a/docs/ko/docs/advanced/generate-clients.md +++ b/docs/ko/docs/advanced/generate-clients.md @@ -40,7 +40,7 @@ FastAPI는 **OpenAPI 3.1** 사양을 자동으로 생성하므로, 사용하는 간단한 FastAPI 애플리케이션으로 시작해 보겠습니다: -{* ../../docs_src/generate_clients/tutorial001_py39.py hl[7:9,12:13,16:17,21] *} +{* ../../docs_src/generate_clients/tutorial001_py310.py hl[7:9,12:13,16:17,21] *} *path operation*에서 요청 페이로드와 응답 페이로드에 사용하는 모델을 `Item`, `ResponseMessage` 모델로 정의하고 있다는 점에 주목하세요. @@ -98,7 +98,7 @@ npx @hey-api/openapi-ts -i http://localhost:8000/openapi.json -o src/client 예를 들어 **items** 섹션과 **users** 섹션이 있고, 이를 태그로 분리할 수 있습니다: -{* ../../docs_src/generate_clients/tutorial002_py39.py hl[21,26,34] *} +{* ../../docs_src/generate_clients/tutorial002_py310.py hl[21,26,34] *} ### 태그로 TypeScript 클라이언트 생성하기 { #generate-a-typescript-client-with-tags } @@ -145,7 +145,7 @@ FastAPI는 각 *path operation*에 대해 **유일 ID**를 사용하며, 이는 그 다음 이 커스텀 함수를 `generate_unique_id_function` 매개변수로 **FastAPI**에 전달할 수 있습니다: -{* ../../docs_src/generate_clients/tutorial003_py39.py hl[6:7,10] *} +{* ../../docs_src/generate_clients/tutorial003_py310.py hl[6:7,10] *} ### 커스텀 Operation ID로 TypeScript 클라이언트 생성하기 { #generate-a-typescript-client-with-custom-operation-ids } @@ -167,7 +167,7 @@ OpenAPI 전반에서는 operation ID가 **유일**하다는 것을 보장하기 OpenAPI JSON을 `openapi.json` 파일로 다운로드한 뒤, 아래와 같은 스크립트로 **접두사 태그를 제거**할 수 있습니다: -{* ../../docs_src/generate_clients/tutorial004_py39.py *} +{* ../../docs_src/generate_clients/tutorial004_py310.py *} //// tab | Node.js diff --git a/docs/ko/docs/advanced/index.md b/docs/ko/docs/advanced/index.md index 78ef5ffece..6212a7279c 100644 --- a/docs/ko/docs/advanced/index.md +++ b/docs/ko/docs/advanced/index.md @@ -1,4 +1,4 @@ -# 심화 사용자 안내서 - 도입부 { #advanced-user-guide } +# 심화 사용자 안내서 { #advanced-user-guide } ## 추가 기능 { #additional-features } diff --git a/docs/ko/docs/advanced/middleware.md b/docs/ko/docs/advanced/middleware.md index be2c972a6b..f6f7bbc966 100644 --- a/docs/ko/docs/advanced/middleware.md +++ b/docs/ko/docs/advanced/middleware.md @@ -8,7 +8,7 @@ ## ASGI middleware 추가하기 { #adding-asgi-middlewares } -**FastAPI**는 Starlette를 기반으로 하고 ASGI 사양을 구현하므로, 어떤 ASGI middleware든 사용할 수 있습니다. +**FastAPI**는 Starlette를 기반으로 하고 ASGI 사양을 구현하므로, 어떤 ASGI middleware든 사용할 수 있습니다. ASGI 사양을 따르기만 하면, FastAPI나 Starlette를 위해 만들어진 middleware가 아니어도 동작합니다. @@ -57,13 +57,13 @@ app.add_middleware(UnicornMiddleware, some_config="rainbow") `http` 또는 `ws`로 들어오는 모든 요청은 대신 보안 스킴으로 리디렉션됩니다. -{* ../../docs_src/advanced_middleware/tutorial001_py39.py hl[2,6] *} +{* ../../docs_src/advanced_middleware/tutorial001_py310.py hl[2,6] *} ## `TrustedHostMiddleware` { #trustedhostmiddleware } HTTP Host Header 공격을 방어하기 위해, 들어오는 모든 요청에 올바르게 설정된 `Host` 헤더가 있어야 하도록 강제합니다. -{* ../../docs_src/advanced_middleware/tutorial002_py39.py hl[2,6:8] *} +{* ../../docs_src/advanced_middleware/tutorial002_py310.py hl[2,6:8] *} 다음 인자들을 지원합니다: @@ -78,7 +78,7 @@ HTTP Host Header 공격을 방어하기 위해, 들어오는 모든 요청에 이 middleware는 일반 응답과 스트리밍 응답을 모두 처리합니다. -{* ../../docs_src/advanced_middleware/tutorial003_py39.py hl[2,6] *} +{* ../../docs_src/advanced_middleware/tutorial003_py310.py hl[2,6] *} 다음 인자들을 지원합니다: diff --git a/docs/ko/docs/advanced/openapi-callbacks.md b/docs/ko/docs/advanced/openapi-callbacks.md index e4bdea9d6c..95f90d73cc 100644 --- a/docs/ko/docs/advanced/openapi-callbacks.md +++ b/docs/ko/docs/advanced/openapi-callbacks.md @@ -1,8 +1,8 @@ # OpenAPI 콜백 { #openapi-callbacks } -다른 사람이 만든 *external API*(아마도 당신의 API를 *사용*할 동일한 개발자)가 요청을 트리거하도록 만드는 *경로 처리*를 가진 API를 만들 수 있습니다. +다른 사람이 만든 *external API*(아마도 여러분의 API를 *사용*할 동일한 개발자)가 요청을 트리거하도록 만드는 *경로 처리*를 가진 API를 만들 수 있습니다. -당신의 API 앱이 *external API*를 호출할 때 일어나는 과정을 "callback"이라고 합니다. 외부 개발자가 작성한 소프트웨어가 당신의 API로 요청을 보낸 다음, 당신의 API가 다시 *external API*로 요청을 보내 *되돌려 호출*하기 때문입니다(아마도 같은 개발자가 만든 API일 것입니다). +여러분의 API 앱이 *external API*를 호출할 때 일어나는 과정을 "callback"이라고 합니다. 외부 개발자가 작성한 소프트웨어가 여러분의 API로 요청을 보낸 다음, 여러분의 API가 다시 *external API*로 요청을 보내 *되돌려 호출*하기 때문입니다(아마도 같은 개발자가 만든 API일 것입니다). 이 경우, 그 *external API*가 어떤 형태여야 하는지 문서화하고 싶을 수 있습니다. 어떤 *경로 처리*를 가져야 하는지, 어떤 body를 기대하는지, 어떤 응답을 반환해야 하는지 등입니다. @@ -14,14 +14,14 @@ 이 청구서는 `id`, `title`(선택 사항), `customer`, `total`을 갖습니다. -당신의 API 사용자(외부 개발자)는 POST 요청으로 당신의 API에서 청구서를 생성합니다. +여러분의 API 사용자(외부 개발자)는 POST 요청으로 여러분의 API에서 청구서를 생성합니다. -그 다음 당신의 API는(가정해 보면): +그 다음 여러분의 API는(가정해 보면): * 청구서를 외부 개발자의 고객에게 전송합니다. * 돈을 수금합니다. * API 사용자(외부 개발자)의 API로 다시 알림을 보냅니다. - * 이는 (당신의 API에서) 그 외부 개발자가 제공하는 어떤 *external API*로 POST 요청을 보내는 방식으로 수행됩니다(이것이 "callback"입니다). + * 이는 (여러분의 API에서) 그 외부 개발자가 제공하는 어떤 *external API*로 POST 요청을 보내는 방식으로 수행됩니다(이것이 "callback"입니다). ## 일반적인 **FastAPI** 앱 { #the-normal-fastapi-app } @@ -43,7 +43,7 @@ ## 콜백 문서화하기 { #documenting-the-callback } -실제 콜백 코드는 당신의 API 앱에 크게 의존합니다. +실제 콜백 코드는 여러분의 API 앱에 크게 의존합니다. 그리고 앱마다 많이 달라질 수 있습니다. @@ -54,11 +54,11 @@ callback_url = "https://example.com/api/v1/invoices/events/" httpx.post(callback_url, json={"description": "Invoice paid", "paid": True}) ``` -하지만 콜백에서 가장 중요한 부분은, 당신의 API 사용자(외부 개발자)가 콜백 요청 body로 *당신의 API*가 보낼 데이터 등에 맞춰 *external API*를 올바르게 구현하도록 보장하는 것입니다. +하지만 콜백에서 가장 중요한 부분은, 여러분의 API 사용자(외부 개발자)가 콜백 요청 body로 *여러분의 API*가 보낼 데이터 등에 맞춰 *external API*를 올바르게 구현하도록 보장하는 것입니다. -그래서 다음으로 할 일은, *당신의 API*에서 보내는 콜백을 받기 위해 그 *external API*가 어떤 형태여야 하는지 문서화하는 코드를 추가하는 것입니다. +그래서 다음으로 할 일은, *여러분의 API*에서 보내는 콜백을 받기 위해 그 *external API*가 어떤 형태여야 하는지 문서화하는 코드를 추가하는 것입니다. -그 문서는 당신의 API에서 `/docs`의 Swagger UI에 표시되며, 외부 개발자들이 *external API*를 어떻게 만들어야 하는지 알 수 있게 해줍니다. +그 문서는 여러분의 API에서 `/docs`의 Swagger UI에 표시되며, 외부 개발자들이 *external API*를 어떻게 만들어야 하는지 알 수 있게 해줍니다. 이 예시는 콜백 자체(한 줄 코드로도 될 수 있음)를 구현하지 않고, 문서화 부분만 구현합니다. @@ -76,11 +76,11 @@ httpx.post(callback_url, json={"description": "Invoice paid", "paid": True}) 하지만 **FastAPI**로 API의 자동 문서를 쉽게 생성하는 방법은 이미 알고 있습니다. -따라서 그와 같은 지식을 사용해 *external API*가 어떻게 생겨야 하는지 문서화할 것입니다... 즉 외부 API가 구현해야 하는 *경로 처리(들)*(당신의 API가 호출할 것들)을 만들어서 말입니다. +따라서 그와 같은 지식을 사용해 *external API*가 어떻게 생겨야 하는지 문서화할 것입니다... 즉 외부 API가 구현해야 하는 *경로 처리(들)*(여러분의 API가 호출할 것들)을 만들어서 말입니다. /// tip | 팁 -콜백을 문서화하는 코드를 작성할 때는, 자신이 그 *외부 개발자*라고 상상하는 것이 유용할 수 있습니다. 그리고 지금은 *당신의 API*가 아니라 *external API*를 구현하고 있다고 생각해 보세요. +콜백을 문서화하는 코드를 작성할 때는, 자신이 그 *외부 개발자*라고 상상하는 것이 유용할 수 있습니다. 그리고 지금은 *여러분의 API*가 아니라 *external API*를 구현하고 있다고 생각해 보세요. 이 관점(외부 개발자의 관점)을 잠시 채택하면, 그 *external API*를 위해 파라미터, body용 Pydantic 모델, 응답 등을 어디에 두어야 하는지가 더 명확하게 느껴질 수 있습니다. @@ -105,12 +105,12 @@ httpx.post(callback_url, json={"description": "Invoice paid", "paid": True}) 일반적인 *경로 처리*와의 주요 차이점은 2가지입니다: -* 실제 코드를 가질 필요가 없습니다. 당신의 앱은 이 코드를 절대 호출하지 않기 때문입니다. 이는 *external API*를 문서화하는 데만 사용됩니다. 따라서 함수는 그냥 `pass`만 있어도 됩니다. -* *path*에는 OpenAPI 3 expression(자세한 내용은 아래 참고)이 포함될 수 있으며, 이를 통해 *당신의 API*로 보내진 원래 요청의 파라미터와 일부 값을 변수로 사용할 수 있습니다. +* 실제 코드를 가질 필요가 없습니다. 여러분의 앱은 이 코드를 절대 호출하지 않기 때문입니다. 이는 *external API*를 문서화하는 데만 사용됩니다. 따라서 함수는 그냥 `pass`만 있어도 됩니다. +* *path*에는 OpenAPI 3 expression(자세한 내용은 아래 참고)이 포함될 수 있으며, 이를 통해 *여러분의 API*로 보내진 원래 요청의 파라미터와 일부 값을 변수로 사용할 수 있습니다. ### 콜백 경로 표현식 { #the-callback-path-expression } -콜백 *path*는 *당신의 API*로 보내진 원래 요청의 일부를 포함할 수 있는 OpenAPI 3 expression을 가질 수 있습니다. +콜백 *path*는 *여러분의 API*로 보내진 원래 요청의 일부를 포함할 수 있는 OpenAPI 3 expression을 가질 수 있습니다. 이 경우, 다음 `str`입니다: @@ -118,7 +118,7 @@ httpx.post(callback_url, json={"description": "Invoice paid", "paid": True}) "{$callback_url}/invoices/{$request.body.id}" ``` -따라서 당신의 API 사용자(외부 개발자)가 *당신의 API*로 다음 요청을 보내고: +따라서 여러분의 API 사용자(외부 개발자)가 *여러분의 API*로 다음 요청을 보내고: ``` https://yourapi.com/invoices/?callback_url=https://www.external.org/events @@ -134,7 +134,7 @@ JSON body가 다음과 같다면: } ``` -그러면 *당신의 API*는 청구서를 처리하고, 나중에 어느 시점에서 `callback_url`(즉 *external API*)로 콜백 요청을 보냅니다: +그러면 *여러분의 API*는 청구서를 처리하고, 나중에 어느 시점에서 `callback_url`(즉 *external API*)로 콜백 요청을 보냅니다: ``` https://www.external.org/events/invoices/2expen51ve @@ -167,7 +167,7 @@ https://www.external.org/events/invoices/2expen51ve 이 시점에서, 위에서 만든 콜백 라우터 안에 *콜백 경로 처리(들)*(즉 *external developer*가 *external API*에 구현해야 하는 것들)을 준비했습니다. -이제 *당신의 API 경로 처리 데코레이터*에서 `callbacks` 파라미터를 사용해, 그 콜백 라우터의 `.routes` 속성(실제로는 routes/*경로 처리*의 `list`)을 전달합니다: +이제 *여러분의 API 경로 처리 데코레이터*에서 `callbacks` 파라미터를 사용해, 그 콜백 라우터의 `.routes` 속성(실제로는 routes/*경로 처리*의 `list`)을 전달합니다: {* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[33] *} diff --git a/docs/ko/docs/advanced/openapi-webhooks.md b/docs/ko/docs/advanced/openapi-webhooks.md index 89cacf7b78..8651c4176c 100644 --- a/docs/ko/docs/advanced/openapi-webhooks.md +++ b/docs/ko/docs/advanced/openapi-webhooks.md @@ -32,7 +32,7 @@ Webhooks는 OpenAPI 3.1.0 이상에서 사용할 수 있으며, FastAPI `0.99.0` **FastAPI** 애플리케이션을 만들면, *경로 처리*를 정의하는 것과 같은 방식으로(예: `@app.webhooks.post()`), *webhooks*를 정의하는 데 사용할 수 있는 `webhooks` 속성이 있습니다. -{* ../../docs_src/openapi_webhooks/tutorial001_py39.py hl[9:13,36:53] *} +{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *} 여러분이 정의한 webhook은 **OpenAPI** 스키마와 자동 **docs UI**에 포함됩니다. diff --git a/docs/ko/docs/advanced/path-operation-advanced-configuration.md b/docs/ko/docs/advanced/path-operation-advanced-configuration.md index f20fa6d263..da8e43bd3e 100644 --- a/docs/ko/docs/advanced/path-operation-advanced-configuration.md +++ b/docs/ko/docs/advanced/path-operation-advanced-configuration.md @@ -12,7 +12,7 @@ OpenAPI “전문가”가 아니라면, 아마 이 내용은 필요하지 않 각 작업마다 고유하도록 보장해야 합니다. -{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py39.py hl[6] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py310.py hl[6] *} ### *경로 처리 함수* 이름을 operationId로 사용하기 { #using-the-path-operation-function-name-as-the-operationid } @@ -20,7 +20,7 @@ API의 함수 이름을 `operationId`로 사용하고 싶다면, 모든 API를 모든 *경로 처리*를 추가한 뒤에 수행해야 합니다. -{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py39.py hl[2, 12:21, 24] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py310.py hl[2, 12:21, 24] *} /// tip | 팁 @@ -40,7 +40,7 @@ API의 함수 이름을 `operationId`로 사용하고 싶다면, 모든 API를 생성된 OpenAPI 스키마(따라서 자동 문서화 시스템)에서 특정 *경로 처리*를 제외하려면, `include_in_schema` 매개변수를 `False`로 설정하세요: -{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py39.py hl[6] *} +{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *} ## docstring에서 고급 설명 가져오기 { #advanced-description-from-docstring } @@ -92,7 +92,7 @@ OpenAPI 명세에서는 이를 parsed되지도 않고, `bytes`로 직접 읽습니다. 그리고 함수 `magic_data_reader()`가 어떤 방식으로든 이를 파싱하는 역할을 담당합니다. +이 예시에서는 어떤 Pydantic 모델도 선언하지 않았습니다. 사실 요청 바디는 JSON으로 파싱되지도 않고, `bytes`로 직접 읽습니다. 그리고 함수 `magic_data_reader()`가 어떤 방식으로든 이를 파싱하는 역할을 담당합니다. 그럼에도 불구하고, 요청 바디에 대해 기대하는 스키마를 선언할 수 있습니다. @@ -153,7 +153,7 @@ OpenAPI 명세에서는 이를 Pydantic: Concepts: Configuration을 참고하세요. +`model_config` 속성은 Pydantic 설정을 위한 것입니다. 자세한 내용은 Pydantic: Concepts: Configuration를 참고하세요. /// @@ -226,11 +226,11 @@ def get_settings(): 하지만 위에 `@lru_cache` 데코레이터를 사용하고 있으므로, `Settings` 객체는 최초 호출 시 딱 한 번만 생성됩니다. ✔️ -{* ../../docs_src/settings/app03_an_py39/main.py hl[1,11] *} +{* ../../docs_src/settings/app03_an_py310/main.py hl[1,11] *} 그 다음 요청들에서 의존성으로 `get_settings()`가 다시 호출될 때마다, `get_settings()`의 내부 코드를 실행해서 새 `Settings` 객체를 만드는 대신, 첫 호출에서 반환된 동일한 객체를 계속 반환합니다. -#### `lru_cache` Technical Details { #lru-cache-technical-details } +#### `lru_cache` 기술 세부사항 { #lru-cache-technical-details } `@lru_cache`는 데코레이션한 함수가 매번 다시 계산하는 대신, 첫 번째에 반환된 동일한 값을 반환하도록 함수를 수정합니다(즉, 매번 함수 코드를 실행하지 않습니다). diff --git a/docs/ko/docs/advanced/sub-applications.md b/docs/ko/docs/advanced/sub-applications.md index e1554ca5d6..8da217aab6 100644 --- a/docs/ko/docs/advanced/sub-applications.md +++ b/docs/ko/docs/advanced/sub-applications.md @@ -10,7 +10,7 @@ 먼저, 메인 최상위 **FastAPI** 애플리케이션과 그 *경로 처리*를 생성합니다: -{* ../../docs_src/sub_applications/tutorial001_py39.py hl[3, 6:8] *} +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[3, 6:8] *} ### 하위 응용프로그램 { #sub-application } @@ -18,7 +18,7 @@ 이 하위 응용프로그램은 또 다른 표준 FastAPI 애플리케이션이지만, "마운트"될 애플리케이션입니다: -{* ../../docs_src/sub_applications/tutorial001_py39.py hl[11, 14:16] *} +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 14:16] *} ### 하위 응용프로그램 마운트 { #mount-the-sub-application } @@ -26,7 +26,7 @@ 이 경우 `/subapi` 경로에 마운트됩니다: -{* ../../docs_src/sub_applications/tutorial001_py39.py hl[11, 19] *} +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 19] *} ### 자동 API 문서 확인 { #check-the-automatic-api-docs } diff --git a/docs/ko/docs/advanced/templates.md b/docs/ko/docs/advanced/templates.md index fffffa6a54..3ae718f153 100644 --- a/docs/ko/docs/advanced/templates.md +++ b/docs/ko/docs/advanced/templates.md @@ -27,7 +27,7 @@ $ pip install jinja2 * 템플릿을 반환할 *경로 처리*에 `Request` 매개변수를 선언합니다. * 생성한 `templates`를 사용하여 `TemplateResponse`를 렌더링하고 반환합니다. 템플릿의 이름, 요청 객체 및 Jinja2 템플릿 내에서 사용될 키-값 쌍이 포함된 "컨텍스트" 딕셔너리도 전달합니다. -{* ../../docs_src/templates/tutorial001_py39.py hl[4,11,15:18] *} +{* ../../docs_src/templates/tutorial001_py310.py hl[4,11,15:18] *} /// note | 참고 diff --git a/docs/ko/docs/advanced/testing-events.md b/docs/ko/docs/advanced/testing-events.md index 8dbd4f6e66..a1a7daff38 100644 --- a/docs/ko/docs/advanced/testing-events.md +++ b/docs/ko/docs/advanced/testing-events.md @@ -2,11 +2,11 @@ 테스트에서 `lifespan`을 실행해야 하는 경우, `with` 문과 함께 `TestClient`를 사용할 수 있습니다: -{* ../../docs_src/app_testing/tutorial004_py39.py hl[9:15,18,27:28,30:32,41:43] *} +{* ../../docs_src/app_testing/tutorial004_py310.py hl[9:15,18,27:28,30:32,41:43] *} ["공식 Starlette 문서 사이트에서 테스트에서 라이프스팬 실행하기."](https://www.starlette.dev/lifespan/#running-lifespan-in-tests)에 대한 자세한 내용을 더 읽을 수 있습니다. 더 이상 권장되지 않는 `startup` 및 `shutdown` 이벤트의 경우, 다음과 같이 `TestClient`를 사용할 수 있습니다: -{* ../../docs_src/app_testing/tutorial003_py39.py hl[9:12,20:24] *} +{* ../../docs_src/app_testing/tutorial003_py310.py hl[9:12,20:24] *} diff --git a/docs/ko/docs/advanced/testing-websockets.md b/docs/ko/docs/advanced/testing-websockets.md index 1cb3cad67e..23ff34cd3a 100644 --- a/docs/ko/docs/advanced/testing-websockets.md +++ b/docs/ko/docs/advanced/testing-websockets.md @@ -4,10 +4,10 @@ 이를 위해 `with` 문에서 `TestClient`를 사용하여 WebSocket에 연결합니다: -{* ../../docs_src/app_testing/tutorial002_py39.py hl[27:31] *} +{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *} /// note | 참고 -자세한 내용은 Starlette의 testing WebSockets 문서를 확인하세요. +자세한 내용은 Starlette의 WebSocket 테스트 문서를 확인하세요. /// diff --git a/docs/ko/docs/advanced/using-request-directly.md b/docs/ko/docs/advanced/using-request-directly.md index e0a5e99f88..0c45e2e2f8 100644 --- a/docs/ko/docs/advanced/using-request-directly.md +++ b/docs/ko/docs/advanced/using-request-directly.md @@ -29,7 +29,7 @@ 이를 위해서는 요청에 직접 접근해야 합니다. -{* ../../docs_src/using_request_directly/tutorial001_py39.py hl[1,7:8] *} +{* ../../docs_src/using_request_directly/tutorial001_py310.py hl[1,7:8] *} *경로 처리 함수* 매개변수를 `Request` 타입으로 선언하면 **FastAPI**가 해당 매개변수에 `Request`를 전달하는 것을 알게 됩니다. diff --git a/docs/ko/docs/advanced/websockets.md b/docs/ko/docs/advanced/websockets.md index b6817870b7..384f93952b 100644 --- a/docs/ko/docs/advanced/websockets.md +++ b/docs/ko/docs/advanced/websockets.md @@ -24,7 +24,7 @@ $ pip install websockets 그리고 백엔드와 WebSockets을 사용해 통신하려면 아마도 프런트엔드의 유틸리티를 사용할 것입니다. -또는 네이티브 코드로 WebSocket 백엔드와 직접 통신하는 네이티브 모바일 응용 프로그램을 가질 수도 있습니다. +또는 네이티브 코드로 WebSocket 백엔드와 직접 통신하는 네이티브 모바일 애플리케이션을 가질 수도 있습니다. 혹은 WebSocket 엔드포인트와 통신할 수 있는 다른 방법이 있을 수도 있습니다. @@ -38,13 +38,13 @@ $ pip install websockets 그러나 이는 WebSockets의 서버 측에 집중하고 동작하는 예제를 제공하는 가장 간단한 방법입니다: -{* ../../docs_src/websockets/tutorial001_py39.py hl[2,6:38,41:43] *} +{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *} ## `websocket` 생성하기 { #create-a-websocket } -**FastAPI** 응용 프로그램에서 `websocket`을 생성합니다: +**FastAPI** 애플리케이션에서 `websocket`을 생성합니다: -{* ../../docs_src/websockets/tutorial001_py39.py hl[1,46:47] *} +{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *} /// note | 기술 세부사항 @@ -58,13 +58,13 @@ $ pip install websockets WebSocket 경로에서 메시지를 대기(`await`)하고 전송할 수 있습니다. -{* ../../docs_src/websockets/tutorial001_py39.py hl[48:52] *} +{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *} 여러분은 이진 데이터, 텍스트, JSON 데이터를 받을 수 있고 전송할 수 있습니다. ## 시도해보기 { #try-it } -파일 이름이 `main.py`라고 가정하고 다음으로 응용 프로그램을 실행합니다: +파일 이름이 `main.py`라고 가정하고 다음으로 애플리케이션을 실행합니다:
@@ -86,7 +86,7 @@ $ fastapi dev main.py -그리고 WebSockets가 포함된 **FastAPI** 응용 프로그램이 응답을 돌려줄 것입니다: +그리고 WebSockets가 포함된 **FastAPI** 애플리케이션이 응답을 돌려줄 것입니다: @@ -121,7 +121,7 @@ WebSocket이기 때문에 `HTTPException`을 발생시키는 것은 적절하지 ### 종속성을 가진 WebSockets 시도해보기 { #try-the-websockets-with-dependencies } -파일 이름이 `main.py`라고 가정하고 다음으로 응용 프로그램을 실행합니다: +파일 이름이 `main.py`라고 가정하고 다음으로 애플리케이션을 실행합니다:
@@ -154,7 +154,7 @@ $ fastapi dev main.py WebSocket 연결이 닫히면, `await websocket.receive_text()`가 `WebSocketDisconnect` 예외를 발생시킵니다. 그러면 이 예제처럼 이를 잡아 처리할 수 있습니다. -{* ../../docs_src/websockets/tutorial003_py39.py hl[79:81] *} +{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *} 테스트해보기: diff --git a/docs/ko/docs/advanced/wsgi.md b/docs/ko/docs/advanced/wsgi.md index 5e0e87c5e7..24b074443d 100644 --- a/docs/ko/docs/advanced/wsgi.md +++ b/docs/ko/docs/advanced/wsgi.md @@ -18,7 +18,7 @@ 그리고 해당 경로에 마운트합니다. -{* ../../docs_src/wsgi/tutorial001_py39.py hl[1,3,23] *} +{* ../../docs_src/wsgi/tutorial001_py310.py hl[1,3,23] *} /// note | 참고 diff --git a/docs/ko/docs/alternatives.md b/docs/ko/docs/alternatives.md index d8c2df2d8d..f26fbe39dd 100644 --- a/docs/ko/docs/alternatives.md +++ b/docs/ko/docs/alternatives.md @@ -137,7 +137,7 @@ Flask REST framework는 여러 개가 있지만, 시간을 들여 조사해 본 ### Marshmallow { #marshmallow } -API 시스템에 필요한 주요 기능 중 하나는 데이터 "serialization"입니다. 이는 코드(Python)에서 데이터를 가져와 네트워크로 전송할 수 있는 형태로 변환하는 것을 의미합니다. 예를 들어 데이터베이스의 데이터를 담은 객체를 JSON 객체로 변환하거나, `datetime` 객체를 문자열로 변환하는 등의 작업입니다. +API 시스템에 필요한 주요 기능 중 하나는 데이터 "직렬화"입니다. 이는 코드(Python)에서 데이터를 가져와 네트워크로 전송할 수 있는 형태로 변환하는 것을 의미합니다. 예를 들어 데이터베이스의 데이터를 담은 객체를 JSON 객체로 변환하거나, `datetime` 객체를 문자열로 변환하는 등의 작업입니다. API에 또 하나 크게 필요한 기능은 데이터 검증입니다. 특정 파라미터를 기준으로 데이터가 유효한지 확인하는 것입니다. 예를 들어 어떤 필드가 `int`인지, 임의의 문자열이 아닌지 확인하는 식입니다. 이는 특히 들어오는 데이터에 유용합니다. @@ -145,7 +145,7 @@ API에 또 하나 크게 필요한 기능은 데이터 검증입니다. 특정 이런 기능들을 제공하기 위해 Marshmallow가 만들어졌습니다. 훌륭한 라이브러리이며, 저도 이전에 많이 사용했습니다. -하지만 Python type hints가 존재하기 전에 만들어졌습니다. 그래서 각 schema를 정의하려면 Marshmallow가 제공하는 특정 유틸리티와 클래스를 사용해야 합니다. +하지만 Python type hints가 존재하기 전에 만들어졌습니다. 그래서 각 스키마를 정의하려면 Marshmallow가 제공하는 특정 유틸리티와 클래스를 사용해야 합니다. /// check | **FastAPI**에 영감을 준 것 @@ -155,7 +155,7 @@ API에 또 하나 크게 필요한 기능은 데이터 검증입니다. 특정 ### Webargs { #webargs } -API에 필요한 또 다른 큰 기능은 들어오는 요청에서 데이터를 parsing하는 것입니다. +API에 필요한 또 다른 큰 기능은 들어오는 요청에서 데이터를 파싱하는 것입니다. Webargs는 Flask를 포함한 여러 framework 위에서 이를 제공하기 위해 만들어진 도구입니다. @@ -419,7 +419,7 @@ Marshmallow와 비교할 수 있습니다. 다만 benchmark에서 Marshmallow보 ### Starlette { #starlette } -Starlette는 경량 ASGI framework/toolkit으로, 고성능 asyncio 서비스를 만들기에 이상적입니다. +Starlette는 경량 ASGI framework/toolkit으로, 고성능 asyncio 서비스를 만들기에 이상적입니다. 매우 단순하고 직관적입니다. 쉽게 확장할 수 있도록 설계되었고, 모듈식 component를 갖습니다. diff --git a/docs/ko/docs/deployment/docker.md b/docs/ko/docs/deployment/docker.md index 20e341c269..ca0136d836 100644 --- a/docs/ko/docs/deployment/docker.md +++ b/docs/ko/docs/deployment/docker.md @@ -14,7 +14,7 @@ FastAPI 애플리케이션을 배포할 때 일반적인 접근 방법은 **리 Dockerfile Preview 👀 ```Dockerfile -FROM python:3.9 +FROM python:3.14 WORKDIR /code @@ -166,7 +166,7 @@ def read_item(item_id: int, q: str | None = None): ```{ .dockerfile .annotate } # (1)! -FROM python:3.9 +FROM python:3.14 # (2)! WORKDIR /code @@ -390,7 +390,7 @@ FastAPI가 단일 파일(예: `./app` 디렉터리 없이 `main.py`만 있는 그런 다음 `Dockerfile`에서 해당 파일을 복사하도록 경로만 맞게 변경하면 됩니다: ```{ .dockerfile .annotate hl_lines="10 13" } -FROM python:3.9 +FROM python:3.14 WORKDIR /code @@ -454,7 +454,7 @@ Traefik은 Docker, Kubernetes 등과 통합되어 있어, 이를 사용해 컨 ## 복제 - 프로세스 개수 { #replication-number-of-processes } -**Kubernetes**, Docker Swarm Mode, Nomad 등의 복잡한 시스템으로 여러 머신에 분산된 컨테이너를 관리하는 클러스터를 사용한다면, 각 컨테이너에서(**워커를 사용하는 Uvicorn** 같은) **프로세스 매니저**를 쓰는 대신, **클러스터 레벨**에서 **복제를 처리**하고 싶을 가능성이 큽니다. +**Kubernetes**, Docker Swarm Mode, Nomad 등의 복잡한 시스템으로 여러 머신에 분산된 컨테이너를 관리하는 클러스터를 사용한다면, 각 컨테이너에서(**워커를 사용하는 Uvicorn** 같은) **프로세스 매니저**를 쓰는 대신, **클러스터 레벨**에서 **복제를 처리**하고 싶을 가능성이 큽니다. Kubernetes 같은 분산 컨테이너 관리 시스템은 보통 들어오는 요청에 대한 **로드 밸런싱**을 지원하면서도, **컨테이너 복제**를 처리하는 통합된 방법을 가지고 있습니다. 모두 **클러스터 레벨**에서요. @@ -499,7 +499,7 @@ HTTPS에 사용되는 동일한 **TLS 종료 프록시** 컴포넌트가 **로 그런 경우에는 `--workers` 커맨드 라인 옵션을 사용해 실행할 워커 수를 설정할 수 있습니다: ```{ .dockerfile .annotate } -FROM python:3.9 +FROM python:3.14 WORKDIR /code diff --git a/docs/ko/docs/deployment/https.md b/docs/ko/docs/deployment/https.md index 888ec61592..bda942af68 100644 --- a/docs/ko/docs/deployment/https.md +++ b/docs/ko/docs/deployment/https.md @@ -15,7 +15,7 @@ HTTPS는 그냥 “켜져 있거나” 아니면 “꺼져 있는” 것이라 이제 **개발자 관점**에서 HTTPS를 생각할 때 염두에 두어야 할 여러 가지가 있습니다: * HTTPS를 사용하려면, **서버**가 **제3자**가 발급한 **"인증서(certificates)"**를 **보유**해야 합니다. - * 이 인증서는 실제로 제3자가 “생성”해 주는 것이고, 서버가 만드는 것이 아니라 제3자로부터 **발급/획득**하는 것입니다. + * 이 인증서는 실제로 '생성'되는 것이 아니라 제3자로부터 **발급/획득**하는 것입니다. * 인증서에는 **유효 기간**이 있습니다. * 즉, **만료**됩니다. * 그리고 나면 제3자로부터 다시 **갱신**해서 **재발급/재획득**해야 합니다. @@ -65,7 +65,7 @@ Let's Encrypt 이전에는 이러한 **HTTPS 인증서**가 신뢰할 수 있는 아마도 시작은 **도메인 이름**을 **획득**하는 것일 겁니다. 그 다음 DNS 서버(아마 같은 클라우드 제공업체)에서 이를 설정합니다. -대개 클라우드 서버(가상 머신) 같은 것을 사용하게 되고, 거기에는 fixed **공개 IP 주소**가 있습니다. +대개 클라우드 서버(가상 머신) 같은 것을 사용하게 되고, 거기에는 고정 **공개 IP 주소**가 있습니다. DNS 서버(들)에서 **도메인**이 서버의 **공개 IP 주소**를 가리키도록 레코드(“`A record`”)를 설정합니다. diff --git a/docs/ko/docs/deployment/manually.md b/docs/ko/docs/deployment/manually.md index e85dd02a32..93b1e76115 100644 --- a/docs/ko/docs/deployment/manually.md +++ b/docs/ko/docs/deployment/manually.md @@ -46,7 +46,7 @@ $ fastapi run ASGI라고 불리는, Python 웹 프레임워크와 서버를 만들기 위한 표준을 사용합니다. FastAPI는 ASGI 웹 프레임워크입니다. +FastAPI는 ASGI라고 불리는, Python 웹 프레임워크와 서버를 만들기 위한 표준을 사용합니다. FastAPI는 ASGI 웹 프레임워크입니다. 원격 서버 머신에서 **FastAPI** 애플리케이션(또는 다른 ASGI 애플리케이션)을 실행하기 위해 필요한 핵심 요소는 **Uvicorn** 같은 ASGI 서버 프로그램입니다. `fastapi` 명령에는 기본으로 이것이 포함되어 있습니다. diff --git a/docs/ko/docs/deployment/server-workers.md b/docs/ko/docs/deployment/server-workers.md index e98cfd1142..1be102925e 100644 --- a/docs/ko/docs/deployment/server-workers.md +++ b/docs/ko/docs/deployment/server-workers.md @@ -9,13 +9,13 @@ * 메모리 * 시작하기 전의 이전 단계 -지금까지 문서의 모든 튜토리얼을 참고하면서, `fastapi` 명령처럼 Uvicorn을 실행하는 **서버 프로그램**을 사용해 **단일 프로세스**로 실행해 왔을 가능성이 큽니다. +지금까지 문서의 모든 튜토리얼을 참고하면서, `fastapi` 명령어처럼 Uvicorn을 실행하는 **서버 프로그램**을 사용해 **단일 프로세스**로 실행해 왔을 가능성이 큽니다. 애플리케이션을 배포할 때는 **다중 코어**를 활용하고 더 많은 요청을 처리할 수 있도록 **프로세스 복제**를 하고 싶을 가능성이 큽니다. 이전 장의 [배포 개념들](concepts.md){.internal-link target=_blank}에서 본 것처럼, 사용할 수 있는 전략이 여러 가지 있습니다. -여기서는 `fastapi` 명령을 사용하거나 `uvicorn` 명령을 직접 사용해서, **워커 프로세스**와 함께 **Uvicorn**을 사용하는 방법을 보여드리겠습니다. +여기서는 `fastapi` 명령어를 사용하거나 `uvicorn` 명령어를 직접 사용해서, **워커 프로세스**와 함께 **Uvicorn**을 사용하는 방법을 보여드리겠습니다. /// info | 정보 @@ -27,11 +27,11 @@ Docker나 Kubernetes 같은 컨테이너를 사용하고 있다면, 다음 장 ## 여러 워커 { #multiple-workers } -`--workers` 커맨드라인 옵션으로 여러 워커를 시작할 수 있습니다: +`--workers` 명령어 옵션으로 여러 워커를 시작할 수 있습니다: //// tab | `fastapi` -`fastapi` 명령을 사용한다면: +`fastapi` 명령어를 사용한다면:
@@ -81,7 +81,7 @@ $ fastapi run --workers 4 @@ -132,7 +132,7 @@ $ uvicorn main:app --host 0.0.0.0 --port 8080 --workers 4 ## 요약 { #recap } -`fastapi` 또는 `uvicorn` 명령에서 `--workers` CLI 옵션을 사용해 여러 워커 프로세스를 실행하면, **멀티 코어 CPU**를 활용해 **여러 프로세스를 병렬로 실행**할 수 있습니다. +`fastapi` 또는 `uvicorn` 명령어에서 `--workers` CLI 옵션을 사용해 여러 워커 프로세스를 실행하면, **멀티 코어 CPU**를 활용해 **여러 프로세스를 병렬로 실행**할 수 있습니다. 다른 배포 개념들을 직접 처리하면서 **자체 배포 시스템**을 구축하는 경우, 이러한 도구와 아이디어를 활용할 수 있습니다. diff --git a/docs/ko/docs/deployment/versions.md b/docs/ko/docs/deployment/versions.md index 173ba925cf..b94832aa82 100644 --- a/docs/ko/docs/deployment/versions.md +++ b/docs/ko/docs/deployment/versions.md @@ -34,7 +34,7 @@ fastapi[standard]>=0.112.0,<0.113.0 ## 이용 가능한 버전들 { #available-versions } -사용 가능한 버전(예: 현재 최신 버전이 무엇인지 확인하기 위해)은 [Release Notes](../release-notes.md){.internal-link target=_blank}에서 확인할 수 있습니다. +사용 가능한 버전(예: 현재 최신 버전이 무엇인지 확인하기 위해)은 [릴리스 노트](../release-notes.md){.internal-link target=_blank}에서 확인할 수 있습니다. ## 버전들에 대해 { #about-versions } @@ -66,7 +66,7 @@ fastapi>=0.45.0,<0.46.0 앱에 테스트를 추가해야 합니다. -**FastAPI**에서는 매우 쉽습니다(Starlette 덕분에). 문서를 확인해 보세요: [Testing](../tutorial/testing.md){.internal-link target=_blank} +**FastAPI**에서는 매우 쉽습니다(Starlette 덕분에). 문서를 확인해 보세요: [테스트](../tutorial/testing.md){.internal-link target=_blank} 테스트를 갖춘 뒤에는 **FastAPI** 버전을 더 최신 버전으로 업그레이드하고, 테스트를 실행하여 모든 코드가 올바르게 동작하는지 확인하세요. diff --git a/docs/ko/docs/environment-variables.md b/docs/ko/docs/environment-variables.md index dc231acb64..e8809573fd 100644 --- a/docs/ko/docs/environment-variables.md +++ b/docs/ko/docs/environment-variables.md @@ -19,10 +19,10 @@
```console -// You could create an env var MY_NAME with +// 환경 변수 MY_NAME을 다음과 같이 생성할 수 있습니다 $ export MY_NAME="Wade Wilson" -// Then you could use it with other programs, like +// 그런 다음 다른 프로그램과 함께 사용할 수 있습니다. 예: $ echo "Hello $MY_NAME" Hello Wade Wilson @@ -37,10 +37,10 @@ Hello Wade Wilson
```console -// Create an env var MY_NAME +// 환경 변수 MY_NAME 생성 $ $Env:MY_NAME = "Wade Wilson" -// Use it with other programs, like +// 다른 프로그램과 함께 사용하기. 예: $ echo "Hello $Env:MY_NAME" Hello Wade Wilson @@ -78,20 +78,20 @@ print(f"Hello {name} from Python")
```console -// Here we don't set the env var yet +// 여기서는 아직 환경 변수를 설정하지 않습니다 $ python main.py -// As we didn't set the env var, we get the default value +// 환경 변수를 설정하지 않았으므로 기본값이 사용됩니다 Hello World from Python -// But if we create an environment variable first +// 하지만 먼저 환경 변수를 생성하면 $ export MY_NAME="Wade Wilson" -// And then call the program again +// 그리고 프로그램을 다시 실행하면 $ python main.py -// Now it can read the environment variable +// 이제 환경 변수를 읽을 수 있습니다 Hello Wade Wilson from Python ``` @@ -105,20 +105,20 @@ Hello Wade Wilson from Python
```console -// Here we don't set the env var yet +// 여기서는 아직 환경 변수를 설정하지 않습니다 $ python main.py -// As we didn't set the env var, we get the default value +// 환경 변수를 설정하지 않았으므로 기본값이 사용됩니다 Hello World from Python -// But if we create an environment variable first +// 하지만 먼저 환경 변수를 생성하면 $ $Env:MY_NAME = "Wade Wilson" -// And then call the program again +// 그리고 프로그램을 다시 실행하면 $ python main.py -// Now it can read the environment variable +// 이제 환경 변수를 읽을 수 있습니다 Hello Wade Wilson from Python ``` @@ -136,14 +136,14 @@ Hello Wade Wilson from Python
```console -// Create an env var MY_NAME in line for this program call +// 이 프로그램 호출을 위해 같은 줄에서 환경 변수 MY_NAME 생성 $ MY_NAME="Wade Wilson" python main.py -// Now it can read the environment variable +// 이제 환경 변수를 읽을 수 있습니다 Hello Wade Wilson from Python -// The env var no longer exists afterwards +// 이후에는 해당 환경 변수가 존재하지 않습니다 $ python main.py Hello World from Python diff --git a/docs/ko/docs/features.md b/docs/ko/docs/features.md index 17cc9289f7..b511ae4707 100644 --- a/docs/ko/docs/features.md +++ b/docs/ko/docs/features.md @@ -6,7 +6,7 @@ ### 개방형 표준을 기반으로 { #based-on-open-standards } -* OpenAPI: path operations, 매개변수, 요청 본문, 보안 등의 선언을 포함하여 API를 생성합니다. +* OpenAPI: 경로 처리, 매개변수, 요청 본문, 보안 등의 선언을 포함하여 API를 생성합니다. * JSON Schema를 사용한 자동 데이터 모델 문서화(OpenAPI 자체가 JSON Schema를 기반으로 하기 때문입니다). * 단순히 떠올려서 덧붙인 레이어가 아니라, 세심한 검토를 거친 뒤 이러한 표준을 중심으로 설계되었습니다. * 이는 또한 다양한 언어로 자동 **클라이언트 코드 생성**을 사용할 수 있게 해줍니다. @@ -136,7 +136,7 @@ Python 개발자 설문조사에서 Dependency Injection 시스템을 포함하고 있습니다. +FastAPI는 사용하기 매우 쉽지만, 매우 강력한 의존성 주입 시스템을 포함하고 있습니다. * 의존성도 의존성을 가질 수 있어, 의존성의 계층 또는 **의존성의 "그래프"**를 생성합니다. * 모든 것이 프레임워크에 의해 **자동으로 처리됩니다**. @@ -153,8 +153,8 @@ FastAPI는 사용하기 매우 쉽지만, 매우 강력한 IDE/linter/뇌**와 잘 어울립니다: +* 여러분의 **IDE/린터/뇌**와 잘 어울립니다: * pydantic 데이터 구조는 여러분이 정의한 클래스 인스턴스일 뿐이므로, 자동 완성, 린팅, mypy, 그리고 직관까지도 검증된 데이터와 함께 제대로 작동합니다. * **복잡한 구조**를 검증합니다: * 계층적인 Pydantic 모델, Python `typing`의 `List`와 `Dict` 등을 사용합니다. diff --git a/docs/ko/docs/how-to/authentication-error-status-code.md b/docs/ko/docs/how-to/authentication-error-status-code.md index 47120cae68..e039c073e9 100644 --- a/docs/ko/docs/how-to/authentication-error-status-code.md +++ b/docs/ko/docs/how-to/authentication-error-status-code.md @@ -8,10 +8,10 @@ FastAPI 버전 `0.122.0`부터는 더 적절한 HTTP 상태 코드 `401 Unauthor 예를 들어, 기본값인 `401 Unauthorized` 오류 대신 `403 Forbidden` 오류를 반환하는 `HTTPBearer`의 서브클래스를 만들 수 있습니다: -{* ../../docs_src/authentication_error_status_code/tutorial001_an_py39.py hl[9:13] *} +{* ../../docs_src/authentication_error_status_code/tutorial001_an_py310.py hl[9:13] *} /// tip | 팁 -함수는 예외를 `raise`하는 것이 아니라 예외 인스턴스를 `return`한다는 점에 유의하세요. 예외를 발생시키는(`raise`) 작업은 내부 코드의 나머지 부분에서 수행됩니다. +함수는 예외를 `return`하는 것이지 `raise`하지 않는다는 점에 유의하세요. 예외를 발생시키는(`raise`) 작업은 내부 코드의 나머지 부분에서 수행됩니다. /// diff --git a/docs/ko/docs/how-to/conditional-openapi.md b/docs/ko/docs/how-to/conditional-openapi.md index 16e6833661..3a87bf010b 100644 --- a/docs/ko/docs/how-to/conditional-openapi.md +++ b/docs/ko/docs/how-to/conditional-openapi.md @@ -4,7 +4,7 @@ ## 보안, API 및 docs에 대해서 { #about-security-apis-and-docs } -프로덕션에서, 문서화된 사용자 인터페이스(UI)를 숨기는 것이 API를 보호하는 방법이 *되어서는 안 됩니다*. +프로덕션에서, 문서화된 사용자 인터페이스(UI)를 숨기는 것이 API를 보호하는 방법이 되어서는 안 됩니다. 이는 API에 추가적인 보안을 제공하지 않으며, *경로 처리*는 여전히 동일한 위치에서 사용 할 수 있습니다. @@ -29,7 +29,7 @@ API를 보호하고 싶다면, 예를 들어 다음과 같은 더 나은 방법 예를 들어: -{* ../../docs_src/conditional_openapi/tutorial001_py39.py hl[6,11] *} +{* ../../docs_src/conditional_openapi/tutorial001_py310.py hl[6,11] *} 여기서 `openapi_url` 설정을 기본값인 `"/openapi.json"`으로 선언합니다. diff --git a/docs/ko/docs/how-to/configure-swagger-ui.md b/docs/ko/docs/how-to/configure-swagger-ui.md index 174f976f67..b518fd8f72 100644 --- a/docs/ko/docs/how-to/configure-swagger-ui.md +++ b/docs/ko/docs/how-to/configure-swagger-ui.md @@ -18,7 +18,7 @@ FastAPI는 이 구성을 **JSON** 형식으로 변환하여 JavaScript와 호환 그러나 `syntaxHighlight`를 `False`로 설정하여 구문 강조 기능을 비활성화할 수 있습니다: -{* ../../docs_src/configure_swagger_ui/tutorial001_py39.py hl[3] *} +{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *} ...그럼 Swagger UI에서 더 이상 구문 강조 기능이 표시되지 않습니다: @@ -28,7 +28,7 @@ FastAPI는 이 구성을 **JSON** 형식으로 변환하여 JavaScript와 호환 동일한 방식으로 `"syntaxHighlight.theme"` 키를 사용하여 구문 강조 테마를 설정할 수 있습니다 (중간에 점이 포함된 것을 참고하십시오). -{* ../../docs_src/configure_swagger_ui/tutorial002_py39.py hl[3] *} +{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *} 이 설정은 구문 강조 색상 테마를 변경합니다: @@ -42,11 +42,11 @@ FastAPI는 대부분의 사용 사례에 적합한 몇 가지 기본 구성 매 {* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *} -`swagger_ui_parameters` 인수에 다른 값을 설정하여 이러한 기본값 중 일부를 재정의할 수 있습니다. +`swagger_ui_parameters` 인수에 다른 값을 설정하여 이러한 기본값 중 어느 것이든 재정의할 수 있습니다. 예를 들어, `deepLinking`을 비활성화하려면 `swagger_ui_parameters`에 다음 설정을 전달할 수 있습니다: -{* ../../docs_src/configure_swagger_ui/tutorial003_py39.py hl[3] *} +{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *} ## 기타 Swagger UI 매개변수 { #other-swagger-ui-parameters } diff --git a/docs/ko/docs/how-to/custom-docs-ui-assets.md b/docs/ko/docs/how-to/custom-docs-ui-assets.md index d6383c29cb..7eb4b3cfdb 100644 --- a/docs/ko/docs/how-to/custom-docs-ui-assets.md +++ b/docs/ko/docs/how-to/custom-docs-ui-assets.md @@ -8,7 +8,7 @@ API 문서는 **Swagger UI**와 **ReDoc**을 사용하며, 각각 JavaScript와 ## JavaScript와 CSS용 커스텀 CDN { #custom-cdn-for-javascript-and-css } -예를 들어 다른 CDN을 사용하고 싶다고 해봅시다. 예를 들면 `https://unpkg.com/`을 사용하려는 경우입니다. +예를 들어 다른 CDN을 사용하고 싶다고 해봅시다. 예를 들면 `https://unpkg.com/`을 사용하려는 경우입니다. 이는 예를 들어 특정 국가에서 일부 URL을 제한하는 경우에 유용할 수 있습니다. @@ -18,7 +18,7 @@ API 문서는 **Swagger UI**와 **ReDoc**을 사용하며, 각각 JavaScript와 비활성화하려면 `FastAPI` 앱을 생성할 때 해당 URL을 `None`으로 설정하세요: -{* ../../docs_src/custom_docs_ui/tutorial001_py39.py hl[8] *} +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[8] *} ### 커스텀 문서 포함하기 { #include-the-custom-docs } @@ -34,7 +34,7 @@ FastAPI 내부 함수를 재사용해 문서용 HTML 페이지를 생성하고, ReDoc도 마찬가지입니다... -{* ../../docs_src/custom_docs_ui/tutorial001_py39.py hl[2:6,11:19,22:24,27:33] *} +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[2:6,11:19,22:24,27:33] *} /// tip | 팁 @@ -50,7 +50,7 @@ Swagger UI가 이 과정을 백그라운드에서 처리해 주지만, 이를 이제 모든 것이 제대로 동작하는지 테스트할 수 있도록 *경로 처리*를 하나 만드세요: -{* ../../docs_src/custom_docs_ui/tutorial001_py39.py hl[36:38] *} +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[36:38] *} ### 테스트하기 { #test-it } @@ -118,7 +118,7 @@ JavaScript와 CSS를 자체 호스팅하는 것은 예를 들어, 오프라인 * `StaticFiles`를 import합니다. * 특정 경로에 `StaticFiles()` 인스턴스를 "마운트(mount)"합니다. -{* ../../docs_src/custom_docs_ui/tutorial002_py39.py hl[7,11] *} +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[7,11] *} ### 정적 파일 테스트하기 { #test-the-static-files } @@ -144,7 +144,7 @@ JavaScript와 CSS를 자체 호스팅하는 것은 예를 들어, 오프라인 비활성화하려면 `FastAPI` 앱을 생성할 때 해당 URL을 `None`으로 설정하세요: -{* ../../docs_src/custom_docs_ui/tutorial002_py39.py hl[9] *} +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[9] *} ### 정적 파일을 위한 커스텀 문서 포함하기 { #include-the-custom-docs-for-static-files } @@ -160,7 +160,7 @@ JavaScript와 CSS를 자체 호스팅하는 것은 예를 들어, 오프라인 ReDoc도 마찬가지입니다... -{* ../../docs_src/custom_docs_ui/tutorial002_py39.py hl[2:6,14:22,25:27,30:36] *} +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[2:6,14:22,25:27,30:36] *} /// tip | 팁 @@ -176,7 +176,7 @@ Swagger UI가 이 과정을 백그라운드에서 처리해 주지만, 이를 이제 모든 것이 제대로 동작하는지 테스트할 수 있도록 *경로 처리*를 하나 만드세요: -{* ../../docs_src/custom_docs_ui/tutorial002_py39.py hl[39:41] *} +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[39:41] *} ### 정적 파일 UI 테스트하기 { #test-static-files-ui } diff --git a/docs/ko/docs/how-to/extending-openapi.md b/docs/ko/docs/how-to/extending-openapi.md index d04d6c23e3..0589e479bf 100644 --- a/docs/ko/docs/how-to/extending-openapi.md +++ b/docs/ko/docs/how-to/extending-openapi.md @@ -43,19 +43,19 @@ 먼저, 평소처럼 **FastAPI** 애플리케이션을 모두 작성합니다: -{* ../../docs_src/extending_openapi/tutorial001_py39.py hl[1,4,7:9] *} +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[1,4,7:9] *} ### OpenAPI 스키마 생성하기 { #generate-the-openapi-schema } 그다음 `custom_openapi()` 함수 안에서, 동일한 유틸리티 함수를 사용해 OpenAPI 스키마를 생성합니다: -{* ../../docs_src/extending_openapi/tutorial001_py39.py hl[2,15:21] *} +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[2,15:21] *} ### OpenAPI 스키마 수정하기 { #modify-the-openapi-schema } 이제 OpenAPI 스키마의 `info` "object"에 커스텀 `x-logo`를 추가하여 ReDoc 확장을 더할 수 있습니다: -{* ../../docs_src/extending_openapi/tutorial001_py39.py hl[22:24] *} +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[22:24] *} ### OpenAPI 스키마 캐시하기 { #cache-the-openapi-schema } @@ -65,13 +65,13 @@ 스키마는 한 번만 생성되고, 이후 요청에서는 같은 캐시된 스키마가 사용됩니다. -{* ../../docs_src/extending_openapi/tutorial001_py39.py hl[13:14,25:26] *} +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[13:14,25:26] *} ### 메서드 오버라이드하기 { #override-the-method } 이제 `.openapi()` 메서드를 새 함수로 교체할 수 있습니다. -{* ../../docs_src/extending_openapi/tutorial001_py39.py hl[29] *} +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[29] *} ### 확인하기 { #check-it } diff --git a/docs/ko/docs/how-to/graphql.md b/docs/ko/docs/how-to/graphql.md index 3cc467eb71..a960e6d8b2 100644 --- a/docs/ko/docs/how-to/graphql.md +++ b/docs/ko/docs/how-to/graphql.md @@ -35,7 +35,7 @@ 다음은 Strawberry를 FastAPI와 통합하는 방법에 대한 간단한 미리보기입니다: -{* ../../docs_src/graphql_/tutorial001_py39.py hl[3,22,25] *} +{* ../../docs_src/graphql_/tutorial001_py310.py hl[3,22,25] *} Strawberry 문서에서 Strawberry에 대해 더 알아볼 수 있습니다. diff --git a/docs/ko/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md b/docs/ko/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md index 6e528ecaf5..5dd40cbdc2 100644 --- a/docs/ko/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md +++ b/docs/ko/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md @@ -22,7 +22,7 @@ Pydantic v1을 사용하는 오래된 FastAPI 앱이 있다면, 여기서는 이 ## 공식 가이드 { #official-guide } -Pydantic에는 v1에서 v2로의 공식 Migration Guide가 있습니다. +Pydantic에는 v1에서 v2로의 공식 마이그레이션 가이드가 있습니다. 여기에는 무엇이 바뀌었는지, 검증이 이제 어떻게 더 정확하고 엄격해졌는지, 가능한 주의사항 등도 포함되어 있습니다. @@ -30,7 +30,7 @@ Pydantic에는 v1에서 v2로의 공식 - +
**Pydantic v2**의 이 기능 덕분에 API 문서는 더 **정밀**해지고, 자동 생성된 클라이언트와 SDK가 있다면 그것들도 더 정밀해져서 더 나은 **developer experience**와 일관성을 제공할 수 있습니다. 🎉 diff --git a/docs/ko/docs/index.md b/docs/ko/docs/index.md index 776b8c47c4..d2e08be16f 100644 --- a/docs/ko/docs/index.md +++ b/docs/ko/docs/index.md @@ -40,7 +40,7 @@ FastAPI는 현대적이고, 빠르며(고성능), 파이썬 표준 타입 힌트 * **빠름**: (Starlette과 Pydantic 덕분에) **NodeJS** 및 **Go**와 대등할 정도로 매우 높은 성능. [사용 가능한 가장 빠른 파이썬 프레임워크 중 하나](#performance). * **빠른 코드 작성**: 약 200%에서 300%까지 기능 개발 속도 증가. * * **적은 버그**: 사람(개발자)에 의한 에러 약 40% 감소. * -* **직관적**: 훌륭한 편집기 지원. 모든 곳에서 자동완성. 적은 디버깅 시간. +* **직관적**: 훌륭한 편집기 지원. 자동완성이 모든 곳에서 동작. 적은 디버깅 시간. * **쉬움**: 쉽게 사용하고 배우도록 설계. 적은 문서 읽기 시간. * **짧음**: 코드 중복 최소화. 각 매개변수 선언의 여러 기능. 적은 버그. * **견고함**: 준비된 프로덕션 용 코드를 얻으십시오. 자동 대화형 문서와 함께. @@ -368,7 +368,7 @@ item: Item * 데이터 검증: * 데이터가 유효하지 않을 때 자동으로 생성하는 명확한 에러. * 깊이 중첩된 JSON 객체에 대한 유효성 검사. -* 입력 데이터 변환: 네트워크에서 파이썬 데이터 및 타입으로 전송. 읽을 수 있는 것들: +* 입력 데이터 변환: 네트워크에서 파이썬 데이터 및 타입으로 전송. 읽을 수 있는 것들: * JSON. * 경로 매개변수. * 쿼리 매개변수. @@ -376,7 +376,7 @@ item: Item * 헤더. * 폼(Forms). * 파일. -* 출력 데이터 변환: 파이썬 데이터 및 타입을 네트워크 데이터로 전환(JSON 형식으로): +* 출력 데이터 변환: 파이썬 데이터 및 타입을 네트워크 데이터로 전환(JSON 형식으로): * 파이썬 타입 변환 (`str`, `int`, `float`, `bool`, `list`, 등). * `datetime` 객체. * `UUID` 객체. @@ -439,7 +439,7 @@ item: Item * 서로 다른 장소에서 **매개변수** 선언: **헤더**, **쿠키**, **폼 필드** 그리고 **파일**. * `maximum_length` 또는 `regex`처럼 **유효성 제약**하는 방법. -* 강력하고 사용하기 쉬운 **의존성 주입** 시스템. +* 강력하고 사용하기 쉬운 **의존성 주입** 시스템. * **OAuth2** 지원을 포함한 **JWT tokens** 및 **HTTP Basic**을 갖는 보안과 인증. * (Pydantic 덕분에) **깊은 중첩 JSON 모델**을 선언하는데 더 진보한 (하지만 마찬가지로 쉬운) 기술. * Strawberry 및 기타 라이브러리와의 **GraphQL** 통합. @@ -524,7 +524,7 @@ Starlette이 사용하는: * httpx - `TestClient`를 사용하려면 필요. * jinja2 - 기본 템플릿 설정을 사용하려면 필요. -* python-multipart - `request.form()`과 함께 form "parsing" 지원을 원하면 필요. +* python-multipart - `request.form()`과 함께 form "파싱" 지원을 원하면 필요. FastAPI가 사용하는: diff --git a/docs/ko/docs/project-generation.md b/docs/ko/docs/project-generation.md index 73ea67d3e5..e3120e6f80 100644 --- a/docs/ko/docs/project-generation.md +++ b/docs/ko/docs/project-generation.md @@ -2,7 +2,7 @@ 템플릿은 일반적으로 특정 설정과 함께 제공되지만, 유연하고 커스터마이징이 가능하게 디자인 되었습니다. 이 특성들은 여러분이 프로젝트의 요구사항에 맞춰 수정, 적용을 할 수 있게 해주고, 템플릿이 완벽한 시작점이 되게 해줍니다. 🏁 -많은 초기 설정, 보안, 데이터베이스 및 일부 API 엔드포인트가 이미 준비되어 있으므로, 여러분은 이 템플릿을 (프로젝트를) 시작하는 데 사용할 수 있습니다. +많은 초기 설정, 보안, 데이터베이스 및 일부 API 엔드포인트가 이미 준비되어 있으므로, 여러분은 이 템플릿을 시작하는 데 사용할 수 있습니다. GitHub 저장소: Full Stack FastAPI 템플릿 diff --git a/docs/ko/docs/python-types.md b/docs/ko/docs/python-types.md index dc264df805..d7d9021ed3 100644 --- a/docs/ko/docs/python-types.md +++ b/docs/ko/docs/python-types.md @@ -2,7 +2,7 @@ 파이썬은 선택적으로 "타입 힌트(type hints)"(“type annotations”라고도 함)를 지원합니다. -이러한 **"타입 힌트"** 또는 애너테이션은 변수의 타입을 선언할 수 있게 해주는 특수한 구문입니다. +이러한 **"타입 힌트"** 또는 애너테이션은 변수의 타입을 선언할 수 있게 해주는 특수한 구문입니다. 변수의 타입을 선언하면 에디터와 도구가 더 나은 지원을 제공할 수 있습니다. @@ -22,7 +22,7 @@ 간단한 예제로 시작해봅시다: -{* ../../docs_src/python_types/tutorial001_py39.py *} +{* ../../docs_src/python_types/tutorial001_py310.py *} 이 프로그램을 호출하면 다음이 출력됩니다: @@ -34,9 +34,9 @@ John Doe * `first_name`과 `last_name`를 받습니다. * `title()`로 각각의 첫 글자를 대문자로 변환합니다. -* 가운데에 공백을 두고 연결합니다. +* 가운데에 공백을 두고 연결합니다. -{* ../../docs_src/python_types/tutorial001_py39.py hl[2] *} +{* ../../docs_src/python_types/tutorial001_py310.py hl[2] *} ### 수정하기 { #edit-it } @@ -80,7 +80,7 @@ John Doe 이것들이 "타입 힌트"입니다: -{* ../../docs_src/python_types/tutorial002_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial002_py310.py hl[1] *} 이것은 다음처럼 기본값을 선언하는 것과는 다릅니다: @@ -108,7 +108,7 @@ John Doe 이 함수를 확인해보세요. 이미 타입 힌트가 있습니다: -{* ../../docs_src/python_types/tutorial003_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial003_py310.py hl[1] *} 에디터가 변수의 타입을 알고 있기 때문에, 자동완성만 되는 게 아니라 오류 검사도 할 수 있습니다: @@ -116,7 +116,7 @@ John Doe 이제 고쳐야 한다는 것을 알고, `age`를 `str(age)`로 문자열로 바꿉니다: -{* ../../docs_src/python_types/tutorial004_py39.py hl[2] *} +{* ../../docs_src/python_types/tutorial004_py310.py hl[2] *} ## 타입 선언 { #declaring-types } @@ -135,29 +135,32 @@ John Doe * `bool` * `bytes` -{* ../../docs_src/python_types/tutorial005_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial005_py310.py hl[1] *} -### 타입 매개변수가 있는 Generic(제네릭) 타입 { #generic-types-with-type-parameters } +### `typing` 모듈 { #typing-module } -`dict`, `list`, `set`, `tuple`처럼 다른 값을 담을 수 있는 데이터 구조가 있습니다. 그리고 내부 값에도 각자의 타입이 있을 수 있습니다. +몇 가지 추가적인 사용 사례에서는 표준 라이브러리의 `typing` 모듈에서 무언가를 import해야 할 수 있습니다. 예를 들어 어떤 값이 "아무 타입"일 수 있다고 선언하려면, `typing`의 `Any`를 사용할 수 있습니다: -이렇게 내부 타입을 가지는 타입을 "**generic**" 타입이라고 부릅니다. 그리고 내부 타입까지 포함해 선언할 수도 있습니다. +```python +from typing import Any -이런 타입과 내부 타입을 선언하려면 표준 파이썬 모듈 `typing`을 사용할 수 있습니다. 이 모듈은 이러한 타입 힌트를 지원하기 위해 존재합니다. -#### 더 최신 버전의 Python { #newer-versions-of-python } +def some_function(data: Any): + print(data) +``` -`typing`을 사용하는 문법은 Python 3.6부터 최신 버전까지, Python 3.9, Python 3.10 등을 포함한 모든 버전과 **호환**됩니다. +### Generic(제네릭) 타입 { #generic-types } -파이썬이 발전함에 따라 **더 최신 버전**에서는 이러한 타입 애너테이션 지원이 개선되며, 많은 경우 타입 애너테이션을 선언하기 위해 `typing` 모듈을 import해서 사용할 필요조차 없게 됩니다. +일부 타입은 대괄호 안에 "타입 매개변수"를 받아 내부 타입을 정의할 수 있습니다. 예를 들어 "문자열의 리스트"는 `list[str]`로 선언합니다. -프로젝트에서 더 최신 버전의 파이썬을 선택할 수 있다면, 그 추가적인 단순함을 활용할 수 있습니다. +이렇게 타입 매개변수를 받을 수 있는 타입을 **Generic types** 또는 **Generics**라고 부릅니다. -이 문서 전체에는 각 파이썬 버전과 호환되는 예제가 있습니다(차이가 있을 때). +대괄호와 내부 타입을 사용해 동일한 내장 타입들을 제네릭으로 사용할 수 있습니다: -예를 들어 "**Python 3.6+**"는 Python 3.6 이상(3.7, 3.8, 3.9, 3.10 등 포함)과 호환된다는 뜻입니다. 그리고 "**Python 3.9+**"는 Python 3.9 이상(3.10 등 포함)과 호환된다는 뜻입니다. - -**최신 버전의 Python**을 사용할 수 있다면, 최신 버전용 예제를 사용하세요. 예를 들어 "**Python 3.10+**"처럼, 가장 **좋고 가장 단순한 문법**을 갖게 됩니다. +* `list` +* `tuple` +* `set` +* `dict` #### List { #list } @@ -169,7 +172,7 @@ John Doe `list`는 내부 타입을 포함하는 타입이므로, 그 타입들을 대괄호 안에 넣습니다: -{* ../../docs_src/python_types/tutorial006_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial006_py310.py hl[1] *} /// info | 정보 @@ -195,7 +198,7 @@ John Doe `tuple`과 `set`도 동일하게 선언할 수 있습니다: -{* ../../docs_src/python_types/tutorial007_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial007_py310.py hl[1] *} 이는 다음을 의미합니다: @@ -210,7 +213,7 @@ John Doe 두 번째 타입 매개변수는 `dict`의 값을 위한 것입니다: -{* ../../docs_src/python_types/tutorial008_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial008_py310.py hl[1] *} 이는 다음을 의미합니다: @@ -222,44 +225,20 @@ John Doe 변수가 **여러 타입 중 어떤 것이든** 될 수 있다고 선언할 수 있습니다. 예를 들어 `int` 또는 `str`입니다. -Python 3.6 이상(3.10 포함)에서는 `typing`의 `Union` 타입을 사용하고, 대괄호 안에 허용할 수 있는 타입들을 넣을 수 있습니다. +이를 정의하려면 두 타입을 세로 막대(`|`)로 구분해 사용합니다. -Python 3.10에는 가능한 타입들을 세로 막대(`|`)로 구분해 넣을 수 있는 **새 문법**도 있습니다. - -//// tab | Python 3.10+ +이는 두 타입 집합의 합집합(union) 안의 어느 것이든 될 수 있다는 뜻이므로 "유니온"이라고 부릅니다. ```Python hl_lines="1" {!> ../../docs_src/python_types/tutorial008b_py310.py!} ``` -//// - -//// tab | Python 3.9+ - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial008b_py39.py!} -``` - -//// - -두 경우 모두 이는 `item`이 `int` 또는 `str`일 수 있다는 뜻입니다. +이는 `item`이 `int` 또는 `str`일 수 있다는 뜻입니다. #### `None`일 수도 있음 { #possibly-none } 값이 `str` 같은 타입일 수도 있지만, `None`일 수도 있다고 선언할 수 있습니다. -Python 3.6 이상(3.10 포함)에서는 `typing` 모듈에서 `Optional`을 import해서 사용하여 선언할 수 있습니다. - -```Python hl_lines="1 4" -{!../../docs_src/python_types/tutorial009_py39.py!} -``` - -그냥 `str` 대신 `Optional[str]`을 사용하면, 값이 항상 `str`이라고 가정하고 있지만 실제로는 `None`일 수도 있는 상황에서 에디터가 오류를 감지하도록 도와줍니다. - -`Optional[Something]`은 사실 `Union[Something, None]`의 축약이며, 서로 동등합니다. - -또한 이는 Python 3.10에서 `Something | None`을 사용할 수 있다는 의미이기도 합니다: - //// tab | Python 3.10+ ```Python hl_lines="1" @@ -268,96 +247,7 @@ Python 3.6 이상(3.10 포함)에서는 `typing` 모듈에서 `Optional`을 impo //// -//// tab | Python 3.9+ - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial009_py39.py!} -``` - -//// - -//// tab | Python 3.9+ alternative - -```Python hl_lines="1 4" -{!> ../../docs_src/python_types/tutorial009b_py39.py!} -``` - -//// - -#### `Union` 또는 `Optional` 사용하기 { #using-union-or-optional } - -Python 3.10 미만 버전을 사용한다면, 아주 **주관적인** 관점에서의 팁입니다: - -* 🚨 `Optional[SomeType]` 사용을 피하세요 -* 대신 ✨ **`Union[SomeType, None]`을 사용하세요** ✨. - -둘은 동등하고 내부적으로는 같은 것이지만, `Optional`이라는 단어가 값이 선택 사항인 것처럼 보일 수 있기 때문에 `Optional` 대신 `Union`을 권장합니다. 실제 의미는 값이 선택 사항이라는 뜻이 아니라, "값이 `None`일 수 있다"는 뜻이기 때문입니다. 선택 사항이 아니고 여전히 필수인 경우에도요. - -`Union[SomeType, None]`이 의미를 더 명확하게 드러낸다고 생각합니다. - -이건 단지 단어와 이름의 문제입니다. 하지만 그런 단어들이 여러분과 팀원이 코드에 대해 생각하는 방식에 영향을 줄 수 있습니다. - -예로, 이 함수를 봅시다: - -{* ../../docs_src/python_types/tutorial009c_py39.py hl[1,4] *} - -매개변수 `name`은 `Optional[str]`로 정의되어 있지만, **선택 사항이 아닙니다**. 매개변수 없이 함수를 호출할 수 없습니다: - -```Python -say_hi() # Oh, no, this throws an error! 😱 -``` - -기본값이 없기 때문에 `name` 매개변수는 **여전히 필수입니다**(*optional*이 아님). 그럼에도 `name`은 값으로 `None`을 허용합니다: - -```Python -say_hi(name=None) # This works, None is valid 🎉 -``` - -좋은 소식은 Python 3.10을 사용하면, 타입의 유니온을 정의하기 위해 간단히 `|`를 사용할 수 있어서 이런 걱정을 할 필요가 없다는 점입니다: - -{* ../../docs_src/python_types/tutorial009c_py310.py hl[1,4] *} - -그러면 `Optional`이나 `Union` 같은 이름에 대해 걱정할 필요도 없습니다. 😎 - -#### Generic(제네릭) 타입 { #generic-types } - -대괄호 안에 타입 매개변수를 받는 이러한 타입들은 **Generic types** 또는 **Generics**라고 부릅니다. 예를 들면: - -//// tab | Python 3.10+ - -대괄호와 내부 타입을 사용해, 동일한 내장 타입들을 제네릭으로 사용할 수 있습니다: - -* `list` -* `tuple` -* `set` -* `dict` - -그리고 이전 파이썬 버전과 마찬가지로 `typing` 모듈의 다음도 사용할 수 있습니다: - -* `Union` -* `Optional` -* ...그 밖의 것들. - -Python 3.10에서는 제네릭 `Union`과 `Optional`을 사용하는 대안으로, 타입 유니온을 선언하기 위해 세로 막대(`|`)를 사용할 수 있는데, 훨씬 더 좋고 단순합니다. - -//// - -//// tab | Python 3.9+ - -대괄호와 내부 타입을 사용해, 동일한 내장 타입들을 제네릭으로 사용할 수 있습니다: - -* `list` -* `tuple` -* `set` -* `dict` - -그리고 `typing` 모듈의 제네릭들: - -* `Union` -* `Optional` -* ...그 밖의 것들. - -//// +그냥 `str` 대신 `str | None`을 사용하면, 값이 항상 `str`이라고 가정하고 있지만 실제로는 `None`일 수도 있는 상황에서 에디터가 오류를 감지하도록 도와줍니다. ### 타입으로서의 클래스 { #classes-as-types } @@ -365,11 +255,11 @@ Python 3.10에서는 제네릭 `Union`과 `Optional`을 사용하는 대안으 이름을 가진 `Person` 클래스가 있다고 해봅시다: -{* ../../docs_src/python_types/tutorial010_py39.py hl[1:3] *} +{* ../../docs_src/python_types/tutorial010_py310.py hl[1:3] *} 그러면 `Person` 타입의 변수를 선언할 수 있습니다: -{* ../../docs_src/python_types/tutorial010_py39.py hl[6] *} +{* ../../docs_src/python_types/tutorial010_py310.py hl[6] *} 그리고 다시, 에디터의 모든 지원을 받을 수 있습니다: @@ -405,19 +295,13 @@ Pydantic 공식 문서의 예시: 이 모든 것은 [자습서 - 사용자 안내서](tutorial/index.md){.internal-link target=_blank}에서 실제로 많이 보게 될 것입니다. -/// tip | 팁 - -Pydantic은 기본값 없이 `Optional` 또는 `Union[Something, None]`을 사용할 때 특별한 동작이 있습니다. 이에 대해서는 Pydantic 문서의 Required Optional fields에서 더 읽을 수 있습니다. - -/// - ## 메타데이터 애너테이션이 있는 타입 힌트 { #type-hints-with-metadata-annotations } -파이썬에는 `Annotated`를 사용해 이러한 타입 힌트에 **추가 메타데이터**를 넣을 수 있는 기능도 있습니다. +파이썬에는 `Annotated`를 사용해 이러한 타입 힌트에 **추가 메타데이터**를 넣을 수 있는 기능도 있습니다. -Python 3.9부터 `Annotated`는 표준 라이브러리의 일부이므로, `typing`에서 import할 수 있습니다. +`Annotated`는 `typing`에서 import할 수 있습니다. -{* ../../docs_src/python_types/tutorial013_py39.py hl[1,4] *} +{* ../../docs_src/python_types/tutorial013_py310.py hl[1,4] *} 파이썬 자체는 이 `Annotated`로 아무것도 하지 않습니다. 그리고 에디터와 다른 도구들에게는 타입이 여전히 `str`입니다. diff --git a/docs/ko/docs/resources/index.md b/docs/ko/docs/resources/index.md index 477b93a584..f8ec8dddde 100644 --- a/docs/ko/docs/resources/index.md +++ b/docs/ko/docs/resources/index.md @@ -1,3 +1,3 @@ # 리소스 { #resources } -추가 리소스, 외부 링크 등. ✈️ +추가 리소스, 외부 링크, 그리고 더 많은 자료. ✈️ diff --git a/docs/ko/docs/translation-banner.md b/docs/ko/docs/translation-banner.md new file mode 100644 index 0000000000..7bcd907d56 --- /dev/null +++ b/docs/ko/docs/translation-banner.md @@ -0,0 +1,11 @@ +/// details | 🌐 AI와 사람이 함께한 번역 + +이 번역은 사람의 안내를 받아 AI가 만들었습니다. 🤝 + +원문의 의미를 오해하거나 부자연스러워 보이는 등 오류가 있을 수 있습니다. 🤖 + +[AI LLM을 더 잘 안내하는 데 도움을 주세요](https://fastapi.tiangolo.com/ko/contributing/#translations). + +[영문 버전](ENGLISH_VERSION_URL) + +/// diff --git a/docs/ko/docs/tutorial/background-tasks.md b/docs/ko/docs/tutorial/background-tasks.md index 9e868f2fa7..f23902e11f 100644 --- a/docs/ko/docs/tutorial/background-tasks.md +++ b/docs/ko/docs/tutorial/background-tasks.md @@ -15,7 +15,7 @@ FastAPI에서는 응답을 반환한 *후에* 실행할 백그라운드 작업 먼저 `BackgroundTasks`를 임포트하고, `BackgroundTasks` 타입 선언으로 *경로 처리 함수*에 매개변수를 정의합니다: -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[1,13] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[1,13] *} **FastAPI**가 `BackgroundTasks` 타입의 객체를 생성하고 해당 매개변수로 전달합니다. @@ -31,13 +31,13 @@ FastAPI에서는 응답을 반환한 *후에* 실행할 백그라운드 작업 그리고 쓰기 작업은 `async`와 `await`를 사용하지 않으므로, 일반 `def`로 함수를 정의합니다: -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[6:9] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[6:9] *} ## 백그라운드 작업 추가 { #add-the-background-task } *경로 처리 함수* 내부에서 `.add_task()` 메서드로 작업 함수를 *백그라운드 작업* 객체에 전달합니다: -{* ../../docs_src/background_tasks/tutorial001_py39.py hl[14] *} +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[14] *} `.add_task()`는 다음 인자를 받습니다: diff --git a/docs/ko/docs/tutorial/bigger-applications.md b/docs/ko/docs/tutorial/bigger-applications.md index cfc3900d4c..1b9d17e49a 100644 --- a/docs/ko/docs/tutorial/bigger-applications.md +++ b/docs/ko/docs/tutorial/bigger-applications.md @@ -58,17 +58,17 @@ from app.routers import items ```bash . -├── app # "app" is a Python package -│   ├── __init__.py # this file makes "app" a "Python package" -│   ├── main.py # "main" module, e.g. import app.main -│   ├── dependencies.py # "dependencies" module, e.g. import app.dependencies -│   └── routers # "routers" is a "Python subpackage" -│   │ ├── __init__.py # makes "routers" a "Python subpackage" -│   │ ├── items.py # "items" submodule, e.g. import app.routers.items -│   │ └── users.py # "users" submodule, e.g. import app.routers.users -│   └── internal # "internal" is a "Python subpackage" -│   ├── __init__.py # makes "internal" a "Python subpackage" -│   └── admin.py # "admin" submodule, e.g. import app.internal.admin +├── app # 'app'은 Python 패키지입니다 +│   ├── __init__.py # 이 파일로 'app'이 'Python 패키지'가 됩니다 +│   ├── main.py # 'main' 모듈, 예: import app.main +│   ├── dependencies.py # 'dependencies' 모듈, 예: import app.dependencies +│   └── routers # 'routers'는 'Python 하위 패키지'입니다 +│   │ ├── __init__.py # 이 파일로 'routers'가 'Python 하위 패키지'가 됩니다 +│   │ ├── items.py # 'items' 서브모듈, 예: import app.routers.items +│   │ └── users.py # 'users' 서브모듈, 예: import app.routers.users +│   └── internal # 'internal'은 'Python 하위 패키지'입니다 +│   ├── __init__.py # 이 파일로 'internal'이 'Python 하위 패키지'가 됩니다 +│   └── admin.py # 'admin' 서브모듈, 예: import app.internal.admin ``` ## `APIRouter` { #apirouter } @@ -85,7 +85,7 @@ from app.routers import items `FastAPI` 클래스와 동일한 방식으로 import하고 "instance"를 생성합니다: -{* ../../docs_src/bigger_applications/app_an_py39/routers/users.py hl[1,3] title["app/routers/users.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *} ### `APIRouter`로 *path operations* 만들기 { #path-operations-with-apirouter } @@ -93,7 +93,7 @@ from app.routers import items `FastAPI` 클래스를 사용할 때와 동일한 방식으로 사용합니다: -{* ../../docs_src/bigger_applications/app_an_py39/routers/users.py hl[6,11,16] title["app/routers/users.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[6,11,16] title["app/routers/users.py"] *} `APIRouter`는 "미니 `FastAPI`" 클래스라고 생각할 수 있습니다. @@ -117,7 +117,7 @@ from app.routers import items 이제 간단한 dependency를 사용해 커스텀 `X-Token` 헤더를 읽어 보겠습니다: -{* ../../docs_src/bigger_applications/app_an_py39/dependencies.py hl[3,6:8] title["app/dependencies.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/dependencies.py hl[3,6:8] title["app/dependencies.py"] *} /// tip | 팁 @@ -149,7 +149,7 @@ from app.routers import items 따라서 각 *path operation*마다 매번 모두 추가하는 대신, `APIRouter`에 한 번에 추가할 수 있습니다. -{* ../../docs_src/bigger_applications/app_an_py39/routers/items.py hl[5:10,16,21] title["app/routers/items.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[5:10,16,21] title["app/routers/items.py"] *} 각 *path operation*의 경로는 다음처럼 `/`로 시작해야 하므로: @@ -208,7 +208,7 @@ async def read_item(item_id: str): 그래서 dependencies에 대해 `..`를 사용하는 상대 import를 사용합니다: -{* ../../docs_src/bigger_applications/app_an_py39/routers/items.py hl[3] title["app/routers/items.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[3] title["app/routers/items.py"] *} #### 상대 import가 동작하는 방식 { #how-relative-imports-work } @@ -279,7 +279,7 @@ from ...dependencies import get_token_header 하지만 특정 *path operation*에만 적용될 _추가_ `tags`를 더할 수도 있고, 그 *path operation* 전용의 추가 `responses`도 넣을 수 있습니다: -{* ../../docs_src/bigger_applications/app_an_py39/routers/items.py hl[30:31] title["app/routers/items.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[30:31] title["app/routers/items.py"] *} /// tip | 팁 @@ -305,13 +305,13 @@ from ...dependencies import get_token_header 또한 각 `APIRouter`의 dependencies와 결합될 [global dependencies](dependencies/global-dependencies.md){.internal-link target=_blank}도 선언할 수 있습니다: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[1,3,7] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[1,3,7] title["app/main.py"] *} ### `APIRouter` import하기 { #import-the-apirouter } 이제 `APIRouter`가 있는 다른 submodule들을 import합니다: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[4:5] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[4:5] title["app/main.py"] *} `app/routers/users.py`와 `app/routers/items.py` 파일은 같은 Python package `app`에 속한 submodule들이므로, 점 하나 `.`를 사용해 "상대 import"로 가져올 수 있습니다. @@ -374,13 +374,13 @@ from .routers.users import router 따라서 같은 파일에서 둘 다 사용할 수 있도록 submodule들을 직접 import합니다: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[5] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[5] title["app/main.py"] *} ### `users`와 `items`용 `APIRouter` 포함하기 { #include-the-apirouters-for-users-and-items } 이제 submodule `users`와 `items`의 `router`를 포함해 봅시다: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[10:11] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[10:11] title["app/main.py"] *} /// info | 정보 @@ -394,7 +394,7 @@ from .routers.users import router 그 router의 모든 route가 애플리케이션의 일부로 포함됩니다. -/// note Technical Details | 기술 세부사항 +/// note | 기술 세부사항 내부적으로는 `APIRouter`에 선언된 각 *path operation*마다 *path operation*을 실제로 생성합니다. @@ -420,13 +420,13 @@ router를 포함(include)할 때 성능을 걱정할 필요는 없습니다. 이 예시에서는 매우 단순하게 만들겠습니다. 하지만 조직 내 다른 프로젝트와 공유되기 때문에, 이를 수정할 수 없어 `prefix`, `dependencies`, `tags` 등을 `APIRouter`에 직접 추가할 수 없다고 해봅시다: -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} 하지만 `APIRouter`를 포함할 때 커스텀 `prefix`를 지정해 모든 *path operations*가 `/admin`으로 시작하게 하고, 이 프로젝트에서 이미 가진 `dependencies`로 보호하고, `tags`와 `responses`도 포함하고 싶습니다. 원래 `APIRouter`를 수정하지 않고도 `app.include_router()`에 파라미터를 전달해서 이를 선언할 수 있습니다: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[14:17] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[14:17] title["app/main.py"] *} 이렇게 하면 원래 `APIRouter`는 수정되지 않으므로, 조직 내 다른 프로젝트에서도 동일한 `app/internal/admin.py` 파일을 계속 공유할 수 있습니다. @@ -447,11 +447,11 @@ router를 포함(include)할 때 성능을 걱정할 필요는 없습니다. 여기서는 가능하다는 것을 보여주기 위해... 그냥 해봅니다 🤷: -{* ../../docs_src/bigger_applications/app_an_py39/main.py hl[21:23] title["app/main.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[21:23] title["app/main.py"] *} 그리고 `app.include_router()`로 추가한 다른 모든 *path operations*와 함께 올바르게 동작합니다. -/// info | 정보 +/// info | 매우 기술적인 세부사항 **참고**: 이는 매우 기술적인 세부사항이라 아마 **그냥 건너뛰어도 됩니다**. diff --git a/docs/ko/docs/tutorial/body-fields.md b/docs/ko/docs/tutorial/body-fields.md index c98734ab37..0774dc4413 100644 --- a/docs/ko/docs/tutorial/body-fields.md +++ b/docs/ko/docs/tutorial/body-fields.md @@ -48,8 +48,8 @@ /// warning | 경고 -별도 키가 전달된 `Field` 또한 여러분의 어플리케이션의 OpenAPI 스키마에 나타날 것입니다. -이런 키가 OpenAPI 명세서, [the OpenAPI validator](https://validator.swagger.io/)같은 몇몇 OpenAPI 도구들에 포함되지 못할 수 있으며, 여러분이 생성한 스키마와 호환되지 않을 수 있습니다. +별도 키가 전달된 `Field` 또한 여러분의 애플리케이션의 OpenAPI 스키마에 나타날 것입니다. +이런 키가 OpenAPI 명세서의 일부가 아닐 수도 있으므로, [OpenAPI validator](https://validator.swagger.io/) 같은 몇몇 OpenAPI 도구들은 여러분이 생성한 스키마와 호환되지 않을 수 있습니다. /// diff --git a/docs/ko/docs/tutorial/body-multiple-params.md b/docs/ko/docs/tutorial/body-multiple-params.md index bebdffed80..3db614d72b 100644 --- a/docs/ko/docs/tutorial/body-multiple-params.md +++ b/docs/ko/docs/tutorial/body-multiple-params.md @@ -106,13 +106,6 @@ q: str | None = None ``` -또는 Python 3.9에서는: - -```Python -q: Union[str, None] = None -``` - - 예를 들어: {* ../../docs_src/body_multiple_params/tutorial004_an_py310.py hl[28] *} diff --git a/docs/ko/docs/tutorial/body-nested-models.md b/docs/ko/docs/tutorial/body-nested-models.md index 4a8c1afc13..33f0f71e95 100644 --- a/docs/ko/docs/tutorial/body-nested-models.md +++ b/docs/ko/docs/tutorial/body-nested-models.md @@ -164,7 +164,7 @@ images: list[Image] 이를 아래처럼: -{* ../../docs_src/body_nested_models/tutorial008_py39.py hl[13] *} +{* ../../docs_src/body_nested_models/tutorial008_py310.py hl[13] *} ## 어디서나 편집기 지원 { #editor-support-everywhere } @@ -194,7 +194,7 @@ Pydantic 모델 대신 `dict`로 직접 작업한다면 이런 종류의 편집 이 경우, `int` 키와 `float` 값을 가진 한 어떤 `dict`든 받아들입니다: -{* ../../docs_src/body_nested_models/tutorial009_py39.py hl[7] *} +{* ../../docs_src/body_nested_models/tutorial009_py310.py hl[7] *} /// tip | 팁 diff --git a/docs/ko/docs/tutorial/body.md b/docs/ko/docs/tutorial/body.md index 1e66c60c22..b282d1cc92 100644 --- a/docs/ko/docs/tutorial/body.md +++ b/docs/ko/docs/tutorial/body.md @@ -74,7 +74,7 @@ * 매개변수 `item`에 포함된 수신 데이터를 제공합니다. * 함수 내에서 매개변수를 `Item` 타입으로 선언했기 때문에, 모든 어트리뷰트와 그에 대한 타입에 대한 편집기 지원(완성 등)을 또한 받을 수 있습니다. * 여러분의 모델을 위한 JSON Schema 정의를 생성합니다. 여러분의 프로젝트에 적합하다면 여러분이 사용하고 싶은 곳 어디에서나 사용할 수 있습니다. -* 이러한 스키마는, 생성된 OpenAPI 스키마 일부가 될 것이며, 자동 문서화 UIs에 사용됩니다. +* 이러한 스키마는, 생성된 OpenAPI 스키마 일부가 될 것이며, 자동 문서화 UIs에 사용됩니다. ## 자동 문서화 { #automatic-docs } @@ -141,7 +141,7 @@ **본문**, **경로** 그리고 **쿼리** 매개변수 모두 동시에 선언할 수도 있습니다. -**FastAPI**는 각각을 인지하고 데이터를 옳바른 위치에 가져올 것입니다. +**FastAPI**는 각각을 인지하고 데이터를 올바른 위치에 가져올 것입니다. {* ../../docs_src/body/tutorial004_py310.py hl[16] *} @@ -153,9 +153,9 @@ /// note | 참고 -FastAPI는 `q`의 값이 필요없음을 알게 될 것입니다. 기본 값이 `= None`이기 때문입니다. +FastAPI는 `q`의 값이 필요없음을 기본 값 `= None` 때문에 알게 됩니다. -Python 3.10+의 `str | None` 또는 Python 3.9+의 `Union[str, None]`에 있는 `Union`은 FastAPI가 `q` 값이 필수가 아님을 판단하기 위해 사용하지 않습니다. 기본 값이 `= None`이기 때문에 필수가 아님을 알게 됩니다. +`str | None`은 FastAPI가 값이 필수인지 아닌지를 판단하기 위해 사용하지 않습니다. 기본 값이 `= None`이므로 필수가 아님을 알게 됩니다. 하지만 타입 어노테이션을 추가하면 편집기가 더 나은 지원을 제공하고 오류를 감지할 수 있습니다. diff --git a/docs/ko/docs/tutorial/cookie-param-models.md b/docs/ko/docs/tutorial/cookie-param-models.md index 00238d1b79..70b76e09ce 100644 --- a/docs/ko/docs/tutorial/cookie-param-models.md +++ b/docs/ko/docs/tutorial/cookie-param-models.md @@ -46,7 +46,7 @@ 일부 특별한 사용 사례(흔하지는 않겠지만)에서는 수신하려는 쿠키를 **제한**할 수 있습니다. -이제 API는 자신의 cookie consent를 제어할 수 있는 권한을 갖게 되었습니다. 🤪🍪 +이제 API는 자신의 쿠키 동의를 제어할 수 있는 권한을 갖게 되었습니다. 🤪🍪 Pydantic의 모델 구성을 사용하여 추가(`extra`) 필드를 금지(`forbid`)할 수 있습니다: @@ -54,9 +54,9 @@ Pydantic의 모델 구성을 사용하여 추가(`extra`) 필드를 금지(`forb 클라이언트가 **추가 쿠키**를 보내려고 시도하면, **오류** 응답을 받게 됩니다. -동의를 얻기 위해 애쓰는 불쌍한 쿠키 배너(팝업)들, API가 거부하는데도. 🍪 +동의를 얻기 위해 애쓰는 불쌍한 쿠키 배너(팝업)들, API가 거부하는데도. 🍪 -예를 들어, 클라이언트가 `good-list-please` 값으로 `santa_tracker` 쿠키를 보내려고 하면 클라이언트는 `santa_tracker` 쿠키가 허용되지 않는다는 **오류** 응답을 받게 됩니다: +예를 들어, 클라이언트가 `good-list-please` 값으로 `santa_tracker` 쿠키를 보내려고 하면 클라이언트는 `santa_tracker` 쿠키가 허용되지 않는다는 **오류** 응답을 받게 됩니다: ```json { @@ -73,4 +73,4 @@ Pydantic의 모델 구성을 사용하여 추가(`extra`) 필드를 금지(`forb ## 요약 { #summary } -**Pydantic 모델**을 사용하여 **FastAPI**에서 **쿠키**를 선언할 수 있습니다. 😎 +**Pydantic 모델**을 사용하여 **FastAPI**에서 **쿠키**를 선언할 수 있습니다. 😎 diff --git a/docs/ko/docs/tutorial/cookie-params.md b/docs/ko/docs/tutorial/cookie-params.md index 0591a5e96b..6ea09101c3 100644 --- a/docs/ko/docs/tutorial/cookie-params.md +++ b/docs/ko/docs/tutorial/cookie-params.md @@ -24,13 +24,13 @@ /// -/// info | 정보 +/// info 쿠키를 선언하기 위해서는 `Cookie`를 사용해야 합니다. 그렇지 않으면 해당 매개변수를 쿼리 매개변수로 해석하기 때문입니다. /// -/// info | 정보 +/// info **브라우저는 쿠키를** 내부적으로 특별한 방식으로 처리하기 때문에, **JavaScript**가 쉽게 쿠키를 다루도록 허용하지 않는다는 점을 염두에 두세요. diff --git a/docs/ko/docs/tutorial/cors.md b/docs/ko/docs/tutorial/cors.md index 0f3948a3dc..f78e1c0707 100644 --- a/docs/ko/docs/tutorial/cors.md +++ b/docs/ko/docs/tutorial/cors.md @@ -46,7 +46,7 @@ * 특정 HTTP 메서드(`POST`, `PUT`) 또는 와일드카드 `"*"`를 사용한 모든 메서드. * 특정 HTTP 헤더 또는 와일드카드 `"*"`를 사용한 모든 헤더. -{* ../../docs_src/cors/tutorial001_py39.py hl[2,6:11,13:19] *} +{* ../../docs_src/cors/tutorial001_py310.py hl[2,6:11,13:19] *} `CORSMiddleware` 구현에서 사용하는 기본 매개변수는 기본적으로 제한적이므로, 브라우저가 Cross-Domain 컨텍스트에서 특정 출처, 메서드 또는 헤더를 사용할 수 있도록 하려면 이를 명시적으로 활성화해야 합니다. @@ -78,7 +78,7 @@ ## 더 많은 정보 { #more-info } -CORS에 대한 더 많은 정보는 Mozilla CORS 문서를 참고하세요. +CORS에 대한 더 많은 정보는 Mozilla CORS 문서를 참고하세요. /// note | 기술 세부사항 diff --git a/docs/ko/docs/tutorial/debugging.md b/docs/ko/docs/tutorial/debugging.md index ca20acff64..c27b68bc1c 100644 --- a/docs/ko/docs/tutorial/debugging.md +++ b/docs/ko/docs/tutorial/debugging.md @@ -6,7 +6,7 @@ FastAPI 애플리케이션에서 `uvicorn`을 직접 임포트하여 실행합니다: -{* ../../docs_src/debugging/tutorial001_py39.py hl[1,15] *} +{* ../../docs_src/debugging/tutorial001_py310.py hl[1,15] *} ### `__name__ == "__main__"` 에 대하여 { #about-name-main } diff --git a/docs/ko/docs/tutorial/dependencies/classes-as-dependencies.md b/docs/ko/docs/tutorial/dependencies/classes-as-dependencies.md index 68bba669ae..83749f7b0a 100644 --- a/docs/ko/docs/tutorial/dependencies/classes-as-dependencies.md +++ b/docs/ko/docs/tutorial/dependencies/classes-as-dependencies.md @@ -101,7 +101,7 @@ FastAPI가 실제로 확인하는 것은 그것이 "호출 가능(callable)"(함 위 코드에서 `CommonQueryParams`를 두 번 작성하는 방식에 주목하세요: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] @@ -109,7 +109,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] //// -//// tab | Python 3.9+ non-Annotated +//// tab | Python 3.10+ Annotated 미사용 /// tip | 팁 @@ -137,7 +137,7 @@ FastAPI는 여기에서 선언된 매개변수들을 추출하고, 실제로 이 이 경우 첫 번째 `CommonQueryParams`는 다음에서: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, ... @@ -145,7 +145,7 @@ commons: Annotated[CommonQueryParams, ... //// -//// tab | Python 3.9+ non-Annotated +//// tab | Python 3.10+ Annotated 미사용 /// tip | 팁 @@ -163,7 +163,7 @@ commons: CommonQueryParams ... 실제로는 이렇게만 작성해도 됩니다: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[Any, Depends(CommonQueryParams)] @@ -171,7 +171,7 @@ commons: Annotated[Any, Depends(CommonQueryParams)] //// -//// tab | Python 3.9+ non-Annotated +//// tab | Python 3.10+ Annotated 미사용 /// tip | 팁 @@ -197,7 +197,7 @@ commons = Depends(CommonQueryParams) 하지만 `CommonQueryParams`를 두 번 작성하는 코드 반복이 있다는 것을 볼 수 있습니다: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] @@ -205,7 +205,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] //// -//// tab | Python 3.9+ non-Annotated +//// tab | Python 3.10+ Annotated 미사용 /// tip | 팁 @@ -225,7 +225,7 @@ commons: CommonQueryParams = Depends(CommonQueryParams) 다음처럼 작성하는 대신: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] @@ -233,7 +233,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] //// -//// tab | Python 3.9+ non-Annotated +//// tab | Python 3.10+ Annotated 미사용 /// tip | 팁 @@ -249,7 +249,7 @@ commons: CommonQueryParams = Depends(CommonQueryParams) ...이렇게 작성합니다: -//// tab | Python 3.9+ +//// tab | Python 3.10+ ```Python commons: Annotated[CommonQueryParams, Depends()] @@ -257,7 +257,7 @@ commons: Annotated[CommonQueryParams, Depends()] //// -//// tab | Python 3.9+ non-Annotated +//// tab | Python 3.10+ Annotated 미사용 /// tip | 팁 diff --git a/docs/ko/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md b/docs/ko/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md index 39c78c0786..d269e7e774 100644 --- a/docs/ko/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md +++ b/docs/ko/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md @@ -1,28 +1,28 @@ -# 경로 작동 데코레이터에서의 의존성 { #dependencies-in-path-operation-decorators } +# 경로 처리 데코레이터에서의 의존성 { #dependencies-in-path-operation-decorators } -몇몇 경우에는, *경로 작동 함수* 안에서 의존성의 반환 값이 필요하지 않습니다. +몇몇 경우에는, *경로 처리 함수* 안에서 의존성의 반환 값이 필요하지 않습니다. 또는 의존성이 값을 반환하지 않습니다. 그러나 여전히 실행/해결될 필요가 있습니다. -그런 경우에, `Depends`를 사용하여 *경로 작동 함수*의 매개변수로 선언하는 것보다 *경로 작동 데코레이터*에 `dependencies`의 `list`를 추가할 수 있습니다. +그런 경우에, `Depends`를 사용하여 *경로 처리 함수*의 매개변수로 선언하는 대신 *경로 처리 데코레이터*에 `dependencies`의 `list`를 추가할 수 있습니다. -## *경로 작동 데코레이터*에 `dependencies` 추가하기 { #add-dependencies-to-the-path-operation-decorator } +## *경로 처리 데코레이터*에 `dependencies` 추가하기 { #add-dependencies-to-the-path-operation-decorator } -*경로 작동 데코레이터*는 `dependencies`라는 선택적인 인자를 받습니다. +*경로 처리 데코레이터*는 선택적인 인자 `dependencies`를 받습니다. -`Depends()`로 된 `list`이어야합니다: +`Depends()`로 된 `list`이어야 합니다: -{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[19] *} +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[19] *} -이러한 의존성들은 기존 의존성들과 같은 방식으로 실행/해결됩니다. 그러나 값은 (무엇이든 반환한다면) *경로 작동 함수*에 제공되지 않습니다. +이러한 의존성들은 기존 의존성들과 같은 방식으로 실행/해결됩니다. 그러나 값은 (무엇이든 반환한다면) *경로 처리 함수*에 제공되지 않습니다. /// tip | 팁 일부 편집기에서는 사용되지 않는 함수 매개변수를 검사하고 오류로 표시합니다. -*경로 작동 데코레이터*에서 이러한 `dependencies`를 사용하면 편집기/도구 오류를 피하면서도 실행되도록 할 수 있습니다. +*경로 처리 데코레이터*에서 이러한 `dependencies`를 사용하면 편집기/도구 오류를 피하면서도 실행되도록 할 수 있습니다. 또한 코드에서 사용되지 않는 매개변수를 보고 불필요하다고 생각할 수 있는 새로운 개발자의 혼란을 방지하는데 도움이 될 수 있습니다. @@ -44,13 +44,13 @@ (헤더같은) 요청 요구사항이나 하위-의존성을 선언할 수 있습니다: -{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[8,13] *} +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[8,13] *} ### 오류 발생시키기 { #raise-exceptions } 다음 의존성은 기존 의존성과 동일하게 예외를 `raise`할 수 있습니다: -{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[10,15] *} +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[10,15] *} ### 값 반환하기 { #return-values } @@ -58,12 +58,12 @@ 그래서 이미 다른 곳에서 사용된 (값을 반환하는) 일반적인 의존성을 재사용할 수 있고, 비록 값은 사용되지 않지만 의존성은 실행될 것입니다: -{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[11,16] *} +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[11,16] *} -## *경로 작동* 모음에 대한 의존성 { #dependencies-for-a-group-of-path-operations } +## *경로 처리* 모음에 대한 의존성 { #dependencies-for-a-group-of-path-operations } -나중에 여러 파일을 가지고 있을 수 있는 더 큰 애플리케이션을 구조화하는 법([더 큰 애플리케이션 - 여러 파일들](../../tutorial/bigger-applications.md){.internal-link target=_blank})을 읽을 때, *경로 작동* 모음에 대한 단일 `dependencies` 매개변수를 선언하는 법에 대해서 배우게 될 것입니다. +나중에 여러 파일을 가지고 있을 수 있는 더 큰 애플리케이션을 구조화하는 법([더 큰 애플리케이션 - 여러 파일들](../../tutorial/bigger-applications.md){.internal-link target=_blank})을 읽을 때, *경로 처리* 모음에 대한 단일 `dependencies` 매개변수를 선언하는 법에 대해서 배우게 될 것입니다. ## 전역 의존성 { #global-dependencies } -다음으로 각 *경로 작동*에 적용되도록 `FastAPI` 애플리케이션 전체에 의존성을 추가하는 법을 볼 것입니다. +다음으로 각 *경로 처리*에 적용되도록 `FastAPI` 애플리케이션 전체에 의존성을 추가하는 법을 볼 것입니다. diff --git a/docs/ko/docs/tutorial/dependencies/dependencies-with-yield.md b/docs/ko/docs/tutorial/dependencies/dependencies-with-yield.md index 9bf6c0693a..7b50fd438b 100644 --- a/docs/ko/docs/tutorial/dependencies/dependencies-with-yield.md +++ b/docs/ko/docs/tutorial/dependencies/dependencies-with-yield.md @@ -1,6 +1,6 @@ # `yield`를 사용하는 의존성 { #dependencies-with-yield } -FastAPI는 작업 완료 후 추가 단계를 수행하는 의존성을 지원합니다. +FastAPI는 작업 완료 후 추가 단계를 수행하는 의존성을 지원합니다. 이를 구현하려면 `return` 대신 `yield`를 사용하고, 추가로 실행할 단계 (코드)를 그 뒤에 작성하세요. @@ -29,15 +29,15 @@ FastAPI는 CORS를 처리하는 방법을 보게 될 것입니다. +다음 섹션에서 미들웨어로 CORS를 처리하는 방법을 보게 될 것입니다. diff --git a/docs/ko/docs/tutorial/path-operation-configuration.md b/docs/ko/docs/tutorial/path-operation-configuration.md index baef3fb403..0d6a0d4229 100644 --- a/docs/ko/docs/tutorial/path-operation-configuration.md +++ b/docs/ko/docs/tutorial/path-operation-configuration.md @@ -46,7 +46,7 @@ **FastAPI**는 일반 문자열과 동일한 방식으로 이를 지원합니다: -{* ../../docs_src/path_operation_configuration/tutorial002b_py39.py hl[1,8:10,13,18] *} +{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *} ## 요약과 설명 { #summary-and-description } @@ -56,7 +56,7 @@ ## 독스트링으로 만든 설명 { #description-from-docstring } -설명은 보통 길어지고 여러 줄에 걸쳐있기 때문에, *경로 처리* 설명을 함수 docstring에 선언할 수 있으며, **FastAPI**는 그곳에서 이를 읽습니다. +설명은 보통 길어지고 여러 줄에 걸쳐있기 때문에, *경로 처리* 설명을 함수 독스트링에 선언할 수 있으며, **FastAPI**는 그곳에서 이를 읽습니다. 독스트링에는 Markdown을 작성할 수 있으며, (독스트링의 들여쓰기를 고려하여) 올바르게 해석되고 표시됩니다. @@ -90,9 +90,9 @@ OpenAPI는 각 *경로 처리*가 응답에 관한 설명을 요구할 것을 ## *경로 처리* 지원중단하기 { #deprecate-a-path-operation } -*경로 처리*를 제거하지 않고 deprecated로 표시해야 한다면, `deprecated` 매개변수를 전달하면 됩니다: +*경로 처리*를 제거하지 않고 지원중단으로 표시해야 한다면, `deprecated` 매개변수를 전달하면 됩니다: -{* ../../docs_src/path_operation_configuration/tutorial006_py39.py hl[16] *} +{* ../../docs_src/path_operation_configuration/tutorial006_py310.py hl[16] *} 대화형 문서에서 지원중단으로 명확하게 표시됩니다: diff --git a/docs/ko/docs/tutorial/path-params-numeric-validations.md b/docs/ko/docs/tutorial/path-params-numeric-validations.md index f2c52d4aac..51f9fe2c14 100644 --- a/docs/ko/docs/tutorial/path-params-numeric-validations.md +++ b/docs/ko/docs/tutorial/path-params-numeric-validations.md @@ -54,11 +54,11 @@ FastAPI는 0.95.0 버전에서 `Annotated` 지원을 추가했고(그리고 이 따라서 함수를 다음과 같이 선언할 수 있습니다: -{* ../../docs_src/path_params_numeric_validations/tutorial002_py39.py hl[7] *} +{* ../../docs_src/path_params_numeric_validations/tutorial002_py310.py hl[7] *} 하지만 `Annotated`를 사용하면 이 문제가 없다는 점을 기억하세요. `Query()`나 `Path()`에 함수 매개변수 기본값을 사용하지 않기 때문에, 순서는 중요하지 않습니다. -{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py39.py *} +{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py310.py *} ## 필요한 대로 매개변수 정렬하기, 트릭 { #order-the-parameters-as-you-need-tricks } @@ -83,13 +83,13 @@ FastAPI는 0.95.0 버전에서 `Annotated` 지원을 추가했고(그리고 이 파이썬은 `*`으로 아무것도 하지 않지만, 뒤따르는 모든 매개변수는 키워드 인자(키-값 쌍)로 호출되어야 함을 알게 됩니다. 이는 kwargs로도 알려져 있습니다. 기본값이 없더라도 마찬가지입니다. -{* ../../docs_src/path_params_numeric_validations/tutorial003_py39.py hl[7] *} +{* ../../docs_src/path_params_numeric_validations/tutorial003_py310.py hl[7] *} ### `Annotated`를 쓰면 더 좋습니다 { #better-with-annotated } `Annotated`를 사용하면 함수 매개변수 기본값을 사용하지 않기 때문에 이 문제가 발생하지 않으며, 아마 `*`도 사용할 필요가 없다는 점을 기억하세요. -{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py310.py hl[10] *} ## 숫자 검증: 크거나 같음 { #number-validations-greater-than-or-equal } @@ -97,7 +97,7 @@ FastAPI는 0.95.0 버전에서 `Annotated` 지원을 추가했고(그리고 이 여기서 `ge=1`인 경우, `item_id`는 `1`보다 "`g`reater than or `e`qual"(크거나 같은) 정수형 숫자여야 합니다. -{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py310.py hl[10] *} ## 숫자 검증: 크거나 및 작거나 같음 { #number-validations-greater-than-and-less-than-or-equal } @@ -106,7 +106,7 @@ FastAPI는 0.95.0 버전에서 `Annotated` 지원을 추가했고(그리고 이 * `gt`: `g`reater `t`han * `le`: `l`ess than or `e`qual -{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py39.py hl[10] *} +{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py310.py hl[10] *} ## 숫자 검증: 부동소수, 크거나 및 작거나 { #number-validations-floats-greater-than-and-less-than } @@ -118,7 +118,7 @@ FastAPI는 0.95.0 버전에서 `Annotated` 지원을 추가했고(그리고 이 lt 역시 마찬가지입니다. -{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py39.py hl[13] *} +{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py310.py hl[13] *} ## 요약 { #recap } diff --git a/docs/ko/docs/tutorial/path-params.md b/docs/ko/docs/tutorial/path-params.md index ea5170eccb..c6e973709a 100644 --- a/docs/ko/docs/tutorial/path-params.md +++ b/docs/ko/docs/tutorial/path-params.md @@ -2,7 +2,7 @@ 파이썬의 포맷 문자열 리터럴에서 사용되는 문법을 이용하여 경로 "매개변수" 또는 "변수"를 선언할 수 있습니다: -{* ../../docs_src/path_params/tutorial001_py39.py hl[6:7] *} +{* ../../docs_src/path_params/tutorial001_py310.py hl[6:7] *} 경로 매개변수 `item_id`의 값은 함수의 `item_id` 인자로 전달됩니다. @@ -16,7 +16,7 @@ 파이썬 표준 타입 어노테이션을 사용하여 함수에 있는 경로 매개변수의 타입을 선언할 수 있습니다: -{* ../../docs_src/path_params/tutorial002_py39.py hl[7] *} +{* ../../docs_src/path_params/tutorial002_py310.py hl[7] *} 위의 예시에서, `item_id`는 `int`로 선언되었습니다. @@ -26,7 +26,7 @@ /// -## 데이터 변환 { #data-conversion } +## 데이터 변환 { #data-conversion } 이 예제를 실행하고 http://127.0.0.1:8000/items/3을 열면, 다음 응답을 볼 수 있습니다: @@ -38,7 +38,7 @@ 함수가 받은(반환도 하는) 값은 문자열 `"3"`이 아니라 파이썬 `int` 형인 `3`입니다. -즉, 타입 선언을 하면 **FastAPI**는 자동으로 요청을 "파싱"합니다. +즉, 타입 선언을 하면 **FastAPI**는 자동으로 요청을 "파싱"합니다. /// @@ -116,21 +116,21 @@ 사용자 ID를 이용해 특정 사용자의 정보를 가져오는 경로 `/users/{user_id}`도 있습니다. -*경로 처리*는 순차적으로 평가되기 때문에 `/users/{user_id}` 이전에 `/users/me`에 대한 경로가 먼저 선언되었는지 확인해야 합니다: +*경로 처리*는 순차적으로 평가되기 때문에 `/users/me`에 대한 경로가 `/users/{user_id}` 이전에 먼저 선언되었는지 확인해야 합니다: -{* ../../docs_src/path_params/tutorial003_py39.py hl[6,11] *} +{* ../../docs_src/path_params/tutorial003_py310.py hl[6,11] *} 그렇지 않으면 `/users/{user_id}`에 대한 경로가 `/users/me`에도 매칭되어, 매개변수 `user_id`에 `"me"` 값이 들어왔다고 "생각하게" 됩니다. 마찬가지로, 경로 처리를 재정의할 수는 없습니다: -{* ../../docs_src/path_params/tutorial003b_py39.py hl[6,11] *} +{* ../../docs_src/path_params/tutorial003b_py310.py hl[6,11] *} 경로가 먼저 매칭되기 때문에 첫 번째 것이 항상 사용됩니다. ## 사전정의 값 { #predefined-values } -만약 *경로 매개변수*를 받는 *경로 처리*가 있지만, 가능한 유효한 *경로 매개변수* 값들을 미리 정의하고 싶다면 파이썬 표준 `Enum`을 사용할 수 있습니다. +만약 *경로 매개변수*를 받는 *경로 처리*가 있지만, 가능한 유효한 *경로 매개변수* 값들을 미리 정의하고 싶다면 파이썬 표준 `Enum`을 사용할 수 있습니다. ### `Enum` 클래스 생성 { #create-an-enum-class } @@ -140,11 +140,11 @@ 가능한 값들에 해당하는 고정된 값의 클래스 어트리뷰트들을 만듭니다: -{* ../../docs_src/path_params/tutorial005_py39.py hl[1,6:9] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[1,6:9] *} /// tip | 팁 -혹시 궁금하다면, "AlexNet", "ResNet", 그리고 "LeNet"은 그저 머신 러닝 모델들의 이름입니다. +혹시 궁금하다면, "AlexNet", "ResNet", 그리고 "LeNet"은 그저 머신 러닝 모델들의 이름입니다. /// @@ -152,7 +152,7 @@ 생성한 열거형 클래스(`ModelName`)를 사용하는 타입 어노테이션으로 *경로 매개변수*를 만듭니다: -{* ../../docs_src/path_params/tutorial005_py39.py hl[16] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[16] *} ### 문서 확인 { #check-the-docs } @@ -168,13 +168,13 @@ 생성한 열거형 `ModelName`의 *열거형 멤버*와 비교할 수 있습니다: -{* ../../docs_src/path_params/tutorial005_py39.py hl[17] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[17] *} #### *열거형 값* 가져오기 { #get-the-enumeration-value } `model_name.value` 또는 일반적으로 `your_enum_member.value`를 이용하여 실제 값(위 예시의 경우 `str`)을 가져올 수 있습니다: -{* ../../docs_src/path_params/tutorial005_py39.py hl[20] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[20] *} /// tip | 팁 @@ -188,7 +188,7 @@ 클라이언트에 반환하기 전에 해당 값(이 경우 문자열)으로 변환됩니다: -{* ../../docs_src/path_params/tutorial005_py39.py hl[18,21,23] *} +{* ../../docs_src/path_params/tutorial005_py310.py hl[18,21,23] *} 클라이언트는 아래와 같은 JSON 응답을 얻게 됩니다: @@ -227,7 +227,7 @@ Starlette의 옵션을 직접 이용하여 다음과 같은 URL을 사용함으 따라서 다음과 같이 사용할 수 있습니다: -{* ../../docs_src/path_params/tutorial004_py39.py hl[6] *} +{* ../../docs_src/path_params/tutorial004_py310.py hl[6] *} /// tip | 팁 @@ -242,7 +242,7 @@ Starlette의 옵션을 직접 이용하여 다음과 같은 URL을 사용함으 **FastAPI**를 이용하면 짧고 직관적인 표준 파이썬 타입 선언을 사용하여 다음을 얻을 수 있습니다: * 편집기 지원: 오류 검사, 자동완성 등 -* 데이터 "parsing" +* 데이터 "파싱" * 데이터 검증 * API 주석(Annotation)과 자동 문서 diff --git a/docs/ko/docs/tutorial/query-params-str-validations.md b/docs/ko/docs/tutorial/query-params-str-validations.md index 68824932ee..2b608fd1d5 100644 --- a/docs/ko/docs/tutorial/query-params-str-validations.md +++ b/docs/ko/docs/tutorial/query-params-str-validations.md @@ -2,7 +2,7 @@ **FastAPI**를 사용하면 매개변수에 대한 추가 정보 및 검증을 선언할 수 있습니다. -이 응용 프로그램을 예로 들어보겠습니다: +이 애플리케이션을 예로 들어보겠습니다: {* ../../docs_src/query_params_str_validations/tutorial001_py310.py hl[7] *} @@ -41,46 +41,22 @@ FastAPI는 0.95.0 버전에서 `Annotated` 지원을 추가했고(그리고 이 ## `q` 매개변수의 타입에 `Annotated` 사용하기 { #use-annotated-in-the-type-for-the-q-parameter } -이전에 [Python Types Intro](../python-types.md#type-hints-with-metadata-annotations){.internal-link target=_blank}에서 `Annotated`를 사용해 매개변수에 메타데이터를 추가할 수 있다고 말씀드린 것을 기억하시나요? +이전에 [Python 타입 소개](../python-types.md#type-hints-with-metadata-annotations){.internal-link target=_blank}에서 `Annotated`를 사용해 매개변수에 메타데이터를 추가할 수 있다고 말씀드린 것을 기억하시나요? 이제 FastAPI에서 사용할 차례입니다. 🚀 다음과 같은 타입 어노테이션이 있었습니다: -//// tab | Python 3.10+ - ```Python q: str | None = None ``` -//// - -//// tab | Python 3.9+ - -```Python -q: Union[str, None] = None -``` - -//// - 여기서 `Annotated`로 감싸서 다음과 같이 만듭니다: -//// tab | Python 3.10+ - ```Python q: Annotated[str | None] = None ``` -//// - -//// tab | Python 3.9+ - -```Python -q: Annotated[Union[str, None]] = None -``` - -//// - 두 버전 모두 같은 의미로, `q`는 `str` 또는 `None`이 될 수 있는 매개변수이며 기본값은 `None`입니다. 이제 재미있는 부분으로 넘어가 봅시다. 🎉 @@ -109,7 +85,7 @@ q: Annotated[Union[str, None]] = None ## 대안(이전 방식): 기본값으로 `Query` 사용 { #alternative-old-query-as-the-default-value } -이전 FastAPI 버전(0.95.0 이전)에서는 `Annotated`에 넣는 대신, 매개변수의 기본값으로 `Query`를 사용해야 했습니다. 주변에서 이 방식을 사용하는 코드를 볼 가능성이 높기 때문에 설명해 드리겠습니다. +이전 FastAPI 버전(0.95.0 이전)에서는 `Annotated`에 넣는 대신, 매개변수의 기본값으로 `Query`를 사용해야 했습니다. 주변에서 이 방식을 사용하는 코드를 볼 가능성이 높기 때문에 설명해 드리겠습니다. /// tip | 팁 @@ -192,7 +168,7 @@ FastAPI 없이도 **다른 곳에서** 같은 함수를 **호출**할 수 있고 ## 정규식 추가 { #add-regular-expressions } -매개변수와 일치해야 하는 정규 표현식 `pattern`을 정의할 수 있습니다: +매개변수와 일치해야 하는 정규 표현식 `pattern`을 정의할 수 있습니다: {* ../../docs_src/query_params_str_validations/tutorial004_an_py310.py hl[11] *} @@ -212,7 +188,7 @@ FastAPI 없이도 **다른 곳에서** 같은 함수를 **호출**할 수 있고 `q` 쿼리 매개변수에 `min_length`를 `3`으로 설정하고, 기본값을 `"fixedquery"`로 선언하고 싶다고 해봅시다: -{* ../../docs_src/query_params_str_validations/tutorial005_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial005_an_py310.py hl[9] *} /// note | 참고 @@ -242,7 +218,7 @@ q: Annotated[str | None, Query(min_length=3)] = None 따라서 `Query`를 사용하면서 값을 필수로 선언해야 할 때는, 기본값을 선언하지 않으면 됩니다: -{* ../../docs_src/query_params_str_validations/tutorial006_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial006_an_py310.py hl[9] *} ### 필수지만 `None` 가능 { #required-can-be-none } @@ -293,7 +269,7 @@ http://localhost:8000/items/?q=foo&q=bar 제공된 값이 없으면 기본 `list` 값을 정의할 수도 있습니다: -{* ../../docs_src/query_params_str_validations/tutorial012_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial012_an_py310.py hl[9] *} 다음으로 이동하면: @@ -316,7 +292,7 @@ http://localhost:8000/items/ `list[str]` 대신 `list`를 직접 사용할 수도 있습니다: -{* ../../docs_src/query_params_str_validations/tutorial013_an_py39.py hl[9] *} +{* ../../docs_src/query_params_str_validations/tutorial013_an_py310.py hl[9] *} /// note | 참고 @@ -372,7 +348,7 @@ http://127.0.0.1:8000/items/?item-query=foobaritems 이제는 더 이상 이 매개변수를 마음에 들어하지 않는다고 가정해 봅시다. -이 매개변수를 사용하는 클라이언트가 있기 때문에 한동안은 남겨둬야 하지만, 문서에서 deprecated로 명확하게 보여주고 싶습니다. +이 매개변수를 사용하는 클라이언트가 있기 때문에 한동안은 남겨둬야 하지만, 문서에서 사용 중단됨으로 명확하게 보여주고 싶습니다. 그렇다면 `deprecated=True` 매개변수를 `Query`로 전달합니다: @@ -402,7 +378,7 @@ Pydantic에는 ISBN 도서 번호의 경우 아이템 ID가 `isbn-`으로 시작하고, IMDB 영화 URL ID의 경우 `imdb-`로 시작하는지 확인합니다: +예를 들어, 이 커스텀 validator는 ISBN 도서 번호의 경우 아이템 ID가 `isbn-`으로 시작하고, IMDB 영화 URL ID의 경우 `imdb-`로 시작하는지 확인합니다: {* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py hl[5,16:19,24] *} @@ -436,9 +412,9 @@ Pydantic에는 iterable object를 얻습니다. +`data.items()`를 사용하면 각 딕셔너리 항목의 키와 값을 담은 튜플로 구성된 이터러블 객체를 얻습니다. -이 iterable object를 `list(data.items())`로 적절한 `list`로 변환합니다. +이 이터러블 객체를 `list(data.items())`로 적절한 `list`로 변환합니다. 그 다음 `random.choice()`로 리스트에서 **무작위 값**을 얻어 `(id, name)` 형태의 튜플을 얻습니다. 예를 들어 `("imdb-tt0371724", "The Hitchhiker's Guide to the Galaxy")` 같은 값이 될 것입니다. diff --git a/docs/ko/docs/tutorial/query-params.md b/docs/ko/docs/tutorial/query-params.md index 5124f73bf5..0a6b1f922c 100644 --- a/docs/ko/docs/tutorial/query-params.md +++ b/docs/ko/docs/tutorial/query-params.md @@ -2,7 +2,7 @@ 경로 매개변수의 일부가 아닌 다른 함수 매개변수를 선언하면 "쿼리" 매개변수로 자동 해석합니다. -{* ../../docs_src/query_params/tutorial001_py39.py hl[9] *} +{* ../../docs_src/query_params/tutorial001_py310.py hl[9] *} 쿼리는 URL에서 `?` 후에 나오고 `&`으로 구분되는 키-값 쌍의 집합입니다. @@ -24,7 +24,7 @@ URL의 일부이므로 "자연스럽게" 문자열입니다. 경로 매개변수에 적용된 동일한 프로세스가 쿼리 매개변수에도 적용됩니다: * (당연히) 편집기 지원 -* 데이터 "파싱" +* 데이터 "파싱" * 데이터 검증 * 자동 문서화 @@ -128,7 +128,7 @@ http://127.0.0.1:8000/items/foo?short=yes 그러나 쿼리 매개변수를 필수로 만들려면 단순히 기본값을 선언하지 않으면 됩니다: -{* ../../docs_src/query_params/tutorial005_py39.py hl[6:7] *} +{* ../../docs_src/query_params/tutorial005_py310.py hl[6:7] *} 여기 쿼리 매개변수 `needy`는 `str`형인 필수 쿼리 매개변수입니다. diff --git a/docs/ko/docs/tutorial/request-files.md b/docs/ko/docs/tutorial/request-files.md index cc00009211..3ee0fa74c3 100644 --- a/docs/ko/docs/tutorial/request-files.md +++ b/docs/ko/docs/tutorial/request-files.md @@ -20,13 +20,13 @@ $ pip install python-multipart `fastapi` 에서 `File` 과 `UploadFile` 을 임포트 합니다: -{* ../../docs_src/request_files/tutorial001_an_py39.py hl[3] *} +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[3] *} ## `File` 매개변수 정의 { #define-file-parameters } `Body` 및 `Form` 과 동일한 방식으로 파일의 매개변수를 생성합니다: -{* ../../docs_src/request_files/tutorial001_an_py39.py hl[9] *} +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[9] *} /// info | 정보 @@ -54,7 +54,7 @@ File의 본문을 선언할 때, 매개변수가 쿼리 매개변수 또는 본 `File` 매개변수를 `UploadFile` 타입으로 정의합니다: -{* ../../docs_src/request_files/tutorial001_an_py39.py hl[14] *} +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[14] *} `UploadFile` 을 사용하는 것은 `bytes` 과 비교해 다음과 같은 장점이 있습니다: @@ -121,7 +121,7 @@ HTML의 폼들(`
`)이 서버에 데이터를 전송하는 방식은 하지만 파일이 포함된 경우, `multipart/form-data`로 인코딩됩니다. `File`을 사용하였다면, **FastAPI**는 본문의 적합한 부분에서 파일을 가져와야 한다는 것을 인지합니다. -인코딩과 폼 필드에 대해 더 알고싶다면,
MDN web docs for POST를 참고하기 바랍니다. +인코딩과 폼 필드에 대해 더 알고싶다면, MDN web docs for POST를 참고하기 바랍니다. /// @@ -143,7 +143,7 @@ HTML의 폼들(`
`)이 서버에 데이터를 전송하는 방식은 추가 메타데이터를 설정하기 위해 예를 들어 `UploadFile`과 함께 `File()`을 사용할 수도 있습니다: -{* ../../docs_src/request_files/tutorial001_03_an_py39.py hl[9,15] *} +{* ../../docs_src/request_files/tutorial001_03_an_py310.py hl[9,15] *} ## 다중 파일 업로드 { #multiple-file-uploads } @@ -153,7 +153,7 @@ HTML의 폼들(`
`)이 서버에 데이터를 전송하는 방식은 이 기능을 사용하기 위해 , `bytes` 의 `List` 또는 `UploadFile` 를 선언하기 바랍니다: -{* ../../docs_src/request_files/tutorial002_an_py39.py hl[10,15] *} +{* ../../docs_src/request_files/tutorial002_an_py310.py hl[10,15] *} 선언한대로, `bytes` 의 `list` 또는 `UploadFile` 들을 전송받을 것입니다. @@ -169,7 +169,7 @@ HTML의 폼들(`
`)이 서버에 데이터를 전송하는 방식은 이전과 같은 방식으로 `UploadFile`에 대해서도 `File()`을 사용해 추가 매개변수를 설정할 수 있습니다: -{* ../../docs_src/request_files/tutorial003_an_py39.py hl[11,18:20] *} +{* ../../docs_src/request_files/tutorial003_an_py310.py hl[11,18:20] *} ## 요약 { #recap } diff --git a/docs/ko/docs/tutorial/request-form-models.md b/docs/ko/docs/tutorial/request-form-models.md index b37186dfb8..20a2e95972 100644 --- a/docs/ko/docs/tutorial/request-form-models.md +++ b/docs/ko/docs/tutorial/request-form-models.md @@ -24,7 +24,7 @@ $ pip install python-multipart **폼 필드**로 받고 싶은 필드를 **Pydantic 모델**로 선언한 다음, 매개변수를 `Form`으로 선언하면 됩니다: -{* ../../docs_src/request_form_models/tutorial001_an_py39.py hl[9:11,15] *} +{* ../../docs_src/request_form_models/tutorial001_an_py310.py hl[9:11,15] *} **FastAPI**는 요청에서 받은 **폼 데이터**에서 **각 필드**에 대한 데이터를 **추출**하고 정의한 Pydantic 모델을 줍니다. @@ -48,7 +48,7 @@ $ pip install python-multipart Pydantic의 모델 구성을 사용하여 `extra` 필드를 `forbid`할 수 있습니다: -{* ../../docs_src/request_form_models/tutorial002_an_py39.py hl[12] *} +{* ../../docs_src/request_form_models/tutorial002_an_py310.py hl[12] *} 클라이언트가 추가 데이터를 보내려고 하면 **오류** 응답을 받게 됩니다. diff --git a/docs/ko/docs/tutorial/request-forms-and-files.md b/docs/ko/docs/tutorial/request-forms-and-files.md index a5309b5c07..4c2d12bc06 100644 --- a/docs/ko/docs/tutorial/request-forms-and-files.md +++ b/docs/ko/docs/tutorial/request-forms-and-files.md @@ -16,13 +16,13 @@ $ pip install python-multipart ## `File` 및 `Form` 임포트 { #import-file-and-form } -{* ../../docs_src/request_forms_and_files/tutorial001_an_py39.py hl[3] *} +{* ../../docs_src/request_forms_and_files/tutorial001_an_py310.py hl[3] *} ## `File` 및 `Form` 매개변수 정의 { #define-file-and-form-parameters } `Body` 및 `Query`와 동일한 방식으로 파일과 폼의 매개변수를 생성합니다: -{* ../../docs_src/request_forms_and_files/tutorial001_an_py39.py hl[10:12] *} +{* ../../docs_src/request_forms_and_files/tutorial001_an_py310.py hl[10:12] *} 파일과 폼 필드는 폼 데이터로 업로드되며, 파일과 폼 필드를 받게 됩니다. diff --git a/docs/ko/docs/tutorial/request-forms.md b/docs/ko/docs/tutorial/request-forms.md index 584cbba35c..a830bc5f8a 100644 --- a/docs/ko/docs/tutorial/request-forms.md +++ b/docs/ko/docs/tutorial/request-forms.md @@ -18,17 +18,17 @@ $ pip install python-multipart `fastapi`에서 `Form`을 임포트합니다: -{* ../../docs_src/request_forms/tutorial001_an_py39.py hl[3] *} +{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[3] *} ## `Form` 매개변수 정의하기 { #define-form-parameters } `Body` 또는 `Query`와 동일한 방식으로 폼 매개변수를 만듭니다: -{* ../../docs_src/request_forms/tutorial001_an_py39.py hl[9] *} +{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[9] *} 예를 들어, OAuth2 사양을 사용할 수 있는 방법 중 하나("패스워드 플로우"라고 함)로 `username`과 `password`를 폼 필드로 보내야 합니다. -spec에서는 필드 이름이 `username` 및 `password`로 정확하게 명명되어야 하고, JSON이 아닌 폼 필드로 전송해야 합니다. +사양에서는 필드 이름이 `username` 및 `password`로 정확하게 명명되어야 하고, JSON이 아닌 폼 필드로 전송해야 합니다. `Form`을 사용하면 유효성 검사, 예제, 별칭(예: `username` 대신 `user-name`) 등을 포함하여 `Body`(및 `Query`, `Path`, `Cookie`)와 동일한 구성을 선언할 수 있습니다. @@ -56,7 +56,7 @@ HTML 폼(`
`)이 데이터를 서버로 보내는 방식은 일반 그러나 폼에 파일이 포함된 경우, `multipart/form-data`로 인코딩합니다. 다음 장에서 파일 처리에 대해 읽을 겁니다. -이러한 인코딩 및 폼 필드에 대해 더 읽고 싶다면, POST에 대한 MDN 웹 문서를 참조하세요. +이러한 인코딩 및 폼 필드에 대해 더 읽고 싶다면, MDN 웹 문서를 참조하세요 POST에 대한. /// diff --git a/docs/ko/docs/tutorial/response-model.md b/docs/ko/docs/tutorial/response-model.md index 6246ed9ad1..942901e7cc 100644 --- a/docs/ko/docs/tutorial/response-model.md +++ b/docs/ko/docs/tutorial/response-model.md @@ -183,7 +183,7 @@ FastAPI는 Pydantic을 내부적으로 여러 방식으로 사용하여, 클래 가장 흔한 경우는 [고급 문서에서 나중에 설명하는 대로 Response를 직접 반환하는 것](../advanced/response-directly.md){.internal-link target=_blank}입니다. -{* ../../docs_src/response_model/tutorial003_02_py39.py hl[8,10:11] *} +{* ../../docs_src/response_model/tutorial003_02_py310.py hl[8,10:11] *} 이 간단한 경우는 반환 타입 어노테이션이 `Response` 클래스(또는 그 서브클래스)이기 때문에 FastAPI에서 자동으로 처리됩니다. @@ -193,7 +193,7 @@ FastAPI는 Pydantic을 내부적으로 여러 방식으로 사용하여, 클래 타입 어노테이션에 `Response`의 서브클래스를 사용할 수도 있습니다: -{* ../../docs_src/response_model/tutorial003_03_py39.py hl[8:9] *} +{* ../../docs_src/response_model/tutorial003_03_py310.py hl[8:9] *} 이는 `RedirectResponse`가 `Response`의 서브클래스이기 때문에 동작하며, FastAPI가 이 간단한 경우를 자동으로 처리합니다. @@ -201,7 +201,7 @@ FastAPI는 Pydantic을 내부적으로 여러 방식으로 사용하여, 클래 하지만 유효한 Pydantic 타입이 아닌 다른 임의의 객체(예: 데이터베이스 객체)를 반환하고, 함수에서 그렇게 어노테이션하면, FastAPI는 그 타입 어노테이션으로부터 Pydantic 응답 모델을 만들려고 시도하다가 실패합니다. -또한, 유효한 Pydantic 타입이 아닌 타입이 하나 이상 포함된 여러 타입 간의 union이 있는 경우에도 동일합니다. 예를 들어, 아래는 실패합니다 💥: +또한, 유효한 Pydantic 타입이 아닌 타입이 하나 이상 포함된 여러 타입 간의 union이 있는 경우에도 동일합니다. 예를 들어, 아래는 실패합니다 💥: {* ../../docs_src/response_model/tutorial003_04_py310.py hl[8] *} diff --git a/docs/ko/docs/tutorial/response-status-code.md b/docs/ko/docs/tutorial/response-status-code.md index 257f6a8d6f..c81132dfb9 100644 --- a/docs/ko/docs/tutorial/response-status-code.md +++ b/docs/ko/docs/tutorial/response-status-code.md @@ -8,7 +8,7 @@ * `@app.delete()` * 등 -{* ../../docs_src/response_status_code/tutorial001_py39.py hl[6] *} +{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *} /// note | 참고 @@ -43,7 +43,7 @@ FastAPI는 이를 알고 있으며, 응답 본문이 없다고 명시하는 Open /// note | 참고 -만약 HTTP 상태 코드가 무엇인지 이미 알고 있다면, 다음 섹션으로 넘어가세요. +만약 HTTP 상태 코드가 무엇인지 이미 알고 있다면, 다음 섡션으로 넘어가세요. /// @@ -66,7 +66,7 @@ HTTP에서는 응답의 일부로 3자리 숫자 상태 코드를 보냅니다. /// tip | 팁 -각 상태 코드와 어떤 코드가 어떤 용도인지 더 알고 싶다면 MDN의 HTTP 상태 코드에 관한 문서를 확인하세요. +각 상태 코드와 어떤 코드가 어떤 용도인지 더 알고 싶다면 MDN의 HTTP 상태 코드에 관한 문서를 확인하세요. /// @@ -74,7 +74,7 @@ HTTP에서는 응답의 일부로 3자리 숫자 상태 코드를 보냅니다. 이전 예시를 다시 확인해보겠습니다: -{* ../../docs_src/response_status_code/tutorial001_py39.py hl[6] *} +{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *} `201` 은 "생성됨"을 위한 상태 코드입니다. @@ -82,7 +82,7 @@ HTTP에서는 응답의 일부로 3자리 숫자 상태 코드를 보냅니다. `fastapi.status` 의 편의 변수를 사용할 수 있습니다. -{* ../../docs_src/response_status_code/tutorial002_py39.py hl[1,6] *} +{* ../../docs_src/response_status_code/tutorial002_py310.py hl[1,6] *} 이것들은 단지 편의를 위한 것으로, 동일한 숫자를 갖고 있지만, 이를 통해 편집기의 자동완성 기능으로 찾을 수 있습니다: diff --git a/docs/ko/docs/tutorial/schema-extra-example.md b/docs/ko/docs/tutorial/schema-extra-example.md index b2b54836ac..a1d0c84689 100644 --- a/docs/ko/docs/tutorial/schema-extra-example.md +++ b/docs/ko/docs/tutorial/schema-extra-example.md @@ -74,7 +74,7 @@ Pydantic 모델과 같이 `Field()`를 사용할 때 추가적인 `examples`를 이와 같이 하면 예제들은 그 본문 데이터의 내부 **JSON 스키마**의 일부가 될 것입니다. -그럼에도 불구하고, 지금 이 문서를 작성하는 시간에, 문서 UI를 보여주는 역할을 맡은 Swagger UI는 **JSON 스키마** 속 데이터를 위한 여러 예제의 표현을 지원하지 않습니다. 하지만 해결 방안을 밑에서 읽어보세요. +그럼에도 불구하고, 지금 이 문서를 작성하는 시간에, 문서 UI를 보여주는 역할을 맡은 Swagger UI는 **JSON 스키마** 속 데이터를 위한 여러 예제의 표현을 지원하지 않습니다. 하지만 해결 방안을 밑에서 읽어보세요. ### OpenAPI-특화 `examples` { #openapi-specific-examples } diff --git a/docs/ko/docs/tutorial/security/first-steps.md b/docs/ko/docs/tutorial/security/first-steps.md index 4c9181b31e..57b336d52d 100644 --- a/docs/ko/docs/tutorial/security/first-steps.md +++ b/docs/ko/docs/tutorial/security/first-steps.md @@ -20,7 +20,7 @@ 예제를 파일 `main.py`에 복사하세요: -{* ../../docs_src/security/tutorial001_an_py39.py *} +{* ../../docs_src/security/tutorial001_an_py310.py *} ## 실행하기 { #run-it } @@ -132,7 +132,7 @@ OAuth2는 backend 또는 API가 사용자를 인증하는 서버와 독립적일 `OAuth2PasswordBearer` 클래스의 인스턴스를 만들 때 `tokenUrl` 파라미터를 전달합니다. 이 파라미터에는 클라이언트(사용자의 브라우저에서 실행되는 frontend)가 token을 받기 위해 `username`과 `password`를 보낼 URL이 들어 있습니다. -{* ../../docs_src/security/tutorial001_an_py39.py hl[8] *} +{* ../../docs_src/security/tutorial001_an_py310.py hl[8] *} /// tip | 팁 @@ -170,7 +170,7 @@ oauth2_scheme(some, parameters) 이제 `Depends`로 `oauth2_scheme`를 의존성에 전달할 수 있습니다. -{* ../../docs_src/security/tutorial001_an_py39.py hl[12] *} +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} 이 의존성은 `str`을 제공하고, 그 값은 *경로 처리 함수*의 파라미터 `token`에 할당됩니다. diff --git a/docs/ko/docs/tutorial/security/get-current-user.md b/docs/ko/docs/tutorial/security/get-current-user.md index f21a22b7a0..eab599e275 100644 --- a/docs/ko/docs/tutorial/security/get-current-user.md +++ b/docs/ko/docs/tutorial/security/get-current-user.md @@ -2,7 +2,7 @@ 이전 장에서 (의존성 주입 시스템을 기반으로 한) 보안 시스템은 *경로 처리 함수*에 `str`로 `token`을 제공했습니다: -{* ../../docs_src/security/tutorial001_an_py39.py hl[12] *} +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} 하지만 이는 여전히 그다지 유용하지 않습니다. diff --git a/docs/ko/docs/tutorial/security/oauth2-jwt.md b/docs/ko/docs/tutorial/security/oauth2-jwt.md index 907795ca4b..f9c4cc2ff3 100644 --- a/docs/ko/docs/tutorial/security/oauth2-jwt.md +++ b/docs/ko/docs/tutorial/security/oauth2-jwt.md @@ -1,6 +1,6 @@ # 패스워드(해싱 포함)를 사용하는 OAuth2, JWT 토큰을 사용하는 Bearer { #oauth2-with-password-and-hashing-bearer-with-jwt-tokens } -모든 보안 흐름을 구성했으므로, 이제 JWT 토큰과 안전한 패스워드 해싱을 사용해 애플리케이션을 실제로 안전하게 만들겠습니다. +모든 보안 흐름을 구성했으므로, 이제 JWT 토큰과 안전한 패스워드 해싱을 사용해 애플리케이션을 실제로 안전하게 만들겠습니다. 이 코드는 실제로 애플리케이션에서 사용할 수 있으며, 패스워드 해시를 데이터베이스에 저장하는 등의 작업에 활용할 수 있습니다. @@ -42,7 +42,7 @@ $ pip install pyjwt
-/// info +/// info | 정보 RSA나 ECDSA 같은 전자 서명 알고리즘을 사용할 계획이라면, cryptography 라이브러리 의존성인 `pyjwt[crypto]`를 설치해야 합니다. @@ -84,7 +84,7 @@ $ pip install "pwdlib[argon2]"
-/// tip +/// tip | 팁 `pwdlib`를 사용하면 **Django**, **Flask** 보안 플러그인 또는 다른 여러 도구로 생성한 패스워드를 읽을 수 있도록 설정할 수도 있습니다. @@ -100,7 +100,7 @@ $ pip install "pwdlib[argon2]" 권장 설정으로 PasswordHash 인스턴스를 생성합니다. 이는 패스워드를 해싱하고 검증하는 데 사용됩니다. -/// tip +/// tip | 팁 pwdlib는 bcrypt 해싱 알고리즘도 지원하지만 레거시 알고리즘은 포함하지 않습니다. 오래된 해시로 작업해야 한다면 passlib 라이브러리를 사용하는 것을 권장합니다. @@ -116,9 +116,13 @@ pwdlib는 bcrypt 해싱 알고리즘도 지원하지만 레거시 알고리즘 그리고 사용자를 인증하고 반환하는 또 다른 함수도 생성합니다. -{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,56:57,60:61,70:76] *} +{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,51,58:59,62:63,72:79] *} -/// note +`authenticate_user`가 데이터베이스에 존재하지 않는 사용자이름으로 호출되더라도, 여전히 `verify_password`를 더미 해시에 대해 실행합니다. + +이렇게 하면 사용자이름이 유효하든 아니든 엔드포인트가 응답하는 데 걸리는 시간이 대략 동일해져, 기존 사용자이름을 열거하는 데 악용될 수 있는 **타이밍 공격**을 방지합니다. + +/// note | 참고 새로운 (가짜) 데이터베이스 `fake_users_db`를 확인하면, 이제 해시 처리된 패스워드가 어떻게 생겼는지 볼 수 있습니다: `"$argon2id$v=19$m=65536,t=3,p=4$wagCPXjifgvUFBzq4hqe3w$CYaIb8sB+wtD+Vu/P4uod1+Qof8h+1g7bbDlBID48Rc"`. @@ -152,7 +156,7 @@ JWT 토큰을 서명하는 데 사용될 알고리즘을 위한 변수 `ALGORITH 새 액세스 토큰을 생성하기 위한 유틸리티 함수를 생성합니다. -{* ../../docs_src/security/tutorial004_an_py310.py hl[4,7,13:15,29:31,79:87] *} +{* ../../docs_src/security/tutorial004_an_py310.py hl[4,7,13:15,29:31,82:90] *} ## 의존성 업데이트 { #update-the-dependencies } @@ -162,7 +166,7 @@ JWT 토큰을 서명하는 데 사용될 알고리즘을 위한 변수 `ALGORITH 토큰이 유효하지 않다면 즉시 HTTP 오류를 반환합니다. -{* ../../docs_src/security/tutorial004_an_py310.py hl[90:107] *} +{* ../../docs_src/security/tutorial004_an_py310.py hl[93:110] *} ## `/token` *경로 처리* 업데이트 { #update-the-token-path-operation } @@ -170,7 +174,7 @@ JWT 토큰을 서명하는 데 사용될 알고리즘을 위한 변수 `ALGORITH 실제 JWT 액세스 토큰을 생성하여 반환합니다. -{* ../../docs_src/security/tutorial004_an_py310.py hl[118:133] *} +{* ../../docs_src/security/tutorial004_an_py310.py hl[121:136] *} ### JWT "주체(subject)" `sub`에 대한 기술 세부사항 { #technical-details-about-the-jwt-subject-sub } @@ -209,7 +213,7 @@ JWT는 사용자를 식별하고 사용자가 API에서 직접 작업을 수행 Username: `johndoe` Password: `secret` -/// check +/// check | 확인 코드 어디에도 평문 패스워드 "`secret`"은 없고, 해시된 버전만 있다는 점에 유의하십시오. @@ -234,7 +238,7 @@ Password: `secret` -/// note +/// note | 참고 `Bearer `로 시작하는 값을 가진 `Authorization` 헤더에 주목하십시오. diff --git a/docs/ko/docs/tutorial/security/simple-oauth2.md b/docs/ko/docs/tutorial/security/simple-oauth2.md index 189dd89f2a..918c94b25f 100644 --- a/docs/ko/docs/tutorial/security/simple-oauth2.md +++ b/docs/ko/docs/tutorial/security/simple-oauth2.md @@ -162,7 +162,7 @@ UserInDB( /// tip | 팁 -다음 장에서는 패스워드 해싱 및 JWT 토큰을 사용하여 실제 보안 구현을 볼 수 있습니다. +다음 장에서는 패스워드 해싱 및 JWT 토큰을 사용하여 실제 보안 구현을 볼 수 있습니다. 하지만 지금은 필요한 세부 정보에 집중하겠습니다. @@ -286,4 +286,4 @@ UserInDB( 유일한 오점은 아직 실제로 "안전"하지 않다는 것입니다. -다음 장에서는 안전한 패스워드 해싱 라이브러리와 JWT 토큰을 사용하는 방법을 살펴보겠습니다. +다음 장에서는 안전한 패스워드 해싱 라이브러리와 JWT 토큰을 사용하는 방법을 살펴보겠습니다. diff --git a/docs/ko/docs/tutorial/sql-databases.md b/docs/ko/docs/tutorial/sql-databases.md index 3d64cf627a..20c1367164 100644 --- a/docs/ko/docs/tutorial/sql-databases.md +++ b/docs/ko/docs/tutorial/sql-databases.md @@ -8,7 +8,7 @@ /// tip | 팁 -다른 SQL 또는 NoSQL 데이터베이스 라이브러리를 사용할 수도 있습니다 (일부는 "ORMs"이라고도 불립니다), FastAPI는 특정 라이브러리의 사용을 강요하지 않습니다. 😎 +다른 SQL 또는 NoSQL 데이터베이스 라이브러리를 사용할 수도 있습니다 (일부는 "ORMs"이라고도 불립니다), FastAPI는 특정 라이브러리의 사용을 강요하지 않습니다. 😎 /// diff --git a/docs/ko/docs/tutorial/static-files.md b/docs/ko/docs/tutorial/static-files.md index aa4c571793..0235d83c7f 100644 --- a/docs/ko/docs/tutorial/static-files.md +++ b/docs/ko/docs/tutorial/static-files.md @@ -7,7 +7,7 @@ * `StaticFiles`를 임포트합니다. * 특정 경로에 `StaticFiles()` 인스턴스를 "마운트"합니다. -{* ../../docs_src/static_files/tutorial001_py39.py hl[2,6] *} +{* ../../docs_src/static_files/tutorial001_py310.py hl[2,6] *} /// note | 기술 세부사항 diff --git a/docs/ko/docs/tutorial/testing.md b/docs/ko/docs/tutorial/testing.md index db7fb17ead..57ab811515 100644 --- a/docs/ko/docs/tutorial/testing.md +++ b/docs/ko/docs/tutorial/testing.md @@ -2,7 +2,7 @@ Starlette 덕분에 **FastAPI** 애플리케이션을 테스트하는 일은 쉽고 즐거운 일이 되었습니다. -Starlette는 HTTPX를 기반으로 하며, 이는 Requests를 기반으로 설계되었기 때문에 매우 친숙하고 직관적입니다. +이는 HTTPX를 기반으로 하며, 이는 Requests를 기반으로 설계되었기 때문에 매우 친숙하고 직관적입니다. 이를 사용하면 **FastAPI**에서 pytest를 직접 사용할 수 있습니다. @@ -30,7 +30,7 @@ $ pip install httpx 표준적인 파이썬 표현식으로 확인이 필요한 곳에 간단한 `assert` 문장을 작성하세요(역시 표준적인 `pytest` 관례입니다). -{* ../../docs_src/app_testing/tutorial001_py39.py hl[2,12,15:18] *} +{* ../../docs_src/app_testing/tutorial001_py310.py hl[2,12,15:18] *} /// tip | 팁 @@ -42,7 +42,7 @@ $ pip install httpx /// -/// note Technical Details | 기술 세부사항 +/// note | 기술 세부사항 `from starlette.testclient import TestClient` 역시 사용할 수 있습니다. @@ -76,7 +76,7 @@ FastAPI 애플리케이션에 요청을 보내는 것 외에도 테스트에서 `main.py` 파일 안에 **FastAPI** app 을 만들었습니다: -{* ../../docs_src/app_testing/app_a_py39/main.py *} +{* ../../docs_src/app_testing/app_a_py310/main.py *} ### 테스트 파일 { #testing-file } @@ -92,7 +92,7 @@ FastAPI 애플리케이션에 요청을 보내는 것 외에도 테스트에서 파일들이 동일한 패키지에 위치해 있으므로, 상대 임포트를 사용하여 `main` 모듈(`main.py`)에서 `app` 객체를 임포트 해올 수 있습니다. -{* ../../docs_src/app_testing/app_a_py39/test_main.py hl[3] *} +{* ../../docs_src/app_testing/app_a_py310/test_main.py hl[3] *} ...그리고 이전에 작성했던 것과 같은 테스트 코드를 작성할 수 있습니다. @@ -115,7 +115,7 @@ FastAPI 애플리케이션에 요청을 보내는 것 외에도 테스트에서 이제 **FastAPI** 앱이 있는 `main.py` 파일에 몇 가지 다른 **경로 처리**가 추가된 경우를 생각해봅시다. -단일 오류를 반환할 수 있는 `GET` 작업이 있습니다. +오류를 반환할 수 있는 `GET` 작업이 있습니다. 여러 다른 오류를 반환할 수 있는 `POST` 작업이 있습니다. diff --git a/docs/ko/docs/virtual-environments.md b/docs/ko/docs/virtual-environments.md index b639f8a3e4..e6baef73b4 100644 --- a/docs/ko/docs/virtual-environments.md +++ b/docs/ko/docs/virtual-environments.md @@ -37,15 +37,15 @@ Python 설치까지 포함해 **모든 것을 관리해주는 도구**를 도입
```console -// Go to the home directory +// 홈 디렉터리로 이동 $ cd -// Create a directory for all your code projects +// 모든 코드 프로젝트를 위한 디렉터리 생성 $ mkdir code -// Enter into that code directory +// 그 code 디렉터리로 이동 $ cd code -// Create a directory for this project +// 이 프로젝트를 위한 디렉터리 생성 $ mkdir awesome-project -// Enter into that project directory +// 그 프로젝트 디렉터리로 이동 $ cd awesome-project ``` @@ -53,7 +53,7 @@ $ cd awesome-project ## 가상 환경 생성 { #create-a-virtual-environment } -Python 프로젝트를 **처음 시작할 때**, **프로젝트 내부**에 가상 환경을 생성하세요. +Python 프로젝트를 **처음 시작할 때**, 가상 환경을 **프로젝트 내부**에 생성하세요. /// tip @@ -166,7 +166,7 @@ $ source .venv/Scripts/activate 해당 환경에 **새 패키지**를 설치할 때마다, 환경을 다시 **활성화**하세요. -이렇게 하면 해당 패키지가 설치한 **터미널(CLI) 프로그램**을 사용할 때, 전역으로 설치되어 있을 수도 있는(아마 필요한 버전과는 다른 버전인) 다른 프로그램이 아니라 가상 환경에 있는 것을 사용하게 됩니다. +이렇게 하면 해당 패키지가 설치한 **터미널(CLI) 프로그램**을 사용할 때, 전역으로 설치되어 있을 수도 있는(아마 필요한 버전과는 다른 버전인) 다른 프로그램이 아니라 가상 환경에 있는 것을 사용하게 됩니다. /// @@ -557,7 +557,7 @@ Python을 설치하면 컴퓨터에 몇몇 파일이 들어 있는 디렉터리
```console -// Don't run this now, it's just an example 🤓 +// 지금은 실행하지 마세요, 예시일 뿐입니다 🤓 $ pip install "fastapi[standard]" ---> 100% ``` @@ -811,7 +811,7 @@ $ cd ~/code/prisoner-of-azkaban $ python main.py -// Error importing sirius, it's not installed 😱 +// sirius 임포트 오류, 설치되어 있지 않습니다 😱 Traceback (most recent call last): File "main.py", line 1, in import sirius @@ -826,13 +826,13 @@ Traceback (most recent call last): ```console $ cd ~/code/prisoner-of-azkaban -// You don't need to be in the old directory to deactivate, you can do it wherever you are, even after going to the other project 😎 +// 비활성화를 위해 이전 디렉터리에 있을 필요는 없습니다. 어디서든, 다른 프로젝트로 이동한 뒤에도 할 수 있습니다 😎 $ deactivate -// Activate the virtual environment in prisoner-of-azkaban/.venv 🚀 +// prisoner-of-azkaban/.venv의 가상 환경을 활성화하세요 🚀 $ source .venv/bin/activate -// Now when you run python, it will find the package sirius installed in this virtual environment ✨ +// 이제 python을 실행하면, 이 가상 환경에 설치된 sirius 패키지를 찾습니다 ✨ $ python main.py I solemnly swear 🐺 diff --git a/docs/uk/docs/_llm-test.md b/docs/uk/docs/_llm-test.md new file mode 100644 index 0000000000..0dbfaa3db4 --- /dev/null +++ b/docs/uk/docs/_llm-test.md @@ -0,0 +1,502 @@ +# Тестовий файл LLM { #llm-test-file } + +Цей документ перевіряє, чи розуміє LLM, який перекладає документацію, `general_prompt` у `scripts/translate.py` та мовно-специфічну підсказку в `docs/{language code}/llm-prompt.md`. Мовно-специфічна підсказка додається до `general_prompt`. + +Тести, додані тут, побачать усі автори мовно-специфічних підсказок. + +Використовуйте так: + +* Майте мовно-специфічну підсказку - `docs/{language code}/llm-prompt.md`. +* Зробіть свіжий переклад цього документа на бажану цільову мову (див., наприклад, команду `translate-page` у `translate.py`). Це створить переклад у `docs/{language code}/docs/_llm-test.md`. +* Перевірте, чи все гаразд у перекладі. +* За потреби покращіть вашу мовно-специфічну підсказку, загальну підсказку або англійський документ. +* Потім вручну виправте решту проблем у перекладі, щоб він був якісним. +* Перекладіть повторно, маючи якісний переклад на місці. Ідеальний результат - коли LLM більше не вносить змін до перекладу. Це означає, що загальна підсказка та ваша мовно-специфічна підсказка настільки добрі, наскільки це можливо (інколи він робитиме кілька, здавалося б, випадкових змін, причина в тому, що LLM-и не є детерміністичними алгоритмами). + +Тести: + +## Фрагменти коду { #code-snippets } + +//// tab | Тест + +Це фрагмент коду: `foo`. А це ще один фрагмент коду: `bar`. І ще один: `baz quux`. + +//// + +//// tab | Інформація + +Вміст фрагментів коду слід залишати без змін. + +Див. розділ `### Content of code snippets` в загальній підсказці в `scripts/translate.py`. + +//// + +## Цитати { #quotes } + +//// tab | Тест + +Вчора мій друг написав: «Якщо ви правильно напишете "incorrectly", ви написали це неправильно». На що я відповів: «Правильно, але 'incorrectly' - це неправильно, а не '"incorrectly"'». + +/// note | Примітка + +LLM, ймовірно, перекладе це неправильно. Цікаво лише те, чи збереже він виправлений переклад під час повторного перекладу. + +/// + +//// + +//// tab | Інформація + +Автор підсказки може обрати, чи конвертувати нейтральні лапки в типографські. Можна залишити як є. + +Див., наприклад, розділ `### Quotes` у `docs/de/llm-prompt.md`. + +//// + +## Лапки у фрагментах коду { #quotes-in-code-snippets } + +//// tab | Тест + +`pip install "foo[bar]"` + +Приклади строкових літералів у фрагментах коду: `"this"`, `'that'`. + +Складний приклад строкових літералів у фрагментах коду: `f"I like {'oranges' if orange else "apples"}"` + +Хардкор: `Yesterday, my friend wrote: "If you spell incorrectly correctly, you have spelled it incorrectly". To which I answered: "Correct, but 'incorrectly' is incorrectly not '"incorrectly"'"` + +//// + +//// tab | Інформація + +... Однак лапки всередині фрагментів коду мають залишатися як є. + +//// + +## Блоки коду { #code-blocks } + +//// tab | Тест + +Приклад коду Bash... + +```bash +# Вивести привітання всесвіту +echo "Hello universe" +``` + +...і приклад коду консолі... + +```console +$ fastapi run main.py + FastAPI Starting server + Searching for package file structure +``` + +...і ще один приклад коду консолі... + +```console +// Створіть каталог "code" +$ mkdir code +// Перейдіть до цього каталогу +$ cd code +``` + +...і приклад коду Python... + +```Python +wont_work() # Це не спрацює 😱 +works(foo="bar") # Це працює 🎉 +``` + +...і це все. + +//// + +//// tab | Інформація + +Код у блоках коду не слід змінювати, за винятком коментарів. + +Див. розділ `### Content of code blocks` в загальній підсказці в `scripts/translate.py`. + +//// + +## Вкладки та кольорові блоки { #tabs-and-colored-boxes } + +//// tab | Тест + +/// info | Інформація +Some text +/// + +/// note | Примітка +Some text +/// + +/// note | Технічні деталі +Some text +/// + +/// check | Перевірте +Some text +/// + +/// tip | Порада +Some text +/// + +/// warning | Попередження +Some text +/// + +/// danger | Обережно +Some text +/// + +//// + +//// tab | Інформація + +У вкладках і блоках `Info`/`Note`/`Warning`/тощо необхідно додати переклад їхнього заголовка після вертикальної риски (`|`). + +Див. розділи `### Special blocks` і `### Tab blocks` в загальній підсказці в `scripts/translate.py`. + +//// + +## Веб- і внутрішні посилання { #web-and-internal-links } + +//// tab | Тест + +Текст посилання має бути перекладений, адреса посилання має залишитися незмінною: + +* [Посилання на заголовок вище](#code-snippets) +* [Внутрішнє посилання](index.md#installation){.internal-link target=_blank} +* Зовнішнє посилання +* Посилання на стиль +* Посилання на скрипт +* Посилання на зображення + +Текст посилання має бути перекладений, адреса посилання має вказувати на переклад: + +* Посилання на FastAPI + +//// + +//// tab | Інформація + +Посилання слід перекладати, але їхні адреси мають лишатися незмінними. Виняток - абсолютні посилання на сторінки документації FastAPI. У такому випадку вони мають вказувати на переклад. + +Див. розділ `### Links` в загальній підсказці в `scripts/translate.py`. + +//// + +## Елементи HTML «abbr» { #html-abbr-elements } + +//// tab | Тест + +Ось деякі речі, обгорнуті в елементи HTML «abbr» (деякі вигадані): + +### Скорочення містить повну фразу { #the-abbr-gives-a-full-phrase } + +* GTD +* lt +* XWT +* PSGI + +### Скорочення містить повну фразу та пояснення { #the-abbr-gives-a-full-phrase-and-an-explanation } + +* MDN +* I/O. + +//// + +//// tab | Інформація + +Атрибути "title" елементів "abbr" перекладаються за певними інструкціями. + +Переклади можуть додавати власні елементи "abbr", які LLM не повинен прибирати. Наприклад, щоб пояснити англійські слова. + +Див. розділ `### HTML abbr elements` в загальній підсказці в `scripts/translate.py`. + +//// + +## Елементи HTML «dfn» { #html-dfn-elements } + +* кластер +* Глибоке навчання + +## Заголовки { #headings } + +//// tab | Тест + +### Розробка вебзастосунку - навчальний посібник { #develop-a-webapp-a-tutorial } + +Привіт. + +### Підказки типів та - анотації { #type-hints-and-annotations } + +Ще раз привіт. + +### Супер- та підкласи { #super-and-subclasses } + +Ще раз привіт. + +//// + +//// tab | Інформація + +Єдине жорстке правило для заголовків - LLM має залишати хеш-частину в фігурних дужках незмінною, щоб посилання не ламалися. + +Див. розділ `### Headings` у загальній підсказці в `scripts/translate.py`. + +Для деяких мовно-специфічних інструкцій див., наприклад, розділ `### Headings` у `docs/de/llm-prompt.md`. + +//// + +## Терміни, що використовуються в документації { #terms-used-in-the-docs } + +//// tab | Тест + +* ви +* ваш + +* напр. +* тощо + +* `foo` як `int` +* `bar` як `str` +* `baz` як `list` + +* навчальний посібник - Керівництво користувача +* просунутий посібник користувача +* документація SQLModel +* документація API +* автоматична документація + +* Наука про дані +* глибоке навчання +* машинне навчання +* впровадження залежностей +* HTTP базова автентифікація +* HTTP дайджест +* формат ISO +* стандарт Схеми JSON +* Схема JSON +* визначення схеми +* потік паролю +* мобільний + +* застаріле +* спроєктовано +* недійсний +* на льоту +* стандарт +* типове +* чутливий до регістру +* нечутливий до регістру + +* обслуговувати застосунок +* обслуговувати сторінку + +* застосунок +* застосунок + +* запит +* відповідь +* відповідь з помилкою + +* операція шляху +* декоратор операції шляху +* функція операції шляху + +* тіло +* тіло запиту +* тіло відповіді +* тіло JSON +* тіло форми +* тіло функції + +* параметр +* параметр тіла +* параметр шляху +* параметр запиту +* параметр кукі +* параметр заголовка +* параметр форми +* параметр функції + +* подія +* подія запуску +* запуск сервера +* подія вимкнення +* подія тривалості життя + +* обробник +* обробник події +* обробник винятків +* обробляти + +* модель +* модель Pydantic +* модель даних +* модель бази даних +* модель форми +* об'єкт моделі + +* клас +* базовий клас +* батьківський клас +* підклас +* дочірній клас +* споріднений клас +* метод класу + +* заголовок +* заголовки +* заголовок авторизації +* заголовок `Authorization` +* направлений заголовок + +* система впровадження залежностей +* залежність +* залежний +* залежний + +* I/O-обмежений +* CPU-обмежений +* рівночасність +* паралелізм +* багатопроцесорність + +* змінна оточення +* змінна оточення +* `PATH` +* змінна `PATH` + +* автентифікація +* постачальник автентифікації +* авторизація +* форма авторизації +* постачальник авторизації +* користувач автентифікується +* система автентифікує користувача + +* CLI +* інтерфейс командного рядка + +* сервер +* клієнт + +* хмарний постачальник +* хмарний сервіс + +* розробка +* етапи розробки + +* словник +* словник +* перелік +* перелік +* елемент переліку + +* кодувальник +* декодувальник +* кодувати +* декодувати + +* виняток +* породжувати + +* вираз +* оператор + +* фронтенд +* бекенд + +* обговорення GitHub +* проблема GitHub + +* продуктивність +* оптимізація продуктивності + +* тип, що повертається +* повернене значення + +* безпека +* схема безпеки + +* завдання +* фонове завдання +* функція завдання + +* шаблон +* рушій шаблонів + +* анотація типу +* підказка типу + +* серверний працівник +* працівник Uvicorn +* працівник Gunicorn +* процес працівника +* клас працівника +* робоче навантаження + +* розгортання +* розгортати + +* SDK +* набір для розробки програмного забезпечення + +* `APIRouter` +* `requirements.txt` +* токен носія +* несумісна зміна +* помилка +* кнопка +* викликаємий +* код +* фіксація +* менеджер контексту +* співпрограма +* сеанс бази даних +* диск +* домен +* рушій +* фальшивий X +* метод HTTP GET +* предмет +* бібліотека +* тривалість життя +* блокування +* проміжне програмне забезпечення +* мобільний застосунок +* модуль +* монтування +* мережа +* джерело +* переписування +* корисне навантаження +* процесор +* властивість +* представник +* запит на витяг +* запит +* пам'ять з довільним доступом +* віддалена машина +* код статусу +* строка +* мітка +* веб-фреймворк +* дика карта +* повертати +* перевіряти + +//// + +//// tab | Інформація + +Це неповний і не нормативний список (переважно) технічних термінів, що зустрічаються в документації. Він може бути корисним автору підсказки, щоб зрозуміти, для яких термінів LLM потрібна допомога. Наприклад, коли він постійно повертає хороший переклад до менш вдалого. Або коли йому складно відмінювати термін вашою мовою. + +Див., наприклад, розділ `### List of English terms and their preferred German translations` у `docs/de/llm-prompt.md`. + +//// diff --git a/docs/uk/docs/about/index.md b/docs/uk/docs/about/index.md new file mode 100644 index 0000000000..198fd828e5 --- /dev/null +++ b/docs/uk/docs/about/index.md @@ -0,0 +1,3 @@ +# Про { #about } + +Про FastAPI, його проєктування, натхнення та інше. 🤓 diff --git a/docs/uk/docs/advanced/additional-responses.md b/docs/uk/docs/advanced/additional-responses.md new file mode 100644 index 0000000000..089967a51a --- /dev/null +++ b/docs/uk/docs/advanced/additional-responses.md @@ -0,0 +1,247 @@ +# Додаткові відповіді в OpenAPI { #additional-responses-in-openapi } + +/// warning | Попередження + +Це доволі просунута тема. + +Якщо ви лише починаєте з **FastAPI**, ймовірно, вам це не потрібно. + +/// + +Ви можете оголосити додаткові відповіді з додатковими кодами статусу, типами медіа, описами тощо. + +Ці додаткові відповіді буде включено до схеми OpenAPI, тож вони з'являться і в документації API. + +Але для таких додаткових відповідей потрібно повертати `Response` на кшталт `JSONResponse` безпосередньо, із потрібним кодом статусу та вмістом. + +## Додаткова відповідь з `model` { #additional-response-with-model } + +Ви можете передати вашим декораторам операцій шляху параметр `responses`. + +Він приймає `dict`: ключі - це коди статусу для кожної відповіді (наприклад, `200`), а значення - інші `dict` з інформацією для кожної з них. + +Кожен із цих словників відповіді може мати ключ `model`, що містить Pydantic-модель, подібно до `response_model`. + +**FastAPI** візьме цю модель, згенерує її Схему JSON і додасть у відповідне місце в OpenAPI. + +Наприклад, щоб оголосити іншу відповідь з кодом статусу `404` і Pydantic-моделлю `Message`, ви можете написати: + +{* ../../docs_src/additional_responses/tutorial001_py310.py hl[18,22] *} + +/// note | Примітка + +Майте на увазі, що потрібно повертати `JSONResponse` безпосередньо. + +/// + +/// info | Інформація + +Ключ `model` не є частиною OpenAPI. + +**FastAPI** візьме звідти Pydantic-модель, згенерує Схему JSON і помістить у відповідне місце. + +Відповідне місце це: + +- У ключі `content`, значенням якого є інший JSON-об'єкт (`dict`), що містить: + - Ключ із типом медіа, напр. `application/json`, значенням якого є інший JSON-об'єкт, що містить: + - Ключ `schema`, значенням якого є Схема JSON з моделі - ось це і є правильне місце. + - **FastAPI** додає тут посилання на глобальні Схеми JSON в іншому місці вашого OpenAPI замість прямого включення. Так інші застосунки та клієнти можуть напряму використовувати ці Схеми JSON, надавати кращі інструменти генерації коду тощо. + +/// + +Згенеровані відповіді в OpenAPI для цієї операції шляху будуть такими: + +```JSON hl_lines="3-12" +{ + "responses": { + "404": { + "description": "Additional Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Item" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } +} +``` + +Схеми посилаються на інше місце всередині схеми OpenAPI: + +```JSON hl_lines="4-16" +{ + "components": { + "schemas": { + "Message": { + "title": "Message", + "required": [ + "message" + ], + "type": "object", + "properties": { + "message": { + "title": "Message", + "type": "string" + } + } + }, + "Item": { + "title": "Item", + "required": [ + "id", + "value" + ], + "type": "object", + "properties": { + "id": { + "title": "Id", + "type": "string" + }, + "value": { + "title": "Value", + "type": "string" + } + } + }, + "ValidationError": { + "title": "ValidationError", + "required": [ + "loc", + "msg", + "type" + ], + "type": "object", + "properties": { + "loc": { + "title": "Location", + "type": "array", + "items": { + "type": "string" + } + }, + "msg": { + "title": "Message", + "type": "string" + }, + "type": { + "title": "Error Type", + "type": "string" + } + } + }, + "HTTPValidationError": { + "title": "HTTPValidationError", + "type": "object", + "properties": { + "detail": { + "title": "Detail", + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidationError" + } + } + } + } + } + } +} +``` + +## Додаткові типи медіа для основної відповіді { #additional-media-types-for-the-main-response } + +Можна використати цей самий параметр `responses`, щоб додати різні типи медіа для тієї ж основної відповіді. + +Наприклад, можна додати додатковий тип медіа `image/png`, оголосивши, що ваша операція шляху може повертати JSON-об'єкт (з типом медіа `application/json`) або PNG-зображення: + +{* ../../docs_src/additional_responses/tutorial002_py310.py hl[17:22,26] *} + +/// note | Примітка + +Зверніть увагу, що потрібно повертати зображення безпосередньо за допомогою `FileResponse`. + +/// + +/// info | Інформація + +Поки ви явно не вкажете інший тип медіа в параметрі `responses`, FastAPI вважатиме, що відповідь має той самий тип медіа, що й основний клас відповіді (типово `application/json`). + +Але якщо ви вказали власний клас відповіді з `None` як типом медіа, FastAPI використає `application/json` для будь-якої додаткової відповіді, що має пов'язану модель. + +/// + +## Комбінування інформації { #combining-information } + +Ви також можете поєднувати інформацію про відповіді з кількох місць, зокрема з параметрів `response_model`, `status_code` і `responses`. + +Ви можете оголосити `response_model`, використовуючи типовий код статусу `200` (або власний за потреби), а потім оголосити додаткову інформацію для цієї ж відповіді в `responses`, безпосередньо в схемі OpenAPI. + +**FastAPI** збереже додаткову інформацію з `responses` і поєднає її зі Схемою JSON з вашої моделі. + +Наприклад, ви можете оголосити відповідь з кодом статусу `404`, яка використовує Pydantic-модель і має власний `description`. + +І відповідь з кодом статусу `200`, яка використовує ваш `response_model`, але містить власний `example`: + +{* ../../docs_src/additional_responses/tutorial003_py310.py hl[20:31] *} + +Усе це буде поєднано та включено до вашого OpenAPI і показано в документації API: + + + +## Комбінуйте попередньо визначені та власні відповіді { #combine-predefined-responses-and-custom-ones } + +Можливо, ви захочете мати кілька попередньо визначених відповідей, що застосовуються до багатьох операцій шляху, але поєднувати їх із власними відповідями, потрібними для кожної операції шляху. + +Для таких випадків можна скористатися прийомом Python «розпакування» `dict` за допомогою `**dict_to_unpack`: + +```Python +old_dict = { + "old key": "old value", + "second old key": "second old value", +} +new_dict = {**old_dict, "new key": "new value"} +``` + +Тут `new_dict` міститиме всі пари ключ-значення з `old_dict` плюс нову пару ключ-значення: + +```Python +{ + "old key": "old value", + "second old key": "second old value", + "new key": "new value", +} +``` + +Цей прийом можна використати, щоб перевикористовувати деякі попередньо визначені відповіді у ваших операціях шляху та поєднувати їх із додатковими власними. + +Наприклад: + +{* ../../docs_src/additional_responses/tutorial004_py310.py hl[11:15,24] *} + +## Докладніше про відповіді OpenAPI { #more-information-about-openapi-responses } + +Щоб побачити, що саме можна включати у відповіді, ознайомтеся з цими розділами специфікації OpenAPI: + +- Об'єкт відповідей OpenAPI, він включає `Response Object`. +- Об'єкт відповіді OpenAPI, ви можете включити будь-що з цього безпосередньо в кожну відповідь у параметрі `responses`. Зокрема `description`, `headers`, `content` (усередині нього ви оголошуєте різні типи медіа та Схеми JSON) і `links`. diff --git a/docs/uk/docs/advanced/additional-status-codes.md b/docs/uk/docs/advanced/additional-status-codes.md new file mode 100644 index 0000000000..afba933e20 --- /dev/null +++ b/docs/uk/docs/advanced/additional-status-codes.md @@ -0,0 +1,41 @@ +# Додаткові коди статусу { #additional-status-codes } + +За замовчуванням **FastAPI** повертатиме відповіді за допомогою `JSONResponse`, поміщаючи вміст, який ви повертаєте з вашої *операції шляху*, у цей `JSONResponse`. + +Він використовуватиме код статусу за замовчуванням або той, який ви встановите у своїй *операції шляху*. + +## Додаткові коди статусу { #additional-status-codes_1 } + +Якщо ви хочете повертати додаткові коди статусу, окрім основного, зробіть це, повертаючи `Response` безпосередньо, наприклад `JSONResponse`, і встановіть додатковий код статусу напряму. + +Наприклад, припустімо, ви хочете мати *операцію шляху*, яка дозволяє оновлювати предмети та повертає код статусу HTTP 200 «OK» у разі успіху. + +Але ви також хочете приймати нові предмети. І коли таких предметів раніше не існувало, операція створює їх і повертає код статусу HTTP 201 «Created». + +Щоб це реалізувати, імпортуйте `JSONResponse` і поверніть ваш вміст безпосередньо там, встановивши потрібний `status_code`: + +{* ../../docs_src/additional_status_codes/tutorial001_an_py310.py hl[4,25] *} + +/// warning | Попередження + +Коли ви повертаєте `Response` безпосередньо, як у прикладі вище, він і буде повернений безпосередньо. + +Він не буде серіалізований за допомогою моделі тощо. + +Переконайтеся, що він містить саме ті дані, які вам потрібні, і що значення є коректним JSON (якщо ви використовуєте `JSONResponse`). + +/// + +/// note | Технічні деталі + +Ви також можете використати `from starlette.responses import JSONResponse`. + +**FastAPI** надає ті самі `starlette.responses` як `fastapi.responses` просто для вашої зручності як розробника. Але більшість доступних відповідей надходить безпосередньо зі Starlette. Те саме і зі `status`. + +/// + +## OpenAPI і документація API { #openapi-and-api-docs } + +Якщо ви повертаєте додаткові коди статусу та відповіді безпосередньо, вони не будуть включені до схеми OpenAPI (документації API), адже FastAPI не має способу заздалегідь знати, що саме ви повернете. + +Але ви можете задокументувати це у своєму коді, використовуючи: [Додаткові відповіді](additional-responses.md){.internal-link target=_blank}. diff --git a/docs/uk/docs/advanced/advanced-dependencies.md b/docs/uk/docs/advanced/advanced-dependencies.md new file mode 100644 index 0000000000..0c6f8cbb34 --- /dev/null +++ b/docs/uk/docs/advanced/advanced-dependencies.md @@ -0,0 +1,163 @@ +# Просунуті залежності { #advanced-dependencies } + +## Параметризовані залежності { #parameterized-dependencies } + +Усі залежності, які ми бачили, - це фіксована функція або клас. + +Але можуть бути випадки, коли ви хочете мати змогу задавати параметри залежності, не оголошуючи багато різних функцій або класів. + +Уявімо, що ми хочемо мати залежність, яка перевіряє, чи параметр запиту `q` містить певний фіксований вміст. + +Але ми хочемо мати змогу параметризувати цей фіксований вміст. + +## Екземпляр «callable» { #a-callable-instance } + +У Python є спосіб зробити екземпляр класу «callable». + +Не сам клас (який уже є «callable»), а екземпляр цього класу. + +Щоб це зробити, оголошуємо метод `__call__`: + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[12] *} + +У цьому випадку саме `__call__` **FastAPI** використає для перевірки додаткових параметрів і підзалежностей, і саме його буде викликано, щоб передати значення параметру у вашу *функцію операції шляху* пізніше. + +## Параметризувати екземпляр { #parameterize-the-instance } + +Тепер ми можемо використати `__init__`, щоб оголосити параметри екземпляра, які можна застосувати для «параметризації» залежності: + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[9] *} + +У цьому випадку **FastAPI** ніколи не торкається `__init__` і не покладається на нього - ми використовуватимемо його безпосередньо у своєму коді. + +## Створити екземпляр { #create-an-instance } + +Ми можемо створити екземпляр цього класу так: + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[18] *} + +Таким чином ми «параметризуємо» нашу залежність, яка тепер містить «bar» як атрибут `checker.fixed_content`. + +## Використовувати екземпляр як залежність { #use-the-instance-as-a-dependency } + +Далі ми можемо використати цей `checker` у `Depends(checker)` замість `Depends(FixedContentQueryChecker)`, адже залежністю є екземпляр `checker`, а не сам клас. + +Коли залежність розв'язується, **FastAPI** викличе цей `checker` так: + +```Python +checker(q="somequery") +``` + +...і передасть усе, що він поверне, як значення залежності у нашій *функції операції шляху* як параметр `fixed_content_included`: + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[22] *} + +/// tip | Порада + +Усе це може здаватися надуманим. І поки що може бути не дуже зрозуміло, навіщо це корисно. + +Ці приклади навмисно прості, але показують, як усе працює. + +У розділах про безпеку є утилітарні функції, реалізовані таким самим способом. + +Якщо ви все це зрозуміли, ви вже знаєте, як під капотом працюють ті утиліти для безпеки. + +/// + +## Залежності з `yield`, `HTTPException`, `except` та фоновими задачами { #dependencies-with-yield-httpexception-except-and-background-tasks } + +/// warning | Попередження + +Найімовірніше, вам не знадобляться ці технічні деталі. + +Вони корисні головно, якщо у вас був застосунок FastAPI старіший за 0.121.0 і ви стикаєтеся з проблемами залежностей із `yield`. + +/// + +Залежності з `yield` еволюціонували з часом, щоб охопити різні сценарії використання та виправити деякі проблеми, ось підсумок змін. + +### Залежності з `yield` і `scope` { #dependencies-with-yield-and-scope } + +У версії 0.121.0 **FastAPI** додано підтримку `Depends(scope="function")` для залежностей з `yield`. + +З `Depends(scope="function")` завершальний код після `yield` виконується одразу після завершення *функції операції шляху*, до того як відповідь буде надіслана клієнту. + +А при використанні `Depends(scope="request")` (типове значення) завершальний код після `yield` виконується після відправлення відповіді. + +Докладніше читайте в документації: [Залежності з `yield` - Ранній вихід і `scope`](../tutorial/dependencies/dependencies-with-yield.md#early-exit-and-scope). + +### Залежності з `yield` і `StreamingResponse`, технічні деталі { #dependencies-with-yield-and-streamingresponse-technical-details } + +До **FastAPI** 0.118.0, якщо ви використовували залежність із `yield`, завершальний код виконувався після повернення з *функції операції шляху*, але безпосередньо перед відправленням відповіді. + +Метою було уникнути утримання ресурсів довше, ніж потрібно, очікуючи, поки відповідь пройде мережею. + +Це також означало, що якщо ви повертали `StreamingResponse`, завершальний код залежності з `yield` уже було б виконано. + +Наприклад, якщо у залежності з `yield` була сесія бази даних, `StreamingResponse` не зміг би використовувати цю сесію під час потокової передачі даних, тому що сесію вже закрито в завершальному коді після `yield`. + +Цю поведінку змінено у 0.118.0: завершальний код після `yield` знову виконується після відправлення відповіді. + +/// info | Інформація + +Як побачите нижче, це дуже схоже на поведінку до версії 0.106.0, але з кількома покращеннями та виправленнями помилок у крайових випадках. + +/// + +#### Випадки використання з раннім завершальним кодом { #use-cases-with-early-exit-code } + +Є кілька сценаріїв із певними умовами, які можуть виграти від старої поведінки - виконувати завершальний код залежностей з `yield` до надсилання відповіді. + +Наприклад, уявіть, що у вас є код, який використовує сесію бази даних у залежності з `yield` лише для перевірки користувача, але сесія більше не використовується у *функції операції шляху*, тільки в залежності, і відправлення відповіді триває довго - як у `StreamingResponse`, що повільно надсилає дані, але з якоїсь причини не використовує базу даних. + +У такому разі сесія БД утримувалася б до завершення відправлення відповіді, але якщо ви її не використовуєте, утримувати її немає потреби. + +Ось як це може виглядати: + +{* ../../docs_src/dependencies/tutorial013_an_py310.py *} + +Завершальний код - автоматичне закриття `Session` у: + +{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[19:21] *} + +...виконається після того, як відповідь завершить надсилати повільні дані: + +{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[30:38] hl[31:33] *} + +Але оскільки `generate_stream()` не використовує сесію бази даних, немає реальної потреби тримати сесію відкритою під час надсилання відповіді. + +Якщо у вас саме такий випадок із SQLModel (або SQLAlchemy), ви можете явно закрити сесію, коли вона більше не потрібна: + +{* ../../docs_src/dependencies/tutorial014_an_py310.py ln[24:28] hl[28] *} + +Так сесія звільнить з'єднання з базою даних, і його зможуть використовувати інші запити. + +Якщо у вас інший сценарій, де потрібно раннє завершення залежності з `yield`, створіть, будь ласка, питання в обговореннях GitHub із вашим конкретним випадком і поясненням, чому вам корисне раннє закриття для залежностей з `yield`. + +Якщо будуть переконливі приклади для раннього закриття в залежностях з `yield`, я розгляну додавання нового способу увімкнути раннє закриття. + +### Залежності з `yield` і `except`, технічні деталі { #dependencies-with-yield-and-except-technical-details } + +До **FastAPI** 0.110.0, якщо ви використовували залежність із `yield`, перехоплювали виняток через `except` у цій залежності і не піднімали його знову, виняток автоматично піднімався/пересилався до будь-яких обробників винятків або внутрішнього обробника помилок сервера. + +Це змінено у версії 0.110.0, щоб усунути неконтрольоване споживання пам'яті від пересланих винятків без обробника (внутрішні помилки сервера) та зробити поведінку узгодженою зі звичайним Python-кодом. + +### Фонові задачі та залежності з `yield`, технічні деталі { #background-tasks-and-dependencies-with-yield-technical-details } + +До **FastAPI** 0.106.0 піднімати винятки після `yield` було неможливо: завершальний код у залежностях з `yield` виконувався після надсилання відповіді, тож [обробники винятків](../tutorial/handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank} уже відпрацювали б. + +Так було спроєктовано головно для того, щоб дозволити використовувати ті самі об'єкти, «віддані» залежностями через `yield`, усередині фонових задач, оскільки завершальний код виконувався після завершення фонових задач. + +У **FastAPI** 0.106.0 це змінено, щоб не утримувати ресурси під час очікування, поки відповідь піде мережею. + +/// tip | Порада + +Крім того, фонова задача зазвичай є незалежним набором логіки, який слід обробляти окремо, з власними ресурсами (наприклад, власним з'єднанням з базою даних). + +Тож так у вас, ймовірно, буде чистіший код. + +/// + +Якщо ви раніше покладалися на цю поведінку, тепер слід створювати ресурси для фонових задач усередині самої фонової задачі та використовувати всередині лише дані, що не залежать від ресурсів залежностей із `yield`. + +Наприклад, замість використання тієї самої сесії бази даних ви створюватимете нову сесію в самій фоновій задачі та отримуватимете об'єкти з бази даних, використовуючи цю нову сесію. І далі, замість передавання об'єкта з бази даних як параметра у функцію фонової задачі, ви передасте ідентифікатор цього об'єкта, а потім отримаєте об'єкт знову всередині функції фонової задачі. diff --git a/docs/uk/docs/advanced/advanced-python-types.md b/docs/uk/docs/advanced/advanced-python-types.md new file mode 100644 index 0000000000..9eedc48568 --- /dev/null +++ b/docs/uk/docs/advanced/advanced-python-types.md @@ -0,0 +1,61 @@ +# Просунуті типи Python { #advanced-python-types } + +Ось кілька додаткових ідей, які можуть бути корисні під час роботи з типами в Python. + +## Використання `Union` або `Optional` { #using-union-or-optional } + +Якщо ваш код з якоїсь причини не може використовувати `|`, наприклад, якщо це не анотація типів, а щось на кшталт `response_model=`, замість вертикальної риски (`|`) ви можете використати `Union` з `typing`. + +Наприклад, ви можете оголосити, що щось може бути `str` або `None`: + +```python +from typing import Union + + +def say_hi(name: Union[str, None]): + print(f"Hi {name}!") +``` + +У `typing` також є скорочення, щоб оголосити, що щось може бути `None`, - `Optional`. + +Ось порада з моєї дуже «суб'єктивної» точки зору: + +- 🚨 Уникайте використання `Optional[SomeType]` +- Натомість ✨ **використовуйте `Union[SomeType, None]`** ✨. + +Обидва варіанти еквівалентні і під капотом однакові, але я рекомендую `Union` замість `Optional`, тому що слово «**optional**» ніби натякає, що значення є необов'язковим, а насправді означає «може бути `None`», навіть якщо воно не є необов'язковим і все ще обов'язкове. + +Вважаю, `Union[SomeType, None]` більш явно це передає. + +Йдеться лише про слова та назви. Але ці слова можуть впливати на те, як ви та ваша команда думаєте про код. + +Як приклад, розгляньмо цю функцію: + +```python +from typing import Optional + + +def say_hi(name: Optional[str]): + print(f"Hey {name}!") +``` + +Параметр `name` визначено як `Optional[str]`, але він не є необов'язковим, ви не можете викликати функцію без цього параметра: + +```Python +say_hi() # О ні, це викликає помилку! 😱 +``` + +Параметр `name` все ще обов'язковий (не «необов'язковий»), тому що не має значення за замовчуванням. Водночас `name` приймає `None` як значення: + +```Python +say_hi(name=None) # Це працює, None припустимий 🎉 +``` + +Гарна новина: у більшості випадків ви зможете просто використовувати `|`, щоб визначати об'єднання типів: + +```python +def say_hi(name: str | None): + print(f"Hey {name}!") +``` + +Тож зазвичай вам не доведеться перейматися такими назвами, як `Optional` і `Union`. 😎 diff --git a/docs/uk/docs/advanced/async-tests.md b/docs/uk/docs/advanced/async-tests.md new file mode 100644 index 0000000000..51d0d57610 --- /dev/null +++ b/docs/uk/docs/advanced/async-tests.md @@ -0,0 +1,99 @@ +# Асинхронні тести { #async-tests } + +Ви вже бачили, як тестувати ваші застосунки **FastAPI** за допомогою наданого `TestClient`. До цього часу ви бачили лише, як писати синхронні тести, без використання функцій `async`. + +Можливість використовувати асинхронні функції у тестах може бути корисною, наприклад, коли ви асинхронно звертаєтеся до бази даних. Уявіть, що ви хочете протестувати надсилання запитів до вашого застосунку FastAPI, а потім перевірити, що ваш бекенд успішно записав коректні дані в базу даних, використовуючи асинхронну бібліотеку для бази даних. + +Розгляньмо, як це реалізувати. + +## pytest.mark.anyio { #pytest-mark-anyio } + +Якщо ми хочемо викликати асинхронні функції у тестах, самі тестові функції мають бути асинхронними. AnyIO надає зручний плагін, який дозволяє вказати, що деякі тестові функції слід виконувати асинхронно. + +## HTTPX { #httpx } + +Навіть якщо ваш застосунок **FastAPI** використовує звичайні функції `def` замість `async def`, під капотом це все одно `async`-застосунок. + +`TestClient` робить певну «магію» всередині, щоб викликати асинхронний застосунок FastAPI у ваших звичайних тестових функціях `def`, використовуючи стандартний pytest. Але ця «магія» більше не працює, коли ми використовуємо його всередині асинхронних функцій. Запускаючи тести асинхронно, ми більше не можемо використовувати `TestClient` у наших тестових функціях. + +`TestClient` побудований на основі HTTPX, і на щастя, ми можемо використовувати його безпосередньо для тестування API. + +## Приклад { #example } + +Для простого прикладу розгляньмо структуру файлів, подібну до описаної в [Більші застосунки](../tutorial/bigger-applications.md){.internal-link target=_blank} та [Тестування](../tutorial/testing.md){.internal-link target=_blank}: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +│   └── test_main.py +``` + +Файл `main.py` міститиме: + +{* ../../docs_src/async_tests/app_a_py310/main.py *} + +Файл `test_main.py` міститиме тести для `main.py`, тепер це може виглядати так: + +{* ../../docs_src/async_tests/app_a_py310/test_main.py *} + +## Запуск { #run-it } + +Ви можете запустити тести як зазвичай: + +
+ +```console +$ pytest + +---> 100% +``` + +
+ +## Докладно { #in-detail } + +Маркер `@pytest.mark.anyio` повідомляє pytest, що цю тестову функцію слід викликати асинхронно: + +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[7] *} + +/// tip | Порада + +Зауважте, що тестова функція тепер `async def` замість просто `def`, як це було раніше при використанні `TestClient`. + +/// + +Далі ми можемо створити `AsyncClient` із застосунком і надсилати до нього асинхронні запити, використовуючи `await`. + +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[9:12] *} + +Це еквівалентно: + +```Python +response = client.get('/') +``` + +...що ми раніше використовували для надсилання запитів за допомогою `TestClient`. + +/// tip | Порада + +Зауважте, що ми використовуємо async/await із новим `AsyncClient` - запит є асинхронним. + +/// + +/// warning | Попередження + +Якщо ваш застосунок залежить від подій тривалості життя, `AsyncClient` не ініціюватиме ці події. Щоб гарантувати їх ініціалізацію, використовуйте `LifespanManager` з florimondmanca/asgi-lifespan. + +/// + +## Інші асинхронні виклики функцій { #other-asynchronous-function-calls } + +Оскільки тестова функція тепер асинхронна, ви також можете викликати (і `await`) інші `async`-функції окрім надсилання запитів до вашого застосунку FastAPI у тестах - так само, як ви робили б це будь-де у вашому коді. + +/// tip | Порада + +Якщо ви натрапили на `RuntimeError: Task attached to a different loop` під час інтеграції асинхронних викликів у ваші тести (наприклад, при використанні MongoDB's MotorClient), пам'ятайте створювати об'єкти, яким потрібен цикл подій, лише всередині асинхронних функцій, наприклад, у зворотному виклику `@app.on_event("startup")`. + +/// diff --git a/docs/uk/docs/advanced/behind-a-proxy.md b/docs/uk/docs/advanced/behind-a-proxy.md new file mode 100644 index 0000000000..66bb4c0827 --- /dev/null +++ b/docs/uk/docs/advanced/behind-a-proxy.md @@ -0,0 +1,466 @@ +# За представником { #behind-a-proxy } + +У багатьох випадках ви будете використовувати **представника** на кшталт Traefik або Nginx перед вашим застосунком FastAPI. + +Такі представники можуть обробляти сертифікати HTTPS та інші речі. + +## Направлені заголовки представника { #proxy-forwarded-headers } + +**Представник** перед вашим застосунком зазвичай встановлює деякі заголовки на льоту перед відправленням запитів до вашого **сервера**, щоб повідомити серверу, що запит було **направлено** через представника, вказати оригінальну (публічну) URL-адресу, включно з доменом, що використовується HTTPS тощо. + +Програмний **сервер** (наприклад, **Uvicorn** через **FastAPI CLI**) здатний інтерпретувати ці заголовки і передавати цю інформацію вашому застосунку. + +Але з міркувань безпеки, оскільки сервер не знає, що він працює за довіреним представником, він не інтерпретуватиме ці заголовки. + +/// note | Технічні деталі + +Заголовки представника: + +* X-Forwarded-For +* X-Forwarded-Proto +* X-Forwarded-Host + +/// + +### Увімкнути направлені заголовки представника { #enable-proxy-forwarded-headers } + +Ви можете запустити FastAPI CLI з *опцією CLI* `--forwarded-allow-ips` і передати IP-адреси, яким слід довіряти для читання цих направлених заголовків. + +Якщо ви встановите `--forwarded-allow-ips="*"`, це означатиме довіру до всіх вхідних IP. + +Якщо ваш **сервер** знаходиться за довіреним **представником** і тільки представник спілкується з ним, це змусить сервер приймати будь-яку IP-адресу цього **представника**. + +
+ +```console +$ fastapi run --forwarded-allow-ips="*" + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +### Перенаправлення з HTTPS { #redirects-with-https } + +Наприклад, припустимо, ви визначили *операцію шляху* `/items/`: + +{* ../../docs_src/behind_a_proxy/tutorial001_01_py310.py hl[6] *} + +Якщо клієнт спробує перейти до `/items`, за замовчуванням буде виконано перенаправлення на `/items/`. + +Але до встановлення *опції CLI* `--forwarded-allow-ips` це могло б перенаправити на `http://localhost:8000/items/`. + +Втім, можливо ваш застосунок розміщено на `https://mysuperapp.com`, і перенаправлення має бути на `https://mysuperapp.com/items/`. + +Налаштувавши `--proxy-headers`, FastAPI зможе перенаправляти на правильну адресу. 😎 + +``` +https://mysuperapp.com/items/ +``` + +/// tip | Порада + +Якщо хочете дізнатися більше про HTTPS, перегляньте посібник [Про HTTPS](../deployment/https.md){.internal-link target=_blank}. + +/// + +### Як працюють направлені заголовки представника { #how-proxy-forwarded-headers-work } + +Ось візуальне подання того, як **представник** додає направлені заголовки між клієнтом і **сервером застосунку**: + +```mermaid +sequenceDiagram + participant Client + participant Proxy as Proxy/Load Balancer + participant Server as FastAPI Server + + Client->>Proxy: HTTPS Request
Host: mysuperapp.com
Path: /items + + Note over Proxy: Proxy adds forwarded headers + + Proxy->>Server: HTTP Request
X-Forwarded-For: [client IP]
X-Forwarded-Proto: https
X-Forwarded-Host: mysuperapp.com
Path: /items + + Note over Server: Server interprets headers
(if --forwarded-allow-ips is set) + + Server->>Proxy: HTTP Response
with correct HTTPS URLs + + Proxy->>Client: HTTPS Response +``` + +**Представник** перехоплює початковий запит клієнта і додає спеціальні *направлені* заголовки (`X-Forwarded-*`) перед передачею запиту на **сервер застосунку**. + +Ці заголовки зберігають інформацію про оригінальний запит, яка інакше була б втрачена: + +- X-Forwarded-For: оригінальна IP-адреса клієнта +- X-Forwarded-Proto: оригінальний протокол (`https`) +- X-Forwarded-Host: оригінальний хост (`mysuperapp.com`) + +Коли **FastAPI CLI** налаштовано з `--forwarded-allow-ips`, він довіряє цим заголовкам і використовує їх, наприклад, для побудови коректних URL-адрес у перенаправленнях. + +## Представник із вилученим префіксом шляху { #proxy-with-a-stripped-path-prefix } + +У вас може бути представник, що додає префікс шляху до вашого застосунку. + +У таких випадках ви можете використати `root_path` для конфігурації застосунку. + +`root_path` - це механізм, наданий специфікацією ASGI (на якій побудовано FastAPI через Starlette). + +`root_path` використовується для обробки саме таких випадків. + +Його також використано внутрішньо під час монтування підзастосунків. + +Наявність представника з вилученим префіксом шляху означає, що ви могли б оголосити шлях `/app` у вашому коді, але потім додати шар зверху (представника), який розмістить ваш застосунок **FastAPI** під шляхом на кшталт `/api/v1`. + +У такому разі початковий шлях `/app` фактично буде доступний за `/api/v1/app`. + +Хоча весь ваш код написано з припущенням, що є лише `/app`. + +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[6] *} + +І представник буде **«зрізати»** **префікс шляху** на льоту перед передачею запиту серверу застосунку (ймовірно, Uvicorn через FastAPI CLI), зберігаючи переконання вашого застосунку, що його обслуговують за `/app`, тож вам не доведеться оновлювати весь код, щоб додати префікс `/api/v1`. + +Дотепер усе працювало б як зазвичай. + +Але коли ви відкриєте вбудований інтерфейс документації (фронтенд), він очікуватиме отримати схему OpenAPI за `/openapi.json`, замість `/api/v1/openapi.json`. + +Отже, фронтенд (що працює у браузері) спробує звернутися до `/openapi.json` і не зможе отримати схему OpenAPI. + +Оскільки у нас є представник з префіксом шляху `/api/v1` для нашого застосунку, фронтенду потрібно отримувати схему OpenAPI за `/api/v1/openapi.json`. + +```mermaid +graph LR + +browser("Browser") +proxy["Proxy on http://0.0.0.0:9999/api/v1/app"] +server["Server on http://127.0.0.1:8000/app"] + +browser --> proxy +proxy --> server +``` + +/// tip | Порада + +IP `0.0.0.0` зазвичай означає, що програма слухає на всіх IP-адресах, доступних на цій машині/сервері. + +/// + +Інтерфейсу документації також потрібно, щоб схема OpenAPI оголошувала, що цей `server` API розташований за `/api/v1` (за представником). Наприклад: + +```JSON hl_lines="4-8" +{ + "openapi": "3.1.0", + // Ще дещо тут + "servers": [ + { + "url": "/api/v1" + } + ], + "paths": { + // Ще дещо тут + } +} +``` + +У цьому прикладі «Proxy» може бути чимось на кшталт **Traefik**. А сервером буде щось на кшталт FastAPI CLI з **Uvicorn**, який запускає ваш застосунок FastAPI. + +### Задання `root_path` { #providing-the-root-path } + +Щоб цього досягти, ви можете використати опцію командного рядка `--root-path`, наприклад: + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Якщо ви використовуєте Hypercorn, у нього також є опція `--root-path`. + +/// note | Технічні деталі + +Специфікація ASGI визначає `root_path` для такого випадку використання. + +А опція командного рядка `--root-path` надає цей `root_path`. + +/// + +### Перевірка поточного `root_path` { #checking-the-current-root-path } + +Ви можете отримати поточний `root_path`, який використовує ваш застосунок для кожного запиту, він є частиною словника `scope` (це частина специфікації ASGI). + +Тут ми додаємо його у повідомлення лише для демонстрації. + +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[8] *} + +Потім, якщо ви запустите Uvicorn так: + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Відповідь буде приблизно такою: + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +### Встановлення `root_path` у застосунку FastAPI { #setting-the-root-path-in-the-fastapi-app } + +Альтернативно, якщо у вас немає способу передати опцію командного рядка на кшталт `--root-path` чи еквівалентну, ви можете встановити параметр `root_path` під час створення вашого застосунку FastAPI: + +{* ../../docs_src/behind_a_proxy/tutorial002_py310.py hl[3] *} + +Передача `root_path` до `FastAPI` еквівалентна передачі опції командного рядка `--root-path` до Uvicorn або Hypercorn. + +### Про `root_path` { #about-root-path } + +Майте на увазі, що сервер (Uvicorn) не використовуватиме `root_path` ні для чого, окрім передачі його застосунку. + +Але якщо ви перейдете у вашому браузері на http://127.0.0.1:8000/app, ви побачите звичайну відповідь: + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +Тобто він не очікуватиме доступу за адресою `http://127.0.0.1:8000/api/v1/app`. + +Uvicorn очікуватиме, що представник буде звертатися до Uvicorn на `http://127.0.0.1:8000/app`, і тоді саме представник відповідатиме за додавання додаткового префікса `/api/v1` зверху. + +## Про представників із вилученим префіксом шляху { #about-proxies-with-a-stripped-path-prefix } + +Майте на увазі, що представник із вилученим префіксом шляху - це лише один зі способів його налаштування. + +Ймовірно, в багатьох випадках за замовчуванням представник не матиме вилученого префікса шляху. + +У такому випадку (без вилученого префікса шляху) представник слухатиме щось на кшталт `https://myawesomeapp.com`, і коли браузер перейде на `https://myawesomeapp.com/api/v1/app`, а ваш сервер (наприклад, Uvicorn) слухає на `http://127.0.0.1:8000`, представник (без вилученого префікса) звернеться до Uvicorn за тим самим шляхом: `http://127.0.0.1:8000/api/v1/app`. + +## Локальне тестування з Traefik { #testing-locally-with-traefik } + +Ви можете легко провести експеримент локально з вилученим префіксом шляху, використовуючи Traefik. + +Завантажте Traefik, це один бінарний файл, ви можете розпакувати архів і запустити його безпосередньо з термінала. + +Потім створіть файл `traefik.toml` з таким вмістом: + +```TOML hl_lines="3" +[entryPoints] + [entryPoints.http] + address = ":9999" + +[providers] + [providers.file] + filename = "routes.toml" +``` + +Це вказує Traefik слухати порт 9999 і використовувати інший файл `routes.toml`. + +/// tip | Порада + +Ми використовуємо порт 9999 замість стандартного HTTP-порту 80, щоб вам не довелося запускати його з адмін-повноваженнями (`sudo`). + +/// + +Тепер створіть інший файл `routes.toml`: + +```TOML hl_lines="5 12 20" +[http] + [http.middlewares] + + [http.middlewares.api-stripprefix.stripPrefix] + prefixes = ["/api/v1"] + + [http.routers] + + [http.routers.app-http] + entryPoints = ["http"] + service = "app" + rule = "PathPrefix(`/api/v1`)" + middlewares = ["api-stripprefix"] + + [http.services] + + [http.services.app] + [http.services.app.loadBalancer] + [[http.services.app.loadBalancer.servers]] + url = "http://127.0.0.1:8000" +``` + +Цей файл налаштовує Traefik на використання префікса шляху `/api/v1`. + +Потім Traefik переспрямовуватиме свої запити до вашого Uvicorn, який працює на `http://127.0.0.1:8000`. + +Тепер запустіть Traefik: + +
+ +```console +$ ./traefik --configFile=traefik.toml + +INFO[0000] Configuration loaded from file: /home/user/awesomeapi/traefik.toml +``` + +
+ +А тепер запустіть ваш застосунок, використовуючи опцію `--root-path`: + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +### Перевірте відповіді { #check-the-responses } + +Тепер, якщо ви перейдете за URL із портом Uvicorn: http://127.0.0.1:8000/app, ви побачите звичайну відповідь: + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +/// tip | Порада + +Зверніть увагу, що хоча ви звертаєтеся за адресою `http://127.0.0.1:8000/app`, відображається `root_path` `/api/v1`, взятий із опції `--root-path`. + +/// + +А тепер відкрийте URL із портом Traefik, включно з префіксом шляху: http://127.0.0.1:9999/api/v1/app. + +Ми отримуємо ту саму відповідь: + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +але цього разу за URL із префіксом шляху, який надає представник: `/api/v1`. + +Звісно, ідея полягає в тому, що всі мають доступатися до застосунку через представника, тож варіант із префіксом шляху `/api/v1` є «правильним». + +А варіант без префікса шляху (`http://127.0.0.1:8000/app`), який надає безпосередньо Uvicorn, має бути виключно для того, щоб _представник_ (Traefik) звертався до нього. + +Це демонструє, як Представник (Traefik) використовує префікс шляху і як сервер (Uvicorn) використовує `root_path` з опції `--root-path`. + +### Перевірте інтерфейс документації { #check-the-docs-ui } + +А тепер до цікавої частини. ✨ + +«Офіційний» спосіб доступу до застосунку - через представника з префіксом шляху, який ми визначили. Тож, як і очікується, якщо ви спробуєте інтерфейс документації, який обслуговує безпосередньо Uvicorn без префікса шляху в URL, це не запрацює, оскільки він очікує доступу через представника. + +Ви можете перевірити це на http://127.0.0.1:8000/docs: + + + +Але якщо ми звернемося до інтерфейсу документації за «офіційним» URL, використовуючи представника з портом `9999`, за адресою `/api/v1/docs`, усе працює коректно! 🎉 + +Ви можете перевірити це на http://127.0.0.1:9999/api/v1/docs: + + + +Саме так, як ми хотіли. ✔️ + +Це тому, що FastAPI використовує `root_path`, щоб створити типовий `server` в OpenAPI з URL, наданою `root_path`. + +## Додаткові сервери { #additional-servers } + +/// warning | Попередження + +Це більш просунутий випадок використання. Можете пропустити його. + +/// + +За замовчуванням **FastAPI** створить `server` у схемі OpenAPI з URL для `root_path`. + +Але ви також можете надати інші альтернативні `servers`, наприклад, якщо хочете, щоб той самий інтерфейс документації взаємодіяв і зі стейджингом, і з продакшном. + +Якщо ви передасте власний список `servers`, і є `root_path` (тому що ваш API знаходиться за представником), **FastAPI** вставить «server» з цим `root_path` на початок списку. + +Наприклад: + +{* ../../docs_src/behind_a_proxy/tutorial003_py310.py hl[4:7] *} + +Буде згенерована схема OpenAPI на кшталт: + +```JSON hl_lines="5-7" +{ + "openapi": "3.1.0", + // Ще дещо тут + "servers": [ + { + "url": "/api/v1" + }, + { + "url": "https://stag.example.com", + "description": "Staging environment" + }, + { + "url": "https://prod.example.com", + "description": "Production environment" + } + ], + "paths": { + // Ще дещо тут + } +} +``` + +/// tip | Порада + +Зверніть увагу на автоматично згенерований сервер із значенням `url` `/api/v1`, взятим із `root_path`. + +/// + +В інтерфейсі документації за адресою http://127.0.0.1:9999/api/v1/docs це виглядатиме так: + + + +/// tip | Порада + +Інтерфейс документації взаємодіятиме з сервером, який ви оберете. + +/// + +/// note | Технічні деталі + +Властивість `servers` у специфікації OpenAPI є необовʼязковою. + +Якщо ви не вкажете параметр `servers`, і `root_path` дорівнює `/`, властивість `servers` у згенерованій схемі OpenAPI буде повністю пропущено за замовчуванням, що еквівалентно одному серверу зі значенням `url` рівним `/`. + +/// + +### Вимкнути автоматичний сервер із `root_path` { #disable-automatic-server-from-root-path } + +Якщо ви не хочете, щоб **FastAPI** додавав автоматичний сервер, використовуючи `root_path`, скористайтеся параметром `root_path_in_servers=False`: + +{* ../../docs_src/behind_a_proxy/tutorial004_py310.py hl[9] *} + +і тоді він не буде включений у схему OpenAPI. + +## Монтування підзастосунку { #mounting-a-sub-application } + +Якщо вам потрібно змонтувати підзастосунок (як описано в [Підзастосунки - монтування](sub-applications.md){.internal-link target=_blank}), одночасно використовуючи представника з `root_path`, ви можете робити це звичайним чином, як і очікуєте. + +FastAPI внутрішньо розумно використовуватиме `root_path`, тож усе просто працюватиме. ✨ diff --git a/docs/uk/docs/advanced/custom-response.md b/docs/uk/docs/advanced/custom-response.md new file mode 100644 index 0000000000..ebd0ec24a1 --- /dev/null +++ b/docs/uk/docs/advanced/custom-response.md @@ -0,0 +1,312 @@ +# Користувацька відповідь - HTML, стрім, файл, інше { #custom-response-html-stream-file-others } + +Типово **FastAPI** повертатиме відповіді, використовуючи `JSONResponse`. + +Ви можете переписати це, повернувши безпосередньо `Response`, як показано в [Повернути відповідь безпосередньо](response-directly.md){.internal-link target=_blank}. + +Але якщо ви повертаєте `Response` безпосередньо (або будь-який його підклас, як-от `JSONResponse`), дані не будуть автоматично конвертовані (навіть якщо ви оголосите `response_model`), і документація не буде автоматично згенерована (наприклад, із включенням конкретного «медіа-типу» в HTTP-заголовку `Content-Type` як частини згенерованого OpenAPI). + +Ви також можете оголосити `Response`, який слід використовувати (наприклад, будь-який підклас `Response`), у декораторі операції шляху через параметр `response_class`. + +Вміст, який ви повертаєте з вашої функції операції шляху, буде поміщений усередину цього `Response`. + +І якщо цей `Response` має JSON медіа-тип (`application/json`), як у випадку з `JSONResponse` та `UJSONResponse`, дані, що повертаються, будуть автоматично перетворені (і відфільтровані) з урахуванням будь-якого Pydantic `response_model`, який ви оголосили в декораторі операції шляху. + +/// note | Примітка + +Якщо ви використовуєте клас відповіді без медіа-типу, FastAPI очікуватиме, що у вашої відповіді не буде вмісту, тож формат відповіді не буде задокументовано в згенерованих OpenAPI-документах. + +/// + +## Використовуйте `ORJSONResponse` { #use-orjsonresponse } + +Наприклад, якщо ви максимально оптимізуєте продуктивність, можете встановити та використовувати `orjson` і встановити відповідь як `ORJSONResponse`. + +Імпортуйте потрібний клас `Response` (підклас) і оголосіть його в декораторі операції шляху. + +Для великих відповідей повернення `Response` безпосередньо значно швидше, ніж повернення словника. + +Це тому, що за замовчуванням FastAPI перевірятиме кожен елемент усередині та переконуватиметься, що його можна серіалізувати як JSON, використовуючи той самий [Сумісний кодувальник JSON](../tutorial/encoder.md){.internal-link target=_blank}, описаний у навчальному посібнику. Саме це дозволяє повертати довільні об'єкти, наприклад моделі бази даних. + +Але якщо ви впевнені, що вміст, який повертається, серіалізується в JSON, ви можете передати його безпосередньо класу відповіді та уникнути додаткових витрат FastAPI на пропускання вашого вмісту через `jsonable_encoder` перед передаванням його класу відповіді. + +{* ../../docs_src/custom_response/tutorial001b_py310.py hl[2,7] *} + +/// info | Інформація + +Параметр `response_class` також визначатиме «медіа-тип» відповіді. + +У цьому випадку HTTP-заголовок `Content-Type` буде встановлено в `application/json`. + +І це буде задокументовано відповідно в OpenAPI. + +/// + +/// tip | Порада + +`ORJSONResponse` доступний лише у FastAPI, не в Starlette. + +/// + +## HTML-відповідь { #html-response } + +Щоб повернути відповідь із HTML безпосередньо з **FastAPI**, використовуйте `HTMLResponse`. + +- Імпортуйте `HTMLResponse`. +- Передайте `HTMLResponse` як параметр `response_class` вашого декоратора операції шляху. + +{* ../../docs_src/custom_response/tutorial002_py310.py hl[2,7] *} + +/// info | Інформація + +Параметр `response_class` також визначатиме «медіа-тип» відповіді. + +У цьому випадку HTTP-заголовок `Content-Type` буде встановлено в `text/html`. + +І це буде задокументовано відповідно в OpenAPI. + +/// + +### Повернути `Response` { #return-a-response } + +Як показано в [Повернути відповідь безпосередньо](response-directly.md){.internal-link target=_blank}, ви також можете переписати відповідь безпосередньо у вашій операції шляху, просто повернувши її. + +Той самий приклад вище, що повертає `HTMLResponse`, може виглядати так: + +{* ../../docs_src/custom_response/tutorial003_py310.py hl[2,7,19] *} + +/// warning | Попередження + +`Response`, повернений безпосередньо вашою функцією операції шляху, не буде задокументовано в OpenAPI (наприклад, `Content-Type` не буде задокументовано) і не буде видно в автоматичній інтерактивній документації. + +/// + +/// info | Інформація + +Звісно, фактичні заголовок `Content-Type`, код статусу тощо прийдуть з об'єкта `Response`, який ви повернули. + +/// + +### Задокументуйте в OpenAPI і перепишіть `Response` { #document-in-openapi-and-override-response } + +Якщо ви хочете переписати відповідь усередині функції, але водночас задокументувати «медіа-тип» в OpenAPI, ви можете використати параметр `response_class` І повернути об'єкт `Response`. + +Тоді `response_class` буде використано лише для документування операції шляху в OpenAPI, а ваша `Response` буде використана як є. + +#### Повернути `HTMLResponse` безпосередньо { #return-an-htmlresponse-directly } + +Наприклад, це може бути щось на кшталт: + +{* ../../docs_src/custom_response/tutorial004_py310.py hl[7,21,23] *} + +У цьому прикладі функція `generate_html_response()` уже генерує та повертає `Response` замість повернення HTML як `str`. + +Повертаючи результат виклику `generate_html_response()`, ви вже повертаєте `Response`, яка перепише типову поведінку **FastAPI**. + +Але оскільки ви також передали `HTMLResponse` у `response_class`, **FastAPI** знатиме, як задокументувати це в OpenAPI та інтерактивній документації як HTML з `text/html`: + + + +## Доступні відповіді { #available-responses } + +Ось деякі з доступних відповідей. + +Майте на увазі, що ви можете використовувати `Response`, щоб повертати що завгодно інше, або навіть створити власний підклас. + +/// note | Технічні деталі + +Ви також можете використати `from starlette.responses import HTMLResponse`. + +**FastAPI** надає ті ж `starlette.responses` як `fastapi.responses` лише для вашої зручності як розробника. Але більшість доступних відповідей надходять безпосередньо зі Starlette. + +/// + +### `Response` { #response } + +Головний клас `Response`, від якого успадковуються всі інші відповіді. + +Ви можете повертати його безпосередньо. + +Він приймає такі параметри: + +- `content` - `str` або `bytes`. +- `status_code` - `int` - код статусу HTTP. +- `headers` - `dict` строк. +- `media_type` - `str`, що задає медіа-тип, напр. `"text/html"`. + +FastAPI (насправді Starlette) автоматично додасть заголовок Content-Length. Також буде додано заголовок Content-Type, на основі `media_type` з додаванням набору символів для текстових типів. + +{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *} + +### `HTMLResponse` { #htmlresponse } + +Приймає текст або байти та повертає HTML-відповідь, як описано вище. + +### `PlainTextResponse` { #plaintextresponse } + +Приймає текст або байти та повертає відповідь звичайним текстом. + +{* ../../docs_src/custom_response/tutorial005_py310.py hl[2,7,9] *} + +### `JSONResponse` { #jsonresponse } + +Приймає дані та повертає відповідь, закодовану як `application/json`. + +Це типова відповідь, яку використовує **FastAPI**, як зазначено вище. + +### `ORJSONResponse` { #orjsonresponse } + +Швидка альтернативна JSON-відповідь з використанням `orjson`, як описано вище. + +/// info | Інформація + +Потрібно встановити `orjson`, наприклад `pip install orjson`. + +/// + +### `UJSONResponse` { #ujsonresponse } + +Альтернативна JSON-відповідь з використанням `ujson`. + +/// info | Інформація + +Потрібно встановити `ujson`, наприклад `pip install ujson`. + +/// + +/// warning | Попередження + +`ujson` менш обережний, ніж вбудована реалізація Python, у поводженні з деякими крайніми випадками. + +/// + +{* ../../docs_src/custom_response/tutorial001_py310.py hl[2,7] *} + +/// tip | Порада + +Ймовірно, `ORJSONResponse` може бути швидшою альтернативою. + +/// + +### `RedirectResponse` { #redirectresponse } + +Повертає HTTP-перенаправлення. Типово використовує код статусу 307 (Temporary Redirect). + +Ви можете повернути `RedirectResponse` безпосередньо: + +{* ../../docs_src/custom_response/tutorial006_py310.py hl[2,9] *} + +--- + +Або ви можете використати його в параметрі `response_class`: + +{* ../../docs_src/custom_response/tutorial006b_py310.py hl[2,7,9] *} + +У такому разі ви можете повертати URL безпосередньо з вашої функції операції шляху. + +У цьому випадку `status_code` буде типовим для `RedirectResponse`, тобто `307`. + +--- + +Ви також можете використати параметр `status_code` разом із параметром `response_class`: + +{* ../../docs_src/custom_response/tutorial006c_py310.py hl[2,7,9] *} + +### `StreamingResponse` { #streamingresponse } + +Приймає async-генератор або звичайний генератор/ітератор і транслює тіло відповіді потоково. + +{* ../../docs_src/custom_response/tutorial007_py310.py hl[2,14] *} + +#### Використання `StreamingResponse` з об'єктами типу file-like { #using-streamingresponse-with-file-like-objects } + +Якщо у вас є file-like об'єкт (наприклад, об'єкт, що повертається `open()`), ви можете створити генераторну функцію для ітерації по цьому file-like об'єкту. + +Таким чином, вам не потрібно спочатку читати все в пам'ять, і ви можете передати цю генераторну функцію в `StreamingResponse` і повернути її. + +Сюди входить багато бібліотек для взаємодії з хмарними сховищами, обробки відео та інші. + +{* ../../docs_src/custom_response/tutorial008_py310.py hl[2,10:12,14] *} + +1. Це генераторна функція. Вона є «генераторною функцією», бо містить оператори `yield` усередині. +2. Використовуючи блок `with`, ми гарантуємо, що file-like об'єкт буде закрито після завершення роботи генераторної функції. Тобто після того, як вона завершить надсилання відповіді. +3. Цей `yield from` вказує функції ітеруватися по об'єкту з назвою `file_like`. А потім, для кожної ітерованої частини, повертати цю частину, ніби вона надходить з цієї генераторної функції (`iterfile`). + + Тож це генераторна функція, яка всередині передає роботу «генерації» чомусь іншому. + + Роблячи це таким чином, ми можемо помістити її в блок `with` і таким чином гарантувати, що file-like об'єкт буде закрито після завершення. + +/// tip | Порада + +Зверніть увагу, що тут ми використовуємо стандартний `open()`, який не підтримує `async` та `await`, тому ми оголошуємо операцію шляху звичайною `def`. + +/// + +### `FileResponse` { #fileresponse } + +Асинхронно транслює файл як відповідь. + +Приймає інший набір аргументів для створення екземпляра, ніж інші типи відповідей: + +- `path` - шлях до файлу для трансляції. +- `headers` - будь-які користувацькі заголовки як словник. +- `media_type` - строка, що задає медіа-тип. Якщо не встановлено, медіа-тип буде виведено з імені файлу або шляху. +- `filename` - якщо встановлено, буде включено до `Content-Disposition` відповіді. + +Відповіді з файлами включатимуть відповідні заголовки `Content-Length`, `Last-Modified` і `ETag`. + +{* ../../docs_src/custom_response/tutorial009_py310.py hl[2,10] *} + +Ви також можете використати параметр `response_class`: + +{* ../../docs_src/custom_response/tutorial009b_py310.py hl[2,8,10] *} + +У цьому випадку ви можете повертати шлях до файлу безпосередньо з вашої функції операції шляху. + +## Власний клас відповіді { #custom-response-class } + +Ви можете створити власний клас відповіді, успадкувавши його від `Response`, і використовувати його. + +Наприклад, скажімо, ви хочете використовувати `orjson`, але з деякими користувацькими налаштуваннями, які не використовуються у вбудованому класі `ORJSONResponse`. + +Припустімо, ви хочете, щоб повертався відформатований із відступами JSON, тож ви хочете використати опцію orjson `orjson.OPT_INDENT_2`. + +Ви можете створити `CustomORJSONResponse`. Головне, що потрібно зробити, це створити метод `Response.render(content)`, який повертає вміст як `bytes`: + +{* ../../docs_src/custom_response/tutorial009c_py310.py hl[9:14,17] *} + +Тепер замість повернення: + +```json +{"message": "Hello World"} +``` + +...ця відповідь повертатиме: + +```json +{ + "message": "Hello World" +} +``` + +Звісно, ви, ймовірно, знайдете значно кращі способи скористатися цим, ніж просто форматування JSON. 😉 + +## Типова відповідь за замовчуванням { #default-response-class } + +Створюючи екземпляр класу **FastAPI** або `APIRouter`, ви можете вказати, який клас відповіді використовувати за замовчуванням. + +Параметр, що це визначає, - `default_response_class`. + +У прикладі нижче **FastAPI** використовуватиме `ORJSONResponse` за замовчуванням в усіх операціях шляху замість `JSONResponse`. + +{* ../../docs_src/custom_response/tutorial010_py310.py hl[2,4] *} + +/// tip | Порада + +Ви все одно можете переписати `response_class` в операціях шляху, як і раніше. + +/// + +## Додаткова документація { #additional-documentation } + +Ви також можете оголосити медіа-тип і багато інших деталей в OpenAPI, використовуючи `responses`: [Додаткові відповіді в OpenAPI](additional-responses.md){.internal-link target=_blank}. diff --git a/docs/uk/docs/advanced/dataclasses.md b/docs/uk/docs/advanced/dataclasses.md new file mode 100644 index 0000000000..a41e6e5890 --- /dev/null +++ b/docs/uk/docs/advanced/dataclasses.md @@ -0,0 +1,95 @@ +# Використання dataclasses { #using-dataclasses } + +FastAPI побудовано поверх **Pydantic**, і я показував вам, як використовувати моделі Pydantic для оголошення запитів і відповідей. + +Але FastAPI також підтримує використання `dataclasses` таким самим чином: + +{* ../../docs_src/dataclasses_/tutorial001_py310.py hl[1,6:11,18:19] *} + +Це підтримується завдяки **Pydantic**, адже він має внутрішню підтримку `dataclasses`. + +Тож навіть із наведеним вище кодом, який явно не використовує Pydantic, FastAPI використовує Pydantic, щоб перетворити стандартні dataclasses у власний варіант dataclasses Pydantic. + +І, звісно, підтримується те саме: + +* валідація даних +* серіалізація даних +* документація даних тощо + +Це працює так само, як із моделями Pydantic. Насправді під капотом це також досягається за допомогою Pydantic. + +/// info | Інформація + +Майте на увазі, що dataclasses не можуть робити все те, що можуть моделі Pydantic. + +Тож вам усе ще може знадобитися використовувати моделі Pydantic. + +Але якщо у вас вже є чимало dataclasses, це зручний трюк, щоб задіяти їх для веб-API на FastAPI. 🤓 + +/// + +## Dataclasses у `response_model` { #dataclasses-in-response-model } + +Ви також можете використовувати `dataclasses` у параметрі `response_model`: + +{* ../../docs_src/dataclasses_/tutorial002_py310.py hl[1,6:12,18] *} + +Dataclass буде автоматично перетворено на dataclass Pydantic. + +Таким чином його схема з'явиться в інтерфейсі користувача документації API: + + + +## Dataclasses у вкладених структурах даних { #dataclasses-in-nested-data-structures } + +Можна поєднувати `dataclasses` з іншими анотаціями типів, щоб створювати вкладені структури даних. + +У деяких випадках вам усе ж доведеться використовувати варіант `dataclasses` від Pydantic. Наприклад, якщо виникають помилки з автоматично згенерованою документацією API. + +У такому разі ви можете просто замінити стандартні `dataclasses` на `pydantic.dataclasses`, що є взаємозамінником: + +{* ../../docs_src/dataclasses_/tutorial003_py310.py hl[1,4,7:10,13:16,22:24,27] *} + +1. Ми все ще імпортуємо `field` зі стандартних `dataclasses`. + +2. `pydantic.dataclasses` - це взаємозамінник для `dataclasses`. + +3. Dataclass `Author` містить список dataclass `Item`. + +4. Dataclass `Author` використовується як параметр `response_model`. + +5. Ви можете використовувати інші стандартні анотації типів із dataclasses як тіло запиту. + + У цьому випадку це список dataclass `Item`. + +6. Тут ми повертаємо словник, що містить `items`, який є списком dataclass. + + FastAPI усе ще здатний серіалізувати дані до JSON. + +7. Тут у `response_model` використано анотацію типу список dataclass `Author`. + + Знову ж, ви можете поєднувати `dataclasses` зі стандартними анотаціями типів. + +8. Зверніть увагу, що ця *функція операції шляху* використовує звичайний `def` замість `async def`. + + Як завжди, у FastAPI ви можете поєднувати `def` і `async def` за потреби. + + Якщо вам потрібне коротке нагадування, коли що використовувати, перегляньте розділ _«Поспішаєте?»_ у документації про [`async` та `await`](../async.md#in-a-hurry){.internal-link target=_blank}. + +9. Ця *функція операції шляху* не повертає dataclasses (хоча могла б), а список словників із внутрішніми даними. + + FastAPI використає параметр `response_model` (що включає dataclasses), щоб перетворити відповідь. + +Ви можете поєднувати `dataclasses` з іншими анотаціями типів у багатьох поєднаннях, щоб формувати складні структури даних. + +Перегляньте підказки щодо анотацій у коді вище, щоб побачити більше деталей. + +## Дізнатися більше { #learn-more } + +Можна поєднувати `dataclasses` з іншими моделями Pydantic, наслідувати їх, включати у власні моделі тощо. + +Щоб дізнатися більше, перегляньте документацію Pydantic про dataclasses. + +## Версія { #version } + +Доступно починаючи з версії FastAPI `0.67.0`. 🔖 diff --git a/docs/uk/docs/advanced/events.md b/docs/uk/docs/advanced/events.md new file mode 100644 index 0000000000..7c05ee4a4e --- /dev/null +++ b/docs/uk/docs/advanced/events.md @@ -0,0 +1,165 @@ +# Події тривалості життя { #lifespan-events } + +Ви можете визначити логіку (код), яку слід виконати перед тим, як застосунок запуститься. Це означає, що цей код буде виконано один раз, перед тим як застосунок почне отримувати запити. + +Так само ви можете визначити логіку (код), яку слід виконати під час вимкнення застосунку. У цьому випадку код буде виконано один раз, після обробки можливо багатьох запитів. + +Оскільки цей код виконується перед тим, як застосунок почне приймати запити, і одразу після того, як він завершить їх обробку, він охоплює всю тривалість життя застосунку (слово «lifespan» буде важливим за мить 😉). + +Це дуже корисно для налаштування ресурсів, які потрібні для всього застосунку, які спільні між запитами, та/або які потрібно потім прибрати. Наприклад, пул з’єднань з базою даних або завантаження спільної моделі машинного навчання. + +## Випадок використання { #use-case } + +Почнемо з прикладу випадку використання, а потім подивимось, як це вирішити. + +Уявімо, що у вас є моделі машинного навчання, якими ви хочете обробляти запити. 🤖 + +Ті самі моделі спільні між запитами, тобто це не окрема модель на запит чи на користувача. + +Уявімо, що завантаження моделі може займати чимало часу, бо треба читати багато даних з диска. Тож ви не хочете робити це для кожного запиту. + +Ви могли б завантажити її на верхньому рівні модуля/файлу, але це означало б, що модель завантажиться навіть якщо ви просто запускаєте простий автоматизований тест - тоді тест буде повільним, бо йому доведеться чекати завантаження моделі перед виконанням незалежної частини коду. + +Ось це ми й вирішимо: завантажимо модель перед обробкою запитів, але лише безпосередньо перед тим, як застосунок почне отримувати запити, а не під час завантаження коду. + +## Тривалість життя { #lifespan } + +Ви можете визначити цю логіку запуску і вимкнення за допомогою параметра `lifespan` застосунку `FastAPI` та «менеджера контексту» (зараз покажу, що це). + +Почнемо з прикладу, а потім розберемо детально. + +Ми створюємо асинхронну функцію `lifespan()` з `yield` так: + +{* ../../docs_src/events/tutorial003_py310.py hl[16,19] *} + +Тут ми імітуємо дорогу операцію запуску із завантаженням моделі, поміщаючи (фальшиву) функцію моделі у словник з моделями машинного навчання перед `yield`. Цей код буде виконано перед тим, як застосунок почне приймати запити, під час запуску. + +А одразу після `yield` ми розвантажуємо модель. Цей код буде виконано після того, як застосунок завершить обробку запитів, безпосередньо перед вимкненням. Це, наприклад, може звільнити ресурси на кшталт пам’яті або GPU. + +/// tip | Порада + +Подія `shutdown` відбувається, коли ви зупиняєте застосунок. + +Можливо, вам треба запустити нову версію, або ви просто втомилися її запускати. 🤷 + +/// + +### Функція тривалості життя { #lifespan-function } + +Перше, на що слід звернути увагу: ми визначаємо асинхронну функцію з `yield`. Це дуже схоже на залежності з `yield`. + +{* ../../docs_src/events/tutorial003_py310.py hl[14:19] *} + +Перша частина функції до `yield` буде виконана перед запуском застосунку. + +А частина після `yield` буде виконана після завершення роботи застосунку. + +### Асинхронний менеджер контексту { #async-context-manager } + +Якщо придивитися, функція задекорована за допомогою `@asynccontextmanager`. + +Це перетворює функцію на так званий «асинхронний менеджер контексту». + +{* ../../docs_src/events/tutorial003_py310.py hl[1,13] *} + +Менеджер контексту в Python - це те, що можна використовувати в операторі `with`, наприклад, `open()` можна використовувати як менеджер контексту: + +```Python +with open("file.txt") as file: + file.read() +``` + +У новіших версіях Python також є асинхронний менеджер контексту. Його використовують з `async with`: + +```Python +async with lifespan(app): + await do_stuff() +``` + +Коли ви створюєте менеджер контексту або асинхронний менеджер контексту, як вище, перед входом у блок `with` буде виконано код перед `yield`, а після виходу з блоку `with` буде виконано код після `yield`. + +У нашому прикладі коду вище ми не використовуємо його напряму, а передаємо його до FastAPI, щоб він його використав. + +Параметр `lifespan` застосунку `FastAPI` приймає асинхронний менеджер контексту, тож ми можемо передати йому наш новий асинхронний менеджер контексту `lifespan`. + +{* ../../docs_src/events/tutorial003_py310.py hl[22] *} + +## Альтернативні події (застаріло) { #alternative-events-deprecated } + +/// warning | Попередження + +Рекомендований спосіб обробляти запуск і вимкнення - використовувати параметр `lifespan` застосунку `FastAPI`, як описано вище. Якщо ви надаєте параметр `lifespan`, обробники подій `startup` і `shutdown` більше не будуть викликані. Або все через `lifespan`, або все через події - не обидва одночасно. + +Можете, ймовірно, пропустити цю частину. + +/// + +Є альтернативний спосіб визначити логіку, яку слід виконати під час запуску і під час вимкнення. + +Ви можете визначити обробники подій (функції), які потрібно виконати перед запуском застосунку або коли застосунок вимикається. + +Ці функції можна оголошувати як з `async def`, так і звичайним `def`. + +### Подія `startup` { #startup-event } + +Щоб додати функцію, яку слід виконати перед запуском застосунку, оголосіть її з подією `"startup"`: + +{* ../../docs_src/events/tutorial001_py310.py hl[8] *} + +У цьому випадку функція-обробник події `startup` ініціалізує «базу даних» предметів (це лише `dict`) деякими значеннями. + +Ви можете додати більше ніж один обробник події. + +І ваш застосунок не почне приймати запити, доки всі обробники події `startup` не завершаться. + +### Подія `shutdown` { #shutdown-event } + +Щоб додати функцію, яку слід виконати, коли застосунок вимикається, оголосіть її з подією `"shutdown"`: + +{* ../../docs_src/events/tutorial002_py310.py hl[6] *} + +Тут функція-обробник події `shutdown` запише текстовий рядок `"Application shutdown"` у файл `log.txt`. + +/// info | Інформація + +У функції `open()` параметр `mode="a"` означає «append», тож рядок буде додано після всього, що є у файлі, без перезапису попереднього вмісту. + +/// + +/// tip | Порада + +Зауважте, що в цьому випадку ми використовуємо стандартну Python-функцію `open()`, яка працює з файлом. + +Тобто вона включає I/O (input/output), де потрібно «чекати», поки дані буде записано на диск. + +Але `open()` не використовує `async` і `await`. + +Тому ми оголошуємо функцію-обробник події зі стандартним `def`, а не `async def`. + +/// + +### Разом `startup` і `shutdown` { #startup-and-shutdown-together } + +Велика ймовірність, що логіка для вашого запуску і вимкнення пов’язана: ви можете хотіти щось запустити, а потім завершити, отримати ресурс, а потім звільнити його тощо. + +Робити це в окремих функціях, які не діляться логікою чи змінними, складніше - доведеться зберігати значення у глобальних змінних або вдаватися до подібних трюків. + +Тому зараз рекомендується натомість використовувати `lifespan`, як пояснено вище. + +## Технічні деталі { #technical-details } + +Невелика технічна деталь для допитливих нердів. 🤓 + +Під капотом, у технічній специфікації ASGI, це частина Протоколу тривалості життя, і там визначені події `startup` і `shutdown`. + +/// info | Інформація + +Ви можете прочитати більше про обробники `lifespan` у документації Starlette про Lifespan. + +Зокрема, як працювати зі станом тривалості життя, який можна використовувати в інших ділянках вашого коду. + +/// + +## Підзастосунки { #sub-applications } + +🚨 Майте на увазі, що ці події тривалості життя (startup і shutdown) виконуються лише для головного застосунку, а не для [Підзастосунки - монтування](sub-applications.md){.internal-link target=_blank}. diff --git a/docs/uk/docs/advanced/generate-clients.md b/docs/uk/docs/advanced/generate-clients.md new file mode 100644 index 0000000000..66e9193ac3 --- /dev/null +++ b/docs/uk/docs/advanced/generate-clients.md @@ -0,0 +1,208 @@ +# Генерація SDK { #generating-sdks } + +Оскільки **FastAPI** базується на специфікації **OpenAPI**, його API можна описати у стандартному форматі, який розуміють багато інструментів. + +Це спрощує створення актуальної **документації**, клієнтських бібліотек (**SDKs**) багатьма мовами, а також **тестування** чи **автоматизованих робочих процесів**, що залишаються синхронізованими з вашим кодом. + +У цьому посібнику ви дізнаєтеся, як згенерувати **TypeScript SDK** для вашого бекенда на FastAPI. + +## Генератори SDK з відкритим кодом { #open-source-sdk-generators } + +Універсальним варіантом є OpenAPI Generator, який підтримує **багато мов програмування** та може генерувати SDK з вашої специфікації OpenAPI. + +Для **клієнтів TypeScript** Hey API — спеціалізоване рішення, що надає оптимізований досвід для екосистеми TypeScript. + +Більше генераторів SDK ви можете знайти на OpenAPI.Tools. + +/// tip | Порада + +FastAPI автоматично генерує специфікації **OpenAPI 3.1**, тож будь-який інструмент, який ви використовуєте, має підтримувати цю версію. + +/// + +## Генератори SDK від спонсорів FastAPI { #sdk-generators-from-fastapi-sponsors } + +У цьому розділі представлено рішення від компаній, що спонсорують FastAPI: вони мають **венчурну підтримку** та **корпоративну підтримку**. Ці продукти надають **додаткові можливості** та **інтеграції** поверх високоякісно згенерованих SDK. + +Завдяки ✨ [**спонсорству FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨ ці компанії допомагають підтримувати фреймворк та його **екосистему** здоровими та **сталими**. + +Їхня підтримка також демонструє сильну відданість **спільноті** FastAPI (вам), показуючи, що їм важливо не лише надавати **відмінний сервіс**, а й підтримувати **міцний і процвітаючий фреймворк**, FastAPI. 🙇 + +Наприклад, ви можете спробувати: + +* Speakeasy +* Stainless +* liblab + +Деякі з цих рішень також можуть бути з відкритим кодом або мати безкоштовні тарифи, тож ви можете спробувати їх без фінансових зобов'язань. Інші комерційні генератори SDK також доступні й їх можна знайти онлайн. 🤓 + +## Створити TypeScript SDK { #create-a-typescript-sdk } + +Почнімо з простого застосунку FastAPI: + +{* ../../docs_src/generate_clients/tutorial001_py310.py hl[7:9,12:13,16:17,21] *} + +Зверніть увагу, що *операції шляху* визначають моделі, які вони використовують для корисного навантаження запиту та корисного навантаження відповіді, використовуючи моделі `Item` і `ResponseMessage`. + +### Документація API { #api-docs } + +Якщо ви перейдете до `/docs`, ви побачите **схеми** даних, які надсилаються в запитах і приймаються у відповідях: + + + +Ви бачите ці схеми, оскільки їх було оголошено як моделі в застосунку. + +Ця інформація доступна у **схемі OpenAPI** застосунку, а потім показується в документації API. + +Та сама інформація з моделей, яку включено до OpenAPI, може бути використана для **генерації клієнтського коду**. + +### Hey API { #hey-api } + +Коли у нас є застосунок FastAPI з моделями, ми можемо використати Hey API для генерації клієнта TypeScript. Найшвидший спосіб зробити це — через npx. + +```sh +npx @hey-api/openapi-ts -i http://localhost:8000/openapi.json -o src/client +``` + +Це згенерує TypeScript SDK у `./src/client`. + +Ви можете дізнатися, як встановити `@hey-api/openapi-ts`, і почитати про згенерований результат на їхньому сайті. + +### Використання SDK { #using-the-sdk } + +Тепер ви можете імпортувати та використовувати клієнтський код. Це може виглядати так; зверніть увагу, що ви отримуєте «автодоповнення» для методів: + + + +Ви також отримаєте автодоповнення для корисного навантаження, яке надсилаєте: + + + +/// tip | Порада + +Зверніть увагу на автодоповнення для `name` і `price`, які були визначені в застосунку FastAPI, у моделі `Item`. + +/// + +Ви бачитимете вбудовані помилки для даних, які надсилаєте: + + + +Об'єкт відповіді також матиме автодоповнення: + + + +## Застосунок FastAPI з мітками { #fastapi-app-with-tags } + +У багатьох випадках ваш застосунок FastAPI буде більшим, і ви, ймовірно, використовуватимете мітки, щоб розділяти різні групи *операцій шляху*. + +Наприклад, у вас може бути секція для **items** і окрема секція для **users**, і їх можна розділити мітками: + +{* ../../docs_src/generate_clients/tutorial002_py310.py hl[21,26,34] *} + +### Згенерувати TypeScript-клієнт із мітками { #generate-a-typescript-client-with-tags } + +Якщо ви згенеруєте клієнт для застосунку FastAPI, що використовує мітки, зазвичай клієнтський код також буде розділено за цими мітками. + +Таким чином, ви матимете правильно впорядковані та згруповані частини клієнтського коду: + + + +У цьому випадку у вас є: + +* `ItemsService` +* `UsersService` + +### Назви методів клієнта { #client-method-names } + +Зараз згенеровані назви методів на кшталт `createItemItemsPost` виглядають не дуже охайно: + +```TypeScript +ItemsService.createItemItemsPost({name: "Plumbus", price: 5}) +``` + +...це тому, що генератор клієнта використовує внутрішній OpenAPI **operation ID** для кожної *операції шляху*. + +OpenAPI вимагає, щоб кожен operation ID був унікальним для всіх *операцій шляху*, тому FastAPI використовує **назву функції**, **шлях** і **HTTP-метод/операцію** для генерації цього operation ID, адже так воно може гарантувати унікальність operation ID. + +Але далі я покажу, як це покращити. 🤓 + +## Користувацькі operation ID та кращі назви методів { #custom-operation-ids-and-better-method-names } + +Ви можете **змінити** спосіб **генерації** цих operation ID, щоб зробити їх простішими та мати **простіші назви методів** у клієнтах. + +У цьому випадку вам потрібно буде іншим способом гарантувати, що кожен operation ID є **унікальним**. + +Наприклад, ви можете переконатися, що кожна *операція шляху* має мітку, а потім генерувати operation ID на основі **мітки** та **назви** *операції шляху* (назви функції). + +### Користувацька функція генерування унікального ID { #custom-generate-unique-id-function } + +FastAPI використовує **унікальний ID** для кожної *операції шляху*, який застосовується для **operation ID**, а також для назв будь-яких потрібних користувацьких моделей для запитів чи відповідей. + +Ви можете налаштувати цю функцію. Вона приймає `APIRoute` і повертає строку. + +Наприклад, тут використовується перша мітка (у вас, ймовірно, буде лише одна мітка) і назва *операції шляху* (назва функції). + +Потім ви можете передати цю користувацьку функцію до **FastAPI** як параметр `generate_unique_id_function`: + +{* ../../docs_src/generate_clients/tutorial003_py310.py hl[6:7,10] *} + +### Згенерувати TypeScript-клієнт з користувацькими operation ID { #generate-a-typescript-client-with-custom-operation-ids } + +Тепер, якщо ви згенеруєте клієнт знову, ви побачите покращені назви методів: + + + +Як бачите, тепер у назвах методів є мітка, а потім назва функції; вони більше не містять інформації з URL-шляху та HTTP-операції. + +### Попередня обробка специфікації OpenAPI для генератора клієнта { #preprocess-the-openapi-specification-for-the-client-generator } + +У згенерованому коді все ще є певна **дубльована інформація**. + +Ми вже знаємо, що цей метод стосується **items**, адже це слово є в `ItemsService` (взято з мітки), але все ще маємо назву мітки як префікс у назві методу. 😕 + +Ми, ймовірно, все одно захочемо зберегти це загалом для OpenAPI, адже так гарантується унікальність operation ID. + +Але для згенерованого клієнта ми можемо **змінити** operation ID в OpenAPI безпосередньо перед генерацією клієнтів, просто щоб зробити назви методів приємнішими та **чистішими**. + +Ми можемо завантажити JSON OpenAPI у файл `openapi.json`, а потім **прибрати цей префікс із міткою** за допомогою такого скрипту: + +{* ../../docs_src/generate_clients/tutorial004_py310.py *} + +//// tab | Node.js + +```Javascript +{!> ../../docs_src/generate_clients/tutorial004.js!} +``` + +//// + +Після цього operation ID буде перейменовано з чогось на кшталт `items-get_items` просто на `get_items`, тож генератор клієнта зможе створити простіші назви методів. + +### Згенерувати TypeScript-клієнт із попередньо обробленим OpenAPI { #generate-a-typescript-client-with-the-preprocessed-openapi } + +Оскільки кінцевий результат тепер у файлі `openapi.json`, вам потрібно оновити шлях до вхідних даних: + +```sh +npx @hey-api/openapi-ts -i ./openapi.json -o src/client +``` + +Після генерації нового клієнта ви отримаєте **чисті назви методів**, із усім **автодоповненням**, **вбудованими помилками** тощо: + + + +## Переваги { #benefits } + +Використовуючи автоматично згенеровані клієнти, ви отримаєте **автодоповнення** для: + +* Методів. +* Корисного навантаження запиту в тілі, параметрах запиту тощо. +* Корисного навантаження відповіді. + +Також ви матимете **вбудовані помилки** для всього. + +І щоразу, коли ви оновлюєте код бекенда та **перегенеровуєте** фронтенд, у ньому з'являтимуться нові *операції шляху* як методи, старі буде видалено, а будь-які інші зміни відобразяться у згенерованому коді. 🤓 + +Це також означає, що якщо щось змінилося, це буде **відображено** в клієнтському коді автоматично. А якщо ви **зіберете** клієнт, буде повідомлено про помилку, якщо є будь-яка **невідповідність** у використаних даних. + +Таким чином, ви **виявлятимете багато помилок** дуже рано в циклі розробки, замість того, щоб чекати, поки помилки проявляться у ваших кінцевих користувачів у продакшені, і лише потім намагатися з'ясувати, у чому проблема. ✨ diff --git a/docs/uk/docs/advanced/index.md b/docs/uk/docs/advanced/index.md new file mode 100644 index 0000000000..1cffe0cecd --- /dev/null +++ b/docs/uk/docs/advanced/index.md @@ -0,0 +1,21 @@ +# Просунутий посібник користувача { #advanced-user-guide } + +## Додаткові можливості { #additional-features } + +Основний [Навчальний посібник - Посібник користувача](../tutorial/index.md){.internal-link target=_blank} має бути достатнім, щоб провести вас через усі основні можливості **FastAPI**. + +У наступних розділах ви побачите інші опції, конфігурації та додаткові можливості. + +/// tip | Порада + +Наступні розділи не обов'язково «просунуті». + +І можливо, що рішення для вашого випадку використання може бути в одному з них. + +/// + +## Спершу прочитайте навчальний посібник { #read-the-tutorial-first } + +Ви все ще можете використовувати більшість можливостей **FastAPI**, маючи знання з основного [Навчального посібника - Посібника користувача](../tutorial/index.md){.internal-link target=_blank}. + +А в наступних розділах передбачається, що ви вже його прочитали і знайомі з основними ідеями. diff --git a/docs/uk/docs/advanced/middleware.md b/docs/uk/docs/advanced/middleware.md new file mode 100644 index 0000000000..207ca96e0a --- /dev/null +++ b/docs/uk/docs/advanced/middleware.md @@ -0,0 +1,97 @@ +# Просунуте проміжне програмне забезпечення { #advanced-middleware } + +У головному навчальному посібнику ви читали, як додати [Користувацьке проміжне ПЗ](../tutorial/middleware.md){.internal-link target=_blank} до вашого застосунку. + +Також ви читали, як обробляти [CORS за допомогою `CORSMiddleware`](../tutorial/cors.md){.internal-link target=_blank}. + +У цьому розділі розглянемо, як використовувати інше проміжне ПЗ. + +## Додавання middleware ASGI { #adding-asgi-middlewares } + +Оскільки **FastAPI** базується на Starlette і реалізує специфікацію ASGI, ви можете використовувати будь-яке проміжне ПЗ ASGI. + +Middleware не обов'язково має бути створене саме для FastAPI або Starlette, головне - щоб воно відповідало специфікації ASGI. + +Загалом, middleware ASGI — це класи, які очікують отримати застосунок ASGI як перший аргумент. + +Тож у документації до сторонніх middleware ASGI вам, імовірно, порадять зробити приблизно так: + +```Python +from unicorn import UnicornMiddleware + +app = SomeASGIApp() + +new_app = UnicornMiddleware(app, some_config="rainbow") +``` + +Але FastAPI (точніше Starlette) надає простіший спосіб, який гарантує, що внутрішнє middleware обробляє помилки сервера, а користувацькі обробники винятків працюють коректно. + +Для цього використовуйте `app.add_middleware()` (як у прикладі для CORS). + +```Python +from fastapi import FastAPI +from unicorn import UnicornMiddleware + +app = FastAPI() + +app.add_middleware(UnicornMiddleware, some_config="rainbow") +``` + +`app.add_middleware()` приймає клас middleware як перший аргумент і будь-які додаткові аргументи, що будуть передані цьому middleware. + +## Вбудоване middleware { #integrated-middlewares } + +**FastAPI** містить кілька middleware для поширених випадків використання, далі розглянемо, як їх використовувати. + +/// note | Технічні деталі + +У наступних прикладах ви також можете використовувати `from starlette.middleware.something import SomethingMiddleware`. + +**FastAPI** надає кілька middleware у `fastapi.middleware` виключно для зручності розробника. Але більшість доступних middleware походять безпосередньо зі Starlette. + +/// + +## `HTTPSRedirectMiddleware` { #httpsredirectmiddleware } + +Примушує, щоб усі вхідні запити були або `https`, або `wss`. + +Будь-який вхідний запит до `http` або `ws` буде перенаправлено на захищену схему. + +{* ../../docs_src/advanced_middleware/tutorial001_py310.py hl[2,6] *} + +## `TrustedHostMiddleware` { #trustedhostmiddleware } + +Примушує, щоб усі вхідні запити мали коректно встановлений заголовок `Host`, щоб захиститися від атак HTTP Host Header. + +{* ../../docs_src/advanced_middleware/tutorial002_py310.py hl[2,6:8] *} + +Підтримуються такі аргументи: + +- `allowed_hosts` - Список доменних імен, які слід дозволити як імена хостів. Підтримуються домени з «дикою картою», такі як `*.example.com`, для зіставлення піддоменів. Щоб дозволити будь-яке ім'я хоста, або використовуйте `allowed_hosts=["*"]`, або не додавайте це middleware. +- `www_redirect` - Якщо встановлено True, запити до не-www версій дозволених хостів буде перенаправлено до їхніх www-варіантів. Типово `True`. + +Якщо вхідний запит не проходить перевірку, буде надіслано відповідь `400`. + +## `GZipMiddleware` { #gzipmiddleware } + +Обробляє відповіді GZip для будь-якого запиту, що містить `"gzip"` у заголовку `Accept-Encoding`. + +Middleware обробляє як стандартні, так і потокові відповіді. + +{* ../../docs_src/advanced_middleware/tutorial003_py310.py hl[2,6] *} + +Підтримуються такі аргументи: + +- `minimum_size` - Не GZip-увати відповіді, менші за цей мінімальний розмір у байтах. Типово `500`. +- `compresslevel` - Використовується під час стиснення GZip. Це ціле число в діапазоні від 1 до 9. Типово `9`. Менше значення дає швидше стиснення, але більший розмір файлів; більше значення дає повільніше стиснення, але менший розмір файлів. + +## Інше middleware { #other-middlewares } + +Є багато іншого проміжного ПЗ ASGI. + +Наприклад: + +- `ProxyHeadersMiddleware` з Uvicorn +- MessagePack + +Щоб переглянути інші доступні middleware, ознайомтеся з документацією Starlette щодо middleware та списком ASGI Awesome. diff --git a/docs/uk/docs/advanced/openapi-callbacks.md b/docs/uk/docs/advanced/openapi-callbacks.md new file mode 100644 index 0000000000..1f2adb1fc0 --- /dev/null +++ b/docs/uk/docs/advanced/openapi-callbacks.md @@ -0,0 +1,186 @@ +# Зворотні виклики OpenAPI { #openapi-callbacks } + +Ви можете створити API з операцією шляху, яка ініціюватиме запит до зовнішнього API, створеного кимось іншим (ймовірно тим самим розробником, який буде використовувати ваш API). + +Процес, що відбувається, коли ваш застосунок API викликає зовнішній API, називається «зворотний виклик». Тому що програмне забезпечення, написане зовнішнім розробником, надсилає запит до вашого API, а потім ваш API виконує зворотний виклик, надсилаючи запит до зовнішнього API (його, ймовірно, також створив той самий розробник). + +У такому випадку вам може знадобитися задокументувати, яким має бути той зовнішній API: які операції шляху він має мати, яке тіло очікувати, яку відповідь повертати тощо. + +## Застосунок зі зворотними викликами { #an-app-with-callbacks } + +Розгляньмо це на прикладі. + +Уявімо, що ви розробляєте застосунок для створення рахунків. + +Ці рахунки матимуть `id`, `title` (необов'язково), `customer` і `total`. + +Користувач вашого API (зовнішній розробник) створить рахунок у вашому API за допомогою POST-запиту. + +Потім ваш API буде (уявімо): + +- Надсилати рахунок деякому клієнту зовнішнього розробника. +- Отримувати оплату. +- Надсилати сповіщення назад користувачу API (зовнішньому розробнику). + - Це буде зроблено шляхом надсилання POST-запиту (з вашого API) до деякого зовнішнього API, наданого тим зовнішнім розробником (це і є «зворотний виклик»). + +## Звичайний застосунок FastAPI { #the-normal-fastapi-app } + +Спочатку подивімося, як виглядав би звичайний застосунок API до додавання зворотного виклику. + +Він матиме операцію шляху, яка отримуватиме тіло `Invoice`, і параметр запиту `callback_url`, що міститиме URL для зворотного виклику. + +Ця частина цілком звична, більшість коду вам, ймовірно, уже знайома: + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[7:11,34:51] *} + +/// tip | Порада + +Параметр запиту `callback_url` використовує тип Pydantic Url. + +/// + +Єдина нова річ - це `callbacks=invoices_callback_router.routes` як аргумент декоратора операції шляху. Далі розглянемо, що це таке. + +## Документування зворотного виклику { #documenting-the-callback } + +Фактичний код зворотного виклику сильно залежатиме від вашого застосунку API. + +І, ймовірно, сильно відрізнятиметься від застосунку до застосунку. + +Це можуть бути лише один-два рядки коду, наприклад: + +```Python +callback_url = "https://example.com/api/v1/invoices/events/" +httpx.post(callback_url, json={"description": "Invoice paid", "paid": True}) +``` + +Але, можливо, найважливіша частина зворотного виклику - переконатися, що користувач вашого API (зовнішній розробник) правильно реалізує зовнішній API відповідно до даних, які ваш API надсилатиме в тілі запиту зворотного виклику тощо. + +Тому далі ми додамо код, щоб задокументувати, яким має бути цей зовнішній API, щоб приймати зворотний виклик від вашого API. + +Ця документація з'явиться в Swagger UI за адресою `/docs` у вашому API і дасть змогу зовнішнім розробникам зрозуміти, як створити зовнішній API. + +У цьому прикладі сам зворотний виклик не реалізовано (це може бути лише один рядок коду), лише частину з документацією. + +/// tip | Порада + +Фактичний зворотний виклик - це просто HTTP-запит. + +Реалізуючи зворотний виклик самостійно, ви можете скористатися, наприклад, HTTPX або Requests. + +/// + +## Напишіть код документації для зворотного виклику { #write-the-callback-documentation-code } + +Цей код не виконуватиметься у вашому застосунку, він потрібен лише, щоб задокументувати, яким має бути зовнішній API. + +Але ви вже знаєте, як легко створювати автоматичну документацію для API за допомогою FastAPI. + +Тож ми скористаємося цими знаннями, щоб задокументувати, яким має бути зовнішній API... створивши операції шляху, які має реалізувати зовнішній API (ті, які викликатиме ваш API). + +/// tip | Порада + +Пишучи код для документування зворотного виклику, корисно уявити, що ви - той *зовнішній розробник*. І що ви зараз реалізуєте *зовнішній API*, а не *ваш API*. + +Тимчасово прийнявши цю точку зору ( *зовнішнього розробника* ), вам буде очевидніше, куди помістити параметри, яку Pydantic-модель використати для тіла, для відповіді тощо для того *зовнішнього API*. + +/// + +### Створіть callback `APIRouter` { #create-a-callback-apirouter } + +Спочатку створіть новий `APIRouter`, який міститиме один або кілька зворотних викликів. + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[1,23] *} + +### Створіть операцію шляху зворотного виклику { #create-the-callback-path-operation } + +Щоб створити операцію шляху зворотного виклику, використайте той самий `APIRouter`, який ви створили вище. + +Вона має виглядати як звичайна операція шляху FastAPI: + +- Ймовірно має містити оголошення тіла, яке вона приймає, напр. `body: InvoiceEvent`. +- І також може містити оголошення відповіді, яку вона повертає, напр. `response_model=InvoiceEventReceived`. + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[14:16,19:20,26:30] *} + +Є 2 основні відмінності від звичайної операції шляху: + +- Їй не потрібен реальний код, адже ваш застосунок ніколи не викликатиме цей код. Вона використовується лише для документування зовнішнього API. Тому функція може просто містити `pass`. +- Шлях може містити вираз OpenAPI 3 (див. нижче), де можна використовувати змінні з параметрами та частини оригінального запиту, надісланого до вашого API. + +### Вираз шляху зворотного виклику { #the-callback-path-expression } + +Шлях зворотного виклику може містити вираз OpenAPI 3, який включає частини оригінального запиту, надісланого до вашого API. + +У цьому випадку це строка: + +```Python +"{$callback_url}/invoices/{$request.body.id}" +``` + +Отже, якщо користувач вашого API (зовнішній розробник) надішле запит до *вашого API* на: + +``` +https://yourapi.com/invoices/?callback_url=https://www.external.org/events +``` + +з JSON-тілом: + +```JSON +{ + "id": "2expen51ve", + "customer": "Mr. Richie Rich", + "total": "9999" +} +``` + +тоді *ваш API* опрацює рахунок і згодом надішле запит зворотного виклику на `callback_url` ( *зовнішній API* ): + +``` +https://www.external.org/events/invoices/2expen51ve +``` + +з JSON-тілом на кшталт: + +```JSON +{ + "description": "Payment celebration", + "paid": true +} +``` + +і очікуватиме відповідь від того *зовнішнього API* з JSON-тілом на кшталт: + +```JSON +{ + "ok": true +} +``` + +/// tip | Порада + +Зверніть увагу, що використаний URL зворотного виклику містить URL, отриманий як параметр запиту в `callback_url` (`https://www.external.org/events`), а також `id` рахунку зсередини JSON-тіла (`2expen51ve`). + +/// + +### Додайте маршрутизатор зворотного виклику { #add-the-callback-router } + +На цьому етапі ви маєте потрібні операції шляху зворотного виклику (ті, які має реалізувати *зовнішній розробник* у *зовнішньому API*) у створеному вище маршрутизаторі зворотного виклику. + +Тепер використайте параметр `callbacks` у декораторі операції шляху вашого API, щоб передати атрибут `.routes` (це насправді просто `list` маршрутів/операцій шляху) з цього маршрутизатора зворотного виклику: + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[33] *} + +/// tip | Порада + +Зверніть увагу, що ви передаєте не сам маршрутизатор (`invoices_callback_router`) у `callback=`, а атрибут `.routes`, тобто `invoices_callback_router.routes`. + +/// + +### Перевірте документацію { #check-the-docs } + +Тепер ви можете запустити застосунок і перейти за адресою http://127.0.0.1:8000/docs. + +Ви побачите вашу документацію з розділом «Callbacks» для вашої операції шляху, який показує, як має виглядати зовнішній API: + + diff --git a/docs/uk/docs/advanced/openapi-webhooks.md b/docs/uk/docs/advanced/openapi-webhooks.md new file mode 100644 index 0000000000..0d8a7f4c5f --- /dev/null +++ b/docs/uk/docs/advanced/openapi-webhooks.md @@ -0,0 +1,55 @@ +# Вебхуки OpenAPI { #openapi-webhooks } + +Бувають випадки, коли ви хочете повідомити **користувачів** вашого API, що ваш застосунок може викликати *їхній* застосунок (надсилаючи запит) із деякими даними, зазвичай щоб **сповістити** про певний тип **події**. + +Це означає, що замість звичного процесу, коли ваші користувачі надсилають запити до вашого API, саме **ваш API** (або ваш застосунок) може **надсилати запити до їхньої системи** (до їх API, їх застосунку). + +Зазвичай це називають **вебхуком**. + +## Кроки вебхуків { #webhooks-steps } + +Зазвичай процес такий: ви визначаєте у своєму коді, яке повідомлення надсилатимете, тобто **тіло запиту**. + +Ви також якимось чином визначаєте моменти, коли ваш застосунок надсилатиме ці запити або події. + +А **ваші користувачі** якимось чином (наприклад, у веб-дашборді) визначають **URL**, куди ваш застосунок має надсилати ці запити. + +Уся **логіка** щодо реєстрації URL для вебхуків і код для фактичного надсилання цих запитів - на ваш розсуд. Ви пишете це у **власному коді** так, як вважаєте за потрібне. + +## Документування вебхуків у **FastAPI** та OpenAPI { #documenting-webhooks-with-fastapi-and-openapi } + +У **FastAPI**, використовуючи OpenAPI, ви можете визначити назви цих вебхуків, типи HTTP-операцій, які ваш застосунок може надсилати (наприклад, `POST`, `PUT` тощо), і **тіла** запитів, які ваш застосунок надсилатиме. + +Це значно спростить для ваших користувачів **реалізацію їхніх API** для отримання ваших запитів **вебхуків**; вони навіть зможуть згенерувати частину власного коду API автоматично. + +/// info | Інформація + +Вебхуки доступні в OpenAPI 3.1.0 і вище, підтримуються FastAPI `0.99.0` і вище. + +/// + +## Застосунок із вебхуками { #an-app-with-webhooks } + +Коли ви створюєте застосунок **FastAPI**, є атрибут `webhooks`, який можна використати для визначення *вебхуків* так само, як ви визначаєте *операції шляху*, наприклад за допомогою `@app.webhooks.post()`. + +{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *} + +Визначені вами вебхуки потраплять до **схеми OpenAPI** та автоматичного **інтерфейсу документації**. + +/// info | Інформація + +Об'єкт `app.webhooks` насправді є просто `APIRouter` - тим самим типом, який ви використовуєте, структуризуючи застосунок у кількох файлах. + +/// + +Зверніть увагу, що з вебхуками ви фактично не оголошуєте *шлях* (на кшталт `/items/`), текст, який ви передаєте там, - це лише **ідентифікатор** вебхука (назва події). Наприклад, у `@app.webhooks.post("new-subscription")` назва вебхука - `new-subscription`. + +Це тому, що очікується, що **ваші користувачі** іншим способом (наприклад, у веб-дашборді) визначать фактичний **URL-шлях**, де вони хочуть отримувати запит вебхука. + +### Перевірте документацію { #check-the-docs } + +Тепер ви можете запустити свій застосунок і перейти за адресою http://127.0.0.1:8000/docs. + +Ви побачите у своїй документації звичайні *операції шляху*, а також деякі **вебхуки**: + + diff --git a/docs/uk/docs/advanced/path-operation-advanced-configuration.md b/docs/uk/docs/advanced/path-operation-advanced-configuration.md new file mode 100644 index 0000000000..202f9317ed --- /dev/null +++ b/docs/uk/docs/advanced/path-operation-advanced-configuration.md @@ -0,0 +1,172 @@ +# Додаткова конфігурація операцій шляху { #path-operation-advanced-configuration } + +## OpenAPI operationId { #openapi-operationid } + +/// warning | Попередження + +Якщо ви не «експерт» з OpenAPI, імовірно, вам це не потрібно. + +/// + +Ви можете встановити OpenAPI `operationId`, який буде використано у вашій *операції шляху*, за допомогою параметра `operation_id`. + +Потрібно переконатися, що він унікальний для кожної операції. + +{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py310.py hl[6] *} + +### Використання назви *функції операції шляху* як operationId { #using-the-path-operation-function-name-as-the-operationid } + +Якщо ви хочете використовувати назви функцій ваших API як `operationId`, ви можете пройтися по всіх них і переписати `operation_id` кожної *операції шляху*, використовуючи їхній `APIRoute.name`. + +Зробіть це після додавання всіх *операцій шляху*. + +{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py310.py hl[2, 12:21, 24] *} + +/// tip | Порада + +Якщо ви вручну викликаєте `app.openapi()`, оновіть значення `operationId` до цього. + +/// + +/// warning | Попередження + +Якщо ви робите це, переконайтеся, що кожна з ваших *функцій операцій шляху* має унікальну назву. + +Навіть якщо вони в різних модулях (файлах Python). + +/// + +## Виключення з OpenAPI { #exclude-from-openapi } + +Щоб виключити *операцію шляху* зі згенерованої Схеми OpenAPI (а отже, і з автоматичних систем документації), використайте параметр `include_in_schema` і встановіть його в `False`: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *} + +## Розширений опис із docstring { #advanced-description-from-docstring } + +Ви можете обмежити кількість рядків із docstring *функції операції шляху*, що використовуються для OpenAPI. + +Додавання `\f` (екранованого символу «form feed») змусить **FastAPI** обрізати вивід для OpenAPI в цій точці. + +Це не з’явиться в документації, але інші інструменти (такі як Sphinx) зможуть використати решту. + +{* ../../docs_src/path_operation_advanced_configuration/tutorial004_py310.py hl[17:27] *} + +## Додаткові відповіді { #additional-responses } + +Ймовірно, ви вже бачили, як оголошувати `response_model` і `status_code` для *операції шляху*. + +Це визначає метадані про основну відповідь *операції шляху*. + +Також можна оголосити додаткові відповіді з їхніми моделями, кодами статусу тощо. + +У документації є цілий розділ про це, ви можете прочитати його тут: [Додаткові відповіді в OpenAPI](additional-responses.md){.internal-link target=_blank}. + +## Додатково в OpenAPI { #openapi-extra } + +Коли ви оголошуєте *операцію шляху* у своєму застосунку, **FastAPI** автоматично генерує відповідні метадані про цю *операцію шляху* для включення в Схему OpenAPI. + +/// note | Технічні деталі + +У специфікації OpenAPI це називається Об'єкт Operation. + +/// + +Він містить усю інформацію про *операцію шляху* і використовується для побудови автоматичної документації. + +Він включає `tags`, `parameters`, `requestBody`, `responses` тощо. + +Цю OpenAPI-схему, специфічну для *операції шляху*, зазвичай генерує **FastAPI** автоматично, але ви також можете її розширити. + +/// tip | Порада + +Це низькорівнева точка розширення. + +Якщо вам потрібно лише оголосити додаткові відповіді, зручніше зробити це через [Додаткові відповіді в OpenAPI](additional-responses.md){.internal-link target=_blank}. + +/// + +Ви можете розширити OpenAPI-схему для *операції шляху*, використовуючи параметр `openapi_extra`. + +### Розширення OpenAPI { #openapi-extensions } + +`openapi_extra` може бути корисним, наприклад, для оголошення [OpenAPI Extensions](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions): + +{* ../../docs_src/path_operation_advanced_configuration/tutorial005_py310.py hl[6] *} + +Якщо ви відкриєте автоматичну документацію API, ваше розширення з’явиться внизу конкретної *операції шляху*. + + + +І якщо ви відкриєте згенерований OpenAPI (за адресою `/openapi.json` у вашому API), ви також побачите своє розширення як частину конкретної *операції шляху*: + +```JSON hl_lines="22" +{ + "openapi": "3.1.0", + "info": { + "title": "FastAPI", + "version": "0.1.0" + }, + "paths": { + "/items/": { + "get": { + "summary": "Read Items", + "operationId": "read_items_items__get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-aperture-labs-portal": "blue" + } + } + } +} +``` + +### Власна схема OpenAPI для *операції шляху* { #custom-openapi-path-operation-schema } + +Словник у `openapi_extra` буде глибоко об’єднано з автоматично згенерованою OpenAPI-схемою для *операції шляху*. + +Тож ви можете додати додаткові дані до автоматично згенерованої схеми. + +Наприклад, ви можете вирішити читати та перевіряти запит власним кодом, не використовуючи автоматичні можливості FastAPI з Pydantic, але все ж захотіти визначити запит у Схемі OpenAPI. + +Ви можете зробити це за допомогою `openapi_extra`: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial006_py310.py hl[19:36, 39:40] *} + +У цьому прикладі ми не оголошували жодної моделі Pydantic. Насправді тіло запиту навіть не розібрано як JSON, воно читається безпосередньо як `bytes`, а функція `magic_data_reader()` відповідатиме за його розбір певним чином. + +Водночас ми можемо оголосити очікувану схему для тіла запиту. + +### Власний тип вмісту OpenAPI { #custom-openapi-content-type } + +Використовуючи той самий прийом, ви можете застосувати модель Pydantic, щоб визначити Схему JSON, яка потім включається в користувацький розділ OpenAPI-схеми для *операції шляху*. + +І ви можете зробити це, навіть якщо тип даних у запиті - не JSON. + +Наприклад, у цьому застосунку ми не використовуємо вбудовану функціональність FastAPI для отримання Схеми JSON з моделей Pydantic і не використовуємо автоматичну валідацію для JSON. Насправді ми оголошуємо тип вмісту запиту як YAML, а не JSON: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py310.py hl[15:20, 22] *} + +Попри те, що ми не використовуємо типову вбудовану функціональність, ми все одно використовуємо модель Pydantic, щоб вручну згенерувати Схему JSON для даних, які хочемо отримати у форматі YAML. + +Потім ми працюємо із запитом безпосередньо і отримуємо тіло як `bytes`. Це означає, що FastAPI навіть не намагатиметься розібрати корисне навантаження запиту як JSON. + +Далі у нашому коді ми безпосередньо розбираємо цей YAML-вміст і знову використовуємо ту саму модель Pydantic, щоб перевірити YAML-вміст: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py310.py hl[24:31] *} + +/// tip | Порада + +Тут ми перевикористовуємо ту саму модель Pydantic. + +Але так само ми могли б перевіряти дані іншим способом. + +/// diff --git a/docs/uk/docs/advanced/response-change-status-code.md b/docs/uk/docs/advanced/response-change-status-code.md new file mode 100644 index 0000000000..fdf9f81c56 --- /dev/null +++ b/docs/uk/docs/advanced/response-change-status-code.md @@ -0,0 +1,31 @@ +# Відповідь - зміна коду статусу { #response-change-status-code } + +Ймовірно, ви вже читали, що можна встановити типовий [код статусу відповіді](../tutorial/response-status-code.md){.internal-link target=_blank}. + +Але інколи потрібно повернути інший код статусу, ніж типовий. + +## Випадок використання { #use-case } + +Наприклад, уявімо, що ви хочете за замовчуванням повертати код статусу HTTP «OK» `200`. + +Але якщо даних не існувало, ви хочете створити їх і повернути код статусу HTTP «CREATED» `201`. + +Водночас ви все одно хочете мати змогу фільтрувати та перетворювати повернені дані за допомогою `response_model`. + +Для таких випадків ви можете використати параметр `Response`. + +## Використовуйте параметр `Response` { #use-a-response-parameter } + +Ви можете оголосити параметр типу `Response` у своїй функції операції шляху (так само, як для кукі та заголовків). + +Потім ви можете встановити `status_code` у цьому *тимчасовому* об'єкті відповіді. + +{* ../../docs_src/response_change_status_code/tutorial001_py310.py hl[1,9,12] *} + +Після цього ви можете повернути будь-який потрібний об'єкт, як зазвичай (`dict`, модель бази даних тощо). + +І якщо ви оголосили `response_model`, він усе одно буде використаний для фільтрації та перетворення поверненого об'єкта. + +**FastAPI** використає цей *тимчасовий* об'єкт відповіді, щоб отримати код статусу (а також кукі та заголовки), і помістить їх у фінальну відповідь, що містить повернуте вами значення, відфільтроване за допомогою `response_model`. + +Ви також можете оголосити параметр `Response` у залежностях і встановлювати там код статусу. Але майте на увазі: останнє встановлене значення матиме пріоритет. diff --git a/docs/uk/docs/advanced/response-cookies.md b/docs/uk/docs/advanced/response-cookies.md new file mode 100644 index 0000000000..826602e708 --- /dev/null +++ b/docs/uk/docs/advanced/response-cookies.md @@ -0,0 +1,51 @@ +# Кукі у відповіді { #response-cookies } + +## Використовуйте параметр `Response` { #use-a-response-parameter } + +Ви можете оголосити параметр типу `Response` у вашій *функції операції шляху*. + +Потім ви можете встановити кукі в цьому *тимчасовому* об'єкті відповіді. + +{* ../../docs_src/response_cookies/tutorial002_py310.py hl[1, 8:9] *} + +Після цього ви можете повернути будь-який потрібний об'єкт, як зазвичай (наприклад, `dict`, модель бази даних тощо). + +І якщо ви оголосили `response_model`, він усе одно буде використаний для фільтрації та перетворення об'єкта, який ви повернули. + +**FastAPI** використає цю *тимчасову* відповідь, щоб витягнути кукі (а також заголовки та код статусу) і помістить їх у фінальну відповідь, що містить значення, яке ви повернули, відфільтроване будь-якою `response_model`. + +Ви також можете оголосити параметр `Response` у залежностях і встановлювати в них кукі (і заголовки). + +## Повертайте `Response` безпосередньо { #return-a-response-directly } + +Ви також можете створювати кукі, повертаючи `Response` безпосередньо у вашому коді. + +Для цього ви можете створити відповідь, як описано в [Повернути відповідь безпосередньо](response-directly.md){.internal-link target=_blank}. + +Потім встановіть у ньому кукі і поверніть його: + +{* ../../docs_src/response_cookies/tutorial001_py310.py hl[10:12] *} + +/// tip | Порада + +Майте на увазі, що якщо ви повертаєте відповідь безпосередньо замість використання параметра `Response`, FastAPI поверне її напряму. + +Тому вам потрібно переконатися, що ваші дані мають коректний тип. Наприклад, сумісні з JSON, якщо ви повертаєте `JSONResponse`. + +А також що ви не надсилаєте дані, які мали б бути відфільтровані за допомогою `response_model`. + +/// + +### Більше інформації { #more-info } + +/// note | Технічні деталі + +Ви також можете використати `from starlette.responses import Response` або `from starlette.responses import JSONResponse`. + +**FastAPI** надає ті самі `starlette.responses` як `fastapi.responses` лише для зручності для вас, розробника. Але більшість доступних відповідей надходять безпосередньо зі Starlette. + +І оскільки `Response` часто використовується для встановлення заголовків і кукі, **FastAPI** також надає його як `fastapi.Response`. + +/// + +Щоб побачити всі доступні параметри та опції, перегляньте документацію в Starlette. diff --git a/docs/uk/docs/advanced/response-directly.md b/docs/uk/docs/advanced/response-directly.md new file mode 100644 index 0000000000..7396ab7565 --- /dev/null +++ b/docs/uk/docs/advanced/response-directly.md @@ -0,0 +1,65 @@ +# Повернення Response безпосередньо { #return-a-response-directly } + +Коли ви створюєте операцію шляху FastAPI, зазвичай ви можете повертати з неї будь-які дані: `dict`, `list`, модель Pydantic, модель бази даних тощо. + +Типово FastAPI автоматично перетворить це значення повернення на JSON, використовуючи `jsonable_encoder`, описаний у [Сумісному з JSON кодері](../tutorial/encoder.md){.internal-link target=_blank}. + +Потім, за лаштунками, він помістить ці дані, сумісні з JSON (наприклад, `dict`), у `JSONResponse`, який буде використано для надсилання відповіді клієнту. + +Але ви можете повертати `JSONResponse` безпосередньо з ваших операцій шляху. + +Це може бути корисним, наприклад, щоб повертати власні заголовки або кукі. + +## Повернення `Response` { #return-a-response } + +Насправді ви можете повертати будь-який `Response` або будь-який його підклас. + +/// tip | Порада + +`JSONResponse` сам є підкласом `Response`. + +/// + +І коли ви повертаєте `Response`, FastAPI передасть його безпосередньо. + +Він не виконуватиме жодних перетворень даних за допомогою моделей Pydantic, не перетворюватиме вміст на будь-який тип тощо. + +Це дає вам багато гнучкості. Ви можете повертати будь-які типи даних, переписувати будь-які оголошення або перевірки даних тощо. + +## Використання `jsonable_encoder` у `Response` { #using-the-jsonable-encoder-in-a-response } + +Оскільки FastAPI не вносить змін у `Response`, який ви повертаєте, вам потрібно впевнитися, що його вміст готовий. + +Наприклад, ви не можете покласти модель Pydantic у `JSONResponse`, не перетворивши її спочатку на `dict` з усіма типами даних (як-от `datetime`, `UUID` тощо), перетвореними на типи, сумісні з JSON. + +Для таких випадків ви можете використати `jsonable_encoder`, щоб перетворити ваші дані перед тим, як передати їх у відповідь: + +{* ../../docs_src/response_directly/tutorial001_py310.py hl[5:6,20:21] *} + +/// note | Технічні деталі + +Ви також можете використати `from starlette.responses import JSONResponse`. + +FastAPI надає ті самі `starlette.responses` як `fastapi.responses` просто як зручність для вас, розробника. Але більшість доступних `Response` походять безпосередньо зі Starlette. + +/// + +## Повернення власного `Response` { #returning-a-custom-response } + +Наведений вище приклад показує всі необхідні частини, але він ще не дуже корисний, адже ви могли просто повернути `item` безпосередньо, і FastAPI помістив би його у `JSONResponse`, перетворивши на `dict` тощо. Усе це відбувається за замовчуванням. + +Тепер подивімося, як це використати, щоб повернути власну відповідь. + +Припустімо, ви хочете повернути відповідь XML. + +Ви можете помістити свій вміст XML у строку, помістити це в `Response` і повернути: + +{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *} + +## Примітки { #notes } + +Коли ви повертаєте `Response` безпосередньо, його дані не перевіряються, не перетворюються (серіалізуються) і не документуються автоматично. + +Але ви все ще можете задокументувати це, як описано в [Додаткових відповідях в OpenAPI](additional-responses.md){.internal-link target=_blank}. + +У подальших розділах ви побачите, як використовувати/оголошувати ці власні `Response`, водночас зберігаючи автоматичне перетворення даних, документацію тощо. diff --git a/docs/uk/docs/advanced/response-headers.md b/docs/uk/docs/advanced/response-headers.md new file mode 100644 index 0000000000..1c9d4e6773 --- /dev/null +++ b/docs/uk/docs/advanced/response-headers.md @@ -0,0 +1,41 @@ +# Заголовки відповіді { #response-headers } + +## Використовуйте параметр `Response` { #use-a-response-parameter } + +Ви можете оголосити параметр типу `Response` у вашій функції операції шляху (так само, як і для кукі). + +Потім ви можете встановлювати заголовки в цьому *тимчасовому* обʼєкті відповіді. + +{* ../../docs_src/response_headers/tutorial002_py310.py hl[1, 7:8] *} + +Далі ви можете повернути будь-який потрібний обʼєкт, як зазвичай (наприклад, `dict`, модель бази даних тощо). + +Якщо ви оголосили `response_model`, його все одно буде використано для фільтрації та перетворення поверненого обʼєкта. + +FastAPI використає цей *тимчасовий* обʼєкт відповіді, щоб витягти заголовки (а також кукі та код статусу) і помістить їх у кінцеву відповідь, яка міститиме повернуте вами значення, відфільтроване будь-яким `response_model`. + +Також ви можете оголосити параметр `Response` у залежностях і встановлювати в них заголовки (та кукі). + +## Поверніть `Response` безпосередньо { #return-a-response-directly } + +Ви також можете додавати заголовки, коли повертаєте `Response` безпосередньо. + +Створіть відповідь, як описано в [Повернення Response безпосередньо](response-directly.md){.internal-link target=_blank}, і передайте заголовки як додатковий параметр: + +{* ../../docs_src/response_headers/tutorial001_py310.py hl[10:12] *} + +/// note | Технічні деталі + +Ви також можете використати `from starlette.responses import Response` або `from starlette.responses import JSONResponse`. + +FastAPI надає ті самі `starlette.responses` як `fastapi.responses` просто для зручності для вас, розробника. Але більшість доступних типів відповідей походять безпосередньо зі Starlette. + +Оскільки `Response` часто використовують для встановлення заголовків і кукі, FastAPI також надає його як `fastapi.Response`. + +/// + +## Власні заголовки { #custom-headers } + +Майте на увазі, що власні закриті заголовки можна додавати за допомогою префікса `X-`. + +Але якщо у вас є власні заголовки, які клієнт у браузері має бачити, вам потрібно додати їх у вашу конфігурацію CORS (докладніше в [CORS (Cross-Origin Resource Sharing)](../tutorial/cors.md){.internal-link target=_blank}), використовуючи параметр `expose_headers`, задокументований у документації Starlette щодо CORS. diff --git a/docs/uk/docs/advanced/security/http-basic-auth.md b/docs/uk/docs/advanced/security/http-basic-auth.md new file mode 100644 index 0000000000..e0578772d3 --- /dev/null +++ b/docs/uk/docs/advanced/security/http-basic-auth.md @@ -0,0 +1,107 @@ +# HTTP Basic Auth { #http-basic-auth } + +Для найпростіших випадків ви можете використовувати HTTP Basic Auth. + +У HTTP Basic Auth застосунок очікує заголовок, що містить ім'я користувача та пароль. + +Якщо він його не отримує, повертається помилка HTTP 401 «Unauthorized». + +І повертається заголовок `WWW-Authenticate` зі значенням `Basic` та необов'язковим параметром `realm`. + +Це каже браузеру показати вбудовану підсказку для введення імені користувача та пароля. + +Потім, коли ви введете це ім'я користувача та пароль, браузер автоматично надішле їх у заголовку. + +## Простий HTTP Basic Auth { #simple-http-basic-auth } + +- Імпортуйте `HTTPBasic` і `HTTPBasicCredentials`. +- Створіть «`security` scheme» за допомогою `HTTPBasic`. +- Використайте цей `security` як залежність у вашій операції шляху. +- Він повертає об'єкт типу `HTTPBasicCredentials`: + - Він містить надіслані `username` і `password`. + +{* ../../docs_src/security/tutorial006_an_py310.py hl[4,8,12] *} + +Коли ви спробуєте відкрити URL вперше (або натиснете кнопку «Execute» у документації), браузер попросить вас ввести ім'я користувача та пароль: + + + +## Перевірте ім'я користувача { #check-the-username } + +Ось більш повний приклад. + +Використайте залежність, щоб перевірити, чи правильні ім'я користувача та пароль. + +Для цього використайте стандартний модуль Python `secrets`, щоб перевірити ім'я користувача та пароль. + +`secrets.compare_digest()` повинен отримувати `bytes` або `str`, що містить лише ASCII-символи (англійські), це означає, що він не працюватиме з символами на кшталт `á`, як у `Sebastián`. + +Щоб це обійти, ми спочатку перетворюємо `username` і `password` у `bytes`, кодувавши їх у UTF-8. + +Потім ми можемо використати `secrets.compare_digest()`, щоб упевнитися, що `credentials.username` дорівнює `"stanleyjobson"`, а `credentials.password` дорівнює `"swordfish"`. + +{* ../../docs_src/security/tutorial007_an_py310.py hl[1,12:24] *} + +Це було б подібно до: + +```Python +if not (credentials.username == "stanleyjobson") or not (credentials.password == "swordfish"): + # Return some error + ... +``` + +Але використовуючи `secrets.compare_digest()`, це буде захищено від типу атак, що називаються «атаки за часом» (timing attacks). + +### Атаки за часом { #timing-attacks } + +Що таке «атака за часом»? + +Уявімо, що зловмисники намагаються вгадати ім'я користувача та пароль. + +Вони надсилають запит з ім'ям користувача `johndoe` та паролем `love123`. + +Тоді Python-код у вашому застосунку буде еквівалентний чомусь на кшталт: + +```Python +if "johndoe" == "stanleyjobson" and "love123" == "swordfish": + ... +``` + +Але в той момент, коли Python порівнює першу `j` у `johndoe` з першою `s` у `stanleyjobson`, він поверне `False`, тому що вже знає, що ці дві строки не однакові, «немає сенсу витрачати обчислення на порівняння решти літер». І ваш застосунок скаже «Невірні ім'я користувача або пароль». + +А потім зловмисники спробують з ім'ям користувача `stanleyjobsox` і паролем `love123`. + +І ваш код застосунку зробить щось на кшталт: + +```Python +if "stanleyjobsox" == "stanleyjobson" and "love123" == "swordfish": + ... +``` + +Python доведеться порівняти весь `stanleyjobso` у обох `stanleyjobsox` і `stanleyjobson`, перш ніж зрозуміти, що строки різні. Тому відповідь «Невірні ім'я користувача або пароль» займе на кілька мікросекунд довше. + +#### Час відповіді допомагає зловмисникам { #the-time-to-answer-helps-the-attackers } + +У цей момент, помітивши, що сервер витратив на кілька мікросекунд більше, щоб надіслати відповідь «Невірні ім'я користувача або пароль», зловмисники знатимуть, що вони щось вгадали, деякі початкові літери правильні. + +І тоді вони можуть спробувати знову, знаючи, що це, ймовірно, щось більш схоже на `stanleyjobsox`, ніж на `johndoe`. + +#### «Професійна» атака { #a-professional-attack } + +Звісно, зловмисники не робитимуть усе це вручну, вони напишуть програму, можливо з тисячами або мільйонами перевірок за секунду. І вони отримуватимуть лише по одній правильній літері за раз. + +Але так за кілька хвилин або годин зловмисники вгадають правильні ім'я користувача та пароль, «за допомогою» нашого застосунку, просто використовуючи час, потрібний для відповіді. + +#### Виправте за допомогою `secrets.compare_digest()` { #fix-it-with-secrets-compare-digest } + +Але в нашому коді ми насправді використовуємо `secrets.compare_digest()`. + +Коротко, він витрачає однаковий час на порівняння `stanleyjobsox` зі `stanleyjobson`, як і на порівняння `johndoe` зі `stanleyjobson`. І так само для пароля. + +Таким чином, використовуючи `secrets.compare_digest()` у коді вашого застосунку, він буде захищений від усього цього класу атак безпеки. + +### Поверніть помилку { #return-the-error } + +Після виявлення, що облікові дані неправильні, поверніть `HTTPException` з кодом статусу 401 (такий самий повертається, коли облікові дані не надані) і додайте заголовок `WWW-Authenticate`, щоб браузер знову показав підсказку входу: + +{* ../../docs_src/security/tutorial007_an_py310.py hl[26:30] *} diff --git a/docs/uk/docs/advanced/security/index.md b/docs/uk/docs/advanced/security/index.md new file mode 100644 index 0000000000..a3479794f8 --- /dev/null +++ b/docs/uk/docs/advanced/security/index.md @@ -0,0 +1,19 @@ +# Просунута безпека { #advanced-security } + +## Додаткові можливості { #additional-features } + +Є кілька додаткових можливостей для роботи з безпекою, окрім тих, що розглянуті в [Навчальний посібник - Посібник користувача: Безпека](../../tutorial/security/index.md){.internal-link target=_blank}. + +/// tip | Порада + +Наступні розділи не обов'язково «просунуті». + +І можливо, що для вашого випадку використання рішення є в одному з них. + +/// + +## Спершу прочитайте навчальний посібник { #read-the-tutorial-first } + +У наступних розділах передбачається, що ви вже прочитали основний [Навчальний посібник - Посібник користувача: Безпека](../../tutorial/security/index.md){.internal-link target=_blank}. + +Усі вони базуються на тих самих концепціях, але надають деякі додаткові можливості. diff --git a/docs/uk/docs/advanced/security/oauth2-scopes.md b/docs/uk/docs/advanced/security/oauth2-scopes.md new file mode 100644 index 0000000000..34ef04a288 --- /dev/null +++ b/docs/uk/docs/advanced/security/oauth2-scopes.md @@ -0,0 +1,274 @@ +# OAuth2 scopes { #oauth2-scopes } + +Ви можете використовувати OAuth2 scopes безпосередньо з **FastAPI**, вони інтегровані для безшовної роботи. + +Це дозволить мати більш детальну систему дозволів, відповідно до стандарту OAuth2, інтегровану у ваш застосунок OpenAPI (і документацію API). + +OAuth2 зі scopes - це механізм, який використовують багато великих провайдерів автентифікації, як-от Facebook, Google, GitHub, Microsoft, X (Twitter) тощо. Вони застосовують його, щоб надавати конкретні дозволи користувачам і застосункам. + +Кожного разу, коли ви «log in with» Facebook, Google, GitHub, Microsoft, X (Twitter), цей застосунок використовує OAuth2 зі scopes. + +У цьому розділі ви побачите, як керувати автентифікацією та авторизацією за допомогою того ж OAuth2 зі scopes у вашому застосунку **FastAPI**. + +/// warning | Попередження + +Це більш-менш просунутий розділ. Якщо ви тільки починаєте, можете пропустити його. + +Вам не обов’язково потрібні OAuth2 scopes, ви можете керувати автентифікацією та авторизацією будь-яким зручним способом. + +Але OAuth2 зі scopes можна гарно інтегрувати у ваш API (з OpenAPI) і документацію API. + +Водночас ви все одно примушуєте виконувати ці scopes або будь-які інші вимоги безпеки/авторизації так, як потрібно, у своєму коді. + +У багатьох випадках OAuth2 зі scopes - це надмірність. + +Але якщо ви знаєте, що це потрібно, або просто цікаво, читайте далі. + +/// + +## OAuth2 scopes та OpenAPI { #oauth2-scopes-and-openapi } + +Специфікація OAuth2 визначає «scopes» як список строк, розділених пробілами. + +Вміст кожної з цих строк може мати будь-який формат, але не повинен містити пробілів. + +Ці scopes представляють «дозволи». + +В OpenAPI (наприклад, у документації API) ви можете визначати «схеми безпеки». + +Коли одна з цих схем безпеки використовує OAuth2, ви також можете оголошувати та використовувати scopes. + +Кожен «scope» - це просто строка (без пробілів). + +Зазвичай їх використовують для оголошення конкретних дозволів безпеки, наприклад: + +- `users:read` або `users:write` - поширені приклади. +- `instagram_basic` використовується Facebook / Instagram. +- `https://www.googleapis.com/auth/drive` використовується Google. + +/// info | Інформація + +В OAuth2 «scope» - це просто строка, що декларує конкретний потрібний дозвіл. + +Не має значення, чи містить вона інші символи на кшталт `:` або чи це URL. + +Ці деталі специфічні для реалізації. + +Для OAuth2 це просто строки. + +/// + +## Загальний огляд { #global-view } + +Спочатку швидко подивімося на частини, що відрізняються від прикладів у головному **Навчальному посібнику - Керівництві користувача** для [OAuth2 з паролем (і хешуванням), Bearer з JWT-токенами](../../tutorial/security/oauth2-jwt.md){.internal-link target=_blank}. Тепер із використанням OAuth2 scopes: + +{* ../../docs_src/security/tutorial005_an_py310.py hl[5,9,13,47,65,106,108:116,122:126,130:136,141,157] *} + +Тепер розгляньмо ці зміни крок за кроком. + +## Схема безпеки OAuth2 { #oauth2-security-scheme } + +Перша зміна - тепер ми оголошуємо схему безпеки OAuth2 з двома доступними scopes: `me` і `items`. + +Параметр `scopes` приймає `dict`, де кожен scope - це ключ, а опис - значення: + +{* ../../docs_src/security/tutorial005_an_py310.py hl[63:66] *} + +Оскільки тепер ми оголошуємо ці scopes, вони з’являться в документації API, коли ви увійдете/авторизуєтеся. + +І ви зможете обрати, які scopes надати доступ: `me` і `items`. + +Це той самий механізм, який використовується, коли ви надаєте дозволи під час входу через Facebook, Google, GitHub тощо: + + + +## JWT токен зі scopes { #jwt-token-with-scopes } + +Тепер змініть операцію шляху токена, щоб повертати запитані scopes. + +Ми все ще використовуємо той самий `OAuth2PasswordRequestForm`. Він містить властивість `scopes` зі `list` з `str`, по одному scope, отриманому в запиті. + +І ми повертаємо scopes як частину JWT токена. + +/// danger | Обережно + +Для простоти тут ми просто додаємо отримані scopes безпосередньо до токена. + +Але у вашому застосунку, з міркувань безпеки, переконайтеся, що ви додаєте лише ті scopes, які користувач дійсно може мати, або ті, що ви попередньо визначили. + +/// + +{* ../../docs_src/security/tutorial005_an_py310.py hl[157] *} + +## Оголосіть scopes в операціях шляху та залежностях { #declare-scopes-in-path-operations-and-dependencies } + +Тепер ми оголошуємо, що операція шляху для `/users/me/items/` вимагає scope `items`. + +Для цього імпортуємо і використовуємо `Security` з `fastapi`. + +Ви можете використовувати `Security` для оголошення залежностей (так само як `Depends`), але `Security` також приймає параметр `scopes` зі списком scopes (строк). + +У цьому випадку ми передаємо функцію-залежність `get_current_active_user` до `Security` (так само, як зробили б із `Depends`). + +А також передаємо `list` scopes, у цьому випадку лише один scope: `items` (їх могло б бути більше). + +І функція-залежність `get_current_active_user` також може оголошувати підзалежності не лише з `Depends`, а й з `Security`. Оголошуючи свою підзалежність (`get_current_user`) і додаткові вимоги до scopes. + +У цьому випадку вона вимагає scope `me` (вона могла б вимагати більш ніж один scope). + +/// note | Примітка + +Вам не обов’язково додавати різні scopes у різних місцях. + +Ми робимо це тут, щоб показати, як **FastAPI** обробляє scopes, оголошені на різних рівнях. + +/// + +{* ../../docs_src/security/tutorial005_an_py310.py hl[5,141,172] *} + +/// info | Технічні деталі + +`Security` насправді є підкласом `Depends`, і має лише один додатковий параметр, який ми побачимо пізніше. + +Але використовуючи `Security` замість `Depends`, **FastAPI** знатиме, що можна оголошувати scopes безпеки, використовувати їх внутрішньо та документувати API через OpenAPI. + +Коли ви імпортуєте `Query`, `Path`, `Depends`, `Security` та інші з `fastapi`, це насправді функції, що повертають спеціальні класи. + +/// + +## Використовуйте `SecurityScopes` { #use-securityscopes } + +Тепер оновіть залежність `get_current_user`. + +Вона використовується наведеними вище залежностями. + +Тут ми використовуємо ту саму схему OAuth2, створену раніше, оголошуючи її як залежність: `oauth2_scheme`. + +Оскільки ця функція-залежність не має власних вимог до scopes, ми можемо використовувати `Depends` з `oauth2_scheme`, немає потреби застосовувати `Security`, коли не потрібно вказувати scopes безпеки. + +Ми також оголошуємо спеціальний параметр типу `SecurityScopes`, імпортований з `fastapi.security`. + +Клас `SecurityScopes` подібний до `Request` (у `Request` ми напряму отримували об’єкт запиту). + +{* ../../docs_src/security/tutorial005_an_py310.py hl[9,106] *} + +## Використовуйте scopes { #use-the-scopes } + +Параметр `security_scopes` матиме тип `SecurityScopes`. + +Він матиме властивість `scopes` зі списком, що містить усі scopes, потрібні самій функції та всім залежним, які використовують її як підзалежність. Тобто всім «залежним»... це може звучати заплутано, нижче пояснено ще раз. + +Об’єкт `security_scopes` (класу `SecurityScopes`) також надає атрибут `scope_str` з одним рядком, що містить ці scopes, розділені пробілами (ми його використаємо). + +Ми створюємо `HTTPException`, який зможемо повторно використати (`raise`) у кількох місцях. + +У цьому винятку ми включаємо потрібні scopes (якщо є) як строку, розділену пробілами (використовуючи `scope_str`). Ми поміщаємо цю строку зі scopes в заголовок `WWW-Authenticate` (це частина специфікації). + +{* ../../docs_src/security/tutorial005_an_py310.py hl[106,108:116] *} + +## Перевірте `username` і структуру даних { #verify-the-username-and-data-shape } + +Ми перевіряємо, що отримали `username`, і видобуваємо scopes. + +Потім валідовуємо ці дані за допомогою Pydantic-моделі (перехоплюючи виняток `ValidationError`), і якщо виникає помилка читання JWT токена або валідації даних Pydantic, підіймаємо раніше створений `HTTPException`. + +Для цього ми оновлюємо Pydantic-модель `TokenData` новою властивістю `scopes`. + +Валідувавши дані через Pydantic, ми гарантуємо, що, наприклад, маємо саме `list` із `str` для scopes і `str` для `username`. + +Замість, наприклад, `dict` або чогось іншого, що може зламати застосунок далі, створивши ризик безпеки. + +Ми також перевіряємо, що існує користувач із цим username, інакше підіймаємо той самий виняток. + +{* ../../docs_src/security/tutorial005_an_py310.py hl[47,117:129] *} + +## Перевірте `scopes` { #verify-the-scopes } + +Тепер перевіряємо, що всі потрібні scopes - для цієї залежності та всіх залежних (включно з операціями шляху) - містяться в scopes, наданих у отриманому токені, інакше підіймаємо `HTTPException`. + +Для цього використовуємо `security_scopes.scopes`, що містить `list` із усіма цими scopes як `str`. + +{* ../../docs_src/security/tutorial005_an_py310.py hl[130:136] *} + +## Дерево залежностей і scopes { #dependency-tree-and-scopes } + +Ще раз розгляньмо дерево залежностей і scopes. + +Оскільки залежність `get_current_active_user` має підзалежність `get_current_user`, scope «me», оголошений у `get_current_active_user`, буде включений до списку потрібних scopes у `security_scopes.scopes`, переданого до `get_current_user`. + +Сама операція шляху також оголошує scope «items», отже він також буде у списку `security_scopes.scopes`, переданому до `get_current_user`. + +Ось як виглядає ієрархія залежностей і scopes: + +- Операція шляху `read_own_items` має: + - Потрібні scopes `["items"]` із залежністю: + - `get_current_active_user`: + - Функція-залежність `get_current_active_user` має: + - Потрібні scopes `["me"]` із залежністю: + - `get_current_user`: + - Функція-залежність `get_current_user` має: + - Власних scopes не потребує. + - Залежність, що використовує `oauth2_scheme`. + - Параметр `security_scopes` типу `SecurityScopes`: + - Цей параметр `security_scopes` має властивість `scopes` із `list`, що містить усі наведені вище scopes, отже: + - `security_scopes.scopes` міститиме `["me", "items"]` для операції шляху `read_own_items`. + - `security_scopes.scopes` міститиме `["me"]` для операції шляху `read_users_me`, адже він оголошений у залежності `get_current_active_user`. + - `security_scopes.scopes` міститиме `[]` (нічого) для операції шляху `read_system_status`, бо вона не оголошує жодного `Security` зі `scopes`, і її залежність `get_current_user` також не оголошує жодних `scopes`. + +/// tip | Порада + +Важливе і «магічне» тут у тому, що `get_current_user` матиме різні списки `scopes` для перевірки для кожної операції шляху. + +Усе залежить від `scopes`, оголошених у кожній операції шляху та кожній залежності в дереві залежностей для конкретної операції шляху. + +/// + +## Більше деталей про `SecurityScopes` { #more-details-about-securityscopes } + +Ви можете використовувати `SecurityScopes` у будь-якому місці й у кількох місцях, він не обов’язково має бути в «кореневій» залежності. + +Він завжди міститиме scopes безпеки, оголошені в поточних залежностях `Security` і всіх залежних для **цієї конкретної** операції шляху і **цього конкретного** дерева залежностей. + +Оскільки `SecurityScopes` міститиме всі scopes, оголошені залежними, ви можете використовувати його, щоб перевірити, що токен має потрібні scopes, у центральній функції-залежності, а потім оголошувати різні вимоги до scopes у різних операціях шляху. + +Вони перевірятимуться незалежно для кожної операції шляху. + +## Перевірте { #check-it } + +Якщо ви відкриєте документацію API, ви зможете автентифікуватися і вказати, які scopes хочете авторизувати. + + + +Якщо ви не оберете жодного scope, ви будете «автентифіковані», але при спробі доступу до `/users/me/` або `/users/me/items/` отримаєте помилку про недостатні дозволи. Ви все ще матимете доступ до `/status/`. + +Якщо оберете scope `me`, але не scope `items`, ви зможете отримати доступ до `/users/me/`, але не до `/users/me/items/`. + +Так станеться зі стороннім застосунком, який спробує звернутися до однієї з цих операцій шляху з токеном, наданим користувачем, залежно від того, скільки дозволів користувач надав застосунку. + +## Про сторонні інтеграції { #about-third-party-integrations } + +У цьому прикладі ми використовуємо «потік паролю» OAuth2. + +Це доречно, коли ми входимо у власний застосунок, ймовірно, з власним фронтендом. + +Адже ми можемо довіряти йому отримання `username` і `password`, бо ми його контролюємо. + +Але якщо ви створюєте OAuth2-застосунок, до якого підключатимуться інші (тобто якщо ви створюєте провайдера автентифікації на кшталт Facebook, Google, GitHub тощо), слід використовувати один з інших потоків. + +Найпоширеніший - неявний потік (implicit flow). + +Найбезпечніший - потік коду (code flow), але його складніше реалізувати, оскільки він потребує більше кроків. Через складність багато провайдерів у підсумку радять неявний потік. + +/// note | Примітка + +Часто кожен провайдер автентифікації називає свої потоки по-різному, роблячи це частиною свого бренду. + +Але зрештою вони реалізують той самий стандарт OAuth2. + +/// + +**FastAPI** містить утиліти для всіх цих потоків автентифікації OAuth2 у `fastapi.security.oauth2`. + +## `Security` у параметрі декоратора `dependencies` { #security-in-decorator-dependencies } + +Так само як ви можете визначити `list` із `Depends` у параметрі `dependencies` декоратора (як пояснено в [Залежності в декораторах операцій шляху](../../tutorial/dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}), ви також можете використовувати там `Security` зі `scopes`. diff --git a/docs/uk/docs/advanced/settings.md b/docs/uk/docs/advanced/settings.md new file mode 100644 index 0000000000..dccb4b0911 --- /dev/null +++ b/docs/uk/docs/advanced/settings.md @@ -0,0 +1,302 @@ +# Налаштування та змінні оточення { #settings-and-environment-variables } + +У багатьох випадках вашому застосунку можуть знадобитися зовнішні налаштування або конфігурації, наприклад секретні ключі, облікові дані бази даних, облікові дані для email-сервісів тощо. + +Більшість із цих налаштувань змінні (можуть змінюватися), як-от URL-адреси баз даних. І багато з них можуть бути чутливими, як-от секрети. + +З цієї причини поширено надавати їх у змінних оточення, які зчитуються застосунком. + +/// tip | Порада + +Щоб зрозуміти змінні оточення, ви можете прочитати [Змінні оточення](../environment-variables.md){.internal-link target=_blank}. + +/// + +## Типи та перевірка { #types-and-validation } + +Ці змінні оточення можуть містити лише текстові строки, оскільки вони зовнішні до Python і мають бути сумісні з іншими програмами та рештою системи (і навіть з різними операційними системами, як-от Linux, Windows, macOS). + +Це означає, що будь-яке значення, прочитане в Python зі змінної оточення, буде `str`, і будь-яке перетворення в інший тип або будь-яка перевірка мають виконуватися в коді. + +## Pydantic `Settings` { #pydantic-settings } + +На щастя, Pydantic надає чудовий інструмент для обробки цих налаштувань із змінних оточення - Pydantic: Settings management. + +### Встановіть `pydantic-settings` { #install-pydantic-settings } + +Спершу переконайтеся, що ви створили [віртуальне оточення](../virtual-environments.md){.internal-link target=_blank}, активували його, а потім встановили пакет `pydantic-settings`: + +
+ +```console +$ pip install pydantic-settings +---> 100% +``` + +
+ +Він також входить у склад, якщо ви встановлюєте додаткові можливості «all» за допомогою: + +
+ +```console +$ pip install "fastapi[all]" +---> 100% +``` + +
+ +### Створіть об'єкт `Settings` { #create-the-settings-object } + +Імпортуйте `BaseSettings` із Pydantic і створіть підклас, дуже подібно до моделі Pydantic. + +Так само, як і з моделями Pydantic, ви оголошуєте атрибути класу з анотаціями типів і, за потреби, значеннями за замовчуванням. + +Ви можете використовувати всі ті самі можливості перевірки та інструменти, що й для моделей Pydantic, як-от різні типи даних і додаткові перевірки з `Field()`. + +{* ../../docs_src/settings/tutorial001_py310.py hl[2,5:8,11] *} + +/// tip | Порада + +Якщо вам потрібно щось швидко скопіювати й вставити, не використовуйте цей приклад, скористайтеся останнім нижче. + +/// + +Потім, коли ви створите екземпляр цього класу `Settings` (у цьому випадку в об'єкті `settings`), Pydantic зчитуватиме змінні оточення без урахування регістру, тож верхньорегістрова змінна `APP_NAME` все одно буде прочитана для атрибута `app_name`. + +Далі він перетворить і перевірить дані. Тож коли ви використовуватимете об'єкт `settings`, у вас будуть дані тих типів, які ви оголосили (наприклад, `items_per_user` буде `int`). + +### Використовуйте `settings` { #use-the-settings } + +Потім ви можете використати новий об'єкт `settings` у вашому застосунку: + +{* ../../docs_src/settings/tutorial001_py310.py hl[18:20] *} + +### Запустіть сервер { #run-the-server } + +Далі ви б запустили сервер, передаючи конфігурації як змінні оточення, наприклад, ви можете встановити `ADMIN_EMAIL` і `APP_NAME` так: + +
+ +```console +$ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp" fastapi run main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +/// tip | Порада + +Щоб встановити кілька змінних оточення для однієї команди, просто розділіть їх пробілами і розмістіть усі перед командою. + +/// + +Після цього налаштування `admin_email` буде встановлено в `"deadpool@example.com"`. + +`app_name` буде `"ChimichangApp"`. + +А `items_per_user` збереже своє значення за замовчуванням `50`. + +## Налаштування в іншому модулі { #settings-in-another-module } + +Ви можете розмістити ці налаштування в іншому модулі, як ви бачили в [Більші застосунки - кілька файлів](../tutorial/bigger-applications.md){.internal-link target=_blank}. + +Наприклад, у вас може бути файл `config.py` з: + +{* ../../docs_src/settings/app01_py310/config.py *} + +А потім використати його у файлі `main.py`: + +{* ../../docs_src/settings/app01_py310/main.py hl[3,11:13] *} + +/// tip | Порада + +Вам також знадобиться файл `__init__.py`, як ви бачили в [Більші застосунки - кілька файлів](../tutorial/bigger-applications.md){.internal-link target=_blank}. + +/// + +## Налаштування як залежність { #settings-in-a-dependency } + +Іноді може бути корисно надавати налаштування через залежність, замість того, щоб мати глобальний об'єкт `settings`, який використовується всюди. + +Це може бути особливо корисно під час тестування, оскільки дуже легко переписати залежність власними налаштуваннями. + +### Файл конфігурації { #the-config-file } + +Продовжуючи попередній приклад, ваш файл `config.py` може виглядати так: + +{* ../../docs_src/settings/app02_an_py310/config.py hl[10] *} + +Зверніть увагу, що тепер ми не створюємо екземпляр за замовчуванням `settings = Settings()`. + +### Основний файл застосунку { #the-main-app-file } + +Тепер ми створюємо залежність, яка повертає новий `config.Settings()`. + +{* ../../docs_src/settings/app02_an_py310/main.py hl[6,12:13] *} + +/// tip | Порада + +Ми обговоримо `@lru_cache` трохи згодом. + +Поки що можете вважати, що `get_settings()` - це звичайна функція. + +/// + +А далі ми можемо вимагати її у *функції операції шляху* як залежність і використовувати будь-де, де це потрібно. + +{* ../../docs_src/settings/app02_an_py310/main.py hl[17,19:21] *} + +### Налаштування і тестування { #settings-and-testing } + +Потім буде дуже просто надати інший об'єкт налаштувань під час тестування, створивши переписування залежності для `get_settings`: + +{* ../../docs_src/settings/app02_an_py310/test_main.py hl[9:10,13,21] *} + +У переписуванні залежності ми встановлюємо нове значення `admin_email` під час створення нового об'єкта `Settings`, а потім повертаємо цей новий об'єкт. + +Після цього ми можемо перевірити, що саме він використовується. + +## Читання файлу `.env` { #reading-a-env-file } + +Якщо у вас багато налаштувань, які можуть часто змінюватися, можливо в різних оточеннях, може бути корисно розмістити їх у файлі, а потім зчитувати їх із нього так, ніби це змінні оточення. + +Ця практика достатньо поширена, тож має назву - ці змінні оточення зазвичай розміщуються у файлі `.env`, а сам файл називається «dotenv». + +/// tip | Порада + +Файл, що починається з крапки (`.`), є прихованим у системах, подібних до Unix, як-от Linux і macOS. + +Але файл dotenv не обов'язково має мати саме таку назву. + +/// + +Pydantic має підтримку читання з таких типів файлів за допомогою зовнішньої бібліотеки. Ви можете дізнатися більше тут: Pydantic Settings: Dotenv (.env) support. + +/// tip | Порада + +Щоб це працювало, потрібно виконати `pip install python-dotenv`. + +/// + +### Файл `.env` { #the-env-file } + +У вас може бути файл `.env` із вмістом: + +```bash +ADMIN_EMAIL="deadpool@example.com" +APP_NAME="ChimichangApp" +``` + +### Зчитування налаштувань із `.env` { #read-settings-from-env } + +Потім оновіть ваш `config.py` так: + +{* ../../docs_src/settings/app03_an_py310/config.py hl[9] *} + +/// tip | Порада + +Атрибут `model_config` використовується лише для конфігурації Pydantic. Докладніше: Pydantic: Concepts: Configuration. + +/// + +Тут ми визначаємо конфіг `env_file` усередині вашого класу Pydantic `Settings` і задаємо значення - ім'я файла з dotenv, який ми хочемо використати. + +### Створення `Settings` лише один раз за допомогою `lru_cache` { #creating-the-settings-only-once-with-lru-cache } + +Читання файла з диска зазвичай є дорогою (повільною) операцією, тож, імовірно, ви захочете робити це лише один раз і потім перевикористовувати той самий об'єкт налаштувань замість зчитування для кожного запиту. + +Але щоразу, коли ми робимо: + +```Python +Settings() +``` + +буде створено новий об'єкт `Settings`, і під час створення він знову зчитуватиме файл `.env`. + +Якби функція залежності виглядала так: + +```Python +def get_settings(): + return Settings() +``` + +ми створювали б цей об'єкт для кожного запиту і читали б файл `.env` для кожного запиту. ⚠️ + +Але оскільки ми використовуємо декоратор `@lru_cache` зверху, об'єкт `Settings` буде створено лише один раз, під час першого виклику. ✔️ + +{* ../../docs_src/settings/app03_an_py310/main.py hl[1,11] *} + +Потім для будь-якого подальшого виклику `get_settings()` у залежностях для наступних запитів, замість виконання внутрішнього коду `get_settings()` і створення нового об'єкта `Settings`, він повертатиме той самий об'єкт, що був повернутий під час першого виклику, знову і знову. + +#### Технічні деталі `lru_cache` { #lru-cache-technical-details } + +`@lru_cache` модифікує функцію, яку він декорує, так, щоб вона повертала те саме значення, що й уперше, замість повторного обчислення, виконуючи код функції щоразу. + +Тобто функція під ним буде виконана один раз для кожної комбінації аргументів. А потім значення, повернені кожною з цих комбінацій аргументів, використовуватимуться знову і знову щоразу, коли функцію викликають із точно такою ж комбінацією аргументів. + +Наприклад, якщо у вас є функція: + +```Python +@lru_cache +def say_hi(name: str, salutation: str = "Ms."): + return f"Hello {salutation} {name}" +``` + +ваша програма може виконуватись так: + +```mermaid +sequenceDiagram + +participant code as Code +participant function as say_hi() +participant execute as Execute function + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Camila") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Camila") + function ->> code: return stored result + end + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Rick") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Rick", salutation="Mr.") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Rick") + function ->> code: return stored result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Camila") + function ->> code: return stored result + end +``` + +У випадку з нашою залежністю `get_settings()` функція взагалі не приймає жодних аргументів, тож вона завжди повертає те саме значення. + +Таким чином, вона поводиться майже так само, якби це була просто глобальна змінна. Але оскільки використовується функція залежності, ми можемо легко переписати її для тестування. + +`@lru_cache` є частиною `functools`, що входить до стандартної бібліотеки Python, більше про це можна прочитати в документації Python для `@lru_cache`. + +## Підсумок { #recap } + +Ви можете використовувати Pydantic Settings для обробки налаштувань або конфігурацій вашого застосунку, з усією потужністю моделей Pydantic. + +- Використовуючи залежність, ви можете спростити тестування. +- Ви можете використовувати з ним файли `.env`. +- Використання `@lru_cache` дає змогу уникнути повторного читання файла dotenv для кожного запиту, водночас дозволяючи переписувати його під час тестування. diff --git a/docs/uk/docs/advanced/sub-applications.md b/docs/uk/docs/advanced/sub-applications.md new file mode 100644 index 0000000000..5e611c6ff2 --- /dev/null +++ b/docs/uk/docs/advanced/sub-applications.md @@ -0,0 +1,67 @@ +# Підзастосунки - монтування { #sub-applications-mounts } + +Якщо вам потрібно мати два незалежні застосунки FastAPI з власними незалежними OpenAPI та власними інтерфейсами документації, ви можете мати головний застосунок і «змонтувати» один або кілька підзастосунків. + +## Монтування застосунку **FastAPI** { #mounting-a-fastapi-application } + +«Монтування» означає додавання повністю «незалежного» застосунку на конкретний шлях, який далі обробляє все під цим шляхом за допомогою _операцій шляху_, оголошених у цьому підзастосунку. + +### Застосунок верхнього рівня { #top-level-application } + +Спочатку створіть головний, верхньорівневий застосунок **FastAPI** та його _операції шляху_: + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[3, 6:8] *} + +### Підзастосунок { #sub-application } + +Потім створіть свій підзастосунок та його _операції шляху_. + +Цей підзастосунок - просто ще один стандартний застосунок FastAPI, але саме його буде «змонтовано»: + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 14:16] *} + +### Змонтуйте підзастосунок { #mount-the-sub-application } + +У вашому застосунку верхнього рівня, `app`, змонтуйте підзастосунок `subapi`. + +У цьому випадку його буде змонтовано за шляхом `/subapi`: + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 19] *} + +### Перевірте автоматичну документацію API { #check-the-automatic-api-docs } + +Тепер запустіть команду `fastapi` з вашим файлом: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +І відкрийте документацію за адресою http://127.0.0.1:8000/docs. + +Ви побачите автоматичну документацію API для головного застосунку, що містить лише його власні _операції шляху_: + + + +А потім відкрийте документацію для підзастосунку за адресою http://127.0.0.1:8000/subapi/docs. + +Ви побачите автоматичну документацію API для підзастосунку, що містить лише його власні _операції шляху_, усі з правильним префіксом підшляху `/subapi`: + + + +Якщо ви спробуєте взаємодіяти з будь-яким із двох інтерфейсів користувача, вони працюватимуть коректно, адже браузер зможе спілкуватися з кожним конкретним застосунком або підзастосунком. + +### Технічні деталі: `root_path` { #technical-details-root-path } + +Коли ви монтуєте підзастосунок, як описано вище, FastAPI подбає про передачу шляху монтування для підзастосунку, використовуючи механізм зі специфікації ASGI під назвою `root_path`. + +Таким чином підзастосунок знатиме, що слід використовувати цей префікс шляху для інтерфейсу документації. + +Підзастосунок також може мати власні змонтовані підзастосунки, і все працюватиме коректно, оскільки FastAPI автоматично обробляє всі ці `root_path`. + +Ви дізнаєтеся більше про `root_path` і як використовувати його явно в розділі [За представником](behind-a-proxy.md){.internal-link target=_blank}. diff --git a/docs/uk/docs/advanced/templates.md b/docs/uk/docs/advanced/templates.md new file mode 100644 index 0000000000..9e1ce3709b --- /dev/null +++ b/docs/uk/docs/advanced/templates.md @@ -0,0 +1,126 @@ +# Шаблони { #templates } + +Ви можете використовувати будь-який рушій шаблонів з **FastAPI**. + +Поширений вибір - Jinja2, той самий, що використовується у Flask та інших інструментах. + +Є утиліти для простої конфігурації, які ви можете використовувати безпосередньо у вашому застосунку **FastAPI** (надає Starlette). + +## Встановіть залежності { #install-dependencies } + +Переконайтеся, що ви створили [віртуальне оточення](../virtual-environments.md){.internal-link target=_blank}, активували його та встановили `jinja2`: + +
+ +```console +$ pip install jinja2 + +---> 100% +``` + +
+ +## Використання `Jinja2Templates` { #using-jinja2templates } + +- Імпортуйте `Jinja2Templates`. +- Створіть об'єкт `templates`, який ви зможете перевикористовувати. +- Оголосіть параметр `Request` в *операції шляху*, яка повертатиме шаблон. +- Використайте створені `templates`, щоб зрендерити та повернути `TemplateResponse`; передайте назву шаблону, об'єкт `request` і словник «контекст» з парами ключ-значення, які будуть використані всередині шаблону Jinja2. + +{* ../../docs_src/templates/tutorial001_py310.py hl[4,11,15:18] *} + +/// note | Примітка + +До FastAPI 0.108.0, Starlette 0.29.0, параметр `name` був першим. + +Також раніше, у попередніх версіях, об'єкт `request` передавався як частина пар ключ-значення в контексті для Jinja2. + +/// + +/// tip | Порада + +Якщо вказати `response_class=HTMLResponse`, інтерфейс документації знатиме, що відповідь буде HTML. + +/// + +/// note | Технічні деталі + +Можна також використати `from starlette.templating import Jinja2Templates`. + +**FastAPI** надає той самий `starlette.templating` як `fastapi.templating` просто для зручності для вас, розробника. Але більшість доступних відповідей надходять безпосередньо зі Starlette. Так само з `Request` і `StaticFiles`. + +/// + +## Створення шаблонів { #writing-templates } + +Потім ви можете написати шаблон у `templates/item.html`, наприклад: + +```jinja hl_lines="7" +{!../../docs_src/templates/templates/item.html!} +``` + +### Значення контексту шаблону { #template-context-values } + +У HTML, який містить: + +{% raw %} + +```jinja +Item ID: {{ id }} +``` + +{% endraw %} + +...буде показано `id`, взятий із «контексту» `dict`, який ви передали: + +```Python +{"id": id} +``` + +Наприклад, з ID `42` це буде відображено як: + +```html +Item ID: 42 +``` + +### Аргументи `url_for` у шаблоні { #template-url-for-arguments } + +Ви також можете використовувати `url_for()` у шаблоні - вона приймає ті самі аргументи, що й ваша *функція операції шляху*. + +Тож фрагмент: + +{% raw %} + +```jinja + +``` + +{% endraw %} + +...згенерує посилання на той самий URL, який оброблятиме *функція операції шляху* `read_item(id=id)`. + +Наприклад, з ID `42` це буде відображено як: + +```html + +``` + +## Шаблони і статичні файли { #templates-and-static-files } + +Ви також можете використовувати `url_for()` у шаблоні, наприклад з `StaticFiles`, які ви змонтували з `name="static"`. + +```jinja hl_lines="4" +{!../../docs_src/templates/templates/item.html!} +``` + +У цьому прикладі це посилатиметься на файл CSS у `static/styles.css` за допомогою: + +```CSS hl_lines="4" +{!../../docs_src/templates/static/styles.css!} +``` + +І оскільки ви використовуєте `StaticFiles`, цей файл CSS буде автоматично обслуговуватись вашим застосунком **FastAPI** за URL `/static/styles.css`. + +## Детальніше { #more-details } + +Докладніше, зокрема як тестувати шаблони, дивіться документацію Starlette щодо шаблонів. diff --git a/docs/uk/docs/advanced/testing-dependencies.md b/docs/uk/docs/advanced/testing-dependencies.md new file mode 100644 index 0000000000..3061e745d3 --- /dev/null +++ b/docs/uk/docs/advanced/testing-dependencies.md @@ -0,0 +1,53 @@ +# Тестування залежностей з переписуваннями { #testing-dependencies-with-overrides } + +## Переписування залежностей під час тестування { #overriding-dependencies-during-testing } + +Є сценарії, коли ви можете захотіти переписати залежність під час тестування. + +Ви не хочете запускати оригінальну залежність (ані будь-які її підзалежності). + +Натомість ви хочете надати іншу залежність, яку буде використано лише під час тестів (можливо, тільки в окремих тестах), і яка повертатиме значення, що підставляється всюди, де раніше використовувалося значення оригінальної залежності. + +### Випадки використання: зовнішній сервіс { #use-cases-external-service } + +Наприклад, у вас є зовнішній постачальник автентифікації, який потрібно викликати. + +Ви надсилаєте йому токен, і він повертає автентифікованого користувача. + +Такий постачальник може стягувати плату за кожний запит, а виклик може займати більше часу, ніж використання фіксованого фальшивого користувача для тестів. + +Ймовірно, ви хочете протестувати зовнішнього постачальника один раз, але не обов'язково викликати його для кожного тесту. + +У такому разі ви можете переписати залежність, що викликає цього постачальника, і використати власну залежність, яка повертає фальшивого користувача, лише для ваших тестів. + +### Використовуйте атрибут `app.dependency_overrides` { #use-the-app-dependency-overrides-attribute } + +Для таких випадків ваш застосунок FastAPI має атрибут `app.dependency_overrides`, це простий `dict`. + +Щоб переписати залежність для тестування, вкажіть у ключі оригінальну залежність (функцію), а значенням - ваше переписування залежності (іншу функцію). + +Після цього FastAPI викликатиме це переписування замість оригінальної залежності. + +{* ../../docs_src/dependency_testing/tutorial001_an_py310.py hl[26:27,30] *} + +/// tip | Порада + +Ви можете налаштувати переписування для залежності, яка використовується де завгодно у вашому застосунку FastAPI. + +Оригінальна залежність може використовуватися у функції операції шляху, у декораторі операції шляху (коли ви не використовуєте повернуте значення), у виклику `.include_router()` тощо. + +FastAPI усе одно зможе її переписати. + +/// + +Потім ви можете скинути переписування (видалити їх), встановивши для `app.dependency_overrides` порожній `dict`: + +```Python +app.dependency_overrides = {} +``` + +/// tip | Порада + +Якщо ви хочете переписувати залежність лише під час окремих тестів, встановіть переписування на початку тесту (всередині тестової функції) і скиньте його наприкінці (в кінці тестової функції). + +/// diff --git a/docs/uk/docs/advanced/testing-events.md b/docs/uk/docs/advanced/testing-events.md new file mode 100644 index 0000000000..040b4f756f --- /dev/null +++ b/docs/uk/docs/advanced/testing-events.md @@ -0,0 +1,11 @@ +# Тестування подій: тривалість життя та запуск - вимкнення { #testing-events-lifespan-and-startup-shutdown } + +Коли вам потрібно, щоб `lifespan` виконувався у ваших тестах, ви можете використати `TestClient` з оператором `with`: + +{* ../../docs_src/app_testing/tutorial004_py310.py hl[9:15,18,27:28,30:32,41:43] *} + +Ви можете прочитати більше у [«Запуск тривалості життя у тестах на офіційному сайті документації Starlette.»](https://www.starlette.dev/lifespan/#running-lifespan-in-tests) + +Для застарілих подій `startup` і `shutdown` ви можете використовувати `TestClient` так: + +{* ../../docs_src/app_testing/tutorial003_py310.py hl[9:12,20:24] *} diff --git a/docs/uk/docs/advanced/testing-websockets.md b/docs/uk/docs/advanced/testing-websockets.md new file mode 100644 index 0000000000..cec576fddf --- /dev/null +++ b/docs/uk/docs/advanced/testing-websockets.md @@ -0,0 +1,13 @@ +# Тестування WebSocket { #testing-websockets } + +Ви можете використовувати той самий `TestClient` для тестування WebSocket. + +Для цього використайте `TestClient` в інструкції `with`, підключаючись до WebSocket: + +{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *} + +/// note | Примітка + +Докладніше дивіться документацію Starlette з тестування WebSocket. + +/// diff --git a/docs/uk/docs/advanced/using-request-directly.md b/docs/uk/docs/advanced/using-request-directly.md new file mode 100644 index 0000000000..81b90f19b9 --- /dev/null +++ b/docs/uk/docs/advanced/using-request-directly.md @@ -0,0 +1,55 @@ +# Використання Request безпосередньо { #using-the-request-directly } + +Дотепер ви оголошували потрібні вам частини запиту разом з їх типами. + +Отримуючи дані з: +- шляху як параметрів; +- заголовків; +- кукі; +- тощо. + +І таким чином **FastAPI** перевіряє ці дані, перетворює їх і автоматично генерує документацію для вашого API. + +Але бувають ситуації, коли може знадобитися доступ до об'єкта `Request` безпосередньо. + +## Деталі про об'єкт `Request` { #details-about-the-request-object } + +Оскільки під капотом **FastAPI** - це **Starlette** з шаром інструментів зверху, ви можете за потреби використовувати об'єкт `Request` Starlette безпосередньо. + +Це також означає, що якщо ви отримуєте дані безпосередньо з об'єкта `Request` (наприклад, читаєте тіло), FastAPI не буде їх перевіряти, перетворювати або документувати (через OpenAPI для автоматичного інтерфейсу користувача API). + +Водночас будь-який інший параметр, оголошений звичайним способом (наприклад, тіло з моделлю Pydantic), і надалі буде перевірений, перетворений, анотований тощо. + +Але є окремі випадки, коли корисно отримати об'єкт `Request`. + +## Використовуйте об'єкт `Request` безпосередньо { #use-the-request-object-directly } + +Припустімо, ви хочете отримати IP-адресу/хост клієнта всередині вашої функції операції шляху. + +Для цього потрібно звернутися до запиту безпосередньо. + +{* ../../docs_src/using_request_directly/tutorial001_py310.py hl[1,7:8] *} + +Якщо вказати у функції операції шляху параметр типу `Request`, **FastAPI** передасть у нього об'єкт `Request`. + +/// tip | Порада + +Зауважте, що в цьому прикладі ми оголошуємо параметр шляху поряд із параметром запиту. + +Тому параметр шляху буде витягнуто, перевірено, перетворено до вказаного типу та анотовано в OpenAPI. + +Так само ви можете оголошувати будь-які інші параметри звичайним чином і додатково отримувати `Request`. + +/// + +## Документація `Request` { #request-documentation } + +Докладніше про об'єкт `Request` на офіційному сайті документації Starlette. + +/// note | Технічні деталі + +Ви також можете використати `from starlette.requests import Request`. + +**FastAPI** надає його безпосередньо як зручність для вас, розробника. Але він походить безпосередньо із Starlette. + +/// diff --git a/docs/uk/docs/advanced/websockets.md b/docs/uk/docs/advanced/websockets.md new file mode 100644 index 0000000000..21bb61d7e9 --- /dev/null +++ b/docs/uk/docs/advanced/websockets.md @@ -0,0 +1,186 @@ +# WebSockets { #websockets } + +Ви можете використовувати WebSockets з **FastAPI**. + +## Встановіть `websockets` { #install-websockets } + +Переконайтеся, що ви створили [віртуальне оточення](../virtual-environments.md){.internal-link target=_blank}, активували його та встановили `websockets` (бібліотеку Python, що полегшує використання протоколу «WebSocket»): + +
+ +```console +$ pip install websockets + +---> 100% +``` + +
+ +## Клієнт WebSockets { #websockets-client } + +### У продакшені { #in-production } + +У вашій продакшен-системі у вас, напевно, є фронтенд, створений за допомогою сучасного фреймворку на кшталт React, Vue.js або Angular. + +Для спілкування через WebSockets з бекендом ви, ймовірно, використовуватимете утиліти вашого фронтенду. + +Або у вас може бути нативний мобільний застосунок, що напряму спілкується з вашим WebSocket-бекендом нативним кодом. + +Або будь-який інший спосіб спілкування з кінцевою точкою WebSocket. + +--- + +Але для цього прикладу ми використаємо дуже простий HTML-документ з невеликим JavaScript, усе всередині довгого рядка. + +Звісно, це не оптимально і ви б не використовували це у продакшені. + +У продакшені ви б використали один з варіантів вище. + +Але це найпростіший спосіб зосередитися на серверній частині WebSockets і мати робочий приклад: + +{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *} + +## Створіть `websocket` { #create-a-websocket } + +У вашому застосунку **FastAPI** створіть `websocket`: + +{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *} + +/// note | Технічні деталі + +Ви також можете використати `from starlette.websockets import WebSocket`. + +**FastAPI** надає той самий `WebSocket` напряму як зручність для вас, розробника. Але він походить безпосередньо зі Starlette. + +/// + +## Очікуйте повідомлення та надсилайте повідомлення { #await-for-messages-and-send-messages } + +У вашому маршруті WebSocket ви можете `await` повідомлення і надсилати повідомлення. + +{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *} + +Ви можете отримувати та надсилати бінарні, текстові та JSON-дані. + +## Спробуйте { #try-it } + +Якщо ваш файл називається `main.py`, запустіть ваш застосунок командою: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Відкрийте у браузері http://127.0.0.1:8000. + +Ви побачите просту сторінку на кшталт: + + + +Ви можете вводити повідомлення у поле вводу та надсилати їх: + + + +І ваш застосунок **FastAPI** з WebSockets відповість: + + + +Ви можете надсилати (і отримувати) багато повідомлень: + + + +І всі вони використовуватимуть те саме з'єднання WebSocket. + +## Використання `Depends` та іншого { #using-depends-and-others } + +У кінцевих точках WebSocket ви можете імпортувати з `fastapi` і використовувати: + +* `Depends` +* `Security` +* `Cookie` +* `Header` +* `Path` +* `Query` + +Вони працюють так само, як для інших ендпойнтів FastAPI/*операцій шляху*: + +{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *} + +/// info + +Оскільки це WebSocket, не має сенсу піднімати `HTTPException`, натомість ми піднімаємо `WebSocketException`. + +Ви можете використати код закриття з чинних кодів, визначених у специфікації. + +/// + +### Спробуйте WebSockets із залежностями { #try-the-websockets-with-dependencies } + +Якщо ваш файл називається `main.py`, запустіть ваш застосунок командою: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Відкрийте у браузері http://127.0.0.1:8000. + +Там ви можете встановити: + +* «Item ID», який використовується у шляху. +* «Token», який використовується як параметр запиту. + +/// tip + +Зверніть увагу, що параметр запиту `token` буде оброблено залежністю. + +/// + +Після цього ви зможете під'єднати WebSocket, а далі надсилати й отримувати повідомлення: + + + +## Обробка відключень і кількох клієнтів { #handling-disconnections-and-multiple-clients } + +Коли з'єднання WebSocket закривається, `await websocket.receive_text()` підніме виняток `WebSocketDisconnect`, який ви можете перехопити й обробити, як у цьому прикладі. + +{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *} + +Щоб спробувати: + +* Відкрийте застосунок у кількох вкладках браузера. +* Надсилайте з них повідомлення. +* Потім закрийте одну з вкладок. + +Це підніме виняток `WebSocketDisconnect`, і всі інші клієнти отримають повідомлення на кшталт: + +``` +Client #1596980209979 left the chat +``` + +/// tip + +Застосунок вище - це мінімальний і простий приклад, що демонструє, як обробляти та розсилати повідомлення кільком з'єднанням WebSocket. + +Але майте на увазі, що оскільки все обробляється в пам'яті, в одному списку, це працюватиме лише поки процес запущений, і лише з одним процесом. + +Якщо вам потрібне щось просте для інтеграції з FastAPI, але більш надійне, з підтримкою Redis, PostgreSQL чи інших, перегляньте encode/broadcaster. + +/// + +## Детальніше { #more-info } + +Щоб дізнатися більше про можливості, перегляньте документацію Starlette: + +* Клас `WebSocket`. +* Обробка WebSocket на основі класів. diff --git a/docs/uk/docs/advanced/wsgi.md b/docs/uk/docs/advanced/wsgi.md new file mode 100644 index 0000000000..8969241350 --- /dev/null +++ b/docs/uk/docs/advanced/wsgi.md @@ -0,0 +1,51 @@ +# Підключення WSGI - Flask, Django та інші { #including-wsgi-flask-django-others } + +Ви можете монтувати застосунки WSGI, як ви бачили в [Підзастосунки - монтування](sub-applications.md){.internal-link target=_blank}, [За представником](behind-a-proxy.md){.internal-link target=_blank}. + +Для цього ви можете використати `WSGIMiddleware` і обгорнути ним ваш застосунок WSGI, наприклад Flask, Django тощо. + +## Використання `WSGIMiddleware` { #using-wsgimiddleware } + +/// info | Інформація + +Для цього потрібно встановити `a2wsgi`, наприклад за допомогою `pip install a2wsgi`. + +/// + +Потрібно імпортувати `WSGIMiddleware` з `a2wsgi`. + +Потім обгорніть застосунок WSGI (напр., Flask) цим проміжним програмним забезпеченням. + +І змонтуйте його під певним шляхом. + +{* ../../docs_src/wsgi/tutorial001_py310.py hl[1,3,23] *} + +/// note | Примітка + +Раніше рекомендувалося використовувати `WSGIMiddleware` з `fastapi.middleware.wsgi`, але тепер його визнано застарілим. + +Замість цього радимо використовувати пакет `a2wsgi`. Використання залишається таким самим. + +Просто переконайтеся, що у вас встановлено пакет `a2wsgi`, і імпортуйте `WSGIMiddleware` коректно з `a2wsgi`. + +/// + +## Перевірте { #check-it } + +Тепер кожен запит за шляхом `/v1/` оброблятиметься застосунком Flask. + +А решта - **FastAPI**. + +Якщо ви запустите це й перейдете на http://localhost:8000/v1/, ви побачите відповідь від Flask: + +```txt +Hello, World from Flask! +``` + +А якщо ви перейдете на http://localhost:8000/v2, ви побачите відповідь від FastAPI: + +```JSON +{ + "message": "Hello World" +} +``` diff --git a/docs/uk/docs/async.md b/docs/uk/docs/async.md new file mode 100644 index 0000000000..baf4720542 --- /dev/null +++ b/docs/uk/docs/async.md @@ -0,0 +1,444 @@ +# Рівночасність і async / await { #concurrency-and-async-await } + +Деталі щодо синтаксису `async def` для функцій операції шляху і деякі відомості про асинхронний код, рівночасність і паралелізм. + +## Поспішаєте? { #in-a-hurry } + +TL;DR: + +Якщо ви використовуєте сторонні бібліотеки, які вимагають виклику з `await`, наприклад: + +```Python +results = await some_library() +``` + +Тоді оголошуйте ваші функції операції шляху з `async def`, наприклад: + +```Python hl_lines="2" +@app.get('/') +async def read_results(): + results = await some_library() + return results +``` + +/// note | Примітка + +Ви можете використовувати `await` лише всередині функцій, створених з `async def`. + +/// + +--- + +Якщо ви використовуєте сторонню бібліотеку, яка взаємодіє з чимось (база даних, API, файлова система тощо) і не підтримує використання `await` (наразі це стосується більшості бібліотек баз даних), тоді оголошуйте ваші функції операції шляху як зазвичай, просто з `def`, наприклад: + +```Python hl_lines="2" +@app.get('/') +def results(): + results = some_library() + return results +``` + +--- + +Якщо ваш застосунок (якимось чином) не має комунікувати з чимось іншим і чекати на відповідь, використовуйте `async def`, навіть якщо вам не потрібно використовувати `await` всередині. + +--- + +Якщо ви не певні, використовуйте звичайний `def`. + +--- + +Примітка: ви можете змішувати `def` і `async def` у ваших функціях операції шляху скільки завгодно і визначати кожну з них найкращим для вас способом. FastAPI зробить з ними все правильно. + +У будь-якому з наведених випадків FastAPI все одно працюватиме асинхронно і буде надзвичайно швидким. + +Але слідуючи крокам вище, він зможе зробити деякі оптимізації продуктивності. + +## Технічні деталі { #technical-details } + +Сучасні версії Python мають підтримку «асинхронного коду» за допомогою так званих «співпрограм» з синтаксисом **`async` і `await`**. + +Розгляньмо цю фразу по частинах у секціях нижче: + +- Асинхронний код +- `async` і `await` +- Співпрограми + +## Асинхронний код { #asynchronous-code } + +Асинхронний код означає, що мова 💬 має спосіб сказати комп’ютеру/програмі 🤖, що в певний момент у коді він 🤖 має почекати, поки «щось інше» завершиться десь ще. Скажімо, це «щось інше» називається «slow-file» 📝. + +Отже, в цей час комп’ютер може піти і зробити іншу роботу, доки «slow-file» 📝 завершується. + +Далі комп’ютер/програма 🤖 повертатиметься щоразу, коли матиме можливість, бо знову чекає, або коли він 🤖 завершив усю роботу, яка була в нього на той момент. І він 🤖 перевірить, чи якась із задач, на які він чекав, уже завершилася, виконавши все, що потрібно. + +Потім він 🤖 бере першу завершену задачу (скажімо, наш «slow-file» 📝) і продовжує робити те, що потрібно було зробити з нею. + +Це «чекати на щось інше» зазвичай стосується операцій I/O, які відносно «повільні» (порівняно зі швидкістю процесора та пам’яті з довільним доступом), наприклад, очікування: + +- даних від клієнта, що надсилаються мережею +- даних, надісланих вашим застосунком, які клієнт має отримати мережею +- вмісту файла на диску, який система має прочитати і передати вашому застосунку +- вмісту, який ваш застосунок передав системі, щоб він був записаний на диск +- віддаленої операції API +- завершення операції бази даних +- повернення результатів запиту до бази даних +- тощо + +Оскільки час виконання переважно витрачається на очікування операцій I/O, їх називають операціями «I/O bound». + +Це називається «асинхронним», тому що комп’ютеру/програмі не потрібно бути «синхронізованими» з повільною задачею, очікуючи точного моменту її завершення, нічого не роблячи, лише щоб отримати результат задачі та продовжити роботу. + +Натомість, у «асинхронній» системі щойно завершена задача може трохи зачекати в черзі (кілька мікросекунд), доки комп’ютер/програма завершить те, що пішов робити, а потім повернеться, щоб забрати результати і продовжити роботу з ними. + +Для «синхронного» (на противагу «асинхронному») часто також використовують термін «послідовний», бо комп’ютер/програма слідує всім крокам послідовно, перш ніж перемкнутися на іншу задачу, навіть якщо ці кроки включають очікування. + +### Рівночасність і бургери { #concurrency-and-burgers } + +Ідею **асинхронного** коду, описану вище, інколи також називають **«рівночасністю»**. Вона відрізняється від **«паралелізму»**. + +І рівночасність, і паралелізм стосуються «різних речей, що відбуваються більш-менш одночасно». + +Але деталі між рівночасністю і паралелізмом досить різні. + +Щоб побачити різницю, уявімо таку історію про бургери: + +### Рівночасні бургери { #concurrent-burgers } + +Ви йдете зі своєю симпатією по фастфуд, стаєте в чергу, доки касир приймає замовлення у людей перед вами. 😍 + + + +Потім ваша черга, ви замовляєте 2 дуже вишукані бургери для вашої симпатії і для себе. 🍔🍔 + + + +Касир каже щось кухарю на кухні, щоб той знав, що треба приготувати ваші бургери (хоча зараз він готує бургери для попередніх клієнтів). + + + +Ви платите. 💸 + +Касир дає вам номер вашої черги. + + + +Поки ви чекаєте, ви з вашою симпатією обираєте столик, сідаєте і довго розмовляєте (адже ваші бургери дуже вишукані і потребують часу на приготування). + +Сидячи за столиком із вашою симпатією, доки чекаєте бургери, ви можете витратити цей час, милуючись тим, яка ваша симпатія класна, мила і розумна ✨😍✨. + + + +Чекаючи і спілкуючись із вашою симпатією, час від часу ви перевіряєте номер на табло біля прилавка, щоб побачити, чи вже ваша черга. + +І от нарешті ваша черга. Ви підходите до прилавка, забираєте бургери і повертаєтеся до столика. + + + +Ви з вашою симпатією їсте бургери і гарно проводите час. ✨ + + + +/// info | Інформація + +Прекрасні ілюстрації від Ketrina Thompson. 🎨 + +/// + +--- + +Уявіть, що в цій історії ви - комп’ютер/програма 🤖. + +Поки ви в черзі, ви просто бездіяльні 😴, чекаєте своєї черги, нічого «продуктивного» не роблячи. Але черга рухається швидко, бо касир лише приймає замовлення (а не готує їх), тож це нормально. + +Коли ж ваша черга, ви виконуєте справді «продуктивну» роботу: переглядаєте меню, вирішуєте, що бажаєте, дізнаєтеся вибір вашої симпатії, платите, перевіряєте, що віддаєте правильну купюру чи картку, що з вас правильно списали кошти, що замовлення містить правильні позиції тощо. + +Але потім, хоча у вас ще немає бургерів, ваша взаємодія з касиром «на паузі» ⏸, бо вам доводиться чекати 🕙, поки бургери будуть готові. + +Втім, відійшовши від прилавка і сівши за столик із номерком, ви можете перемкнути 🔀 увагу на свою симпатію і «попрацювати» ⏯ 🤓 над цим. Тоді ви знову робите щось дуже «продуктивне» - фліртуєте зі своєю симпатією 😍. + +Потім касир 💁 каже «Я закінчив робити бургери», виводячи ваш номер на табло прилавка, але ви не підстрибуєте миттєво, щойно номер змінюється на ваш. Ви знаєте, що ніхто не вкраде ваші бургери, адже у вас є номер вашої черги, а в інших - свій. + +Тож ви чекаєте, поки ваша симпатія завершить історію (завершить поточну роботу ⏯/задачу 🤓), лагідно усміхаєтеся і кажете, що підете за бургерами ⏸. + +Потім ви йдете до прилавка 🔀, до початкової задачі, яку тепер завершено ⏯, забираєте бургери, дякуєте і несете їх до столу. Це завершує той крок/задачу взаємодії з прилавком ⏹. Натомість з’являється нова задача «їсти бургери» 🔀 ⏯, але попередня «отримати бургери» завершена ⏹. + +### Паралельні бургери { #parallel-burgers } + +А тепер уявімо, що це не «рівночасні бургери», а «паралельні бургери». + +Ви йдете зі своєю симпатією по паралельний фастфуд. + +Ви стаєте в чергу, поки кілька (скажімо, 8) касирів, які водночас є кухарями, приймають замовлення у людей перед вами. + +Кожен перед вами чекає, поки його бургери будуть готові, перш ніж відійти від прилавка, тому що кожен з 8 касирів одразу йде і готує бургер, перш ніж приймати наступне замовлення. + + + +Нарешті ваша черга, ви замовляєте 2 дуже вишукані бургери для вашої симпатії і для себе. + +Ви платите 💸. + + + +Касир іде на кухню. + +Ви чекаєте, стоячи перед прилавком 🕙, щоб ніхто інший не забрав ваші бургери раніше, ніж ви, адже номерків черги немає. + + + +Оскільки ви з вашою симпатією зайняті тим, щоб ніхто не став перед вами і не забрав ваші бургери, щойно вони з’являться, ви не можете приділяти увагу своїй симпатії. 😞 + +Це «синхронна» робота, ви «синхронізовані» з касиром/кухарем 👨‍🍳. Вам доводиться чекати 🕙 і бути тут у точний момент, коли касир/кухар 👨‍🍳 завершить бургери і віддасть їх вам, інакше хтось інший може їх забрати. + + + +Потім ваш касир/кухар 👨‍🍳 нарешті повертається з вашими бургерами після довгого очікування 🕙 перед прилавком. + + + +Ви берете бургери і йдете до столика зі своєю симпатією. + +Ви просто їх їсте - і все. ⏹ + + + +Багато розмов чи флірту не було, бо більшість часу пішла на очікування 🕙 перед прилавком. 😞 + +/// info | Інформація + +Прекрасні ілюстрації від Ketrina Thompson. 🎨 + +/// + +--- + +У цьому сценарії паралельних бургерів ви - комп’ютер/програма 🤖 з двома процесорами (ви і ваша симпатія), які обидва чекають 🕙 і приділяють увагу ⏯ «очікуванню біля прилавка» 🕙 тривалий час. + +У закладу фастфуду 8 процесорів (касира/кухаря). У той час як у закладі з рівночасними бургерами могло бути лише 2 (один касир і один кухар). + +Та все одно фінальний досвід не найкращий. 😞 + +--- + +Це була б паралельна історія про бургери. 🍔 + +Для більш «реального» прикладу уявіть банк. + +До недавнього часу більшість банків мали кілька касирів 👨‍💼👨‍💼👨‍💼👨‍💼 і велику чергу 🕙🕙🕙🕙🕙🕙🕙🕙. + +Усі касири робили всю роботу з одним клієнтом за іншим 👨‍💼⏯. + +І вам доводилося 🕙 довго стояти в черзі, інакше ви втратите свою чергу. + +Ви, напевно, не хотіли б брати свою симпатію 😍 із собою у справи до банку 🏦. + +### Висновок про бургери { #burger-conclusion } + +У цьому сценарії «фастфуд із вашою симпатією», оскільки є багато очікування 🕙, значно доцільніше мати рівночасну систему ⏸🔀⏯. + +Так є у більшості вебзастосунків. + +Багато-багато користувачів, але ваш сервер чекає 🕙 на їхнє не надто гарне з’єднання, щоб вони надіслали свої запити. + +А потім знову чекає 🕙 на повернення відповідей. + +Це «очікування» 🕙 вимірюється у мікросекундах, але все ж, у сумі - це багато очікування в підсумку. + +Ось чому дуже логічно використовувати асинхронний ⏸🔀⏯ код для веб API. + +Такий тип асинхронності зробив NodeJS популярним (хоча NodeJS не є паралельним), і це сила Go як мови програмування. + +І такий самий рівень продуктивності ви отримуєте з **FastAPI**. + +А оскільки можна мати паралелізм і асинхронність одночасно, ви отримуєте вищу продуктивність, ніж більшість протестованих фреймворків NodeJS, і на рівні з Go, який є компільованою мовою, ближчою до C (усе завдяки Starlette). + +### Чи краща рівночасність за паралелізм? { #is-concurrency-better-than-parallelism } + +Ні! Це не мораль історії. + +Рівночасність відрізняється від паралелізму. І вона краща у конкретних сценаріях, що містять багато очікування. Через це зазвичай вона значно краща за паралелізм для розробки вебзастосунків. Але не для всього. + +Щоб урівноважити це, уявімо коротку історію: + +> Ви маєте прибрати великий брудний будинок. + +*Так, це вся історія*. + +--- + +Тут немає очікування 🕙 - просто багато роботи, яку треба зробити, у багатьох місцях будинку. + +У вас могли б бути «черги» як у прикладі з бургерами: спочатку вітальня, потім кухня. Але оскільки ви ні на що не чекаєте 🕙, а просто прибираєте, «черги» нічого не змінять. + +Завершення займе той самий час із «чергами» чи без (рівночасність), і ви виконаєте той самий обсяг роботи. + +Але в цьому випадку, якби ви могли привести 8 колишніх касирів/кухарів/тепер прибиральників, і кожен з них (разом із вами) взяв би свою зону будинку для прибирання, ви могли б виконати всю роботу паралельно — з додатковою допомогою — і завершити значно швидше. + +У цьому сценарії кожен з прибиральників (включно з вами) був би процесором, що виконує свою частину роботи. + +І оскільки більшість часу виконання займає реальна робота (а не очікування), а роботу на комп’ютері виконує CPU, ці проблеми називають «CPU bound». + +--- + +Поширені приклади «CPU bound» операцій - це речі, що потребують складної математичної обробки. + +Наприклад: + +- **Обробка аудіо** або **зображень**. +- **Комп’ютерний зір**: зображення складається з мільйонів пікселів, кожен піксель має 3 значення/кольори, обробка зазвичай потребує обчислення чогось над цими пікселями, усіма одночасно. +- **Машинне навчання**: зазвичай потребує великої кількості множень «матриць» і «векторів». Уявіть величезну таблицю з числами і множення всіх їх разом одночасно. +- **Глибоке навчання**: це підгалузь машинного навчання, тож те саме застосовується. Просто тут не одна таблиця чисел для множення, а величезний їх набір, і в багатьох випадках ви використовуєте спеціальний процесор для побудови та/або використання цих моделей. + +### Рівночасність + паралелізм: веб + машинне навчання { #concurrency-parallelism-web-machine-learning } + +З **FastAPI** ви можете скористатися рівночасністю, що дуже поширена у веброзробці (та ж головна принада NodeJS). + +Але ви також можете використати переваги паралелізму і багатопроцесорності (наявність кількох процесів, що працюють паралельно) для навантажень «CPU bound», як у системах машинного навчання. + +Це, плюс простий факт, що Python є основною мовою для **Data Science**, машинного навчання і особливо глибокого навчання, робить FastAPI дуже вдалим вибором для веб API та застосунків Data Science / машинного навчання (серед багатьох інших). + +Щоб побачити, як досягти цього паралелізму у продакшні, див. розділ про [Розгортання](deployment/index.md){.internal-link target=_blank}. + +## `async` і `await` { #async-and-await } + +Сучасні версії Python мають дуже інтуїтивний спосіб визначення асинхронного коду. Це робить його схожим на звичайний «послідовний» код і виконує «очікування» за вас у відповідні моменти. + +Коли є операція, яка вимагатиме очікування перед поверненням результатів і має підтримку цих нових можливостей Python, ви можете написати її так: + +```Python +burgers = await get_burgers(2) +``` + +Ключ тут - `await`. Він каже Python, що потрібно почекати ⏸, поки `get_burgers(2)` завершить свою роботу 🕙, перш ніж зберегти результати в `burgers`. Завдяки цьому Python знатиме, що може піти і зробити щось інше 🔀 ⏯ тим часом (наприклад, прийняти інший запит). + +Щоб `await` працював, він має бути всередині функції, що підтримує цю асинхронність. Для цього просто оголосіть її як `async def`: + +```Python hl_lines="1" +async def get_burgers(number: int): + # Виконайте деякі асинхронні дії, щоб створити бургери + return burgers +``` + +...замість `def`: + +```Python hl_lines="2" +# Це не асинхронно +def get_sequential_burgers(number: int): + # Виконайте деякі послідовні дії, щоб створити бургери + return burgers +``` + +З `async def` Python знає, що всередині цієї функції він має відслідковувати вирази `await`, і що він може «ставити на паузу» ⏸ виконання цієї функції і йти робити щось інше 🔀, перш ніж повернутися. + +Коли ви хочете викликати функцію, визначену з `async def`, ви маєте «очікувати» її. Тож це не спрацює: + +```Python +# Це не спрацює, тому що get_burgers визначено як: async def +burgers = get_burgers(2) +``` + +--- + +Отже, якщо ви використовуєте бібліотеку, яку можна викликати з `await`, вам потрібно створити функцію операції шляху, що її використовує, з `async def`, як тут: + +```Python hl_lines="2-3" +@app.get('/burgers') +async def read_burgers(): + burgers = await get_burgers(2) + return burgers +``` + +### Більше технічних деталей { #more-technical-details } + +Ви могли помітити, що `await` можна використовувати лише всередині функцій, визначених з `async def`. + +А водночас функції, визначені з `async def`, потрібно «очікувати». Тож функції з `async def` також можна викликати лише всередині функцій, визначених з `async def`. + +Тож як же викликати першу `async`-функцію - курка чи яйце? + +Якщо ви працюєте з **FastAPI**, вам не потрібно про це турбуватися, адже цією «першою» функцією буде ваша функція операції шляху, і FastAPI знатиме, як учинити правильно. + +Але якщо ви хочете використовувати `async` / `await` без FastAPI, ви також можете це зробити. + +### Пишемо свій власний async-код { #write-your-own-async-code } + +Starlette (і **FastAPI**) базуються на AnyIO, що робить їх сумісними як зі стандартною бібліотекою Python asyncio, так і з Trio. + +Зокрема, ви можете безпосередньо використовувати AnyIO для ваших просунутих сценаріїв рівночасності, що потребують складніших патернів у вашому коді. + +І навіть якщо ви не використовували FastAPI, ви могли б писати свої власні async-застосунки з AnyIO, щоб мати високу сумісність і отримати його переваги (наприклад, *структурована рівночасність*). + +Я створив іншу бібліотеку поверх AnyIO, як тонкий шар, щоб дещо покращити анотації типів і отримати кращу **автодопомогу** (autocompletion), **вбудовані помилки** (inline errors) тощо. Вона також має дружній вступ і навчальний посібник, щоб допомогти вам **зрозуміти** і написати **власний async-код**: Asyncer. Вона буде особливо корисною, якщо вам потрібно **поєднувати async-код зі звичайним** (блокуючим/синхронним) кодом. + +### Інші форми асинхронного коду { #other-forms-of-asynchronous-code } + +Такий стиль використання `async` і `await` відносно новий у мові. + +Але він значно полегшує роботу з асинхронним кодом. + +Такий самий (або майже ідентичний) синтаксис нещодавно з’явився в сучасних версіях JavaScript (у Browser і NodeJS). + +До цього робота з асинхронним кодом була значно складнішою. + +У попередніх версіях Python ви могли використовувати потоки (threads) або Gevent. Але код набагато складніший для розуміння, налагодження і мислення про нього. + +У попередніх версіях NodeJS/Browser JavaScript ви б використовували «callbacks», що призводить до «callback hell». + +## Співпрограми { #coroutines } + +**Співпрограма** - це просто дуже вишукана назва для об’єкта, який повертає функція `async def`. Python знає, що це щось на кшталт функції, яку можна запустити і яка завершиться в певний момент, але яку також можна поставити на паузу ⏸ всередині, коли є `await`. + +Але всю цю функціональність використання асинхронного коду з `async` і `await` часто підсумовують як використання «співпрограм». Це порівняно з головною ключовою особливістю Go - «Goroutines». + +## Висновок { #conclusion } + +Погляньмо на ту саму фразу ще раз: + +> Сучасні версії Python мають підтримку «асинхронного коду» за допомогою так званих «співпрограм», з синтаксисом **`async` і `await`**. + +Тепер це має більше сенсу. ✨ + +Усе це приводить у дію FastAPI (через Starlette) і дає йому таку вражаючу продуктивність. + +## Дуже технічні деталі { #very-technical-details } + +/// warning | Попередження + +Ймовірно, ви можете пропустити це. + +Це дуже технічні деталі про те, як **FastAPI** працює «під капотом». + +Якщо у вас є чимало технічних знань (співпрограми, потоки, блокування тощо) і вам цікаво, як FastAPI обробляє `async def` проти звичайного `def`, - вперед. + +/// + +### Функції операції шляху { #path-operation-functions } + +Коли ви оголошуєте функцію операції шляху зі звичайним `def` замість `async def`, вона виконується у зовнішньому пулі потоків (threadpool), який потім «очікується», замість прямого виклику (оскільки прямий виклик блокував би сервер). + +Якщо ви прийшли з іншого async-фреймворку, який не працює так, як описано вище, і звикли визначати тривіальні, лише обчислювальні функції операції шляху зі звичайним `def` заради крихітного виграшу у продуктивності (близько 100 наносекунд), зверніть увагу, що у **FastAPI** ефект буде протилежним. У таких випадках краще використовувати `async def`, якщо тільки ваші функції операції шляху не використовують код, що виконує блокуюче I/O. + +Втім, у будь-якій ситуації є велика ймовірність, що **FastAPI** [все одно буде швидшим](index.md#performance){.internal-link target=_blank} (або принаймні порівнянним) за ваш попередній фреймворк. + +### Залежності { #dependencies } + +Те саме стосується і [залежностей](tutorial/dependencies/index.md){.internal-link target=_blank}. Якщо залежність є стандартною функцією `def` замість `async def`, вона виконується у зовнішньому пулі потоків. + +### Підзалежності { #sub-dependencies } + +Ви можете мати кілька залежностей і [підзалежностей](tutorial/dependencies/sub-dependencies.md){.internal-link target=_blank}, які вимагають одна одну (як параметри визначень функцій). Деякі з них можуть бути створені з `async def`, а деякі - зі звичайним `def`. Все працюватиме, і ті, що створені зі звичайним `def`, будуть викликані у зовнішньому потоці (з пулу потоків), а не «очікувані». + +### Інші допоміжні функції { #other-utility-functions } + +Будь-яка інша допоміжна функція, яку ви викликаєте безпосередньо, може бути створена зі звичайним `def` або `async def`, і FastAPI не впливатиме на спосіб її виклику. + +Це відрізняється від функцій, які FastAPI викликає за вас: функції операції шляху і залежності. + +Якщо ваша допоміжна функція є звичайною функцією з `def`, її буде викликано безпосередньо (як ви написали у своєму коді), не в пулі потоків; якщо функція створена з `async def`, тоді вам слід використовувати `await` при її виклику у вашому коді. + +--- + +Знову ж таки, це дуже технічні деталі, які, ймовірно, стануть у пригоді, якщо ви спеціально їх шукали. + +Інакше вам вистачить настанов із розділу вище: Поспішаєте?. diff --git a/docs/uk/docs/benchmarks.md b/docs/uk/docs/benchmarks.md new file mode 100644 index 0000000000..d53b7ee989 --- /dev/null +++ b/docs/uk/docs/benchmarks.md @@ -0,0 +1,34 @@ +# Бенчмарки { #benchmarks } + +Незалежні бенчмарки TechEmpower показують, що застосунки FastAPI, запущені під керуванням Uvicorn, є одним із найшвидших доступних фреймворків Python, поступаючись лише самим Starlette і Uvicorn (використовуються FastAPI внутрішньо). + +Але переглядаючи бенчмарки та порівняння, майте на увазі таке. + +## Бенчмарки та швидкість { #benchmarks-and-speed } + +Під час перегляду бенчмарків часто порівнюють кілька інструментів різних типів як рівноцінні. + +Зокрема, разом порівнюють Uvicorn, Starlette і FastAPI (серед багатьох інших інструментів). + +Чим простіше завдання, яке розв'язує інструмент, тим кращою буде продуктивність. І більшість бенчмарків не перевіряють додаткові можливості, що надає інструмент. + +Ієрархія приблизно така: + +* Uvicorn: сервер ASGI + * Starlette: (використовує Uvicorn) веб-мікрофреймворк + * FastAPI: (використовує Starlette) мікрофреймворк для API з низкою додаткових можливостей для створення API, з валідацією даних тощо. + +* Uvicorn: + * Матиме найвищу продуктивність, адже майже не містить додаткового коду окрім власне сервера. + * Ви не писатимете застосунок безпосередньо на Uvicorn. Це означало б, що ваш код мав би включати принаймні приблизно весь код, який надає Starlette (або FastAPI). І якщо зробити так, ваш кінцевий застосунок матиме ті самі накладні витрати, що й під час використання фреймворку, який мінімізує код застосунку та помилки. + * Якщо ви порівнюєте Uvicorn, порівнюйте його з Daphne, Hypercorn, uWSGI тощо. Сервери застосунків. +* Starlette: + * Матиме наступну за швидкістю продуктивність після Uvicorn. Насправді Starlette використовує Uvicorn для запуску. Тож вона може бути «повільнішою» за Uvicorn лише через необхідність виконувати більше коду. + * Але надає інструменти для створення простих веб-застосунків із маршрутизацією на основі шляхів тощо. + * Якщо ви порівнюєте Starlette, порівнюйте її з Sanic, Flask, Django тощо. Веб-фреймворки (або мікрофреймворки). +* FastAPI: + * Аналогічно до того, як Starlette використовує Uvicorn і не може бути швидшою за нього, FastAPI використовує Starlette, тож не може бути швидшою за неї. + * FastAPI надає більше можливостей поверх Starlette. Можливості, які майже завжди потрібні під час створення API, як-от валідація та серіалізація даних. І, використовуючи його, ви безкоштовно отримуєте автоматичну документацію (автоматична документація навіть не додає накладних витрат під час роботи застосунку - вона генерується під час запуску). + * Якби ви не використовували FastAPI і застосували Starlette безпосередньо (або інший інструмент, наприклад Sanic, Flask, Responder тощо), вам довелося б самостійно реалізувати всю валідацію та серіалізацію даних. Тож ваш кінцевий застосунок усе одно мав би ті самі накладні витрати, ніби він був створений із використанням FastAPI. І в багатьох випадках саме ця валідація та серіалізація даних становить найбільший обсяг коду в застосунках. + * Отже, використовуючи FastAPI, ви заощаджуєте час розробки, зменшуєте кількість помилок і рядків коду та, ймовірно, отримуєте таку саму (або кращу) продуктивність, як і без нього (адже інакше вам довелося б реалізувати все це у власному коді). + * Якщо ви порівнюєте FastAPI, порівнюйте його з веб-фреймворком (або набором інструментів), який надає валідацію даних, серіалізацію та документацію, наприклад Flask-apispec, NestJS, Molten тощо. Фреймворки з вбудованою автоматичною валідацією даних, серіалізацією та документацією. diff --git a/docs/uk/docs/deployment/cloud.md b/docs/uk/docs/deployment/cloud.md new file mode 100644 index 0000000000..a17aaf2591 --- /dev/null +++ b/docs/uk/docs/deployment/cloud.md @@ -0,0 +1,24 @@ +# Розгортання FastAPI у хмарних постачальників { #deploy-fastapi-on-cloud-providers } + +Ви можете використовувати практично **будь-якого хмарного постачальника**, щоб розгорнути свій застосунок FastAPI. + +У більшості випадків основні хмарні постачальники мають інструкції з розгортання FastAPI у них. + +## FastAPI Cloud { #fastapi-cloud } + +**FastAPI Cloud** створено тим самим автором і командою, що стоять за **FastAPI**. + +Воно спрощує процес **створення**, **розгортання** та **доступу** до API з мінімальними зусиллями. + +Воно переносить той самий **досвід розробника** зі створення застосунків із FastAPI на їх **розгортання** у хмарі. 🎉 + +FastAPI Cloud є основним спонсором і джерелом фінансування проєктів з відкритим кодом *FastAPI and friends*. ✨ + +## Хмарні постачальники - спонсори { #cloud-providers-sponsors } + +Деякі інші хмарні постачальники ✨ [**спонсорують FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨ також. 🙇 + +Можливо, ви захочете розглянути їх, щоб дотримуватися їхніх інструкцій і спробувати їхні сервіси: + +* Render +* Railway diff --git a/docs/uk/docs/deployment/concepts.md b/docs/uk/docs/deployment/concepts.md new file mode 100644 index 0000000000..07ad314405 --- /dev/null +++ b/docs/uk/docs/deployment/concepts.md @@ -0,0 +1,321 @@ +# Концепції розгортання { #deployments-concepts } + +Під час розгортання застосунку **FastAPI** (або будь-якого веб-API) є кілька концепцій, які, ймовірно, вас цікавлять, і, спираючись на них, ви зможете знайти **найвідповідніший** спосіб **розгорнути ваш застосунок**. + +Деякі важливі концепції: + +- Безпека - HTTPS +- Запуск під час старту +- Перезапуски +- Реплікація (кількість запущених процесів) +- Пам'ять +- Попередні кроки перед стартом + +Подивимось, як вони впливають на **розгортання**. + +Зрештою головна мета - **обслуговувати клієнтів вашого API** так, щоб це було **безпечним**, з **мінімумом перерв у роботі**, і щоб **обчислювальні ресурси** (наприклад, віддалені сервери/віртуальні машини) використовувалися якомога ефективніше. 🚀 + +Нижче я трохи більше розповім про ці **концепції**, і, сподіваюся, це дасть вам потрібну **інтуїцію**, щоб вирішувати, як розгортати ваш API в дуже різних середовищах, можливо, навіть у **майбутніх**, яких ще не існує. + +Враховуючи ці концепції, ви зможете **оцінювати та проєктувати** найкращий спосіб розгортання **ваших власних API**. + +У наступних розділах я наведу більш **конкретні рецепти** розгортання застосунків FastAPI. + +А поки перегляньмо ці важливі **концептуальні ідеї**. Вони також застосовні до будь-якого іншого типу веб-API. 💡 + +## Безпека - HTTPS { #security-https } + +У [попередньому розділі про HTTPS](https.md){.internal-link target=_blank} ми дізналися, як HTTPS забезпечує шифрування для вашого API. + +Ми також бачили, що HTTPS зазвичай надається компонентом, **зовнішнім** щодо вашого серверного застосунку, - **TLS Termination Proxy**. + +І має бути щось, що відповідає за **оновлення сертифікатів HTTPS** - це може бути той самий компонент або інший. + +### Приклади інструментів для HTTPS { #example-tools-for-https } + +Деякі інструменти, які можна використовувати як TLS Termination Proxy: + +- Traefik + - Автоматично обробляє оновлення сертифікатів ✨ +- Caddy + - Автоматично обробляє оновлення сертифікатів ✨ +- Nginx + - З зовнішнім компонентом на кшталт Certbot для оновлення сертифікатів +- HAProxy + - З зовнішнім компонентом на кшталт Certbot для оновлення сертифікатів +- Kubernetes з Ingress Controller, наприклад Nginx + - З зовнішнім компонентом на кшталт cert-manager для оновлення сертифікатів +- Обробляється внутрішньо хмарним провайдером як частина їхніх сервісів (див. нижче 👇) + +Ще один варіант - використати **хмарний сервіс**, який зробить більше роботи, зокрема налаштує HTTPS. Можуть бути обмеження або додаткова вартість тощо. Але у такому разі вам не потрібно самостійно налаштовувати TLS Termination Proxy. + +У наступних розділах я покажу кілька конкретних прикладів. + +--- + +Далі всі наступні концепції стосуються програми, яка запускає ваш фактичний API (наприклад, Uvicorn). + +## Програма і процес { #program-and-process } + +Ми багато говоритимемо про запущений «процес», тож корисно чітко розуміти, що це означає, і чим відрізняється від слова «програма». + +### Що таке програма { #what-is-a-program } + +Слово **програма** зазвичай вживають для опису багатьох речей: + +- **Код**, який ви пишете, **файли Python**. +- **Файл**, який може бути **виконаний** операційною системою, наприклад: `python`, `python.exe` або `uvicorn`. +- Конкретна програма під час **виконання** в операційній системі, що використовує CPU та зберігає дані в пам'яті. Це також називають **процесом**. + +### Що таке процес { #what-is-a-process } + +Слово **процес** зазвичай використовують у більш специфічному значенні, маючи на увазі саме те, що виконується в операційній системі (як у попередньому пункті): + +- Конкретна програма під час **виконання** в операційній системі. + - Це не про файл і не про код, це **конкретно** про те, що **виконується** та керується операційною системою. +- Будь-яка програма, будь-який код **може щось робити** лише під час **виконання**. Тобто коли **процес запущений**. +- Процес може бути **завершений** (або «kill») вами чи операційною системою. У цей момент він припиняє виконання і **більше нічого не може робити**. +- Кожен застосунок, який працює на вашому комп'ютері, має певний процес за собою: кожна запущена програма, кожне вікно тощо. Зазвичай на комп'ютері одночасно працює **багато процесів**. +- **Кілька процесів** **однієї й тієї самої програми** можуть працювати одночасно. + +Якщо ви відкриєте «диспетчер завдань» або «системний монітор» (чи подібні інструменти) в операційній системі, ви побачите багато таких процесів. + +Наприклад, ви, ймовірно, побачите кілька процесів того самого браузера (Firefox, Chrome, Edge тощо). Зазвичай він запускає один процес на вкладку плюс деякі додаткові процеси. + + + +--- + +Тепер, коли ми знаємо різницю між термінами **процес** і **програма**, продовжимо говорити про розгортання. + +## Запуск під час старту { #running-on-startup } + +У більшості випадків, коли ви створюєте веб-API, ви хочете, щоб він **працював постійно**, без перерв, щоб клієнти завжди мали до нього доступ. Звісно, якщо немає особливих причин запускати його лише в певних ситуаціях. Але зазвичай ви хочете, щоб він постійно працював і був **доступний**. + +### На віддаленому сервері { #in-a-remote-server } + +Коли ви налаштовуєте віддалений сервер (хмарний сервер, віртуальну машину тощо), найпростіше - використовувати `fastapi run` (який використовує Uvicorn) або щось схоже, вручну, так само, як під час локальної розробки. + +І це працюватиме та буде корисним **під час розробки**. + +Але якщо ви втратите з'єднання з сервером, **запущений процес**, найімовірніше, завершиться. + +І якщо сервер буде перезавантажено (наприклад, після оновлень або міграцій у хмарного провайдера), ви, ймовірно, **не помітите цього**. І через це ви навіть не знатимете, що треба вручну перезапустити процес. У результаті ваш API просто залишиться «мертвим». 😱 + +### Автоматичний запуск під час старту { #run-automatically-on-startup } + +Загалом ви, напевно, захочете, щоб серверна програма (наприклад, Uvicorn) запускалася автоматично під час старту сервера і без будь-якого **людського втручання**, щоб завжди був запущений процес із вашим API (наприклад, Uvicorn із вашим FastAPI-застосунком). + +### Окрема програма { #separate-program } + +Щоб цього досягти, зазвичай використовують **окрему програму**, яка гарантує запуск вашого застосунку під час старту. І в багатьох випадках вона також забезпечує запуск інших компонентів або застосунків, наприклад бази даних. + +### Приклади інструментів для запуску під час старту { #example-tools-to-run-at-startup } + +Приклади інструментів, які можуть це робити: + +- Docker +- Kubernetes +- Docker Compose +- Docker у режимі Swarm +- Systemd +- Supervisor +- Обробляється внутрішньо хмарним провайдером як частина їхніх сервісів +- Інші... + +У наступних розділах я наведу більш конкретні приклади. + +## Перезапуски { #restarts } + +Подібно до забезпечення запуску застосунку під час старту системи, ви, ймовірно, також захочете гарантувати його **перезапуск** після збоїв. + +### Ми помиляємося { #we-make-mistakes } + +Ми, люди, постійно робимо **помилки**. Майже завжди у програмному забезпеченні є приховані **помилки**. 🐛 + +І ми як розробники постійно покращуємо код, знаходячи ці помилки та додаючи нові можливості (можливо, теж додаючи нові помилки 😅). + +### Невеликі помилки обробляються автоматично { #small-errors-automatically-handled } + +Створюючи веб-API з FastAPI, якщо в нашому коді є помилка, FastAPI зазвичай обмежує її одним запитом, який цю помилку спровокував. 🛡 + +Клієнт отримає **500 Internal Server Error** для цього запиту, але застосунок продовжить працювати для наступних запитів замість повного краху. + +### Великі помилки - крахи { #bigger-errors-crashes } + +Втім, бувають випадки, коли ми пишемо код, який **падає весь застосунок**, спричиняючи крах Uvicorn і Python. 💥 + +І все ж ви, ймовірно, не захочете, щоб застосунок залишався «мертвим» через помилку в одному місці - ви, напевно, хочете, щоб він **продовжував працювати** принаймні для тих *операцій шляху*, що не зламані. + +### Перезапуск після краху { #restart-after-crash } + +Але в таких випадках із серйозними помилками, що призводять до краху запущеного **процесу**, потрібен зовнішній компонент, відповідальний за **перезапуск** процесу, принаймні кілька разів... + +/// tip | Порада + +...Хоча якщо весь застосунок просто **миттєво падає**, безглуздо перезапускати його безкінечно. Але в таких випадках ви, ймовірно, помітите це під час розробки або принаймні відразу після розгортання. + +Тож зосередьмося на основних випадках, коли у майбутньому він може повністю падати за певних обставин, і тоді все ще має сенс його перезапускати. + +/// + +Ймовірно, ви захочете мати відокремлений **зовнішній компонент**, який відповідає за перезапуск застосунку, адже до того моменту сам застосунок з Uvicorn і Python уже впав, і нічого в тому ж коді цієї ж програми зробити не зможе. + +### Приклади інструментів для автоматичного перезапуску { #example-tools-to-restart-automatically } + +У більшості випадків той самий інструмент, який використовується для **запуску програми під час старту**, також використовується для автоматичних **перезапусків**. + +Наприклад, це можуть забезпечувати: + +- Docker +- Kubernetes +- Docker Compose +- Docker у режимі Swarm +- Systemd +- Supervisor +- Обробляється внутрішньо хмарним провайдером як частина їхніх сервісів +- Інші... + +## Реплікація - процеси та пам'ять { #replication-processes-and-memory } + +У застосунку FastAPI, використовуючи серверну програму, як-от команду `fastapi`, що запускає Uvicorn, один запуск в **одному процесі** може обслуговувати кількох клієнтів рівночасно. + +Але часто ви захочете запускати кілька процесів-працівників одночасно. + +### Кілька процесів - працівники { #multiple-processes-workers } + +Якщо у вас більше клієнтів, ніж може обробити один процес (наприклад, якщо віртуальна машина не надто потужна) і на сервері є **кілька ядер** CPU, тоді ви можете запустити **кілька процесів** із тим самим застосунком паралельно і розподіляти запити між ними. + +Коли ви запускаєте **кілька процесів** того самого програмного забезпечення API, їх зазвичай називають **працівниками** (workers). + +### Процеси-працівники і порти { #worker-processes-and-ports } + +Пам'ятаєте з документації [Про HTTPS](https.md){.internal-link target=_blank}, що на сервері лише один процес може слухати певну комбінацію порту та IP-адреси? + +Це досі так. + +Отже, щоб мати **кілька процесів** одночасно, має бути **єдиний процес, який слухає порт**, і який далі якимось чином передає комунікацію кожному процесу-працівнику. + +### Пам'ять на процес { #memory-per-process } + +Коли програма завантажує щось у пам'ять, наприклад модель машинного навчання в змінну або вміст великого файлу в змінну, все це **споживає частину пам'яті (RAM)** сервера. + +І кілька процесів зазвичай **не діляться пам'яттю**. Це означає, що кожен запущений процес має власні речі, змінні та пам'ять. І якщо у вашому коді споживається багато пам'яті, **кожен процес** споживатиме еквівалентний обсяг пам'яті. + +### Пам'ять сервера { #server-memory } + +Наприклад, якщо ваш код завантажує модель машинного навчання розміром **1 GB**, то при запуску одного процесу з вашим API він споживатиме щонайменше 1 GB RAM. А якщо ви запустите **4 процеси** (4 працівники) - кожен споживатиме 1 GB RAM. Отже, загалом ваш API споживатиме **4 GB RAM**. + +І якщо ваш віддалений сервер або віртуальна машина має лише 3 GB RAM, спроба використати понад 4 GB призведе до проблем. 🚨 + +### Кілька процесів - приклад { #multiple-processes-an-example } + +У цьому прикладі є **керівний процес** (Manager Process), який запускає і контролює два **процеси-працівники**. + +Цей керівний процес, імовірно, саме і слухатиме **порт** на IP. І він передаватиме всю комунікацію процесам-працівникам. + +Ці процеси-працівники виконуватимуть ваш застосунок, здійснюватимуть основні обчислення, щоб отримати **запит** і повернути **відповідь**, і завантажуватимуть усе, що ви зберігаєте в змінних у RAM. + + + +Звісно, на тій самій машині, окрім вашого застосунку, зазвичай працюватимуть **інші процеси**. + +Цікавий момент: відсоток **використання CPU** кожним процесом може сильно **варіюватися** з часом, тоді як **пам'ять (RAM)** зазвичай залишається більш-менш **стабільною**. + +Якщо у вас API, що виконує порівняний обсяг обчислень щоразу і у вас багато клієнтів, тоді **використання CPU** також, ймовірно, буде *стабільним* (замість постійних швидких коливань). + +### Приклади інструментів і стратегій реплікації { #examples-of-replication-tools-and-strategies } + +Є кілька підходів для цього, і про конкретні стратегії я розповім у наступних розділах, наприклад, коли говоритимемо про Docker і контейнери. + +Головне обмеження: має бути **єдиний** компонент, що обробляє **порт** на **публічній IP-адресі**. А тоді він має мати спосіб **передавати** комунікацію реплікованим **процесам/працівникам**. + +Ось кілька можливих комбінацій і стратегій: + +- **Uvicorn** з `--workers` + - Один **менеджер процесів** Uvicorn слухатиме **IP** і **порт** та запускатиме **кілька процесів-працівників Uvicorn**. +- **Kubernetes** та інші розподілені **системи контейнерів** + - Щось на рівні **Kubernetes** слухатиме **IP** і **порт**. Реплікація відбуватиметься через **кілька контейнерів**, у кожному з яких запущено **один процес Uvicorn**. +- **Хмарні сервіси**, що роблять це за вас + - Хмарний сервіс, ймовірно, **забезпечить реплікацію за вас**. Він може дозволяти визначити **процес для запуску** або **образ контейнера** для використання; у будь-якому разі це, найімовірніше, буде **один процес Uvicorn**, а сервіс відповідатиме за його реплікацію. + +/// tip | Порада + +Не хвилюйтеся, якщо деякі пункти про **контейнери**, Docker чи Kubernetes поки що не дуже зрозумілі. + +Я розповім більше про образи контейнерів, Docker, Kubernetes тощо в майбутньому розділі: [FastAPI у контейнерах - Docker](docker.md){.internal-link target=_blank}. + +/// + +## Попередні кроки перед стартом { #previous-steps-before-starting } + +Є багато випадків, коли потрібно виконати деякі кроки **перед стартом** вашого застосунку. + +Наприклад, ви можете захотіти запустити **міграції бази даних**. + +Але найчастіше ці кроки потрібно виконувати лише **один раз**. + +Отже, ви захочете мати **єдиний процес**, який виконає ці **попередні кроки** перед запуском застосунку. + +І потрібно переконатися, що їх виконує саме один процес навіть якщо потім ви запускаєте **кілька процесів** (кілька працівників) для самого застосунку. Якщо ці кроки виконуватимуться **кількома процесами**, вони **подвоюватимуть** роботу, виконуючи її **паралельно**, і якщо кроки делікатні, як-от міграції бази даних, це може призвести до конфліктів. + +Звісно, бувають випадки, коли немає проблеми запускати попередні кроки кілька разів - тоді все набагато простіше. + +/// tip | Порада + +Також майте на увазі, що залежно від вашого налаштування інколи **попередні кроки взагалі не потрібні** перед запуском застосунку. + +У такому разі про це можна не турбуватися. 🤷 + +/// + +### Приклади стратегій попередніх кроків { #examples-of-previous-steps-strategies } + +Це **значною мірою залежить** від способу **розгортання вашої системи** і, ймовірно, буде пов'язано зі способом запуску програм, обробки перезапусків тощо. + +Ось кілька можливих ідей: + +- «Init Container» у Kubernetes, який виконується перед вашим контейнером застосунку +- bash-скрипт, який виконує попередні кроки, а потім запускає ваш застосунок + - Вам усе одно потрібен спосіб запускати/перезапускати цей bash-скрипт, виявляти помилки тощо. + +/// tip | Порада + +Я наведу більш конкретні приклади для цього з контейнерами у майбутньому розділі: [FastAPI у контейнерах - Docker](docker.md){.internal-link target=_blank}. + +/// + +## Використання ресурсів { #resource-utilization } + +Ваш сервер(и) - це **ресурс**, який ви можете споживати/**використовувати** вашими програмами: час обчислень на CPU та доступну RAM. + +Скільки системних ресурсів ви хочете споживати/використовувати? Легко подумати «небагато», але насправді ви, ймовірно, захочете споживати **настільки багато, наскільки можливо без краху**. + +Якщо ви платите за 3 сервери, але використовуєте лише трохи їх RAM і CPU, ви, ймовірно, **марнуєте гроші** 💸 і, можливо, **електроенергію серверів** 🌎 тощо. + +У такому разі може бути краще мати лише 2 сервери й використовувати більший відсоток їхніх ресурсів (CPU, пам'ять, диск, пропускну здатність мережі тощо). + +З іншого боку, якщо у вас 2 сервери і ви використовуєте **100% їхнього CPU та RAM**, у певний момент якийсь процес попросить більше пам'яті, і сервер муситиме використати диск як «пам'ять» (що може бути у тисячі разів повільнішим) або навіть **впасти**. Або процесу знадобляться обчислення, і він чекатиме, доки CPU знову звільниться. + +У цьому випадку краще додати **ще один сервер** і запустити частину процесів на ньому, щоб у всіх було **достатньо RAM та часу CPU**. + +Також можлива ситуація, коли з певної причини ви отримаєте **стрибок** використання вашого API. Можливо, він став вірусним або його почали використовувати інші сервіси чи боти. І ви можете захотіти мати додаткові ресурси на випадок таких ситуацій. + +Ви можете встановити **довільний цільовий** рівень, наприклад, **між 50% і 90%** використання ресурсів. Суть у тому, що це, ймовірно, головні речі, які ви захочете вимірювати й використовувати для налаштування розгортань. + +Ви можете використати прості інструменти, як-от `htop`, щоб побачити використання CPU і RAM на сервері або кількість, спожиту кожним процесом. Або складніші засоби моніторингу, розподілені між серверами тощо. + +## Підсумок { #recap } + +Тут ви прочитали про основні концепції, які, ймовірно, потрібно тримати в голові, вирішуючи, як розгортати ваш застосунок: + +- Безпека - HTTPS +- Запуск під час старту +- Перезапуски +- Реплікація (кількість запущених процесів) +- Пам'ять +- Попередні кроки перед стартом + +Розуміння цих ідей і того, як їх застосовувати, має дати вам інтуїцію, необхідну для прийняття рішень під час конфігурування і тонкого налаштування ваших розгортань. 🤓 + +У наступних розділах я наведу більше конкретних прикладів можливих стратегій, якими ви можете скористатися. 🚀 diff --git a/docs/uk/docs/deployment/docker.md b/docs/uk/docs/deployment/docker.md new file mode 100644 index 0000000000..d6faacfe5e --- /dev/null +++ b/docs/uk/docs/deployment/docker.md @@ -0,0 +1,618 @@ +# FastAPI у контейнерах - Docker { #fastapi-in-containers-docker } + +Під час розгортання застосунків FastAPI поширений підхід - збирати образи контейнерів Linux. Зазвичай це робиться за допомогою Docker. Потім ви можете розгорнути цей образ контейнера кількома різними способами. + +Використання контейнерів Linux має кілька переваг, зокрема безпека, відтворюваність, простота та інші. + +/// tip | Порада + +Поспішаєте і вже все це знаєте? Перейдіть до [`Dockerfile` нижче 👇](#build-a-docker-image-for-fastapi). + +/// + +
+Попередній перегляд Dockerfile 👀 + +```Dockerfile +FROM python:3.14 + +WORKDIR /code + +COPY ./requirements.txt /code/requirements.txt + +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt + +COPY ./app /code/app + +CMD ["fastapi", "run", "app/main.py", "--port", "80"] + +# Якщо запускаєте за представником на кшталт Nginx або Traefik, додайте --proxy-headers +# CMD ["fastapi", "run", "app/main.py", "--port", "80", "--proxy-headers"] +``` + +
+ +## Що таке контейнер { #what-is-a-container } + +Контейнери (переважно контейнери Linux) - це дуже легкий спосіб упакувати застосунки з усіма їхніми залежностями та потрібними файлами, ізолювавши їх від інших контейнерів (інших застосунків або компонентів) у тій самій системі. + +Контейнери Linux працюють, використовуючи той самий ядро Linux, що й хост (машина, віртуальна машина, хмарний сервер тощо). Це означає, що вони дуже легкі (у порівнянні з повними віртуальними машинами, які емулюють цілу операційну систему). + +Таким чином контейнери споживають мало ресурсів, приблизно як безпосередньо запущені процеси (віртуальна машина споживала б значно більше). + +У контейнерів також є власні ізольовані процеси виконання (зазвичай лише один процес), файлові системи та мережі, що спрощує розгортання, безпеку, розробку тощо. + +## Що таке образ контейнера { #what-is-a-container-image } + +Контейнер запускається з образу контейнера. + +Образ контейнера - це статична версія всіх файлів, змінних оточення та типова команда/програма, яка має бути присутня в контейнері. Тут «статична» означає, що образ контейнера не запущений, він не виконується, це лише упаковані файли та метадані. + +На противагу «образу контейнера», що є збереженим статичним вмістом, «контейнер» зазвичай означає запущений екземпляр, те, що виконується. + +Коли контейнер запущено (запущений з образу контейнера), він може створювати або змінювати файли, змінні оточення тощо. Ці зміни існуватимуть лише в цьому контейнері, але не збережуться в базовому образі контейнера (не будуть записані на диск). + +Образ контейнера можна порівняти з файлом і вмістом програми, наприклад `python` і файлом `main.py`. + +А сам контейнер (на відміну від образу) - це фактично запущений екземпляр образу, порівнянний із процесом. Насправді контейнер працює лише тоді, коли в ньому працює процес (і зазвичай це один процес). Контейнер зупиняється, коли в ньому не працює жоден процес. + +## Образи контейнерів { #container-images } + +Docker був одним з основних інструментів для створення та керування образами контейнерів і контейнерами. + +Існує публічний Docker Hub з готовими офіційними образами для багатьох інструментів, середовищ, баз даних і застосунків. + +Наприклад, є офіційний образ Python. + +І є багато інших образів для різних речей, як-от бази даних, наприклад для: + +* PostgreSQL +* MySQL +* MongoDB +* Redis тощо. + +Використовуючи готовий образ контейнера, дуже легко поєднувати та використовувати різні інструменти. Наприклад, щоб випробувати нову базу даних. У більшості випадків ви можете використати офіційні образи та просто налаштувати їх змінними оточення. + +Таким чином, у багатьох випадках ви зможете навчитися працювати з контейнерами і Docker та повторно використати ці знання з багатьма різними інструментами і компонентами. + +Тобто ви запускатимете кілька контейнерів з різними речами, як-от базу даних, застосунок на Python, вебсервер із фронтендом на React, і з’єднаєте їх через внутрішню мережу. + +Усі системи керування контейнерами (як Docker чи Kubernetes) мають ці мережеві можливості вбудовано. + +## Контейнери і процеси { #containers-and-processes } + +Образ контейнера зазвичай містить у своїх метаданих типову програму або команду, яку слід виконати під час запуску контейнера, і параметри для цієї програми. Дуже схоже на те, що ви б виконали в командному рядку. + +Коли контейнер запускається, він виконає цю команду/програму (хоча ви можете перевизначити її і запустити іншу команду/програму). + +Контейнер працює доти, доки працює головний процес (команда або програма). + +Зазвичай контейнер має один процес, але також можливо запускати підпроцеси з головного процесу, і таким чином у вас може бути кілька процесів у тому самому контейнері. + +Але неможливо мати запущений контейнер без принаймні одного запущеного процесу. Якщо головний процес зупиняється, контейнер зупиняється. + +## Зібрати Docker-образ для FastAPI { #build-a-docker-image-for-fastapi } + +Гаразд, зберімо щось зараз! 🚀 + +Я покажу вам, як зібрати образ Docker для FastAPI з нуля на основі офіційного образу Python. + +Це те, що ви захочете робити у більшості випадків, наприклад: + +* Використання Kubernetes або подібних інструментів +* Під час запуску на Raspberry Pi +* Використання хмарного сервісу, який запустить для вас образ контейнера тощо + +### Вимоги до пакетів { #package-requirements } + +Зазвичай ви маєте вимоги до пакетів для вашого застосунку в окремому файлі. + +Це залежить переважно від інструменту, який ви використовуєте для встановлення цих вимог. + +Найпоширеніший спосіб - мати файл `requirements.txt` з назвами пакетів і їхніми версіями, по одному на рядок. + +Звісно, ви застосуєте ті самі ідеї з [Про версії FastAPI](versions.md){.internal-link target=_blank}, щоб задати діапазони версій. + +Наприклад, ваш `requirements.txt` може виглядати так: + +``` +fastapi[standard]>=0.113.0,<0.114.0 +pydantic>=2.7.0,<3.0.0 +``` + +І зазвичай ви встановлюватимете ці залежності пакетів через `pip`, наприклад: + +
+ +```console +$ pip install -r requirements.txt +---> 100% +Successfully installed fastapi pydantic +``` + +
+ +/// info | Інформація + +Існують інші формати та інструменти для визначення і встановлення залежностей пакетів. + +/// + +### Створіть код **FastAPI** { #create-the-fastapi-code } + +* Створіть директорію `app` і перейдіть у неї. +* Створіть порожній файл `__init__.py`. +* Створіть файл `main.py` з вмістом: + +```Python +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 = None): + return {"item_id": item_id, "q": q} +``` + +### Dockerfile { #dockerfile } + +Тепер у тій самій директорії проєкту створіть файл `Dockerfile` з вмістом: + +```{ .dockerfile .annotate } +# (1)! +FROM python:3.14 + +# (2)! +WORKDIR /code + +# (3)! +COPY ./requirements.txt /code/requirements.txt + +# (4)! +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt + +# (5)! +COPY ./app /code/app + +# (6)! +CMD ["fastapi", "run", "app/main.py", "--port", "80"] +``` + +1. Почніть з офіційного базового образу Python. + +2. Встановіть поточну робочу директорію в `/code`. + + Саме сюди ми помістимо файл `requirements.txt` і директорію `app`. + +3. Скопіюйте файл з вимогами в директорію `/code`. + + Спочатку скопіюйте лише файл з вимогами, а не решту коду. + + Оскільки цей файл змінюється нечасто, Docker виявить це і використає кеш для цього кроку, що також увімкне кеш і для наступного кроку. + +4. Встановіть залежності пакетів із файлу вимог. + + Опція `--no-cache-dir` каже `pip` не зберігати завантажені пакети локально, адже це потрібно лише тоді, якщо `pip` буде запущено знову для встановлення тих самих пакетів, але в роботі з контейнерами це не так. + + /// note | Примітка + + `--no-cache-dir` стосується лише `pip`, це не має відношення до Docker чи контейнерів. + + /// + + Опція `--upgrade` каже `pip` оновити пакети, якщо вони вже встановлені. + + Оскільки попередній крок копіювання файлу може бути виявлений кешем Docker, цей крок також використовуватиме кеш Docker, коли це можливо. + + Використання кешу на цьому кроці збереже вам багато часу під час повторних збірок образу в розробці, замість того щоб завжди завантажувати і встановлювати всі залежності. + +5. Скопіюйте директорію `./app` у директорію `/code`. + + Оскільки тут увесь код, який змінюється найчастіше, кеш Docker не буде легко використаний для цього або будь-яких наступних кроків. + + Тому важливо розмістити це ближче до кінця `Dockerfile`, щоб оптимізувати час збірки образу контейнера. + +6. Встановіть команду для використання `fastapi run`, яка всередині використовує Uvicorn. + + `CMD` приймає список строк, кожна з яких - це те, що ви б набирали в командному рядку, розділене пробілами. + + Ця команда буде виконана з поточної робочої директорії, тієї самої `/code`, яку ви вказали вище через `WORKDIR /code`. + +/// tip | Порада + +Перегляньте, що робить кожен рядок, клацнувши на кожну номерну позначку в коді. 👆 + +/// + +/// warning | Попередження + +Обов’язково завжди використовуйте exec form інструкції `CMD`, як пояснено нижче. + +/// + +#### Використовуйте `CMD` - exec form { #use-cmd-exec-form } + +Інструкцію Docker `CMD` можна записати у двох формах: + +✅ Exec form: + +```Dockerfile +# ✅ Робіть так +CMD ["fastapi", "run", "app/main.py", "--port", "80"] +``` + +⛔️ Shell form: + +```Dockerfile +# ⛔️ Не робіть так +CMD fastapi run app/main.py --port 80 +``` + +Обов’язково завжди використовуйте exec form, щоб FastAPI міг коректно завершувати роботу та щоб були викликані [події тривалості життя](../advanced/events.md){.internal-link target=_blank}. + +Докладніше про це можна прочитати в документації Docker про shell та exec form. + +Це може бути особливо помітно при використанні `docker compose`. Див. розділ FAQ Docker Compose для технічних деталей: Чому мої сервіси потребують 10 секунд, щоб пересотворитися або зупинитися?. + +#### Структура директорій { #directory-structure } + +Зараз у вас має бути така структура директорій: + +``` +. +├── app +│   ├── __init__.py +│ └── main.py +├── Dockerfile +└── requirements.txt +``` + +#### За представником з термінацією TLS { #behind-a-tls-termination-proxy } + +Якщо ви запускаєте контейнер за представником з термінацією TLS (балансувальником навантаження), наприклад Nginx або Traefik, додайте опцію `--proxy-headers`. Це скаже Uvicorn (через CLI FastAPI) довіряти заголовкам, що надсилаються цим представником, які вказують, що застосунок працює за HTTPS тощо. + +```Dockerfile +CMD ["fastapi", "run", "app/main.py", "--proxy-headers", "--port", "80"] +``` + +#### Кеш Docker { #docker-cache } + +У цьому `Dockerfile` є важливий трюк: спочатку ми копіюємо лише файл із залежностями, а не решту коду. Ось чому. + +```Dockerfile +COPY ./requirements.txt /code/requirements.txt +``` + +Docker та інші інструменти збирають ці образи контейнерів інкрементально, додаючи один шар поверх іншого, починаючи з верхньої частини `Dockerfile` і додаючи будь-які файли, створені кожною інструкцією в `Dockerfile`. + +Docker та подібні інструменти також використовують внутрішній кеш під час збірки образу. Якщо файл не змінювався з моменту останньої збірки, тоді він повторно використає той самий шар, створений востаннє, замість копіювання файлу знову та створення нового шару з нуля. + +Просте уникнення копіювання файлів не обов’язково суттєво покращує ситуацію, але оскільки для цього кроку використано кеш, він може використати кеш і для наступного кроку. Наприклад, він може використати кеш для інструкції, яка встановлює залежності: + +```Dockerfile +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt +``` + +Файл із вимогами до пакетів змінюватиметься нечасто. Отже, копіюючи лише цей файл, Docker зможе використати кеш для цього кроку. + +А потім Docker зможе використати кеш і для наступного кроку, який завантажує та встановлює ці залежності. І саме тут ми заощаджуємо багато часу. ✨ ...і уникаємо нудного очікування. 😪😆 + +Завантаження і встановлення залежностей пакетів може займати хвилини, але використання кешу займе максимум секунди. + +І оскільки ви збиратимете образ контейнера знову і знову під час розробки, щоб перевіряти, що зміни у вашому коді працюють, це заощадить багато накопиченого часу. + +Потім, ближче до кінця `Dockerfile`, ми копіюємо весь код. Оскільки це те, що змінюється найчастіше, ми розміщуємо це ближче до кінця, адже майже завжди все після цього кроку не зможе використати кеш. + +```Dockerfile +COPY ./app /code/app +``` + +### Зберіть Docker-образ { #build-the-docker-image } + +Тепер, коли всі файли на місці, зберімо образ контейнера. + +* Перейдіть у директорію проєкту (де ваш `Dockerfile`, який містить директорію `app`). +* Зберіть ваш образ FastAPI: + +
+ +```console +$ docker build -t myimage . + +---> 100% +``` + +
+ +/// tip | Порада + +Зверніть увагу на `.` в кінці. Це еквівалент `./`. Воно каже Docker, яку директорію використовувати для збірки образу контейнера. + +У цьому випадку - це поточна директорія (`.`). + +/// + +### Запустіть Docker-контейнер { #start-the-docker-container } + +* Запустіть контейнер на основі вашого образу: + +
+ +```console +$ docker run -d --name mycontainer -p 80:80 myimage +``` + +
+ +## Перевірте { #check-it } + +Ви маєте змогу перевірити це за URL вашого Docker-контейнера, наприклад: http://192.168.99.100/items/5?q=somequery або http://127.0.0.1/items/5?q=somequery (або еквівалент, використовуючи ваш Docker-хост). + +Ви побачите щось таке: + +```JSON +{"item_id": 5, "q": "somequery"} +``` + +## Інтерактивна документація API { #interactive-api-docs } + +Тепер ви можете перейти на http://192.168.99.100/docs або http://127.0.0.1/docs (або еквівалент, використовуючи ваш Docker-хост). + +Ви побачите автоматичну інтерактивну документацію API (надається Swagger UI): + +![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png) + +## Альтернативна документація API { #alternative-api-docs } + +Також ви можете перейти на http://192.168.99.100/redoc або http://127.0.0.1/redoc (або еквівалент, використовуючи ваш Docker-хост). + +Ви побачите альтернативну автоматичну документацію (надається ReDoc): + +![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png) + +## Збірка Docker-образу з FastAPI в одному файлі { #build-a-docker-image-with-a-single-file-fastapi } + +Якщо ваш FastAPI - це один файл, наприклад `main.py` без директорії `./app`, структура файлів може виглядати так: + +``` +. +├── Dockerfile +├── main.py +└── requirements.txt +``` + +Тоді вам потрібно лише змінити відповідні шляхи для копіювання файлу всередині `Dockerfile`: + +```{ .dockerfile .annotate hl_lines="10 13" } +FROM python:3.14 + +WORKDIR /code + +COPY ./requirements.txt /code/requirements.txt + +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt + +# (1)! +COPY ./main.py /code/ + +# (2)! +CMD ["fastapi", "run", "main.py", "--port", "80"] +``` + +1. Скопіюйте файл `main.py` безпосередньо у директорію `/code` (без будь-якої директорії `./app`). + +2. Використовуйте `fastapi run`, щоб обслуговувати ваш застосунок з одного файлу `main.py`. + +Коли ви передаєте файл у `fastapi run`, воно автоматично визначить, що це один файл, а не частина пакета, і знатиме, як імпортувати його та запустити ваш застосунок FastAPI. 😎 + +## Концепції розгортання { #deployment-concepts } + +Поговорімо знову про деякі з тих самих [Концепцій розгортання](concepts.md){.internal-link target=_blank} у термінах контейнерів. + +Контейнери - це переважно інструмент для спрощення процесу збирання та розгортання застосунку, але вони не нав’язують конкретний підхід до обробки цих концепцій розгортання, і існує кілька можливих стратегій. + +Гарна новина полягає в тому, що для кожної стратегії є спосіб покрити всі концепції розгортання. 🎉 + +Розгляньмо ці концепції розгортання в контексті контейнерів: + +* HTTPS +* Автозапуск +* Перезапуски +* Реплікація (кількість запущених процесів) +* Пам’ять +* Попередні кроки перед запуском + +## HTTPS { #https } + +Якщо зосередитись лише на образі контейнера для застосунку FastAPI (а згодом на запущеному контейнері), HTTPS зазвичай обробляється зовнішнім іншим інструментом. + +Це може бути інший контейнер, наприклад з Traefik, що обробляє HTTPS і автоматичне отримання сертифікатів. + +/// tip | Порада + +Traefik має інтеграції з Docker, Kubernetes та іншими, тож налаштувати і сконфігурувати HTTPS для ваших контейнерів з ним дуже просто. + +/// + +Альтернативно, HTTPS може оброблятись хмарним провайдером як один з їхніх сервісів (при цьому застосунок усе ще працює в контейнері). + +## Автозапуск і перезапуски { #running-on-startup-and-restarts } + +Зазвичай інший інструмент відповідає за запуск і виконання вашого контейнера. + +Це може бути безпосередньо Docker, Docker Compose, Kubernetes, хмарний сервіс тощо. + +У більшості (або всіх) випадків є проста опція, щоб увімкнути запуск контейнера при старті системи та перезапуски у разі збоїв. Наприклад, у Docker це опція командного рядка `--restart`. + +Без використання контейнерів змусити застосунки запускатися при старті системи та з перезапусками може бути клопітно і складно. Але під час роботи з контейнерами у більшості випадків ця функціональність вбудована за замовчуванням. ✨ + +## Реплікація - кількість процесів { #replication-number-of-processes } + +Якщо у вас є кластер машин із Kubernetes, Docker Swarm Mode, Nomad або іншою подібною складною системою для керування розподіленими контейнерами на кількох машинах, тоді ви, ймовірно, захочете обробляти реплікацію на рівні кластера замість використання менеджера процесів (як-от Uvicorn з працівниками) у кожному контейнері. + +Одна з таких розподілених систем керування контейнерами, як-от Kubernetes, зазвичай має інтегровані способи обробляти реплікацію контейнерів, підтримуючи водночас балансування навантаження для вхідних запитів. Усе це - на рівні кластера. + +У таких випадках ви, ймовірно, захочете зібрати Docker-образ з нуля, як [пояснено вище](#dockerfile), встановивши ваші залежності і запустивши один процес Uvicorn замість використання кількох працівників Uvicorn. + +### Балансувальник навантаження { #load-balancer } + +При використанні контейнерів зазвичай є якийсь компонент, що слухає на головному порту. Це може бути інший контейнер, який також є представником з термінацією TLS для обробки HTTPS, або подібний інструмент. + +Оскільки цей компонент приймає навантаження запитів і розподіляє його між працівниками (сподіваємось) збалансовано, його також часто називають балансувальником навантаження. + +/// tip | Порада + +Той самий компонент представника з термінацією TLS, що використовується для HTTPS, швидше за все, також буде балансувальником навантаження. + +/// + +І під час роботи з контейнерами та сама система, яку ви використовуєте для їх запуску і керування ними, вже матиме внутрішні інструменти для передавання мережевої комунікації (наприклад, HTTP-запитів) від цього балансувальника навантаження (який також може бути представником з термінацією TLS) до контейнерів із вашим застосунком. + +### Один балансувальник навантаження - кілька контейнерів-працівників { #one-load-balancer-multiple-worker-containers } + +Під час роботи з Kubernetes або подібними розподіленими системами керування контейнерами використання їхніх внутрішніх мережевих механізмів дозволяє єдиному балансувальнику навантаження, що слухає на головному порту, передавати комунікацію (запити) до кількох контейнерів, у яких запущено ваш застосунок. + +Кожен з цих контейнерів із вашим застосунком зазвичай має лише один процес (наприклад, процес Uvicorn, що запускає ваш застосунок FastAPI). Усі вони будуть ідентичними контейнерами, які запускають те саме, але кожен зі своїм процесом, пам’яттю тощо. Таким чином ви використаєте переваги паралелізму на різних ядрах процесора або навіть на різних машинах. + +А розподілена система контейнерів із балансувальником навантаження розподілятиме запити між кожним із контейнерів із вашим застосунком по черзі. Тож кожен запит може оброблятися одним із кількох реплікованих контейнерів, що запускають ваш застосунок. + +І зазвичай цей балансувальник навантаження зможе обробляти запити, які йдуть до інших застосунків у вашому кластері (наприклад, до іншого домену або під іншим префіксом шляху URL), і передаватиме комунікацію до відповідних контейнерів для того іншого застосунку, що працює у вашому кластері. + +### Один процес на контейнер { #one-process-per-container } + +У такому сценарії ви, ймовірно, захочете мати один (Uvicorn) процес на контейнер, адже ви вже обробляєте реплікацію на рівні кластера. + +Тобто в цьому випадку ви не захочете мати кількох працівників у контейнері, наприклад через опцію командного рядка `--workers`. Ви захочете мати лише один процес Uvicorn на контейнер (але, ймовірно, кілька контейнерів). + +Наявність іншого менеджера процесів всередині контейнера (як це було б із кількома працівниками) лише додасть зайвої складності, яку, найімовірніше, ви вже вирішуєте на рівні кластера. + +### Контейнери з кількома процесами та особливі випадки { #containers-with-multiple-processes-and-special-cases } + +Звісно, є особливі випадки, коли ви можете захотіти мати контейнер із кількома процесами-працівниками Uvicorn всередині. + +У таких випадках ви можете використати опцію командного рядка `--workers`, щоб задати кількість працівників, яких потрібно запустити: + +```{ .dockerfile .annotate } +FROM python:3.14 + +WORKDIR /code + +COPY ./requirements.txt /code/requirements.txt + +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt + +COPY ./app /code/app + +# (1)! +CMD ["fastapi", "run", "app/main.py", "--port", "80", "--workers", "4"] +``` + +1. Тут ми використовуємо опцію командного рядка `--workers`, щоб встановити кількість працівників 4. + +Ось кілька прикладів, коли це може мати сенс: + +#### Простий застосунок { #a-simple-app } + +Ви можете захотіти менеджер процесів у контейнері, якщо ваш застосунок достатньо простий, щоб запускати його на одному сервері, а не на кластері. + +#### Docker Compose { #docker-compose } + +Ви можете розгортати на одному сервері (не в кластері) за допомогою Docker Compose, тож у вас не буде простого способу керувати реплікацією контейнерів (у Docker Compose), зберігаючи спільну мережу та балансування навантаження. + +Тоді ви можете захотіти мати один контейнер із менеджером процесів, що запускає кілька процесів-працівників всередині. + +--- + +Головна думка: це не правила, викарбувані в камені, яких потрібно сліпо дотримуватися. Ви можете використати ці ідеї, щоб оцінити власний кейс і вирішити, який підхід найкращий для вашої системи, розглядаючи, як керувати такими концепціями: + +* Безпека - HTTPS +* Автозапуск +* Перезапуски +* Реплікація (кількість запущених процесів) +* Пам’ять +* Попередні кроки перед запуском + +## Пам’ять { #memory } + +Якщо ви запускаєте один процес на контейнер, ви матимете більш-менш чітко визначений, стабільний і обмежений обсяг пам’яті, що споживається кожним із цих контейнерів (їх може бути більше одного, якщо вони репліковані). + +Потім ви можете встановити ті самі ліміти та вимоги до пам’яті у ваших конфігураціях для системи керування контейнерами (наприклад, у Kubernetes). Таким чином вона зможе реплікувати контейнери на доступних машинах, враховуючи обсяг пам’яті, потрібний їм, і обсяг доступної пам’яті на машинах у кластері. + +Якщо ваш застосунок простий, імовірно, це не буде проблемою, і вам може не знадобитися задавати жорсткі ліміти пам’яті. Але якщо ви використовуєте багато пам’яті (наприклад, із моделями машинного навчання), вам слід перевірити, скільки пам’яті ви споживаєте, і відкоригувати кількість контейнерів, що запускаються на кожній машині (і, можливо, додати більше машин у ваш кластер). + +Якщо ви запускаєте кілька процесів на контейнер, вам потрібно переконатися, що кількість запущених процесів не споживає більше пам’яті, ніж доступно. + +## Попередні кроки перед запуском і контейнери { #previous-steps-before-starting-and-containers } + +Якщо ви використовуєте контейнери (наприклад, Docker, Kubernetes), то є два основні підходи. + +### Кілька контейнерів { #multiple-containers } + +Якщо у вас кілька контейнерів, імовірно кожен запускає один процес (наприклад, у кластері Kubernetes), тоді ви, ймовірно, захочете мати окремий контейнер, який виконає попередні кроки в одному контейнері, запустивши один процес, перед запуском реплікованих контейнерів-працівників. + +/// info | Інформація + +Якщо ви використовуєте Kubernetes, це, ймовірно, буде Init Container. + +/// + +Якщо у вашому випадку немає проблеми запускати ці попередні кроки кілька разів паралельно (наприклад, якщо ви не виконуєте міграції бази даних, а лише перевіряєте, чи база вже готова), тоді ви також можете просто помістити їх у кожен контейнер безпосередньо перед запуском головного процесу. + +### Один контейнер { #single-container } + +Якщо у вас просте налаштування з одним контейнером, який потім запускає кілька процесів-працівників (або теж лише один процес), тоді ви можете виконати ці попередні кроки в тому ж контейнері безпосередньо перед запуском процесу із застосунком. + +### Базовий образ Docker { #base-docker-image } + +Колись існував офіційний образ Docker для FastAPI: tiangolo/uvicorn-gunicorn-fastapi. Але зараз він застарілий. ⛔️ + +Ймовірно, вам не слід використовувати цей базовий образ Docker (або будь-який інший подібний). + +Якщо ви використовуєте Kubernetes (або інші) і вже налаштовуєте реплікацію на рівні кластера з кількома контейнерами. У таких випадках краще зібрати образ з нуля, як описано вище: [Зібрати Docker-образ для FastAPI](#build-a-docker-image-for-fastapi). + +А якщо вам потрібно мати кілька працівників, ви можете просто використати опцію командного рядка `--workers`. + +/// note | Технічні деталі + +Цей образ Docker було створено тоді, коли Uvicorn не підтримував керування та перезапуск «мертвих» працівників, тому потрібно було використовувати Gunicorn з Uvicorn, що додавало чимало складності лише для того, щоб Gunicorn керував та перезапускав процеси-працівники Uvicorn. + +Але тепер, коли Uvicorn (і команда `fastapi`) підтримують використання `--workers`, немає причин використовувати базовий образ Docker замість того, щоб зібрати власний (це приблизно та сама кількість коду 😅). + +/// + +## Розгорнути образ контейнера { #deploy-the-container-image } + +Після отримання образу контейнера (Docker) є кілька способів його розгорнути. + +Наприклад: + +* З Docker Compose на одному сервері +* З кластером Kubernetes +* З кластером Docker Swarm Mode +* З іншим інструментом, як-от Nomad +* З хмарним сервісом, який бере ваш образ контейнера і розгортає його + +## Образ Docker з `uv` { #docker-image-with-uv } + +Якщо ви використовуєте uv для встановлення та керування вашим проєктом, ви можете скористатися їхнім посібником Docker для uv. + +## Підсумок { #recap } + +Використовуючи системи контейнерів (наприклад, з Docker і Kubernetes), досить просто обробляти всі концепції розгортання: + +* HTTPS +* Автозапуск +* Перезапуски +* Реплікація (кількість запущених процесів) +* Пам’ять +* Попередні кроки перед запуском + +У більшості випадків ви, ймовірно, не захочете використовувати будь-який базовий образ, а натомість зібрати образ контейнера з нуля на основі офіційного образу Python для Docker. + +Дотримуючись порядку інструкцій у `Dockerfile` і використовуючи кеш Docker, ви можете мінімізувати час збірки, щоб максимізувати свою продуктивність (і уникнути нудьги). 😎 diff --git a/docs/uk/docs/deployment/fastapicloud.md b/docs/uk/docs/deployment/fastapicloud.md new file mode 100644 index 0000000000..4b4f3e59be --- /dev/null +++ b/docs/uk/docs/deployment/fastapicloud.md @@ -0,0 +1,65 @@ +# FastAPI Cloud { #fastapi-cloud } + +Ви можете розгорнути свій застосунок FastAPI на FastAPI Cloud однією командою, приєднуйтесь до списку очікування, якщо ще ні. 🚀 + +## Вхід { #login } + +Переконайтеся, що у вас вже є обліковий запис **FastAPI Cloud** (ми запросили вас зі списку очікування 😉). + +Потім увійдіть: + +
+ +```console +$ fastapi login + +You are logged in to FastAPI Cloud 🚀 +``` + +
+ +## Розгортання { #deploy } + +Тепер розгорніть свій застосунок однією командою: + +
+ +```console +$ fastapi deploy + +Deploying to FastAPI Cloud... + +✅ Deployment successful! + +🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev +``` + +
+ +Ось і все! Тепер ви можете отримати доступ до свого застосунку за цим URL. ✨ + +## Про FastAPI Cloud { #about-fastapi-cloud } + +**FastAPI Cloud** створено тим самим автором і командою, що стоїть за **FastAPI**. + +Він спрощує процес **створення**, **розгортання** та **доступу** до API з мінімальними зусиллями. + +Він переносить той самий **досвід розробника**, що і під час створення застосунків з FastAPI, на їх **розгортання** у хмарі. 🎉 + +Він також подбає про більшість речей, які вам потрібні під час розгортання застосунку, як-от: + +- HTTPS +- реплікація з автомасштабуванням на основі запитів +- тощо + +FastAPI Cloud - основний спонсор і джерело фінансування для відкритих проєктів *«FastAPI та друзі»*. ✨ + +## Розгортання в інших хмарних провайдерів { #deploy-to-other-cloud-providers } + +FastAPI є відкритим кодом і базується на стандартах. Ви можете розгортати застосунки FastAPI в будь-якого хмарного провайдера за вашим вибором. + +Дотримуйтесь інструкцій вашого хмарного провайдера, щоб розгортати застосунки FastAPI у них. 🤓 + +## Розгортання на вашому сервері { #deploy-your-own-server } + +Пізніше в цьому розділі **Розгортання** я також навчу вас усім деталям, щоб ви розуміли, що відбувається, що потрібно зробити і як розгортати застосунки FastAPI самостійно, зокрема на власних серверах. 🤓 diff --git a/docs/uk/docs/deployment/https.md b/docs/uk/docs/deployment/https.md new file mode 100644 index 0000000000..29329c88f0 --- /dev/null +++ b/docs/uk/docs/deployment/https.md @@ -0,0 +1,231 @@ +# Про HTTPS { #about-https } + +Легко припустити, що HTTPS - це щось, що просто «увімкнено» або ні. + +Але все значно складніше. + +/// tip | Порада + +Якщо ви поспішаєте або це неважливо для вас, переходьте до наступних розділів для покрокових інструкцій із налаштування всього різними техніками. + +/// + +Щоб вивчити основи HTTPS з точки зору споживача, перегляньте https://howhttps.works/. + +Тепер, з точки зору розробника, ось кілька речей, які варто пам'ятати, розмірковуючи про HTTPS: + +* Для HTTPS сервер має мати «сертифікати», видані третьою стороною. + * Насправді ці сертифікати «отримуються» у третьої сторони, а не «генеруються». +* Сертифікати мають строк дії. + * Їхній строк дії спливає. + * І тоді їх потрібно поновити, знову отримавши у третьої сторони. +* Шифрування з'єднання відбувається на рівні TCP. + * Це один шар нижче від HTTP. + * Тож обробка сертифіката та шифрування виконується до HTTP. +* TCP не знає про «домени». Лише про IP-адреси. + * Інформація про конкретний домен, який запитується, міститься в даних HTTP. +* Сертифікати HTTPS «засвідчують» певний домен, але протокол і шифрування працюють на рівні TCP, до того як відомо, з яким доменом маємо справу. +* Типово це означало б, що на одну IP-адресу можна мати лише один сертифікат HTTPS. + * Неважливо, наскільки великий ваш сервер або наскільки малий кожен застосунок на ньому. + * Однак для цього є рішення. +* Є розширення протоколу TLS (який обробляє шифрування на рівні TCP, до HTTP), що називається SNI. + * Це розширення SNI дозволяє одному серверу (з однією IP-адресою) мати кілька сертифікатів HTTPS і обслуговувати кілька доменів/застосунків по HTTPS. + * Щоб це працювало, один-єдиний компонент (програма), що працює на сервері та слухає публічну IP-адресу, має мати всі сертифікати HTTPS на сервері. +* Після отримання захищеного з'єднання протокол обміну все ще HTTP. + * Вміст зашифровано, хоча він надсилається протоколом HTTP. + +Поширена практика мати одну програму/HTTP-сервер, що працює на сервері (машині, хості тощо) і керує всіма частинами HTTPS: приймає зашифровані HTTPS-запити, надсилає розшифровані HTTP-запити до фактичного HTTP-застосунку, що працює на тому ж сервері (у нашому випадку застосунок FastAPI), отримує HTTP-відповідь від застосунку, шифрує її за допомогою відповідного сертифіката HTTPS і надсилає її назад клієнту через HTTPS. Такий сервер часто називають TLS Termination Proxy. + +Деякі варіанти, які ви можете використати як TLS Termination Proxy: + +* Traefik (також може виконувати поновлення сертифікатів) +* Caddy (також може виконувати поновлення сертифікатів) +* Nginx +* HAProxy + +## Let's Encrypt { #lets-encrypt } + +До Let's Encrypt ці сертифікати HTTPS продавалися довіреними третіми сторонами. + +Процес отримання одного з таких сертифікатів був громіздким, вимагав чимало паперової роботи, а самі сертифікати були доволі дорогими. + +Але потім з'явився проєкт Let's Encrypt. + +Це проєкт Linux Foundation. Він надає сертифікати HTTPS безкоштовно, в автоматизований спосіб. Ці сертифікати використовують усі стандартні криптографічні механізми безпеки і є короткостроковими (близько 3 місяців), тож безпека насправді краща завдяки зменшеній тривалості життя. + +Домени безпечно перевіряються, а сертифікати генеруються автоматично. Це також дозволяє автоматизувати поновлення цих сертифікатів. + +Ідея полягає в автоматизації отримання та поновлення цих сертифікатів, щоб ви могли мати безпечний HTTPS безкоштовно та назавжди. + +## HTTPS для розробників { #https-for-developers } + +Ось приклад того, як може виглядати HTTPS API, крок за кроком, зосереджуючись переважно на ідеях, важливих для розробників. + +### Доменне ім'я { #domain-name } + +Ймовірно, все почнеться з того, що ви придбаєте якесь доменне ім'я. Потім ви налаштуєте його на сервері DNS (можливо, у вашого ж хмарного провайдера). + +Ви, скоріш за все, отримаєте хмарний сервер (віртуальну машину) або щось подібне, і він матиме фіксовану публічну IP-адресу. + +На сервері(ах) DNS ви налаштуєте запис («`A record`»), щоб спрямувати ваш домен на публічну IP-адресу вашого сервера. + +Ймовірно, ви зробите це лише один раз, уперше, коли все налаштовуватимете. + +/// tip | Порада + +Частина про доменне ім'я значно раніше за HTTPS, але оскільки все залежить від домену та IP-адреси, варто згадати це тут. + +/// + +### DNS { #dns } + +Тепер зосередьмося на всіх власне частинах HTTPS. + +Спочатку браузер звернеться до серверів DNS, щоб дізнатися, яка IP-адреса для домену, у цьому випадку `someapp.example.com`. + +Сервери DNS повідомлять браузеру використати конкретну IP-адресу. Це буде публічна IP-адреса, яку використовує ваш сервер і яку ви налаштували на серверах DNS. + + + +### Початок TLS рукостискання { #tls-handshake-start } + +Потім браузер зв'яжеться з цією IP-адресою на порту 443 (порт HTTPS). + +Перша частина комунікації - це просто встановлення з'єднання між клієнтом і сервером та узгодження криптографічних ключів тощо. + + + +Ця взаємодія між клієнтом і сервером для встановлення з'єднання TLS називається TLS рукостисканням. + +### TLS із розширенням SNI { #tls-with-sni-extension } + +Лише один процес на сервері може слухати конкретний порт на конкретній IP-адресі. Інші процеси можуть слухати інші порти на тій самій IP-адресі, але лише один для кожної комбінації IP-адреси та порту. + +TLS (HTTPS) за замовчуванням використовує конкретний порт `443`. Отже, це порт, який нам потрібен. + +Оскільки лише один процес може слухати цей порт, процесом, що робитиме це, буде TLS Termination Proxy. + +TLS Termination Proxy матиме доступ до одного або кількох сертифікатів TLS (сертифікатів HTTPS). + +Використовуючи обговорене вище розширення SNI, TLS Termination Proxy перевірить, який із наявних сертифікатів TLS (HTTPS) слід використати для цього з'єднання, обравши той, що відповідає домену, очікуваному клієнтом. + +У цьому випадку він використає сертифікат для `someapp.example.com`. + + + +Клієнт уже довіряє сутності, яка видала цей сертифікат TLS (у цьому випадку Let's Encrypt, але про це згодом), тож він може перевірити, що сертифікат дійсний. + +Потім, використовуючи сертифікат, клієнт і TLS Termination Proxy узгоджують, як шифрувати решту TCP-комунікації. На цьому частина TLS рукостискання завершується. + +Після цього клієнт і сервер мають зашифроване TCP-з'єднання - саме це надає TLS. І тоді вони можуть використати це з'єднання, щоб почати власне HTTP-комунікацію. + +І це і є HTTPS: це звичайний HTTP усередині захищеного TLS-з'єднання замість чистого (незашифрованого) TCP-з'єднання. + +/// tip | Порада + +Зверніть увагу, що шифрування комунікації відбувається на рівні TCP, а не на рівні HTTP. + +/// + +### HTTPS-запит { #https-request } + +Тепер, коли клієнт і сервер (конкретно браузер і TLS Termination Proxy) мають зашифроване TCP-з'єднання, вони можуть почати HTTP-комунікацію. + +Отже, клієнт надсилає HTTPS-запит. Це просто HTTP-запит через зашифроване TLS-з'єднання. + + + +### Розшифрування запиту { #decrypt-the-request } + +TLS Termination Proxy використає узгоджене шифрування, щоб розшифрувати запит, і передасть звичайний (розшифрований) HTTP-запит процесу, що запускає застосунок (наприклад, процесу з Uvicorn, який запускає застосунок FastAPI). + + + +### HTTP-відповідь { #http-response } + +Застосунок обробить запит і надішле звичайну (незашифровану) HTTP-відповідь TLS Termination Proxy. + + + +### HTTPS-відповідь { #https-response } + +Потім TLS Termination Proxy зашифрує відповідь, використовуючи попередньо узгоджену криптографію (що почалася із сертифіката для `someapp.example.com`), і надішле її назад у браузер. + +Далі браузер перевірить, що відповідь дійсна й зашифрована правильним криптографічним ключем тощо. Потім він розшифрує відповідь і обробить її. + + + +Клієнт (браузер) знатиме, що відповідь надходить від правильного сервера, тому що використовується узгоджена раніше криптографія з використанням сертифіката HTTPS. + +### Кілька застосунків { #multiple-applications } + +На тому самому сервері (або серверах) може бути кілька застосунків, наприклад інші програми API або база даних. + +Лише один процес може обробляти конкретну IP-адресу і порт (TLS Termination Proxy у нашому прикладі), але інші застосунки/процеси також можуть працювати на сервері(ах), доки вони не намагаються використати ту саму комбінацію публічної IP-адреси й порту. + + + +Таким чином, TLS Termination Proxy може обробляти HTTPS і сертифікати для кількох доменів, для кількох застосунків, а потім передавати запити до відповідного застосунку в кожному випадку. + +### Поновлення сертифіката { #certificate-renewal } + +У певний момент у майбутньому строк дії кожного сертифіката спливе (приблизно через 3 місяці після його отримання). + +Потім інша програма (в деяких випадках це інша програма, а в деяких - той самий TLS Termination Proxy) зв'яжеться з Let's Encrypt і поновить сертифікат(и). + + + +Сертифікати TLS пов'язані з доменним іменем, а не з IP-адресою. + +Тому, щоб поновити сертифікати, програма поновлення має довести авторитету (Let's Encrypt), що вона справді «володіє» і контролює цей домен. + +Щоб зробити це й задовольнити різні потреби застосунків, є кілька способів. Деякі популярні: + +* Змінити деякі записи DNS. + * Для цього програма поновлення має підтримувати API провайдера DNS, тож залежно від того, якого провайдера DNS ви використовуєте, це може бути або не бути варіантом. +* Запуститися як сервер (принаймні під час процесу отримання сертифіката) на публічній IP-адресі, пов'язаній із доменом. + * Як ми казали вище, лише один процес може слухати конкретну IP-адресу та порт. + * Це одна з причин, чому дуже зручно, коли той самий TLS Termination Proxy також займається процесом поновлення сертифікатів. + * Інакше вам, можливо, доведеться на мить зупинити TLS Termination Proxy, запустити програму поновлення, щоб отримати сертифікати, потім налаштувати їх у TLS Termination Proxy і перезапустити TLS Termination Proxy. Це неідеально, оскільки ваші застосунки будуть недоступні під час вимкнення TLS Termination Proxy. + +Увесь цей процес поновлення, паралельно з обслуговуванням застосунку, - одна з головних причин, чому ви можете захотіти мати окрему систему для обробки HTTPS за допомогою TLS Termination Proxy замість того, щоб просто використовувати сертифікати TLS безпосередньо з сервером застосунку (наприклад, Uvicorn). + +## Направлені заголовки проксі { #proxy-forwarded-headers } + +Коли ви використовуєте проксі для обробки HTTPS, ваш сервер застосунку (наприклад, Uvicorn через FastAPI CLI) нічого не знає про процес HTTPS, він спілкується звичайним HTTP із TLS Termination Proxy. + +Цей проксі зазвичай динамічно встановлює деякі HTTP-заголовки перед передачею запиту серверу застосунку, щоб дати йому знати, що запит направляється проксі. + +/// note | Технічні деталі + +Заголовки проксі: + +* X-Forwarded-For +* X-Forwarded-Proto +* X-Forwarded-Host + +/// + +Втім, оскільки сервер застосунку не знає, що він стоїть за довіреним проксі, за замовчуванням він не довірятиме цим заголовкам. + +Але ви можете налаштувати сервер застосунку, щоб довіряти направленим заголовкам, надісланим проксі. Якщо ви використовуєте FastAPI CLI, ви можете скористатися курсивною *опцією CLI* `--forwarded-allow-ips`, щоб повідомити, з яких IP-адрес слід довіряти цим направленим заголовкам. + +Наприклад, якщо сервер застосунку отримує комунікацію лише від довіреного проксі, ви можете встановити `--forwarded-allow-ips="*"`, щоб довіряти всім вхідним IP-адресам, оскільки він отримуватиме запити лише з тієї IP-адреси, яку використовує проксі. + +Так застосунок зможе знати свою публічну URL-адресу, чи використовує він HTTPS, домен тощо. + +Це буде корисно, наприклад, для коректної обробки перенаправлень. + +/// tip | Порада + +Ви можете дізнатися більше про це в документації [За проксі - Увімкнути направлені заголовки проксі](../advanced/behind-a-proxy.md#enable-proxy-forwarded-headers){.internal-link target=_blank} + +/// + +## Підсумок { #recap } + +Наявність HTTPS дуже важлива і в більшості випадків критична. Більшість зусиль, які вам як розробнику доведеться докласти навколо HTTPS, полягають лише в розумінні цих концепцій і того, як вони працюють. + +Але як тільки ви знаєте базову інформацію про HTTPS для розробників, ви можете легко комбінувати й налаштовувати різні інструменти, щоб керувати всім просто. + +У деяких наступних розділах я покажу кілька конкретних прикладів налаштування HTTPS для застосунків FastAPI. 🔒 diff --git a/docs/uk/docs/deployment/index.md b/docs/uk/docs/deployment/index.md new file mode 100644 index 0000000000..7386681397 --- /dev/null +++ b/docs/uk/docs/deployment/index.md @@ -0,0 +1,23 @@ +# Розгортання { #deployment } + +Розгортання застосунку **FastAPI** відносно просте. + +## Що означає розгортання { #what-does-deployment-mean } + +Розгорнути застосунок - це виконати необхідні кроки, щоб зробити його доступним для користувачів. + +Для **веб API** це зазвичай означає розміщення його на **віддаленій машині** з **серверною програмою**, що забезпечує хорошу продуктивність, стабільність тощо, щоб ваші **користувачі** могли **отримувати доступ** до застосунку ефективно та без перерв чи проблем. + +Це відрізняється від етапів **розробки**, коли ви постійно змінюєте код, ламаєте й виправляєте його, зупиняєте та перезапускаєте сервер розробки тощо. + +## Стратегії розгортання { #deployment-strategies } + +Існує кілька способів зробити це залежно від вашого конкретного випадку використання та інструментів, які ви використовуєте. + +Ви можете розгорнути сервер самостійно, використовуючи комбінацію інструментів, можете скористатися **хмарним сервісом**, який виконує частину роботи за вас, або обрати інші варіанти. + +Наприклад, ми, команда, що стоїть за FastAPI, створили **FastAPI Cloud**, щоб зробити розгортання застосунків FastAPI у хмарі якомога простішим і з тим самим досвідом розробки, що й під час роботи з FastAPI. + +Я покажу вам кілька основних концепцій, про які, ймовірно, варто пам'ятати під час розгортання **FastAPI**-застосунку (хоча більшість із них стосується будь-яких інших типів веб-застосунків). + +У наступних розділах ви побачите більше деталей, на які варто зважати, та деякі техніки, як це зробити. ✨ diff --git a/docs/uk/docs/deployment/manually.md b/docs/uk/docs/deployment/manually.md new file mode 100644 index 0000000000..d70ec5d5d0 --- /dev/null +++ b/docs/uk/docs/deployment/manually.md @@ -0,0 +1,157 @@ +# Запустіть сервер вручну { #run-a-server-manually } + +## Використовуйте команду `fastapi run` { #use-the-fastapi-run-command } + +Коротко: використовуйте `fastapi run`, щоб запустити ваш застосунок FastAPI: + +
+ +```console +$ fastapi run main.py + + FastAPI Starting production server 🚀 + + Searching for package file structure from directories + with __init__.py files + Importing from /home/user/code/awesomeapp + + module 🐍 main.py + + code Importing the FastAPI app object from the module with + the following code: + + from main import app + + app Using import string: main:app + + server Server started at http://0.0.0.0:8000 + server Documentation at http://0.0.0.0:8000/docs + + Logs: + + INFO Started server process [2306215] + INFO Waiting for application startup. + INFO Application startup complete. + INFO Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C + to quit) +``` + +
+ +Це спрацює в більшості випадків. 😎 + +Цю команду можна використати, наприклад, щоб запустити ваш застосунок FastAPI у контейнері, на сервері тощо. + +## Сервери ASGI { #asgi-servers } + +Розгляньмо деталі. + +FastAPI використовує стандарт для побудови Python вебфреймворків і серверів під назвою ASGI. FastAPI - це ASGI вебфреймворк. + +Головне, що потрібно, щоб запустити застосунок **FastAPI** (або будь-який інший ASGI-застосунок) на віддаленій серверній машині, - це програма ASGI-сервера на кшталт **Uvicorn**; саме вона постачається за замовчуванням у команді `fastapi`. + +Є кілька альтернатив, зокрема: + +* Uvicorn: високопродуктивний ASGI-сервер. +* Hypercorn: ASGI-сервер, сумісний з HTTP/2 і Trio, серед інших можливостей. +* Daphne: ASGI-сервер, створений для Django Channels. +* Granian: Rust HTTP-сервер для Python-застосунків. +* NGINX Unit: NGINX Unit - легке й універсальне середовище виконання вебзастосунків. + +## Серверна машина і серверна програма { #server-machine-and-server-program } + +Є невелика деталь щодо назв, яку варто пам'ятати. 💡 + +Слово «**сервер**» зазвичай означає і віддалений/хмарний комп'ютер (фізична або віртуальна машина), і програму, що працює на цій машині (наприклад, Uvicorn). + +Майте на увазі, що коли ви бачите слово «сервер» загалом, воно може стосуватися будь-якого з цих двох значень. + +Коли йдеться про віддалену машину, її часто називають «сервер», а також «машина», «VM» (віртуальна машина), «вузол». Усе це означає різновиди віддаленої машини, зазвичай з Linux, на якій ви запускаєте програми. + +## Встановіть серверну програму { #install-the-server-program } + +Після встановлення FastAPI ви отримуєте продакшн-сервер Uvicorn і можете запускати його командою `fastapi run`. + +Але ви також можете встановити ASGI-сервер вручну. + +Переконайтеся, що ви створили [віртуальне оточення](../virtual-environments.md){.internal-link target=_blank}, активували його, після чого можете встановити серверну програму. + +Наприклад, щоб установити Uvicorn: + +
+ +```console +$ pip install "uvicorn[standard]" + +---> 100% +``` + +
+ +Подібний процес застосовується до будь-якої іншої ASGI-серверної програми. + +/// tip | Порада + +Додавши `standard`, Uvicorn встановить і використовуватиме деякі рекомендовані додаткові залежності. + +Зокрема `uvloop` - високопродуктивну заміну «без змін у коді» для `asyncio`, що суттєво підвищує рівночасність і продуктивність. + +Якщо ви встановлюєте FastAPI через `pip install "fastapi[standard]"`, ви вже отримаєте і `uvicorn[standard]`. + +/// + +## Запустіть серверну програму { #run-the-server-program } + +Якщо ви встановили ASGI-сервер вручну, зазвичай потрібно передати рядок імпорту в спеціальному форматі, щоб він імпортував ваш застосунок FastAPI: + +
+ +```console +$ uvicorn main:app --host 0.0.0.0 --port 80 + +INFO: Uvicorn running on http://0.0.0.0:80 (Press CTRL+C to quit) +``` + +
+ +/// note | Примітка + +Команда `uvicorn main:app` означає: + +* `main`: файл `main.py` (Python «модуль»). +* `app`: об'єкт, створений у `main.py` рядком `app = FastAPI()`. + +Це еквівалентно: + +```Python +from main import app +``` + +/// + +Кожна альтернативна ASGI-серверна програма матиме подібну команду; читайте більше в їхній документації. + +/// warning | Попередження + +Uvicorn та інші сервери підтримують опцію `--reload`, корисну під час розробки. + +Опція `--reload` споживає значно більше ресурсів, є менш стабільною тощо. + +Вона дуже допомагає під час розробки, але її не слід використовувати в продакшні. + +/// + +## Концепції розгортання { #deployment-concepts } + +Ці приклади запускають серверну програму (наприклад, Uvicorn), піднімаючи один процес, що слухає всі IP (`0.0.0.0`) на визначеному порту (наприклад, `80`). + +Це базова ідея. Але, ймовірно, вам знадобиться подбати ще про таке: + +* Безпека - HTTPS +* Автозапуск +* Перезапуски +* Реплікація (кількість запущених процесів) +* Пам'ять +* Попередні кроки перед стартом + +У наступних розділах я розповім більше про кожну з цих концепцій, як про них думати, і наведу конкретні приклади та стратегії для їх опрацювання. 🚀 diff --git a/docs/uk/docs/deployment/server-workers.md b/docs/uk/docs/deployment/server-workers.md new file mode 100644 index 0000000000..81a8bd2a4d --- /dev/null +++ b/docs/uk/docs/deployment/server-workers.md @@ -0,0 +1,139 @@ +# Працівники сервера - Uvicorn з працівниками { #server-workers-uvicorn-with-workers } + +Повернімося до попередніх концепцій розгортання: + +- Безпека - HTTPS +- Запуск під час старту +- Перезапуски +- Реплікація (кількість процесів, що виконуються) +- Пам'ять +- Попередні кроки перед запуском + +До цього моменту, проходячи всі навчальні посібники в документації, ви, ймовірно, запускали серверну програму, наприклад, використовуючи команду `fastapi`, яка запускає Uvicorn у вигляді одного процесу. + +Під час розгортання застосунків ви, найімовірніше, захочете мати реплікацію процесів, щоб використовувати кілька ядер і обробляти більше запитів. + +Як ви бачили в попередньому розділі про [Концепції розгортання](concepts.md){.internal-link target=_blank}, існує кілька стратегій, які можна використовувати. + +Тут я покажу, як використовувати Uvicorn із процесами-працівниками за допомогою команди `fastapi` або безпосередньо команди `uvicorn`. + +/// info | Інформація + +Якщо ви використовуєте контейнери, наприклад з Docker або Kubernetes, я розповім про це більше в наступному розділі: [FastAPI у контейнерах - Docker](docker.md){.internal-link target=_blank}. + +Зокрема, під час запуску в Kubernetes вам, найімовірніше, не варто використовувати працівників, натомість запускати один процес Uvicorn на контейнер. Але про це я розповім пізніше в тому розділі. + +/// + +## Кілька працівників { #multiple-workers } + +Ви можете запустити кілька працівників за допомогою параметра командного рядка `--workers`: + +//// tab | `fastapi` + +Якщо ви використовуєте команду `fastapi`: + +
+ +```console +$ fastapi run --workers 4 main.py + + FastAPI Starting production server 🚀 + + Searching for package file structure from directories with + __init__.py files + Importing from /home/user/code/awesomeapp + + module 🐍 main.py + + code Importing the FastAPI app object from the module with the + following code: + + from main import app + + app Using import string: main:app + + server Server started at http://0.0.0.0:8000 + server Documentation at http://0.0.0.0:8000/docs + + Logs: + + INFO Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to + quit) + INFO Started parent process [27365] + INFO Started server process [27368] + INFO Started server process [27369] + INFO Started server process [27370] + INFO Started server process [27367] + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Application startup complete. + INFO Application startup complete. + INFO Application startup complete. + INFO Application startup complete. +``` + +
+ +//// + +//// tab | `uvicorn` + +Якщо ви віддаєте перевагу використовувати команду `uvicorn` безпосередньо: + +
+ +```console +$ uvicorn main:app --host 0.0.0.0 --port 8080 --workers 4 +INFO: Uvicorn running on http://0.0.0.0:8080 (Press CTRL+C to quit) +INFO: Started parent process [27365] +INFO: Started server process [27368] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27369] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27370] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27367] +INFO: Waiting for application startup. +INFO: Application startup complete. +``` + +
+ +//// + +Єдина нова опція тут — `--workers`, яка вказує Uvicorn запустити 4 процеси-працівники. + +Також ви можете побачити, що виводиться PID кожного процесу: `27365` для батьківського процесу (це менеджер процесів) і по одному для кожного процесу-працівника: `27368`, `27369`, `27370` і `27367`. + +## Концепції розгортання { #deployment-concepts } + +Тут ви побачили, як використовувати кілька працівників, щоб паралелізувати виконання застосунку, використати кілька ядер процесора та обслуговувати більше запитів. + +Із наведеного вище списку концепцій розгортання, використання працівників головним чином допоможе з частиною про реплікацію і трохи з перезапусками, але про інше все ще треба подбати: + +- Безпека - HTTPS +- Запуск під час старту +- ***Перезапуски*** +- Реплікація (кількість процесів, що виконуються) +- Пам'ять +- Попередні кроки перед запуском + +## Контейнери і Docker { #containers-and-docker } + +У наступному розділі про [FastAPI у контейнерах - Docker](docker.md){.internal-link target=_blank} я поясню кілька стратегій, які ви можете використати для інших концепцій розгортання. + +Я покажу, як побудувати власний образ з нуля для запуску одного процесу Uvicorn. Це простий процес і, ймовірно, саме те, що потрібно при використанні розподіленої системи керування контейнерами, такої як Kubernetes. + +## Підсумок { #recap } + +Ви можете використовувати кілька процесів-працівників за допомогою параметра CLI `--workers` у командах `fastapi` або `uvicorn`, щоб скористатися перевагами багатоядерних процесорів і запускати кілька процесів паралельно. + +Ви можете застосувати ці інструменти та ідеї, якщо налаштовуєте власну систему розгортання і самостійно дбаєте про інші концепції розгортання. + +Перегляньте наступний розділ, щоб дізнатися про FastAPI з контейнерами (наприклад Docker і Kubernetes). Ви побачите, що ці інструменти також мають прості способи вирішити інші концепції розгортання. ✨ diff --git a/docs/uk/docs/deployment/versions.md b/docs/uk/docs/deployment/versions.md new file mode 100644 index 0000000000..4f6d1b01a2 --- /dev/null +++ b/docs/uk/docs/deployment/versions.md @@ -0,0 +1,93 @@ +# Про версії FastAPI { #about-fastapi-versions } + +**FastAPI** уже використовується у продакшні в багатьох застосунках і системах. Покриття тестами підтримується на рівні 100%. Але розробка все ще рухається швидко. + +Нові можливості додаються часто, помилки регулярно виправляються, а код постійно поліпшується. + +Тому поточні версії все ще `0.x.x`, це відображає те, що кожна версія потенційно може містити несумісні зміни. Це відповідає правилам Семантичного версіонування. + +Ви можете створювати продакшн-застосунки з **FastAPI** вже зараз (і, ймовірно, робите це вже певний час), просто переконайтеся, що ви використовуєте версію, яка коректно працює з рештою вашого коду. + +## Зафіксуйте версію `fastapi` { #pin-your-fastapi-version } + +Перше, що слід зробити, - «зафіксувати» версію **FastAPI**, яку ви використовуєте, до конкретної останньої версії, що, як ви знаєте, правильно працює для вашого застосунку. + +Наприклад, припустімо, що у вашому застосунку використовується версія `0.112.0`. + +Якщо ви використовуєте файл `requirements.txt`, ви можете вказати версію так: + +```txt +fastapi[standard]==0.112.0 +``` + +це означатиме, що ви використовуватимете саме версію `0.112.0`. + +Або ви також можете зафіксувати так: + +```txt +fastapi[standard]>=0.112.0,<0.113.0 +``` + +це означатиме, що ви використовуватимете версії `0.112.0` і вище, але менше `0.113.0`, наприклад, версія `0.112.2` все ще буде прийнятною. + +Якщо ви використовуєте інший інструмент для керування встановленнями, як-от `uv`, Poetry, Pipenv чи інші, у всіх них є спосіб визначати конкретні версії для ваших пакетів. + +## Доступні версії { #available-versions } + +Ви можете переглянути доступні версії (наприклад, щоб перевірити поточну останню) в [Примітках до випусків](../release-notes.md){.internal-link target=_blank}. + +## Про версії { #about-versions } + +Відповідно до правил Семантичного версіонування, будь-яка версія нижче `1.0.0` потенційно може містити несумісні зміни. + +FastAPI також дотримується правила, що будь-яка зміна «PATCH»-версії - це виправлення помилок і зміни без порушень сумісності. + +/// tip | Порада + +«PATCH» - це останнє число, наприклад, у `0.2.3` PATCH-версія - це `3`. + +/// + +Тож ви можете зафіксувати версію так: + +```txt +fastapi>=0.45.0,<0.46.0 +``` + +Несумісні зміни та нові можливості додаються у «MINOR»-версіях. + +/// tip | Порада + +«MINOR» - це число посередині, наприклад, у `0.2.3` MINOR-версія - це `2`. + +/// + +## Оновлення версій FastAPI { #upgrading-the-fastapi-versions } + +Ви повинні додати тести для вашого застосунку. + +З **FastAPI** це дуже легко (завдяки Starlette), перегляньте документацію: [Тестування](../tutorial/testing.md){.internal-link target=_blank} + +Після того як у вас є тести, ви можете оновити версію **FastAPI** до новішої і переконатися, що весь ваш код працює правильно, запустивши тести. + +Якщо все працює або після внесення необхідних змін і проходження всіх тестів, зафіксуйте вашу версію `fastapi` на цій новій версії. + +## Про Starlette { #about-starlette } + +Не варто фіксувати версію `starlette`. + +Різні версії **FastAPI** використовуватимуть конкретну новішу версію Starlette. + +Отже, просто дозвольте **FastAPI** використовувати відповідну версію Starlette. + +## Про Pydantic { #about-pydantic } + +Pydantic включає тести для **FastAPI** разом із власними тестами, тому нові версії Pydantic (вище `1.0.0`) завжди сумісні з FastAPI. + +Ви можете зафіксувати Pydantic на будь-якій версії вище `1.0.0`, яка вам підходить. + +Наприклад: + +```txt +pydantic>=2.7.0,<3.0.0 +``` diff --git a/docs/uk/docs/environment-variables.md b/docs/uk/docs/environment-variables.md new file mode 100644 index 0000000000..b61fd011f6 --- /dev/null +++ b/docs/uk/docs/environment-variables.md @@ -0,0 +1,298 @@ +# Змінні оточення { #environment-variables } + +/// tip | Порада + +Якщо ви вже знаєте, що таке «змінні оточення» і як їх використовувати, можете пропустити цей розділ. + +/// + +Змінна оточення (також відома як «env var») - це змінна, що існує поза кодом Python, в операційній системі, і може бути прочитана вашим кодом Python (а також іншими програмами). + +Змінні оточення корисні для роботи з налаштуваннями застосунку, як частина встановлення Python тощо. + +## Створення і використання змінних оточення { #create-and-use-env-vars } + +Ви можете створювати і використовувати змінні оточення в оболонці (терміналі) без участі Python: + +//// tab | Linux, macOS, Windows Bash + +
+ +```console +// Ви можете створити змінну оточення MY_NAME командою +$ export MY_NAME="Wade Wilson" + +// Потім можна використати її з іншими програмами, наприклад +$ echo "Hello $MY_NAME" + +Hello Wade Wilson +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +// Створіть змінну оточення MY_NAME +$ $Env:MY_NAME = "Wade Wilson" + +// Використайте її з іншими програмами, наприклад +$ echo "Hello $Env:MY_NAME" + +Hello Wade Wilson +``` + +
+ +//// + +## Читання змінних оточення в Python { #read-env-vars-in-python } + +Ви також можете створити змінні оточення поза Python, у терміналі (або будь-яким іншим способом), а потім зчитати їх у Python. + +Наприклад, у вас може бути файл `main.py` з: + +```Python hl_lines="3" +import os + +name = os.getenv("MY_NAME", "World") +print(f"Hello {name} from Python") +``` + +/// tip | Порада + +Другий аргумент до `os.getenv()` - це значення за замовчуванням, яке буде повернено. + +Якщо його не вказано, за замовчуванням це `None`. Тут ми надаємо `"World"` як значення за замовчуванням. + +/// + +Потім ви можете запустити цю програму Python: + +//// tab | Linux, macOS, Windows Bash + +
+ +```console +// Тут ми ще не встановлюємо змінну оточення +$ python main.py + +// Оскільки ми не встановили змінну оточення, отримуємо значення за замовчуванням + +Hello World from Python + +// Але якщо спочатку створимо змінну оточення +$ export MY_NAME="Wade Wilson" + +// А потім знову викличемо програму +$ python main.py + +// Тепер вона може прочитати змінну оточення + +Hello Wade Wilson from Python +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +// Тут ми ще не встановлюємо змінну оточення +$ python main.py + +// Оскільки ми не встановили змінну оточення, отримуємо значення за замовчуванням + +Hello World from Python + +// Але якщо спочатку створимо змінну оточення +$ $Env:MY_NAME = "Wade Wilson" + +// А потім знову викличемо програму +$ python main.py + +// Тепер вона може прочитати змінну оточення + +Hello Wade Wilson from Python +``` + +
+ +//// + +Оскільки змінні оточення можна встановлювати поза кодом, але читати в коді, і їх не потрібно зберігати (фіксувати у `git`) разом з іншими файлами, їх часто використовують для конфігурацій або налаштувань. + +Ви також можете створити змінну оточення лише для конкретного запуску програми, вона буде доступна тільки цій програмі і лише на час її виконання. + +Щоб зробити це, створіть її безпосередньо перед командою запуску програми, в тому самому рядку: + +
+ +```console +// Створіть змінну оточення MY_NAME безпосередньо в цьому виклику програми +$ MY_NAME="Wade Wilson" python main.py + +// Тепер вона може прочитати змінну оточення + +Hello Wade Wilson from Python + +// Після цього змінна оточення більше не існує +$ python main.py + +Hello World from Python +``` + +
+ +/// tip | Порада + +Докладніше про це можна прочитати у The Twelve-Factor App: Config. + +/// + +## Типи і перевірка { #types-and-validation } + +Ці змінні оточення можуть містити лише текстові строки, оскільки вони зовнішні щодо Python і мають бути сумісними з іншими програмами та рештою системи (і навіть з різними операційними системами, як-от Linux, Windows, macOS). + +Це означає, що будь-яке значення, прочитане в Python зі змінної оточення, буде `str`, а будь-яке перетворення до іншого типу або будь-яка перевірка має виконуватися в коді. + +Ви дізнаєтеся більше про використання змінних оточення для роботи з налаштуваннями застосунку в розділі [Просунутий посібник користувача - Налаштування і змінні оточення](./advanced/settings.md){.internal-link target=_blank}. + +## Змінна оточення `PATH` { #path-environment-variable } + +Є спеціальна змінна оточення `PATH`, яку використовують операційні системи (Linux, macOS, Windows) для пошуку програм для запуску. + +Значення змінної `PATH` - це довга строка, що складається з каталогів, розділених двокрапкою `:` у Linux і macOS та крапкою з комою `;` у Windows. + +Наприклад, змінна оточення `PATH` може виглядати так: + +//// tab | Linux, macOS + +```plaintext +/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin +``` + +Це означає, що система має шукати програми в каталогах: + +* `/usr/local/bin` +* `/usr/bin` +* `/bin` +* `/usr/sbin` +* `/sbin` + +//// + +//// tab | Windows + +```plaintext +C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32 +``` + +Це означає, що система має шукати програми в каталогах: + +* `C:\Program Files\Python312\Scripts` +* `C:\Program Files\Python312` +* `C:\Windows\System32` + +//// + +Коли ви вводите команду в терміналі, операційна система шукає програму в кожному з тих каталогів, перелічених у змінній оточення `PATH`. + +Наприклад, коли ви вводите `python` у терміналі, операційна система шукає програму з назвою `python` у першому каталозі цього списку. + +Якщо знайде, вона використає її. Інакше продовжить пошук в інших каталогах. + +### Встановлення Python і оновлення `PATH` { #installing-python-and-updating-the-path } + +Під час встановлення Python вас можуть запитати, чи хочете ви оновити змінну оточення `PATH`. + +//// tab | Linux, macOS + +Припустімо, ви встановлюєте Python і він опиняється в каталозі `/opt/custompython/bin`. + +Якщо ви погодитеся оновити змінну оточення `PATH`, інсталятор додасть `/opt/custompython/bin` до змінної `PATH`. + +Це може виглядати так: + +```plaintext +/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/custompython/bin +``` + +Тепер, коли ви введете `python` у терміналі, система знайде програму Python у `/opt/custompython/bin` (останній каталог) і використає саме її. + +//// + +//// tab | Windows + +Припустімо, ви встановлюєте Python і він опиняється в каталозі `C:\opt\custompython\bin`. + +Якщо ви погодитеся оновити змінну оточення `PATH`, інсталятор додасть `C:\opt\custompython\bin` до змінної `PATH`. + +```plaintext +C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32;C:\opt\custompython\bin +``` + +Тепер, коли ви введете `python` у терміналі, система знайде програму Python у `C:\opt\custompython\bin` (останній каталог) і використає саме її. + +//// + +Отже, якщо ви введете: + +
+ +```console +$ python +``` + +
+ +//// tab | Linux, macOS + +Система знайде програму `python` у `/opt/custompython/bin` і запустить її. + +Це приблизно еквівалентно введенню: + +
+ +```console +$ /opt/custompython/bin/python +``` + +
+ +//// + +//// tab | Windows + +Система знайде програму `python` у `C:\opt\custompython\bin\python` і запустить її. + +Це приблизно еквівалентно введенню: + +
+ +```console +$ C:\opt\custompython\bin\python +``` + +
+ +//// + +Ця інформація стане у пригоді під час вивчення [Віртуальних середовищ](virtual-environments.md){.internal-link target=_blank}. + +## Висновок { #conclusion } + +Тепер ви маєте базове розуміння того, що таке змінні оточення і як їх використовувати в Python. + +Також можна прочитати більше у Вікіпедії про змінну оточення. + +У багатьох випадках не одразу очевидно, як змінні оточення будуть корисними та застосовними. Але вони постійно з’являються в різних сценаріях під час розробки, тож варто про них знати. + +Наприклад, вам знадобиться ця інформація в наступному розділі про [Віртуальні середовища](virtual-environments.md). diff --git a/docs/uk/docs/help-fastapi.md b/docs/uk/docs/help-fastapi.md new file mode 100644 index 0000000000..a98e56c260 --- /dev/null +++ b/docs/uk/docs/help-fastapi.md @@ -0,0 +1,256 @@ +# Допоможіть FastAPI - отримайте допомогу { #help-fastapi-get-help } + +Вам подобається **FastAPI**? + +Хочете допомогти FastAPI, іншим користувачам та автору? + +Або ви хочете отримати допомогу щодо **FastAPI**? + +Є дуже прості способи допомогти (деякі потребують лише одного-двох кліків). + +І є кілька способів отримати допомогу. + +## Підпишіться на розсилку { #subscribe-to-the-newsletter } + +Ви можете підписатися на (нечасту) розсилку [**FastAPI and friends**](newsletter.md){.internal-link target=_blank}, щоб бути в курсі: + +* Новин про FastAPI та друзів 🚀 +* Посібників 📝 +* Можливостей ✨ +* Несумісних змін 🚨 +* Порад і трюків ✅ + +## Стежте за FastAPI в X (Twitter) { #follow-fastapi-on-x-twitter } + +Стежте за @fastapi в **X (Twitter)**, щоб отримувати найсвіжіші новини про **FastAPI**. 🐦 + +## Додайте зірочку **FastAPI** на GitHub { #star-fastapi-in-github } + +Ви можете «поставити зірочку» FastAPI на GitHub (натиснувши кнопку зірочки у верхньому правому куті): https://github.com/fastapi/fastapi. ⭐️ + +Додавши зірочку, іншим користувачам буде легше його знайти і побачити, що він уже був корисним для інших. + +## Стежте за випусками в репозиторії GitHub { #watch-the-github-repository-for-releases } + +Ви можете «спостерігати» за FastAPI на GitHub (натиснувши кнопку «watch» у верхньому правому куті): https://github.com/fastapi/fastapi. 👀 + +Там ви можете вибрати «Releases only». + +Зробивши це, ви отримуватимете сповіщення (на вашу електронну пошту) щоразу, коли вийде новий реліз (нова версія) **FastAPI** з виправленнями помилок і новими можливостями. + +## Зв'яжіться з автором { #connect-with-the-author } + +Ви можете зв'язатися зі мною (Sebastián Ramírez / `tiangolo`), автором. + +Ви можете: + +* Стежити за мною на **GitHub**. + * Подивитися інші Open Source-проєкти, які я створив і які можуть вам допомогти. + * Стежити, щоб бачити, коли я створюю новий Open Source-проєкт. +* Стежити за мною в **X (Twitter)** або Mastodon. + * Розкажіть мені, як ви використовуєте FastAPI (мені дуже приємно це чути). + * Дізнаватися, коли я роблю оголошення або випускаю нові інструменти. + * Також ви можете стежити за @fastapi в X (Twitter) (окремий акаунт). +* Стежити за мною в **LinkedIn**. + * Дізнаватися, коли я роблю оголошення або випускаю нові інструменти (хоча X (Twitter) я використовую частіше 🤷‍♂). +* Читати, що я пишу (або стежити за мною) на **Dev.to** або **Medium**. + * Читати інші ідеї, статті та про інструменти, які я створив. + * Стежити, щоб читати нове, коли я щось публікую. + +## Твітніть про **FastAPI** { #tweet-about-fastapi } + +Твітніть про **FastAPI** і дайте мені та іншим знати, чому він вам подобається. 🎉 + +Мені дуже подобається дізнаватися, як використовують **FastAPI**, що вам у ньому сподобалося, у якому проєкті/компанії ви його застосовуєте тощо. + +## Голосуйте за FastAPI { #vote-for-fastapi } + +* Проголосуйте за **FastAPI** на Slant. +* Проголосуйте за **FastAPI** на AlternativeTo. +* Повідомте, що ви використовуєте **FastAPI**, на StackShare. + +## Допомагайте іншим з питаннями на GitHub { #help-others-with-questions-in-github } + +Ви можете спробувати допомагати іншим з їхніми питаннями у: + +* GitHub Discussions +* GitHub Issues + +У багатьох випадках ви вже можете знати відповідь на ці питання. 🤓 + +Якщо ви багато допомагаєте людям із їхніми питаннями, ви станете офіційним [Експертом FastAPI](fastapi-people.md#fastapi-experts){.internal-link target=_blank}. 🎉 + +Пам'ятайте, найважливіше: намагайтеся бути добрими. Люди приходять зі своєю фрустрацією і часто питають не найкращим чином, але постарайтеся бути якомога доброзичливішими. 🤗 + +Ідея в тому, щоб спільнота **FastAPI** була доброзичливою та гостинною. Водночас не терпіть булінг чи неповажну поведінку щодо інших. Ми маємо піклуватися одне про одного. + +--- + +Ось як допомагати іншим із питаннями (у discussions або issues): + +### Зрозумійте питання { #understand-the-question } + +* Перевірте, чи розумієте ви **мету** та варіант використання людини, яка питає. + +* Потім перевірте, чи **чітке** саме питання (переважна більшість — це питання). + +* Часто запит стосується уявного рішення користувача, але може бути **краще**. Якщо ви краще зрозумієте проблему та варіант використання, зможете запропонувати кращу **альтернативу**. + +* Якщо ви не розумієте питання, попросіть більше **подробиць**. + +### Відтворіть проблему { #reproduce-the-problem } + +У більшості випадків і запитань мова йде про **оригінальний код** людини. + +Часто вони наводять лише фрагмент коду, але цього недостатньо, щоб **відтворити проблему**. + +* Ви можете попросити надати мінімальний, відтворюваний приклад, який ви зможете **скопіювати-вставити** і запустити локально, щоб побачити ту саму помилку або поведінку, яку бачать вони, або краще зрозуміти їхній варіант використання. + +* Якщо ви дуже щедрі, можете спробувати **створити такий приклад** самостійно, лише на основі опису проблеми. Просто майте на увазі, що це може зайняти багато часу, і краще спочатку попросити їх уточнити проблему. + +### Запропонуйте рішення { #suggest-solutions } + +* Після того як ви змогли зрозуміти питання, дайте можливу **відповідь**. + +* Часто краще зрозуміти їхню **первинну проблему або варіант використання**, адже може бути кращий спосіб її вирішити, ніж те, що вони намагаються зробити. + +### Попросіть закрити { #ask-to-close } + +Якщо вони відповіли, дуже ймовірно, що ви розв'язали їхню проблему. Вітаю, **ви герой**! 🦸 + +* Тепер, якщо це вирішило їхню проблему, ви можете попросити: + + * У GitHub Discussions: позначити коментар як **відповідь**. + * У GitHub Issues: **закрити** issue. + +## Стежте за репозиторієм GitHub { #watch-the-github-repository } + +Ви можете «спостерігати» за FastAPI на GitHub (натиснувши кнопку «watch» у верхньому правому куті): https://github.com/fastapi/fastapi. 👀 + +Якщо вибрати «Watching» замість «Releases only», ви отримуватимете сповіщення, коли хтось створює нове issue або питання. Ви також можете вказати, що хочете отримувати сповіщення лише про нові issues, або discussions, або PR тощо. + +Тоді ви зможете спробувати допомогти їм вирішити ці питання. + +## Ставте питання { #ask-questions } + +Ви можете створити нове питання у репозиторії GitHub, наприклад, щоб: + +* Поставити **питання** або запитати про **проблему**. +* Запропонувати нову **можливість**. + +**Примітка**: якщо ви це зробите, я попрошу вас також допомагати іншим. 😉 + +## Переглядайте запити на витяг { #review-pull-requests } + +Ви можете допомогти мені переглядати запити на витяг інших. + +І знову, будь ласка, намагайтеся бути якомога доброзичливішими. 🤗 + +--- + +Ось що слід пам'ятати і як переглядати запит на витяг: + +### Зрозумійте проблему { #understand-the-problem } + +* Спочатку переконайтеся, що ви **розумієте проблему**, яку намагається вирішити запит на витяг. Може бути довша дискусія у GitHub Discussion або issue. + +* Також є велика ймовірність, що запит на витяг насправді не потрібен, бо проблему можна розв'язати **іншим способом**. Тоді ви можете про це запропонувати або запитати. + +### Не переймайтеся стилем { #dont-worry-about-style } + +* Не надто хвилюйтеся про стиль повідомлень фіксацій, я зроблю squash and merge, налаштувавши фіксацію вручну. + +* Також не переймайтеся правилами стилю, вже є автоматизовані інструменти, що це перевіряють. + +А якщо будуть інші вимоги щодо стилю чи узгодженості, я попрошу про це безпосередньо або додам зверху фіксації з потрібними змінами. + +### Перевірте код { #check-the-code } + +* Перегляньте та прочитайте код, оцініть, чи він має сенс, **запустіть його локально** і перевірте, чи справді він розв'язує проблему. + +* Потім залиште **коментар**, що ви це зробили, так я знатиму, що ви справді перевірили. + +/// info | Інформація + +На жаль, я не можу просто довіряти PR, які мають кілька схвалень. + +Бувало не раз, що PR мали 3, 5 або більше схвалень, мабуть тому, що опис привабливий, але коли я перевіряв PR, вони виявлялися зламаними, мали помилку або не розв'язували заявлену проблему. 😅 + +Тож дуже важливо, щоб ви справді прочитали і запустили код та повідомили в коментарях, що ви це зробили. 🤓 + +/// + +* Якщо PR можна якось спростити, ви можете про це попросити, але немає потреби бути надто прискіпливими, адже може бути багато суб'єктивних точок зору (і в мене також є своя 🙈), тож краще зосередитися на фундаментальних речах. + +### Тести { #tests } + +* Допоможіть перевірити, що PR має **тести**. + +* Переконайтеся, що тести **падають** до PR. 🚨 + +* Потім перевірте, що тести **проходять** після PR. ✅ + +* Багато PRів не мають тестів, ви можете **нагадати** додати тести або навіть **запропонувати** деякі тести самі. Це одна з речей, яка найбільше забирає часу, і ви дуже допоможете. + +* Потім також прокоментуйте, що саме ви спробували, так я знатиму, що ви це перевірили. 🤓 + +## Створіть запит на витяг { #create-a-pull-request } + +Ви можете [зробити внесок](contributing.md){.internal-link target=_blank} у вихідний код із запитами на витяг, наприклад: + +* Щоб виправити описку, знайдену в документації. +* Щоб поділитися статтею, відео або подкастом про FastAPI, який ви створили або знайшли, відредагувавши цей файл. + * Обов'язково додайте ваше посилання на початок відповідного розділу. +* Щоб допомогти [перекласти документацію](contributing.md#translations){.internal-link target=_blank} вашою мовою. + * Ви також можете допомогти з переглядом перекладів, створених іншими. +* Щоб запропонувати нові розділи документації. +* Щоб виправити наявну проблему/помилку. + * Обов'язково додайте тести. +* Щоб додати нову можливість. + * Обов'язково додайте тести. + * Обов'язково додайте документацію, якщо це доречно. + +## Допоможіть підтримувати FastAPI { #help-maintain-fastapi } + +Допоможіть мені підтримувати **FastAPI**! 🤓 + +Роботи багато, і більшу її частину можете зробити **ВИ**. + +Основні завдання, які ви можете виконувати вже зараз: + +* [Допомагайте іншим з питаннями на GitHub](#help-others-with-questions-in-github){.internal-link target=_blank} (див. розділ вище). +* [Переглядайте запити на витяг](#review-pull-requests){.internal-link target=_blank} (див. розділ вище). + +Ці два завдання **найбільше споживають час**. Це основна робота з підтримки FastAPI. + +Якщо ви можете допомогти мені з цим, **ви допомагаєте підтримувати FastAPI** і гарантуєте, що він **рухатиметься швидше й краще**. 🚀 + +## Долучайтеся до чату { #join-the-chat } + +Долучайтеся до 👥 серверу чату Discord 👥 і спілкуйтеся з іншими в спільноті FastAPI. + +/// tip | Порада + +Для запитань ставте їх у GitHub Discussions, там значно вища ймовірність, що вам допоможуть [Експерти FastAPI](fastapi-people.md#fastapi-experts){.internal-link target=_blank}. + +Використовуйте чат лише для інших загальних розмов. + +/// + +### Не використовуйте чат для запитань { #dont-use-the-chat-for-questions } + +Майте на увазі, що оскільки чати дозволяють більше «вільної розмови», легко ставити надто загальні питання, на які складніше відповісти, тож ви можете не отримати відповідей. + +У GitHub шаблон підкаже вам, як написати правильне питання, щоб ви легше отримали хорошу відповідь, або навіть вирішили проблему самостійно ще до запиту. І в GitHub я можу гарантувати, що завжди на все відповім, навіть якщо це займе трохи часу. Особисто я не можу робити це в чатах. 😅 + +Розмови в чатах також не так просто шукати, як у GitHub, тож питання та відповіді можуть загубитися. І лише ті, що в GitHub, зараховуються, щоб стати [Експертом FastAPI](fastapi-people.md#fastapi-experts){.internal-link target=_blank}, тож швидше за все ви отримаєте більше уваги саме в GitHub. + +З іншого боку, у чатах є тисячі користувачів, тож дуже ймовірно, що ви майже завжди знайдете там співрозмовника. 😄 + +## Спонсоруйте автора { #sponsor-the-author } + +Якщо ваш **продукт/компанія** залежить від **FastAPI** або пов'язана з ним і ви хочете охопити його користувачів, ви можете спонсорувати автора (мене) через GitHub sponsors. Залежно від рівня ви можете отримати додаткові переваги, наприклад значок у документації. 🎁 + +--- + +Дякую! 🚀 diff --git a/docs/uk/docs/history-design-future.md b/docs/uk/docs/history-design-future.md new file mode 100644 index 0000000000..1897807c84 --- /dev/null +++ b/docs/uk/docs/history-design-future.md @@ -0,0 +1,79 @@ +# Історія, проєктування і майбутнє { #history-design-and-future } + +Деякий час тому користувач **FastAPI** запитав: + +> Яка історія цього проєкту? Здається, він нізвідки за кілька тижнів став чудовим [...] + +Ось трохи цієї історії. + +## Альтернативи { #alternatives } + +Я створював API зі складними вимогами протягом кількох років (машинне навчання, розподілені системи, асинхронні завдання, бази даних NoSQL тощо), очолюючи кілька команд розробників. + +У межах цього мені довелося досліджувати, тестувати й використовувати багато альтернатив. + +Історія **FastAPI** значною мірою - це історія його попередників. + +Як сказано в розділі [Альтернативи](alternatives.md){.internal-link target=_blank}: + +
+ +**FastAPI** не існував би без попередньої роботи інших. + +Було створено багато інструментів, які надихнули на його створення. + +Я роками уникав створення нового фреймворку. Спочатку я намагався вирішити всі можливості, які покриває **FastAPI**, використовуючи різні фреймворки, плагіни та інструменти. + +Але в певний момент не залишилося іншого варіанту, окрім створити щось, що надає всі ці можливості, узявши найкращі ідеї з попередніх інструментів і поєднавши їх якнайкраще, використовуючи можливості самої мови, яких раніше взагалі не було (підказки типів Python 3.6+). + +
+ +## Дослідження { #investigation } + +Використовуючи всі попередні альтернативи, я мав змогу повчитися в кожної, узяти ідеї й поєднати їх якнайкраще для себе та команд розробників, з якими працював. + +Наприклад, було очевидно, що в ідеалі все має ґрунтуватися на стандартних підказках типів Python. + +Також найкращим підходом було використовувати вже наявні стандарти. + +Тож, ще до початку написання коду **FastAPI**, я провів кілька місяців, вивчаючи специфікації OpenAPI, Схеми JSON, OAuth2 тощо. Розуміючи їхні взаємозв'язки, перетини та відмінності. + +## Проєктування { #design } + +Потім я приділив час проєктуванню «API» для розробника, яке я хотів мати як користувач (як розробник, що використовує FastAPI). + +Я протестував кілька ідей у найпопулярніших Python-редакторах: PyCharm, VS Code, редакторах на основі Jedi. + +За даними Python Developer Survey, це охоплює близько 80% користувачів. + +Це означає, що **FastAPI** спеціально тестувався з редакторами, якими користуються 80% розробників Python. І оскільки більшість інших редакторів працюють подібно, усі ці переваги мають працювати практично у всіх редакторах. + +Так я зміг знайти найкращі способи максимально зменшити дублювання коду, забезпечити автодоповнення всюди, перевірки типів і помилок тощо. + +І все це так, щоб надати найкращий досвід розробки для всіх розробників. + +## Вимоги { #requirements } + +Після перевірки кількох альтернатив я вирішив використовувати **Pydantic** через його переваги. + +Потім я зробив внески до нього, щоб зробити його повністю сумісним із Схемою JSON, додати підтримку різних способів оголошення обмежень і поліпшити підтримку редакторів (перевірки типів, автодоповнення) на основі тестів у кількох редакторах. + +Під час розробки я також зробив внески до **Starlette**, іншої ключової залежності. + +## Розробка { #development } + +Коли я взявся безпосередньо за створення **FastAPI**, більшість складових уже були на місцях: дизайн визначено, вимоги та інструменти підготовлено, знання про стандарти й специфікації - чіткі та свіжі. + +## Майбутнє { #future } + +На цей момент уже зрозуміло, що **FastAPI** зі своїми ідеями корисний для багатьох. + +Його обирають замість попередніх альтернатив, бо він краще відповідає багатьом сценаріям використання. + +Багато розробників і команд уже залежать від **FastAPI** у своїх проєктах (включно зі мною та моєю командою). + +Але попереду ще багато покращень і можливостей. + +**FastAPI** має велике майбутнє. + +І [ваша допомога](help-fastapi.md){.internal-link target=_blank} дуже цінується. diff --git a/docs/uk/docs/how-to/authentication-error-status-code.md b/docs/uk/docs/how-to/authentication-error-status-code.md new file mode 100644 index 0000000000..58016f261b --- /dev/null +++ b/docs/uk/docs/how-to/authentication-error-status-code.md @@ -0,0 +1,17 @@ +# Використовуйте старі коди статусу помилки автентифікації 403 { #use-old-403-authentication-error-status-codes } + +До версії FastAPI `0.122.0`, коли інтегровані засоби безпеки повертали клієнту помилку після невдалої автентифікації, вони використовували HTTP код статусу `403 Forbidden`. + +Починаючи з версії FastAPI `0.122.0`, вони використовують більш доречний HTTP код статусу `401 Unauthorized` і повертають змістовний заголовок `WWW-Authenticate` у відповіді, відповідно до специфікацій HTTP, RFC 7235, RFC 9110. + +Але якщо з якоїсь причини ваші клієнти залежать від старої поведінки, ви можете повернутися до неї, переписавши метод `make_not_authenticated_error` у ваших класах безпеки. + +Наприклад, ви можете створити підклас `HTTPBearer`, який повертатиме помилку `403 Forbidden` замість типового `401 Unauthorized`: + +{* ../../docs_src/authentication_error_status_code/tutorial001_an_py310.py hl[9:13] *} + +/// tip | Порада + +Зверніть увагу, що функція повертає екземпляр винятку, вона не породжує його. Породження відбувається в іншій частині внутрішнього коду. + +/// diff --git a/docs/uk/docs/how-to/conditional-openapi.md b/docs/uk/docs/how-to/conditional-openapi.md new file mode 100644 index 0000000000..f8bbaa6498 --- /dev/null +++ b/docs/uk/docs/how-to/conditional-openapi.md @@ -0,0 +1,56 @@ +# Умовний OpenAPI { #conditional-openapi } + +Якщо потрібно, ви можете використовувати налаштування і змінні оточення, щоб умовно налаштовувати OpenAPI залежно від середовища, а також повністю вимикати його. + +## Про безпеку, API та документацію { #about-security-apis-and-docs } + +Приховування інтерфейсів документації у продукційному середовищі *не має* бути способом захисту вашого API. + +Це не додає жодної додаткової безпеки вашому API, *операції шляху* й надалі будуть доступні там, де вони є. + +Якщо у вашому коді є вразливість, вона залишиться. + +Приховування документації лише ускладнює розуміння того, як взаємодіяти з вашим API, і може ускладнити для вас його налагодження у продакшні. Це можна вважати просто формою Безпека через неясність. + +Якщо ви хочете захистити ваш API, є кілька кращих дій, які ви можете зробити, наприклад: + +- Переконайтеся, що у вас добре визначені моделі Pydantic для тіл запитів і відповідей. +- Налаштуйте потрібні дозволи та ролі за допомогою залежностей. +- Ніколи не зберігайте паролі у відкритому вигляді, лише хеші паролів. +- Реалізуйте та використовуйте відомі криптографічні інструменти, як-от pwdlib і токени JWT. +- Додайте більш детальний контроль дозволів із областями OAuth2 там, де це потрібно. +- ...тощо. + +Втім, у вас може бути дуже специфічний випадок використання, коли справді потрібно вимкнути документацію API для певного середовища (наприклад, для продакшну) або залежно від конфігурацій зі змінних оточення. + +## Умовний OpenAPI з налаштувань і змінних оточення { #conditional-openapi-from-settings-and-env-vars } + +Ви можете легко використати ті самі налаштування Pydantic, щоб налаштувати згенерований OpenAPI та інтерфейси документації. + +Наприклад: + +{* ../../docs_src/conditional_openapi/tutorial001_py310.py hl[6,11] *} + +Тут ми оголошуємо налаштування `openapi_url` з тим самим значенням за замовчуванням `"/openapi.json"`. + +Потім ми використовуємо його під час створення застосунку `FastAPI`. + +Далі ви можете вимкнути OpenAPI (включно з інтерфейсами документації), встановивши змінну оточення `OPENAPI_URL` у пусту строку, наприклад: + +
+ +```console +$ OPENAPI_URL= uvicorn main:app + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Потім, якщо ви перейдете за URL `/openapi.json`, `/docs` або `/redoc`, ви просто отримаєте помилку `404 Not Found` на кшталт: + +```JSON +{ + "detail": "Not Found" +} +``` diff --git a/docs/uk/docs/how-to/configure-swagger-ui.md b/docs/uk/docs/how-to/configure-swagger-ui.md new file mode 100644 index 0000000000..f8c4470dfa --- /dev/null +++ b/docs/uk/docs/how-to/configure-swagger-ui.md @@ -0,0 +1,70 @@ +# Налаштуйте Swagger UI { #configure-swagger-ui } + +Ви можете налаштувати додаткові параметри Swagger UI. + +Щоб їх налаштувати, передайте аргумент `swagger_ui_parameters` під час створення об’єкта додатка `FastAPI()` або до функції `get_swagger_ui_html()`. + +`swagger_ui_parameters` отримує словник із налаштуваннями, що передаються безпосередньо до Swagger UI. + +FastAPI перетворює ці налаштування на **JSON**, щоб зробити їх сумісними з JavaScript, оскільки саме це потрібно Swagger UI. + +## Вимкніть підсвітку синтаксису { #disable-syntax-highlighting } + +Наприклад, ви можете вимкнути підсвітку синтаксису в Swagger UI. + +Без змін у налаштуваннях підсвітка синтаксису увімкнена за замовчуванням: + + + +Але ви можете вимкнути її, встановивши `syntaxHighlight` у `False`: + +{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *} + +...після цього Swagger UI більше не показуватиме підсвітку синтаксису: + + + +## Змініть тему { #change-the-theme } + +Так само ви можете задати тему підсвітки синтаксису ключем `"syntaxHighlight.theme"` (зверніть увагу, що посередині є крапка): + +{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *} + +Це налаштування змінить колірну тему підсвітки синтаксису: + + + +## Змініть параметри Swagger UI за замовчуванням { #change-default-swagger-ui-parameters } + +FastAPI містить деякі параметри конфігурації за замовчуванням, що підходять для більшості випадків. + +Вони включають такі типові налаштування: + +{* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *} + +Ви можете переписати будь-яке з них, задавши інше значення в аргументі `swagger_ui_parameters`. + +Наприклад, щоб вимкнути `deepLinking`, ви можете передати такі налаштування до `swagger_ui_parameters`: + +{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *} + +## Інші параметри Swagger UI { #other-swagger-ui-parameters } + +Щоб побачити всі можливі налаштування, які ви можете використовувати, прочитайте офіційну документацію щодо параметрів Swagger UI. + +## Налаштування лише для JavaScript { #javascript-only-settings } + +Swagger UI також дозволяє інші налаштування як об’єкти, що є тільки для **JavaScript** (наприклад, функції JavaScript). + +FastAPI також включає такі налаштування `presets`, що є лише для JavaScript: + +```JavaScript +presets: [ + SwaggerUIBundle.presets.apis, + SwaggerUIBundle.SwaggerUIStandalonePreset +] +``` + +Це об’єкти **JavaScript**, а не строки, тому ви не можете передати їх безпосередньо з коду Python. + +Якщо вам потрібно використати такі налаштування лише для JavaScript, скористайтеся одним із методів вище. Повністю перепишіть операцію шляху Swagger UI та вручну напишіть потрібний JavaScript. diff --git a/docs/uk/docs/how-to/custom-docs-ui-assets.md b/docs/uk/docs/how-to/custom-docs-ui-assets.md new file mode 100644 index 0000000000..faea3ccc4a --- /dev/null +++ b/docs/uk/docs/how-to/custom-docs-ui-assets.md @@ -0,0 +1,185 @@ +# Користувацькі статичні ресурси інтерфейсу документації (самохостинг) { #custom-docs-ui-static-assets-self-hosting } + +Документація API використовує **Swagger UI** і **ReDoc**, і кожному з них потрібні файли JavaScript та CSS. + +Типово ці файли віддаються з CDN. + +Але це можна налаштувати: ви можете вказати конкретний CDN або віддавати файли самостійно. + +## Власний CDN для JavaScript і CSS { #custom-cdn-for-javascript-and-css } + +Припустімо, що ви хочете використовувати інший CDN, наприклад `https://unpkg.com/`. + +Це може бути корисно, якщо, наприклад, ви живете в країні, що обмежує деякі URL-адреси. + +### Вимкніть автоматичну документацію { #disable-the-automatic-docs } + +Перший крок - вимкнути автоматичну документацію, адже типово вона використовує стандартний CDN. + +Щоб їх вимкнути, встановіть їхні URL у `None` під час створення вашого застосунку `FastAPI`: + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[8] *} + +### Додайте користувацьку документацію { #include-the-custom-docs } + +Тепер ви можете створити *операції шляху* для користувацької документації. + +Ви можете перевикористати внутрішні функції FastAPI для створення HTML-сторінок документації і передати їм потрібні аргументи: + +- `openapi_url`: URL, за яким HTML-сторінка документації зможе отримати схему OpenAPI для вашого API. Тут можна використати атрибут `app.openapi_url`. +- `title`: заголовок вашого API. +- `oauth2_redirect_url`: тут можна використати `app.swagger_ui_oauth2_redirect_url`, щоб узяти значення за замовчуванням. +- `swagger_js_url`: URL, за яким HTML для Swagger UI зможе отримати файл **JavaScript**. Це URL вашого користувацького CDN. +- `swagger_css_url`: URL, за яким HTML для Swagger UI зможе отримати файл **CSS**. Це URL вашого користувацького CDN. + +Аналогічно для ReDoc... + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[2:6,11:19,22:24,27:33] *} + +/// tip | Порада + +*Операція шляху* для `swagger_ui_redirect` - це допоміжний маршрут, коли ви використовуєте OAuth2. + +Якщо ви інтегруєте ваш API з провайдером OAuth2, ви зможете автентифікуватися і повернутися до документації API з отриманими обліковими даними. І взаємодіяти з ним, використовуючи реальну автентифікацію OAuth2. + +Swagger UI впорається з цим «за лаштунками», але йому потрібен цей «redirect» хелпер. + +/// + +### Створіть операцію шляху для перевірки { #create-a-path-operation-to-test-it } + +Тепер, щоб перевірити, що все працює, створіть *операцію шляху*: + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[36:38] *} + +### Перевірте { #test-it } + +Тепер ви маєте змогу відкрити документацію за http://127.0.0.1:8000/docs і перезавантажити сторінку, вона завантажить ці ресурси з нового CDN. + +## Самохостинг JavaScript і CSS для документації { #self-hosting-javascript-and-css-for-docs } + +Самохостинг JavaScript і CSS може бути корисним, якщо, наприклад, ваш застосунок має працювати офлайн, без доступу до Інтернету, або в локальній мережі. + +Тут ви побачите, як віддавати ці файли самостійно, у тому самому застосунку FastAPI, і налаштувати документацію на їх використання. + +### Структура файлів проєкту { #project-file-structure } + +Припустімо, що структура файлів вашого проєкту виглядає так: + +``` +. +├── app +│ ├── __init__.py +│ ├── main.py +``` + +Тепер створіть каталог для збереження цих статичних файлів. + +Нова структура файлів може виглядати так: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +└── static/ +``` + +### Завантажте файли { #download-the-files } + +Завантажте статичні файли, потрібні для документації, і помістіть їх у каталог `static/`. + +Ви, ймовірно, можете натиснути правою кнопкою на кожному посиланні і вибрати опцію на кшталт «Зберегти посилання як...». + +**Swagger UI** використовує файли: + +- `swagger-ui-bundle.js` +- `swagger-ui.css` + +А **ReDoc** використовує файл: + +- `redoc.standalone.js` + +Після цього ваша структура файлів може виглядати так: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +└── static + ├── redoc.standalone.js + ├── swagger-ui-bundle.js + └── swagger-ui.css +``` + +### Обслуговуйте статичні файли { #serve-the-static-files } + +- Імпортуйте `StaticFiles`. +- Змонтуйте екземпляр `StaticFiles()` у певному шляху. + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[7,11] *} + +### Перевірте статичні файли { #test-the-static-files } + +Запустіть ваш застосунок і перейдіть до http://127.0.0.1:8000/static/redoc.standalone.js. + +Ви маєте побачити дуже довгий файл JavaScript для **ReDoc**. + +Він може починатися приблизно так: + +```JavaScript +/*! For license information please see redoc.standalone.js.LICENSE.txt */ +!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("null")): +... +``` + +Це підтверджує, що ви можете віддавати статичні файли з вашого застосунку і що ви розмістили статичні файли для документації у правильному місці. + +Тепер ми можемо налаштувати застосунок на використання цих статичних файлів для документації. + +### Вимкніть автоматичну документацію для статичних файлів { #disable-the-automatic-docs-for-static-files } + +Як і при використанні користувацького CDN, першим кроком є вимкнення автоматичної документації, оскільки типово вона використовує CDN. + +Щоб їх вимкнути, встановіть їхні URL у `None` під час створення вашого застосунку `FastAPI`: + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[9] *} + +### Додайте користувацьку документацію для статичних файлів { #include-the-custom-docs-for-static-files } + +Аналогічно користувацькому CDN, тепер ви можете створити *операції шляху* для користувацької документації. + +Знову ж, ви можете перевикористати внутрішні функції FastAPI для створення HTML-сторінок документації і передати їм потрібні аргументи: + +- `openapi_url`: URL, за яким HTML-сторінка документації зможе отримати схему OpenAPI для вашого API. Тут можна використати атрибут `app.openapi_url`. +- `title`: заголовок вашого API. +- `oauth2_redirect_url`: тут можна використати `app.swagger_ui_oauth2_redirect_url`, щоб узяти значення за замовчуванням. +- `swagger_js_url`: URL, за яким HTML для Swagger UI зможе отримати файл **JavaScript**. **Це той файл, який тепер віддає ваш власний застосунок**. +- `swagger_css_url`: URL, за яким HTML для Swagger UI зможе отримати файл **CSS**. **Це той файл, який тепер віддає ваш власний застосунок**. + +Аналогічно для ReDoc... + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[2:6,14:22,25:27,30:36] *} + +/// tip | Порада + +*Операція шляху* для `swagger_ui_redirect` - це допоміжний маршрут, коли ви використовуєте OAuth2. + +Якщо ви інтегруєте ваш API з провайдером OAuth2, ви зможете автентифікуватися і повернутися до документації API з отриманими обліковими даними. І взаємодіяти з ним, використовуючи реальну автентифікацію OAuth2. + +Swagger UI впорається з цим «за лаштунками», але йому потрібен цей «redirect» хелпер. + +/// + +### Створіть операцію шляху для перевірки статичних файлів { #create-a-path-operation-to-test-static-files } + +Тепер, щоб перевірити, що все працює, створіть *операцію шляху*: + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[39:41] *} + +### Перевірте UI зі статичними файлами { #test-static-files-ui } + +Тепер ви маєте змогу вимкнути WiFi, відкрити документацію за http://127.0.0.1:8000/docs і перезавантажити сторінку. + +І навіть без Інтернету ви зможете побачити документацію для вашого API і взаємодіяти з ним. diff --git a/docs/uk/docs/how-to/custom-request-and-route.md b/docs/uk/docs/how-to/custom-request-and-route.md new file mode 100644 index 0000000000..9f21da7a86 --- /dev/null +++ b/docs/uk/docs/how-to/custom-request-and-route.md @@ -0,0 +1,109 @@ +# Користувацькі класи Request та APIRoute { #custom-request-and-apiroute-class } + +У деяких випадках ви можете захотіти перевизначити логіку, яку використовують класи `Request` та `APIRoute`. + +Зокрема, це може бути доброю альтернативою логіці в проміжному програмному забезпеченні. + +Наприклад, якщо потрібно прочитати або змінити тіло запиту до того, як його обробить ваш застосунок. + +/// danger | Обережно + +Це «просунута» можливість. + +Якщо ви тільки починаєте працювати з **FastAPI**, можливо, варто пропустити цей розділ. + +/// + +## Випадки використання { #use-cases } + +Деякі варіанти використання: + +- Перетворення не-JSON тіл запитів на JSON (наприклад, `msgpack`). +- Розпакування тіл запитів, стиснених gzip. +- Автоматичне логування всіх тіл запитів. + +## Обробка користувацьких кодувань тіла запиту { #handling-custom-request-body-encodings } + +Розгляньмо, як використати користувацький підклас `Request` для розпакування gzip-запитів. + +А також підклас `APIRoute`, щоб застосувати цей користувацький клас запиту. + +### Створіть користувацький клас `GzipRequest` { #create-a-custom-gziprequest-class } + +/// tip | Порада + +Це навчальний приклад, щоб продемонструвати принцип роботи. Якщо вам потрібна підтримка Gzip, скористайтеся вбудованим [`GzipMiddleware`](../advanced/middleware.md#gzipmiddleware){.internal-link target=_blank}. + +/// + +Спочатку створимо клас `GzipRequest`, який перевизначить метод `Request.body()`, щоб розпаковувати тіло за наявності відповідного заголовка. + +Якщо в заголовку немає `gzip`, він не намагатиметься розпаковувати тіло. + +Таким чином один і той самий клас маршруту зможе обробляти як стиснені gzip, так і нестиснені запити. + +{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[9:16] *} + +### Створіть користувацький клас `GzipRoute` { #create-a-custom-gziproute-class } + +Далі створимо користувацький підклас `fastapi.routing.APIRoute`, який використовуватиме `GzipRequest`. + +Цього разу він перевизначить метод `APIRoute.get_route_handler()`. + +Цей метод повертає функцію. І саме ця функція прийме запит і поверне відповідь. + +Тут ми використовуємо її, щоб створити `GzipRequest` з початкового запиту. + +{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[19:27] *} + +/// note | Технічні деталі + +У `Request` є атрибут `request.scope` - це просто Python `dict`, що містить метадані, пов'язані із запитом. + +Також `Request` має `request.receive` - це функція для «отримання» тіла запиту. + +`scope` `dict` і функція `receive` є частиною специфікації ASGI. + +І саме ці дві сутності - `scope` та `receive` - потрібні для створення нового екземпляра `Request`. + +Щоб дізнатися більше про `Request`, перегляньте документацію Starlette про запити. + +/// + +Єдине, що робить інакше функція, повернена `GzipRequest.get_route_handler`, - перетворює `Request` на `GzipRequest`. + +Завдяки цьому наш `GzipRequest` подбає про розпакування даних (за потреби) перед передаванням їх у наші *операції шляху*. + +Після цього вся логіка обробки залишається тією самою. + +А завдяки змінам у `GzipRequest.body` тіло запиту за потреби буде автоматично розпаковане під час завантаження **FastAPI**. + +## Доступ до тіла запиту в обробнику виключень { #accessing-the-request-body-in-an-exception-handler } + +/// tip | Порада + +Щоб розв’язати це саме завдання, скоріш за все, простіше використати `body` у користувацькому обробнику `RequestValidationError` ([Обробка помилок](../tutorial/handling-errors.md#use-the-requestvalidationerror-body){.internal-link target=_blank}). + +Але цей приклад усе ще корисний і показує, як взаємодіяти з внутрішніми компонентами. + +/// + +Ми також можемо скористатися цим підходом, щоб отримати доступ до тіла запиту в обробнику виключень. + +Усе, що потрібно, - обробити запит усередині блоку `try`/`except`: + +{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[14,16] *} + +Якщо станеться виключення, екземпляр `Request` усе ще буде у видимості, тож ми зможемо прочитати й використати тіло запиту під час обробки помилки: + +{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[17:19] *} + +## Користувацький клас `APIRoute` у маршрутизаторі { #custom-apiroute-class-in-a-router } + +Можна також встановити параметр `route_class` у `APIRouter`: + +{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[26] *} + +У цьому прикладі *операції шляху* в `router` використовуватимуть користувацький клас `TimedRoute` і матимуть додатковий заголовок відповіді `X-Response-Time` із часом, витраченим на формування відповіді: + +{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[13:20] *} diff --git a/docs/uk/docs/how-to/extending-openapi.md b/docs/uk/docs/how-to/extending-openapi.md new file mode 100644 index 0000000000..1597cbc762 --- /dev/null +++ b/docs/uk/docs/how-to/extending-openapi.md @@ -0,0 +1,80 @@ +# Розширення OpenAPI { #extending-openapi } + +У деяких випадках вам може знадобитися змінити згенеровану схему OpenAPI. + +У цьому розділі ви побачите як це зробити. + +## Звичайний процес { #the-normal-process } + +Звичайний (типовий) процес такий. + +Застосунок `FastAPI` (екземпляр) має метод `.openapi()`, який має повертати схему OpenAPI. + +Під час створення об'єкта застосунку реєструється *операція шляху* для `/openapi.json` (або для того значення, яке ви встановили в `openapi_url`). + +Вона просто повертає відповідь JSON з результатом методу `.openapi()` застосунку. + +Типово метод `.openapi()` перевіряє властивість `.openapi_schema`, і якщо там вже є дані, повертає їх. + +Якщо ні, він генерує їх за допомогою утилітарної функції `fastapi.openapi.utils.get_openapi`. + +Функція `get_openapi()` приймає такі параметри: + +- `title`: Заголовок OpenAPI, показується в документації. +- `version`: Версія вашого API, напр. `2.5.0`. +- `openapi_version`: Версія специфікації OpenAPI, що використовується. Типово остання: `3.1.0`. +- `summary`: Короткий підсумок API. +- `description`: Опис вашого API; може містити markdown і буде показаний у документації. +- `routes`: Список маршрутів, це кожна з зареєстрованих *операцій шляху*. Їх беруть з `app.routes`. + +/// info | Інформація + +Параметр `summary` доступний в OpenAPI 3.1.0 і вище, підтримується FastAPI 0.99.0 і вище. + +/// + +## Переписування типових значень { #overriding-the-defaults } + +Використовуючи наведене вище, ви можете скористатися тією ж утилітарною функцією для генерації схеми OpenAPI і переписати потрібні частини. + +Наприклад, додаймо розширення OpenAPI для ReDoc для додавання власного логотипа. + +### Звичайний **FastAPI** { #normal-fastapi } + +Спочатку напишіть ваш застосунок **FastAPI** як зазвичай: + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[1,4,7:9] *} + +### Згенерувати схему OpenAPI { #generate-the-openapi-schema } + +Далі використайте ту ж утилітарну функцію для генерації схеми OpenAPI всередині функції `custom_openapi()`: + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[2,15:21] *} + +### Змінити схему OpenAPI { #modify-the-openapi-schema } + +Тепер можна додати розширення ReDoc, додавши власний `x-logo` до «об'єкта» `info` у схемі OpenAPI: + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[22:24] *} + +### Кешувати схему OpenAPI { #cache-the-openapi-schema } + +Ви можете використовувати властивість `.openapi_schema` як «кеш» для збереження згенерованої схеми. + +Так вашому застосунку не доведеться щоразу генерувати схему, коли користувач відкриває документацію вашого API. + +Вона буде згенерована лише один раз, а потім та сама закешована схема використовуватиметься для наступних запитів. + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[13:14,25:26] *} + +### Переписати метод { #override-the-method } + +Тепер ви можете замінити метод `.openapi()` вашою новою функцією. + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[29] *} + +### Перевірте { #check-it } + +Коли ви перейдете за адресою http://127.0.0.1:8000/redoc, побачите, що використовується ваш власний логотип (у цьому прикладі логотип **FastAPI**): + + diff --git a/docs/uk/docs/how-to/general.md b/docs/uk/docs/how-to/general.md new file mode 100644 index 0000000000..f33ae195c6 --- /dev/null +++ b/docs/uk/docs/how-to/general.md @@ -0,0 +1,39 @@ +# Загальне - Як зробити - Рецепти { #general-how-to-recipes } + +Нижче наведено кілька вказівок до інших розділів документації для загальних або частих питань. + +## Фільтрування даних - Безпека { #filter-data-security } + +Щоб гарантувати, що ви не повертаєте більше даних, ніж слід, прочитайте документацію [Навчальний посібник - Модель відповіді - Тип повернення](../tutorial/response-model.md){.internal-link target=_blank}. + +## Мітки документації - OpenAPI { #documentation-tags-openapi } + +Щоб додати мітки до ваших *операцій шляху* та згрупувати їх в інтерфейсі документації, прочитайте документацію [Навчальний посібник - Налаштування операції шляху - Мітки](../tutorial/path-operation-configuration.md#tags){.internal-link target=_blank}. + +## Короткий опис і опис - OpenAPI { #documentation-summary-and-description-openapi } + +Щоб додати короткий опис і опис до ваших *операцій шляху* і показати їх в інтерфейсі документації, прочитайте документацію [Навчальний посібник - Налаштування операції шляху - Короткий опис і опис](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank}. + +## Опис відповіді в документації - OpenAPI { #documentation-response-description-openapi } + +Щоб визначити опис відповіді, що відображається в інтерфейсі документації, прочитайте документацію [Навчальний посібник - Налаштування операції шляху - Опис відповіді](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank}. + +## Позначити застарілою *операцію шляху* - OpenAPI { #documentation-deprecate-a-path-operation-openapi } + +Щоб позначити *операцію шляху* як застарілу і показати це в інтерфейсі документації, прочитайте документацію [Навчальний посібник - Налаштування операції шляху - Позначення як застаріле](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank}. + +## Перетворити будь-які дані на сумісні з JSON { #convert-any-data-to-json-compatible } + +Щоб перетворити будь-які дані на сумісні з JSON, прочитайте документацію [Навчальний посібник - Кодувальник, сумісний з JSON](../tutorial/encoder.md){.internal-link target=_blank}. + +## Метадані OpenAPI - Документація { #openapi-metadata-docs } + +Щоб додати метадані до вашої схеми OpenAPI, зокрема ліцензію, версію, контактні дані тощо, прочитайте документацію [Навчальний посібник - Метадані та URL документації](../tutorial/metadata.md){.internal-link target=_blank}. + +## Власний URL OpenAPI { #openapi-custom-url } + +Щоб налаштувати URL OpenAPI (або прибрати його), прочитайте документацію [Навчальний посібник - Метадані та URL документації](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}. + +## URL документації OpenAPI { #openapi-docs-urls } + +Щоб оновити URL, які використовуються для автоматично згенерованих інтерфейсів користувача документації, прочитайте документацію [Навчальний посібник - Метадані та URL документації](../tutorial/metadata.md#docs-urls){.internal-link target=_blank}. diff --git a/docs/uk/docs/how-to/graphql.md b/docs/uk/docs/how-to/graphql.md new file mode 100644 index 0000000000..2d0e355ea4 --- /dev/null +++ b/docs/uk/docs/how-to/graphql.md @@ -0,0 +1,60 @@ +# GraphQL { #graphql } + +Оскільки FastAPI базується на стандарті ASGI, дуже просто інтегрувати будь-яку бібліотеку GraphQL, сумісну з ASGI. + +Ви можете поєднувати звичайні *операції шляху* FastAPI з GraphQL в одному застосунку. + +/// tip | Порада + +GraphQL розв’язує деякі дуже специфічні сценарії використання. + +Порівняно зі звичайними веб-API він має переваги та недоліки. + +Переконайтеся, що переваги для вашого випадку використання переважають недоліки. 🤓 + +/// + +## Бібліотеки GraphQL { #graphql-libraries } + +Ось деякі бібліотеки GraphQL з підтримкою ASGI. Ви можете використовувати їх із FastAPI: + +* Strawberry 🍓 + * З документацією для FastAPI +* Ariadne + * З документацією для FastAPI +* Tartiflette + * З Tartiflette ASGI для інтеграції з ASGI +* Graphene + * З starlette-graphene3 + +## GraphQL зі Strawberry { #graphql-with-strawberry } + +Якщо вам потрібен або ви хочете використовувати GraphQL, Strawberry - рекомендована бібліотека, адже її дизайн найближчий до дизайну FastAPI; усе базується на анотаціях типів. + +Залежно від вашого сценарію використання ви можете надати перевагу іншій бібліотеці, але якби ви запитали мене, я, ймовірно, порадив би спробувати Strawberry. + +Ось невеликий приклад того, як інтегрувати Strawberry з FastAPI: + +{* ../../docs_src/graphql_/tutorial001_py310.py hl[3,22,25] *} + +Більше про Strawberry ви можете дізнатися в документації Strawberry. + +І також документацію про Strawberry з FastAPI. + +## Застарілий `GraphQLApp` зі Starlette { #older-graphqlapp-from-starlette } + +Попередні версії Starlette містили клас `GraphQLApp` для інтеграції з Graphene. + +Його вилучено з Starlette як застарілий, але якщо у вас є код, що його використовував, ви можете легко мігрувати на starlette-graphene3, який покриває той самий сценарій використання та має майже ідентичний інтерфейс. + +/// tip | Порада + +Якщо вам потрібен GraphQL, я все ж рекомендую звернути увагу на Strawberry, адже він базується на анотаціях типів, а не на власних класах і типах. + +/// + +## Дізнайтеся більше { #learn-more } + +Ви можете дізнатися більше про GraphQL в офіційній документації GraphQL. + +Також ви можете почитати більше про кожну з цих бібліотек за наведеними посиланнями. diff --git a/docs/uk/docs/how-to/index.md b/docs/uk/docs/how-to/index.md new file mode 100644 index 0000000000..ac2dd16eb9 --- /dev/null +++ b/docs/uk/docs/how-to/index.md @@ -0,0 +1,13 @@ +# Як зробити - Рецепти { #how-to-recipes } + +Тут ви побачите різні рецепти або керівництва «як зробити» з **різних тем**. + +Більшість із цих ідей є більш-менш **незалежними**, і в більшості випадків вам слід вивчати їх лише тоді, коли вони безпосередньо стосуються **вашого проєкту**. + +Якщо щось здається цікавим і корисним для вашого проєкту, сміливо перевірте це, інакше, ймовірно, просто пропустіть. + +/// tip | Порада + +Якщо ви хочете **вивчити FastAPI** у структурований спосіб (рекомендується), натомість прочитайте [Навчальний посібник - Посібник користувача](../tutorial/index.md){.internal-link target=_blank} розділ за розділом. + +/// diff --git a/docs/uk/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md b/docs/uk/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md new file mode 100644 index 0000000000..0f5d1c924e --- /dev/null +++ b/docs/uk/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md @@ -0,0 +1,135 @@ +# Перехід з Pydantic v1 на Pydantic v2 { #migrate-from-pydantic-v1-to-pydantic-v2 } + +Якщо у вас стара програма FastAPI, можливо, ви використовуєте Pydantic версії 1. + +FastAPI версії 0.100.0 підтримував як Pydantic v1, так і v2. Використовувалася та версія, яку ви встановили. + +FastAPI версії 0.119.0 запровадив часткову підтримку Pydantic v1 всередині Pydantic v2 (як `pydantic.v1`), щоб спростити перехід на v2. + +FastAPI 0.126.0 припинив підтримку Pydantic v1, водночас ще певний час підтримував `pydantic.v1`. + +/// warning | Попередження + +Команда Pydantic припинила підтримку Pydantic v1 для останніх версій Python, починаючи з Python 3.14. + +Це стосується і `pydantic.v1`, який більше не підтримується в Python 3.14 і новіших. + +Якщо ви хочете використовувати найновіші можливості Python, вам потрібно переконатися, що ви використовуєте Pydantic v2. + +/// + +Якщо у вас стара програма FastAPI з Pydantic v1, нижче я покажу, як мігрувати на Pydantic v2, а також можливості FastAPI 0.119.0, які допоможуть з поступовою міграцією. + +## Офіційний посібник { #official-guide } + +У Pydantic є офіційний Посібник з міграції з v1 на v2. + +Там описано, що змінилося, як перевірки тепер стали коректнішими та суворішими, можливі застереження тощо. + +Прочитайте його, щоб краще зрозуміти зміни. + +## Тести { #tests } + +Переконайтеся, що у вашій програмі є [тести](../tutorial/testing.md){.internal-link target=_blank} і що ви запускаєте їх у системі безперервної інтеграції (CI). + +Так ви зможете виконати оновлення і впевнитися, що все працює як очікується. + +## `bump-pydantic` { #bump-pydantic } + +У багатьох випадках, якщо ви використовуєте звичайні моделі Pydantic без налаштувань, більшу частину процесу міграції з Pydantic v1 на Pydantic v2 можна автоматизувати. + +Ви можете скористатися `bump-pydantic` від тієї ж команди Pydantic. + +Цей інструмент допоможе автоматично змінити більшість коду, який потрібно змінити. + +Після цього запустіть тести й перевірте, чи все працює. Якщо так - ви все завершили. 😎 + +## Pydantic v1 у v2 { #pydantic-v1-in-v2 } + +Pydantic v2 містить усе з Pydantic v1 як підмодуль `pydantic.v1`. Але це більше не підтримується у версіях Python вище 3.13. + +Це означає, що ви можете встановити останню версію Pydantic v2 та імпортувати і використовувати старі компоненти Pydantic v1 з цього підмодуля, ніби у вас встановлено старий Pydantic v1. + +{* ../../docs_src/pydantic_v1_in_v2/tutorial001_an_py310.py hl[1,4] *} + +### Підтримка FastAPI для Pydantic v1 у v2 { #fastapi-support-for-pydantic-v1-in-v2 } + +Починаючи з FastAPI 0.119.0, також є часткова підтримка Pydantic v1 всередині Pydantic v2, щоб спростити перехід на v2. + +Тож ви можете оновити Pydantic до останньої версії 2 і змінити імпорти на використання підмодуля `pydantic.v1`, і в багатьох випадках усе просто запрацює. + +{* ../../docs_src/pydantic_v1_in_v2/tutorial002_an_py310.py hl[2,5,15] *} + +/// warning | Попередження + +Майте на увазі, що оскільки команда Pydantic більше не підтримує Pydantic v1 у нових версіях Python, починаючи з Python 3.14, використання `pydantic.v1` також не підтримується в Python 3.14 і новіших. + +/// + +### Pydantic v1 і v2 в одній програмі { #pydantic-v1-and-v2-on-the-same-app } + +Pydantic не підтримує ситуацію, коли модель Pydantic v2 має власні поля, визначені як моделі Pydantic v1, або навпаки. + +```mermaid +graph TB + subgraph "❌ Not Supported" + direction TB + subgraph V2["Pydantic v2 Model"] + V1Field["Pydantic v1 Model"] + end + subgraph V1["Pydantic v1 Model"] + V2Field["Pydantic v2 Model"] + end + end + + style V2 fill:#f9fff3 + style V1 fill:#fff6f0 + style V1Field fill:#fff6f0 + style V2Field fill:#f9fff3 +``` + +...але в одній програмі ви можете мати окремі моделі на Pydantic v1 і v2. + +```mermaid +graph TB + subgraph "✅ Supported" + direction TB + subgraph V2["Pydantic v2 Model"] + V2Field["Pydantic v2 Model"] + end + subgraph V1["Pydantic v1 Model"] + V1Field["Pydantic v1 Model"] + end + end + + style V2 fill:#f9fff3 + style V1 fill:#fff6f0 + style V1Field fill:#fff6f0 + style V2Field fill:#f9fff3 +``` + +У деяких випадках можна навіть використовувати моделі і Pydantic v1, і v2 в одній операції шляху у вашій програмі FastAPI: + +{* ../../docs_src/pydantic_v1_in_v2/tutorial003_an_py310.py hl[2:3,6,12,21:22] *} + +У наведеному вище прикладі вхідна модель - це модель Pydantic v1, а вихідна модель (визначена як `response_model=ItemV2`) - модель Pydantic v2. + +### Параметри Pydantic v1 { #pydantic-v1-parameters } + +Якщо вам потрібно використовувати деякі специфічні для FastAPI інструменти для параметрів, як-от `Body`, `Query`, `Form` тощо, з моделями Pydantic v1, ви можете імпортувати їх з `fastapi.temp_pydantic_v1_params`, поки завершуєте міграцію на Pydantic v2: + +{* ../../docs_src/pydantic_v1_in_v2/tutorial004_an_py310.py hl[4,18] *} + +### Покрокова міграція { #migrate-in-steps } + +/// tip | Порада + +Спершу спробуйте `bump-pydantic`: якщо ваші тести проходять і все працює - ви впоралися однією командою. ✨ + +/// + +Якщо `bump-pydantic` не підходить для вашого випадку, скористайтеся підтримкою одночасно Pydantic v1 і v2 в одній програмі, щоб виконати поступову міграцію на Pydantic v2. + +Спочатку ви можете оновити Pydantic до останньої версії 2 і змінити імпорти на `pydantic.v1` для всіх ваших моделей. + +Потім починайте переносити моделі з Pydantic v1 на v2 групами, поступовими кроками. 🚶 diff --git a/docs/uk/docs/how-to/separate-openapi-schemas.md b/docs/uk/docs/how-to/separate-openapi-schemas.md new file mode 100644 index 0000000000..7e6fcbf5f9 --- /dev/null +++ b/docs/uk/docs/how-to/separate-openapi-schemas.md @@ -0,0 +1,101 @@ +# Окремі схеми OpenAPI для введення та виведення, чи ні { #separate-openapi-schemas-for-input-and-output-or-not } + +Відколи вийшов **Pydantic v2**, згенерований OpenAPI став трохи точнішим і більш коректним, ніж раніше. 😎 + +Насправді подекуди буде навіть **дві схеми JSON** в OpenAPI для тієї самої моделі Pydantic: для введення та для виведення - залежно від наявності значень за замовчуванням. + +Розгляньмо, як це працює, і як це змінити за потреби. + +## Моделі Pydantic для введення та виведення { #pydantic-models-for-input-and-output } + +Припустімо, у вас є модель Pydantic зі значеннями за замовчуванням, наприклад: + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *} + +### Модель для введення { #model-for-input } + +Якщо ви використовуєте цю модель як введення, як тут: + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *} + +…тоді поле `description` не буде обов'язковим, адже воно має значення за замовчуванням `None`. + +### Модель для введення в документації { #input-model-in-docs } + +У документації ви побачите, що поле `description` не має **червоної зірочки** - воно не позначене як обов'язкове: + +
+ +
+ +### Модель для виведення { #model-for-output } + +Але якщо ви використовуєте цю саму модель для виведення, як тут: + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py hl[19] *} + +…тоді, оскільки `description` має значення за замовчуванням, якщо ви нічого не повернете для цього поля, воно все одно матиме це **значення за замовчуванням**. + +### Модель для даних відповіді при виведенні { #model-for-output-response-data } + +Якщо ви скористаєтеся документацією та перевірите відповідь, навіть попри те, що код нічого не додав в одне з полів `description`, JSON-відповідь містить значення за замовчуванням (`null`): + +
+ +
+ +Це означає, що воно **завжди матиме значення** - просто іноді це значення може бути `None` (або `null` у JSON). + +Отже, клієнтам, які використовують ваш API, не потрібно перевіряти, чи існує значення - вони можуть **припустити, що поле завжди буде присутнє**, але в окремих випадках воно матиме значення за замовчуванням `None`. + +У OpenAPI це описується тим, що поле позначається як **обов'язкове**, адже воно завжди присутнє. + +Тому Схема JSON для моделі може відрізнятися залежно від того, чи використовується вона для **введення або виведення**: +- для **введення** `description` не буде обов'язковим +- для **виведення** воно буде **обов'язковим** (і можливо `None`, або в термінах JSON - `null`) + +### Модель для виведення в документації { #model-for-output-in-docs } + +У документації ви також можете перевірити модель для виведення: **і** `name`, і `description` позначені як **обов'язкові** червоною зірочкою: + +
+ +
+ +### Модель для введення та виведення в документації { #model-for-input-and-output-in-docs } + +Якщо відкрити всі наявні Схеми (схеми JSON) в OpenAPI, то ви побачите дві: `Item-Input` і `Item-Output`. + +Для `Item-Input` поле `description` **не є обов'язковим** - червоної зірочки немає. + +А для `Item-Output` `description` **є обов'язковим** - є червона зірочка. + +
+ +
+ +Завдяки цій можливості у **Pydantic v2** ваша документація API стає більш **точною**, а якщо у вас є згенеровані клієнти та SDK, вони також будуть точнішими - з кращим **досвідом розробника** та узгодженістю. 🎉 + +## Не розділяти схеми { #do-not-separate-schemas } + +Втім іноді може знадобитися мати **одну й ту саму схему для введення та виведення**. + +Основний випадок - коли у вас вже є згенерований клієнтський код/SDK, і ви поки не бажаєте оновлювати весь такий згенерований код/SDK. Ймовірно, ви зробите це пізніше, але не зараз. + +У такому разі ви можете вимкнути цю можливість у **FastAPI** параметром `separate_input_output_schemas=False`. + +/// info | Інформація + +Підтримку `separate_input_output_schemas` додано у FastAPI `0.102.0`. 🤓 + +/// + +{* ../../docs_src/separate_openapi_schemas/tutorial002_py310.py hl[10] *} + +### Одна схема для моделей введення та виведення в документації { #same-schema-for-input-and-output-models-in-docs } + +Тепер для цієї моделі буде лише одна спільна схема для введення та виведення - тільки `Item`, і в ній `description` буде **не обов'язковим**: + +
+ +
diff --git a/docs/uk/docs/how-to/testing-database.md b/docs/uk/docs/how-to/testing-database.md new file mode 100644 index 0000000000..2e6b21ced0 --- /dev/null +++ b/docs/uk/docs/how-to/testing-database.md @@ -0,0 +1,7 @@ +# Тестування бази даних { #testing-a-database } + +Ви можете ознайомитися з базами даних, SQL і SQLModel у документації SQLModel. 🤓 + +Є невеликий навчальний посібник про використання SQLModel з FastAPI. ✨ + +Цей навчальний посібник містить розділ про тестування баз даних SQL. 😎 diff --git a/docs/uk/docs/project-generation.md b/docs/uk/docs/project-generation.md new file mode 100644 index 0000000000..4899090d42 --- /dev/null +++ b/docs/uk/docs/project-generation.md @@ -0,0 +1,28 @@ +# Шаблон Full Stack FastAPI { #full-stack-fastapi-template } + +Шаблони, хоча зазвичай постачаються з певним налаштуванням, спроєктовані бути гнучкими та налаштовуваними. Це дає змогу змінювати їх і адаптувати до вимог вашого проєкту, що робить їх чудовою відправною точкою. 🏁 + +Ви можете використати цей шаблон для старту, адже в ньому вже виконано значну частину початкового налаштування, безпеки, роботи з базою даних і деяких кінцевих точок API. + +Репозиторій GitHub: Шаблон Full Stack FastAPI + +## Шаблон Full Stack FastAPI - стек технологій і можливості { #full-stack-fastapi-template-technology-stack-and-features } + +- ⚡ [**FastAPI**](https://fastapi.tiangolo.com/uk) для бекенд API на Python. + - 🧰 [SQLModel](https://sqlmodel.tiangolo.com) для взаємодії з SQL-базою даних у Python (ORM). + - 🔍 [Pydantic](https://docs.pydantic.dev), який використовується FastAPI, для перевірки даних і керування налаштуваннями. + - 💾 [PostgreSQL](https://www.postgresql.org) як SQL-база даних. +- 🚀 [React](https://react.dev) для фронтенду. + - 💃 Використання TypeScript, хуків, Vite та інших частин сучасного фронтенд-стеку. + - 🎨 [Tailwind CSS](https://tailwindcss.com) і [shadcn/ui](https://ui.shadcn.com) для фронтенд-компонентів. + - 🤖 Автоматично згенерований фронтенд-клієнт. + - 🧪 [Playwright](https://playwright.dev) для End-to-End тестування. + - 🦇 Підтримка темного режиму. +- 🐋 [Docker Compose](https://www.docker.com) для розробки та продакшену. +- 🔒 Безпечне хешування паролів за замовчуванням. +- 🔑 Автентифікація JWT (JSON Web Token). +- 📫 Відновлення пароля на основі електронної пошти. +- ✅ Тести з [Pytest](https://pytest.org). +- 📞 [Traefik](https://traefik.io) як зворотний представник / балансувальник навантаження. +- 🚢 Інструкції з розгортання з Docker Compose, включно з налаштуванням фронтенд-представника Traefik для автоматичних HTTPS-сертифікатів. +- 🏭 CI (безперервна інтеграція) і CD (безперервне розгортання) на базі GitHub Actions. diff --git a/docs/uk/docs/resources/index.md b/docs/uk/docs/resources/index.md new file mode 100644 index 0000000000..353992fad4 --- /dev/null +++ b/docs/uk/docs/resources/index.md @@ -0,0 +1,3 @@ +# Ресурси { #resources } + +Додаткові ресурси, зовнішні посилання та інше. ✈️ diff --git a/docs/uk/docs/translation-banner.md b/docs/uk/docs/translation-banner.md new file mode 100644 index 0000000000..8640803994 --- /dev/null +++ b/docs/uk/docs/translation-banner.md @@ -0,0 +1,11 @@ +/// details | 🌐 Переклад ШІ та людьми + +Цей переклад виконано ШІ під керівництвом людей. 🤝 + +Можливі помилки через неправильне розуміння початкового змісту або неприродні формулювання тощо. 🤖 + +Ви можете покращити цей переклад, [допомігши нам краще спрямовувати AI LLM](https://fastapi.tiangolo.com/uk/contributing/#translations). + +[Англійська версія](ENGLISH_VERSION_URL) + +/// diff --git a/docs/uk/docs/tutorial/bigger-applications.md b/docs/uk/docs/tutorial/bigger-applications.md new file mode 100644 index 0000000000..a75da2ac6d --- /dev/null +++ b/docs/uk/docs/tutorial/bigger-applications.md @@ -0,0 +1,504 @@ +# Більші застосунки - кілька файлів { #bigger-applications-multiple-files } + +Якщо ви створюєте застосунок або веб-API, рідко вдається вмістити все в один файл. + +**FastAPI** надає зручний інструмент для структурування вашого застосунку, зберігаючи всю гнучкість. + +/// info | Інформація + +Якщо ви прийшли з Flask, це еквівалент «Blueprints» у Flask. + +/// + +## Приклад структури файлів { #an-example-file-structure } + +Припустімо, у вас така структура файлів: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +│   ├── dependencies.py +│   └── routers +│   │ ├── __init__.py +│   │ ├── items.py +│   │ └── users.py +│   └── internal +│   ├── __init__.py +│   └── admin.py +``` + +/// tip | Порада + +Тут кілька файлів `__init__.py`: по одному в кожному каталозі та підкаталозі. + +Саме це дозволяє імпортувати код з одного файлу в інший. + +Наприклад, у `app/main.py` ви можете мати рядок: + +``` +from app.routers import items +``` + +/// + +* Каталог `app` містить усе. І він має порожній файл `app/__init__.py`, тож це «пакет Python» (збірка «модулів Python»): `app`. +* Він містить файл `app/main.py`. Оскільки він усередині пакета Python (каталог з файлом `__init__.py`), це «модуль» цього пакета: `app.main`. +* Є також файл `app/dependencies.py`, так само як `app/main.py`, це «модуль»: `app.dependencies`. +* Є підкаталог `app/routers/` з іншим файлом `__init__.py`, отже це «підпакет Python»: `app.routers`. +* Файл `app/routers/items.py` знаходиться в пакеті `app/routers/`, отже це підмодуль: `app.routers.items`. +* Так само і `app/routers/users.py`, це інший підмодуль: `app.routers.users`. +* Є також підкаталог `app/internal/` з іншим файлом `__init__.py`, отже це інший «підпакет Python»: `app.internal`. +* І файл `app/internal/admin.py` - ще один підмодуль: `app.internal.admin`. + + + +Та сама структура файлів з коментарями: + +```bash +. +├── app # «app» - це пакет Python +│   ├── __init__.py # цей файл робить «app» «пакетом Python» +│   ├── main.py # модуль «main», напр. import app.main +│   ├── dependencies.py # модуль «dependencies», напр. import app.dependencies +│   └── routers # «routers» - це «підпакет Python» +│   │ ├── __init__.py # робить «routers» «підпакетом Python» +│   │ ├── items.py # підмодуль «items», напр. import app.routers.items +│   │ └── users.py # підмодуль «users», напр. import app.routers.users +│   └── internal # «internal» - це «підпакет Python» +│   ├── __init__.py # робить «internal» «підпакетом Python» +│   └── admin.py # підмодуль «admin», напр. import app.internal.admin +``` + +## `APIRouter` { #apirouter } + +Припустімо, файл, присвячений обробці лише користувачів, - це підмодуль у `/app/routers/users.py`. + +Ви хочете мати *операції шляху*, пов'язані з користувачами, відокремлено від решти коду, щоб зберегти порядок. + +Але це все одно частина того самого застосунку/веб-API **FastAPI** (це частина того самого «пакета Python»). + +Ви можете створювати *операції шляху* для цього модуля, використовуючи `APIRouter`. + +### Імпортуйте `APIRouter` { #import-apirouter } + +Імпортуйте його та створіть «екземпляр» так само, як ви б робили з класом `FastAPI`: + +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *} + +### *Операції шляху* з `APIRouter` { #path-operations-with-apirouter } + +Потім використовуйте його для оголошення *операцій шляху*. + +Використовуйте його так само, як і клас `FastAPI`: + +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[6,11,16] title["app/routers/users.py"] *} + +Можете думати про `APIRouter` як про «міні `FastAPI`». + +Підтримуються ті самі опції. + +Ті самі `parameters`, `responses`, `dependencies`, `tags` тощо. + +/// tip | Порада + +У цьому прикладі змінна називається `router`, але ви можете назвати її як завгодно. + +/// + +Ми включимо цей `APIRouter` у основний застосунок `FastAPI`, але спочатку розгляньмо залежності та інший `APIRouter`. + +## Залежності { #dependencies } + +Бачимо, що нам знадобляться кілька залежностей, які використовуються в різних місцях застосунку. + +Тож помістимо їх у власний модуль `dependencies` (`app/dependencies.py`). + +Тепер використаємо просту залежність для читання користувацького заголовка `X-Token`: + +{* ../../docs_src/bigger_applications/app_an_py310/dependencies.py hl[3,6:8] title["app/dependencies.py"] *} + +/// tip | Порада + +Ми використовуємо вигаданий заголовок, щоб спростити приклад. + +Але в реальних випадках ви отримаєте кращі результати, використовуючи інтегровані [засоби безпеки](security/index.md){.internal-link target=_blank}. + +/// + +## Інший модуль з `APIRouter` { #another-module-with-apirouter } + +Припустімо, у вас також є кінцеві точки для обробки «items» у модулі `app/routers/items.py`. + +У вас є *операції шляху* для: + +* `/items/` +* `/items/{item_id}` + +Структура така сама, як у `app/routers/users.py`. + +Але ми хочемо бути розумнішими й трохи спростити код. + +Ми знаємо, що всі *операції шляху* в цьому модулі мають однакові: + +* Префікс шляху `prefix`: `/items`. +* `tags`: (лише одна мітка: `items`). +* Додаткові `responses`. +* `dependencies`: усім потрібна залежність `X-Token`, яку ми створили. + +Тож замість додавання цього до кожної *операції шляху*, ми можемо додати це до `APIRouter`. + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[5:10,16,21] title["app/routers/items.py"] *} + +Оскільки шлях кожної *операції шляху* має починатися з `/`, як у: + +```Python hl_lines="1" +@router.get("/{item_id}") +async def read_item(item_id: str): + ... +``` + +...префікс не має містити кінцевий `/`. + +Отже, у цьому випадку префікс - це `/items`. + +Ми також можемо додати список `tags` та додаткові `responses`, які застосовуватимуться до всіх *операцій шляху*, включених у цей router. + +І ми можемо додати список `dependencies`, які буде додано до всіх *операцій шляху* у router і які виконуватимуться/вирішуватимуться для кожного запиту до них. + +/// tip | Порада + +Зверніть увагу, що так само як і для [залежностей у декораторах *операцій шляху*](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, жодне значення не буде передано вашій *функції операції шляху*. + +/// + +У підсумку шляхи предметів тепер: + +* `/items/` +* `/items/{item_id}` + +...як ми і планували. + +* Вони будуть позначені списком міток, що містить один рядок `"items"`. + * Ці «мітки» особливо корисні для автоматичної інтерактивної документації (за допомогою OpenAPI). +* Усі вони включатимуть наперед визначені `responses`. +* Для всіх цих *операцій шляху* список `dependencies` буде оцінений/виконаний перед ними. + * Якщо ви також оголосите залежності в конкретній *операції шляху*, **вони також будуть виконані**. + * Спочатку виконуються залежності router'а, потім [`dependencies` у декораторі](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, а потім звичайні параметричні залежності. + * Ви також можете додати [`Security` залежності з `scopes`](../advanced/security/oauth2-scopes.md){.internal-link target=_blank}. + +/// tip | Порада + +Наявність `dependencies` у `APIRouter` можна використати, наприклад, щоб вимагати автентифікацію для всієї групи *операцій шляху*. Навіть якщо залежності не додані до кожної з них окремо. + +/// + +/// check | Перевірте + +Параметри `prefix`, `tags`, `responses` і `dependencies` - це (як і в багатьох інших випадках) просто можливість **FastAPI**, яка допомагає уникати дублювання коду. + +/// + +### Імпортуйте залежності { #import-the-dependencies } + +Цей код живе в модулі `app.routers.items`, у файлі `app/routers/items.py`. + +І нам потрібно отримати функцію залежності з модуля `app.dependencies`, файлу `app/dependencies.py`. + +Тож ми використовуємо відносний імпорт з `..` для залежностей: + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[3] title["app/routers/items.py"] *} + +#### Як працюють відносні імпорти { #how-relative-imports-work } + +/// tip | Порада + +Якщо ви досконало знаєте, як працюють імпорти, перейдіть до наступного розділу нижче. + +/// + +Одна крапка `.`, як у: + +```Python +from .dependencies import get_token_header +``` + +означає: + +* Починаючи в тому самому пакеті, де знаходиться цей модуль (файл `app/routers/items.py`) (каталог `app/routers/`)... +* знайти модуль `dependencies` (уявний файл `app/routers/dependencies.py`)... +* і з нього імпортувати функцію `get_token_header`. + +Але такого файлу не існує, наші залежності у файлі `app/dependencies.py`. + +Згадайте, як виглядає структура нашого застосунку/файлів: + + + +--- + +Дві крапки `..`, як у: + +```Python +from ..dependencies import get_token_header +``` + +означають: + +* Починаючи в тому самому пакеті, де знаходиться цей модуль (файл `app/routers/items.py`) (каталог `app/routers/`)... +* перейти до батьківського пакета (каталог `app/`)... +* і там знайти модуль `dependencies` (файл `app/dependencies.py`)... +* і з нього імпортувати функцію `get_token_header`. + +Це працює правильно! 🎉 + +--- + +Так само, якби ми використали три крапки `...`, як у: + +```Python +from ...dependencies import get_token_header +``` + +це б означало: + +* Починаючи в тому самому пакеті, де знаходиться цей модуль (файл `app/routers/items.py`) (каталог `app/routers/`)... +* перейти до батьківського пакета (каталог `app/`)... +* потім перейти до батьківського пакета від того (немає батьківського пакета, `app` - верхній рівень 😱)... +* і там знайти модуль `dependencies` (файл `app/dependencies.py`)... +* і з нього імпортувати функцію `get_token_header`. + +Це б посилалося на якийсь пакет вище за `app/` з власним файлом `__init__.py` тощо. Але в нас такого немає. Тож у нашому прикладі це спричинить помилку. 🚨 + +Але тепер ви знаєте, як це працює, тож можете використовувати відносні імпорти у власних застосунках, незалежно від їхньої складності. 🤓 + +### Додайте користувацькі `tags`, `responses` і `dependencies` { #add-some-custom-tags-responses-and-dependencies } + +Ми не додаємо префікс `/items` ані `tags=["items"]` до кожної *операції шляху*, бо додали їх до `APIRouter`. + +Але ми все ще можемо додати _ще_ `tags`, які будуть застосовані до конкретної *операції шляху*, а також додаткові `responses`, специфічні для цієї *операції шляху*: + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[30:31] title["app/routers/items.py"] *} + +/// tip | Порада + +Остання операція шляху матиме комбінацію міток: `["items", "custom"]`. + +І вона також матиме в документації обидві відповіді: одну для `404` і одну для `403`. + +/// + +## Основний `FastAPI` { #the-main-fastapi } + +Тепер розгляньмо модуль `app/main.py`. + +Тут ви імпортуєте і використовуєте клас `FastAPI`. + +Це буде головний файл вашого застосунку, який усе поєднує. + +І оскільки більшість вашої логіки тепер житиме у власних модулях, головний файл буде досить простим. + +### Імпортуйте `FastAPI` { #import-fastapi } + +Імпортуйте та створіть клас `FastAPI`, як зазвичай. + +І ми навіть можемо оголосити [глобальні залежності](dependencies/global-dependencies.md){.internal-link target=_blank}, які будуть поєднані із залежностями кожного `APIRouter`: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[1,3,7] title["app/main.py"] *} + +### Імпортуйте `APIRouter` { #import-the-apirouter } + +Тепер імпортуємо інші підмодулі, що мають `APIRouter`: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[4:5] title["app/main.py"] *} + +Оскільки файли `app/routers/users.py` та `app/routers/items.py` - це підмодулі, що є частиною того самого пакета Python `app`, ми можемо використати одну крапку `.` для «відносних імпортів». + +### Як працює імпорт { #how-the-importing-works } + +Розділ: + +```Python +from .routers import items, users +``` + +означає: + +* Починаючи в тому самому пакеті, де знаходиться цей модуль (файл `app/main.py`) (каталог `app/`)... +* знайти підпакет `routers` (каталог `app/routers/`)... +* і з нього імпортувати підмодулі `items` (файл `app/routers/items.py`) і `users` (файл `app/routers/users.py`)... + +Модуль `items` матиме змінну `router` (`items.router`). Це та сама, що ми створили у файлі `app/routers/items.py`, це об’єкт `APIRouter`. + +Потім ми робимо те саме для модуля `users`. + +Ми також могли б імпортувати їх так: + +```Python +from app.routers import items, users +``` + +/// info | Інформація + +Перша версія - «відносний імпорт»: + +```Python +from .routers import items, users +``` + +Друга версія - «абсолютний імпорт»: + +```Python +from app.routers import items, users +``` + +Щоб дізнатися більше про пакети й модулі Python, прочитайте офіційну документацію Python про модулі. + +/// + +### Уникайте колізій імен { #avoid-name-collisions } + +Ми імпортуємо підмодуль `items` напряму, замість імпорту лише його змінної `router`. + +Це тому, що в підмодулі `users` також є змінна з назвою `router`. + +Якби ми імпортували один за одним, як: + +```Python +from .routers.items import router +from .routers.users import router +``` + +`router` з `users` перезаписав би той, що з `items`, і ми не змогли б використовувати їх одночасно. + +Щоб мати змогу використовувати обидва в одному файлі, ми імпортуємо підмодулі напряму: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[5] title["app/main.py"] *} + +### Додайте `APIRouter` для `users` і `items` { #include-the-apirouters-for-users-and-items } + +Тепер додаймо `router` з підмодулів `users` і `items`: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[10:11] title["app/main.py"] *} + +/// info | Інформація + +`users.router` містить `APIRouter` у файлі `app/routers/users.py`. + +А `items.router` містить `APIRouter` у файлі `app/routers/items.py`. + +/// + +За допомогою `app.include_router()` ми можемо додати кожен `APIRouter` до основного застосунку `FastAPI`. + +Це включить усі маршрути з цього router'а як частину застосунку. + +/// note | Технічні деталі + +Фактично, всередині для кожної *операції шляху*, оголошеної в `APIRouter`, буде створена окрема *операція шляху*. + +Тобто за лаштунками все працюватиме так, ніби це один і той самий застосунок. + +/// + +/// check | Перевірте + +Вам не потрібно перейматися продуктивністю під час включення router'ів. + +Це займе мікросекунди і відбуватиметься лише під час запуску. + +Тож це не вплине на продуктивність. ⚡ + +/// + +### Додайте `APIRouter` з власними `prefix`, `tags`, `responses` і `dependencies` { #include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies } + +Уявімо, що ваша організація надала вам файл `app/internal/admin.py`. + +Він містить `APIRouter` з кількома адміністративними *операціями шляху*, які організація спільно використовує між кількома проєктами. + +Для цього прикладу він буде дуже простим. Але припустімо, що оскільки його спільно використовують з іншими проєктами організації, ми не можемо модифікувати його та додавати `prefix`, `dependencies`, `tags` тощо прямо до `APIRouter`: + +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} + +Але ми все одно хочемо встановити користувацький `prefix` під час включення `APIRouter`, щоб усі його *операції шляху* починалися з `/admin`, хочемо захистити його за допомогою `dependencies`, які вже є в цьому проєкті, і хочемо додати `tags` та `responses`. + +Ми можемо оголосити все це, не змінюючи оригінальний `APIRouter`, передавши ці параметри до `app.include_router()`: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[14:17] title["app/main.py"] *} + +Таким чином, вихідний `APIRouter` залишиться без змін, тож ми все ще зможемо спільно використовувати той самий файл `app/internal/admin.py` з іншими проєктами в організації. + +У результаті в нашому застосунку кожна з *операцій шляху* з модуля `admin` матиме: + +* Префікс `/admin`. +* Мітку `admin`. +* Залежність `get_token_header`. +* Відповідь `418`. 🍵 + +Але це вплине лише на цей `APIRouter` у нашому застосунку, а не на будь-який інший код, який його використовує. + +Наприклад, інші проєкти можуть використовувати той самий `APIRouter` з іншим методом автентифікації. + +### Додайте *операцію шляху* { #include-a-path-operation } + +Ми також можемо додавати *операції шляху* безпосередньо до застосунку `FastAPI`. + +Тут ми це робимо... просто щоб показати, що так можна 🤷: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[21:23] title["app/main.py"] *} + +і це працюватиме коректно разом з усіма іншими *операціями шляху*, доданими через `app.include_router()`. + +/// info | Дуже технічні деталі + +Примітка: це дуже технічна деталь, яку ви, ймовірно, можете просто пропустити. + +--- + +`APIRouter` не «монтуються», вони не ізольовані від решти застосунку. + +Це тому, що ми хочемо включати їхні *операції шляху* в схему OpenAPI та інтерфейси користувача. + +Оскільки ми не можемо просто ізолювати їх і «змонтувати» незалежно від решти, *операції шляху* «клонуються» (створюються заново), а не включаються безпосередньо. + +/// + +## Перевірте автоматичну документацію API { #check-the-automatic-api-docs } + +Тепер запустіть ваш застосунок: + +
+ +```console +$ fastapi dev app/main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +І відкрийте документацію за адресою http://127.0.0.1:8000/docs. + +Ви побачите автоматичну документацію API, що включає шляхи з усіх підмодулів, з правильними шляхами (і префіксами) та правильними мітками: + + + +## Включайте той самий router кілька разів з різними `prefix` { #include-the-same-router-multiple-times-with-different-prefix } + +Ви також можете використовувати `.include_router()` кілька разів з одним і тим самим router'ом, але з різними префіксами. + +Це може бути корисно, наприклад, щоб публікувати той самий API під різними префіксами, наприклад `/api/v1` і `/api/latest`. + +Це просунуте використання, яке вам може й не знадобитися, але воно є на випадок, якщо потрібно. + +## Включіть один `APIRouter` до іншого { #include-an-apirouter-in-another } + +Так само як ви можете включити `APIRouter` у застосунок `FastAPI`, ви можете включити `APIRouter` в інший `APIRouter`, використовуючи: + +```Python +router.include_router(other_router) +``` + +Переконайтеся, що ви робите це до включення `router` в застосунок `FastAPI`, щоб *операції шляху* з `other_router` також були включені. diff --git a/docs/uk/docs/tutorial/dependencies/classes-as-dependencies.md b/docs/uk/docs/tutorial/dependencies/classes-as-dependencies.md new file mode 100644 index 0000000000..e64f90ae24 --- /dev/null +++ b/docs/uk/docs/tutorial/dependencies/classes-as-dependencies.md @@ -0,0 +1,288 @@ +# Класи як залежності { #classes-as-dependencies } + +Перш ніж заглибитися у систему **впровадження залежностей**, оновімо попередній приклад. + +## `dict` з попереднього прикладу { #a-dict-from-the-previous-example } + +У попередньому прикладі ми повертали `dict` із нашого «залежного»: + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[9] *} + +Але тоді ми отримуємо `dict` у параметрі `commons` функції операції шляху. + +І ми знаємо, що редактори не можуть надати багато підтримки (наприклад, автодоповнення) для `dict`, адже вони не знають їхніх ключів і типів значень. + +Можна зробити краще… + +## Що робить об’єкт залежністю { #what-makes-a-dependency } + +Дотепер ви бачили залежності, оголошені як функції. + +Але це не єдиний спосіб оголошувати залежності (хоча, ймовірно, найпоширеніший). + +Ключовий момент у тому, що залежність має бути «викликаємим». + +«Викликаємий» у Python - це будь-що, що Python може «викликати», як функцію. + +Отже, якщо у вас є об’єкт `something` (який може й не бути функцією) і ви можете «викликати» його (виконати) так: + +```Python +something() +``` + +або + +```Python +something(some_argument, some_keyword_argument="foo") +``` + +тоді це «викликаємий». + +## Класи як залежності { #classes-as-dependencies_1 } + +Ви могли помітити, що для створення екземпляра класу Python ви використовуєте той самий синтаксис. + +Наприклад: + +```Python +class Cat: + def __init__(self, name: str): + self.name = name + + +fluffy = Cat(name="Mr Fluffy") +``` + +У цьому випадку `fluffy` - екземпляр класу `Cat`. + +А для створення `fluffy` ви «викликаєте» `Cat`. + +Отже, клас Python також є **викликаємим**. + +Тож у **FastAPI** ви можете використовувати клас Python як залежність. + +Насправді **FastAPI** перевіряє, що це «викликаємий» об’єкт (функція, клас чи щось інше) і які параметри в нього оголошені. + +Якщо ви передаєте «викликаємий» як залежність у **FastAPI**, він проаналізує параметри цього об’єкта і обробить їх так само, як параметри для функції операції шляху. Включно з підзалежностями. + +Це також стосується викликаємих без жодних параметрів. Так само, як і для функцій операцій шляху без параметрів. + +Тоді ми можемо змінити залежність `common_parameters` вище на клас `CommonQueryParams`: + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[11:15] *} + +Зверніть увагу на метод `__init__`, який використовують для створення екземпляра класу: + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[12] *} + +…він має ті самі параметри, що й наш попередній `common_parameters`: + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[8] *} + +Саме ці параметри **FastAPI** використає, щоб «розв’язати» залежність. + +В обох випадках буде: + +- Необов’язковий параметр запиту `q`, який є `str`. +- Параметр запиту `skip`, який є `int`, зі значенням за замовчуванням `0`. +- Параметр запиту `limit`, який є `int`, зі значенням за замовчуванням `100`. + +В обох випадках дані будуть перетворені, перевірені й задокументовані в схемі OpenAPI тощо. + +## Використання { #use-it } + +Тепер ви можете оголосити залежність, використовуючи цей клас. + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[19] *} + +**FastAPI** викликає клас `CommonQueryParams`. Це створює «екземпляр» цього класу, і цей екземпляр буде передано як параметр `commons` у вашу функцію. + +## Анотація типів проти `Depends` { #type-annotation-vs-depends } + +Зверніть увагу, що вище ми двічі пишемо `CommonQueryParams`: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ без Annotated + +/// tip | Порада + +Надавайте перевагу варіанту з `Annotated`, якщо це можливо. + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +Останній `CommonQueryParams` у: + +```Python +... Depends(CommonQueryParams) +``` + + - це те, що **FastAPI** фактично використає, щоб дізнатися, яка залежність. + +Саме з нього **FastAPI** витягне оголошені параметри і саме його **FastAPI** буде викликати. + +--- + +У цьому випадку перший `CommonQueryParams` у: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, ... +``` + +//// + +//// tab | Python 3.10+ без Annotated + +/// tip | Порада + +Надавайте перевагу варіанту з `Annotated`, якщо це можливо. + +/// + +```Python +commons: CommonQueryParams ... +``` + +//// + +…не має жодного особливого значення для **FastAPI**. FastAPI не використовуватиме його для перетворення даних, перевірки тощо (адже для цього використовується `Depends(CommonQueryParams)`). + +Насправді ви могли б написати просто: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[Any, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ без Annotated + +/// tip | Порада + +Надавайте перевагу варіанту з `Annotated`, якщо це можливо. + +/// + +```Python +commons = Depends(CommonQueryParams) +``` + +//// + +…як у: + +{* ../../docs_src/dependencies/tutorial003_an_py310.py hl[19] *} + +Але оголошувати тип рекомендується - так ваш редактор знатиме, що буде передано в параметр `commons`, і зможе допомагати з автодоповненням, перевірками типів тощо: + + + +## Скорочення { #shortcut } + +Але ви бачите, що тут маємо деяке дублювання коду - `CommonQueryParams` пишемо двічі: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ без Annotated + +/// tip | Порада + +Надавайте перевагу варіанту з `Annotated`, якщо це можливо. + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +**FastAPI** надає скорочення для таких випадків, коли залежність - це саме клас, який **FastAPI** «викличе», щоб створити екземпляр цього класу. + +Для таких випадків ви можете зробити так: + +Замість того щоб писати: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ без Annotated + +/// tip | Порада + +Надавайте перевагу варіанту з `Annotated`, якщо це можливо. + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +…напишіть: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends()] +``` + +//// + +//// tab | Python 3.10+ без Annotated + +/// tip | Порада + +Надавайте перевагу варіанту з `Annotated`, якщо це можливо. + +/// + +```Python +commons: CommonQueryParams = Depends() +``` + +//// + +Ви оголошуєте залежність як тип параметра і використовуєте `Depends()` без параметрів, замість того щоб вдруге писати повний клас усередині `Depends(CommonQueryParams)`. + +Той самий приклад виглядатиме так: + +{* ../../docs_src/dependencies/tutorial004_an_py310.py hl[19] *} + +…і **FastAPI** знатиме, що робити. + +/// tip | Порада + +Якщо це здається заплутанішим, ніж корисним, просто не використовуйте це - воно не є обов’язковим. + +Це лише скорочення. Адже **FastAPI** дбає про мінімізацію дублювання коду. + +/// diff --git a/docs/uk/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md b/docs/uk/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md new file mode 100644 index 0000000000..4614c626c5 --- /dev/null +++ b/docs/uk/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md @@ -0,0 +1,69 @@ +# Залежності в декораторах операцій шляху { #dependencies-in-path-operation-decorators } + +Іноді вам насправді не потрібне значення, яке повертає залежність, у вашій *функції операції шляху*. + +Або залежність узагалі не повертає значення. + +Але її все одно потрібно виконати/опрацювати. + +Для таких випадків, замість оголошення параметра *функції операції шляху* з `Depends`, ви можете додати `list` `dependencies` до *декоратора операції шляху*. + +## Додайте `dependencies` до *декоратора операції шляху* { #add-dependencies-to-the-path-operation-decorator } + +*Декоратор операції шляху* приймає необов'язковий аргумент `dependencies`. + +Це має бути `list` з `Depends()`: + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[19] *} + +Ці залежності будуть виконані/оброблені так само, як звичайні залежності. Але їхні значення (якщо щось повертають) не передаватимуться у вашу *функцію операції шляху*. + +/// tip | Порада + +Деякі редактори перевіряють невикористані параметри функцій і показують їх як помилки. + +Використовуючи ці `dependencies` у *декораторі операції шляху*, ви можете гарантувати їх виконання та водночас уникнути помилок редактора/інструментів. + +Це також може допомогти уникнути плутанини для нових розробників, які бачать невикористаний параметр у вашому коді й можуть вирішити, що він зайвий. + +/// + +/// info | Інформація + +У цьому прикладі ми використовуємо вигадані власні заголовки `X-Key` і `X-Token`. + +Але в реальних випадках, під час впровадження безпеки, ви отримаєте більше користі, використовуючи вбудовані [Інструменти безпеки (наступний розділ)](../security/index.md){.internal-link target=_blank}. + +/// + +## Помилки залежностей і значення, що повертаються { #dependencies-errors-and-return-values } + +Ви можете використовувати ті самі *функції* залежностей, що й зазвичай. + +### Вимоги залежностей { #dependency-requirements } + +Вони можуть оголошувати вимоги до запиту (наприклад, заголовки) або інші підзалежності: + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[8,13] *} + +### Підіймати винятки { #raise-exceptions } + +Ці залежності можуть `raise` винятки, так само як і звичайні залежності: + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[10,15] *} + +### Значення, що повертаються { #return-values } + +Вони можуть повертати значення або ні - ці значення не використовуватимуться. + +Отже, ви можете перевикористати звичайну залежність (яка повертає значення), яку вже застосовуєте деінде, і навіть якщо значення не буде використано, залежність буде виконана: + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[11,16] *} + +## Залежності для групи операцій шляху { #dependencies-for-a-group-of-path-operations } + +Далі, читаючи про структурування великих застосунків ([Більші застосунки - декілька файлів](../../tutorial/bigger-applications.md){.internal-link target=_blank}), можливо з кількома файлами, ви дізнаєтеся, як оголосити один параметр `dependencies` для групи *операцій шляху*. + +## Глобальні залежності { #global-dependencies } + +Далі ми побачимо, як додати залежності до всього застосунку `FastAPI`, щоб вони застосовувалися до кожної *операції шляху*. diff --git a/docs/uk/docs/tutorial/dependencies/dependencies-with-yield.md b/docs/uk/docs/tutorial/dependencies/dependencies-with-yield.md new file mode 100644 index 0000000000..70d4210a1c --- /dev/null +++ b/docs/uk/docs/tutorial/dependencies/dependencies-with-yield.md @@ -0,0 +1,289 @@ +# Залежності з yield { #dependencies-with-yield } + +FastAPI підтримує залежності, які виконують деякі додаткові кроки після завершення. + +Щоб це зробити, використовуйте `yield` замість `return` і напишіть додаткові кроки (код) після нього. + +/// tip | Порада + +Переконайтесь, що ви використовуєте `yield` лише один раз на залежність. + +/// + +/// note | Технічні деталі + +Будь-яка функція, яку можна використовувати з: + +* `@contextlib.contextmanager` або +* `@contextlib.asynccontextmanager` + +буде придатною як залежність у **FastAPI**. + +Насправді FastAPI використовує ці два декоратори внутрішньо. + +/// + +## Залежність бази даних з `yield` { #a-database-dependency-with-yield } + +Наприклад, ви можете використати це, щоб створити сесію бази даних і закрити її після завершення. + +Перед створенням відповіді виконується лише код до і включно з оператором `yield`: + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[2:4] *} + +Значення, передане `yield`, впроваджується в *операції шляху* та інші залежності: + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[4] *} + +Код після оператора `yield` виконується після відповіді: + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[5:6] *} + +/// tip | Порада + +Можете використовувати як `async`, так і звичайні функції. + +**FastAPI** зробить усе правильно з кожною з них, так само як і зі звичайними залежностями. + +/// + +## Залежність з `yield` та `try` { #a-dependency-with-yield-and-try } + +Якщо ви використовуєте блок `try` в залежності з `yield`, ви отримаєте будь-який виняток, який був згенерований під час використання залежності. + +Наприклад, якщо якийсь код десь посередині, в іншій залежності або в *операції шляху*, зробив «rollback» транзакції бази даних або створив будь-який інший виняток, ви отримаєте цей виняток у своїй залежності. + +Тож ви можете обробити цей конкретний виняток усередині залежності за допомогою `except SomeException`. + +Так само ви можете використовувати `finally`, щоб гарантувати виконання завершальних кроків незалежно від того, був виняток чи ні. + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[3,5] *} + +## Підзалежності з `yield` { #sub-dependencies-with-yield } + +Ви можете мати підзалежності та «дерева» підзалежностей будь-якого розміру і форми, і будь-яка або всі з них можуть використовувати `yield`. + +**FastAPI** гарантує, що «exit code» у кожній залежності з `yield` буде виконано в правильному порядку. + +Наприклад, `dependency_c` може залежати від `dependency_b`, а `dependency_b` - від `dependency_a`: + +{* ../../docs_src/dependencies/tutorial008_an_py310.py hl[6,14,22] *} + +І всі вони можуть використовувати `yield`. + +У цьому випадку `dependency_c`, щоб виконати свій завершальний код, потребує, щоб значення з `dependency_b` (тут `dep_b`) все ще було доступним. + +І, у свою чергу, `dependency_b` потребує, щоб значення з `dependency_a` (тут `dep_a`) було доступним для свого завершального коду. + +{* ../../docs_src/dependencies/tutorial008_an_py310.py hl[18:19,26:27] *} + +Так само ви можете мати деякі залежності з `yield`, а інші - з `return`, і частина з них може залежати від інших. + +І ви можете мати одну залежність, яка вимагає кілька інших залежностей з `yield` тощо. + +Ви можете мати будь-які комбінації залежностей, які вам потрібні. + +**FastAPI** подбає, щоб усе виконувалося в правильному порядку. + +/// note | Технічні деталі + +Це працює завдяки Менеджерам контексту Python. + +**FastAPI** використовує їх внутрішньо, щоб досягти цього. + +/// + +## Залежності з `yield` та `HTTPException` { #dependencies-with-yield-and-httpexception } + +Ви бачили, що можна використовувати залежності з `yield` і мати блоки `try`, які намагаються виконати деякий код, а потім запускають завершальний код після `finally`. + +Також можна використовувати `except`, щоб перехопити згенерований виняток і щось із ним зробити. + +Наприклад, ви можете підняти інший виняток, як-от `HTTPException`. + +/// tip | Порада + +Це доволі просунута техніка, і в більшості випадків вона вам не знадобиться, адже ви можете піднімати винятки (включно з `HTTPException`) всередині іншого коду вашого застосунку, наприклад, у *функції операції шляху*. + +Але вона є, якщо вам це потрібно. 🤓 + +/// + +{* ../../docs_src/dependencies/tutorial008b_an_py310.py hl[18:22,31] *} + +Якщо ви хочете перехоплювати винятки та створювати на їх основі користувацьку відповідь, створіть [Користувацький обробник винятків](../handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank}. + +## Залежності з `yield` та `except` { #dependencies-with-yield-and-except } + +Якщо ви перехоплюєте виняток за допомогою `except` у залежності з `yield` і не піднімаєте його знову (або не піднімаєте новий виняток), FastAPI не зможе помітити, що стався виняток, так само як це було б у звичайному Python: + +{* ../../docs_src/dependencies/tutorial008c_an_py310.py hl[15:16] *} + +У цьому випадку клієнт побачить відповідь *HTTP 500 Internal Server Error*, як і має бути, з огляду на те, що ми не піднімаємо `HTTPException` або подібний виняток, але на сервері **не буде жодних логів** чи інших ознак того, що це була за помилка. 😱 + +### Завжди використовуйте `raise` у залежностях з `yield` та `except` { #always-raise-in-dependencies-with-yield-and-except } + +Якщо ви перехоплюєте виняток у залежності з `yield`, якщо тільки ви не піднімаєте інший `HTTPException` або подібний, **вам слід повторно підняти початковий виняток**. + +Ви можете повторно підняти той самий виняток, використовуючи `raise`: + +{* ../../docs_src/dependencies/tutorial008d_an_py310.py hl[17] *} + +Тепер клієнт отримає ту саму відповідь *HTTP 500 Internal Server Error*, але сервер матиме наш користувацький `InternalError` у логах. 😎 + +## Виконання залежностей з `yield` { #execution-of-dependencies-with-yield } + +Послідовність виконання приблизно така, як на цій діаграмі. Час тече зверху вниз. І кожна колонка - це одна з частин, що взаємодіють або виконують код. + +```mermaid +sequenceDiagram + +participant client as Client +participant handler as Exception handler +participant dep as Dep with yield +participant operation as Path Operation +participant tasks as Background tasks + + Note over client,operation: Can raise exceptions, including HTTPException + client ->> dep: Start request + Note over dep: Run code up to yield + opt raise Exception + dep -->> handler: Raise Exception + handler -->> client: HTTP error response + end + dep ->> operation: Run dependency, e.g. DB session + opt raise + operation -->> dep: Raise Exception (e.g. HTTPException) + opt handle + dep -->> dep: Can catch exception, raise a new HTTPException, raise other exception + end + handler -->> client: HTTP error response + end + + operation ->> client: Return response to client + Note over client,operation: Response is already sent, can't change it anymore + opt Tasks + operation -->> tasks: Send background tasks + end + opt Raise other exception + tasks -->> tasks: Handle exceptions in the background task code + end +``` + +/// info | Інформація + +Лише **одна відповідь** буде надіслана клієнту. Це може бути одна з помилкових відповідей або відповідь від *операції шляху*. + +Після відправлення однієї з цих відповідей іншу відправити не можна. + +/// + +/// tip | Порада + +Якщо ви піднімаєте будь-який виняток у коді з *функції операції шляху*, він буде переданий у залежності з `yield`, включно з `HTTPException`. У більшості випадків ви захочете повторно підняти той самий виняток або новий із залежності з `yield`, щоб переконатися, що його коректно оброблено. + +/// + +## Ранній вихід і `scope` { #early-exit-and-scope } + +Зазвичай завершальний код залежностей з `yield` виконується **після того**, як відповідь надіслано клієнту. + +Але якщо ви знаєте, що вам не потрібно використовувати залежність після повернення з *функції операції шляху*, ви можете використати `Depends(scope="function")`, щоб сказати FastAPI, що слід закрити залежність після повернення з *функції операції шляху*, але **до** надсилання **відповіді**. + +{* ../../docs_src/dependencies/tutorial008e_an_py310.py hl[12,16] *} + +`Depends()` приймає параметр `scope`, який може бути: + +* `"function"`: запустити залежність перед *функцією операції шляху*, що обробляє запит, завершити залежність після завершення *функції операції шляху*, але **до** того, як відповідь буде відправлена клієнту. Тобто функція залежності буде виконуватися **навколо** *функції операції **шляху***. +* `"request"`: запустити залежність перед *функцією операції шляху*, що обробляє запит (подібно до `"function"`), але завершити **після** того, як відповідь буде відправлена клієнту. Тобто функція залежності буде виконуватися **навколо** циклу **запиту** та відповіді. + +Якщо не вказано, і залежність має `yield`, за замовчуванням `scope` дорівнює `"request"`. + +### `scope` для підзалежностей { #scope-for-sub-dependencies } + +Коли ви оголошуєте залежність із `scope="request"` (за замовчуванням), будь-яка підзалежність також має мати `scope` рівний `"request"`. + +Але залежність з `scope` рівним `"function"` може мати залежності з `scope` `"function"` і `scope` `"request"`. + +Це тому, що будь-яка залежність має бути здатною виконати свій завершальний код раніше за підзалежності, оскільки вона може все ще потребувати їх під час свого завершального коду. + +```mermaid +sequenceDiagram + +participant client as Client +participant dep_req as Dep scope="request" +participant dep_func as Dep scope="function" +participant operation as Path Operation + + client ->> dep_req: Start request + Note over dep_req: Run code up to yield + dep_req ->> dep_func: Pass dependency + Note over dep_func: Run code up to yield + dep_func ->> operation: Run path operation with dependency + operation ->> dep_func: Return from path operation + Note over dep_func: Run code after yield + Note over dep_func: ✅ Dependency closed + dep_func ->> client: Send response to client + Note over client: Response sent + Note over dep_req: Run code after yield + Note over dep_req: ✅ Dependency closed +``` + +## Залежності з `yield`, `HTTPException`, `except` і фоновими задачами { #dependencies-with-yield-httpexception-except-and-background-tasks } + +Залежності з `yield` еволюціонували з часом, щоб покрити різні сценарії та виправити деякі проблеми. + +Якщо ви хочете дізнатися, що змінювалося в різних версіях FastAPI, прочитайте про це в просунутому посібнику користувача: [Розширені залежності - Залежності з `yield`, `HTTPException`, `except` і фоновими задачами](../../advanced/advanced-dependencies.md#dependencies-with-yield-httpexception-except-and-background-tasks){.internal-link target=_blank}. +## Менеджери контексту { #context-managers } + +### Що таке «Менеджери контексту» { #what-are-context-managers } + +«Менеджери контексту» - це будь-які Python-об'єкти, які можна використовувати в операторі `with`. + +Наприклад, можна використати `with`, щоб прочитати файл: + +```Python +with open("./somefile.txt") as f: + contents = f.read() + print(contents) +``` + +Під капотом `open("./somefile.txt")` створює об'єкт, який називається «Менеджер контексту». + +Коли блок `with` завершується, він гарантує закриття файлу, навіть якщо були винятки. + +Коли ви створюєте залежність з `yield`, **FastAPI** внутрішньо створить для неї менеджер контексту й поєднає його з іншими пов'язаними інструментами. + +### Використання менеджерів контексту в залежностях з `yield` { #using-context-managers-in-dependencies-with-yield } + +/// warning | Попередження + +Це, загалом, «просунута» ідея. + +Якщо ви тільки починаєте з **FastAPI**, можливо, варто наразі пропустити це. + +/// + +У Python ви можете створювати Менеджери контексту, створивши клас із двома методами: `__enter__()` і `__exit__()`. + +Ви також можете використовувати їх усередині залежностей **FastAPI** з `yield`, використовуючи +`with` або `async with` у середині функції залежності: + +{* ../../docs_src/dependencies/tutorial010_py310.py hl[1:9,13] *} + +/// tip | Порада + +Інший спосіб створити менеджер контексту: + +* `@contextlib.contextmanager` або +* `@contextlib.asynccontextmanager` + +використовуючи їх для декорування функції з одним `yield`. + +Саме це **FastAPI** використовує внутрішньо для залежностей з `yield`. + +Але вам не потрібно використовувати ці декоратори для залежностей FastAPI (і не варто). + +FastAPI зробить це за вас внутрішньо. + +/// diff --git a/docs/uk/docs/tutorial/dependencies/global-dependencies.md b/docs/uk/docs/tutorial/dependencies/global-dependencies.md new file mode 100644 index 0000000000..3cffa1752c --- /dev/null +++ b/docs/uk/docs/tutorial/dependencies/global-dependencies.md @@ -0,0 +1,15 @@ +# Глобальні залежності { #global-dependencies } + +Для деяких типів застосунків ви можете захотіти додати залежності до всього застосунку. + +Подібно до того, як ви можете [додавати `dependencies` до *декораторів операцій шляху*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, ви можете додати їх до застосунку `FastAPI`. + +У такому разі вони будуть застосовані до всіх *операцій шляху* в застосунку: + +{* ../../docs_src/dependencies/tutorial012_an_py310.py hl[17] *} + +Усі ідеї з розділу про [додавання `dependencies` до *декораторів операцій шляху*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank} так само застосовні, але в цьому випадку - до всіх *операцій шляху* в застосунку. + +## Залежності для груп *операцій шляху* { #dependencies-for-groups-of-path-operations } + +Пізніше, читаючи про структуру більших застосунків ([Більші застосунки - кілька файлів](../../tutorial/bigger-applications.md){.internal-link target=_blank}), можливо з кількома файлами, ви дізнаєтеся, як оголосити єдиний параметр `dependencies` для групи *операцій шляху*. diff --git a/docs/uk/docs/tutorial/dependencies/index.md b/docs/uk/docs/tutorial/dependencies/index.md new file mode 100644 index 0000000000..cbcf693077 --- /dev/null +++ b/docs/uk/docs/tutorial/dependencies/index.md @@ -0,0 +1,250 @@ +# Залежності { #dependencies } + +**FastAPI** має дуже потужну, але інтуїтивну систему **Впровадження залежностей**. + +Вона створена так, щоб бути дуже простою у використанні та щоб полегшити будь-якому розробнику інтеграцію інших компонентів з **FastAPI**. + +## Що таке «Впровадження залежностей» { #what-is-dependency-injection } + +У програмуванні **«Впровадження залежностей»** означає, що існує спосіб для вашого коду (у цьому випадку ваших *функцій операцій шляху*) задекларувати речі, які йому потрібні для роботи: «залежності». + +А потім ця система (у цьому випадку **FastAPI**) подбає про все необхідне, щоб надати вашому коду ці потрібні залежності («інжектувати» залежності). + +Це дуже корисно, коли вам потрібно: + +* Мати спільну логіку (одна й та сама логіка знову і знову). +* Ділитися з’єднаннями з базою даних. +* Примусово застосовувати безпеку, автентифікацію, вимоги до ролей тощо. +* І багато іншого... + +Все це з мінімізацією дублювання коду. + +## Перші кроки { #first-steps } + +Розгляньмо дуже простий приклад. Він буде таким простим, що поки що не дуже корисним. + +Але так ми зможемо зосередитися на тому, як працює система **Впровадження залежностей**. + +### Створіть залежність або «залежний» { #create-a-dependency-or-dependable } + +Спочатку зосередьмося на залежності. + +Це просто функція, яка може приймати ті самі параметри, що й *функція операції шляху*: + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[8:9] *} + +Ось і все. + +**2 рядки**. + +І вона має ту саму форму та структуру, що й усі ваші *функції операцій шляху*. + +Можете думати про неї як про *функцію операції шляху* без «декоратора» (без `@app.get("/some-path")`). + +І вона може повертати будь-що. + +У цьому випадку ця залежність очікує: + +* Необов’язковий параметр запиту `q` типу `str`. +* Необов’язковий параметр запиту `skip` типу `int`, за замовчуванням `0`. +* Необов’язковий параметр запиту `limit` типу `int`, за замовчуванням `100`. + +Потім вона просто повертає `dict`, що містить ці значення. + +/// info | Інформація + +FastAPI додав підтримку `Annotated` (і почав її рекомендувати) у версії 0.95.0. + +Якщо у вас старіша версія, ви отримаєте помилки при спробі використати `Annotated`. + +Переконайтеся, що ви [Оновіть версію FastAPI](../../deployment/versions.md#upgrading-the-fastapi-versions){.internal-link target=_blank} щонайменше до 0.95.1 перед використанням `Annotated`. + +/// + +### Імпортуйте `Depends` { #import-depends } + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[3] *} + +### Оголосіть залежність у «залежному» { #declare-the-dependency-in-the-dependant } + +Так само, як ви використовуєте `Body`, `Query` тощо з параметрами вашої *функції операції шляху*, використовуйте `Depends` з новим параметром: + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[13,18] *} + +Хоча ви використовуєте `Depends` у параметрах вашої функції так само, як `Body`, `Query` тощо, `Depends` працює трохи інакше. + +Ви передаєте в `Depends` лише один параметр. + +Цей параметр має бути чимось на кшталт функції. + +Ви її не викликаєте безпосередньо (не додавайте дужки в кінці), ви просто передаєте її як параметр у `Depends()`. + +І ця функція приймає параметри так само, як і *функції операцій шляху*. + +/// tip | Порада + +У наступному розділі ви побачите, які ще «речі», окрім функцій, можна використовувати як залежності. + +/// + +Щоразу, коли надходить новий запит, **FastAPI** подбає про: + +* Виклик вашої функції-залежності («залежного») з правильними параметрами. +* Отримання результату з вашої функції. +* Присвоєння цього результату параметру у вашій *функції операції шляху*. + +```mermaid +graph TB + +common_parameters(["common_parameters"]) +read_items["/items/"] +read_users["/users/"] + +common_parameters --> read_items +common_parameters --> read_users +``` + +Таким чином ви пишете спільний код один раз, а **FastAPI** подбає про його виклик для ваших *операцій шляху*. + +/// check | Перевірте + +Зверніть увагу, що вам не потрібно створювати спеціальний клас і передавати його кудись у **FastAPI**, щоб «зареєструвати» його чи щось подібне. + +Ви просто передаєте його в `Depends`, і **FastAPI** знає, що робити далі. + +/// + +## Спільне використання залежностей `Annotated` { #share-annotated-dependencies } + +У наведених вище прикладах видно невелике **дублювання коду**. + +Коли вам потрібно використати залежність `common_parameters()`, доводиться писати весь параметр з анотацією типу та `Depends()`: + +```Python +commons: Annotated[dict, Depends(common_parameters)] +``` + +Але оскільки ми використовуємо `Annotated`, ми можемо зберегти це значення `Annotated` у змінній і використовувати його в кількох місцях: + +{* ../../docs_src/dependencies/tutorial001_02_an_py310.py hl[12,16,21] *} + +/// tip | Порада + +Це просто стандартний Python, це називається «псевдонім типу» і насправді не є специфічним для **FastAPI**. + +Але оскільки **FastAPI** базується на стандартах Python, включно з `Annotated`, ви можете використати цей трюк у своєму коді. 😎 + +/// + +Залежності продовжать працювати як очікується, і **найкраще** те, що **інформація про типи буде збережена**, а це означає, що ваш редактор зможе й надалі надавати **автозаповнення**, **помилки в рядку** тощо. Те саме і для інших інструментів, як-от `mypy`. + +Це буде особливо корисно у **великій кодовій базі**, де ви використовуєте **одні й ті самі залежності** знову і знову в **багатьох *операціях шляху***. + +## Бути `async` чи не бути `async` { #to-async-or-not-to-async } + +Оскільки залежності також викликатимуться **FastAPI** (так само, як і ваші *функції операцій шляху*), під час визначення ваших функцій діють ті самі правила. + +Ви можете використовувати `async def` або звичайний `def`. + +І ви можете оголошувати залежності з `async def` всередині звичайних *функцій операцій шляху* з `def`, або залежності з `def` всередині *функцій операцій шляху* з `async def` тощо. + +Це не має значення. **FastAPI** знатиме, що робити. + +/// note | Примітка + +Якщо ви не впевнені, перегляньте розділ [Async: *"In a hurry?"*](../../async.md#in-a-hurry){.internal-link target=_blank} про `async` і `await` у документації. + +/// + +## Інтегровано з OpenAPI { #integrated-with-openapi } + +Усі декларації запитів, перевірки та вимоги ваших залежностей (і субзалежностей) будуть інтегровані в ту саму схему OpenAPI. + +Тож інтерактивна документація також міститиме всю інформацію з цих залежностей: + + + +## Просте використання { #simple-usage } + +Якщо придивитися, *функції операцій шляху* оголошуються для використання щоразу, коли збігаються *шлях* та *операція*, а потім **FastAPI** подбає про виклик функції з правильними параметрами, витягуючи дані із запиту. + +Насправді всі (або більшість) вебфреймворків працюють так само. + +Ви ніколи не викликаєте ці функції безпосередньо. Їх викликає ваш фреймворк (у цьому випадку **FastAPI**). + +За допомогою системи впровадження залежностей ви також можете вказати **FastAPI**, що ваша *функція операції шляху* також «залежить» від чогось, що має бути виконано до вашої *функції операції шляху*, і **FastAPI** подбає про виконання цього та «інжектування» результатів. + +Інші поширені терміни для цієї самої ідеї «впровадження залежностей»: + +* ресурси +* провайдери +* сервіси +* інжектовані об’єкти +* компоненти + +## Плагіни **FastAPI** { #fastapi-plug-ins } + +Інтеграції та «плагіни» можна будувати за допомогою системи **Впровадження залежностей**. Але насправді **немає потреби створювати «плагіни»**, оскільки, використовуючи залежності, можна оголосити безмежну кількість інтеграцій та взаємодій, які стають доступними для ваших *функцій операцій шляху*. + +І залежності можна створювати дуже просто та інтуїтивно, що дозволяє вам просто імпортувати потрібні пакунки Python і інтегрувати їх з вашими функціями API за кілька рядків коду, буквально. + +Ви побачите приклади цього в наступних розділах, про реляційні та NoSQL бази даних, безпеку тощо. + +## Сумісність **FastAPI** { #fastapi-compatibility } + +Простота системи впровадження залежностей робить **FastAPI** сумісним з: + +* усіма реляційними базами даних +* NoSQL базами даних +* зовнішніми пакунками +* зовнішніми API +* системами автентифікації та авторизації +* системами моніторингу використання API +* системами інжекції даних у відповідь +* тощо. + +## Просто і потужно { #simple-and-powerful } + +Хоча ієрархічна система впровадження залежностей дуже проста у визначенні та використанні, вона все ще дуже потужна. + +Ви можете визначати залежності, які своєю чергою можуть визначати власні залежності. + +Зрештою будується ієрархічне дерево залежностей, і система **Впровадження залежностей** подбає про розв’язання всіх цих залежностей (і їхніх субзалежностей) та надання (інжектування) результатів на кожному кроці. + +Наприклад, припустімо, у вас є 4 кінцеві точки API (*операції шляху*): + +* `/items/public/` +* `/items/private/` +* `/users/{user_id}/activate` +* `/items/pro/` + +тоді ви могли б додати різні вимоги до дозволів для кожної з них лише за допомогою залежностей і субзалежностей: + +```mermaid +graph TB + +current_user(["current_user"]) +active_user(["active_user"]) +admin_user(["admin_user"]) +paying_user(["paying_user"]) + +public["/items/public/"] +private["/items/private/"] +activate_user["/users/{user_id}/activate"] +pro_items["/items/pro/"] + +current_user --> active_user +active_user --> admin_user +active_user --> paying_user + +current_user --> public +active_user --> private +admin_user --> activate_user +paying_user --> pro_items +``` + +## Інтегровано з **OpenAPI** { #integrated-with-openapi_1 } + +Усі ці залежності, декларуючи свої вимоги, також додають параметри, перевірки тощо до ваших *операцій шляху*. + +**FastAPI** подбає про додавання всього цього до схеми OpenAPI, щоб це відображалося в інтерактивних системах документації. diff --git a/docs/uk/docs/tutorial/dependencies/sub-dependencies.md b/docs/uk/docs/tutorial/dependencies/sub-dependencies.md new file mode 100644 index 0000000000..4e7488086a --- /dev/null +++ b/docs/uk/docs/tutorial/dependencies/sub-dependencies.md @@ -0,0 +1,105 @@ +# Підзалежності { #sub-dependencies } + +Ви можете створювати залежності, які мають підзалежності. + +Вони можуть бути настільки глибокими, наскільки потрібно. + +FastAPI подбає про їх розв'язання. + +## Перша залежність «dependable» { #first-dependency-dependable } + +Можна створити першу залежність («dependable») так: + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[8:9] *} + +Вона оголошує необов'язковий параметр запиту `q` типу `str`, а потім просто повертає його. + +Це досить просто (не дуже корисно), але допоможе зосередитися на тому, як працюють підзалежності. + +## Друга залежність, «dependable» і «dependant» { #second-dependency-dependable-and-dependant } + +Далі ви можете створити іншу функцію залежності («dependable»), яка водночас оголошує власну залежність (тож вона також є «dependant»): + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[13] *} + +Зосередьмося на оголошених параметрах: + +- Хоча ця функція сама є залежністю («dependable»), вона також оголошує іншу залежність (вона «залежить» від чогось). + - Вона залежить від `query_extractor` і присвоює значення, яке він повертає, параметру `q`. +- Вона також оголошує необов'язкове кукі `last_query` типу `str`. + - Якщо користувач не надав параметр запиту `q`, ми використовуємо останній запит, який зберегли раніше в кукі. + +## Використання залежності { #use-the-dependency } + +Потім ми можемо використати залежність так: + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[23] *} + +/// info | Інформація + +Зверніть увагу, що ми оголошуємо лише одну залежність у функції операції шляху — `query_or_cookie_extractor`. + +Але FastAPI знатиме, що спочатку треба розв'язати `query_extractor`, щоб передати його результат у `query_or_cookie_extractor` під час виклику. + +/// + +```mermaid +graph TB + +query_extractor(["query_extractor"]) +query_or_cookie_extractor(["query_or_cookie_extractor"]) + +read_query["/items/"] + +query_extractor --> query_or_cookie_extractor --> read_query +``` + +## Використання тієї ж залежності кілька разів { #using-the-same-dependency-multiple-times } + +Якщо одна з ваших залежностей оголошена кілька разів для однієї операції шляху, наприклад, кілька залежностей мають спільну підзалежність, FastAPI знатиме, що цю підзалежність потрібно викликати лише один раз на запит. + +І він збереже повернуте значення у «кеш» і передасть його всім «dependants», яким воно потрібне в цьому конкретному запиті, замість того щоб викликати залежність кілька разів для одного й того ж запиту. + +У просунутому сценарії, коли ви знаєте, що залежність має викликатися на кожному кроці (можливо, кілька разів) у межах того самого запиту замість використання «кешованого» значення, ви можете встановити параметр `use_cache=False` при використанні `Depends`: + +//// tab | Python 3.10+ + +```Python hl_lines="1" +async def needy_dependency(fresh_value: Annotated[str, Depends(get_value, use_cache=False)]): + return {"fresh_value": fresh_value} +``` + +//// + +//// tab | Python 3.10+ без Annotated + +/// tip | Порада + +Надавайте перевагу версії з `Annotated`, якщо це можливо. + +/// + +```Python hl_lines="1" +async def needy_dependency(fresh_value: str = Depends(get_value, use_cache=False)): + return {"fresh_value": fresh_value} +``` + +//// + +## Підсумок { #recap } + +Попри всі модні терміни, система впровадження залежностей досить проста. + +Це просто функції, які виглядають так само, як функції операцій шляху. + +Втім вона дуже потужна і дозволяє оголошувати довільно глибоко вкладені «графи» залежностей (дерева). + +/// tip | Порада + +Усе це може здаватися не надто корисним на простих прикладах. + +Але ви побачите, наскільки це корисно, у розділах про **безпеку**. + +І також побачите, скільки коду це вам заощадить. + +/// diff --git a/docs/uk/docs/tutorial/extra-models.md b/docs/uk/docs/tutorial/extra-models.md new file mode 100644 index 0000000000..25930b8c0b --- /dev/null +++ b/docs/uk/docs/tutorial/extra-models.md @@ -0,0 +1,211 @@ +# Додаткові моделі { #extra-models } + +Продовжуючи попередній приклад, часто потрібно мати більше ніж одну пов’язану модель. + +Особливо це стосується моделей користувача, тому що: + +* **вхідна модель** повинна мати пароль. +* **вихідна модель** не повинна містити пароль. +* **модель бази даних**, ймовірно, повинна містити хеш пароля. + +/// danger | Обережно + +Ніколи не зберігайте паролі користувачів у відкритому вигляді. Завжди зберігайте «безпечний хеш», який потім можна перевірити. + +Якщо ви ще не знаєте, що таке «хеш пароля», ви дізнаєтесь у [розділах про безпеку](security/simple-oauth2.md#password-hashing){.internal-link target=_blank}. + +/// + +## Кілька моделей { #multiple-models } + +Ось загальна ідея того, як можуть виглядати моделі з їхніми полями пароля та місцями використання: + +{* ../../docs_src/extra_models/tutorial001_py310.py hl[7,9,14,20,22,27:28,31:33,38:39] *} + +### Про `**user_in.model_dump()` { #about-user-in-model-dump } + +#### `.model_dump()` у Pydantic { #pydantics-model-dump } + +`user_in` - це модель Pydantic класу `UserIn`. + +Моделі Pydantic мають метод `.model_dump()`, який повертає `dict` з даними моделі. + +Отже, якщо ми створимо об’єкт Pydantic `user_in` так: + +```Python +user_in = UserIn(username="john", password="secret", email="john.doe@example.com") +``` + +і викличемо: + +```Python +user_dict = user_in.model_dump() +``` + +тепер ми маємо `dict` з даними у змінній `user_dict` (це `dict`, а не об’єкт моделі Pydantic). + +А якщо викликати: + +```Python +print(user_dict) +``` + +ми отримаємо Python `dict` з: + +```Python +{ + 'username': 'john', + 'password': 'secret', + 'email': 'john.doe@example.com', + 'full_name': None, +} +``` + +#### Розпакування `dict` { #unpacking-a-dict } + +Якщо взяти `dict`, наприклад `user_dict`, і передати його у функцію (або клас) як `**user_dict`, Python «розпакує» його. Ключі та значення `user_dict` будуть передані безпосередньо як іменовані аргументи. + +Отже, продовжуючи з `user_dict` вище, запис: + +```Python +UserInDB(**user_dict) +``` + +дасть еквівалентний результат: + +```Python +UserInDB( + username="john", + password="secret", + email="john.doe@example.com", + full_name=None, +) +``` + +А точніше, використовуючи безпосередньо `user_dict`, з будь-яким його вмістом у майбутньому: + +```Python +UserInDB( + username = user_dict["username"], + password = user_dict["password"], + email = user_dict["email"], + full_name = user_dict["full_name"], +) +``` + +#### Модель Pydantic зі вмісту іншої { #a-pydantic-model-from-the-contents-of-another } + +Як у прикладі вище ми отримали `user_dict` з `user_in.model_dump()`, цей код: + +```Python +user_dict = user_in.model_dump() +UserInDB(**user_dict) +``` + +буде еквівалентним: + +```Python +UserInDB(**user_in.model_dump()) +``` + +...тому що `user_in.model_dump()` повертає `dict`, а ми змушуємо Python «розпакувати» його, передаючи в `UserInDB` з префіксом `**`. + +Тож ми отримуємо модель Pydantic з даних іншої моделі Pydantic. + +#### Розпакування `dict` і додаткові ключові аргументи { #unpacking-a-dict-and-extra-keywords } + +Додаючи додатковий іменований аргумент `hashed_password=hashed_password`, як тут: + +```Python +UserInDB(**user_in.model_dump(), hashed_password=hashed_password) +``` + +...у підсумку це дорівнює: + +```Python +UserInDB( + username = user_dict["username"], + password = user_dict["password"], + email = user_dict["email"], + full_name = user_dict["full_name"], + hashed_password = hashed_password, +) +``` + +/// warning | Попередження + +Додаткові допоміжні функції `fake_password_hasher` і `fake_save_user` лише демонструють можливий потік даних і, звісно, не забезпечують реальної безпеки. + +/// + +## Зменшення дублювання { #reduce-duplication } + +Зменшення дублювання коду - одна з ключових ідей у **FastAPI**. + +Адже дублювання коду підвищує ймовірність помилок, проблем безпеки, розсинхронізації коду (коли ви оновлюєте в одному місці, але не в інших) тощо. + +І ці моделі спільно використовують багато даних та дублюють назви і типи атрибутів. + +Можна зробити краще. + +Можна оголосити модель `UserBase`, яка буде базовою для інших моделей. Потім створити підкласи цієї моделі, що наслідуватимуть її атрибути (оголошення типів, валідацію тощо). + +Уся конвертація даних, валідація, документація тощо працюватимуть як зазвичай. + +Таким чином, ми оголошуємо лише відмінності між моделями (з відкритим `password`, з `hashed_password` і без пароля): + +{* ../../docs_src/extra_models/tutorial002_py310.py hl[7,13:14,17:18,21:22] *} + +## `Union` або `anyOf` { #union-or-anyof } + +Ви можете оголосити відповідь як `Union` двох або більше типів - це означає, що відповідь може бути будь-якого з них. + +В OpenAPI це буде визначено як `anyOf`. + +Для цього використайте стандартну підказку типу Python `typing.Union`: + +/// note | Примітка + +Під час визначення `Union` спочатку вказуйте найконкретніший тип, а потім менш конкретний. У прикладі нижче більш конкретний `PlaneItem` стоїть перед `CarItem` у `Union[PlaneItem, CarItem]`. + +/// + +{* ../../docs_src/extra_models/tutorial003_py310.py hl[1,14:15,18:20,33] *} + +### `Union` у Python 3.10 { #union-in-python-3-10 } + +У цьому прикладі ми передаємо `Union[PlaneItem, CarItem]` як значення аргументу `response_model`. + +Оскільки ми передаємо його як значення аргументу, а не в анотації типу, потрібно використовувати `Union` навіть у Python 3.10. + +Якби це була анотація типу, можна було б використати вертикальну риску, наприклад: + +```Python +some_variable: PlaneItem | CarItem +``` + +Але якщо записати це як присвоєння `response_model=PlaneItem | CarItem`, отримаємо помилку, тому що Python спробує виконати невалідну операцію між `PlaneItem` і `CarItem`, замість того щоб трактувати це як анотацію типу. + +## Список моделей { #list-of-models } + +Аналогічно можна оголошувати відповіді як списки об’єктів. + +Для цього використайте стандартний Python `list`: + +{* ../../docs_src/extra_models/tutorial004_py310.py hl[18] *} + +## Відповідь з довільним `dict` { #response-with-arbitrary-dict } + +Також можна оголосити відповідь, використовуючи звичайний довільний `dict`, вказавши лише типи ключів і значень, без моделі Pydantic. + +Це корисно, якщо ви заздалегідь не знаєте допустимі назви полів/атрибутів (які були б потрібні для моделі Pydantic). + +У такому разі можна використати `dict`: + +{* ../../docs_src/extra_models/tutorial005_py310.py hl[6] *} + +## Підсумок { #recap } + +Використовуйте кілька моделей Pydantic і вільно наслідуйте для кожного випадку. + +Не обов’язково мати одну модель даних на сутність, якщо ця сутність може мати різні «стани». Як у випадку сутності користувача зі станами: з `password`, з `password_hash` і без пароля. diff --git a/docs/uk/docs/tutorial/path-operation-configuration.md b/docs/uk/docs/tutorial/path-operation-configuration.md new file mode 100644 index 0000000000..91b58b24ec --- /dev/null +++ b/docs/uk/docs/tutorial/path-operation-configuration.md @@ -0,0 +1,107 @@ +# Налаштування операції шляху { #path-operation-configuration } + +Є кілька параметрів, які ви можете передати вашому «декоратору операції шляху» для налаштування. + +/// warning | Попередження + +Зверніть увагу, що ці параметри передаються безпосередньо «декоратору операції шляху», а не вашій «функції операції шляху». + +/// + +## Код статусу відповіді { #response-status-code } + +Ви можете визначити (HTTP) `status_code`, який буде використано у відповіді вашої «операції шляху». + +Можна передати безпосередньо цілий код, наприклад `404`. + +Якщо ви не пам'ятаєте призначення числових кодів, скористайтеся скороченими константами в `status`: + +{* ../../docs_src/path_operation_configuration/tutorial001_py310.py hl[1,15] *} + +Цей код статусу буде використано у відповіді та додано до схеми OpenAPI. + +/// note | Технічні деталі + +Ви також можете використати `from starlette import status`. + +FastAPI надає той самий `starlette.status` як `fastapi.status` для вашої зручності як розробника. Але він походить безпосередньо зі Starlette. + +/// + +## Мітки { #tags } + +Ви можете додати мітки до вашої «операції шляху», передайте параметр `tags` зі `list` із `str` (зазвичай лише один `str`): + +{* ../../docs_src/path_operation_configuration/tutorial002_py310.py hl[15,20,25] *} + +Вони будуть додані до схеми OpenAPI та використані інтерфейсами автоматичної документації: + + + +### Мітки з переліками { #tags-with-enums } + +У великому застосунку ви можете накопичити багато міток і захочете переконатися, що завжди використовуєте ту саму мітку для пов'язаних «операцій шляху». + +У таких випадках має сенс зберігати мітки в `Enum`. + +FastAPI підтримує це так само, як і зі звичайними строками: + +{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *} + +## Короткий опис і опис { #summary-and-description } + +Ви можете додати `summary` і `description`: + +{* ../../docs_src/path_operation_configuration/tutorial003_py310.py hl[17:18] *} + +## Опис зі строки документації { #description-from-docstring } + +Оскільки описи зазвичай довгі та займають кілька рядків, ви можете оголосити опис «операції шляху» у строці документації функції, і FastAPI прочитає його звідти. + +Ви можете писати Markdown у строці документації, його буде інтерпретовано та показано коректно (з урахуванням відступів у строці документації). + +{* ../../docs_src/path_operation_configuration/tutorial004_py310.py hl[17:25] *} + +Його буде використано в інтерактивній документації: + + + +## Опис відповіді { #response-description } + +Ви можете вказати опис відповіді параметром `response_description`: + +{* ../../docs_src/path_operation_configuration/tutorial005_py310.py hl[18] *} + +/// info | Інформація + +Зверніть увагу, що `response_description` стосується саме відповіді, а `description` стосується «операції шляху» загалом. + +/// + +/// check | Перевірте + +OpenAPI визначає, що кожна «операція шляху» потребує опису відповіді. + +Тому, якщо ви його не надасте, FastAPI автоматично згенерує «Successful response». + +/// + + + +## Позначити операцію шляху як застарілу { #deprecate-a-path-operation } + +Якщо потрібно позначити «операцію шляху» як застарілу, але не видаляючи її, передайте параметр `deprecated`: + +{* ../../docs_src/path_operation_configuration/tutorial006_py310.py hl[16] *} + +У інтерактивній документації вона буде чітко позначена як застаріла: + + + +Подивіться, як виглядають застарілі та незастарілі «операції шляху»: + + + +## Підсумок { #recap } + +Ви можете легко налаштовувати та додавати метадані до ваших «операцій шляху», передаючи параметри «декораторам операцій шляху». diff --git a/docs/uk/docs/tutorial/security/first-steps.md b/docs/uk/docs/tutorial/security/first-steps.md new file mode 100644 index 0000000000..491328d865 --- /dev/null +++ b/docs/uk/docs/tutorial/security/first-steps.md @@ -0,0 +1,203 @@ +# Безпека - перші кроки { #security-first-steps } + +Уявімо, що ваш **backend** API працює на певному домені. + +А **frontend** - на іншому домені або в іншому шляху того ж домену (або у мобільному застосунку). + +І ви хочете, щоб frontend міг автентифікуватися в backend, використовуючи ім'я користувача та пароль. + +Ми можемо використати **OAuth2**, щоб збудувати це з **FastAPI**. + +Але заощадимо вам час на читання всієї довгої специфікації, щоб знайти лише потрібні дрібниці. + +Скористаймося інструментами, які надає **FastAPI**, щоб обробляти безпеку. + +## Як це виглядає { #how-it-looks } + +Спочатку просто запустімо код і подивімося, як він працює, а потім повернемося, щоб розібратися, що відбувається. + +## Створіть `main.py` { #create-main-py } + +Скопіюйте приклад у файл `main.py`: + +{* ../../docs_src/security/tutorial001_an_py310.py *} + +## Запустіть { #run-it } + +/// info | Інформація + +Пакет `python-multipart` автоматично встановлюється з **FastAPI**, коли ви виконуєте команду `pip install "fastapi[standard]"`. + +Однак, якщо ви використовуєте команду `pip install fastapi`, пакет `python-multipart` за замовчуванням не включено. + +Щоб встановити його вручну, переконайтеся, що ви створили [віртуальне оточення](../../virtual-environments.md){.internal-link target=_blank}, активували його, а потім встановили: + +```console +$ pip install python-multipart +``` + +Це тому, що **OAuth2** використовує «form data» для надсилання `username` та `password`. + +/// + +Запустіть приклад: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +## Перевірте { #check-it } + +Перейдіть до інтерактивної документації: http://127.0.0.1:8000/docs. + +Ви побачите щось подібне: + + + +/// check | Кнопка Authorize! + +У вас уже є нова блискуча кнопка «Authorize». + +А ваша *операція шляху* має маленький замок у правому верхньому куті, на який можна натиснути. + +/// + +Якщо натиснути її, з’явиться маленька форма авторизації, щоб ввести `username` і `password` (та інші необов’язкові поля): + + + +/// note | Примітка + +Неважливо, що ви введете у форму, поки що це не спрацює. Але ми скоро це доробимо. + +/// + +Звісно, це не frontend для кінцевих користувачів, але це чудовий інструмент для інтерактивної документації всього вашого API. + +Ним може користуватися команда frontend (якою можете бути і ви самі). + +Ним можуть користуватися сторонні застосунки та системи. + +І ним також можете користуватися ви самі, щоб налагоджувати, перевіряти та тестувати той самий застосунок. + +## Потік паролю { #the-password-flow } + +Тепер повернімося трохи назад і розберімося, що це все таке. + +`password` «flow» - це один зі способів («flows»), визначених в OAuth2, для обробки безпеки та автентифікації. + +OAuth2 був спроєктований так, щоб backend або API могли бути незалежними від сервера, який автентифікує користувача. + +Але в нашому випадку той самий застосунок **FastAPI** оброблятиме і API, і автентифікацію. + +Тож розгляньмо це у спрощеному вигляді: + +- Користувач вводить `username` і `password` у frontend і натискає `Enter`. +- Frontend (у браузері користувача) надсилає ці `username` і `password` на специфічну URL-адресу нашого API (оголошену як `tokenUrl="token"`). +- API перевіряє ці `username` і `password` та повертає «токен» (ми ще нічого з цього не реалізували). + - «Токен» - це просто строка з деяким вмістом, який ми можемо пізніше використати, щоб перевірити цього користувача. + - Зазвичай токен налаштований на завершення строку дії через певний час. + - Тож користувачу доведеться знову увійти пізніше. + - І якщо токен викрадуть, ризик менший. Це не як постійний ключ, який працюватиме завжди (у більшості випадків). +- Frontend тимчасово зберігає цей токен десь. +- Користувач клікає у frontend, щоб перейти до іншого розділу вебзастосунку. +- Frontend має отримати ще дані з API. + - Але для того конкретного кінцевого пункту потрібна автентифікація. + - Тож, щоб автентифікуватися в нашому API, він надсилає заголовок `Authorization` зі значенням `Bearer ` плюс токен. + - Якщо токен містить `foobar`, вміст заголовка `Authorization` буде: `Bearer foobar`. + +## `OAuth2PasswordBearer` у **FastAPI** { #fastapis-oauth2passwordbearer } + +**FastAPI** надає кілька інструментів на різних рівнях абстракції, щоб реалізувати ці функції безпеки. + +У цьому прикладі ми використаємо **OAuth2** з потоком **Password**, використовуючи токен **Bearer**. Це робиться за допомогою класу `OAuth2PasswordBearer`. + +/// info | Інформація + +«Bearer»-токен - не єдиний варіант. + +Але це найкращий для нашого сценарію. + +І, можливо, найкращий для більшості сценаріїв, якщо ви не експерт з OAuth2 і точно не знаєте, чому інша опція краще відповідає вашим потребам. + +У такому разі **FastAPI** теж надає інструменти, щоб це збудувати. + +/// + +Коли ми створюємо екземпляр класу `OAuth2PasswordBearer`, ми передаємо параметр `tokenUrl`. Цей параметр містить URL, який клієнт (frontend у браузері користувача) використовуватиме, щоб надіслати `username` і `password` для отримання токена. + +{* ../../docs_src/security/tutorial001_an_py310.py hl[8] *} + +/// tip | Порада + +Тут `tokenUrl="token"` відноситься до відносної URL-адреси `token`, яку ми ще не створили. Оскільки це відносна URL-адреса, вона еквівалентна `./token`. + +Тому, якщо ваш API розміщений на `https://example.com/`, це буде `https://example.com/token`. А якщо на `https://example.com/api/v1/`, тоді це буде `https://example.com/api/v1/token`. + +Використання відносної URL-адреси важливе, щоб ваша програма продовжувала працювати навіть у просунутому сценарії, як-от [Behind a Proxy](../../advanced/behind-a-proxy.md){.internal-link target=_blank}. + +/// + +Цей параметр не створює той endpoint / *операцію шляху*, а декларує, що URL `/token` буде тим, який клієнт має використовувати, щоб отримати токен. Ця інформація використовується в OpenAPI, а потім - у системах інтерактивної документації API. + +Незабаром ми також створимо фактичну операцію шляху. + +/// info | Інформація + +Якщо ви дуже строгий «Pythonista», вам може не подобатися стиль імені параметра `tokenUrl` замість `token_url`. + +Це тому, що використано ту саму назву, що і в специфікації OpenAPI. Тож якщо вам потрібно буде дослідити ці схеми безпеки глибше, ви зможете просто скопіювати та вставити її, щоб знайти більше інформації. + +/// + +Змінна `oauth2_scheme` - це екземпляр `OAuth2PasswordBearer`, але це також і «викликаємий» об’єкт. + +Його можна викликати так: + +```Python +oauth2_scheme(some, parameters) +``` + +Тож його можна використовувати з `Depends`. + +### Використання { #use-it } + +Тепер ви можете передати `oauth2_scheme` як залежність через `Depends`. + +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} + +Ця залежність надасть `str`, який буде присвоєний параметру `token` *функції операції шляху*. + +**FastAPI** знатиме, що може використати цю залежність, щоб визначити «схему безпеки» в схемі OpenAPI (і в автоматичній документації API). + +/// info | Технічні деталі + +**FastAPI** знатиме, що може використати клас `OAuth2PasswordBearer` (оголошений у залежності), щоб визначити схему безпеки в OpenAPI, тому що він наслідує `fastapi.security.oauth2.OAuth2`, який своєю чергою наслідує `fastapi.security.base.SecurityBase`. + +Усі утиліти безпеки, які інтегруються з OpenAPI (і автоматичною документацією API), наслідують `SecurityBase`. Так **FastAPI** розуміє, як інтегрувати їх в OpenAPI. + +/// + +## Що відбувається { #what-it-does } + +Вона шукатиме в запиті заголовок `Authorization`, перевірить, чи його значення - це `Bearer ` плюс деякий токен, і поверне токен як `str`. + +Якщо заголовка `Authorization` немає або значення не містить токена `Bearer `, вона одразу відповість помилкою зі статус-кодом 401 (`UNAUTHORIZED`). + +Вам навіть не потрібно перевіряти, чи існує токен, щоб повернути помилку. Ви можете бути певні: якщо ваша функція виконується, у параметрі токена буде `str`. + +Ви вже можете спробувати це в інтерактивній документації: + + + +Ми ще не перевіряємо дійсність токена, але це вже початок. + +## Підсумок { #recap } + +Отже, лише 3-4 додатковими рядками ви вже маєте деяку примітивну форму безпеки. diff --git a/docs/uk/docs/tutorial/security/get-current-user.md b/docs/uk/docs/tutorial/security/get-current-user.md new file mode 100644 index 0000000000..2371ad9fc0 --- /dev/null +++ b/docs/uk/docs/tutorial/security/get-current-user.md @@ -0,0 +1,105 @@ +# Отримати поточного користувача { #get-current-user } + +У попередньому розділі система безпеки (яка базується на системі впровадження залежностей) передавала функції операції шляху `token` як `str`: + +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} + +Але це ще не дуже корисно. + +Зробімо так, щоб вона повертала поточного користувача. + +## Створити модель користувача { #create-a-user-model } + +Спочатку створімо модель користувача в Pydantic. + +Так само, як ми використовуємо Pydantic для оголошення тіл, ми можемо використовувати його будь-де: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[5,12:6] *} + +## Створити залежність `get_current_user` { #create-a-get-current-user-dependency } + +Створімо залежність `get_current_user`. + +Пам'ятаєте, що залежності можуть мати підзалежності? + +`get_current_user` матиме залежність із тим самим `oauth2_scheme`, який ми створили раніше. + +Так само, як ми робили раніше безпосередньо в операції шляху, наша нова залежність `get_current_user` отримає `token` як `str` від підзалежності `oauth2_scheme`: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[25] *} + +## Отримати користувача { #get-the-user } + +`get_current_user` використає (фальшиву) утилітну функцію, яку ми створили, що приймає `token` як `str` і повертає нашу Pydantic-модель `User`: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[19:22,26:27] *} + +## Впровадити поточного користувача { #inject-the-current-user } + +Тепер ми можемо використати той самий `Depends` з нашим `get_current_user` в операції шляху: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[31] *} + +Зверніть увагу, що ми оголошуємо тип `current_user` як Pydantic-модель `User`. + +Це допоможе всередині функції з автодоповненням і перевірками типів. + +/// tip | Порада + +Можливо, ви пам'ятаєте, що тіла запиту також оголошуються моделями Pydantic. + +Тут **FastAPI** не заплутається, тому що ви використовуєте `Depends`. + +/// + +/// check | Перевірте + +Те, як спроєктована ця система залежностей, дозволяє мати різні залежності (різні «залежні»), які всі повертають модель `User`. + +Ми не обмежені наявністю лише однієї залежності, що може повертати такі дані. + +/// + +## Інші моделі { #other-models } + +Тепер ви можете отримувати поточного користувача безпосередньо у функціях операцій шляху та працювати з механізмами безпеки на рівні **впровадження залежностей**, використовуючи `Depends`. + +І ви можете використовувати будь-яку модель або дані для вимог безпеки (у цьому випадку Pydantic-модель `User`). + +Але ви не обмежені використанням якоїсь конкретної модели даних, класу чи типу. + +Хочете мати id та email і не мати жодного username у вашій моделі? Без проблем. Ви можете використовувати ті самі інструменти. + +Хочете мати просто `str`? Або лише `dict`? Або безпосередньо екземпляр класу моделі бази даних? Усе працює так само. + +У вашій програмі насправді входять не користувачі, а роботи, боти чи інші системи, що мають лише токен доступу? Знову ж, усе працює так само. + +Просто використовуйте будь-який тип моделі, будь-який клас, будь-яку базу даних, які потрібні вашій програмі. **FastAPI** подбає про це завдяки системі впровадження залежностей. + +## Розмір коду { #code-size } + +Цей приклад може здаватися багатослівним. Майте на увазі, що ми змішуємо безпеку, моделі даних, утилітні функції та операції шляху в одному файлі. + +Але ось ключовий момент. + +Речі, пов'язані з безпекою та впровадженням залежностей, пишуться один раз. + +І ви можете зробити це настільки складним, наскільки потрібно. І все одно мати це написаним лише один раз, в одному місці. З усією гнучкістю. + +Зате ви можете мати тисячі кінцевих точок (операцій шляху), що використовують одну й ту саму систему безпеки. + +І всі вони (або будь-яка їхня частина, яку ви захочете) можуть скористатися повторним використанням цих залежностей або будь-яких інших, які ви створите. + +І всі ці тисячі операцій шляху можуть бути всього у 3 рядки: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[30:32] *} + +## Підсумок { #recap } + +Тепер ви можете отримувати поточного користувача безпосередньо у вашій функції операції шляху. + +Ми вже на півдорозі. + +Потрібно лише додати операцію шляху, щоб користувач/клієнт міг фактично надіслати `username` і `password`. + +Далі саме це. diff --git a/docs/uk/docs/tutorial/security/oauth2-jwt.md b/docs/uk/docs/tutorial/security/oauth2-jwt.md new file mode 100644 index 0000000000..f94abb897b --- /dev/null +++ b/docs/uk/docs/tutorial/security/oauth2-jwt.md @@ -0,0 +1,277 @@ +# OAuth2 з паролем (і хешуванням), Bearer з токенами JWT { #oauth2-with-password-and-hashing-bearer-with-jwt-tokens } + +Тепер, коли ми маємо весь потік безпеки, зробімо застосунок справді захищеним, використовуючи токени JWT і безпечне хешування паролів. + +Цей код ви можете реально використовувати у своєму застосунку, зберігати хеші паролів у своїй базі даних тощо. + +Ми почнемо з того місця, де зупинилися в попередньому розділі, і розширимо його. + +## Про JWT { #about-jwt } + +JWT означає «JSON Web Tokens». + +Це стандарт кодування об'єкта JSON у довгий щільний рядок без пробілів. Він виглядає так: + +``` +eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c +``` + +Він не зашифрований, тому кожен може відновити інформацію з вмісту. + +Але він підписаний. Тож коли ви отримуєте токен, який ви видали, ви можете перевірити, що справді його видали ви. + +Таким чином, ви можете створити токен із терміном дії, наприклад, 1 тиждень. І коли користувач повернеться наступного дня з токеном, ви знатимете, що користувач досі увійшов у вашу систему. + +Через тиждень токен завершить термін дії, і користувач не буде авторизований та має знову увійти, щоб отримати новий токен. І якщо користувач (або третя сторона) намагатиметься змінити токен, щоб змінити термін дії, ви це виявите, бо підписи не співпадатимуть. + +Якщо хочете «погратися» з токенами JWT і побачити, як вони працюють, перегляньте https://jwt.io. + +## Встановіть `PyJWT` { #install-pyjwt } + +Нам потрібно встановити `PyJWT`, щоб створювати та перевіряти токени JWT у Python. + +Переконайтеся, що ви створили [віртуальне оточення](../../virtual-environments.md){.internal-link target=_blank}, активували його і тоді встановіть `pyjwt`: + +
+ +```console +$ pip install pyjwt + +---> 100% +``` + +
+ +/// info | Інформація + +Якщо ви плануєте використовувати алгоритми цифрового підпису на кшталт RSA або ECDSA, слід встановити залежність криптобібліотеки `pyjwt[crypto]`. + +Докладніше про це можна прочитати у документації з встановлення PyJWT. + +/// + +## Хешування паролів { #password-hashing } + +«Хешування» означає перетворення деякого вмісту (у цьому випадку пароля) на послідовність байтів (просто строку), що виглядає як нісенітниця. + +Кожного разу, коли ви передаєте точно той самий вміст (точно той самий пароль), ви отримуєте точно ту саму «нісенітницю». + +Але не можна перетворити цю «нісенітницю» назад у пароль. + +### Навіщо використовувати хешування паролів { #why-use-password-hashing } + +Якщо вашу базу даних вкрадуть, зловмисник не матиме відкритих паролів ваших користувачів, а лише хеші. + +Тож зловмисник не зможе спробувати використати цей пароль в іншій системі (оскільки багато користувачів використовують той самий пароль всюди, це було б небезпечно). + +## Встановіть `pwdlib` { #install-pwdlib } + +pwdlib - це чудовий пакет Python для роботи з хешами паролів. + +Він підтримує багато безпечних алгоритмів хешування та утиліт для роботи з ними. + +Рекомендований алгоритм - «Argon2». + +Переконайтеся, що ви створили [віртуальне оточення](../../virtual-environments.md){.internal-link target=_blank}, активували його і тоді встановіть pwdlib з Argon2: + +
+ +```console +$ pip install "pwdlib[argon2]" + +---> 100% +``` + +
+ +/// tip | Порада + +З `pwdlib` ви навіть можете налаштувати його так, щоб він умів читати паролі, створені **Django**, плагіном безпеки **Flask** або багатьма іншими. + +Тож ви зможете, наприклад, спільно використовувати ті самі дані з застосунку Django в базі даних із застосунком FastAPI. Або поступово мігрувати застосунок Django, використовуючи ту саму базу даних. + +І ваші користувачі зможуть входити як із вашого застосунку Django, так і з вашого застосунку **FastAPI** одночасно. + +/// + +## Хешування і перевірка паролів { #hash-and-verify-the-passwords } + +Імпортуйте потрібні інструменти з `pwdlib`. + +Створіть екземпляр PasswordHash з рекомендованими налаштуваннями - він буде використаний для хешування та перевірки паролів. + +/// tip | Порада + +pwdlib також підтримує алгоритм хешування bcrypt, але не включає застарілі алгоритми - для роботи із застарілими хешами рекомендується використовувати бібліотеку passlib. + +Наприклад, ви можете використати її для читання і перевірки паролів, згенерованих іншою системою (наприклад, Django), але хешувати будь-які нові паролі іншим алгоритмом, таким як Argon2 або Bcrypt. + +І бути сумісними з усіма ними одночасно. + +/// + +Створіть утилітарну функцію для хешування пароля, що надходить від користувача. + +І ще одну утиліту для перевірки, чи отриманий пароль відповідає збереженому хешу. + +І ще одну - для автентифікації та повернення користувача. + +{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,51,58:59,62:63,72:79] *} + +Коли `authenticate_user` викликається з ім'ям користувача, якого немає в базі даних, ми все одно запускаємо `verify_password` для «підставного» хешу. + +Це забезпечує приблизно однаковий час відповіді кінцевої точки незалежно від того, чи є ім'я користувача дійсним, запобігаючи **атакам за часом**, які могли б бути використані для перелічення наявних імен користувачів. + +/// note | Примітка + +Якщо ви перевірите нову (фальшиву) базу даних `fake_users_db`, побачите, як зараз виглядає хеш пароля: `"$argon2id$v=19$m=65536,t=3,p=4$wagCPXjifgvUFBzq4hqe3w$CYaIb8sB+wtD+Vu/P4uod1+Qof8h+1g7bbDlBID48Rc"`. + +/// + +## Опрацювання токенів JWT { #handle-jwt-tokens } + +Імпортуйте встановлені модулі. + +Створіть випадковий секретний ключ, який буде використано для підписання токенів JWT. + +Щоб згенерувати безпечний випадковий секретний ключ, використайте команду: + +
+ +```console +$ openssl rand -hex 32 + +09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7 +``` + +
+ +І скопіюйте вивід у змінну `SECRET_KEY` (не використовуйте той, що в прикладі). + +Створіть змінну `ALGORITHM` з алгоритмом для підписання токена JWT і встановіть її в `"HS256"`. + +Створіть змінну для терміну дії токена. + +Визначте модель Pydantic, яка буде використана в кінцевій точці токена для відповіді. + +Створіть утилітарну функцію для генерації нового токена доступу. + +{* ../../docs_src/security/tutorial004_an_py310.py hl[4,7,13:15,29:31,82:90] *} + +## Оновіть залежності { #update-the-dependencies } + +Оновіть `get_current_user`, щоб отримувати той самий токен, що й раніше, але цього разу - токен JWT. + +Декодуйте отриманий токен, перевірте його та поверніть поточного користувача. + +Якщо токен недійсний, одразу поверніть помилку HTTP. + +{* ../../docs_src/security/tutorial004_an_py310.py hl[93:110] *} + +## Оновіть операцію шляху `/token` { #update-the-token-path-operation } + +Створіть `timedelta` з часом життя токена. + +Створіть справжній токен доступу JWT і поверніть його. + +{* ../../docs_src/security/tutorial004_an_py310.py hl[121:136] *} + +### Технічні деталі про «subject» `sub` у JWT { #technical-details-about-the-jwt-subject-sub } + +Специфікація JWT каже, що існує ключ `sub` із суб'єктом токена. + +Використовувати його не обов'язково, але саме туди зазвичай поміщають ідентифікатор користувача, тож ми використовуємо його тут. + +JWT може використовуватися й для інших речей, окрім ідентифікації користувача та надання йому можливості безпосередньо виконувати операції з вашою API. + +Наприклад, ви можете ідентифікувати «автомобіль» або «допис у блозі». + +Тоді ви можете додати дозволи щодо цієї сутності, як-от «керувати» (для автомобіля) або «редагувати» (для допису). + +І потім ви можете видати цей токен JWT користувачу (або боту), і він зможе виконувати ці дії (керувати автомобілем або редагувати допис), навіть не маючи облікового запису - лише з токеном JWT, який ваша API для цього згенерувала. + +Використовуючи ці ідеї, JWT можна застосовувати у значно складніших сценаріях. + +У таких випадках кілька сутностей можуть мати однакові ідентифікатори, скажімо `foo` (користувач `foo`, автомобіль `foo` і допис `foo`). + +Щоб уникнути колізій ідентифікаторів, під час створення токена JWT для користувача ви можете додати префікс до значення ключа `sub`, наприклад `username:`. Отже, у цьому прикладі значення `sub` могло б бути: `username:johndoe`. + +Важливо пам'ятати, що ключ `sub` має містити унікальний ідентифікатор у межах усього застосунку і має бути строкою. + +## Перевірте { #check-it } + +Запустіть сервер і перейдіть до документації: http://127.0.0.1:8000/docs. + +Ви побачите такий інтерфейс користувача: + + + +Авторизуйте застосунок так само, як раніше. + +Використайте облікові дані: + +Username: `johndoe` +Password: `secret` + +/// check | Перевірте + +Зверніть увагу, що ніде в коді немає відкритого пароля "`secret`", ми маємо лише хешовану версію. + +/// + + + +Викличте кінцеву точку `/users/me/`, ви отримаєте відповідь: + +```JSON +{ + "username": "johndoe", + "email": "johndoe@example.com", + "full_name": "John Doe", + "disabled": false +} +``` + + + +Якщо відкриєте інструменти розробника, ви побачите, що у відправлених даних є лише токен, пароль надсилається тільки в першому запиті для автентифікації користувача та отримання токена доступу, але не надсилається далі: + + + +/// note | Примітка + +Зверніть увагу на заголовок `Authorization` зі значенням, що починається з `Bearer `. + +/// + +## Просунуте використання зі `scopes` { #advanced-usage-with-scopes } + +OAuth2 має поняття «scopes». + +Ви можете використовувати їх, щоб додати конкретний набір дозволів до токена JWT. + +Потім ви можете видати цей токен користувачу напряму або третій стороні для взаємодії з вашою API із набором обмежень. + +Ви можете дізнатися, як їх використовувати і як вони інтегровані з **FastAPI** пізніше у **просунутому посібнику користувача**. + +## Підсумок { #recap } + +Маючи все, що ви бачили досі, ви можете налаштувати захищений застосунок **FastAPI**, використовуючи стандарти на кшталт OAuth2 і JWT. + +Майже в будь-якому фреймворку опрацювання безпеки дуже швидко стає досить складною темою. + +Багато пакетів, що сильно це спрощують, змушені йти на численні компроміси з моделлю даних, базою даних і доступними можливостями. Дехто з цих пакетів, які надто все спрощують, насправді мають приховані вади безпеки. + +--- + +**FastAPI** не йде на жодні компроміси з будь-якою базою даних, моделлю даних чи інструментом. + +Він дає вам усю гнучкість, щоб обрати ті, які найкраще підходять вашому проєкту. + +І ви можете напряму використовувати добре підтримувані та широко застосовувані пакети на кшталт `pwdlib` і `PyJWT`, адже **FastAPI** не вимагає жодних складних механізмів для інтеграції зовнішніх пакетів. + +Водночас він надає інструменти, щоб максимально спростити процес без компромісів у гнучкості, надійності чи безпеці. + +І ви можете використовувати та впроваджувати безпечні стандартні протоколи, як-от OAuth2, відносно простим способом. + +У **просунутому посібнику користувача** ви можете дізнатися більше про те, як використовувати «scopes» в OAuth2 для більш детальної системи дозволів, дотримуючись тих самих стандартів. OAuth2 зі scopes - це механізм, який використовують багато великих провайдерів автентифікації, як-от Facebook, Google, GitHub, Microsoft, X (Twitter) тощо, щоб авторизувати сторонні застосунки на взаємодію з їхніми API від імені користувачів. diff --git a/docs/uk/docs/tutorial/security/simple-oauth2.md b/docs/uk/docs/tutorial/security/simple-oauth2.md new file mode 100644 index 0000000000..05f949738d --- /dev/null +++ b/docs/uk/docs/tutorial/security/simple-oauth2.md @@ -0,0 +1,289 @@ +# Простий OAuth2 з паролем і Bearer { #simple-oauth2-with-password-and-bearer } + +Тепер продовжимо з попереднього розділу і додамо відсутні частини, щоб отримати повний потік безпеки. + +## Отримайте `username` і `password` { #get-the-username-and-password } + +Ми використаємо утиліти безпеки **FastAPI**, щоб отримати `username` і `password`. + +OAuth2 визначає, що під час використання «потоку паролю» (який ми використовуємо) клієнт/користувач має надіслати поля `username` і `password` як дані форми. + +І специфікація каже, що поля мають називатися саме так. Тому `user-name` або `email` не підійдуть. + +Але не хвилюйтеся, у фронтенді ви можете відображати це так, як забажаєте, для кінцевих користувачів. + +І ваші моделі бази даних можуть використовувати будь-які інші назви. + +Але для *операції шляху* входу ми маємо використовувати саме ці назви, щоб бути сумісними зі специфікацією (і мати змогу, наприклад, користуватися вбудованою системою документації API). + +Специфікація також вказує, що `username` і `password` мають надсилатися як дані форми (тобто без JSON). + +### `scope` { #scope } + +Специфікація також каже, що клієнт може надіслати інше поле форми «`scope`». + +Назва поля форми — `scope` (в однині), але насправді це довга строка зі «scopes», розділеними пробілами. + +Кожен «scope» — це просто строка (без пробілів). + +Їх зазвичай використовують для оголошення конкретних прав доступу, наприклад: + +- `users:read` або `users:write` — поширені приклади. +- `instagram_basic` використовується Facebook / Instagram. +- `https://www.googleapis.com/auth/drive` використовується Google. + +/// info | Інформація + +У OAuth2 «scope» — це просто строка, що оголошує конкретний потрібний дозвіл. + +Не має значення, чи містить вона інші символи на кшталт `:` або чи це URL. + +Ці деталі залежать від реалізації. + +Для OAuth2 це просто строки. + +/// + +## Код для отримання `username` і `password` { #code-to-get-the-username-and-password } + +Тепер скористаймося утилітами, наданими **FastAPI**, щоб обробити це. + +### `OAuth2PasswordRequestForm` { #oauth2passwordrequestform } + +Спочатку імпортуйте `OAuth2PasswordRequestForm` і використайте його як залежність із `Depends` в *операції шляху* для `/token`: + +{* ../../docs_src/security/tutorial003_an_py310.py hl[4,78] *} + +`OAuth2PasswordRequestForm` — це клас залежності, що оголошує тіло форми з: + +- `username`. +- `password`. +- Необов'язковим полем `scope` як великою строкою, складеною зі строк, розділених пробілами. +- Необов'язковим `grant_type`. + +/// tip | Порада + +Специфікація OAuth2 насправді вимагає поле `grant_type` із фіксованим значенням `password`, але `OAuth2PasswordRequestForm` цього не примушує. + +Якщо вам потрібно це примусити, використовуйте `OAuth2PasswordRequestFormStrict` замість `OAuth2PasswordRequestForm`. + +/// + +- Необов'язковим `client_id` (для нашого прикладу не потрібно). +- Необов'язковим `client_secret` (для нашого прикладу не потрібно). + +/// info | Інформація + +`OAuth2PasswordRequestForm` — не спеціальний клас для **FastAPI**, як `OAuth2PasswordBearer`. + +`OAuth2PasswordBearer` робить так, що **FastAPI** знає, що це схема безпеки. Тому її додають таким чином до OpenAPI. + +Але `OAuth2PasswordRequestForm` — це просто клас залежності, який ви могли б написати самі, або ви могли б напряму оголосити параметри `Form`. + +Оскільки це типова задача, **FastAPI** надає його безпосередньо, щоб спростити роботу. + +/// + +### Використовуйте дані форми { #use-the-form-data } + +/// tip | Порада + +Екземпляр класу залежності `OAuth2PasswordRequestForm` не матиме атрибута `scope` з довгою строкою, розділеною пробілами, натомість він матиме атрибут `scopes` зі справжнім списком строк для кожного надісланого scope. + +У цьому прикладі ми не використовуємо `scopes`, але ця можливість є, якщо знадобиться. + +/// + +Тепер отримайте дані користувача з (фальшивої) бази даних, використовуючи `username` з поля форми. + +Якщо такого користувача немає, повертаємо помилку «Incorrect username or password». + +Для помилки використовуємо виняток `HTTPException`: + +{* ../../docs_src/security/tutorial003_an_py310.py hl[3,79:81] *} + +### Перевірте пароль { #check-the-password } + +На цьому етапі ми маємо дані користувача з нашої бази даних, але ще не перевірили пароль. + +Спершу розмістимо ці дані в Pydantic-моделі `UserInDB`. + +Ви ніколи не повинні зберігати паролі у відкритому вигляді, тож ми використаємо (фальшиву) систему хешування паролів. + +Якщо паролі не збігаються, повертаємо ту саму помилку. + +#### Хешування паролів { #password-hashing } + +«Хешування» означає: перетворення деякого вмісту (у цьому випадку пароля) у послідовність байтів (просто строку), яка виглядає як нісенітниця. + +Кожного разу, коли ви передаєте точно той самий вміст (точно той самий пароль), ви отримуєте точно ту саму «нісенітницю». + +Але ви не можете перетворити цю «нісенітницю» назад у пароль. + +##### Навіщо використовувати хешування паролів { #why-use-password-hashing } + +Якщо вашу базу даних вкрадуть, зловмисник не матиме паролів користувачів у відкритому вигляді, лише хеші. + +Тож зловмисник не зможе спробувати використати ті самі паролі в іншій системі (оскільки багато користувачів використовують той самий пароль всюди, це було б небезпечно). + +{* ../../docs_src/security/tutorial003_an_py310.py hl[82:85] *} + +#### Про `**user_dict` { #about-user-dict } + +`UserInDB(**user_dict)` означає: + +Передати ключі та значення з `user_dict` безпосередньо як аргументи ключ-значення, еквівалентно до: + +```Python +UserInDB( + username = user_dict["username"], + email = user_dict["email"], + full_name = user_dict["full_name"], + disabled = user_dict["disabled"], + hashed_password = user_dict["hashed_password"], +) +``` + +/// info | Інформація + +Для повнішого пояснення `**user_dict` перегляньте [документацію для **Додаткових моделей**](../extra-models.md#about-user-in-dict){.internal-link target=_blank}. + +/// + +## Поверніть токен { #return-the-token } + +Відповідь точки входу `token` має бути об'єктом JSON. + +Вона повинна містити `token_type`. У нашому випадку, оскільки ми використовуємо токени «Bearer», тип токена має бути «`bearer`». + +Також має бути `access_token` зі строкою, що містить наш токен доступу. + +Для цього простого прикладу ми зробимо повністю небезпечно і повернемо той самий `username` як токен. + +/// tip | Порада + +У наступному розділі ви побачите справді безпечну реалізацію з хешуванням паролів і токенами JWT. + +А поки зосередьмося на конкретних деталях, які нам потрібні. + +/// + +{* ../../docs_src/security/tutorial003_an_py310.py hl[87] *} + +/// tip | Порада + +Згідно зі специфікацією, ви маєте повертати JSON з `access_token` і `token_type`, як у цьому прикладі. + +Це те, що ви маєте зробити самостійно у своєму коді, і переконатися, що використовуєте саме ці ключі JSON. + +Це майже єдине, що ви маєте зробити правильно самі, щоб відповідати специфікації. + +Решту **FastAPI** зробить за вас. + +/// + +## Оновіть залежності { #update-the-dependencies } + +Тепер оновимо наші залежності. + +Ми хочемо отримати `current_user` лише якщо цей користувач активний. + +Тому створимо додаткову залежність `get_current_active_user`, яка своєю чергою використовує як залежність `get_current_user`. + +Обидві ці залежності просто повернуть HTTP-помилку, якщо користувача не існує або він неактивний. + +Отже, у нашій кінцевій точці ми отримаємо користувача лише якщо він існує, був правильно автентифікований і є активним: + +{* ../../docs_src/security/tutorial003_an_py310.py hl[58:66,69:74,94] *} + +/// info | Інформація + +Додатковий заголовок `WWW-Authenticate` зі значенням `Bearer`, який ми тут повертаємо, також є частиною специфікації. + +Будь-який HTTP (помилка) зі статус-кодом 401 «UNAUTHORIZED» також має повертати заголовок `WWW-Authenticate`. + +У випадку токенів носія (наш випадок) значенням цього заголовка має бути `Bearer`. + +Фактично ви можете пропустити цей додатковий заголовок, і все одно працюватиме. + +Але він наданий тут, щоб відповідати специфікаціям. + +Також можуть існувати інструменти, які очікують і використовують його (зараз або в майбутньому), і це може бути корисно вам або вашим користувачам, зараз або в майбутньому. + +У цьому користь стандартів... + +/// + +## Подивіться в дії { #see-it-in-action } + +Відкрийте інтерактивну документацію: http://127.0.0.1:8000/docs. + +### Автентифікація { #authenticate } + +Натисніть кнопку «Authorize». + +Використайте облікові дані: + +Користувач: `johndoe` + +Пароль: `secret` + + + +Після автентифікації в системі ви побачите таке: + + + +### Отримайте власні дані користувача { #get-your-own-user-data } + +Тепер використайте операцію `GET` зі шляхом `/users/me`. + +Ви отримаєте дані свого користувача, наприклад: + +```JSON +{ + "username": "johndoe", + "email": "johndoe@example.com", + "full_name": "John Doe", + "disabled": false, + "hashed_password": "fakehashedsecret" +} +``` + + + +Якщо натиснути значок замка й вийти з системи, а потім знову спробувати ту саму операцію, ви отримаєте помилку HTTP 401 такого вигляду: + +```JSON +{ + "detail": "Not authenticated" +} +``` + +### Неактивний користувач { #inactive-user } + +Тепер спробуйте з неактивним користувачем, автентифікуйтеся з: + +Користувач: `alice` + +Пароль: `secret2` + +І спробуйте використати операцію `GET` зі шляхом `/users/me`. + +Ви отримаєте помилку «Inactive user», наприклад: + +```JSON +{ + "detail": "Inactive user" +} +``` + +## Підсумок { #recap } + +Тепер у вас є інструменти для реалізації повної системи безпеки на основі `username` і `password` для вашого API. + +Використовуючи ці інструменти, ви можете зробити систему безпеки сумісною з будь-якою базою даних і з будь-якою моделлю користувача чи даних. + +Єдина відсутня деталь у тому, що наразі це ще не «безпечна» реалізація. + +У наступному розділі ви побачите, як використовувати безпечну бібліотеку для хешування паролів і токени JWT. diff --git a/docs/uk/docs/tutorial/sql-databases.md b/docs/uk/docs/tutorial/sql-databases.md new file mode 100644 index 0000000000..991d1e33aa --- /dev/null +++ b/docs/uk/docs/tutorial/sql-databases.md @@ -0,0 +1,357 @@ +# SQL (реляційні) бази даних { #sql-relational-databases } + +**FastAPI** не вимагає від вас використовувати SQL (реляційну) базу даних. Але ви можете скористатися будь-якою базою даних, яку забажаєте. + +Тут ми розглянемо приклад з SQLModel. + +**SQLModel** побудовано поверх SQLAlchemy та Pydantic. Її створив той самий автор, що і **FastAPI**, як ідеальну пару для застосунків FastAPI, яким потрібні **SQL бази даних**. + +/// tip | Порада + +Ви можете використовувати будь-яку іншу бібліотеку для SQL або NoSQL баз (інколи їх називають "ORMs"), FastAPI нічого не нав’язує. 😎 + +/// + +Оскільки SQLModel базується на SQLAlchemy, ви можете легко використовувати будь-яку базу даних, яку підтримує SQLAlchemy (а отже й SQLModel), наприклад: + +* PostgreSQL +* MySQL +* SQLite +* Oracle +* Microsoft SQL Server тощо + +У цьому прикладі ми використаємо **SQLite**, оскільки вона зберігається в одному файлі, а Python має вбудовану підтримку. Тож ви можете скопіювати цей приклад і запустити «як є». + +Пізніше, для вашого продакшн-застосунку, ви можете перейти на сервер бази даних, наприклад **PostgreSQL**. + +/// tip | Порада + +Існує офіційний генератор проєкту з **FastAPI** та **PostgreSQL**, включно з фронтендом та іншими інструментами: https://github.com/fastapi/full-stack-fastapi-template + +/// + +Це дуже простий і короткий навчальний посібник. Якщо ви хочете вивчити бази даних загалом, SQL або більш просунуті можливості, зверніться до документації SQLModel. + +## Встановіть `SQLModel` { #install-sqlmodel } + +Спочатку переконайтеся, що ви створили [віртуальне оточення](../virtual-environments.md){.internal-link target=_blank}, активували його та встановили `sqlmodel`: + +
+ +```console +$ pip install sqlmodel +---> 100% +``` + +
+ +## Створіть застосунок з однією моделлю { #create-the-app-with-a-single-model } + +Спершу створимо найпростішу версію застосунку з однією моделлю **SQLModel**. + +Потім нижче покращимо безпеку і гнучкість за допомогою кількох моделей. 🤓 + +### Створіть моделі { #create-models } + +Імпортуйте `SQLModel` і створіть модель бази даних: + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[1:11] hl[7:11] *} + +Клас `Hero` дуже схожий на модель Pydantic (фактично, під капотом це і є модель Pydantic). + +Є кілька відмінностей: + +* `table=True` каже SQLModel, що це «таблична модель» - вона має представляти **таблицю** в SQL базі даних, а не просто «модель даних» (як будь-який інший звичайний клас Pydantic). + +* `Field(primary_key=True)` каже SQLModel, що `id` - це **первинний ключ** у SQL базі даних (більше про первинні ключі в SQL див. у документації SQLModel). + + Примітка: Ми використовуємо `int | None` для поля первинного ключа, щоб у Python-коді можна було створити об’єкт без `id` (`id=None`), припускаючи, що база даних згенерує його під час збереження. SQLModel розуміє, що `id` надасть база даних, і визначає стовпець як ненульовий `INTEGER` у схемі бази даних. Докладніше див. документацію SQLModel про первинні ключі. + +* `Field(index=True)` каже SQLModel створити **SQL-індекс** для цього стовпця, що дозволить швидше виконувати пошук у базі даних під час читання даних, відфільтрованих за цим стовпцем. + + SQLModel знатиме, що оголошене як `str` стане SQL-стовпцем типу `TEXT` (або `VARCHAR`, залежно від бази). + +### Створіть рушій { #create-an-engine } + +`engine` SQLModel (під капотом це `engine` SQLAlchemy) - це те, що **утримує з’єднання** з базою даних. + +У вас має бути **єдиний об’єкт `engine`** для всього коду, що під’єднується до тієї самої бази. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[14:18] hl[14:15,17:18] *} + +Використання `check_same_thread=False` дозволяє FastAPI використовувати ту саму базу SQLite у різних потоках. Це необхідно, адже **один запит** може використати **понад один потік** (наприклад, у залежностях). + +Не переймайтеся, завдяки структурі коду ми далі забезпечимо **одну сесію SQLModel на запит**, власне цього і прагне `check_same_thread`. + +### Створіть таблиці { #create-the-tables } + +Додамо функцію, яка використовує `SQLModel.metadata.create_all(engine)`, щоб **створити таблиці** для всіх «табличних моделей». + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[21:22] hl[21:22] *} + +### Створіть залежність сесії { #create-a-session-dependency } + +**`Session`** зберігає **об’єкти в пам’яті** та відстежує зміни у даних, а потім **використовує `engine`** для взаємодії з базою даних. + +Ми створимо **залежність** FastAPI з `yield`, яка надаватиме нову `Session` для кожного запиту. Це й гарантує, що ми використовуємо одну сесію на запит. 🤓 + +Далі створимо залежність `Annotated` - `SessionDep`, щоб спростити решту коду, який її використовуватиме. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[25:30] hl[25:27,30] *} + +### Створюйте таблиці під час запуску { #create-database-tables-on-startup } + +Ми створимо таблиці бази під час запуску застосунку. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[32:37] hl[35:37] *} + +Тут ми створюємо таблиці на події запуску застосунку. + +У продакшні ви, ймовірно, використаєте міграційний скрипт, який виконується перед стартом застосунку. 🤓 + +/// tip | Порада + +SQLModel матиме утиліти міграцій-обгортки над Alembic, але поки що ви можете використовувати Alembic напряму. + +/// + +### Створіть героя { #create-a-hero } + +Оскільки кожна модель SQLModel також є моделлю Pydantic, ви можете використовувати її в тих самих **анотаціях типів**, що і моделі Pydantic. + +Наприклад, якщо ви оголосите параметр типу `Hero`, він буде прочитаний з **JSON-тіла**. + +Так само ви можете оголосити її як **тип, що повертається** функції, і форма даних з’явиться в автоматичному UI документації API. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[40:45] hl[40:45] *} + +Тут ми використовуємо залежність `SessionDep` (`Session`), щоб додати нового `Hero` до екземпляра `Session`, закомітити зміни до бази, оновити дані в `hero`, а потім повернути його. + +### Читання героїв { #read-heroes } + +Ми можемо **читати** `Hero` з бази даних, використовуючи `select()`. Ми можемо додати `limit` і `offset` для пагінації результатів. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[48:55] hl[51:52,54] *} + +### Читання одного героя { #read-one-hero } + +Ми можемо **прочитати** одного `Hero`. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[58:63] hl[60] *} + +### Видалення героя { #delete-a-hero } + +Ми також можемо **видалити** `Hero`. + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[66:73] hl[71] *} + +### Запуск застосунку { #run-the-app } + +Ви можете запустити застосунок: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Потім перейдіть до інтерфейсу `/docs`, ви побачите, що **FastAPI** використовує ці **моделі** для **документування** API, а також для **серіалізації** та **валідації** даних. + +
+ +
+ +## Оновіть застосунок кількома моделями { #update-the-app-with-multiple-models } + +Тепер трохи **відрефакторимо** застосунок, щоб підвищити **безпеку** та **гнучкість**. + +Якщо подивитися на попередній варіант, у UI видно, що наразі клієнт може сам обирати `id` для створюваного `Hero`. 😱 + +Цього допускати не можна - вони можуть перезаписати `id`, який уже призначений у БД. Визначення `id` має виконувати **бекенд** або **база даних**, **а не клієнт**. + +Крім того, ми створюємо для героя `secret_name`, але наразі повертаємо його всюди - це не дуже «секретно»... 😅 + +Виправимо це, додавши кілька **додаткових моделей**. Ось де SQLModel засяє. ✨ + +### Створіть кілька моделей { #create-multiple-models } + +У **SQLModel** будь-який клас моделі з `table=True` - це **таблична модель**. + +А будь-який клас моделі без `table=True` - це **модель даних**; це, по суті, просто моделі Pydantic (з парою невеликих доповнень). 🤓 + +З SQLModel ми можемо використовувати **успадкування**, щоб **уникати дублювання** полів у всіх випадках. + +#### `HeroBase` - базовий клас { #herobase-the-base-class } + +Почнімо з моделі `HeroBase`, яка містить усі **спільні поля** для всіх моделей: + +* `name` +* `age` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:9] hl[7:9] *} + +#### `Hero` - «таблична модель» { #hero-the-table-model } + +Потім створімо `Hero`, фактичну «табличну модель», з **додатковими полями**, яких немає в інших моделях завжди: + +* `id` +* `secret_name` + +Оскільки `Hero` успадковується від `HeroBase`, вона **також** містить **поля**, оголошені в `HeroBase`, тож усі поля `Hero` такі: + +* `id` +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:14] hl[12:14] *} + +#### `HeroPublic` - публічна «модель даних» { #heropublic-the-public-data-model } + +Далі створимо модель `HeroPublic` - це та, що буде **повертатися** клієнтам API. + +Вона має ті самі поля, що й `HeroBase`, отже не включатиме `secret_name`. + +Нарешті, особистості наших героїв захищено! 🥷 + +Вона також перевизначає `id: int`. Роблячи це, ми укладаємо **контракт** з клієнтами API, що `id` завжди буде присутній і буде типу `int` (ніколи не `None`). + +/// tip | Порада + +Наявність у моделі відповіді гарантії, що значення завжди доступне і завжди `int` (не `None`), дуже корисна для клієнтів API - вони можуть писати значно простіший код, маючи цю визначеність. + +Також **автоматично згенеровані клієнти** матимуть простіші інтерфейси, тож розробникам, які взаємодіють з вашим API, буде значно зручніше. 😎 + +/// + +Усі поля в `HeroPublic` такі самі, як у `HeroBase`, з `id`, оголошеним як `int` (не `None`): + +* `id` +* `name` +* `age` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:18] hl[17:18] *} + +#### `HeroCreate` - «модель даних» для створення героя { #herocreate-the-data-model-to-create-a-hero } + +Тепер створимо модель `HeroCreate` - вона **валідуватиме** дані, отримані від клієнтів. + +Вона має ті ж поля, що й `HeroBase`, а також `secret_name`. + +Тепер, коли клієнти **створюють нового героя**, вони надсилають `secret_name`, він зберігається в базі даних, але ці секретні імена не повертаються клієнтам у API. + +/// tip | Порада + +Так слід поводитися з **паролями**. Приймайте їх, але не повертайте в API. + +Також потрібно **хешувати** значення паролів перед збереженням, **ніколи не зберігайте їх у відкритому вигляді**. + +/// + +Поля `HeroCreate`: + +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:22] hl[21:22] *} + +#### `HeroUpdate` - «модель даних» для оновлення героя { #heroupdate-the-data-model-to-update-a-hero } + +У попередній версії у нас не було способу **оновлювати героя**, але тепер, маючи **кілька моделей**, ми можемо це зробити. 🎉 + +«Модель даних» `HeroUpdate` дещо особлива: вона має **всі ті самі поля**, що й для створення нового героя, але всі поля **необов’язкові** (усі мають значення за замовчуванням). Таким чином, під час оновлення героя ви можете надіслати лише ті поля, які хочете змінити. + +Оскільки **поля фактично змінюються** (тип тепер включає `None` і значення за замовчуванням - `None`), нам потрібно **оголосити їх заново**. + +Насправді немає потреби успадковуватися від `HeroBase`, бо ми перевизначаємо всі поля. Я залишу успадкування для послідовності, але це не обов’язково. Це радше питання смаку. 🤷 + +Поля `HeroUpdate`: + +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:28] hl[25:28] *} + +### Створення з `HeroCreate` і повернення `HeroPublic` { #create-with-herocreate-and-return-a-heropublic } + +Тепер, коли в нас **кілька моделей**, ми можемо оновити частини застосунку, що їх використовують. + +У запиті ми отримуємо «модель даних» `HeroCreate`, і з неї створюємо «табличну модель» `Hero`. + +Ця нова «таблична модель» `Hero` міститиме поля, надіслані клієнтом, а також матиме `id`, згенерований базою даних. + +Далі ми повертаємо з функції цю ж «табличну модель» `Hero`. Але оскільки ми оголошуємо `response_model` як «модель даних» `HeroPublic`, **FastAPI** використає `HeroPublic` для валідації та серіалізації даних. + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[56:62] hl[56:58] *} + +/// tip | Порада + +Тепер ми використовуємо `response_model=HeroPublic` замість **анотації типу, що повертається** `-> HeroPublic`, тому що значення, яке ми повертаємо, насправді - не `HeroPublic`. + +Якби ми оголосили `-> HeroPublic`, ваш редактор і лінтер справедливо зауважили б, що ви повертаєте `Hero`, а не `HeroPublic`. + +Оголошуючи це в `response_model`, ми кажемо **FastAPI** зробити свою справу, не втручаючись в анотації типів та підказки від вашого редактора й інших інструментів. + +/// + +### Читання героїв з `HeroPublic` { #read-heroes-with-heropublic } + +Можемо зробити те саме, що й раніше, щоб **читати** `Hero`, знову використовуємо `response_model=list[HeroPublic]`, щоб гарантувати коректну валідацію та серіалізацію даних. + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[65:72] hl[65] *} + +### Читання одного героя з `HeroPublic` { #read-one-hero-with-heropublic } + +Ми можемо **прочитати** одного героя: + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[75:80] hl[77] *} + +### Оновлення героя з `HeroUpdate` { #update-a-hero-with-heroupdate } + +Ми можемо **оновити героя**. Для цього використовуємо HTTP-операцію `PATCH`. + +У коді ми отримуємо `dict` з усіма даними, які надіслав клієнт, - лише з тими даними, які надіслав клієнт, виключаючи будь-які значення, присутні лише як значення за замовчуванням. Для цього використовуємо `exclude_unset=True`. Це головний трюк. 🪄 + +Потім використовуємо `hero_db.sqlmodel_update(hero_data)`, щоб оновити `hero_db` даними з `hero_data`. + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[83:93] hl[83:84,88:89] *} + +### Знову видалення героя { #delete-a-hero-again } + +**Видалення** героя майже не змінилося. + +Ми не задовольнимо бажання відрефакторити все в цьому місці. 😅 + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[96:103] hl[101] *} + +### Знову запустіть застосунок { #run-the-app-again } + +Ви можете знову запустити застосунок: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +Якщо ви перейдете до UI `/docs`, побачите, що він оновився і більше не очікуватиме отримати `id` від клієнта під час створення героя тощо. + +
+ +
+ +## Підсумок { #recap } + +Ви можете використовувати **SQLModel** для взаємодії з SQL базою даних і спростити код за допомогою «моделей даних» та «табличних моделей». + +Багато чого ще можна дізнатися в документації **SQLModel**, там є розширений міні-навчальний посібник з використання SQLModel з **FastAPI**. 🚀 diff --git a/docs/uk/docs/virtual-environments.md b/docs/uk/docs/virtual-environments.md new file mode 100644 index 0000000000..78e7ab32f5 --- /dev/null +++ b/docs/uk/docs/virtual-environments.md @@ -0,0 +1,862 @@ +# Віртуальні середовища { #virtual-environments } + +Коли ви працюєте над проєктами Python, вам, імовірно, слід використовувати віртуальне середовище (або схожий механізм), щоб ізолювати пакети, які ви встановлюєте для кожного проєкту. + +/// info | Інформація + +Якщо ви вже знаєте про віртуальні середовища, як їх створювати та використовувати, можете пропустити цей розділ. 🤓 + +/// + +/// tip | Порада + +Віртуальне середовище відрізняється від змінної оточення. + +Змінна оточення - це змінна в системі, яку можуть використовувати програми. + +Віртуальне середовище - це каталог із файлами в ньому. + +/// + +/// info | Інформація + +На цій сторінці ви дізнаєтеся, як використовувати віртуальні середовища і як вони працюють. + +Якщо ви готові прийняти інструмент, що керує всім за вас (включно з установленням Python), спробуйте uv. + +/// + +## Створіть проєкт { #create-a-project } + +Спочатку створіть каталог для вашого проєкту. + +Зазвичай я створюю каталог з назвою `code` у моєму домашньому каталозі користувача. + +І всередині нього я створюю окремий каталог на кожен проєкт. + +
+ +```console +// Перейдіть до домашнього каталогу +$ cd +// Створіть каталог для всіх ваших проєктів з кодом +$ mkdir code +// Перейдіть у цей каталог code +$ cd code +// Створіть каталог для цього проєкту +$ mkdir awesome-project +// Перейдіть до каталогу цього проєкту +$ cd awesome-project +``` + +
+ +## Створіть віртуальне середовище { #create-a-virtual-environment } + +Коли ви починаєте працювати над проєктом Python уперше, створіть віртуальне середовище у вашому проєкті **у вашому проєкті**. + +/// tip | Порада + +Це потрібно робити лише один раз на проєкт, не щоразу, коли ви працюєте. + +/// + +//// tab | `venv` + +Щоб створити віртуальне середовище, ви можете використати модуль `venv`, який постачається разом із Python. + +
+ +```console +$ python -m venv .venv +``` + +
+ +/// details | Що означає ця команда + +* `python`: використати програму з назвою `python` +* `-m`: викликати модуль як скрипт, далі ми вкажемо, який модуль +* `venv`: використати модуль з назвою `venv`, який зазвичай уже встановлено з Python +* `.venv`: створити віртуальне середовище в новому каталозі `.venv` + +/// + +//// + +//// tab | `uv` + +Якщо у вас встановлено `uv`, ви можете використати його для створення віртуального середовища. + +
+ +```console +$ uv venv +``` + +
+ +/// tip | Порада + +Типово `uv` створить віртуальне середовище в каталозі з назвою `.venv`. + +Але ви можете налаштувати це, передавши додатковий аргумент з назвою каталогу. + +/// + +//// + +Ця команда створює нове віртуальне середовище в каталозі з назвою `.venv`. + +/// details | `.venv` або інша назва + +Ви можете створити віртуальне середовище в іншому каталозі, але існує усталена домовленість називати його `.venv`. + +/// + +## Активуйте віртуальне середовище { #activate-the-virtual-environment } + +Активуйте нове віртуальне середовище, щоб будь-яка команда Python, яку ви запускаєте, або пакет, який ви встановлюєте, використовували його. + +/// tip | Порада + +Робіть це щоразу, коли ви починаєте нову сесію термінала для роботи над проєктом. + +/// + +//// tab | Linux, macOS + +
+ +```console +$ source .venv/bin/activate +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +$ .venv\Scripts\Activate.ps1 +``` + +
+ +//// + +//// tab | Windows Bash + +Або якщо ви використовуєте Bash для Windows (напр., Git Bash): + +
+ +```console +$ source .venv/Scripts/activate +``` + +
+ +//// + +/// tip | Порада + +Кожного разу, коли ви встановлюєте новий пакет у це середовище, активуйте середовище знову. + +Це гарантує, що якщо ви використовуєте програму термінала (CLI), встановлену цим пакетом, ви використовуєте саме ту з вашого віртуального середовища, а не будь-яку іншу, яка може бути встановлена глобально, імовірно з іншою версією, ніж вам потрібно. + +/// + +## Перевірте активність віртуального середовища { #check-the-virtual-environment-is-active } + +Перевірте, що віртуальне середовище активне (попередня команда спрацювала). + +/// tip | Порада + +Це необов'язково, але це гарний спосіб перевірити, що все працює як очікується і ви використовуєте саме те віртуальне середовище, яке планували. + +/// + +//// tab | Linux, macOS, Windows Bash + +
+ +```console +$ which python + +/home/user/code/awesome-project/.venv/bin/python +``` + +
+ +Якщо показано бінарний файл `python` за шляхом `.venv/bin/python` усередині вашого проєкту (у цьому випадку `awesome-project`), тоді все спрацювало. 🎉 + +//// + +//// tab | Windows PowerShell + +
+ +```console +$ Get-Command python + +C:\Users\user\code\awesome-project\.venv\Scripts\python +``` + +
+ +Якщо показано бінарний файл `python` за шляхом `.venv\Scripts\python` усередині вашого проєкту (у цьому випадку `awesome-project`), тоді все спрацювало. 🎉 + +//// + +## Оновіть `pip` { #upgrade-pip } + +/// tip | Порада + +Якщо ви використовуєте `uv`, ви використовуватимете його для встановлення замість `pip`, тож вам не потрібно оновлювати `pip`. 😎 + +/// + +Якщо ви використовуєте `pip` для встановлення пакетів (він іде за замовчуванням із Python), вам слід оновити його до найновішої версії. + +Багато дивних помилок під час встановлення пакета вирішуються тим, що спочатку оновлюють `pip`. + +/// tip | Порада + +Зазвичай це роблять один раз, відразу після створення віртуального середовища. + +/// + +Переконайтеся, що віртуальне середовище активне (командою вище), а потім виконайте: + +
+ +```console +$ python -m pip install --upgrade pip + +---> 100% +``` + +
+ +/// tip | Порада + +Іноді ви можете отримати помилку **`No module named pip`** при спробі оновити pip. + +Якщо це сталося, встановіть і оновіть pip за допомогою команди нижче: + +
+ +```console +$ python -m ensurepip --upgrade + +---> 100% +``` + +
+ +Ця команда встановить pip, якщо він ще не встановлений, і також гарантує, що встановлена версія pip принаймні така ж нова, як доступна в `ensurepip`. + +/// + +## Додайте `.gitignore` { #add-gitignore } + +Якщо ви використовуєте Git (варто це робити), додайте файл `.gitignore`, щоб виключити з Git усе у вашому `.venv`. + +/// tip | Порада + +Якщо ви використали `uv` для створення віртуального середовища, він уже зробив це за вас, можете пропустити цей крок. 😎 + +/// + +/// tip | Порада + +Зробіть це один раз, відразу після створення віртуального середовища. + +/// + +
+ +```console +$ echo "*" > .venv/.gitignore +``` + +
+ +/// details | Що означає ця команда + +* `echo "*"`: «виведе» текст `*` у термінал (наступна частина трохи це змінює) +* `>`: усе, що команда ліворуч від `>` «виводить» у термінал, не слід друкувати, натомість записати у файл, вказаний праворуч від `>` +* `.gitignore`: назва файлу, куди слід записати текст + +А `*` для Git означає «все». Тож він ігноруватиме все в каталозі `.venv`. + +Ця команда створить файл `.gitignore` із вмістом: + +```gitignore +* +``` + +/// + +## Встановіть пакети { #install-packages } + +Після активації середовища ви можете встановлювати в нього пакети. + +/// tip | Порада + +Робіть це один раз під час встановлення або оновлення пакетів, потрібних вашому проєкту. + +Якщо вам потрібно оновити версію або додати новий пакет, ви зробите це знову. + +/// + +### Встановіть пакети безпосередньо { #install-packages-directly } + +Якщо ви поспішаєте та не хочете використовувати файл для оголошення вимог вашого проєкту до пакетів, ви можете встановити їх безпосередньо. + +/// tip | Порада + +Дуже добра ідея - записати пакети та версії, потрібні вашій програмі, у файл (наприклад, `requirements.txt` або `pyproject.toml`). + +/// + +//// tab | `pip` + +
+ +```console +$ pip install "fastapi[standard]" + +---> 100% +``` + +
+ +//// + +//// tab | `uv` + +Якщо у вас є `uv`: + +
+ +```console +$ uv pip install "fastapi[standard]" +---> 100% +``` + +
+ +//// + +### Встановіть з `requirements.txt` { #install-from-requirements-txt } + +Якщо у вас є `requirements.txt`, ви можете використати його для встановлення перелічених там пакетів. + +//// tab | `pip` + +
+ +```console +$ pip install -r requirements.txt +---> 100% +``` + +
+ +//// + +//// tab | `uv` + +Якщо у вас є `uv`: + +
+ +```console +$ uv pip install -r requirements.txt +---> 100% +``` + +
+ +//// + +/// details | `requirements.txt` + +`requirements.txt` із деякими пакетами може виглядати так: + +```requirements.txt +fastapi[standard]==0.113.0 +pydantic==2.8.0 +``` + +/// + +## Запустіть вашу програму { #run-your-program } + +Після активації віртуального середовища ви можете запустити вашу програму, і вона використовуватиме Python із вашого віртуального середовища з пакетами, які ви там встановили. + +
+ +```console +$ python main.py + +Hello World +``` + +
+ +## Налаштуйте ваш редактор { #configure-your-editor } + +Ймовірно, ви використовуєте редактор коду, переконайтеся, що ви налаштували його на використання того самого віртуального середовища, яке ви створили (швидше за все, він визначить його автоматично), щоб отримувати автодоповнення та підсвічування помилок. + +Наприклад: + +* VS Code +* PyCharm + +/// tip | Порада + +Зазвичай це потрібно робити лише один раз, коли ви створюєте віртуальне середовище. + +/// + +## Деактивуйте віртуальне середовище { #deactivate-the-virtual-environment } + +Коли ви завершили роботу над проєктом, ви можете деактивувати віртуальне середовище. + +
+ +```console +$ deactivate +``` + +
+ +Таким чином, коли ви запустите `python`, він не намагатиметься запускатися з того віртуального середовища з установленими там пакетами. + +## Готові до роботи { #ready-to-work } + +Тепер ви готові почати працювати над вашим проєктом. + +/// tip | Порада + +Хочете зрозуміти, що це все було вище? + +Продовжуйте читати. 👇🤓 + +/// + +## Навіщо віртуальні середовища { #why-virtual-environments } + +Щоб працювати з FastAPI, вам потрібно встановити Python. + +Після цього вам потрібно буде встановити FastAPI та інші пакети, які ви хочете використовувати. + +Для встановлення пакетів зазвичай використовують команду `pip`, що постачається з Python (або схожі альтернативи). + +Однак, якщо ви просто користуватиметеся `pip` напряму, пакети встановлюватимуться у ваше глобальне середовище Python (глобальну інсталяцію Python). + +### Проблема { #the-problem } + +То в чому ж проблема встановлення пакетів у глобальне середовище Python? + +З часом ви, вірогідно, писатимете багато різних програм, які залежать від різних пакетів. І деякі з цих ваших проєктів залежатимуть від різних версій одного й того ж пакета. 😱 + +Наприклад, ви можете створити проєкт із назвою `philosophers-stone`, ця програма залежить від іншого пакета з назвою `harry`, використовуючи версію `1`. Тож вам потрібно встановити `harry`. + +```mermaid +flowchart LR + stone(philosophers-stone) -->|requires| harry-1[harry v1] +``` + +Потім, трохи згодом, ви створюєте інший проєкт із назвою `prisoner-of-azkaban`, і цей проєкт також залежить від `harry`, але йому потрібна версія `harry` `3`. + +```mermaid +flowchart LR + azkaban(prisoner-of-azkaban) --> |requires| harry-3[harry v3] +``` + +Але тепер проблема в тому, що якщо ви встановлюєте пакети глобально (у глобальне середовище), а не у локальне віртуальне середовище, вам доведеться вибирати, яку версію `harry` встановити. + +Якщо ви хочете запустити `philosophers-stone`, вам спочатку потрібно встановити `harry` версії `1`, наприклад, так: + +
+ +```console +$ pip install "harry==1" +``` + +
+ +У підсумку у вас буде встановлено `harry` версії `1` у глобальному середовищі Python. + +```mermaid +flowchart LR + subgraph global[global env] + harry-1[harry v1] + end + subgraph stone-project[philosophers-stone project] + stone(philosophers-stone) -->|requires| harry-1 + end +``` + +Але якщо ви захочете запустити `prisoner-of-azkaban`, вам доведеться видалити `harry` версії `1` і встановити `harry` версії `3` (або просто встановлення версії `3` автоматично видалить версію `1`). + +
+ +```console +$ pip install "harry==3" +``` + +
+ +У підсумку у вас буде встановлено `harry` версії `3` у глобальному середовищі Python. + +А якщо ви знову спробуєте запустити `philosophers-stone`, є шанс, що він не працюватиме, тому що йому потрібен `harry` версії `1`. + +```mermaid +flowchart LR + subgraph global[global env] + harry-1[harry v1] + style harry-1 fill:#ccc,stroke-dasharray: 5 5 + harry-3[harry v3] + end + subgraph stone-project[philosophers-stone project] + stone(philosophers-stone) -.-x|⛔️| harry-1 + end + subgraph azkaban-project[prisoner-of-azkaban project] + azkaban(prisoner-of-azkaban) --> |requires| harry-3 + end +``` + +/// tip | Порада + +У пакетах Python дуже поширена практика намагатися якнайкраще уникати несумісних змін у нових версіях, але краще підстрахуватися та встановлювати новіші версії свідомо і тоді, коли ви можете запустити тести, щоб перевірити, що все працює коректно. + +/// + +Тепер уявіть те саме з багатьма іншими пакетами, від яких залежать усі ваші проєкти. Це дуже складно керувати. І ви, імовірно, запускатимете деякі проєкти з деякими несумісними версіями пакетів і не розумітимете, чому щось не працює. + +Також, залежно від вашої операційної системи (напр., Linux, Windows, macOS), у ній може бути вже встановлений Python. І в такому разі, імовірно, уже будуть попередньо встановлені деякі пакети з певними версіями, потрібними вашій системі. Якщо ви встановлюєте пакети в глобальне середовище Python, ви можете зламати деякі програми, що постачаються з вашою операційною системою. + +## Де встановлюються пакети { #where-are-packages-installed } + +Коли ви встановлюєте Python, він створює на вашому комп'ютері кілька каталогів із деякими файлами. + +Деякі з цих каталогів відповідають за зберігання всіх пакетів, які ви встановлюєте. + +Коли ви запускаєте: + +
+ +```console +// Не запускайте це зараз, це лише приклад 🤓 +$ pip install "fastapi[standard]" +---> 100% +``` + +
+ +Це завантажить стиснений файл з кодом FastAPI, зазвичай із PyPI. + +Також будуть завантажені файли для інших пакетів, від яких залежить FastAPI. + +Потім усе це буде розпаковано та покладено в каталог на вашому комп'ютері. + +Типово ці завантажені та розпаковані файли будуть покладені в каталог, що постачається з вашою інсталяцією Python, це глобальне середовище. + +## Що таке віртуальні середовища { #what-are-virtual-environments } + +Рішенням проблеми з наявністю всіх пакетів у глобальному середовищі є використання віртуального середовища для кожного проєкту, над яким ви працюєте. + +Віртуальне середовище - це каталог, дуже схожий на глобальний, у якому ви можете встановлювати пакети для конкретного проєкту. + +Таким чином кожен проєкт матиме власне віртуальне середовище (каталог `.venv`) із власними пакетами. + +```mermaid +flowchart TB + subgraph stone-project[philosophers-stone project] + stone(philosophers-stone) --->|requires| harry-1 + subgraph venv1[.venv] + harry-1[harry v1] + end + end + subgraph azkaban-project[prisoner-of-azkaban project] + azkaban(prisoner-of-azkaban) --->|requires| harry-3 + subgraph venv2[.venv] + harry-3[harry v3] + end + end + stone-project ~~~ azkaban-project +``` + +## Що означає активація віртуального середовища { #what-does-activating-a-virtual-environment-mean } + +Коли ви активуєте віртуальне середовище, наприклад так: + +//// tab | Linux, macOS + +
+ +```console +$ source .venv/bin/activate +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +$ .venv\Scripts\Activate.ps1 +``` + +
+ +//// + +//// tab | Windows Bash + +Або якщо ви використовуєте Bash для Windows (напр., Git Bash): + +
+ +```console +$ source .venv/Scripts/activate +``` + +
+ +//// + +Ця команда створить або змінить деякі [Змінні оточення](environment-variables.md){.internal-link target=_blank}, які будуть доступні для наступних команд. + +Однією з цих змінних є змінна `PATH`. + +/// tip | Порада + +Ви можете дізнатися більше про змінну оточення `PATH` у розділі [Змінні оточення](environment-variables.md#path-environment-variable){.internal-link target=_blank}. + +/// + +Активація віртуального середовища додає його шлях `.venv/bin` (на Linux і macOS) або `.venv\Scripts` (на Windows) до змінної оточення `PATH`. + +Скажімо, до активації середовища змінна `PATH` виглядала так: + +//// tab | Linux, macOS + +```plaintext +/usr/bin:/bin:/usr/sbin:/sbin +``` + +Це означає, що система шукатиме програми в: + +* `/usr/bin` +* `/bin` +* `/usr/sbin` +* `/sbin` + +//// + +//// tab | Windows + +```plaintext +C:\Windows\System32 +``` + +Це означає, що система шукатиме програми в: + +* `C:\Windows\System32` + +//// + +Після активації віртуального середовища змінна `PATH` виглядатиме приблизно так: + +//// tab | Linux, macOS + +```plaintext +/home/user/code/awesome-project/.venv/bin:/usr/bin:/bin:/usr/sbin:/sbin +``` + +Це означає, що система тепер спочатку шукатиме програми в: + +```plaintext +/home/user/code/awesome-project/.venv/bin +``` + +перед тим, як шукати в інших каталогах. + +Тож коли ви введете `python` у терміналі, система знайде програму Python у + +```plaintext +/home/user/code/awesome-project/.venv/bin/python +``` + +і використає саме її. + +//// + +//// tab | Windows + +```plaintext +C:\Users\user\code\awesome-project\.venv\Scripts;C:\Windows\System32 +``` + +Це означає, що система тепер спочатку шукатиме програми в: + +```plaintext +C:\Users\user\code\awesome-project\.venv\Scripts +``` + +перед тим, як шукати в інших каталогах. + +Тож коли ви введете `python` у терміналі, система знайде програму Python у + +```plaintext +C:\Users\user\code\awesome-project\.venv\Scripts\python +``` + +і використає саме її. + +//// + +Важлива деталь: шлях до віртуального середовища буде додано на початок змінної `PATH`. Система знайде його раніше за будь-який інший доступний Python. Таким чином, коли ви запускаєте `python`, використовується саме Python із віртуального середовища, а не будь-який інший `python` (наприклад, з глобального середовища). + +Активація віртуального середовища також змінює ще кілька речей, але це одна з найважливіших. + +## Перевірка віртуального середовища { #checking-a-virtual-environment } + +Коли ви перевіряєте, чи активне віртуальне середовище, наприклад так: + +//// tab | Linux, macOS, Windows Bash + +
+ +```console +$ which python + +/home/user/code/awesome-project/.venv/bin/python +``` + +
+ +//// + +//// tab | Windows PowerShell + +
+ +```console +$ Get-Command python + +C:\Users\user\code\awesome-project\.venv\Scripts\python +``` + +
+ +//// + +Це означає, що програма `python`, яка буде використана, знаходиться у віртуальному середовищі. + +На Linux і macOS використовують `which`, а в Windows PowerShell - `Get-Command`. + +Принцип роботи цієї команди в тому, що вона перевіряє змінну оточення `PATH`, проходячи по кожному шляху по порядку, шукаючи програму з назвою `python`. Щойно вона її знайде, вона покаже вам шлях до цієї програми. + +Найважливіше, що коли ви викликаєте `python`, це рівно той «`python`», який буде виконаний. + +Отже, ви можете підтвердити, чи перебуваєте в правильному віртуальному середовищі. + +/// tip | Порада + +Легко активувати одне віртуальне середовище, отримати один Python, а потім перейти до іншого проєкту. + +І другий проєкт не працюватиме, бо ви використовуєте некоректний Python з віртуального середовища іншого проєкту. + +Корисно вміти перевіряти, який саме `python` використовується. 🤓 + +/// + +## Навіщо деактивувати віртуальне середовище { #why-deactivate-a-virtual-environment } + +Наприклад, ви працюєте над проєктом `philosophers-stone`, активували його віртуальне середовище, встановили пакети та працюєте з цим середовищем. + +А потім ви хочете працювати над іншим проєктом `prisoner-of-azkaban`. + +Ви переходите до цього проєкту: + +
+ +```console +$ cd ~/code/prisoner-of-azkaban +``` + +
+ +Якщо ви не деактивуєте віртуальне середовище для `philosophers-stone`, коли ви запустите `python` у терміналі, він спробує використовувати Python із `philosophers-stone`. + +
+ +```console +$ cd ~/code/prisoner-of-azkaban + +$ python main.py + +// Помилка імпорту sirius, його не встановлено 😱 +Traceback (most recent call last): + File "main.py", line 1, in + import sirius +``` + +
+ +Але якщо ви деактивуєте віртуальне середовище і активуєте нове для `prisoner-of-askaban`, тоді при запуску `python` він використовуватиме Python із віртуального середовища в `prisoner-of-azkaban`. + +
+ +```console +$ cd ~/code/prisoner-of-azkaban + +// Вам не потрібно бути в старому каталозі, щоб деактивувати, це можна зробити будь-де, навіть після переходу до іншого проєкту 😎 +$ deactivate + +// Активуйте віртуальне середовище в prisoner-of-azkaban/.venv 🚀 +$ source .venv/bin/activate + +// Тепер, коли ви запускаєте python, він знайде пакет sirius, встановлений у цьому віртуальному середовищі ✨ +$ python main.py + +I solemnly swear 🐺 +``` + +
+ +## Альтернативи { #alternatives } + +Це простий посібник, щоб ви швидко стартували та зрозуміли, як усе працює «під капотом». + +Існує багато альтернатив керування віртуальними середовищами, залежностями пакетів (вимогами), проєктами. + +Коли будете готові й захочете використовувати інструмент для керування всім проєктом, залежностями пакетів, віртуальними середовищами тощо, я раджу спробувати uv. + +`uv` уміє багато чого, зокрема: + +* Встановлювати Python для вас, включно з різними версіями +* Керувати віртуальним середовищем ваших проєктів +* Встановлювати пакети +* Керувати залежностями пакетів і версіями у вашому проєкті +* Гарантувати, що у вас є точний набір пакетів і версій для встановлення, включно з їхніми залежностями, щоб ви були певні, що зможете запустити ваш проєкт у продакшені точно так само, як і на вашому комп'ютері під час розробки - це називається блокуванням +* І багато іншого + +## Висновок { #conclusion } + +Якщо ви все це прочитали й зрозуміли, тепер ви знаєте значно більше про віртуальні середовища, ніж багато розробників. 🤓 + +Знання цих деталей, найімовірніше, стане в пригоді в майбутньому, коли ви налагоджуватимете щось, що виглядає складним, але ви знатимете, як усе працює «під капотом». 😎 diff --git a/docs/zh-hant/docs/_llm-test.md b/docs/zh-hant/docs/_llm-test.md new file mode 100644 index 0000000000..85cfd22991 --- /dev/null +++ b/docs/zh-hant/docs/_llm-test.md @@ -0,0 +1,503 @@ +# LLM 測試檔案 { #llm-test-file } + +本文件用來測試用於翻譯文件的 LLM 是否理解 `scripts/translate.py` 中的 `general_prompt`,以及 `docs/{language code}/llm-prompt.md` 中的語言特定提示。語言特定提示會附加在 `general_prompt` 後面。 + +此處新增的測試會提供給所有語言特定提示的設計者參考。 + +使用方式: + +* 準備語言特定提示 - `docs/{language code}/llm-prompt.md`。 +* 針對本文件做一次全新的翻譯為你想要的目標語言(例如使用 `translate.py` 的 `translate-page` 指令)。這會在 `docs/{language code}/docs/_llm-test.md` 產生翻譯檔。 +* 檢查翻譯是否正確。 +* 如有需要,改進你的語言特定提示、通用提示,或英文原文。 +* 然後手動修正翻譯中剩下的問題,讓它成為一個好的譯文。 +* 重新翻譯,並保留這份好的譯文。理想結果是 LLM 不再對該譯文做任何變更。這代表通用提示與你的語言特定提示已經盡可能完善(有時它仍可能做出幾個看似隨機的變更,原因是LLMs 並非決定性演算法)。 + +測試: + +## 程式碼片段 { #code-snippets } + +//// tab | 測試 + +這是一個程式碼片段:`foo`。這是另一個程式碼片段:`bar`。還有一個:`baz quux`。 + +//// + +//// tab | 資訊 + +程式碼片段內的內容應保持原樣。 + +請見 `scripts/translate.py` 中通用提示的 `### Content of code snippets` 小節。 + +//// + +## 引號 { #quotes } + +//// tab | 測試 + +Yesterday, my friend wrote: "If you spell incorrectly correctly, you have spelled it incorrectly". To which I answered: "Correct, but 'incorrectly' is incorrectly not '"incorrectly"'". + +/// note | 注意 + +LLM 很可能會把這段翻譯錯。重點只在於重新翻譯時是否能保留已修正的翻譯。 + +/// + +//// + +//// tab | 資訊 + +提示設計者可以選擇是否將中性引號轉換為排印引號。保留原樣也可以。 + +例如請見 `docs/de/llm-prompt.md` 中的 `### Quotes` 小節。 + +//// + +## 程式碼片段中的引號 { #quotes-in-code-snippets } + +//// tab | 測試 + +`pip install "foo[bar]"` + +程式碼片段中字串常值的例子:"this"、'that'。 + +較難的程式碼片段中字串常值例子:`f"I like {'oranges' if orange else "apples"}"` + +進階:`Yesterday, my friend wrote: "If you spell incorrectly correctly, you have spelled it incorrectly". To which I answered: "Correct, but 'incorrectly' is incorrectly not '"incorrectly"'"` + +//// + +//// tab | 資訊 + +... 不過,程式碼片段中的引號必須保持原樣。 + +//// + +## 程式碼區塊 { #code-blocks } + +//// tab | 測試 + +一個 Bash 程式碼範例... + +```bash +# 向宇宙輸出問候 +echo "Hello universe" +``` + +...以及一個主控台範例... + +```console +$ fastapi run main.py + FastAPI Starting server + Searching for package file structure +``` + +...以及另一個主控台範例... + +```console +// 建立目錄 "code" +$ mkdir code +// 切換到該目錄 +$ cd code +``` + +...以及一個 Python 程式碼範例... + +```Python +wont_work() # 這不會運作 😱 +works(foo="bar") # 這可以運作 🎉 +``` + +...就是這樣。 + +//// + +//// tab | 資訊 + +程式碼區塊中的程式碼不應修改,註解除外。 + +請見 `scripts/translate.py` 中通用提示的 `### Content of code blocks` 小節。 + +//// + +## 分頁與色塊 { #tabs-and-colored-boxes } + +//// tab | 測試 + +/// info | 資訊 +Some text +/// + +/// note | 注意 +Some text +/// + +/// note | 技術細節 +Some text +/// + +/// check | 檢查 +Some text +/// + +/// tip | 提示 +Some text +/// + +/// warning | 警告 +Some text +/// + +/// danger | 危險 +Some text +/// + +//// + +//// tab | 資訊 + +分頁與 `Info`/`Note`/`Warning`/等區塊,應在直線(`|`)後加入其標題的翻譯。 + +請見 `scripts/translate.py` 中通用提示的 `### Special blocks` 與 `### Tab blocks` 小節。 + +//// + +## 網頁與內部連結 { #web-and-internal-links } + +//// tab | 測試 + +連結文字應被翻譯,連結位址應保持不變: + +* [連結到上方標題](#code-snippets) +* [內部連結](index.md#installation){.internal-link target=_blank} +* 外部連結 +* 連結到樣式 +* 連結到腳本 +* 連結到圖片 + +連結文字應被翻譯,連結位址應指向對應的翻譯版本: + +* FastAPI 連結 + +//// + +//// tab | 資訊 + +連結應翻譯其文字,但位址需保持不變。例外是指向 FastAPI 文件網站的絕對連結,該情況下位址應指向對應的翻譯版本。 + +請見 `scripts/translate.py` 中通用提示的 `### Links` 小節。 + +//// + +## HTML「abbr」元素 { #html-abbr-elements } + +//// tab | 測試 + +以下是一些包在 HTML「abbr」元素中的內容(部分為杜撰): + +### abbr 提供完整詞組 { #the-abbr-gives-a-full-phrase } + +* GTD +* lt +* XWT +* PSGI + +### abbr 提供完整詞組與說明 { #the-abbr-gives-a-full-phrase-and-an-explanation } + +* MDN +* I/O. + +//// + +//// tab | 資訊 + +「abbr」元素的「title」屬性需依特定規則翻譯。 + +翻譯可以自行新增「abbr」元素(例如為解釋英文單字),LLM 不應移除它們。 + +請見 `scripts/translate.py` 中通用提示的 `### HTML abbr elements` 小節。 + +//// + +## HTML「dfn」元素 { #html-dfn-elements } + +* 叢集 +* 深度學習 + +## 標題 { #headings } + +//// tab | 測試 + +### 開發網頁應用程式 - 教學 { #develop-a-webapp-a-tutorial } + +Hello. + +### 型別提示與註解 { #type-hints-and-annotations } + +Hello again. + +### 超類與子類別 { #super-and-subclasses } + +Hello again. + +//// + +//// tab | 資訊 + +標題唯一的硬性規則是保留花括號中的雜湊片段不變,以確保連結不會失效。 + +請見 `scripts/translate.py` 中通用提示的 `### Headings` 小節。 + +關於語言特定的說明,參見例如 `docs/de/llm-prompt.md` 中的 `### Headings` 小節。 + +//// + +## 文件中使用的術語 { #terms-used-in-the-docs } + +//// tab | 測試 + +* you +* your + +* e.g. +* etc. + +* `foo` as an `int` +* `bar` as a `str` +* `baz` as a `list` + +* 教學 - 使用者指南 +* 進階使用者指南 +* SQLModel 文件 +* API 文件 +* 自動文件 + +* 資料科學 +* 深度學習 +* 機器學習 +* 相依性注入 +* HTTP 基本驗證 +* HTTP 摘要驗證 +* ISO 格式 +* JSON Schema 標準 +* JSON 結構描述 +* 結構描述定義 +* 密碼流程 +* 行動裝置 + +* 已棄用 +* 設計的 +* 無效 +* 即時 +* 標準 +* 預設 +* 區分大小寫 +* 不區分大小寫 + +* 提供應用程式服務 +* 提供頁面服務 + +* 應用程式 +* 應用程式 + +* 請求 +* 回應 +* 錯誤回應 + +* 路徑操作 +* 路徑操作裝飾器 +* 路徑操作函式 + +* 主體 +* 請求主體 +* 回應主體 +* JSON 主體 +* 表單主體 +* 檔案主體 +* 函式主體 + +* 參數 +* 主體參數 +* 路徑參數 +* 查詢參數 +* Cookie 參數 +* 標頭參數 +* 表單參數 +* 函式參數 + +* 事件 +* 啟動事件 +* 伺服器的啟動 +* 關閉事件 +* 生命週期事件 + +* 處理器 +* 事件處理器 +* 例外處理器 +* 處理 + +* 模型 +* Pydantic 模型 +* 資料模型 +* 資料庫模型 +* 表單模型 +* 模型物件 + +* 類別 +* 基底類別 +* 父類別 +* 子類別 +* 子類別 +* 同級類別 +* 類別方法 + +* 標頭 +* 標頭 +* 授權標頭 +* `Authorization` 標頭 +* 轉送標頭 + +* 相依性注入系統 +* 相依項 +* 可相依對象 +* 相依者 + +* I/O 受限 +* CPU 受限 +* 並發 +* 平行處理 +* 多處理程序 + +* 環境變數 +* 環境變數 +* `PATH` +* `PATH` 變數 + +* 驗證 +* 驗證提供者 +* 授權 +* 授權表單 +* 授權提供者 +* 使用者進行驗證 +* 系統驗證使用者 + +* CLI +* 命令列介面 + +* 伺服器 +* 用戶端 + +* 雲端提供者 +* 雲端服務 + +* 開發 +* 開發階段 + +* dict +* 字典 +* 列舉 +* enum +* 列舉成員 + +* 編碼器 +* 解碼器 +* 編碼 +* 解碼 + +* 例外 +* 拋出 + +* 運算式 +* 陳述式 + +* 前端 +* 後端 + +* GitHub 討論 +* GitHub 議題 + +* 效能 +* 效能優化 + +* 回傳型別 +* 回傳值 + +* 安全性 +* 安全性機制 + +* 任務 +* 背景任務 +* 任務函式 + +* 樣板 +* 樣板引擎 + +* 型別註解 +* 型別提示 + +* 伺服器工作進程 +* Uvicorn 工作進程 +* Gunicorn 工作進程 +* 工作進程 +* worker 類別 +* 工作負載 + +* 部署 +* 部署 + +* SDK +* 軟體開發工具組 + +* `APIRouter` +* `requirements.txt` +* Bearer Token +* 相容性破壞變更 +* 錯誤 +* 按鈕 +* 可呼叫對象 +* 程式碼 +* 提交 +* 情境管理器 +* 協程 +* 資料庫工作階段 +* 磁碟 +* 網域 +* 引擎 +* 假的 X +* HTTP GET 方法 +* 項目 +* 函式庫 +* 生命週期 +* 鎖 +* 中介軟體 +* 行動應用程式 +* 模組 +* 掛載 +* 網路 +* 來源 +* 覆寫 +* 有效負載 +* 處理器 +* 屬性 +* 代理 +* pull request +* 查詢 +* RAM +* 遠端機器 +* 狀態碼 +* 字串 +* 標籤 +* Web 框架 +* 萬用字元 +* 回傳 +* 驗證 + +//// + +//// tab | 資訊 + +這是一份不完整且非規範性的(多為)技術術語清單,來源為文件內容。它可能有助於提示設計者判斷哪些術語需要 LLM 的特別協助。例如當 LLM 反覆把好的翻譯改回成較差的版本,或在你的語言中對某詞的詞形變化處理有困難時。 + +請見例如 `docs/de/llm-prompt.md` 中的 `### List of English terms and their preferred German translations` 小節。 + +//// diff --git a/docs/zh-hant/docs/advanced/additional-responses.md b/docs/zh-hant/docs/advanced/additional-responses.md new file mode 100644 index 0000000000..bb2bf259bd --- /dev/null +++ b/docs/zh-hant/docs/advanced/additional-responses.md @@ -0,0 +1,247 @@ +# OpenAPI 中的額外回應 { #additional-responses-in-openapi } + +/// warning | 警告 + +這是一個偏進階的主題。 + +如果你剛開始使用 **FastAPI**,大多情況下不需要用到它。 + +/// + +你可以宣告額外的回應,包含額外的狀態碼、媒體型別、描述等。 + +這些額外回應會被包含在 OpenAPI 中,因此也會顯示在 API 文件裡。 + +但對於這些額外回應,你必須直接回傳像 `JSONResponse` 這樣的 `Response`,並包含你的狀態碼與內容。 + +## 使用 `model` 的額外回應 { #additional-response-with-model } + +你可以在你的「路徑操作裝飾器」中傳入參數 `responses`。 + +它接收一個 `dict`:鍵是各回應的狀態碼(例如 `200`),值是另一個 `dict`,其中包含每個回應的資訊。 + +每個回應的 `dict` 都可以有一個鍵 `model`,包含一個 Pydantic 模型,與 `response_model` 類似。 + +**FastAPI** 會取用該模型、產生其 JSON Schema,並把它放到 OpenAPI 中正確的位置。 + +例如,要宣告一個狀態碼為 `404` 的額外回應,並使用 Pydantic 模型 `Message`,你可以這樣寫: + +{* ../../docs_src/additional_responses/tutorial001_py310.py hl[18,22] *} + +/// note | 注意 + +請記住你必須直接回傳 `JSONResponse`。 + +/// + +/// info | 說明 + +`model` 這個鍵不屬於 OpenAPI。 + +**FastAPI** 會從這裡取出 Pydantic 模型,產生 JSON Schema,並放到正確位置。 + +正確的位置是: + +* 在 `content` 這個鍵中,其值是一個 JSON 物件(`dict`),包含: + * 一個媒體型別作為鍵,例如 `application/json`,其值是另一個 JSON 物件,當中包含: + * 鍵 `schema`,其值是該模型的 JSON Schema,這裡就是正確的位置。 + * **FastAPI** 會在這裡加入一個指向你 OpenAPI 中全域 JSON Schemas 的參照,而不是直接把它嵌入。如此一來,其他應用與用戶端可以直接使用那些 JSON Schemas,提供更好的程式碼產生工具等。 + +/// + +這個路徑操作在 OpenAPI 中產生的回應將會是: + +```JSON hl_lines="3-12" +{ + "responses": { + "404": { + "description": "Additional Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Item" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } +} +``` + +這些 Schemas 會在 OpenAPI 中以參照的方式指向其他位置: + +```JSON hl_lines="4-16" +{ + "components": { + "schemas": { + "Message": { + "title": "Message", + "required": [ + "message" + ], + "type": "object", + "properties": { + "message": { + "title": "Message", + "type": "string" + } + } + }, + "Item": { + "title": "Item", + "required": [ + "id", + "value" + ], + "type": "object", + "properties": { + "id": { + "title": "Id", + "type": "string" + }, + "value": { + "title": "Value", + "type": "string" + } + } + }, + "ValidationError": { + "title": "ValidationError", + "required": [ + "loc", + "msg", + "type" + ], + "type": "object", + "properties": { + "loc": { + "title": "Location", + "type": "array", + "items": { + "type": "string" + } + }, + "msg": { + "title": "Message", + "type": "string" + }, + "type": { + "title": "Error Type", + "type": "string" + } + } + }, + "HTTPValidationError": { + "title": "HTTPValidationError", + "type": "object", + "properties": { + "detail": { + "title": "Detail", + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidationError" + } + } + } + } + } + } +} +``` + +## 主回應的其他媒體型別 { #additional-media-types-for-the-main-response } + +你可以用同一個 `responses` 參數,替相同的主回應新增不同的媒體型別。 + +例如,你可以新增 `image/png` 這種媒體型別,宣告你的「路徑操作」可以回傳 JSON 物件(媒體型別為 `application/json`)或一張 PNG 圖片: + +{* ../../docs_src/additional_responses/tutorial002_py310.py hl[17:22,26] *} + +/// note | 注意 + +請注意你必須直接用 `FileResponse` 回傳圖片。 + +/// + +/// info | 說明 + +除非你在 `responses` 參數中明確指定不同的媒體型別,否則 FastAPI 會假設回應的媒體型別與主回應類別相同(預設為 `application/json`)。 + +但如果你指定了一個自訂的回應類別,且其媒體型別為 `None`,那麼對於任何具關聯模型的額外回應,FastAPI 會使用 `application/json`。 + +/// + +## 結合資訊 { #combining-information } + +你也可以從多個地方結合回應資訊,包括 `response_model`、`status_code` 與 `responses` 參數。 + +你可以宣告一個 `response_model`,使用預設狀態碼 `200`(或你需要的自訂狀態碼),然後在 `responses` 中直接於 OpenAPI Schema 為相同的回應宣告額外資訊。 + +**FastAPI** 會保留 `responses` 提供的額外資訊,並把它和你模型的 JSON Schema 結合。 + +例如,你可以宣告一個狀態碼為 `404` 的回應,使用一個 Pydantic 模型,並帶有自訂的 `description`。 + +以及一個狀態碼為 `200` 的回應,使用你的 `response_model`,但包含自訂的 `example`: + +{* ../../docs_src/additional_responses/tutorial003_py310.py hl[20:31] *} + +以上都會被結合並包含在你的 OpenAPI 中,並顯示在 API 文件: + + + +## 結合預先定義與自訂的回應 { #combine-predefined-responses-and-custom-ones } + +你可能想要有一些適用於多個「路徑操作」的預先定義回應,但也想與每個「路徑操作」所需的自訂回應結合。 + +在這些情況下,你可以使用 Python 的「解包」`dict` 技巧,透過 `**dict_to_unpack`: + +```Python +old_dict = { + "old key": "old value", + "second old key": "second old value", +} +new_dict = {**old_dict, "new key": "new value"} +``` + +此處,`new_dict` 會包含 `old_dict` 的所有鍵值配對,再加上新的鍵值配對: + +```Python +{ + "old key": "old value", + "second old key": "second old value", + "new key": "new value", +} +``` + +你可以用這個技巧在「路徑操作」中重用一些預先定義的回應,並與其他自訂回應結合。 + +例如: + +{* ../../docs_src/additional_responses/tutorial004_py310.py hl[11:15,24] *} + +## 關於 OpenAPI 回應的更多資訊 { #more-information-about-openapi-responses } + +若要查看回應中究竟可以包含哪些內容,你可以參考 OpenAPI 規範中的這些章節: + +* OpenAPI Responses 物件,其中包含 `Response Object`。 +* OpenAPI Response 物件,你可以把這裡的任何內容直接放到 `responses` 參數內各個回應中。包含 `description`、`headers`、`content`(在其中宣告不同的媒體型別與 JSON Schemas)、以及 `links`。 diff --git a/docs/zh-hant/docs/advanced/additional-status-codes.md b/docs/zh-hant/docs/advanced/additional-status-codes.md new file mode 100644 index 0000000000..450a4705aa --- /dev/null +++ b/docs/zh-hant/docs/advanced/additional-status-codes.md @@ -0,0 +1,41 @@ +# 額外的狀態碼 { #additional-status-codes } + +在預設情況下,**FastAPI** 會使用 `JSONResponse` 傳回回應,並把你從你的「路徑操作(path operation)」回傳的內容放進該 `JSONResponse` 中。 + +它會使用預設的狀態碼,或你在路徑操作中設定的狀態碼。 + +## 額外的狀態碼 { #additional-status-codes_1 } + +如果你想在主要狀態碼之外再回傳其他狀態碼,可以直接回傳一個 `Response`(例如 `JSONResponse`),並直接設定你想要的額外狀態碼。 + +例如,你想要有一個允許更新項目的路徑操作,成功時回傳 HTTP 狀態碼 200 "OK"。 + +但你也希望它能接受新項目;當項目先前不存在時就建立它們,並回傳 HTTP 狀態碼 201 "Created"。 + +要達成這點,匯入 `JSONResponse`,直接在那裡回傳內容,並設定你想要的 `status_code`: + +{* ../../docs_src/additional_status_codes/tutorial001_an_py310.py hl[4,25] *} + +/// warning + +當你直接回傳一個 `Response`(就像上面的範例),它會原封不動地被送出。 + +不會再經過模型序列化等處理。 + +請確認其中包含你要的資料,且各值是合法的 JSON(如果你使用的是 `JSONResponse`)。 + +/// + +/// note | 注意 + +你也可以使用 `from starlette.responses import JSONResponse`。 + +**FastAPI** 也將同樣的 `starlette.responses` 以 `fastapi.responses` 的形式提供,純粹是為了讓你(開發者)更方便。但大多數可用的回應類別其實都直接來自 Starlette。`status` 也一樣。 + +/// + +## OpenAPI 與 API 文件 { #openapi-and-api-docs } + +如果你直接回傳額外的狀態碼與回應,它們不會被包含進 OpenAPI 綱要(API 文件)中,因為 FastAPI 無法事先知道你會回傳什麼。 + +但你可以在程式碼中補充文件,使用:[額外的回應](additional-responses.md){.internal-link target=_blank}。 diff --git a/docs/zh-hant/docs/advanced/advanced-dependencies.md b/docs/zh-hant/docs/advanced/advanced-dependencies.md new file mode 100644 index 0000000000..472cf470b1 --- /dev/null +++ b/docs/zh-hant/docs/advanced/advanced-dependencies.md @@ -0,0 +1,163 @@ +# 進階相依 { #advanced-dependencies } + +## 參數化的相依 { #parameterized-dependencies } + +到目前為止看到的相依都是固定的函式或類別。 + +但有些情況下,你可能想要能為相依設定參數,而不必宣告許多不同的函式或類別。 + +想像我們想要一個相依,用來檢查查詢參數 `q` 是否包含某些固定內容。 + +同時我們希望能將那個固定內容參數化。 + +## 「callable」的實例 { #a-callable-instance } + +在 Python 中有一種方式可以讓一個類別的實例變成「callable」。 + +不是類別本身(類別本來就可呼叫),而是該類別的實例。 + +要做到這點,我們宣告一個 `__call__` 方法: + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[12] *} + +在這個情境中,**FastAPI** 會用這個 `__call__` 來檢查額外的參數與子相依,並在之後呼叫它,把回傳值傳遞給你的「路徑操作函式」中的參數。 + +## 讓實例可參數化 { #parameterize-the-instance } + +接著,我們可以用 `__init__` 來宣告這個實例的參數,用以「參數化」這個相依: + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[9] *} + +在這裡,**FastAPI** 完全不會接觸或在意 `__init__`,我們會直接在自己的程式碼中使用它。 + +## 建立一個實例 { #create-an-instance } + +我們可以這樣建立該類別的實例: + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[18] *} + +如此一來我們就能「參數化」相依,現在它內部含有 `"bar"`,作為屬性 `checker.fixed_content`。 + +## 將實例作為相依使用 { #use-the-instance-as-a-dependency } + +然後,我們可以在 `Depends(checker)` 中使用這個 `checker`,而不是 `Depends(FixedContentQueryChecker)`,因為相依是那個實例 `checker`,不是類別本身。 + +當解析相依時,**FastAPI** 會像這樣呼叫這個 `checker`: + +```Python +checker(q="somequery") +``` + +...並將其回傳值,作為相依的值,以參數 `fixed_content_included` 傳給我們的「路徑操作函式」: + +{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[22] *} + +/// tip | 提示 + +這一切現在看起來也許有點牽強,而且目前可能還不太清楚有何用途。 + +這些範例刻意保持簡單,但展示了整個機制如何運作。 + +在關於安全性的章節裡,有一些工具函式也是用同樣的方式實作。 + +如果你理解了以上內容,你其實已經知道那些安全性工具在底層是如何運作的。 + +/// + +## 同時含有 `yield`、`HTTPException`、`except` 與背景任務的相依 { #dependencies-with-yield-httpexception-except-and-background-tasks } + +/// warning | 警告 + +你很可能不需要這些技術細節。 + +這些細節主要在於:如果你有一個 0.121.0 之前的 FastAPI 應用,並且在使用含有 `yield` 的相依時遇到問題,會對你有幫助。 + +/// + +含有 `yield` 的相依隨著時間演進,以涵蓋不同的使用情境並修正一些問題。以下是變更摘要。 + +### 含有 `yield` 與 `scope` 的相依 { #dependencies-with-yield-and-scope } + +在 0.121.0 版中,FastAPI 為含有 `yield` 的相依加入了 `Depends(scope="function")` 的支援。 + +使用 `Depends(scope="function")` 時,`yield` 之後的結束程式碼會在「路徑操作函式」執行完畢後立刻執行,在回應發送回客戶端之前。 + +而當使用 `Depends(scope="request")`(預設值)時,`yield` 之後的結束程式碼會在回應送出之後才執行。 + +你可以在文件中閱讀更多:[含有 `yield` 的相依 - 提前結束與 `scope`](../tutorial/dependencies/dependencies-with-yield.md#early-exit-and-scope)。 + +### 含有 `yield` 與 `StreamingResponse` 的相依,技術細節 { #dependencies-with-yield-and-streamingresponse-technical-details } + +在 FastAPI 0.118.0 之前,如果你使用含有 `yield` 的相依,它會在「路徑操作函式」回傳之後、發送回應之前,執行結束程式碼。 + +這樣做的用意是避免在等待回應穿越網路時,比必要的時間更久地占用資源。 + +但這也意味著,如果你回傳的是 `StreamingResponse`,該含有 `yield` 的相依的結束程式碼早已執行完畢。 + +例如,如果你在含有 `yield` 的相依中使用了一個資料庫 session,`StreamingResponse` 在串流資料時將無法使用該 session,因為它已在 `yield` 之後的結束程式碼中被關閉了。 + +這個行為在 0.118.0 被還原,使得 `yield` 之後的結束程式碼會在回應送出之後才被執行。 + +/// info | 資訊 + +如下所見,這與 0.106.0 之前的行為非常類似,但對一些邊界情況做了多項改進與錯誤修正。 + +/// + +#### 需要提早執行結束程式碼的情境 { #use-cases-with-early-exit-code } + +有些特定條件的使用情境,可能會受益於舊行為(在送出回應之前執行含有 `yield` 的相依的結束程式碼)。 + +例如,假設你在含有 `yield` 的相依中只用資料庫 session 來驗證使用者,而這個 session 之後並未在「路徑操作函式」中使用,僅在相依中使用,且回應需要很長時間才會送出,例如一個慢速傳送資料的 `StreamingResponse`,但它並沒有使用資料庫。 + +在這種情況下,資料庫 session 會一直被保留到回應傳送完畢為止,但如果你根本不會用到它,就沒有必要一直持有它。 + +可能會像這樣: + +{* ../../docs_src/dependencies/tutorial013_an_py310.py *} + +結束程式碼(自動關閉 `Session`)在: + +{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[19:21] *} + +...會在回應完成傳送這些慢速資料後才執行: + +{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[30:38] hl[31:33] *} + +但因為 `generate_stream()` 並未使用資料庫 session,實際上不需要在傳送回應時保持 session 開啟。 + +如果你用的是 SQLModel(或 SQLAlchemy)且有這種特定情境,你可以在不再需要時明確關閉該 session: + +{* ../../docs_src/dependencies/tutorial014_an_py310.py ln[24:28] hl[28] *} + +如此一來,該 session 就會釋放資料庫連線,讓其他請求可以使用。 + +如果你有不同的情境,需要從含有 `yield` 的相依中提早結束,請建立一個 GitHub 討論問題,描述你的具體情境,以及為何提早關閉含有 `yield` 的相依對你有幫助。 + +如果有令人信服的案例需要在含有 `yield` 的相依中提前關閉,我會考慮加入一種新的選項,讓你可以選擇性啟用提前關閉。 + +### 含有 `yield` 與 `except` 的相依,技術細節 { #dependencies-with-yield-and-except-technical-details } + +在 FastAPI 0.110.0 之前,如果你使用含有 `yield` 的相依,並且在該相依中用 `except` 捕捉到例外,且沒有再次拋出,那個例外會自動被拋出/轉交給任何例外處理器或內部伺服器錯誤處理器。 + +在 0.110.0 版本中,這被修改以修復沒有處理器(內部伺服器錯誤)而被轉交的例外所造成的未處理記憶體消耗,並使其行為與一般 Python 程式碼一致。 + +### 背景任務與含有 `yield` 的相依,技術細節 { #background-tasks-and-dependencies-with-yield-technical-details } + +在 FastAPI 0.106.0 之前,不可能在 `yield` 之後拋出例外;含有 `yield` 的相依的結束程式碼會在回應送出之後才執行,因此[例外處理器](../tutorial/handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank} 早就已經跑完了。 + +當初這樣設計主要是為了允許在背景任務中使用由相依「yield」出來的同一組物件,因為結束程式碼會在背景任務結束後才執行。 + +在 FastAPI 0.106.0 中,這個行為被修改,目的是在等待回應穿越網路的期間,不要持有資源。 + +/// tip | 提示 + +此外,背景任務通常是一組獨立的邏輯,應該用自己的資源(例如自己的資料庫連線)來處理。 + +這樣你的程式碼通常會更乾淨。 + +/// + +如果你先前依賴這種行為,現在應該在背景任務本身裡建立所需資源,並且只使用不依賴含有 `yield` 的相依之資源的資料。 + +例如,不要共用同一個資料庫 session,而是在背景任務中建立一個新的資料庫 session,並用這個新的 session 從資料庫取得物件。接著,在呼叫背景任務函式時,不是傳遞資料庫物件本身,而是傳遞該物件的 ID,然後在背景任務函式內再透過這個 ID 取得物件。 diff --git a/docs/zh-hant/docs/advanced/advanced-python-types.md b/docs/zh-hant/docs/advanced/advanced-python-types.md new file mode 100644 index 0000000000..ffa139427a --- /dev/null +++ b/docs/zh-hant/docs/advanced/advanced-python-types.md @@ -0,0 +1,61 @@ +# 進階 Python 型別 { #advanced-python-types } + +以下是一些在使用 Python 型別時可能有用的額外想法。 + +## 使用 `Union` 或 `Optional` { #using-union-or-optional } + +如果你的程式碼因某些原因無法使用 `|`,例如不是在型別註記中,而是在像 `response_model=` 之類的參數位置,那麼你可以用 `typing` 中的 `Union` 來取代豎線(`|`)。 + +例如,你可以宣告某個值可以是 `str` 或 `None`: + +```python +from typing import Union + + +def say_hi(name: Union[str, None]): + print(f"Hi {name}!") +``` + +在 `typing` 中也有用 `Optional` 宣告某個值可以是 `None` 的速記法。 + +以下是我個人(非常主觀)的建議: + +* 🚨 避免使用 `Optional[SomeType]` +* 改為 ✨ 使用 `Union[SomeType, None]` ✨。 + +兩者等價且底層相同,但我會推薦用 `Union` 而不要用 `Optional`,因為「optional」這個詞看起來會讓人以為這個值是可選的,但實際上它的意思是「可以是 `None`」,即使它不是可選的、仍然是必填。 + +我認為 `Union[SomeType, None]` 更能清楚表達其含義。 + +這只是措辭與命名問題,但這些詞會影響你與團隊成員對程式碼的理解。 + +例如,看看下面這個函式: + +```python +from typing import Optional + + +def say_hi(name: Optional[str]): + print(f"Hey {name}!") +``` + +參數 `name` 被標註為 `Optional[str]`,但它並不是可選的;你不能在沒有該參數的情況下呼叫這個函式: + +```Python +say_hi() # 糟了,這會拋出錯誤!😱 +``` + +參數 `name` 仍是必填(不是可選),因為它沒有預設值。不過,`name` 可以接受 `None` 作為值: + +```Python +say_hi(name=None) # 這可行,None 是有效的 🎉 +``` + +好消息是,多數情況下你可以直接用 `|` 來定義型別聯集: + +```python +def say_hi(name: str | None): + print(f"Hey {name}!") +``` + +因此,通常你不必為 `Optional` 與 `Union` 這些名稱操心。😎 diff --git a/docs/zh-hant/docs/advanced/async-tests.md b/docs/zh-hant/docs/advanced/async-tests.md new file mode 100644 index 0000000000..cb7430bf6e --- /dev/null +++ b/docs/zh-hant/docs/advanced/async-tests.md @@ -0,0 +1,99 @@ +# 非同步測試 { #async-tests } + +你已經看過如何使用提供的 `TestClient` 來測試你的 FastAPI 應用。到目前為止,你只看到如何撰寫同步測試,沒有使用 `async` 函式。 + +在測試中能使用非同步函式會很有用,例如當你以非同步方式查詢資料庫時。想像你想測試發送請求到 FastAPI 應用,然後在使用非同步資料庫函式庫時,驗證後端是否成功把正確資料寫入資料庫。 + +來看看怎麼做。 + +## pytest.mark.anyio { #pytest-mark-anyio } + +若要在測試中呼叫非同步函式,測試函式本身也必須是非同步的。AnyIO 為此提供了一個好用的外掛,讓我們可以標示某些測試函式以非同步方式執行。 + +## HTTPX { #httpx } + +即使你的 FastAPI 應用使用一般的 `def` 函式而非 `async def`,它在底層仍然是個 `async` 應用。 + +`TestClient` 在內部做了一些魔法,讓我們能在一般的 `def` 測試函式中,使用標準 pytest 來呼叫非同步的 FastAPI 應用。但當我們在非同步函式中使用它時,這個魔法就不再奏效了。也就是說,當以非同步方式執行測試時,就不能在測試函式內使用 `TestClient`。 + +`TestClient` 是建立在 HTTPX 之上,所幸我們可以直接使用它來測試 API。 + +## 範例 { #example } + +作為簡單範例,讓我們考慮與[更大型的應用](../tutorial/bigger-applications.md){.internal-link target=_blank}與[測試](../tutorial/testing.md){.internal-link target=_blank}中描述的類似檔案結構: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +│   └── test_main.py +``` + +檔案 `main.py` 會是: + +{* ../../docs_src/async_tests/app_a_py310/main.py *} + +檔案 `test_main.py` 會包含針對 `main.py` 的測試,現在可能像這樣: + +{* ../../docs_src/async_tests/app_a_py310/test_main.py *} + +## 執行 { #run-it } + +如常執行測試: + +
+ +```console +$ pytest + +---> 100% +``` + +
+ +## 詳解 { #in-detail } + +標記 `@pytest.mark.anyio` 告訴 pytest 這個測試函式應以非同步方式執行: + +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[7] *} + +/// tip + +注意,測試函式現在是 `async def`,而不是像使用 `TestClient` 時那樣僅用 `def`。 + +/// + +接著,我們可以用該應用建立 `AsyncClient`,並以 `await` 發送非同步請求。 + +{* ../../docs_src/async_tests/app_a_py310/test_main.py hl[9:12] *} + +這等同於: + +```Python +response = client.get('/') +``` + +也就是先前用 `TestClient` 發送請求時所用的寫法。 + +/// tip + +注意,對新的 `AsyncClient` 需搭配 async/await —— 請求是非同步的。 + +/// + +/// warning + +如果你的應用仰賴 lifespan 事件,`AsyncClient` 不會觸發這些事件。若要確保它們被觸發,請使用 florimondmanca/asgi-lifespan 的 `LifespanManager`。 + +/// + +## 其他非同步函式呼叫 { #other-asynchronous-function-calls } + +由於測試函式現在是非同步的,你也可以在測試中呼叫(並 `await`)其他 `async` 函式,和在程式碼其他地方一樣。 + +/// tip + +如果在將非同步呼叫整合進測試時遇到 `RuntimeError: Task attached to a different loop`(例如使用 MongoDB 的 MotorClient 時),請記得:需要事件迴圈的物件只應在非同步函式內實例化,例如在 `@app.on_event("startup")` 回呼中。 + +/// diff --git a/docs/zh-hant/docs/advanced/behind-a-proxy.md b/docs/zh-hant/docs/advanced/behind-a-proxy.md new file mode 100644 index 0000000000..71a0557afd --- /dev/null +++ b/docs/zh-hant/docs/advanced/behind-a-proxy.md @@ -0,0 +1,466 @@ +# 在代理之後 { #behind-a-proxy } + +在許多情況下,你會在 FastAPI 應用前面放一個「代理」(proxy),例如 Traefik 或 Nginx。 + +這些代理可以處理 HTTPS 憑證等事務。 + +## 代理轉發標頭 { #proxy-forwarded-headers } + +在你的應用前方的「代理」通常會在將請求送給你的「伺服器」之前,臨時加入一些標頭,讓伺服器知道這個請求是由代理「轉發」過來的,並告訴它原始(公開)的 URL,包括網域、是否使用 HTTPS 等。 + +「伺服器」程式(例如透過 FastAPI CLI 啟動的 Uvicorn)能夠解讀這些標頭,然後把該資訊傳遞給你的應用。 + +但出於安全考量,因為伺服器並不知道自己位於受信任的代理之後,所以它不會解讀那些標頭。 + +/// note | 技術細節 + +代理相關的標頭有: + +* X-Forwarded-For +* X-Forwarded-Proto +* X-Forwarded-Host + +/// + +### 啟用代理轉發標頭 { #enable-proxy-forwarded-headers } + +你可以在啟動 FastAPI CLI 時使用「CLI 選項」`--forwarded-allow-ips`,並傳入允許解析這些轉發標頭的受信任 IP 位址。 + +如果將其設為 `--forwarded-allow-ips="*"`,就會信任所有進來的 IP。 + +如果你的「伺服器」位於受信任的「代理」之後,且只有代理會與它通訊,這樣會讓它接受該「代理」的任何 IP。 + +
+ +```console +$ fastapi run --forwarded-allow-ips="*" + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +### 使用 HTTPS 的重新導向 { #redirects-with-https } + +例如,假設你定義了一個「路徑操作(path operation)」`/items/`: + +{* ../../docs_src/behind_a_proxy/tutorial001_01_py310.py hl[6] *} + +如果用戶端嘗試前往 `/items`,預設會被重新導向到 `/items/`。 + +但在設定「CLI 選項」`--forwarded-allow-ips` 之前,它可能會被重新導向到 `http://localhost:8000/items/`。 + +不過,也許你的應用實際部署在 `https://mysuperapp.com`,那重新導向就應該是 `https://mysuperapp.com/items/`。 + +設定 `--proxy-headers` 之後,FastAPI 就能重新導向到正確的位置。😎 + +``` +https://mysuperapp.com/items/ +``` + +/// tip + +如果你想了解更多 HTTPS 的內容,請參考指南[[關於 HTTPS](../deployment/https.md){.internal-link target=_blank}]。 + +/// + +### 代理轉發標頭如何運作 { #how-proxy-forwarded-headers-work } + +以下是「代理」在用戶端與「應用伺服器」之間加入轉發標頭的視覺化示意: + +```mermaid +sequenceDiagram + participant Client + participant Proxy as Proxy/Load Balancer + participant Server as FastAPI Server + + Client->>Proxy: HTTPS Request
Host: mysuperapp.com
Path: /items + + Note over Proxy: Proxy adds forwarded headers + + Proxy->>Server: HTTP Request
X-Forwarded-For: [client IP]
X-Forwarded-Proto: https
X-Forwarded-Host: mysuperapp.com
Path: /items + + Note over Server: Server interprets headers
(if --forwarded-allow-ips is set) + + Server->>Proxy: HTTP Response
with correct HTTPS URLs + + Proxy->>Client: HTTPS Response +``` + +「代理」會攔截原始用戶端請求,並在將其轉交給「應用伺服器」之前加入特殊的「轉發」標頭(`X-Forwarded-*`)。 + +這些標頭會保留原始請求中原本會遺失的資訊: + +* X-Forwarded-For:原始用戶端的 IP 位址 +* X-Forwarded-Proto:原始協定(`https`) +* X-Forwarded-Host:原始主機(`mysuperapp.com`) + +當以 `--forwarded-allow-ips` 設定好 FastAPI CLI 後,它會信任並使用這些標頭,例如在重新導向時產生正確的 URL。 + +## 具有移除路徑前綴的代理 { #proxy-with-a-stripped-path-prefix } + +你可能會有一個會為你的應用加入路徑前綴的代理。 + +在這些情況下,你可以使用 `root_path` 來設定你的應用。 + +`root_path` 是 ASGI 規格(FastAPI 透過 Starlette 所遵循的規格)所提供的機制。 + +`root_path` 用來處理這些特定情境。 + +在掛載子應用時,內部也會使用它。 + +這種「具有移除路徑前綴的代理」情況,代表你在程式碼中宣告了 `/app` 的路徑,但你在上面又加了一層(代理),把你的 FastAPI 應用放在像是 `/api/v1` 這樣的路徑底下。 + +在這種情況下,原本的 `/app` 路徑實際上會以 `/api/v1/app` 對外提供服務。 + +即使你的程式碼都是以只有 `/app` 為前提撰寫的。 + +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[6] *} + +而代理會在把請求轉交給應用伺服器(多半是透過 FastAPI CLI 啟動的 Uvicorn)之前,動態地「移除」這個「路徑前綴」,讓你的應用仍然以為自己是在 `/app` 底下被提供,這樣你就不需要把整個程式碼都改成包含 `/api/v1` 這個前綴。 + +到目前為止,一切都會如常運作。 + +但是,當你打開整合的文件 UI(前端)時,它會預期在 `/openapi.json` 取得 OpenAPI 模式,而不是在 `/api/v1/openapi.json`。 + +因此,前端(在瀏覽器中執行)會嘗試存取 `/openapi.json`,但無法取得 OpenAPI 模式。 + +因為我們的應用前面有一個將路徑前綴設定為 `/api/v1` 的代理,所以前端需要從 `/api/v1/openapi.json` 取得 OpenAPI 模式。 + +```mermaid +graph LR + +browser("Browser") +proxy["Proxy on http://0.0.0.0:9999/api/v1/app"] +server["Server on http://127.0.0.1:8000/app"] + +browser --> proxy +proxy --> server +``` + +/// tip + +IP `0.0.0.0` 通常用來表示程式在該機器/伺服器上的所有可用 IP 上監聽。 + +/// + +文件 UI 也需要 OpenAPI 模式宣告此 API 的 `server` 位在 `/api/v1`(代理之後)。例如: + +```JSON hl_lines="4-8" +{ + "openapi": "3.1.0", + // 其他內容 + "servers": [ + { + "url": "/api/v1" + } + ], + "paths": { + // 其他內容 + } +} +``` + +在這個例子中,「Proxy」可以是 **Traefik**。而伺服器可以是以 **Uvicorn** 啟動的 FastAPI CLI,運行你的 FastAPI 應用。 + +### 提供 `root_path` { #providing-the-root-path } + +要達成這一點,你可以像這樣使用命令列選項 `--root-path`: + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +如果你使用 Hypercorn,它也有 `--root-path` 這個選項。 + +/// note | 技術細節 + +ASGI 規格針對這種用例定義了 `root_path`。 + +而命令列選項 `--root-path` 就是提供該 `root_path`。 + +/// + +### 檢視目前的 `root_path` { #checking-the-current-root-path } + +你可以在每個請求中取得應用使用的 `root_path`,它是 `scope` 字典的一部分(ASGI 規格的一部分)。 + +這裡我們把它放到回傳訊息中只是為了示範。 + +{* ../../docs_src/behind_a_proxy/tutorial001_py310.py hl[8] *} + +接著,如果你用下列方式啟動 Uvicorn: + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +回應會像是: + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +### 在 FastAPI 應用中設定 `root_path` { #setting-the-root-path-in-the-fastapi-app } + +或者,如果你無法提供像 `--root-path` 這樣的命令列選項(或等效方式),你可以在建立 FastAPI 應用時設定 `root_path` 參數: + +{* ../../docs_src/behind_a_proxy/tutorial002_py310.py hl[3] *} + +把 `root_path` 傳給 `FastAPI` 等同於在 Uvicorn 或 Hypercorn 上使用命令列選項 `--root-path`。 + +### 關於 `root_path` { #about-root-path } + +請記住,伺服器(Uvicorn)除了把 `root_path` 傳給應用之外,不會拿它做其他用途。 + +但如果你用瀏覽器前往 http://127.0.0.1:8000/app,你會看到一般的回應: + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +因此,它不會預期被以 `http://127.0.0.1:8000/api/v1/app` 的方式存取。 + +Uvicorn 會預期代理以 `http://127.0.0.1:8000/app` 來存取 Uvicorn,而由代理負責在上層加上額外的 `/api/v1` 前綴。 + +## 關於「移除路徑前綴」的代理 { #about-proxies-with-a-stripped-path-prefix } + +請記住,具有「移除路徑前綴」的代理只是其中一種設定方式。 + +在許多情況下,預設可能是不移除路徑前綴。 + +在那種情況(沒有移除路徑前綴)下,代理會監聽像是 `https://myawesomeapp.com`,然後當瀏覽器前往 `https://myawesomeapp.com/api/v1/app`,而你的伺服器(例如 Uvicorn)在 `http://127.0.0.1:8000` 監聽時,該代理(不移除路徑前綴)就會以同樣的路徑去存取 Uvicorn:`http://127.0.0.1:8000/api/v1/app`。 + +## 在本機使用 Traefik 測試 { #testing-locally-with-traefik } + +你可以很容易地用 Traefik 在本機跑一個「移除路徑前綴」的測試。 + +下載 Traefik,它是一個單一的執行檔,你可以解壓縮後直接在終端機執行。 + +然後建立一個 `traefik.toml` 檔案,內容如下: + +```TOML hl_lines="3" +[entryPoints] + [entryPoints.http] + address = ":9999" + +[providers] + [providers.file] + filename = "routes.toml" +``` + +這告訴 Traefik 監聽 9999 埠,並使用另一個檔案 `routes.toml`。 + +/// tip + +我們使用 9999 埠而不是標準的 HTTP 80 埠,這樣你就不需要以管理員(`sudo`)權限來執行。 + +/// + +接著建立另一個 `routes.toml` 檔案: + +```TOML hl_lines="5 12 20" +[http] + [http.middlewares] + + [http.middlewares.api-stripprefix.stripPrefix] + prefixes = ["/api/v1"] + + [http.routers] + + [http.routers.app-http] + entryPoints = ["http"] + service = "app" + rule = "PathPrefix(`/api/v1`)" + middlewares = ["api-stripprefix"] + + [http.services] + + [http.services.app] + [http.services.app.loadBalancer] + [[http.services.app.loadBalancer.servers]] + url = "http://127.0.0.1:8000" +``` + +這個檔案把 Traefik 設定為使用 `/api/v1` 的路徑前綴。 + +然後 Traefik 會把它的請求轉發到在 `http://127.0.0.1:8000` 上運行的 Uvicorn。 + +現在啟動 Traefik: + +
+ +```console +$ ./traefik --configFile=traefik.toml + +INFO[0000] Configuration loaded from file: /home/user/awesomeapi/traefik.toml +``` + +
+ +然後啟動你的應用,使用 `--root-path` 選項: + +
+ +```console +$ fastapi run main.py --forwarded-allow-ips="*" --root-path /api/v1 + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +### 檢查回應 { #check-the-responses } + +現在,如果你前往 Uvicorn 的埠:http://127.0.0.1:8000/app,你會看到一般的回應: + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +/// tip + +注意,儘管你是用 `http://127.0.0.1:8000/app` 存取,它仍然顯示從 `--root-path` 選項取得的 `root_path` 為 `/api/v1`。 + +/// + +接著打開使用 Traefik 埠且包含路徑前綴的 URL:http://127.0.0.1:9999/api/v1/app。 + +我們會得到相同的回應: + +```JSON +{ + "message": "Hello World", + "root_path": "/api/v1" +} +``` + +但這次是在由代理提供的、帶有前綴路徑的 URL:`/api/v1`。 + +當然,這裡的重點是大家都會透過代理來存取應用,所以帶有 `/api/v1` 路徑前綴的版本才是「正確」的。 + +而沒有路徑前綴的版本(`http://127.0.0.1:8000/app`),也就是直接由 Uvicorn 提供的,應該只給「代理」(Traefik)來存取。 + +這展示了代理(Traefik)如何使用路徑前綴,以及伺服器(Uvicorn)如何使用 `--root-path` 選項提供的 `root_path`。 + +### 檢查文件 UI { #check-the-docs-ui } + +接下來是有趣的部分。✨ + +「正式」的存取方式應該是透過我們定義了路徑前綴的代理。因此,如我們預期,如果你直接透過 Uvicorn 供應的文件 UI、而 URL 中沒有該路徑前綴,那它不會運作,因為它預期要透過代理來存取。 + +你可以在 http://127.0.0.1:8000/docs 檢查: + + + +但如果我們改用「正式」的 URL,也就是使用埠號 `9999` 的代理、並在 `/api/v1/docs`,它就能正確運作了!🎉 + +你可以在 http://127.0.0.1:9999/api/v1/docs 檢查: + + + +正如我們所希望的那樣。✔️ + +這是因為 FastAPI 使用這個 `root_path` 來在 OpenAPI 中建立預設的 `server`,其 URL 就是 `root_path` 所提供的值。 + +## 其他 servers { #additional-servers } + +/// warning + +這是更進階的用法。你可以選擇略過。 + +/// + +預設情況下,FastAPI 會在 OpenAPI 模式中建立一個 `server`,其 URL 為 `root_path`。 + +但你也可以另外提供其他 `servers`,例如你想要用「同一份」文件 UI 來與測試(staging)與正式(production)環境互動。 + +如果你傳入自訂的 `servers` 清單,且同時存在 `root_path`(因為你的 API 位於代理之後),FastAPI 會在清單開頭插入一個 `server`,其 URL 為該 `root_path`。 + +例如: + +{* ../../docs_src/behind_a_proxy/tutorial003_py310.py hl[4:7] *} + +將會產生如下的 OpenAPI 模式: + +```JSON hl_lines="5-7" +{ + "openapi": "3.1.0", + // 其他內容 + "servers": [ + { + "url": "/api/v1" + }, + { + "url": "https://stag.example.com", + "description": "Staging environment" + }, + { + "url": "https://prod.example.com", + "description": "Production environment" + } + ], + "paths": { + // 其他內容 + } +} +``` + +/// tip + +注意自動產生的 server,其 `url` 值為 `/api/v1`,取自 `root_path`。 + +/// + +在位於 http://127.0.0.1:9999/api/v1/docs 的文件 UI 中看起來會像這樣: + + + +/// tip + +文件 UI 會與你所選擇的 server 互動。 + +/// + +/// note | 技術細節 + +OpenAPI 規格中的 `servers` 屬性是可選的。 + +如果你沒有指定 `servers` 參數,且 `root_path` 等於 `/`,則在產生的 OpenAPI 模式中會完全省略 `servers` 屬性(預設行為),這等同於只有一個 `url` 值為 `/` 的 server。 + +/// + +### 停用從 `root_path` 自動加入的 server { #disable-automatic-server-from-root-path } + +如果你不希望 FastAPI 使用 `root_path` 自動加入一個 server,你可以使用參數 `root_path_in_servers=False`: + +{* ../../docs_src/behind_a_proxy/tutorial004_py310.py hl[9] *} + +這樣它就不會被包含在 OpenAPI 模式中。 + +## 掛載子應用 { #mounting-a-sub-application } + +如果你需要在同時使用具有 `root_path` 的代理時,掛載一個子應用(如[[子應用 - 掛載](sub-applications.md){.internal-link target=_blank}]中所述),可以像平常一樣操作,正如你所預期的那樣。 + +FastAPI 會在內部智慧地使用 `root_path`,所以一切都能順利運作。✨ diff --git a/docs/zh-hant/docs/advanced/custom-response.md b/docs/zh-hant/docs/advanced/custom-response.md new file mode 100644 index 0000000000..b723aa82f6 --- /dev/null +++ b/docs/zh-hant/docs/advanced/custom-response.md @@ -0,0 +1,312 @@ +# 自訂回應——HTML、串流、檔案與其他 { #custom-response-html-stream-file-others } + +預設情況下,**FastAPI** 會使用 `JSONResponse` 傳回回應。 + +你可以像在[直接回傳 Response](response-directly.md){.internal-link target=_blank} 中所示,直接回傳一個 `Response` 來覆寫它。 + +但如果你直接回傳一個 `Response`(或其子類別,如 `JSONResponse`),資料將不會被自動轉換(即使你宣告了 `response_model`),而且文件也不會自動產生(例如,在產生的 OpenAPI 中包含 HTTP 標頭 `Content-Type` 的特定「media type」)。 + +你也可以在「路徑操作裝飾器」中使用 `response_class` 參數,宣告要使用的 `Response`(例如任意 `Response` 子類別)。 + +你從「路徑操作函式」回傳的內容,會被放進該 `Response` 中。 + +若該 `Response` 的 media type 是 JSON(`application/json`),像 `JSONResponse` 與 `UJSONResponse`,則你回傳的資料會自動以你在「路徑操作裝飾器」中宣告的 Pydantic `response_model` 進行轉換(與過濾)。 + +/// note + +若你使用的回應類別沒有 media type,FastAPI 會假設你的回應沒有內容,因此不會在產生的 OpenAPI 文件中記錄回應格式。 + +/// + +## 使用 `ORJSONResponse` { #use-orjsonresponse } + +例如,若你在追求效能,你可以安裝並使用 `orjson`,並將回應設為 `ORJSONResponse`。 + +匯入你想使用的 `Response` 類別(子類),並在「路徑操作裝飾器」中宣告它。 + +對於大型回應,直接回傳 `Response` 會比回傳 `dict` 快得多。 + +這是因為預設情況下,FastAPI 會檢查每個項目並確認它能被序列化為 JSON,使用與教學中說明的相同[JSON 相容編碼器](../tutorial/encoder.md){.internal-link target=_blank}。這使你可以回傳「任意物件」,例如資料庫模型。 + +但如果你確定你回傳的內容「可以用 JSON 序列化」,你可以直接將它傳給回應類別,避免 FastAPI 在把你的回傳內容交給回應類別之前,先經過 `jsonable_encoder` 所帶來的額外開銷。 + +{* ../../docs_src/custom_response/tutorial001b_py310.py hl[2,7] *} + +/// info + +參數 `response_class` 也會用來定義回應的「media type」。 + +在此情況下,HTTP 標頭 `Content-Type` 會被設為 `application/json`。 + +而且它會以此形式被記錄到 OpenAPI 中。 + +/// + +/// tip + +`ORJSONResponse` 只在 FastAPI 中可用,在 Starlette 中不可用。 + +/// + +## HTML 回應 { #html-response } + +要直接從 **FastAPI** 回傳 HTML,使用 `HTMLResponse`。 + +- 匯入 `HTMLResponse`。 +- 在「路徑操作裝飾器」中,將 `HTMLResponse` 傳給 `response_class` 參數。 + +{* ../../docs_src/custom_response/tutorial002_py310.py hl[2,7] *} + +/// info + +參數 `response_class` 也會用來定義回應的「media type」。 + +在此情況下,HTTP 標頭 `Content-Type` 會被設為 `text/html`。 + +而且它會以此形式被記錄到 OpenAPI 中。 + +/// + +### 回傳 `Response` { #return-a-response } + +如[直接回傳 Response](response-directly.md){.internal-link target=_blank} 所示,你也可以在「路徑操作」中直接回傳以覆寫回應。 + +上面的相同範例,回傳 `HTMLResponse`,可以像這樣: + +{* ../../docs_src/custom_response/tutorial003_py310.py hl[2,7,19] *} + +/// warning + +由你的「路徑操作函式」直接回傳的 `Response` 不會被記錄進 OpenAPI(例如不會記錄 `Content-Type`),也不會出現在自動產生的互動式文件中。 + +/// + +/// info + +當然,實際的 `Content-Type` 標頭、狀態碼等,會來自你回傳的 `Response` 物件。 + +/// + +### 在 OpenAPI 中文件化並覆寫 `Response` { #document-in-openapi-and-override-response } + +如果你想在函式內覆寫回應,同時又要在 OpenAPI 中記錄「media type」,你可以同時使用 `response_class` 參數並回傳一個 `Response` 物件。 + +此時,`response_class` 只會用於記錄該 OpenAPI「路徑操作」,而你回傳的 `Response` 將會如實使用。 + +#### 直接回傳 `HTMLResponse` { #return-an-htmlresponse-directly } + +例如,可能會像這樣: + +{* ../../docs_src/custom_response/tutorial004_py310.py hl[7,21,23] *} + +在這個例子中,函式 `generate_html_response()` 已經產生並回傳了一個 `Response`,而不是把 HTML 當作 `str` 回傳。 + +透過回傳 `generate_html_response()` 的結果,你其實已經回傳了一個 `Response`,這會覆寫 **FastAPI** 的預設行為。 + +但因為你同時也在 `response_class` 中傳入了 `HTMLResponse`,**FastAPI** 便能在 OpenAPI 與互動式文件中,將其以 `text/html` 的 HTML 形式記錄: + + + +## 可用的回應 { #available-responses } + +以下是一些可用的回應類別。 + +記得你可以用 `Response` 回傳其他任何東西,甚至建立自訂的子類別。 + +/// note | 技術細節 + +你也可以使用 `from starlette.responses import HTMLResponse`。 + +**FastAPI** 將 `starlette.responses` 以 `fastapi.responses` 提供給你(開發者)做為方便之用。但大多數可用的回應其實直接來自 Starlette。 + +/// + +### `Response` { #response } + +主要的 `Response` 類別,其他回應皆繼承自它。 + +你也可以直接回傳它。 + +它接受以下參數: + +- `content` - `str` 或 `bytes`。 +- `status_code` - `int` 類型的 HTTP 狀態碼。 +- `headers` - 由字串組成的 `dict`。 +- `media_type` - 描述 media type 的 `str`。例如 `"text/html"`。 + +FastAPI(實際上是 Starlette)會自動包含 Content-Length 標頭。也會根據 `media_type`(並為文字型別附加 charset)包含 Content-Type 標頭。 + +{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *} + +### `HTMLResponse` { #htmlresponse } + +接收文字或位元組並回傳 HTML 回應,如上所述。 + +### `PlainTextResponse` { #plaintextresponse } + +接收文字或位元組並回傳純文字回應。 + +{* ../../docs_src/custom_response/tutorial005_py310.py hl[2,7,9] *} + +### `JSONResponse` { #jsonresponse } + +接收資料並回傳 `application/json` 編碼的回應。 + +這是 **FastAPI** 的預設回應,如上所述。 + +### `ORJSONResponse` { #orjsonresponse } + +使用 `orjson` 的快速替代 JSON 回應,如上所述。 + +/// info + +這需要安裝 `orjson`,例如使用 `pip install orjson`。 + +/// + +### `UJSONResponse` { #ujsonresponse } + +使用 `ujson` 的替代 JSON 回應。 + +/// info + +這需要安裝 `ujson`,例如使用 `pip install ujson`。 + +/// + +/// warning + +`ujson` 在處理某些邊界情況時,沒那麼嚴謹,較 Python 內建實作更「隨意」。 + +/// + +{* ../../docs_src/custom_response/tutorial001_py310.py hl[2,7] *} + +/// tip + +`ORJSONResponse` 可能是更快的替代方案。 + +/// + +### `RedirectResponse` { #redirectresponse } + +回傳一個 HTTP 重新導向。預設使用 307 狀態碼(Temporary Redirect)。 + +你可以直接回傳 `RedirectResponse`: + +{* ../../docs_src/custom_response/tutorial006_py310.py hl[2,9] *} + +--- + +或者你可以在 `response_class` 參數中使用它: + +{* ../../docs_src/custom_response/tutorial006b_py310.py hl[2,7,9] *} + +若這麼做,你就可以在「路徑操作函式」中直接回傳 URL。 + +在此情況下,所使用的 `status_code` 會是 `RedirectResponse` 的預設值 `307`。 + +--- + +你也可以同時搭配 `status_code` 與 `response_class` 參數: + +{* ../../docs_src/custom_response/tutorial006c_py310.py hl[2,7,9] *} + +### `StreamingResponse` { #streamingresponse } + +接收一個 async 產生器或一般的產生器/疊代器,並以串流方式傳送回應本文。 + +{* ../../docs_src/custom_response/tutorial007_py310.py hl[2,14] *} + +#### 對「類檔案物件」使用 `StreamingResponse` { #using-streamingresponse-with-file-like-objects } + +如果你有一個類檔案(file-like)物件(例如 `open()` 回傳的物件),你可以建立一個產生器函式來疊代該類檔案物件。 + +如此一來,你不必先把它全部讀進記憶體,就能將那個產生器函式傳給 `StreamingResponse` 並回傳。 + +這也包含許多用於雲端儲存、影像/影音處理等的函式庫。 + +{* ../../docs_src/custom_response/tutorial008_py310.py hl[2,10:12,14] *} + +1. 這是產生器函式。因為它內含 `yield` 陳述式,所以是「產生器函式」。 +2. 透過 `with` 區塊,我們確保在產生器函式結束後關閉類檔案物件。因此,在完成傳送回應後就會關閉。 +3. 這個 `yield from` 告訴函式去疊代名為 `file_like` 的東西。對於每個被疊代到的部分,就把該部分當作此產生器函式(`iterfile`)的輸出進行 `yield`。 + + 因此,這是一個把「生成」工作在內部轉交給其他東西的產生器函式。 + + 透過這樣做,我們可以把它放進 `with` 區塊,藉此確保在完成後關閉類檔案物件。 + +/// tip + +注意,這裡我們使用的是標準的 `open()`,它不支援 `async` 與 `await`,因此我們用一般的 `def` 來宣告路徑操作。 + +/// + +### `FileResponse` { #fileresponse } + +以非同步串流方式將檔案作為回應。 + +它在初始化時所需的參數與其他回應型別不同: + +- `path` - 要串流的檔案路徑。 +- `headers` - 要包含的自訂標頭,字典形式。 +- `media_type` - 描述 media type 的字串。若未設定,將根據檔名或路徑推斷 media type。 +- `filename` - 若設定,會包含在回應的 `Content-Disposition` 中。 + +檔案回應會包含適當的 `Content-Length`、`Last-Modified` 與 `ETag` 標頭。 + +{* ../../docs_src/custom_response/tutorial009_py310.py hl[2,10] *} + +你也可以使用 `response_class` 參數: + +{* ../../docs_src/custom_response/tutorial009b_py310.py hl[2,8,10] *} + +在此情況下,你可以在「路徑操作函式」中直接回傳檔案路徑。 + +## 自訂回應類別 { #custom-response-class } + +你可以建立自己的自訂回應類別,繼承自 `Response` 並加以使用。 + +例如,假設你要使用 `orjson`,但想套用一些未包含在 `ORJSONResponse` 類別中的自訂設定。 + +假設你想回傳縮排且格式化的 JSON,因此要使用 orjson 選項 `orjson.OPT_INDENT_2`。 + +你可以建立 `CustomORJSONResponse`。你主要需要做的是建立一個 `Response.render(content)` 方法,將內容以 `bytes` 回傳: + +{* ../../docs_src/custom_response/tutorial009c_py310.py hl[9:14,17] *} + +現在,不再是回傳: + +```json +{"message": "Hello World"} +``` + +……這個回應會回傳: + +```json +{ + "message": "Hello World" +} +``` + +當然,你大概能找到比格式化 JSON 更好的方式來利用這個能力。😉 + +## 預設回應類別 { #default-response-class } + +在建立 **FastAPI** 類別實例或 `APIRouter` 時,你可以指定預設要使用哪個回應類別。 + +用來設定的是 `default_response_class` 參數。 + +在下面的例子中,**FastAPI** 會在所有「路徑操作」中預設使用 `ORJSONResponse`,而不是 `JSONResponse`。 + +{* ../../docs_src/custom_response/tutorial010_py310.py hl[2,4] *} + +/// tip + +你仍然可以在「路徑操作」中像以前一樣覆寫 `response_class`。 + +/// + +## 其他文件化選項 { #additional-documentation } + +你也可以在 OpenAPI 中使用 `responses` 宣告 media type 與其他許多細節:[在 OpenAPI 中的額外回應](additional-responses.md){.internal-link target=_blank}。 diff --git a/docs/zh-hant/docs/advanced/dataclasses.md b/docs/zh-hant/docs/advanced/dataclasses.md new file mode 100644 index 0000000000..d586bd6844 --- /dev/null +++ b/docs/zh-hant/docs/advanced/dataclasses.md @@ -0,0 +1,87 @@ +# 使用 Dataclasses { #using-dataclasses } + +FastAPI 建立在 **Pydantic** 之上,我之前示範過如何使用 Pydantic 模型來宣告請求與回應。 + +但 FastAPI 也同樣支援以相同方式使用 `dataclasses`: + +{* ../../docs_src/dataclasses_/tutorial001_py310.py hl[1,6:11,18:19] *} + +這之所以可行,要感謝 **Pydantic**,因為它 內建支援 `dataclasses`。 + +所以,即使上面的程式碼沒有明確使用 Pydantic,FastAPI 仍會使用 Pydantic 將那些標準的 dataclass 轉換為 Pydantic 版本的 dataclass。 + +而且當然一樣支援: + +- 資料驗證 +- 資料序列化 +- 資料文件化等 + +它的運作方式與 Pydantic 模型相同;實際上,底層就是透過 Pydantic 達成的。 + +/// info + +請記得,dataclass 無法做到 Pydantic 模型能做的一切。 + +所以你可能仍然需要使用 Pydantic 模型。 + +但如果你手邊剛好有一堆 dataclass,這是個不錯的小技巧,可以用來用 FastAPI 驅動一個 Web API。🤓 + +/// + +## 在 `response_model` 中使用 Dataclasses { #dataclasses-in-response-model } + +你也可以在 `response_model` 參數中使用 `dataclasses`: + +{* ../../docs_src/dataclasses_/tutorial002_py310.py hl[1,6:12,18] *} + +該 dataclass 會自動轉換為 Pydantic 的 dataclass。 + +如此一來,其結構描述(schema)會顯示在 API 文件介面中: + + + +## 巢狀資料結構中的 Dataclasses { #dataclasses-in-nested-data-structures } + +你也可以將 `dataclasses` 與其他型別註記結合,建立巢狀的資料結構。 + +在某些情況下,你可能仍需要使用 Pydantic 版本的 `dataclasses`。例如,當自動產生的 API 文件出現錯誤時。 + +這種情況下,你可以把標準的 `dataclasses` 直接換成 `pydantic.dataclasses`,它是可直接替換(drop-in replacement)的: + +{* ../../docs_src/dataclasses_/tutorial003_py310.py hl[1,4,7:10,13:16,22:24,27] *} + +1. 我們仍然從標準的 `dataclasses` 匯入 `field`。 +2. `pydantic.dataclasses` 是 `dataclasses` 的可直接替換版本。 +3. `Author` dataclass 內含一個 `Item` dataclass 的清單。 +4. `Author` dataclass 被用作 `response_model` 參數。 +5. 你可以將其他標準型別註記與 dataclass 一起用作請求本文。 + + 在此例中,它是 `Item` dataclass 的清單。 +6. 這裡我們回傳一個字典,其中的 `items` 是一個 dataclass 清單。 + + FastAPI 仍能將資料序列化為 JSON。 +7. 這裡 `response_model` 使用的是「`Author` dataclass 的清單」這種型別註記。 + + 同樣地,你可以把 `dataclasses` 與標準型別註記組合使用。 +8. 注意這個「路徑操作函式」使用的是一般的 `def` 而非 `async def`。 + + 一如往常,在 FastAPI 中你可以視需要混用 `def` 與 `async def`。 + + 如果需要複習何時用哪個,請參考文件中關於 [`async` 與 `await`](../async.md#in-a-hurry){.internal-link target=_blank} 的章節「In a hurry?」。 +9. 這個「路徑操作函式」回傳的不是 dataclass(雖然也可以),而是一個包含內部資料的字典清單。 + + FastAPI 會使用 `response_model` 參數(其中包含 dataclass)來轉換回應。 + +你可以把 `dataclasses` 與其他型別註記以多種方式組合,形成複雜的資料結構。 + +查看上面程式碼中的註解提示以了解更具體的細節。 + +## 延伸閱讀 { #learn-more } + +你也可以將 `dataclasses` 與其他 Pydantic 模型結合、從它們繼承、把它們包含進你的自訂模型等。 + +想了解更多,請參考 Pydantic 關於 dataclasses 的文件。 + +## 版本 { #version } + +自 FastAPI 版本 `0.67.0` 起可用。🔖 diff --git a/docs/zh-hant/docs/advanced/events.md b/docs/zh-hant/docs/advanced/events.md new file mode 100644 index 0000000000..e5c0afe48f --- /dev/null +++ b/docs/zh-hant/docs/advanced/events.md @@ -0,0 +1,165 @@ +# 生命週期事件 { #lifespan-events } + +你可以定義在應用程式**啟動**之前要執行的邏輯(程式碼)。也就是說,這段程式碼會在應用開始接收請求**之前**、**只執行一次**。 + +同樣地,你也可以定義在應用程式**關閉**時要執行的邏輯(程式碼)。在這種情況下,這段程式碼會在處理了**許多請求**之後、**只執行一次**。 + +因為這些程式碼分別在應用開始接收請求**之前**與**完成**處理請求之後執行,所以涵蓋了整個應用的**生命週期**(「lifespan」這個詞稍後會很重要 😉)。 + +這對於為整個應用設定需要**共用**於多個請求的**資源**,以及在之後進行**清理**,非常有用。比如資料庫連線池、或載入一個共用的機器學習模型。 + +## 使用情境 { #use-case } + +先從一個**使用情境**開始,然後看看如何用這個機制解決。 + +想像你有一些要用來處理請求的**機器學習模型**。🤖 + +同一組模型會在多個請求間共用,所以不是每個請求或每個使用者各有一個模型。 + +再想像一下,載入模型**需要一段時間**,因為它必須從**磁碟**讀取大量資料。所以你不想在每個請求都做一次。 + +你可以在模組/檔案的最上層載入,但這也表示即使只是要跑一個簡單的自動化測試,也會去**載入模型**,導致測試**變慢**,因為它得等模型載入完才能執行與模型無關的程式碼部分。 + +我們要解決的正是這件事:在開始處理請求之前再載入模型,但只在應用程式即將開始接收請求時載入,而不是在匯入程式碼時就載入。 + +## 生命週期(Lifespan) { #lifespan } + +你可以使用 `FastAPI` 應用的 `lifespan` 參數,搭配「context manager」(稍後會示範),來定義這些 *startup* 與 *shutdown* 邏輯。 + +先看一個例子,接著再深入說明。 + +我們建立一個帶有 `yield` 的非同步函式 `lifespan()`,如下: + +{* ../../docs_src/events/tutorial003_py310.py hl[16,19] *} + +這裡我們透過在 `yield` 之前把(假的)模型函式放進機器學習模型的字典中,來模擬昂貴的 *startup* 載入模型操作。這段程式會在應用**開始接收請求之前**執行,也就是 *startup* 階段。 + +接著,在 `yield` 之後,我們卸載模型。這段程式會在應用**完成處理請求之後**、也就是 *shutdown* 前執行。這可以用來釋放資源,例如記憶體或 GPU。 + +/// tip + +`shutdown` 會在你**停止**應用程式時發生。 + +也許你要啟動新版本,或只是不想再跑它了。🤷 + +/// + +### Lifespan 函式 { #lifespan-function } + +首先要注意的是,我們定義了一個帶有 `yield` 的 async 函式。這和帶有 `yield` 的依賴(Dependencies)非常相似。 + +{* ../../docs_src/events/tutorial003_py310.py hl[14:19] *} + +函式在 `yield` 之前的部分,會在應用啟動前先執行。 + +`yield` 之後的部分,會在應用結束後再執行。 + +### 非同步內容管理器(Async Context Manager) { #async-context-manager } + +你會看到這個函式被 `@asynccontextmanager` 裝飾。 + +它會把函式轉換成所謂的「**非同步內容管理器(async context manager)**」。 + +{* ../../docs_src/events/tutorial003_py310.py hl[1,13] *} + +Python 中的**內容管理器(context manager)**可以用在 `with` 陳述式中,例如 `open()` 可以作為內容管理器使用: + +```Python +with open("file.txt") as file: + file.read() +``` + +在較新的 Python 版本中,也有**非同步內容管理器**。你可以用 `async with` 來使用它: + +```Python +async with lifespan(app): + await do_stuff() +``` + +當你像上面那樣建立一個內容管理器或非同步內容管理器時,在進入 `with` 區塊之前,會先執行 `yield` 之前的程式碼;離開 `with` 區塊之後,會執行 `yield` 之後的程式碼。 + +在我們的範例中,並不是直接用它,而是把它傳給 FastAPI 來使用。 + +`FastAPI` 應用的 `lifespan` 參數需要一個**非同步內容管理器**,所以我們可以把剛寫好的 `lifespan` 非同步內容管理器傳給它。 + +{* ../../docs_src/events/tutorial003_py310.py hl[22] *} + +## 替代事件(已棄用) { #alternative-events-deprecated } + +/// warning + +目前建議使用上面所述,透過 `FastAPI` 應用的 `lifespan` 參數來處理 *startup* 與 *shutdown*。如果你提供了 `lifespan` 參數,`startup` 與 `shutdown` 事件處理器將不會被呼叫。要嘛全用 `lifespan`,要嘛全用事件,不能同時混用。 + +你大概可以直接跳過這一節。 + +/// + +也有另一種方式可以定義在 *startup* 與 *shutdown* 期間要執行的邏輯。 + +你可以定義事件處理器(函式)來在應用啟動前或關閉時執行。 + +這些函式可以用 `async def` 或一般的 `def` 宣告。 + +### `startup` 事件 { #startup-event } + +要加入一個在應用啟動前執行的函式,使用事件 `"startup"` 來宣告: + +{* ../../docs_src/events/tutorial001_py310.py hl[8] *} + +在這個例子中,`startup` 事件處理器函式會用一些值來初始化 items 的「資料庫」(其實就是個 `dict`)。 + +你可以註冊多個事件處理函式。 + +而且在所有 `startup` 事件處理器都完成之前,你的應用不會開始接收請求。 + +### `shutdown` 事件 { #shutdown-event } + +要加入一個在應用關閉時執行的函式,使用事件 `"shutdown"` 來宣告: + +{* ../../docs_src/events/tutorial002_py310.py hl[6] *} + +在這裡,`shutdown` 事件處理器函式會把一行文字 `"Application shutdown"` 寫入檔案 `log.txt`。 + +/// info + +在 `open()` 函式中,`mode="a"` 表示「append(附加)」;也就是說,這行文字會加在檔案現有內容之後,而不會覆寫先前的內容。 + +/// + +/// tip + +注意這裡我們使用的是標準 Python 的 `open()` 函式來操作檔案。 + +這涉及 I/O(輸入/輸出),也就是需要「等待」資料寫入磁碟。 + +但 `open()` 並不使用 `async` 與 `await`。 + +所以我們用一般的 `def` 來宣告事件處理器,而不是 `async def`。 + +/// + +### 同時使用 `startup` 與 `shutdown` { #startup-and-shutdown-together } + +你的 *startup* 與 *shutdown* 邏輯很可能是相關聯的:你可能會先啟動某個東西再把它結束、先取得資源再釋放它,等等。 + +如果把它們拆成兩個彼此不共享邏輯或變數的獨立函式,會比較麻煩,你得把值存在全域變數或用其他技巧。 + +因此,現在建議改用上面介紹的 `lifespan`。 + +## 技術細節 { #technical-details } + +給有興趣鑽研的同好一點技術細節。🤓 + +在底層的 ASGI 技術規範中,這屬於 Lifespan Protocol 的一部分,並定義了 `startup` 與 `shutdown` 兩種事件。 + +/// info + +你可以在 Starlette 的 Lifespan 文件 讀到更多關於 Starlette `lifespan` 處理器的資訊。 + +也包含如何處理可在程式其他區域使用的 lifespan 狀態。 + +/// + +## 子應用程式 { #sub-applications } + +🚨 請記住,這些生命週期事件(startup 與 shutdown)只會在主應用程式上執行,不會在[子應用程式 - 掛載](sub-applications.md){.internal-link target=_blank}上執行。 diff --git a/docs/zh-hant/docs/advanced/generate-clients.md b/docs/zh-hant/docs/advanced/generate-clients.md new file mode 100644 index 0000000000..8d374566cd --- /dev/null +++ b/docs/zh-hant/docs/advanced/generate-clients.md @@ -0,0 +1,208 @@ +# 產生 SDK { #generating-sdks } + +由於 **FastAPI** 建立在 **OpenAPI** 規格之上,其 API 能以許多工具都能理解的標準格式來描述。 + +這讓你能輕鬆產生最新的**文件**、多語言的用戶端程式庫(**SDKs**),以及與程式碼保持同步的**測試**或**自動化工作流程**。 + +在本指南中,你將學會如何為你的 FastAPI 後端產生 **TypeScript SDK**。 + +## 開源 SDK 產生器 { #open-source-sdk-generators } + +其中一個相當萬用的選擇是 OpenAPI Generator,它支援**多種程式語言**,並能從你的 OpenAPI 規格產生 SDK。 + +針對 **TypeScript 用戶端**,Hey API 是專門打造的解決方案,為 TypeScript 生態系提供最佳化的體驗。 + +你可以在 OpenAPI.Tools 找到更多 SDK 產生器。 + +/// tip + +FastAPI 會自動產生 **OpenAPI 3.1** 規格,因此你使用的任何工具都必須支援這個版本。 + +/// + +## 來自 FastAPI 贊助商的 SDK 產生器 { #sdk-generators-from-fastapi-sponsors } + +本節重點介紹由贊助 FastAPI 的公司提供的**創投支持**與**公司維運**的解決方案。這些產品在高品質的自動產生 SDK 之外,還提供**額外功能**與**整合**。 + +透過 ✨ [**贊助 FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨,這些公司幫助確保框架與其**生態系**維持健康且**永續**。 + +他們的贊助也展現對 FastAPI **社群**(你)的高度承諾,不僅關心提供**優良服務**,也支持 **FastAPI** 作為一個**穩健且蓬勃的框架**。🙇 + +例如,你可以嘗試: + +* Speakeasy +* Stainless +* liblab + +其中有些方案也可能是開源或提供免費方案,讓你不需財務承諾就能試用。其他商業的 SDK 產生器也不少,你可以在網路上找到。🤓 + +## 建立 TypeScript SDK { #create-a-typescript-sdk } + +先從一個簡單的 FastAPI 應用開始: + +{* ../../docs_src/generate_clients/tutorial001_py310.py hl[7:9,12:13,16:17,21] *} + +注意這些 *路徑操作* 為請求與回應的有效載荷定義了所用的模型,使用了 `Item` 與 `ResponseMessage` 這兩個模型。 + +### API 文件 { #api-docs } + +如果你前往 `/docs`,你會看到其中包含了請求要送出的資料與回應接收的資料之**結構(schemas)**: + + + +你之所以能看到這些結構,是因為它們在應用內以模型宣告了。 + +這些資訊都在應用的 **OpenAPI 結構**中,並顯示在 API 文件裡。 + +同樣包含在 OpenAPI 中的模型資訊,也可以用來**產生用戶端程式碼**。 + +### Hey API { #hey-api } + +當我們有含模型的 FastAPI 應用後,就能用 Hey API 來產生 TypeScript 用戶端。最快的方法是透過 npx: + +```sh +npx @hey-api/openapi-ts -i http://localhost:8000/openapi.json -o src/client +``` + +這會在 `./src/client` 產生一個 TypeScript SDK。 + +你可以在他們的網站了解如何安裝 `@hey-api/openapi-ts`,以及閱讀產生的輸出內容。 + +### 使用 SDK { #using-the-sdk } + +現在你可以匯入並使用用戶端程式碼。大致看起來會像這樣,你會發現方法有自動完成: + + + +你也會對要送出的有效載荷獲得自動完成: + + + +/// tip + +注意 `name` 與 `price` 的自動完成,這是由 FastAPI 應用中的 `Item` 模型所定義。 + +/// + +你在送出的資料上也會看到行內錯誤: + + + +回應物件同樣有自動完成: + + + +## 含標籤的 FastAPI 應用 { #fastapi-app-with-tags } + +在許多情況下,你的 FastAPI 應用會更大,你可能會用標籤將不同群組的 *路徑操作* 分開。 + +例如,你可以有一個 **items** 區塊與另一個 **users** 區塊,並透過標籤區分: + +{* ../../docs_src/generate_clients/tutorial002_py310.py hl[21,26,34] *} + +### 使用標籤產生 TypeScript 用戶端 { #generate-a-typescript-client-with-tags } + +若你為使用標籤的 FastAPI 應用產生用戶端,產生器通常也會依標籤將用戶端程式碼分開。 + +如此一來,用戶端程式碼就能有條理地正確分組與排列: + + + +在此例中,你會有: + +* `ItemsService` +* `UsersService` + +### 用戶端方法名稱 { #client-method-names } + +目前像 `createItemItemsPost` 這樣的產生方法名稱看起來不太俐落: + +```TypeScript +ItemsService.createItemItemsPost({name: "Plumbus", price: 5}) +``` + +……那是因為用戶端產生器對每個 *路徑操作* 都使用 OpenAPI 內部的**操作 ID(operation ID)**。 + +OpenAPI 要求每個操作 ID 在所有 *路徑操作* 之間必須唯一,因此 FastAPI 會用**函式名稱**、**路徑**與 **HTTP 方法/操作**來產生該操作 ID,如此便能確保操作 ID 的唯一性。 + +接下來我會示範如何把它變得更好看。🤓 + +## 自訂 Operation ID 與更好的方法名稱 { #custom-operation-ids-and-better-method-names } + +你可以**修改**這些操作 ID 的**產生方式**,讓它們更簡潔,並在用戶端中得到**更簡潔的方法名稱**。 + +在這種情況下,你需要用其他方式確保每個操作 ID 都是**唯一**的。 + +例如,你可以確保每個 *路徑操作* 都有標籤,接著根據**標籤**與 *路徑操作* 的**名稱**(函式名稱)來產生操作 ID。 + +### 自訂唯一 ID 產生函式 { #custom-generate-unique-id-function } + +FastAPI 會為每個 *路徑操作* 使用一個**唯一 ID**,它會被用於**操作 ID**,以及任何請求或回應所需的自訂模型名稱。 + +你可以自訂該函式。它接收一個 APIRoute 並回傳字串。 + +例如,下面使用第一個標籤(你通常只會有一個標籤)以及 *路徑操作* 的名稱(函式名稱)。 + +接著你可以將這個自訂函式以 `generate_unique_id_function` 參數傳給 **FastAPI**: + +{* ../../docs_src/generate_clients/tutorial003_py310.py hl[6:7,10] *} + +### 使用自訂 Operation ID 產生 TypeScript 用戶端 { #generate-a-typescript-client-with-custom-operation-ids } + +現在,如果你再次產生用戶端,會看到方法名稱已改善: + + + +如你所見,方法名稱現在包含標籤與函式名稱,不再包含 URL 路徑與 HTTP 操作的資訊。 + +### 為用戶端產生器預處理 OpenAPI 規格 { #preprocess-the-openapi-specification-for-the-client-generator } + +產生的程式碼仍有一些**重複資訊**。 + +我們已經知道這個方法與 **items** 相關,因為該字已出現在 `ItemsService`(取自標籤)中,但方法名稱仍然加上了標籤名稱做前綴。😕 + +對於 OpenAPI 本身,我們可能仍想保留,因為那能確保操作 ID 是**唯一**的。 + +但就產生用戶端而言,我們可以在產生前**修改** OpenAPI 的操作 ID,來讓方法名稱更**簡潔**、更**乾淨**。 + +我們可以把 OpenAPI JSON 下載到 `openapi.json` 檔案,然後用像這樣的腳本**移除該標籤前綴**: + +{* ../../docs_src/generate_clients/tutorial004_py310.py *} + +//// tab | Node.js + +```Javascript +{!> ../../docs_src/generate_clients/tutorial004.js!} +``` + +//// + +如此一來,操作 ID 會從 `items-get_items` 之類的字串,變成單純的 `get_items`,讓用戶端產生器能產生更簡潔的方法名稱。 + +### 使用預處理後的 OpenAPI 產生 TypeScript 用戶端 { #generate-a-typescript-client-with-the-preprocessed-openapi } + +由於最終結果現在是在 `openapi.json` 檔案中,你需要更新輸入位置: + +```sh +npx @hey-api/openapi-ts -i ./openapi.json -o src/client +``` + +產生新的用戶端後,你現在會得到**乾淨的方法名稱**,同時保有所有的**自動完成**、**行內錯誤**等功能: + + + +## 好處 { #benefits } + +使用自動產生的用戶端時,你會得到以下項目的**自動完成**: + +* 方法 +* 本文中的請求有效載荷、查詢參數等 +* 回應的有效載荷 + +你也會對所有內容獲得**行內錯誤**提示。 + +而且每當你更新後端程式碼並**重新產生**前端(用戶端),新的 *路徑操作* 會以方法形式可用、舊的會被移除,其他任何變更也都會反映到產生的程式碼中。🤓 + +這也代表只要有任何變更,便會自動**反映**到用戶端程式碼;而當你**建置**用戶端時,如果使用的資料有任何**不匹配**,就會直接報錯。 + +因此,你能在開發週期的很早期就**偵測到許多錯誤**,而不必等到錯誤在正式環境的最終使用者那裡才出現,然後才開始追查問題所在。✨ diff --git a/docs/zh-hant/docs/advanced/index.md b/docs/zh-hant/docs/advanced/index.md new file mode 100644 index 0000000000..cfbc17afec --- /dev/null +++ b/docs/zh-hant/docs/advanced/index.md @@ -0,0 +1,21 @@ +# 進階使用者指南 { #advanced-user-guide } + +## 更多功能 { #additional-features } + +主要的[教學 - 使用者指南](../tutorial/index.md){.internal-link target=_blank} 應足以帶你快速瀏覽 **FastAPI** 的所有核心功能。 + +在接下來的章節中,你會看到其他選項、設定,以及更多功能。 + +/// tip + +接下來的章節不一定「進階」。 + +而且對於你的使用情境,解法很可能就在其中某一節。 + +/// + +## 先閱讀教學 { #read-the-tutorial-first } + +只要掌握主要[教學 - 使用者指南](../tutorial/index.md){.internal-link target=_blank} 的內容,你就能使用 **FastAPI** 的大多數功能。 + +接下來的章節也假設你已經讀過,並已了解那些主要觀念。 diff --git a/docs/zh-hant/docs/advanced/middleware.md b/docs/zh-hant/docs/advanced/middleware.md new file mode 100644 index 0000000000..80cda345c3 --- /dev/null +++ b/docs/zh-hant/docs/advanced/middleware.md @@ -0,0 +1,97 @@ +# 進階中介軟體 { #advanced-middleware } + +在主要教學中你已學過如何將[自訂中介軟體](../tutorial/middleware.md){.internal-link target=_blank}加入到你的應用程式。 + +你也讀過如何使用 `CORSMiddleware` 處理 [CORS](../tutorial/cors.md){.internal-link target=_blank}。 + +本節將示範如何使用其他中介軟體。 + +## 新增 ASGI 中介軟體 { #adding-asgi-middlewares } + +由於 **FastAPI** 建立在 Starlette 上並實作了 ASGI 規範,你可以使用任何 ASGI 中介軟體。 + +中介軟體不一定要為 FastAPI 或 Starlette 專門撰寫,只要遵循 ASGI 規範即可運作。 + +一般來說,ASGI 中介軟體是類別,預期第一個參數接收一個 ASGI 應用程式。 + +因此,在第三方 ASGI 中介軟體的文件中,通常會指示你這樣做: + +```Python +from unicorn import UnicornMiddleware + +app = SomeASGIApp() + +new_app = UnicornMiddleware(app, some_config="rainbow") +``` + +但 FastAPI(實際上是 Starlette)提供了一種更簡單的方式,確保內部中介軟體能處理伺服器錯誤,且自訂例外處理器可正常運作。 + +為此,你可以使用 `app.add_middleware()`(如同 CORS 範例)。 + +```Python +from fastapi import FastAPI +from unicorn import UnicornMiddleware + +app = FastAPI() + +app.add_middleware(UnicornMiddleware, some_config="rainbow") +``` + +`app.add_middleware()` 將中介軟體類別作為第一個引數,並接收要傳遞給該中介軟體的其他引數。 + +## 內建中介軟體 { #integrated-middlewares } + +**FastAPI** 內建數個常見用途的中介軟體,以下將示範如何使用。 + +/// note | 技術細節 + +在接下來的範例中,你也可以使用 `from starlette.middleware.something import SomethingMiddleware`。 + +**FastAPI** 在 `fastapi.middleware` 中提供了一些中介軟體,純粹是為了方便你這位開發者。但大多數可用的中介軟體直接來自 Starlette。 + +/// + +## `HTTPSRedirectMiddleware` { #httpsredirectmiddleware } + +強制所有傳入請求必須使用 `https` 或 `wss`。 + +任何指向 `http` 或 `ws` 的請求都會被重新導向至對應的安全協定。 + +{* ../../docs_src/advanced_middleware/tutorial001_py310.py hl[2,6] *} + +## `TrustedHostMiddleware` { #trustedhostmiddleware } + +強制所有傳入請求正確設定 `Host` 標頭,以防範 HTTP Host Header 攻擊。 + +{* ../../docs_src/advanced_middleware/tutorial002_py310.py hl[2,6:8] *} + +支援以下參數: + +- `allowed_hosts` - 允許作為主機名稱的網域名稱清單。支援萬用字元網域(例如 `*.example.com`)以比對子網域。若要允許任意主機名稱,可使用 `allowed_hosts=["*"]`,或乾脆不要加上此中介軟體。 +- `www_redirect` - 若設為 True,對允許主機的不含 www 版本的請求會被重新導向至其 www 對應版本。預設為 `True`。 + +若傳入請求驗證失敗,將回傳 `400` 回應。 + +## `GZipMiddleware` { #gzipmiddleware } + +處理在 `Accept-Encoding` 標頭中包含 `"gzip"` 的請求之 GZip 壓縮回應。 + +此中介軟體會處理一般與串流回應。 + +{* ../../docs_src/advanced_middleware/tutorial003_py310.py hl[2,6] *} + +支援以下參數: + +- `minimum_size` - 小於此位元組大小的回應不會進行 GZip。預設為 `500`。 +- `compresslevel` - GZip 壓縮時使用的等級。為 1 到 9 的整數。預設為 `9`。值越小壓縮越快但檔案較大,值越大壓縮較慢但檔案較小。 + +## 其他中介軟體 { #other-middlewares } + +還有許多其他 ASGI 中介軟體。 + +例如: + +- Uvicorn 的 `ProxyHeadersMiddleware` +- MessagePack + +想瞭解更多可用的中介軟體,請參考 Starlette 的中介軟體文件ASGI 精選清單。 diff --git a/docs/zh-hant/docs/advanced/openapi-callbacks.md b/docs/zh-hant/docs/advanced/openapi-callbacks.md new file mode 100644 index 0000000000..b1a16be249 --- /dev/null +++ b/docs/zh-hant/docs/advanced/openapi-callbacks.md @@ -0,0 +1,186 @@ +# OpenAPI 回呼 { #openapi-callbacks } + +你可以建立一個含有「路徑操作(path operation)」的 API,該操作會觸發對某個「外部 API(external API)」的請求(通常由使用你 API 的同一位開發者提供)。 + +當你的 API 應用呼叫「外部 API」時發生的過程稱為「回呼(callback)」。因為外部開發者撰寫的軟體會先向你的 API 發出請求,接著你的 API 再「回呼」,也就是向(可能同一位開發者建立的)外部 API 發送請求。 + +在這種情況下,你可能想要文件化說明該外部 API 應該長什麼樣子。它應該有哪些「路徑操作」、應該接受什麼 body、應該回傳什麼 response,等等。 + +## 帶有回呼的應用 { #an-app-with-callbacks } + +我們用一個例子來看。 + +想像你開發了一個允許建立發票的應用。 + +這些發票會有 `id`、`title`(可選)、`customer` 和 `total`。 + +你的 API 的使用者(外部開發者)會透過一個 POST 請求在你的 API 中建立一張發票。 + +然後你的 API 會(讓我們想像): + +* 將發票寄給該外部開發者的某位客戶。 +* 代收款項。 +* 再把通知回傳給 API 使用者(外部開發者)。 + * 這會透過從「你的 API」向該外部開發者提供的「外部 API」送出 POST 請求完成(這就是「回呼」)。 + +## 一般的 **FastAPI** 應用 { #the-normal-fastapi-app } + +先看看在加入回呼之前,一個一般的 API 應用會長什麼樣子。 + +它會有一個接收 `Invoice` body 的「路徑操作」,以及一個查詢參數 `callback_url`,其中包含用於回呼的 URL。 + +這部分很正常,多數程式碼你應該已經很熟悉了: + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[7:11,34:51] *} + +/// tip + +`callback_url` 查詢參數使用的是 Pydantic 的 Url 型別。 + +/// + +唯一新的地方是在「路徑操作裝飾器」中加入參數 `callbacks=invoices_callback_router.routes`。我們接下來會看到那是什麼。 + +## 文件化回呼 { #documenting-the-callback } + +實際的回呼程式碼會高度依賴你的 API 應用本身。 + +而且很可能每個應用都差很多。 + +它可能就只有一兩行,例如: + +```Python +callback_url = "https://example.com/api/v1/invoices/events/" +httpx.post(callback_url, json={"description": "Invoice paid", "paid": True}) +``` + +但回呼中最重要的部分,可能是在確保你的 API 使用者(外部開發者)能正確實作「外部 API」,符合「你的 API」在回呼請求 body 中要送出的資料格式,等等。 + +因此,接下來我們要加上用來「文件化」說明,該「外部 API」應該長什麼樣子,才能接收來自「你的 API」的回呼。 + +這份文件會出現在你的 API 的 Swagger UI `/docs`,讓外部開發者知道該如何建置「外部 API」。 + +這個範例不會實作回呼本身(那可能就只是一行程式碼),只會實作文件的部分。 + +/// tip + +實際的回呼就是一個 HTTP 請求。 + +當你自己實作回呼時,可以使用像是 HTTPXRequests。 + +/// + +## 撰寫回呼的文件化程式碼 { #write-the-callback-documentation-code } + +這段程式碼在你的應用中不會被執行,我們只需要它來「文件化」說明那個「外部 API」應該長什麼樣子。 + +不過,你已經知道如何用 **FastAPI** 輕鬆為 API 建立自動文件。 + +所以我們會用同樣的方式,來文件化「外部 API」應該長什麼樣子... 也就是建立外部 API 應該實作的「路徑操作(們)」(那些「你的 API」會去呼叫的操作)。 + +/// tip + +在撰寫回呼的文件化程式碼時,把自己想像成那位「外部開發者」會很有幫助。而且你現在是在實作「外部 API」,不是「你的 API」。 + +暫時採用這個(外部開發者)的視角,有助於讓你更直覺地決定該把參數、body 的 Pydantic 模型、response 的模型等放在哪裡,對於那個「外部 API」會更清楚。 + +/// + +### 建立一個回呼用的 `APIRouter` { #create-a-callback-apirouter } + +先建立一個新的 `APIRouter`,用來放一個或多個回呼。 + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[1,23] *} + +### 建立回呼的「路徑操作」 { #create-the-callback-path-operation } + +要建立回呼的「路徑操作」,就使用你上面建立的同一個 `APIRouter`。 + +它看起來就像一般的 FastAPI「路徑操作」: + +* 可能需要宣告它應該接收的 body,例如 `body: InvoiceEvent`。 +* 也可以宣告它應該回傳的 response,例如 `response_model=InvoiceEventReceived`。 + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[14:16,19:20,26:30] *} + +和一般「路徑操作」相比有兩個主要差異: + +* 不需要任何實際程式碼,因為你的應用永遠不會呼叫這段程式。它只用來文件化「外部 API」。因此函式可以只有 `pass`。 +* 「路徑」可以包含一個 OpenAPI 3 表達式(見下文),可使用參數與原始送到「你的 API」的請求中的部分欄位。 + +### 回呼路徑表達式 { #the-callback-path-expression } + +回呼的「路徑」可以包含一個 OpenAPI 3 表達式,能引用原本送到「你的 API」的請求中的部分內容。 + +在這個例子中,它是一個 `str`: + +```Python +"{$callback_url}/invoices/{$request.body.id}" +``` + +所以,如果你的 API 使用者(外部開發者)向「你的 API」送出這樣的請求: + +``` +https://yourapi.com/invoices/?callback_url=https://www.external.org/events +``` + +並附上這個 JSON body: + +```JSON +{ + "id": "2expen51ve", + "customer": "Mr. Richie Rich", + "total": "9999" +} +``` + +那麼「你的 API」會處理這張發票,並在稍後某個時點,向 `callback_url`(也就是「外部 API」)送出回呼請求: + +``` +https://www.external.org/events/invoices/2expen51ve +``` + +其 JSON body 大致包含: + +```JSON +{ + "description": "Payment celebration", + "paid": true +} +``` + +而它會預期該「外部 API」回傳的 JSON body 例如: + +```JSON +{ + "ok": true +} +``` + +/// tip + +注意回呼所用的 URL,包含了在查詢參數 `callback_url` 中收到的 URL(`https://www.external.org/events`),以及來自 JSON body 內的發票 `id`(`2expen51ve`)。 + +/// + +### 加入回呼 router { #add-the-callback-router } + +此時你已經在先前建立的回呼 router 中,擁有所需的回呼「路徑操作(們)」(也就是「外部開發者」應該在「外部 API」中實作的那些)。 + +現在在「你的 API 的路徑操作裝飾器」中使用參數 `callbacks`,將該回呼 router 的屬性 `.routes`(實際上就是一個由路由/「路徑操作」所組成的 `list`)傳入: + +{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[33] *} + +/// tip + +注意你傳給 `callback=` 的不是整個 router 本身(`invoices_callback_router`),而是它的屬性 `.routes`,也就是 `invoices_callback_router.routes`。 + +/// + +### 檢查文件 { #check-the-docs } + +現在你可以啟動應用,並前往 http://127.0.0.1:8000/docs。 + +你會在文件中看到你的「路徑操作」包含一個「Callbacks」區塊,顯示「外部 API」應該長什麼樣子: + + diff --git a/docs/zh-hant/docs/advanced/openapi-webhooks.md b/docs/zh-hant/docs/advanced/openapi-webhooks.md new file mode 100644 index 0000000000..ef52c3884f --- /dev/null +++ b/docs/zh-hant/docs/advanced/openapi-webhooks.md @@ -0,0 +1,55 @@ +# OpenAPI Webhook { #openapi-webhooks } + +有些情況下,你會想告訴你的 API 使用者,你的應用程式可能會攜帶一些資料去呼叫他們的應用程式(發送請求),通常是為了通知某種類型的事件。 + +這表示,與其由使用者向你的 API 發送請求,改為你的 API(或你的應用)可能會向他們的系統(他們的 API、他們的應用)發送請求。 + +這通常稱為 webhook。 + +## Webhook 步驟 { #webhooks-steps } + +流程通常是:你在程式碼中定義要發送的訊息,也就是請求的主體(request body)。 + +你也會以某種方式定義應用在哪些時刻會發送那些請求或事件。 + +而你的使用者則會以某種方式(例如在某個 Web 控制台)設定你的應用應該將這些請求送往的 URL。 + +關於如何註冊 webhook 的 URL,以及實際發送那些請求的程式碼等所有邏輯,都由你決定。你可以在自己的程式碼中用你想要的方式撰寫。 + +## 使用 FastAPI 與 OpenAPI 記錄 webhook { #documenting-webhooks-with-fastapi-and-openapi } + +在 FastAPI 中,透過 OpenAPI,你可以定義這些 webhook 的名稱、你的應用將發送的 HTTP 操作類型(例如 `POST`、`PUT` 等),以及你的應用要發送的請求主體。 + +這能讓你的使用者更容易實作他們的 API 以接收你的 webhook 請求,甚至可能自動產生部分他們自己的 API 程式碼。 + +/// info + +Webhook 功能自 OpenAPI 3.1.0 起提供,FastAPI `0.99.0` 以上版本支援。 + +/// + +## 含有 webhook 的應用 { #an-app-with-webhooks } + +建立 FastAPI 應用時,會有一個 `webhooks` 屬性可用來定義 webhook,方式與定義路徑操作相同,例如使用 `@app.webhooks.post()`。 + +{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *} + +你定義的 webhook 會出現在 OpenAPI 結構描述與自動產生的文件 UI 中。 + +/// info + +`app.webhooks` 其實就是一個 `APIRouter`,與你在將應用拆分為多個檔案時所使用的型別相同。 + +/// + +注意,使用 webhook 時你其實不是在宣告路徑(例如 `/items/`),你傳入的文字只是該 webhook 的識別名稱(事件名稱)。例如在 `@app.webhooks.post("new-subscription")` 中,webhook 名稱是 `new-subscription`。 + +這是因為預期由你的使用者以其他方式(例如 Web 控制台)來設定實際要接收 webhook 請求的 URL 路徑。 + +### 查看文件 { #check-the-docs } + +現在你可以啟動應用,然後前往 http://127.0.0.1:8000/docs。 + +你會在文件中看到一般的路徑操作,另外還有一些 webhook: + + diff --git a/docs/zh-hant/docs/advanced/path-operation-advanced-configuration.md b/docs/zh-hant/docs/advanced/path-operation-advanced-configuration.md new file mode 100644 index 0000000000..4f25eb9878 --- /dev/null +++ b/docs/zh-hant/docs/advanced/path-operation-advanced-configuration.md @@ -0,0 +1,172 @@ +# 路徑操作進階設定 { #path-operation-advanced-configuration } + +## OpenAPI operationId { #openapi-operationid } + +/// warning + +如果你不是 OpenAPI 的「專家」,大概不需要這個。 + +/// + +你可以用參數 `operation_id` 為你的*路徑操作(path operation)*設定要使用的 OpenAPI `operationId`。 + +你必須確保每個操作的 `operationId` 都是唯一的。 + +{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py310.py hl[6] *} + +### 使用路徑操作函式(path operation function)的名稱作為 operationId { #using-the-path-operation-function-name-as-the-operationid } + +如果你想用 API 的函式名稱作為 `operationId`,你可以遍歷所有路徑,並使用各自的 `APIRoute.name` 覆寫每個*路徑操作*的 `operation_id`。 + +應在加入所有*路徑操作*之後再這麼做。 + +{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py310.py hl[2, 12:21, 24] *} + +/// tip + +如果你會手動呼叫 `app.openapi()`,請務必先更新所有 `operationId` 再呼叫。 + +/// + +/// warning + +如果你這樣做,必須確保每個*路徑操作函式*都有唯一的名稱, + +即使它們位於不同的模組(Python 檔案)中。 + +/// + +## 從 OpenAPI 排除 { #exclude-from-openapi } + +若要從產生的 OpenAPI 結構(也就是自動文件系統)中排除某個*路徑操作*,使用參數 `include_in_schema` 並將其設為 `False`: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *} + +## 從 docstring 提供進階描述 { #advanced-description-from-docstring } + +你可以限制 OpenAPI 從*路徑操作函式*的 docstring 中使用的內容行數。 + +加上一個 `\f`(跳頁字元,form feed)會讓 FastAPI 在此處截斷用於 OpenAPI 的輸出。 + +這個字元不會出現在文件中,但其他工具(例如 Sphinx)仍可使用其後的內容。 + +{* ../../docs_src/path_operation_advanced_configuration/tutorial004_py310.py hl[17:27] *} + +## 額外回應 { #additional-responses } + +你大概已看過如何為*路徑操作*宣告 `response_model` 與 `status_code`。 + +這會定義該*路徑操作*主要回應的中繼資料。 + +你也可以宣告額外的回應及其模型、狀態碼等。 + +文件中有完整章節說明,請見 [OpenAPI 中的額外回應](additional-responses.md){.internal-link target=_blank}。 + +## OpenAPI 額外資訊 { #openapi-extra } + +當你在應用程式中宣告一個*路徑操作*時,FastAPI 會自動產生該*路徑操作*的相關中繼資料,並納入 OpenAPI 結構中。 + +/// note | 技術細節 + +在 OpenAPI 規格中,這稱為 Operation 物件。 + +/// + +它包含關於*路徑操作*的所有資訊,並用於產生自動文件。 + +其中包含 `tags`、`parameters`、`requestBody`、`responses` 等。 + +這個針對單一路徑操作的 OpenAPI 結構通常由 FastAPI 自動產生,但你也可以擴充它。 + +/// tip + +這是一個較低階的擴充介面。 + +如果你只需要宣告額外回應,更方便的方式是使用 [OpenAPI 中的額外回應](additional-responses.md){.internal-link target=_blank}。 + +/// + +你可以使用參數 `openapi_extra` 來擴充某個*路徑操作*的 OpenAPI 結構。 + +### OpenAPI 擴充 { #openapi-extensions } + +`openapi_extra` 可用來宣告例如 [OpenAPI 擴充](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions) 的資料: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial005_py310.py hl[6] *} + +打開自動產生的 API 文件時,你的擴充會顯示在該*路徑操作*頁面的底部。 + + + +而在檢視產生出的 OpenAPI(位於你的 API 的 `/openapi.json`)時,也可以在相應*路徑操作*中看到你的擴充: + +```JSON hl_lines="22" +{ + "openapi": "3.1.0", + "info": { + "title": "FastAPI", + "version": "0.1.0" + }, + "paths": { + "/items/": { + "get": { + "summary": "Read Items", + "operationId": "read_items_items__get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-aperture-labs-portal": "blue" + } + } + } +} +``` + +### 自訂 OpenAPI 路徑操作結構 { #custom-openapi-path-operation-schema } + +`openapi_extra` 中的字典會與自動產生的該*路徑操作*之 OpenAPI 結構進行深度合併。 + +因此你可以在自動產生的結構上加入額外資料。 + +例如,你可以選擇用自己的程式碼讀取並驗證請求,而不使用 FastAPI 與 Pydantic 的自動功能,但仍然希望在 OpenAPI 結構中定義該請求。 + +你可以透過 `openapi_extra` 辦到: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial006_py310.py hl[19:36, 39:40] *} + +在這個範例中,我們沒有宣告任何 Pydantic 模型。事實上,請求本文甚至不會被 解析 為 JSON,而是直接以 `bytes` 讀取,並由函式 `magic_data_reader()` 以某種方式負責解析。 + +儘管如此,我們仍可宣告請求本文的預期結構。 + +### 自訂 OpenAPI Content-Type { #custom-openapi-content-type } + +用同樣的方法,你可以使用 Pydantic 模型來定義 JSON Schema,並把它包含到該*路徑操作*的自訂 OpenAPI 區段中。 + +即使請求中的資料型別不是 JSON 也可以這麼做。 + +例如,在這個應用中,我們不使用 FastAPI 內建的從 Pydantic 模型擷取 JSON Schema 的功能,也不使用 JSON 的自動驗證。實際上,我們將請求的 content type 宣告為 YAML,而非 JSON: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py310.py hl[15:20, 22] *} + +儘管沒有使用預設的內建功能,我們仍透過 Pydantic 模型手動產生想以 YAML 接收之資料的 JSON Schema。 + +接著我們直接使用請求,並將本文擷取為 `bytes`。這表示 FastAPI 甚至不會嘗試把請求負載解析為 JSON。 + +然後在程式中直接解析該 YAML 內容,並再次使用相同的 Pydantic 模型來驗證該 YAML 內容: + +{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py310.py hl[24:31] *} + +/// tip + +這裡我們重複使用同一個 Pydantic 模型。 + +不過也可以用其他方式進行驗證。 + +/// diff --git a/docs/zh-hant/docs/advanced/response-change-status-code.md b/docs/zh-hant/docs/advanced/response-change-status-code.md new file mode 100644 index 0000000000..4b8d459ca2 --- /dev/null +++ b/docs/zh-hant/docs/advanced/response-change-status-code.md @@ -0,0 +1,31 @@ +# 回應 - 變更狀態碼 { #response-change-status-code } + +你可能已經讀過,可以設定預設的[回應狀態碼](../tutorial/response-status-code.md){.internal-link target=_blank}。 + +但有些情況你需要回傳與預設不同的狀態碼。 + +## 使用情境 { #use-case } + +例如,假設你預設想回傳 HTTP 狀態碼 "OK" `200`。 + +但如果資料不存在,你想要建立它,並回傳 HTTP 狀態碼 "CREATED" `201`。 + +同時你仍希望能用 `response_model` 過濾並轉換所回傳的資料。 + +在這些情況下,你可以使用 `Response` 參數。 + +## 使用 `Response` 參數 { #use-a-response-parameter } + +你可以在你的路徑操作函式(path operation function)中宣告一個 `Response` 型別的參數(就像你可以對 Cookies 和標頭那樣)。 + +接著你可以在那個「*暫時的*」回應物件上設定 `status_code`。 + +{* ../../docs_src/response_change_status_code/tutorial001_py310.py hl[1,9,12] *} + +然後你可以照常回傳任何需要的物件(例如 `dict`、資料庫模型等)。 + +若你宣告了 `response_model`,它仍會被用來過濾並轉換你回傳的物件。 + +FastAPI 會使用那個「*暫時的*」回應來取得狀態碼(以及 Cookies 和標頭),並將它們放入最終回應中;最終回應包含你回傳的值,且會被任何 `response_model` 過濾。 + +你也可以在相依性(dependencies)中宣告 `Response` 參數,並在其中設定狀態碼。但請注意,最後被設定的值會生效。 diff --git a/docs/zh-hant/docs/advanced/response-cookies.md b/docs/zh-hant/docs/advanced/response-cookies.md new file mode 100644 index 0000000000..b7225d571c --- /dev/null +++ b/docs/zh-hant/docs/advanced/response-cookies.md @@ -0,0 +1,51 @@ +# 回應 Cookie { #response-cookies } + +## 使用 `Response` 參數 { #use-a-response-parameter } + +你可以在路徑操作函式(path operation function)中宣告一個型別為 `Response` 的參數。 + +接著你可以在那個「暫時」的 `Response` 物件上設定 Cookie。 + +{* ../../docs_src/response_cookies/tutorial002_py310.py hl[1, 8:9] *} + +之後如常回傳你需要的任何物件(例如 `dict`、資料庫模型等)。 + +如果你宣告了 `response_model`,它仍會用來過濾並轉換你回傳的物件。 + +FastAPI 會使用那個暫時的 `Response` 取出 Cookie(以及標頭與狀態碼),並將它們放入最終回應;最終回應包含你回傳的值,且會套用任何 `response_model` 的過濾。 + +你也可以在相依項(dependencies)中宣告 `Response` 參數,並在其中設定 Cookie(與標頭)。 + +## 直接回傳 `Response` { #return-a-response-directly } + +當你在程式碼中直接回傳 `Response` 時,也可以建立 Cookie。 + +要這麼做,你可以依照 [直接回傳 Response](response-directly.md){.internal-link target=_blank} 中的說明建立一個回應。 + +接著在其中設定 Cookie,然後回傳它: + +{* ../../docs_src/response_cookies/tutorial001_py310.py hl[10:12] *} + +/// tip | 提示 + +請注意,如果你不是使用 `Response` 參數,而是直接回傳一個 `Response`,FastAPI 會原樣回傳它。 + +因此你必須確保資料型別正確;例如,如果你回傳的是 `JSONResponse`,就要確保資料可與 JSON 相容。 + +同時也要確認沒有送出原本應該由 `response_model` 過濾的資料。 + +/// + +### 更多資訊 { #more-info } + +/// note | 技術細節 + +你也可以使用 `from starlette.responses import Response` 或 `from starlette.responses import JSONResponse`。 + +為了方便開發者,FastAPI 也將相同的 `starlette.responses` 透過 `fastapi.responses` 提供。不過,大多數可用的回應類別都直接來自 Starlette。 + +另外由於 `Response` 常用於設定標頭與 Cookie,FastAPI 也在 `fastapi.Response` 提供了它。 + +/// + +想查看所有可用的參數與選項,請參閱 Starlette 文件。 diff --git a/docs/zh-hant/docs/advanced/response-directly.md b/docs/zh-hant/docs/advanced/response-directly.md new file mode 100644 index 0000000000..5603548934 --- /dev/null +++ b/docs/zh-hant/docs/advanced/response-directly.md @@ -0,0 +1,65 @@ +# 直接回傳 Response { #return-a-response-directly } + +當你建立一個 **FastAPI** 的路徑操作 (path operation) 時,通常可以從中回傳任何資料:`dict`、`list`、Pydantic 模型、資料庫模型等。 + +預設情況下,**FastAPI** 會使用在[JSON 相容編碼器](../tutorial/encoder.md){.internal-link target=_blank}中說明的 `jsonable_encoder`,自動將回傳值轉為 JSON。 + +然後在幕後,它會把這些與 JSON 相容的資料(例如 `dict`)放進 `JSONResponse`,用來把回應傳回給用戶端。 + +但你也可以直接從路徑操作回傳 `JSONResponse`。 + +例如,當你需要回傳自訂的 headers 或 cookies 時就很有用。 + +## 回傳 `Response` { #return-a-response } + +其實,你可以回傳任何 `Response`,或其任何子類別。 + +/// tip + +`JSONResponse` 本身就是 `Response` 的子類別。 + +/// + +當你回傳一個 `Response` 時,**FastAPI** 會直接傳遞它。 + +它不會對 Pydantic 模型做任何資料轉換,也不會把內容轉成其他型別等。 + +這給了你很大的彈性。你可以回傳任何資料型別、覆寫任何資料宣告或驗證等。 + +## 在 `Response` 中使用 `jsonable_encoder` { #using-the-jsonable-encoder-in-a-response } + +因為 **FastAPI** 不會對你回傳的 `Response` 做任何更動,你需要自行確保它的內容已經準備好。 + +例如,你不能直接把一個 Pydantic 模型放進 `JSONResponse`,需要先把它轉成 `dict`,並將所有資料型別(像是 `datetime`、`UUID` 等)轉成與 JSON 相容的型別。 + +在這些情況下,你可以先用 `jsonable_encoder` 把資料轉好,再傳給回應物件: + +{* ../../docs_src/response_directly/tutorial001_py310.py hl[5:6,20:21] *} + +/// note | 技術細節 + +你也可以使用 `from starlette.responses import JSONResponse`。 + +**FastAPI** 為了方便開發者,將 `starlette.responses` 也提供為 `fastapi.responses`。但大多數可用的回應類型其實直接來自 Starlette。 + +/// + +## 回傳自訂 `Response` { #returning-a-custom-response } + +上面的範例展示了所需的各個部分,但目前還不太實用,因為你其實可以直接回傳 `item`,**FastAPI** 就會幫你把它放進 `JSONResponse`,轉成 `dict` 等,這些都是預設行為。 + +現在來看看如何用它來回傳自訂回應。 + +假設你想要回傳一個 XML 回應。 + +你可以把 XML 內容放進一個字串,把它放進 `Response`,然後回傳它: + +{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *} + +## 注意事項 { #notes } + +當你直接回傳 `Response` 時,其資料不會自動被驗證、轉換(序列化)或文件化。 + +但你仍然可以依照[在 OpenAPI 中的額外回應](additional-responses.md){.internal-link target=_blank}中的說明進行文件化。 + +在後續章節中,你會看到如何在仍保有自動資料轉換、文件化等的同時,使用/宣告這些自訂的 `Response`。 diff --git a/docs/zh-hant/docs/advanced/response-headers.md b/docs/zh-hant/docs/advanced/response-headers.md new file mode 100644 index 0000000000..6e32ca1b39 --- /dev/null +++ b/docs/zh-hant/docs/advanced/response-headers.md @@ -0,0 +1,41 @@ +# 回應標頭 { #response-headers } + +## 使用 `Response` 參數 { #use-a-response-parameter } + +你可以在你的*路徑操作函式(path operation function)*中宣告一個 `Response` 型別的參數(就像處理 Cookie 一樣)。 + +然後你可以在那個*暫時性的* `Response` 物件上設定標頭。 + +{* ../../docs_src/response_headers/tutorial002_py310.py hl[1, 7:8] *} + +接著你可以像平常一樣回傳任何你需要的物件(`dict`、資料庫模型等)。 + +如果你宣告了 `response_model`,它仍會用來過濾並轉換你回傳的物件。 + +FastAPI 會使用那個暫時性的回應來擷取標頭(還有 Cookie 與狀態碼),並把它們放到最終回應中;最終回應包含你回傳的值,且會依任何 `response_model` 進行過濾。 + +你也可以在依賴中宣告 `Response` 參數,並在其中設定標頭(與 Cookie)。 + +## 直接回傳 `Response` { #return-a-response-directly } + +當你直接回傳 `Response` 時,也能加入標頭。 + +依照[直接回傳 Response](response-directly.md){.internal-link target=_blank}中的說明建立回應,並把標頭作為額外參數傳入: + +{* ../../docs_src/response_headers/tutorial001_py310.py hl[10:12] *} + +/// note | 技術細節 + +你也可以使用 `from starlette.responses import Response` 或 `from starlette.responses import JSONResponse`。 + +為了方便開發者,FastAPI 提供與 `starlette.responses` 相同的內容於 `fastapi.responses`。但大多數可用的回應類型其實直接來自 Starlette。 + +由於 `Response` 常用來設定標頭與 Cookie,FastAPI 也在 `fastapi.Response` 提供了它。 + +/// + +## 自訂標頭 { #custom-headers } + +請記住,專有的自訂標頭可以使用 `X-` 前綴來新增。 + +但如果你有自訂標頭並希望瀏覽器端的客戶端能看見它們,你需要把這些標頭加入到 CORS 設定中(詳見 [CORS(跨來源資源共用)](../tutorial/cors.md){.internal-link target=_blank}),使用在Starlette 的 CORS 文件中記載的 `expose_headers` 參數。 diff --git a/docs/zh-hant/docs/advanced/security/http-basic-auth.md b/docs/zh-hant/docs/advanced/security/http-basic-auth.md new file mode 100644 index 0000000000..ea3d528292 --- /dev/null +++ b/docs/zh-hant/docs/advanced/security/http-basic-auth.md @@ -0,0 +1,107 @@ +# HTTP 基本認證 { #http-basic-auth } + +在最簡單的情況下,你可以使用 HTTP Basic 認證。 + +在 HTTP Basic 認證中,應用程式會期待一個包含使用者名稱與密碼的標頭。 + +如果沒有接收到,會回傳 HTTP 401「Unauthorized」錯誤。 + +並回傳一個 `WWW-Authenticate` 標頭,其值為 `Basic`,以及可選的 `realm` 參數。 + +這會告訴瀏覽器顯示內建的使用者名稱與密碼提示視窗。 + +接著,當你輸入該使用者名稱與密碼時,瀏覽器會自動在標頭中送出它們。 + +## 簡單的 HTTP 基本認證 { #simple-http-basic-auth } + +- 匯入 `HTTPBasic` 與 `HTTPBasicCredentials`。 +- 使用 `HTTPBasic` 建立一個「`security` scheme」。 +- 在你的*路徑操作*中以依賴的方式使用該 `security`。 +- 它會回傳一個 `HTTPBasicCredentials` 型別的物件: + - 其中包含傳來的 `username` 與 `password`。 + +{* ../../docs_src/security/tutorial006_an_py310.py hl[4,8,12] *} + +當你第一次嘗試開啟該 URL(或在文件中點擊 "Execute" 按鈕)時,瀏覽器會要求輸入你的使用者名稱與密碼: + + + +## 檢查使用者名稱 { #check-the-username } + +以下是一個更完整的範例。 + +使用一個依賴來檢查使用者名稱與密碼是否正確。 + +為此,使用 Python 標準模組 `secrets` 來比對使用者名稱與密碼。 + +`secrets.compare_digest()` 需要接收 `bytes`,或是只包含 ASCII 字元(英文字符)的 `str`。這表示它無法處理像 `á` 這樣的字元,例如 `Sebastián`。 + +為了處理這點,我們會先將 `username` 與 `password` 以 UTF-8 編碼成 `bytes`。 + +接著我們可以使用 `secrets.compare_digest()` 來確認 `credentials.username` 等於 `"stanleyjobson"`,而 `credentials.password` 等於 `"swordfish"`。 + +{* ../../docs_src/security/tutorial007_an_py310.py hl[1,12:24] *} + +這大致等同於: + +```Python +if not (credentials.username == "stanleyjobson") or not (credentials.password == "swordfish"): + # 回傳錯誤 + ... +``` + +但藉由使用 `secrets.compare_digest()`,可以防禦一種稱為「計時攻擊」的攻擊。 + +### 計時攻擊 { #timing-attacks } + +什麼是「計時攻擊」呢? + +想像有攻擊者在嘗試猜測使用者名稱與密碼。 + +他們送出一個帶有使用者名稱 `johndoe` 與密碼 `love123` 的請求。 + +接著,你的應用程式中的 Python 程式碼等同於: + +```Python +if "johndoe" == "stanleyjobson" and "love123" == "swordfish": + ... +``` + +當 Python 比較 `johndoe` 的第一個 `j` 與 `stanleyjobson` 的第一個 `s` 時,會立刻回傳 `False`,因為已經知道兩個字串不同,覺得「沒必要浪費計算資源繼續比較剩下的字元」。你的應用程式便會回應「Incorrect username or password」。 + +但接著攻擊者改用使用者名稱 `stanleyjobsox` 與密碼 `love123` 嘗試。 + +你的應用程式程式碼會做類似: + +```Python +if "stanleyjobsox" == "stanleyjobson" and "love123" == "swordfish": + ... +``` + +Python 會必須先比較完整的 `stanleyjobso`(在 `stanleyjobsox` 與 `stanleyjobson` 之中都一樣),才會發現兩個字串不同。因此回覆「Incorrect username or password」會多花一些微秒。 + +#### 回應時間幫了攻擊者 { #the-time-to-answer-helps-the-attackers } + +此時,透過觀察伺服器回覆「Incorrect username or password」多花了幾個微秒,攻擊者就知道他們有某些地方猜對了,前幾個字母是正確的。 + +接著他們會再嘗試,知道它更可能接近 `stanleyjobsox` 而不是 `johndoe`。 + +#### 「專業」的攻擊 { #a-professional-attack } + +當然,攻擊者不會手動嘗試這一切,他們會寫程式來做,可能每秒進行上千或上百萬次測試,一次只多猜中一個正確字母。 + +但這樣做,幾分鐘或幾小時內,他們就能在我們應用程式「協助」下,僅靠回應時間就猜出正確的使用者名稱與密碼。 + +#### 用 `secrets.compare_digest()` 修正 { #fix-it-with-secrets-compare-digest } + +但在我們的程式碼中實際使用的是 `secrets.compare_digest()`。 + +簡而言之,將 `stanleyjobsox` 與 `stanleyjobson` 比較所花的時間,會與將 `johndoe` 與 `stanleyjobson` 比較所花的時間相同;密碼也一樣。 + +如此一來,在應用程式程式碼中使用 `secrets.compare_digest()`,就能安全地防禦這整類的安全攻擊。 + +### 回傳錯誤 { #return-the-error } + +在偵測到憑證不正確之後,回傳一個狀態碼為 401 的 `HTTPException`(與未提供憑證時相同),並加上 `WWW-Authenticate` 標頭,讓瀏覽器再次顯示登入提示: + +{* ../../docs_src/security/tutorial007_an_py310.py hl[26:30] *} diff --git a/docs/zh-hant/docs/advanced/security/index.md b/docs/zh-hant/docs/advanced/security/index.md new file mode 100644 index 0000000000..9a4cfbbfd6 --- /dev/null +++ b/docs/zh-hant/docs/advanced/security/index.md @@ -0,0 +1,19 @@ +# 進階安全性 { #advanced-security } + +## 額外功能 { #additional-features } + +除了[教學 - 使用者指南:安全性](../../tutorial/security/index.md){.internal-link target=_blank}中涵蓋的內容外,還有一些用來處理安全性的額外功能。 + +/// tip + +以下各節不一定是「進階」內容。 + +而且你的情境很可能可以在其中找到解決方案。 + +/// + +## 請先閱讀教學 { #read-the-tutorial-first } + +以下各節假設你已閱讀主要的[教學 - 使用者指南:安全性](../../tutorial/security/index.md){.internal-link target=_blank}。 + +它們都建立在相同的概念之上,但提供一些額外的功能。 diff --git a/docs/zh-hant/docs/advanced/security/oauth2-scopes.md b/docs/zh-hant/docs/advanced/security/oauth2-scopes.md new file mode 100644 index 0000000000..029572d433 --- /dev/null +++ b/docs/zh-hant/docs/advanced/security/oauth2-scopes.md @@ -0,0 +1,274 @@ +# OAuth2 範圍(scopes) { #oauth2-scopes } + +你可以直接在 FastAPI 中使用 OAuth2 的 scopes,已整合可無縫運作。 + +這能讓你在 OpenAPI 應用(以及 API 文件)中,依照 OAuth2 標準,實作更細粒度的權限系統。 + +帶有 scopes 的 OAuth2 是許多大型身分驗證提供者(如 Facebook、Google、GitHub、Microsoft、X(Twitter)等)所使用的機制。他們用它來為使用者與應用程式提供特定權限。 + +每次你「使用」Facebook、Google、GitHub、Microsoft、X(Twitter)「登入」時,那個應用就是在使用帶有 scopes 的 OAuth2。 + +在本節中,你將看到如何在你的 FastAPI 應用中,用同樣的帶有 scopes 的 OAuth2 管理驗證與授權。 + +/// warning + +這一節算是進階內容。如果你剛開始,可以先跳過。 + +你不一定需要 OAuth2 scopes,你可以用任何你想要的方式處理驗證與授權。 + +但帶有 scopes 的 OAuth2 可以很漂亮地整合進你的 API(透過 OpenAPI)與 API 文件。 + +無論如何,你仍然會在程式碼中,依你的需求,強制檢查那些 scopes,或其他任何安全性/授權需求。 + +在許多情況下,帶有 scopes 的 OAuth2 可能有點大材小用。 + +但如果你確定需要,或是好奇,請繼續閱讀。 + +/// + +## OAuth2 scopes 與 OpenAPI { #oauth2-scopes-and-openapi } + +OAuth2 規格將「scopes」定義為以空白分隔的一串字串列表。 + +每個字串的內容可以有任意格式,但不應包含空白。 + +這些 scopes 代表「權限」。 + +在 OpenAPI(例如 API 文件)中,你可以定義「security schemes」。 + +當某個 security scheme 使用 OAuth2 時,你也可以宣告並使用 scopes。 + +每個「scope」就是一個(不含空白的)字串。 + +它們通常用來宣告特定的安全性權限,例如: + +- `users:read` 或 `users:write` 是常見的例子。 +- `instagram_basic` 是 Facebook / Instagram 使用的。 +- `https://www.googleapis.com/auth/drive` 是 Google 使用的。 + +/// info + +在 OAuth2 中,「scope」只是宣告所需特定權限的一個字串。 + +是否包含像 `:` 這樣的字元,或是否是一個 URL,都沒差。 + +那些細節取決於實作。 + +對 OAuth2 而言,它們就是字串。 + +/// + +## 全局概觀 { #global-view } + +先快速看看相對於主教學「使用密碼(與雜湊)、Bearer 與 JWT token 的 OAuth2」的差異([OAuth2 with Password (and hashing), Bearer with JWT tokens](../../tutorial/security/oauth2-jwt.md){.internal-link target=_blank})。現在加入了 OAuth2 scopes: + +{* ../../docs_src/security/tutorial005_an_py310.py hl[5,9,13,47,65,106,108:116,122:126,130:136,141,157] *} + +接著我們一步一步檢視這些變更。 + +## OAuth2 安全性方案 { #oauth2-security-scheme } + +第一個變更是:我們現在宣告了帶有兩個可用 scope 的 OAuth2 安全性方案,`me` 與 `items`。 + +參數 `scopes` 接收一個 `dict`,以各 scope 為鍵、其描述為值: + +{* ../../docs_src/security/tutorial005_an_py310.py hl[63:66] *} + +由於現在宣告了這些 scopes,當你登入/授權時,它們會出現在 API 文件中。 + +你可以選擇要授予哪些 scopes 存取權:`me` 與 `items`。 + +這與你使用 Facebook、Google、GitHub 等登入時所授與權限的機制相同: + + + +## 內含 scopes 的 JWT token { #jwt-token-with-scopes } + +現在,修改 token 的路徑操作以回傳所請求的 scopes。 + +我們仍然使用相同的 `OAuth2PasswordRequestForm`。它包含屬性 `scopes`,其為 `list` 的 `str`,列出請求中收到的每個 scope。 + +並且我們將這些 scopes 作為 JWT token 的一部分回傳。 + +/// danger + +為了簡化,這裡我們只是直接把接收到的 scopes 加進 token。 + +但在你的應用中,為了安全性,你應確保只加入該使用者實際可擁有或你預先定義的 scopes。 + +/// + +{* ../../docs_src/security/tutorial005_an_py310.py hl[157] *} + +## 在路徑操作與相依性中宣告 scopes { #declare-scopes-in-path-operations-and-dependencies } + +現在我們宣告 `/users/me/items/` 這個路徑操作需要 `items` 這個 scope。 + +為此,我們從 `fastapi` 匯入並使用 `Security`。 + +你可以使用 `Security` 來宣告相依性(就像 `Depends`),但 `Security` 也能接收參數 `scopes`,其為 scopes(字串)的列表。 + +在這裡,我們將相依函式 `get_current_active_user` 傳給 `Security`(就像使用 `Depends` 一樣)。 + +但同時也傳入一個 `list` 的 scopes,這裡只有一個 scope:`items`(當然也可以有更多)。 + +而相依函式 `get_current_active_user` 也能宣告子相依性,不只用 `Depends`,也能用 `Security`。它宣告了自己的子相依函式(`get_current_user`),並加入更多 scope 要求。 + +在這個例子中,它要求 `me` 這個 scope(也可以要求多個)。 + +/// note + +你不一定需要在不同地方加上不同的 scopes。 + +我們在這裡這樣做,是為了示範 FastAPI 如何處理在不同層級宣告的 scopes。 + +/// + +{* ../../docs_src/security/tutorial005_an_py310.py hl[5,141,172] *} + +/// info | 技術細節 + +`Security` 其實是 `Depends` 的子類別,僅多了一個我們稍後會看到的參數。 + +改用 `Security` 而不是 `Depends`,能讓 FastAPI 知道可以宣告安全性 scopes、在內部使用它們,並用 OpenAPI 文件化 API。 + +另外,當你從 `fastapi` 匯入 `Query`、`Path`、`Depends`、`Security` 等時,實際上它們是回傳特殊類別的函式。 + +/// + +## 使用 `SecurityScopes` { #use-securityscopes } + +現在更新相依性 `get_current_user`。 + +上面的相依性就是使用它。 + +這裡我們使用先前建立的相同 OAuth2 scheme,並將其宣告為相依性:`oauth2_scheme`。 + +因為此相依函式本身沒有任何 scope 要求,所以我們可以用 `Depends` 搭配 `oauth2_scheme`,當不需要指定安全性 scopes 時就不必用 `Security`。 + +我們也宣告了一個型別為 `SecurityScopes` 的特殊參數,從 `fastapi.security` 匯入。 + +這個 `SecurityScopes` 類似於 `Request`(`Request` 用來直接取得請求物件)。 + +{* ../../docs_src/security/tutorial005_an_py310.py hl[9,106] *} + +## 使用這些 `scopes` { #use-the-scopes } + +參數 `security_scopes` 的型別是 `SecurityScopes`。 + +它會有屬性 `scopes`,包含一個列表,內含此函式本身與所有使用它為子相依性的相依性所要求的所有 scopes。也就是所有「相依者(dependants)」... 這聽起來可能有點混亂,下面會再解釋。 + +`security_scopes` 物件(類別 `SecurityScopes`)也提供 `scope_str` 屬性,為一個字串,包含那些以空白分隔的 scopes(我們會用到)。 + +我們建立一個可在多處重複丟出(`raise`)的 `HTTPException`。 + +在這個例外中,我們把所需的 scopes(若有)以空白分隔的字串形式(透過 `scope_str`)加入,並將該包含 scopes 的字串放在 `WWW-Authenticate` 標頭中(這是規格的一部分)。 + +{* ../../docs_src/security/tutorial005_an_py310.py hl[106,108:116] *} + +## 驗證 `username` 與資料結構 { #verify-the-username-and-data-shape } + +我們先確認取得了 `username`,並取出 scopes。 + +接著用 Pydantic 模型驗證這些資料(捕捉 `ValidationError` 例外),若在讀取 JWT token 或用 Pydantic 驗證資料時出錯,就丟出先前建立的 `HTTPException`。 + +為此,我們更新了 Pydantic 模型 `TokenData`,加入新屬性 `scopes`。 + +透過 Pydantic 驗證資料,我們可以確保,例如,scopes 正好是 `list` 的 `str`,而 `username` 是 `str`。 + +否則若是 `dict` 或其他型別,可能在後續某處使應用壞掉,造成安全風險。 + +我們也會確認該 `username` 對應的使用者是否存在,否則同樣丟出之前建立的例外。 + +{* ../../docs_src/security/tutorial005_an_py310.py hl[47,117:129] *} + +## 驗證 `scopes` { #verify-the-scopes } + +我們現在要驗證,此相依性與所有相依者(包含路徑操作)所要求的所有 scopes,是否都包含在收到的 token 內所提供的 scopes 中;否則就丟出 `HTTPException`。 + +為此,我們使用 `security_scopes.scopes`,其中包含一個 `list`,列出所有這些 `str` 形式的 scopes。 + +{* ../../docs_src/security/tutorial005_an_py310.py hl[130:136] *} + +## 相依性樹與 scopes { #dependency-tree-and-scopes } + +我們再回顧一次這個相依性樹與 scopes。 + +由於 `get_current_active_user` 相依於 `get_current_user`,因此在 `get_current_active_user` 宣告的 `"me"` 這個 scope 會包含在傳給 `get_current_user` 的 `security_scopes.scopes` 的必須 scopes 清單中。 + +路徑操作本身也宣告了 `"items"` 這個 scope,因此它也會包含在傳給 `get_current_user` 的 `security_scopes.scopes` 中。 + +以下是相依性與 scopes 的階層關係: + +- 路徑操作 `read_own_items` 具有: + - 需要的 scopes `["items"]`,並有相依性: + - `get_current_active_user`: + - 相依函式 `get_current_active_user` 具有: + - 需要的 scopes `["me"]`,並有相依性: + - `get_current_user`: + - 相依函式 `get_current_user` 具有: + - 自身沒有需要的 scopes。 + - 一個使用 `oauth2_scheme` 的相依性。 + - 一個型別為 `SecurityScopes` 的 `security_scopes` 參數: + - 這個 `security_scopes` 參數有屬性 `scopes`,其為一個 `list`,包含了上面宣告的所有 scopes,因此: + - 對於路徑操作 `read_own_items`,`security_scopes.scopes` 會包含 `["me", "items"]`。 + - 對於路徑操作 `read_users_me`,因為它在相依性 `get_current_active_user` 中被宣告,`security_scopes.scopes` 會包含 `["me"]`。 + - 對於路徑操作 `read_system_status`,因為它沒有宣告任何帶 `scopes` 的 `Security`,且其相依性 `get_current_user` 也未宣告任何 `scopes`,所以 `security_scopes.scopes` 會包含 `[]`(空)。 + +/// tip + +這裡重要且「神奇」的是:`get_current_user` 在每個路徑操作中,會有不同的 `scopes` 清單需要檢查。 + +這完全取決於該路徑操作與其相依性樹中每個相依性所宣告的 `scopes`。 + +/// + +## 更多關於 `SecurityScopes` 的細節 { #more-details-about-securityscopes } + +你可以在任意位置、多個地方使用 `SecurityScopes`,它不需要位於「根」相依性。 + +它會永遠帶有對於「該特定」路徑操作與「該特定」相依性樹中,目前 `Security` 相依性所宣告的安全性 scopes(以及所有相依者): + +因為 `SecurityScopes` 會擁有由相依者宣告的所有 scopes,你可以在一個集中式相依函式中用它來驗證 token 是否具有所需 scopes,然後在不同路徑操作中宣告不同的 scope 要求。 + +它們會在每個路徑操作被各自獨立檢查。 + +## 試用看看 { #check-it } + +如果你打開 API 文件,你可以先驗證並指定你要授權的 scopes。 + + + +如果你沒有選任何 scope,你仍會「通過驗證」,但當你嘗試存取 `/users/me/` 或 `/users/me/items/` 時,會收到沒有足夠權限的錯誤。你仍能存取 `/status/`。 + +若你只選了 `me` 而未選 `items`,你能存取 `/users/me/`,但無法存取 `/users/me/items/`。 + +這就是第三方應用在取得使用者提供的 token 後,嘗試存取上述路徑操作時,會依使用者授與該應用的權限多寡而有不同結果。 + +## 關於第三方整合 { #about-third-party-integrations } + +在這個範例中,我們使用 OAuth2 的「password」流程。 + +當我們登入自己的應用(可能也有自己的前端)時,這是合適的。 + +因為我們可以信任它接收 `username` 與 `password`,因為我們掌控它。 + +但如果你要打造一個讓他人連接的 OAuth2 應用(也就是你要建立一個相當於 Facebook、Google、GitHub 等的身分驗證提供者),你應該使用其他流程之一。 + +最常見的是 Implicit Flow(隱式流程)。 + +最安全的是 Authorization Code Flow(授權碼流程),但它需要更多步驟、實作也更複雜。因為較複雜,許多提供者最後會建議使用隱式流程。 + +/// note + +很常見的是,每個身分驗證提供者會用不同的方式命名他們的流程,讓它成為品牌的一部分。 + +但最終,他們實作的都是相同的 OAuth2 標準。 + +/// + +FastAPI 在 `fastapi.security.oauth2` 中提供了所有這些 OAuth2 驗證流程的工具。 + +## 在裝飾器 `dependencies` 中使用 `Security` { #security-in-decorator-dependencies } + +就像你可以在裝飾器的 `dependencies` 參數中定義一個 `Depends` 的 `list` 一樣(詳見[路徑操作裝飾器中的相依性](../../tutorial/dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}),你也可以在那裡使用帶有 `scopes` 的 `Security`。 diff --git a/docs/zh-hant/docs/advanced/settings.md b/docs/zh-hant/docs/advanced/settings.md new file mode 100644 index 0000000000..1ee5ad7cc2 --- /dev/null +++ b/docs/zh-hant/docs/advanced/settings.md @@ -0,0 +1,302 @@ +# 設定與環境變數 { #settings-and-environment-variables } + +在許多情況下,你的應用程式可能需要一些外部設定或組態,例如密鑰、資料庫憑證、電子郵件服務的憑證等。 + +這些設定大多是可變的(可能會改變),像是資料庫 URL。也有許多可能是敏感資訊,例如密鑰。 + +因此,通常會透過環境變數提供這些設定,讓應用程式去讀取。 + +/// tip + +若想了解環境變數,你可以閱讀[環境變數](../environment-variables.md){.internal-link target=_blank}。 + +/// + +## 型別與驗證 { #types-and-validation } + +這些環境變數只能處理文字字串,因為它們在 Python 之外,必須與其他程式與系統的其餘部分相容(甚至跨作業系統,如 Linux、Windows、macOS)。 + +這表示在 Python 中自環境變數讀取到的任何值都會是 `str`,而任何轉型成其他型別或驗證都必須在程式碼中完成。 + +## Pydantic `Settings` { #pydantic-settings } + +幸好,Pydantic 提供了很好的工具,可用來處理由環境變數而來的設定:Pydantic:設定管理。 + +### 安裝 `pydantic-settings` { #install-pydantic-settings } + +首先,請先建立你的[虛擬環境](../virtual-environments.md){.internal-link target=_blank},啟用它,然後安裝 `pydantic-settings` 套件: + +
+ +```console +$ pip install pydantic-settings +---> 100% +``` + +
+ +當你用 `all` extras 安裝時,它也會一併包含在內: + +
+ +```console +$ pip install "fastapi[all]" +---> 100% +``` + +
+ +### 建立 `Settings` 物件 { #create-the-settings-object } + +從 Pydantic 匯入 `BaseSettings` 並建立子類別,與建立 Pydantic model 的方式非常類似。 + +就像使用 Pydantic model 一樣,你用型別註解宣告類別屬性,並可選擇性地提供預設值。 + +你可以使用與 Pydantic model 相同的所有驗證功能與工具,例如不同的資料型別與透過 `Field()` 進行額外驗證。 + +{* ../../docs_src/settings/tutorial001_py310.py hl[2,5:8,11] *} + +/// tip + +如果你想要可以直接複製貼上的範例,先別用這個,請改用本文最後一個範例。 + +/// + +接著,當你建立該 `Settings` 類別的實例(此處為 `settings` 物件)時,Pydantic 會以不區分大小寫的方式讀取環境變數,因此,即使環境變數是大寫的 `APP_NAME`,也會被讀入屬性 `app_name`。 + +然後它會轉換並驗證資料。因此,當你使用該 `settings` 物件時,你會得到你宣告的型別的資料(例如 `items_per_user` 會是 `int`)。 + +### 使用 `settings` { #use-the-settings } + +接著你可以在應用程式中使用新的 `settings` 物件: + +{* ../../docs_src/settings/tutorial001_py310.py hl[18:20] *} + +### 執行伺服器 { #run-the-server } + +接下來,你可以在啟動伺服器時,將設定以環境變數傳入。舉例來說,你可以設定 `ADMIN_EMAIL` 與 `APP_NAME`: + +
+ +```console +$ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp" fastapi run main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +/// tip + +要為單一指令設定多個環境變數,只要用空白分隔它們,並全部放在指令前面即可。 + +/// + +如此一來,`admin_email` 設定會被設為 `"deadpool@example.com"`。 + +`app_name` 會是 `"ChimichangApp"`。 + +而 `items_per_user` 則會保留其預設值 `50`。 + +## 在另一個模組中的設定 { #settings-in-another-module } + +你也可以把這些設定放在另一個模組檔案中,就像在[更大的應用程式 - 多個檔案](../tutorial/bigger-applications.md){.internal-link target=_blank}所示。 + +例如,你可以有一個 `config.py` 檔案如下: + +{* ../../docs_src/settings/app01_py310/config.py *} + +然後在 `main.py` 檔案中使用它: + +{* ../../docs_src/settings/app01_py310/main.py hl[3,11:13] *} + +/// tip + +你也需要一個 `__init__.py` 檔案,詳見[更大的應用程式 - 多個檔案](../tutorial/bigger-applications.md){.internal-link target=_blank}。 + +/// + +## 在相依中的設定 { #settings-in-a-dependency } + +在某些情境中,從相依(dependency)提供設定,會比在各處使用一個全域的 `settings` 物件更有用。 + +這在測試時特別實用,因為你可以很容易用自訂的設定來覆寫一個相依。 + +### 設定檔 { #the-config-file } + +延續前一個範例,你的 `config.py` 可以像這樣: + +{* ../../docs_src/settings/app02_an_py310/config.py hl[10] *} + +注意現在我們不再建立預設實例 `settings = Settings()`。 + +### 主應用程式檔案 { #the-main-app-file } + +現在我們建立一個相依,回傳新的 `config.Settings()`。 + +{* ../../docs_src/settings/app02_an_py310/main.py hl[6,12:13] *} + +/// tip + +我們稍後會討論 `@lru_cache`。 + +現在你可以先把 `get_settings()` 視為一般函式。 + +/// + +接著我們可以在*路徑操作函式 (path operation function)* 中將它宣告為相依,並在需要的地方使用它。 + +{* ../../docs_src/settings/app02_an_py310/main.py hl[17,19:21] *} + +### 設定與測試 { #settings-and-testing } + +接著,在測試時要提供不同的設定物件會非常容易,只要為 `get_settings` 建立相依覆寫(dependency override)即可: + +{* ../../docs_src/settings/app02_an_py310/test_main.py hl[9:10,13,21] *} + +在相依覆寫中,我們在建立新的 `Settings` 物件時設定 `admin_email` 的新值,然後回傳該新物件。 + +接著我們就可以測試它是否被使用。 + +## 讀取 `.env` 檔 { #reading-a-env-file } + +如果你有許多設定,而且在不同環境中可能常常變動,將它們放在一個檔案中,然後像讀取環境變數一樣自該檔案讀取,可能會很實用。 + +這種作法很常見,這些環境變數通常放在 `.env` 檔中,而該檔案被稱為「dotenv」。 + +/// tip + +在類 Unix 系統(如 Linux 與 macOS)中,以點(`.`)開頭的檔案是隱藏檔。 + +但 dotenv 檔並不一定必須使用這個確切的檔名。 + +/// + +Pydantic 透過外部函式庫支援讀取這類型的檔案。你可以閱讀更多:Pydantic Settings:Dotenv (.env) 支援。 + +/// tip + +要讓這個功能運作,你需要 `pip install python-dotenv`。 + +/// + +### `.env` 檔 { #the-env-file } + +你可以有一個 `.env` 檔如下: + +```bash +ADMIN_EMAIL="deadpool@example.com" +APP_NAME="ChimichangApp" +``` + +### 從 `.env` 讀取設定 { #read-settings-from-env } + +然後更新你的 `config.py`: + +{* ../../docs_src/settings/app03_an_py310/config.py hl[9] *} + +/// tip + +`model_config` 屬性僅用於 Pydantic 的設定。你可以閱讀更多:Pydantic:概念:設定。 + +/// + +在這裡我們在 Pydantic 的 `Settings` 類別中定義設定 `env_file`,並將其值設為要使用的 dotenv 檔名。 + +### 使用 `lru_cache` 只建立一次 `Settings` { #creating-the-settings-only-once-with-lru-cache } + +從磁碟讀取檔案通常是昂貴(慢)的操作,所以你可能希望只做一次,然後重複使用同一個設定物件,而不是在每個請求都讀取。 + +但每次我們這樣做: + +```Python +Settings() +``` + +都會建立一個新的 `Settings` 物件,而且在建立時會再次讀取 `.env` 檔。 + +如果相依函式只是像這樣: + +```Python +def get_settings(): + return Settings() +``` + +我們就會為每個請求建立該物件,並在每個請求都讀取 `.env` 檔。⚠️ + +但由於我們在上方使用了 `@lru_cache` 裝飾器,`Settings` 物件只會在第一次呼叫時建立一次。✔️ + +{* ../../docs_src/settings/app03_an_py310/main.py hl[1,11] *} + +之後在下一批請求的相依中任何對 `get_settings()` 的呼叫,都不會再執行 `get_settings()` 的內部程式碼與建立新的 `Settings` 物件,而是會一再回傳第一次呼叫時回傳的同一個物件。 + +#### `lru_cache` 技術細節 { #lru-cache-technical-details } + +`@lru_cache` 會修改它所裝飾的函式,使其回傳第一次回傳的相同值,而不是每次都重新計算、執行函式碼。 + +因此,被裝飾的函式對於每組參數組合只會執行一次。之後,凡是以完全相同參數組合呼叫時,都會重複使用先前對應的回傳值。 + +例如,如果你有一個函式: + +```Python +@lru_cache +def say_hi(name: str, salutation: str = "Ms."): + return f"Hello {salutation} {name}" +``` + +你的程式可能會這樣執行: + +```mermaid +sequenceDiagram + +participant code as Code +participant function as say_hi() +participant execute as Execute function + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Camila") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Camila") + function ->> code: return stored result + end + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Rick") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 0, .1) + code ->> function: say_hi(name="Rick", salutation="Mr.") + function ->> execute: execute function code + execute ->> code: return the result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Rick") + function ->> code: return stored result + end + + rect rgba(0, 255, 255, .1) + code ->> function: say_hi(name="Camila") + function ->> code: return stored result + end +``` + +在我們的相依 `get_settings()` 這個案例中,該函式甚至不帶任何參數,因此它總是回傳相同的值。 + +如此一來,它的行為幾乎就像全域變數。但因為它使用相依函式,因此我們可以在測試時輕鬆將其覆寫。 + +`@lru_cache` 是 `functools` 的一部分,而 `functools` 是 Python 標準程式庫的一部分。你可以在Python 文件中閱讀 `@lru_cache` 以了解更多。 + +## 回顧 { #recap } + +你可以使用 Pydantic Settings 來處理應用程式的設定或組態,並享有 Pydantic model 的全部能力。 + +- 透過相依可以讓測試更容易。 +- 你可以搭配 `.env` 檔使用。 +- 使用 `@lru_cache` 可以避免每個請求都重複讀取 dotenv 檔,同時仍可在測試時覆寫設定。 diff --git a/docs/zh-hant/docs/advanced/sub-applications.md b/docs/zh-hant/docs/advanced/sub-applications.md new file mode 100644 index 0000000000..773bc4b886 --- /dev/null +++ b/docs/zh-hant/docs/advanced/sub-applications.md @@ -0,0 +1,67 @@ +# 子應用程式 - 掛載 { #sub-applications-mounts } + +若你需要兩個彼此獨立的 FastAPI 應用程式,各自擁有獨立的 OpenAPI 與文件 UI,你可以有一個主應用,並「掛載」一個(或多個)子應用程式。 + +## 掛載一個 **FastAPI** 應用程式 { #mounting-a-fastapi-application } + +「掛載」是指在某個特定路徑下加入一個完全「獨立」的應用程式,之後該應用程式會負責處理該路徑底下的一切,使用該子應用程式中宣告的*路徑操作(path operation)*。 + +### 頂層應用程式 { #top-level-application } + +先建立主(頂層)**FastAPI** 應用程式以及它的*路徑操作*: + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[3, 6:8] *} + +### 子應用程式 { #sub-application } + +接著,建立你的子應用程式及其*路徑操作*。 + +這個子應用程式就是另一個標準的 FastAPI 應用,但這個會被「掛載」: + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 14:16] *} + +### 掛載子應用程式 { #mount-the-sub-application } + +在你的頂層應用程式 `app` 中,掛載子應用程式 `subapi`。 + +在此範例中,它會被掛載在路徑 `/subapi`: + +{* ../../docs_src/sub_applications/tutorial001_py310.py hl[11, 19] *} + +### 檢查自動 API 文件 { #check-the-automatic-api-docs } + +現在,用你的檔案執行 `fastapi` 指令: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +然後開啟位於 http://127.0.0.1:8000/docs 的文件。 + +你會看到主應用的自動 API 文件,只包含它自己的*路徑操作*: + + + +接著,開啟子應用程式的文件:http://127.0.0.1:8000/subapi/docs。 + +你會看到子應用程式的自動 API 文件,只包含它自己的*路徑操作*,而且都在正確的子路徑前綴 `/subapi` 之下: + + + +如果你嘗試在任一介面中互動,它們都會正常運作,因為瀏覽器能與各自的應用程式或子應用程式通訊。 + +### 技術細節:`root_path` { #technical-details-root-path } + +當你像上面那樣掛載子應用程式時,FastAPI 會使用 ASGI 規範中的一個機制 `root_path`,將子應用程式的掛載路徑告知它。 + +如此一來,子應用程式就會知道在文件 UI 使用該路徑前綴。 + +而且子應用程式也能再掛載自己的子應用程式,一切都能正確運作,因為 FastAPI 會自動處理所有這些 `root_path`。 + +你可以在[在代理伺服器之後](behind-a-proxy.md){.internal-link target=_blank}一節中進一步了解 `root_path` 與如何顯式使用它。 diff --git a/docs/zh-hant/docs/advanced/templates.md b/docs/zh-hant/docs/advanced/templates.md new file mode 100644 index 0000000000..ffc7599ae2 --- /dev/null +++ b/docs/zh-hant/docs/advanced/templates.md @@ -0,0 +1,126 @@ +# 模板 { #templates } + +你可以在 **FastAPI** 中使用任意你想要的模板引擎。 + +常見的選擇是 Jinja2,與 Flask 與其他工具所使用的一樣。 + +有一些工具可讓你輕鬆設定,並可直接在你的 **FastAPI** 應用程式中使用(由 Starlette 提供)。 + +## 安裝相依套件 { #install-dependencies } + +請先建立一個[虛擬環境](../virtual-environments.md){.internal-link target=_blank}、啟用它,然後安裝 `jinja2`: + +
+ +```console +$ pip install jinja2 + +---> 100% +``` + +
+ +## 使用 `Jinja2Templates` { #using-jinja2templates } + +- 匯入 `Jinja2Templates`。 +- 建立一個可重複使用的 `templates` 物件。 +- 在會回傳模板的「*路徑操作(path operation)*」中宣告一個 `Request` 參數。 +- 使用你建立的 `templates` 來渲染並回傳 `TemplateResponse`,傳入模板名稱、`request` 物件,以及在 Jinja2 模板中使用的「context」鍵值對字典。 + +{* ../../docs_src/templates/tutorial001_py310.py hl[4,11,15:18] *} + +/// note + +在 FastAPI 0.108.0、Starlette 0.29.0 之前,`name` 是第一個參數。 + +此外,在更早的版本中,`request` 物件是作為 context 的鍵值對之一傳給 Jinja2 的。 + +/// + +/// tip + +透過宣告 `response_class=HTMLResponse`,文件 UI 能夠知道回應將會是 HTML。 + +/// + +/// note | 技術細節 + +你也可以使用 `from starlette.templating import Jinja2Templates`。 + +**FastAPI** 以 `fastapi.templating` 的形式提供與 `starlette.templating` 相同的內容,僅為了方便你(開發者)。但大多數可用的回應類別都直接來自 Starlette,`Request` 與 `StaticFiles` 也是如此。 + +/// + +## 撰寫模板 { #writing-templates } + +接著你可以在 `templates/item.html` 編寫模板,例如: + +```jinja hl_lines="7" +{!../../docs_src/templates/templates/item.html!} +``` + +### 模板 context 值 { #template-context-values } + +在包含以下內容的 HTML 中: + +{% raw %} + +```jinja +Item ID: {{ id }} +``` + +{% endraw %} + +...它會顯示你在傳入的 context `dict` 中提供的 `id`: + +```Python +{"id": id} +``` + +例如,若 ID 為 `42`,會渲染為: + +```html +Item ID: 42 +``` + +### 模板 `url_for` 參數 { #template-url-for-arguments } + +你也可以在模板中使用 `url_for()`,它所接受的參數與你的「*路徑操作函式(path operation function)*」所使用的參數相同。 + +因此,包含以下內容的區塊: + +{% raw %} + +```jinja + +``` + +{% endraw %} + +...會產生指向與「*路徑操作函式*」`read_item(id=id)` 相同 URL 的連結。 + +例如,若 ID 為 `42`,會渲染為: + +```html + +``` + +## 模板與靜態檔案 { #templates-and-static-files } + +你也可以在模板中使用 `url_for()`,例如搭配你以 `name="static"` 掛載的 `StaticFiles` 使用。 + +```jinja hl_lines="4" +{!../../docs_src/templates/templates/item.html!} +``` + +在這個例子中,它會連結到 `static/styles.css` 的 CSS 檔案,內容為: + +```CSS hl_lines="4" +{!../../docs_src/templates/static/styles.css!} +``` + +而且因為你使用了 `StaticFiles`,該 CSS 檔案會由你的 **FastAPI** 應用程式在 URL `/static/styles.css` 自動提供。 + +## 更多細節 { #more-details } + +想了解更多細節(包含如何測試模板),請參考 Starlette 的模板說明文件。 diff --git a/docs/zh-hant/docs/advanced/testing-dependencies.md b/docs/zh-hant/docs/advanced/testing-dependencies.md new file mode 100644 index 0000000000..3ce72ccab8 --- /dev/null +++ b/docs/zh-hant/docs/advanced/testing-dependencies.md @@ -0,0 +1,53 @@ +# 用覆寫測試相依 { #testing-dependencies-with-overrides } + +## 在測試期間覆寫相依 { #overriding-dependencies-during-testing } + +有些情境你可能想在測試時覆寫(override)某個相依(dependency)。 + +你不希望執行原本的相依(以及它可能具有的任何子相依)。 + +相反地,你想提供一個只在測試期間使用的不同相依(可能只在特定測試中),並回傳一個可以在原本相依值被使用之處使用的值。 + +### 使用情境:外部服務 { #use-cases-external-service } + +例如你有一個需要呼叫的外部驗證提供者。 + +你傳送一個 token,它會回傳一個已驗證的使用者。 + +這個提供者可能按每個請求收費,而且呼叫它可能比在測試中使用固定的模擬使用者多花一些時間。 + +你大概只想對外部提供者測試一次,而不需要在每個測試都呼叫它。 + +在這種情況下,你可以覆寫用來呼叫該提供者的相依,並在測試中使用自訂的相依來回傳一個模擬使用者。 + +### 使用 `app.dependency_overrides` 屬性 { #use-the-app-dependency-overrides-attribute } + +對這些情況,你的 FastAPI 應用程式有一個屬性 `app.dependency_overrides`,它是一個簡單的 `dict`。 + +要在測試時覆寫某個相依,把原始相依(函式)作為鍵,並把你的覆寫相依(另一個函式)作為值。 + +接著 FastAPI 會呼叫這個覆寫,而不是原本的相依。 + +{* ../../docs_src/dependency_testing/tutorial001_an_py310.py hl[26:27,30] *} + +/// tip + +你可以為應用程式中任何地方使用到的相依設定覆寫。 + +原始相依可以用在*路徑操作函式*、*路徑操作裝飾器*(當你不使用其回傳值時)、`.include_router()` 呼叫等。 + +FastAPI 仍然能夠將其覆寫。 + +/// + +然後你可以將 `app.dependency_overrides` 設為空的 `dict` 以重設(移除)所有覆寫: + +```Python +app.dependency_overrides = {} +``` + +/// tip + +如果只想在某些測試中覆寫相依,你可以在測試開始時(測試函式內)設定覆寫,並在結束時(測試函式結尾)重設。 + +/// diff --git a/docs/zh-hant/docs/advanced/testing-events.md b/docs/zh-hant/docs/advanced/testing-events.md new file mode 100644 index 0000000000..db678977a3 --- /dev/null +++ b/docs/zh-hant/docs/advanced/testing-events.md @@ -0,0 +1,11 @@ +# 測試事件:lifespan 與 startup - shutdown { #testing-events-lifespan-and-startup-shutdown } + +當你需要在測試中執行 lifespan(生命週期)時,你可以使用 TestClient 並搭配 with 陳述式: + +{* ../../docs_src/app_testing/tutorial004_py310.py hl[9:15,18,27:28,30:32,41:43] *} + +你可以閱讀更多細節:[在測試中執行 lifespan](https://www.starlette.dev/lifespan/#running-lifespan-in-tests)(Starlette 官方文件)。 + +對於已棄用的 `startup` 和 `shutdown` 事件,你可以這樣使用 TestClient: + +{* ../../docs_src/app_testing/tutorial003_py310.py hl[9:12,20:24] *} diff --git a/docs/zh-hant/docs/advanced/testing-websockets.md b/docs/zh-hant/docs/advanced/testing-websockets.md new file mode 100644 index 0000000000..7348e60fdf --- /dev/null +++ b/docs/zh-hant/docs/advanced/testing-websockets.md @@ -0,0 +1,13 @@ +# 測試 WebSocket { #testing-websockets } + +你可以使用相同的 `TestClient` 來測試 WebSocket。 + +為此,你可以在 `with` 陳述式中使用 `TestClient`,連線到該 WebSocket: + +{* ../../docs_src/app_testing/tutorial002_py310.py hl[27:31] *} + +/// note | 注意 + +想了解更多,請參考 Starlette 的 測試 WebSocket 文件。 + +/// diff --git a/docs/zh-hant/docs/advanced/using-request-directly.md b/docs/zh-hant/docs/advanced/using-request-directly.md new file mode 100644 index 0000000000..f1dae9bf29 --- /dev/null +++ b/docs/zh-hant/docs/advanced/using-request-directly.md @@ -0,0 +1,56 @@ +# 直接使用 Request { #using-the-request-directly } + +到目前為止,你都是用對應的型別來宣告你需要的請求各部分。 + +例如從以下來源取得資料: + +- 路徑中的參數。 +- 標頭。 +- Cookies。 +- 等等。 + +這麼做時,FastAPI 會自動驗證並轉換這些資料,還會為你的 API 產生文件。 + +但有些情況你可能需要直接存取 `Request` 物件。 + +## 關於 `Request` 物件的細節 { #details-about-the-request-object } + +由於 FastAPI 底層其實是 Starlette,再加上一層工具,因此在需要時你可以直接使用 Starlette 的 `Request` 物件。 + +同時也代表,如果你直接從 `Request` 物件取得資料(例如讀取 body),FastAPI 不會替它做驗證、轉換或文件化(透過 OpenAPI 為自動化的 API 介面產生文件)。 + +不過,其他以一般方式宣告的參數(例如以 Pydantic 模型宣告的 body)仍然會被驗證、轉換、加上標註等。 + +但在某些特定情境下,直接取得 `Request` 物件會很實用。 + +## 直接使用 `Request` 物件 { #use-the-request-object-directly } + +假設你想在你的 路徑操作函式(path operation function) 中取得用戶端的 IP 位址/主機。 + +為此,你需要直接存取請求。 + +{* ../../docs_src/using_request_directly/tutorial001_py310.py hl[1,7:8] *} + +只要在 路徑操作函式 中宣告一個型別為 `Request` 的參數,FastAPI 就會將當前的 `Request` 傳入該參數。 + +/// tip + +注意在這個例子中,除了 request 參數之外,我們也宣告了一個路徑參數。 + +因此,路徑參數會被擷取、驗證、轉換為指定型別,並在 OpenAPI 中加入標註。 + +同理,你可以照常宣告其他參數,並另外同時取得 `Request`。 + +/// + +## `Request` 文件 { #request-documentation } + +你可以在 Starlette 官方文件站點中的 `Request` 物件 了解更多細節。 + +/// note | 技術細節 + +你也可以使用 `from starlette.requests import Request`。 + +FastAPI 之所以直接提供它,是為了讓開發者更方便;但它本身是來自 Starlette。 + +/// diff --git a/docs/zh-hant/docs/advanced/websockets.md b/docs/zh-hant/docs/advanced/websockets.md new file mode 100644 index 0000000000..c4e904f6f6 --- /dev/null +++ b/docs/zh-hant/docs/advanced/websockets.md @@ -0,0 +1,186 @@ +# WebSockets { #websockets } + +你可以在 **FastAPI** 中使用 WebSockets。 + +## 安裝 `websockets` { #install-websockets } + +請先建立[虛擬環境](../virtual-environments.md){.internal-link target=_blank}、啟用它,然後安裝 `websockets`(一個讓你更容易使用「WebSocket」通訊協定的 Python 套件): + +
+ +```console +$ pip install websockets + +---> 100% +``` + +
+ +## WebSockets 用戶端 { #websockets-client } + +### 在生產環境 { #in-production } + +在你的生產系統中,你很可能有一個使用現代框架(如 React、Vue.js 或 Angular)建立的前端。 + +而為了透過 WebSockets 與後端通訊,你通常會使用前端的工具。 + +或者你可能有一個原生行動應用,使用原生程式碼直接與 WebSocket 後端通訊。 + +又或者你有其他任何方式與 WebSocket 端點通訊。 + +--- + +但在這個範例中,我們會用一個非常簡單的 HTML 文件與一些 JavaScript,全都寫在一個長字串裡。 + +當然,這並不理想,你不會在生產環境這樣做。 + +在生產環境你通常會用上述其中一種方式。 + +但這是能讓我們專注於 WebSocket 伺服端並跑起一個可運作範例的最簡單方式: + +{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *} + +## 建立一個 `websocket` { #create-a-websocket } + +在你的 **FastAPI** 應用中,建立一個 `websocket`: + +{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *} + +/// note | 技術細節 + +你也可以使用 `from starlette.websockets import WebSocket`。 + +**FastAPI** 直接提供相同的 `WebSocket` 只是為了方便你這位開發者,但它其實是直接來自 Starlette。 + +/// + +## 等待與傳送訊息 { #await-for-messages-and-send-messages } + +在你的 WebSocket 路由中,你可以 `await` 接收訊息並傳送訊息。 + +{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *} + +你可以接收與傳送二進位、文字與 JSON 資料。 + +## 試試看 { #try-it } + +如果你的檔案名為 `main.py`,用以下指令執行應用: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +在瀏覽器開啟 http://127.0.0.1:8000。 + +你會看到一個像這樣的簡單頁面: + + + +你可以在輸入框輸入訊息並送出: + + + +你的 **FastAPI** 應用會透過 WebSockets 回應: + + + +你可以傳送(與接收)多則訊息: + + + +而且它們都會使用同一個 WebSocket 連線。 + +## 使用 `Depends` 與其他功能 { #using-depends-and-others } + +在 WebSocket 端點中,你可以從 `fastapi` 匯入並使用: + +* `Depends` +* `Security` +* `Cookie` +* `Header` +* `Path` +* `Query` + +它們的運作方式與其他 FastAPI 端點/*路徑操作* 相同: + +{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *} + +/// info + +因為這是 WebSocket,拋出 `HTTPException` 並沒有意義,因此我們改為拋出 `WebSocketException`。 + +你可以使用規範中定義的有效關閉代碼之一。 + +/// + +### 用依賴試用 WebSocket { #try-the-websockets-with-dependencies } + +如果你的檔案名為 `main.py`,用以下指令執行應用: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +在瀏覽器開啟 http://127.0.0.1:8000。 + +在那裡你可以設定: + +* "Item ID",用於路徑。 +* "Token",作為查詢參數。 + +/// tip + +注意查詢參數 `token` 會由一個依賴處理。 + +/// + +之後你就能連線到 WebSocket,並開始收發訊息: + + + +## 處理斷線與多個用戶端 { #handling-disconnections-and-multiple-clients } + +當 WebSocket 連線關閉時,`await websocket.receive_text()` 會拋出 `WebSocketDisconnect` 例外,你可以像範例中那樣捕捉並處理。 + +{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *} + +試用方式: + +* 用多個瀏覽器分頁開啟該應用。 +* 從每個分頁傳送訊息。 +* 然後關閉其中一個分頁。 + +這會引發 `WebSocketDisconnect` 例外,其他所有用戶端都會收到類似以下的訊息: + +``` +Client #1596980209979 left the chat +``` + +/// tip + +上面的應用是一個極簡範例,用來示範如何處理並向多個 WebSocket 連線廣播訊息。 + +但請注意,因為所有狀態都在記憶體中的單一 list 裡管理,它只會在該程序執行期間生效,且僅適用於單一程序。 + +如果你需要一個容易與 FastAPI 整合、但更健壯,且可由 Redis、PostgreSQL 等後端支援的方案,請參考 encode/broadcaster。 + +/// + +## 更多資訊 { #more-info } + +想了解更多選項,請參考 Starlette 的文件: + +* `WebSocket` 類別。 +* 以類別為基礎的 WebSocket 處理。 diff --git a/docs/zh-hant/docs/advanced/wsgi.md b/docs/zh-hant/docs/advanced/wsgi.md new file mode 100644 index 0000000000..9d03b56924 --- /dev/null +++ b/docs/zh-hant/docs/advanced/wsgi.md @@ -0,0 +1,51 @@ +# 包含 WSGI:Flask、Django 等 { #including-wsgi-flask-django-others } + +你可以像在 [子應用程式 - 掛載](sub-applications.md){.internal-link target=_blank}、[在 Proxy 後方](behind-a-proxy.md){.internal-link target=_blank} 中所見那樣掛載 WSGI 應用。 + +為此,你可以使用 `WSGIMiddleware` 來包住你的 WSGI 應用,例如 Flask、Django 等。 + +## 使用 `WSGIMiddleware` { #using-wsgimiddleware } + +/// info + +這需要先安裝 `a2wsgi`,例如使用 `pip install a2wsgi`。 + +/// + +你需要從 `a2wsgi` 匯入 `WSGIMiddleware`。 + +然後用該 middleware 包住 WSGI(例如 Flask)應用。 + +接著把它掛載到某個路徑下。 + +{* ../../docs_src/wsgi/tutorial001_py310.py hl[1,3,23] *} + +/// note + +先前建議使用來自 `fastapi.middleware.wsgi` 的 `WSGIMiddleware`,但現在已棄用。 + +建議改用 `a2wsgi` 套件。用法保持相同。 + +只要確保已安裝 `a2wsgi`,並從 `a2wsgi` 正確匯入 `WSGIMiddleware` 即可。 + +/// + +## 試試看 { #check-it } + +現在,位於路徑 `/v1/` 底下的所有請求都會由 Flask 應用處理。 + +其餘則由 **FastAPI** 處理。 + +如果你啟動它並前往 http://localhost:8000/v1/,你會看到來自 Flask 的回應: + +```txt +Hello, World from Flask! +``` + +如果你前往 http://localhost:8000/v2,你會看到來自 FastAPI 的回應: + +```JSON +{ + "message": "Hello World" +} +``` diff --git a/docs/zh-hant/docs/alternatives.md b/docs/zh-hant/docs/alternatives.md new file mode 100644 index 0000000000..340c47d8ba --- /dev/null +++ b/docs/zh-hant/docs/alternatives.md @@ -0,0 +1,485 @@ +# 替代方案、靈感與比較 { #alternatives-inspiration-and-comparisons } + +啟發 FastAPI 的來源、與其他方案的比較,以及從中學到的內容。 + +## 介紹 { #intro } + +沒有前人的工作,就不會有 **FastAPI**。 + +在它誕生之前,已經有許多工具啟發了它的設計。 + +我多年來一直避免打造新框架。起初我嘗試用許多不同的框架、外掛與工具,來實作 **FastAPI** 涵蓋的所有功能。 + +但在某個時間點,除了創建一個能提供所有這些功能、汲取前人工具的優點,並以最佳方式組合起來、同時運用過去甚至不存在的語言特性(Python 3.6+ 的型別提示)之外,已別無他法。 + +## 先前的工具 { #previous-tools } + +### Django { #django } + +它是最受歡迎且廣受信任的 Python 框架。像 Instagram 等系統就是用它打造的。 + +它與關聯式資料庫(如 MySQL 或 PostgreSQL)相對緊密耦合,因此要以 NoSQL 資料庫(如 Couchbase、MongoDB、Cassandra 等)作為主要儲存引擎並不容易。 + +它一開始是為在後端產生 HTML 而設計,而非為了建立提供現代前端(如 React、Vue.js、Angular)或其他系統(如 IoT 裝置)使用的 API。 + +### Django REST Framework { #django-rest-framework } + +Django REST framework 的目標是成為一套在 Django 之上構建 Web API 的彈性工具組,以強化其 API 能力。 + +它被 Mozilla、Red Hat、Eventbrite 等眾多公司使用。 + +它是「自動 API 文件」的早期典範之一,而這正是啟發我「尋找」**FastAPI** 的第一個想法。 + +/// note | 注意 + +Django REST Framework 由 Tom Christie 創建。他同時也是 Starlette 與 Uvicorn 的作者,而 **FastAPI** 就是建立在它們之上。 + +/// + +/// check | 啟發 **FastAPI** + +提供自動化的 API 文件網頁使用者介面。 + +/// + +### Flask { #flask } + +Flask 是一個「微框架」,它不包含資料庫整合,也沒有像 Django 那樣內建許多功能。 + +這種簡單與彈性,讓你可以把 NoSQL 資料庫作為主要的資料儲存系統。 + +由於它非常簡單,學起來相對直觀,儘管文件在某些地方會變得較技術性。 + +它也常用於其他不一定需要資料庫、使用者管理或 Django 內建眾多功能的應用程式。雖然這些功能中的許多都可以用外掛新增。 + +這種元件的解耦,以及作為可擴充以精準滿足需求的「微框架」,是我想要保留的關鍵特性。 + +基於 Flask 的簡潔,它看起來很適合用來構建 API。接下來要找的,就是 Flask 世界裡的「Django REST Framework」。 + +/// check | 啟發 **FastAPI** + +成為一個微框架,讓所需的工具與元件能輕鬆搭配組合。 + +具備簡單、易用的路由系統。 + +/// + +### Requests { #requests } + +**FastAPI** 其實不是 **Requests** 的替代品。兩者的範疇截然不同。 + +在 FastAPI 應用程式「內部」使用 Requests 其實很常見。 + +儘管如此,FastAPI 仍從 Requests 得到了不少啟發。 + +**Requests** 是一個「與 API 互動」(作為用戶端)的程式庫,而 **FastAPI** 是一個「建立 API」(作為伺服端)的程式庫。 + +它們大致位於相反兩端,彼此互補。 + +Requests 設計非常簡單直觀、容易使用,且有合理的預設值。同時它也非常強大且可自訂。 + +因此,如其官網所言: + +> Requests is one of the most downloaded Python packages of all time + +用法非常簡單。例如,發出一個 `GET` 請求,你會寫: + +```Python +response = requests.get("http://example.com/some/url") +``` + +相對地,FastAPI 的 API 路徑操作(path operation)可能像這樣: + +```Python hl_lines="1" +@app.get("/some/url") +def read_url(): + return {"message": "Hello World"} +``` + +看看 `requests.get(...)` 與 `@app.get(...)` 的相似之處。 + +/// check | 啟發 **FastAPI** + +* 擁有簡單直觀的 API。 +* 直接使用 HTTP 方法名稱(操作),以直接、直觀的方式表達。 +* 具備合理的預設值,同時提供強大的自訂能力。 + +/// + +### Swagger / OpenAPI { #swagger-openapi } + +我想從 Django REST Framework 得到的主要功能是自動 API 文件。 + +後來我發現有一個使用 JSON(或 YAML,JSON 的延伸)來描述 API 的標準,叫做 Swagger。 + +而且已有對 Swagger API 的網頁使用者介面。因此,只要能為 API 產生 Swagger 文件,就可以自動使用這個網頁介面。 + +之後 Swagger 交由 Linux 基金會管理,並更名為 OpenAPI。 + +因此,談到 2.0 版時常說「Swagger」,而 3+ 版則是「OpenAPI」。 + +/// check | 啟發 **FastAPI** + +採用並使用開放的 API 規格標準,而非自訂格式。 + +並整合基於標準的使用者介面工具: + +* Swagger UI +* ReDoc + +選擇這兩個是因為它們相當受歡迎且穩定,但稍加搜尋,你會發現有數十種 OpenAPI 的替代使用者介面(都能與 **FastAPI** 一起使用)。 + +/// + +### Flask 的 REST 框架 { #flask-rest-frameworks } + +有幾個 Flask 的 REST 框架,但在投入時間調查後,我發現許多已停止維護或被棄置,且存在一些關鍵問題使之不適用。 + +### Marshmallow { #marshmallow } + +API 系統需要的主要功能之一是資料「序列化」,也就是把程式中的資料(Python)轉成能透過網路傳輸的形式。例如,將含有資料庫資料的物件轉成 JSON 物件、把 `datetime` 物件轉成字串等等。 + +API 需要的另一個重要功能是資料驗證,確保資料在特定條件下有效。例如,某個欄位必須是 `int`,而不是隨便的字串。這對於輸入資料特別有用。 + +沒有資料驗證系統的話,你就得在程式碼中手動逐一檢查。 + +這些功能正是 Marshmallow 所要提供的。它是很棒的函式庫,我之前也大量使用。 + +但它誕生於 Python 型別提示出現之前。因此,為了定義每個 結構(schema),你需要使用 Marshmallow 提供的特定工具與類別。 + +/// check | 啟發 **FastAPI** + +用程式碼定義能自動提供資料型別與驗證的「schemas」。 + +/// + +### Webargs { #webargs } + +API 所需的另一項大功能,是從傳入請求中解析資料。 + +Webargs 是在多個框架(包含 Flask)之上提供該功能的工具。 + +它底層使用 Marshmallow 來做資料驗證,且由同一群開發者建立。 + +它是一個很棒的工具,在有 **FastAPI** 之前我也經常使用。 + +/// info + +Webargs 由與 Marshmallow 相同的開發者創建。 + +/// + +/// check | 啟發 **FastAPI** + +自動驗證傳入請求資料。 + +/// + +### APISpec { #apispec } + +Marshmallow 與 Webargs 以外掛提供驗證、解析與序列化。 + +但文件仍然缺失,於是 APISpec 出現了。 + +它是多個框架的外掛(Starlette 也有對應外掛)。 + +它的作法是:你在處理路由的每個函式的 docstring 中,用 YAML 格式撰寫結構定義。 + +然後它會產生 OpenAPI schemas。 + +在 Flask、Starlette、Responder 等框架中都是這樣運作。 + +但這又帶來一個問題:在 Python 字串中(大型 YAML)加入一段微語法。 + +編輯器幫不上太多忙。而且如果我們修改了參數或 Marshmallow 的 schemas 卻忘了同步修改 YAML docstring,產生的結構就會過時。 + +/// info + +APISpec 由與 Marshmallow 相同的開發者創建。 + +/// + +/// check | 啟發 **FastAPI** + +支援 API 的開放標準 OpenAPI。 + +/// + +### Flask-apispec { #flask-apispec } + +這是一個 Flask 外掛,把 Webargs、Marshmallow 與 APISpec 串在一起。 + +它使用 Webargs 與 Marshmallow 的資訊,透過 APISpec 自動產生 OpenAPI 結構。 + +它是個很棒但被低估的工具。它理應比許多 Flask 外掛更受歡迎,可能因為它的文件過於簡潔與抽象。 + +這解決了在 Python 文件字串中撰寫 YAML(另一種語法)的问题。 + +在打造 **FastAPI** 前,我最喜歡的後端技術組合就是 Flask、Flask-apispec、Marshmallow 與 Webargs。 + +使用它促成了數個 Flask 全端(full-stack)產生器。這些是我(以及若干外部團隊)至今主要使用的技術組合: + +* https://github.com/tiangolo/full-stack +* https://github.com/tiangolo/full-stack-flask-couchbase +* https://github.com/tiangolo/full-stack-flask-couchdb + +而這些全端產生器,也成為了 [**FastAPI** 專案產生器](project-generation.md){.internal-link target=_blank} 的基礎。 + +/// info + +Flask-apispec 由與 Marshmallow 相同的開發者創建。 + +/// + +/// check | 啟發 **FastAPI** + +從定義序列化與驗證的相同程式碼,自動產生 OpenAPI 結構(schema)。 + +/// + +### NestJS(與 Angular) { #nestjs-and-angular } + +這甚至不是 Python。NestJS 是受 Angular 啟發的 JavaScript(TypeScript)NodeJS 框架。 + +它達成的效果與 Flask-apispec 能做的有點相似。 + +它有一套受 Angular 2 啟發的整合式相依性注入(Dependency Injection)系統。需要預先註冊「可注入」元件(就像我所知的其他相依性注入系統一樣),因此會增加冗長與重複程式碼。 + +由於參數以 TypeScript 型別描述(與 Python 型別提示相似),編輯器支援相當不錯。 + +但因為 TypeScript 的型別在編譯成 JavaScript 後不會被保留,它無法僅靠型別同時定義驗證、序列化與文件。由於這點以及部分設計決定,若要取得驗證、序列化與自動結構產生,就需要在許多地方加上裝飾器,因此會相當冗長。 + +它無法很好地處理巢狀模型。若請求的 JSON 主體中有內層欄位,且這些內層欄位又是巢狀 JSON 物件,就無法被妥善地文件化與驗證。 + +/// check | 啟發 **FastAPI** + +使用 Python 型別以獲得優秀的編輯器支援。 + +提供強大的相依性注入系統,並想辦法將重複程式碼降到最低。 + +/// + +### Sanic { #sanic } + +它是最早基於 `asyncio` 的極高速 Python 框架之一,並做得很像 Flask。 + +/// note | 技術細節 + +它使用 `uvloop` 取代預設的 Python `asyncio` 事件圈。這也是它如此之快的原因。 + +它明顯啟發了 Uvicorn 與 Starlette,而在公開的基準測試中,它們目前比 Sanic 更快。 + +/// + +/// check | 啟發 **FastAPI** + +想辦法達到瘋狂的效能。 + +這就是為什麼 **FastAPI** 建立於 Starlette 之上,因為它是可用的最快框架(由第三方評測)。 + +/// + +### Falcon { #falcon } + +Falcon 是另一個高效能 Python 框架,設計上極簡,並作為其他框架(如 Hug)的基礎。 + +它設計為函式接收兩個參數,一個是「request」,一個是「response」。然後你從 request「讀取」資料、往 response「寫入」資料。由於這種設計,無法使用標準的 Python 型別提示,直接以函式參數宣告請求參數與主體。 + +因此,資料驗證、序列化與文件必須以程式碼手動完成,無法自動化。或者需在 Falcon 之上實作另一層框架(如 Hug)。其他受 Falcon 設計啟發的框架也有同樣的區別:將 request 與 response 物件作為參數。 + +/// check | 啟發 **FastAPI** + +設法取得優秀的效能。 + +連同 Hug(Hug 建立於 Falcon 之上)一起,也啟發 **FastAPI** 在函式中宣告一個 `response` 參數。 + +不過在 FastAPI 中它是可選的,主要用來設定標頭、Cookie 與替代狀態碼。 + +/// + +### Molten { #molten } + +我在 **FastAPI** 打造的早期發現了 Molten。它有一些相當類似的想法: + +* 基於 Python 型別提示。 +* 從這些型別取得驗證與文件。 +* 相依性注入系統。 + +它沒有使用像 Pydantic 這樣的第三方資料驗證、序列化與文件庫,而是有自己的。因此,這些資料型別定義較不容易重複使用。 + +它需要更為冗長的設定。而且因為它基於 WSGI(而非 ASGI),並未設計來享受如 Uvicorn、Starlette、Sanic 等工具所提供的高效能。 + +其相依性注入系統需要預先註冊依賴,並且依據宣告的型別來解析依賴。因此,無法宣告多個能提供相同型別的「元件」。 + +路由需要在單一地方宣告,使用在其他地方宣告的函式(而不是用可以直接放在端點處理函式上方的裝飾器)。這更接近 Django 的作法,而不是 Flask(與 Starlette)的作法。它在程式碼中分離了其實相當緊密耦合的事物。 + +/// check | 啟發 **FastAPI** + +用模型屬性的「預設值」來定義資料型別的額外驗證。這提升了編輯器支援,而這在當時的 Pydantic 還不支援。 + +這實際上也啟發了 Pydantic 的部分更新,以支援相同的驗證宣告風格(這些功能現在已在 Pydantic 中可用)。 + +/// + +### Hug { #hug } + +Hug 是最早使用 Python 型別提示來宣告 API 參數型別的框架之一。這是個很棒的點子,也啟發了其他工具。 + +它在宣告中使用自訂型別而非標準 Python 型別,但仍然是巨大的一步。 + +它也是最早能以 JSON 產出自訂結構、描述整個 API 的框架之一。 + +它不是基於 OpenAPI 與 JSON Schema 等標準。因此,與其他工具(如 Swagger UI)的整合並不直覺。但它仍是一個非常創新的想法。 + +它有個有趣、少見的功能:同一個框架可同時建立 API 與 CLI。 + +由於它基於同步 Python 網頁框架的舊標準(WSGI),無法處理 WebSocket 與其他功能,儘管效能仍然很高。 + +/// info + +Hug 由 Timothy Crosley 創建,他同時也是 `isort` 的作者,一個自動排序 Python 匯入的好工具。 + +/// + +/// check | 啟發 **FastAPI** 的想法 + +Hug 啟發了 APIStar 的部分設計,也是我覺得最有前景的工具之一,與 APIStar 並列。 + +Hug 啟發 **FastAPI** 使用 Python 型別提示宣告參數,並自動產生定義 API 的結構。 + +Hug 啟發 **FastAPI** 在函式中宣告 `response` 參數以設定標頭與 Cookie。 + +/// + +### APIStar (<= 0.5) { #apistar-0-5 } + +在決定打造 **FastAPI** 之前,我找到了 **APIStar** 伺服器。它幾乎具備我所尋找的一切,而且設計很出色。 + +它是我見過最早使用 Python 型別提示來宣告參數與請求的框架實作之一(早於 NestJS 與 Molten)。我與 Hug 幾乎在同時間發現它。不過 APIStar 使用的是 OpenAPI 標準。 + +它基於相同的型別提示,在多處自動進行資料驗證、資料序列化與 OpenAPI 結構產生。 + +主體結構(body schema)的定義並未使用像 Pydantic 那樣的 Python 型別提示,更像 Marshmallow,因此編輯器支援沒有那麼好,但整體而言,APIStar 是當時最好的選擇。 + +它在當時的效能評測中名列前茅(僅被 Starlette 超越)。 + +一開始它沒有自動 API 文件的網頁 UI,但我知道我可以替它加上 Swagger UI。 + +它有相依性注入系統。需要預先註冊元件,與上面提到的其他工具相同。不過這仍是很棒的功能。 + +我從未能在完整專案中使用它,因為它沒有安全性整合,所以無法取代我用 Flask-apispec 全端產生器所擁有的全部功能。我曾把新增該功能的 pull request 放在待辦清單中。 + +但之後,專案的重心改變了。 + +它不再是 API 網頁框架,因為作者需要專注於 Starlette。 + +現在的 APIStar 是一套用於驗證 OpenAPI 規格的工具,不是網頁框架。 + +/// info + +APIStar 由 Tom Christie 創建。他也創建了: + +* Django REST Framework +* Starlette(**FastAPI** 建立於其上) +* Uvicorn(Starlette 與 **FastAPI** 使用) + +/// + +/// check | 啟發 **FastAPI** + +存在。 + +用相同的 Python 型別同時宣告多件事(資料驗證、序列化與文件),並同時提供出色的編輯器支援,這是一個極好的點子。 + +在長時間尋找並測試多種不同替代方案後,APIStar 是最好的可用選擇。 + +當 APIStar 不再作為伺服器存在,而 Starlette 誕生並成為更好的基礎時,這成為打造 **FastAPI** 的最後一個靈感。 + +我將 **FastAPI** 視為 APIStar 的「精神繼承者」,同時基於所有這些先前工具的經驗,改進並擴增了功能、型別系統與其他部分。 + +/// + +## **FastAPI** 所採用的工具 { #used-by-fastapi } + +### Pydantic { #pydantic } + +Pydantic 是基於 Python 型別提示,定義資料驗證、序列化與文件(使用 JSON Schema)的函式庫。 + +這讓它非常直覺。 + +它可與 Marshmallow 相提並論。儘管在效能測試中它比 Marshmallow 更快。而且因為它基於相同的 Python 型別提示,編輯器支援也很出色。 + +/// check | **FastAPI** 用於 + +處理所有資料驗證、資料序列化與自動模型文件(基於 JSON Schema)。 + +**FastAPI** 接著會把這些 JSON Schema 資料放入 OpenAPI 中,此外還有其他許多功能。 + +/// + +### Starlette { #starlette } + +Starlette 是一個輕量的 ASGI 框架/工具集,非常適合用來建構高效能的 asyncio 服務。 + +它非常簡單直觀。設計上易於擴充,且元件化。 + +它具備: + +* 令人印象深刻的效能。 +* WebSocket 支援。 +* 行程內(in-process)背景任務。 +* 啟動與關閉事件。 +* 建立在 HTTPX 上的測試用戶端。 +* CORS、GZip、靜態檔案、串流回應。 +* Session 與 Cookie 支援。 +* 100% 測試涵蓋率。 +* 100% 型別註解的程式碼庫。 +* 幾乎沒有硬性相依。 + +Starlette 目前是測試中最快的 Python 框架。僅次於 Uvicorn(它不是框架,而是伺服器)。 + +Starlette 提供所有網頁微框架的基礎功能。 + +但它不提供自動的資料驗證、序列化或文件。 + +這正是 **FastAPI** 在其上方加入的主要功能之一,且全部基於 Python 型別提示(使用 Pydantic)。此外還有相依性注入系統、安全性工具、OpenAPI 結構產生等。 + +/// note | 技術細節 + +ASGI 是由 Django 核心團隊成員正在開發的新「標準」。它尚未成為「Python 標準」(PEP),但他們正著手進行中。 + +儘管如此,它已被多個工具作為「標準」採用。這大幅提升了互通性,例如你可以把 Uvicorn 換成其他 ASGI 伺服器(如 Daphne 或 Hypercorn),或加入相容 ASGI 的工具,如 `python-socketio`。 + +/// + +/// check | **FastAPI** 用於 + +處理所有核心網頁部分,並在其上加上功能。 + +`FastAPI` 這個類別本身直接繼承自 `Starlette` 類別。 + +因此,凡是你能用 Starlette 做的事,你幾乎都能直接用 **FastAPI** 完成,因為它基本上就是加強版的 Starlette。 + +/// + +### Uvicorn { #uvicorn } + +Uvicorn 是基於 uvloop 與 httptools 的極速 ASGI 伺服器。 + +它不是網頁框架,而是伺服器。例如,它不提供依據路徑路由的工具。這是像 Starlette(或 **FastAPI**)這樣的框架在其上方提供的功能。 + +它是 Starlette 與 **FastAPI** 推薦使用的伺服器。 + +/// check | **FastAPI** 建議用作 + +執行 **FastAPI** 應用的主要網頁伺服器。 + +你也可以使用 `--workers` 命令列選項,取得非同步的多製程伺服器。 + +更多細節請見[部署](deployment/index.md){.internal-link target=_blank}章節。 + +/// + +## 效能與速度 { #benchmarks-and-speed } + +想了解、比較並看出 Uvicorn、Starlette 與 FastAPI 之間的差異,請參考[效能評測](benchmarks.md){.internal-link target=_blank}。 diff --git a/docs/zh-hant/docs/async.md b/docs/zh-hant/docs/async.md index 09e2bf9949..a03d71815f 100644 --- a/docs/zh-hant/docs/async.md +++ b/docs/zh-hant/docs/async.md @@ -1,10 +1,10 @@ -# 並行與 async / await +# 並行與 async / await { #concurrency-and-async-await } 有關*路徑操作函式*的 `async def` 語法的細節與非同步 (asynchronous) 程式碼、並行 (concurrency) 與平行 (parallelism) 的一些背景知識。 -## 趕時間嗎? +## 趕時間嗎? { #in-a-hurry } -TL;DR: +TL;DR: 如果你正在使用要求你以 `await` 語法呼叫的第三方函式庫,例如: @@ -41,7 +41,7 @@ def results(): --- -如果你的應用程式不需要與外部資源進行任何通訊並等待其回應,請使用 `async def`。 +如果你的應用程式不需要與外部資源進行任何通訊並等待其回應,請使用 `async def`,即使內部不需要使用 `await` 也可以。 --- @@ -55,7 +55,7 @@ def results(): 但透過遵循上述步驟,它將能進行一些效能最佳化。 -## 技術細節 +## 技術細節 { #technical-details } 現代版本的 Python 支援使用 **「協程」** 的 **`async` 和 `await`** 語法來寫 **「非同步程式碼」**。 @@ -65,7 +65,7 @@ def results(): * **`async` 和 `await`** * **協程** -## 非同步程式碼 +## 非同步程式碼 { #asynchronous-code } 非同步程式碼僅意味著程式語言 💬 有辦法告訴電腦/程式 🤖 在程式碼中的某個點,它 🤖 需要等待某些事情完成。讓我們假設這些事情被稱為「慢速檔案」📝。 @@ -74,7 +74,7 @@ def results(): 接著程式 🤖 會在有空檔時回來查看是否有等待的工作已經完成,並執行必要的後續操作。 接下來,它 🤖 完成第一個工作(例如我們的「慢速檔案」📝)並繼續執行相關的所有操作。 -這個「等待其他事情」通常指的是一些相對較慢的(與處理器和 RAM 記憶體的速度相比)的 I/O 操作,比如說: +這個「等待其他事情」通常指的是一些相對較慢的(與處理器和 RAM 記憶體的速度相比)的 I/O 操作,比如說: * 透過網路傳送來自用戶端的資料 * 從網路接收來自用戶端的資料 @@ -85,7 +85,7 @@ def results(): * 資料庫查詢 * 等等 -由於大部分的執行時間都消耗在等待 I/O 操作上,因此這些操作被稱為 "I/O 密集型" 操作。 +由於大部分的執行時間都消耗在等待 I/O 操作上,因此這些操作被稱為 "I/O 密集型" 操作。 之所以稱為「非同步」,是因為電腦/程式不需要與那些耗時的任務「同步」,等待任務完成的精確時間,然後才能取得結果並繼續工作。 @@ -93,7 +93,7 @@ def results(): 相對於「非同步」(asynchronous),「同步」(synchronous)也常被稱作「順序性」(sequential),因為電腦/程式會依序執行所有步驟,即便這些步驟涉及等待,才會切換到其他任務。 -### 並行與漢堡 +### 並行與漢堡 { #concurrency-and-burgers } 上述非同步程式碼的概念有時也被稱為「並行」,它不同於「平行」。 @@ -103,7 +103,7 @@ def results(): 為了理解差異,請想像以下有關漢堡的故事: -### 並行漢堡 +### 並行漢堡 { #concurrent-burgers } 你和你的戀人去速食店,排隊等候時,收銀員正在幫排在你前面的人點餐。😍 @@ -163,7 +163,7 @@ def results(): 然後你走向櫃檯 🔀,回到已經完成的最初任務 ⏯,拿起漢堡,說聲謝謝,並帶回桌上。這就結束了與櫃檯的互動步驟/任務 ⏹,接下來會產生一個新的任務,「吃漢堡」 🔀 ⏯,而先前的「拿漢堡」任務已經完成了 ⏹。 -### 平行漢堡 +### 平行漢堡 { #parallel-burgers } 現在,讓我們來想像這裡不是「並行漢堡」,而是「平行漢堡」。 @@ -233,7 +233,7 @@ def results(): 所以,你不會想帶你的戀人 😍 一起去銀行辦事 🏦。 -### 漢堡結論 +### 漢堡結論 { #burger-conclusion } 在「和戀人一起吃速食漢堡」的這個場景中,由於有大量的等待 🕙,使用並行系統 ⏸🔀⏯ 更有意義。 @@ -253,7 +253,7 @@ def results(): 你可以同時利用並行性和平行性,進一步提升效能,這比大多數已測試的 NodeJS 框架都更快,並且與 Go 語言相當,而 Go 是一種更接近 C 的編譯語言(感謝 Starlette)。 -### 並行比平行更好嗎? +### 並行比平行更好嗎? { #is-concurrency-better-than-parallelism } 不是的!這不是故事的本意。 @@ -277,7 +277,7 @@ def results(): 在這個場景中,每個清潔工(包括你)都是一個處理器,完成工作的一部分。 -由於大多數的執行時間都花在實際的工作上(而不是等待),而電腦中的工作由 CPU 完成,因此這些問題被稱為「CPU 密集型」。 +由於大多數的執行時間都花在實際的工作上(而不是等待),而電腦中的工作由 CPU 完成,因此這些問題被稱為「CPU 密集型」。 --- @@ -290,7 +290,7 @@ def results(): * **機器學習**: 通常需要大量的「矩陣」和「向量」運算。想像一個包含數字的巨大電子表格,並所有的數字同時相乘; * **深度學習**: 這是機器學習的子領域,同樣適用。只不過這不僅僅是一張數字表格,而是大量的數據集合,並且在很多情況下,你會使用特殊的處理器來構建或使用這些模型。 -### 並行 + 平行: Web + 機器學習 +### 並行 + 平行: Web + 機器學習 { #concurrency-parallelism-web-machine-learning } 使用 **FastAPI**,你可以利用並行的優勢,這在 Web 開發中非常常見(這也是 NodeJS 的最大吸引力)。 @@ -300,9 +300,9 @@ def results(): 想了解如何在生產環境中實現這種平行性,請參見 [部屬](deployment/index.md){.internal-link target=_blank}。 -## `async` 和 `await` +## `async` 和 `await` { #async-and-await } -現代 Python 版本提供一種非常直觀的方式定義非同步程式碼。這使得它看起來就像正常的「順序」程式碼,並在適當的時機「等待」。 +現代 Python 版本提供一種非常直觀的方式定義非同步程式碼。這使得它看起來就像正常的「順序」程式碼,並在適當的時機替你「等待」。 當某個操作需要等待才能回傳結果,並且支援這些新的 Python 特性時,你可以像這樣編寫程式碼: @@ -329,7 +329,7 @@ def get_sequential_burgers(number: int): return burgers ``` -使用 `async def`,Python Python 知道在該函式內需要注意 `await`,並且它可以「暫停」 ⏸ 執行該函式,然後執行其他任務 🔀 後回來。 +使用 `async def`,Python 知道在該函式內需要注意 `await`,並且它可以「暫停」 ⏸ 執行該函式,然後執行其他任務 🔀 後回來。 當你想要呼叫 `async def` 函式時,必須使用「await」。因此,這樣寫將無法運行: @@ -349,11 +349,11 @@ async def read_burgers(): return burgers ``` -### 更多技術細節 +### 更多技術細節 { #more-technical-details } 你可能已經注意到,`await` 只能在 `async def` 定義的函式內使用。 -但同時,使用 `async def` 定義的函式本身也必須被「等待」。所以,帶有 `async def` 函式只能在其他使用 `async def` 定義的函式內呼叫。 +但同時,使用 `async def` 定義的函式本身也必須被「等待」。所以,帶有 `async def` 的函式只能在其他使用 `async def` 定義的函式內呼叫。 那麼,這就像「先有雞還是先有蛋」的問題,要如何呼叫第一個 `async` 函式呢? @@ -361,35 +361,37 @@ async def read_burgers(): 但如果你想在沒有 FastAPI 的情況下使用 `async` / `await`,你也可以這樣做。 -### 編寫自己的非同步程式碼 +### 編寫自己的非同步程式碼 { #write-your-own-async-code } -Starlette (和 **FastAPI**) 是基於 AnyIO 實作的,這使得它們與 Python 標準函式庫相容 asyncioTrio。 +Starlette(和 **FastAPI**)是基於 AnyIO 實作的,這使得它們與 Python 標準函式庫 asyncioTrio 相容。 特別是,你可以直接使用 AnyIO 來處理更複雜的並行使用案例,這些案例需要你在自己的程式碼中使用更高階的模式。 -即使你不使用 **FastAPI**,你也可以使用 AnyIO 來撰寫自己的非同步應用程式,並獲得高相容性及一些好處(例如結構化並行)。 +即使你不使用 **FastAPI**,你也可以使用 AnyIO 來撰寫自己的非同步應用程式,並獲得高相容性及一些好處(例如「結構化並行」)。 -### 其他形式的非同步程式碼 +我另外在 AnyIO 之上做了一個薄封裝的函式庫,稍微改進型別註解以獲得更好的**自動補全**、**即時錯誤**等。同時它也提供友善的介紹與教學,幫助你**理解**並撰寫**自己的非同步程式碼**:Asyncer。當你需要**將非同步程式碼與一般**(阻塞/同步)**程式碼整合**時,它特別實用。 + +### 其他形式的非同步程式碼 { #other-forms-of-asynchronous-code } 使用 `async` 和 `await` 的風格在語言中相對較新。 -但它使處理異步程式碼變得更加容易。 +但它使處理非同步程式碼變得更加容易。 相同的語法(或幾乎相同的語法)最近也被包含在現代 JavaScript(無論是瀏覽器還是 NodeJS)中。 -但在此之前,處理異步程式碼要更加複雜和困難。 +但在此之前,處理非同步程式碼要更加複雜和困難。 在較舊的 Python 版本中,你可能會使用多執行緒或 Gevent。但這些程式碼要更難以理解、調試和思考。 在較舊的 NodeJS / 瀏覽器 JavaScript 中,你會使用「回呼」,這可能會導致“回呼地獄”。 -## 協程 +## 協程 { #coroutines } -**協程** 只是 `async def` 函式所回傳的非常特殊的事物名稱。Python 知道它是一個類似函式的東西,可以啟動它,並且在某個時刻它會結束,但它也可能在內部暫停 ⏸,只要遇到 `await`。 +「協程」只是 `async def` 函式所回傳的非常特殊的事物名稱。Python 知道它是一個類似函式的東西,可以啟動它,並且在某個時刻它會結束,但它也可能在內部暫停 ⏸,只要遇到 `await`。 這種使用 `async` 和 `await` 的非同步程式碼功能通常被概括為「協程」。這與 Go 語言的主要特性「Goroutines」相似。 -## 結論 +## 結論 { #conclusion } 讓我們再次回顧之前的句子: @@ -397,9 +399,9 @@ Starlette (和 **FastAPI**) 是基於 I/O 的程式碼。 +如果你來自於其他不以這種方式運作的非同步框架,而且你習慣於使用普通的 `def` 定義僅進行簡單計算的*路徑操作函式*,目的是獲得微小的性能增益(大約 100 奈秒),請注意,在 FastAPI 中,效果會完全相反。在這些情況下,最好使用 `async def`,除非你的*路徑操作函式*執行阻塞的 I/O 的程式碼。 -不過,在這兩種情況下,**FastAPI** [仍然很快](index.md#_11){.internal-link target=_blank}至少與你之前的框架相當(或者更快)。 +不過,在這兩種情況下,**FastAPI** [仍然很快](index.md#performance){.internal-link target=_blank},至少與你之前的框架相當(或者更快)。 -### 依賴項(Dependencies) +### 依賴項(Dependencies) { #dependencies } 同樣適用於[依賴項](tutorial/dependencies/index.md){.internal-link target=_blank}。如果依賴項是一個標準的 `def` 函式,而不是 `async def`,那麼它在外部的執行緒池被運行。 -### 子依賴項 +### 子依賴項 { #sub-dependencies } -你可以擁有多個相互依賴的依賴項和[子依賴項](tutorial/dependencies/sub-dependencies.md){.internal-link target=_blank} (作為函式定義的參數),其中一些可能是用 `async def` 宣告,也可能是用 `def` 宣告。它們仍然可以正常運作,用 `def` 定義的那些將會在外部的執行緒中呼叫(來自執行緒池),而不是被「等待」。 +你可以擁有多個相互依賴的依賴項和[子依賴項](tutorial/dependencies/sub-dependencies.md){.internal-link target=_blank}(作為函式定義的參數),其中一些可能是用 `async def` 宣告,也可能是用 `def` 宣告。它們仍然可以正常運作,用 `def` 定義的那些將會在外部的執行緒中呼叫(來自執行緒池),而不是被「等待」。 -### 其他輔助函式 +### 其他輔助函式 { #other-utility-functions } 你可以直接呼叫任何使用 `def` 或 `async def` 建立的其他輔助函式,FastAPI 不會影響你呼叫它們的方式。 @@ -439,4 +441,4 @@ Starlette (和 **FastAPI**) 是基於 趕時間嗎?. +否則,只需遵循上面提到的指引即可:趕時間嗎?。 diff --git a/docs/zh-hant/docs/benchmarks.md b/docs/zh-hant/docs/benchmarks.md index df49621c53..c5b76700b3 100644 --- a/docs/zh-hant/docs/benchmarks.md +++ b/docs/zh-hant/docs/benchmarks.md @@ -6,7 +6,7 @@ ## 基準測試和速度 { #benchmarks-and-speed } -當你查看基準測試時,時常會見到幾個不同類型的工具被同時進行測試。 +當你查看基準測試時,常見到不同類型的多個工具被視為等同來比較。 具體來說,是將 Uvicorn、Starlette 和 FastAPI 同時進行比較(以及許多其他工具)。 @@ -20,7 +20,7 @@ * **Uvicorn**: * 具有最佳效能,因為除了伺服器本身之外,它沒有太多額外的程式碼。 - * 你不會直接在 Uvicorn 中編寫應用程式。這意味著你的程式碼必須或多或少地包含 Starlette(或 **FastAPI**)提供的所有程式碼。如果你這樣做,你的最終應用程式將具有與使用框架相同的開銷並最大限度地減少應用程式程式碼和錯誤。 + * 你不會直接在 Uvicorn 中編寫應用程式。這意味著你的程式碼必須或多或少地包含 Starlette(或 **FastAPI**)提供的所有程式碼。如果你這樣做,你的最終應用程式將具有與使用框架相同的開銷,且無法像使用框架那樣減少應用程式程式碼與錯誤。 * 如果你要比較 Uvicorn,請將其與 Daphne、Hypercorn、uWSGI 等應用程式伺服器進行比較。 * **Starlette**: * 繼 Uvicorn 之後的次佳表現。事實上,Starlette 使用 Uvicorn 來運行。因此它將可能只透過執行更多程式碼而變得比 Uvicorn「慢」。 diff --git a/docs/zh-hant/docs/deployment/concepts.md b/docs/zh-hant/docs/deployment/concepts.md new file mode 100644 index 0000000000..0cca31d260 --- /dev/null +++ b/docs/zh-hant/docs/deployment/concepts.md @@ -0,0 +1,321 @@ +# 部署概念 { #deployments-concepts } + +當你要部署一個 FastAPI 應用,或其實任何類型的 Web API 時,有幾個你可能在意的概念。掌握這些概念後,你就能找出最適合部署你應用的方式。 + +一些重要的概念包括: + +- 安全性 - HTTPS +- 開機自動執行 +- 重新啟動 +- 複本(執行中的行程數量) +- 記憶體 +- 啟動前的前置步驟 + +我們將看看它們如何影響部署。 + +最終目標是能夠以安全、避免中斷,並盡可能高效使用運算資源(例如遠端伺服器/虛擬機)的方式來服務你的 API 用戶端。🚀 + +我會在這裡多介紹一些這些觀念,希望能幫你建立必要的直覺,讓你能在非常不同、甚至尚未出現的未來環境中決定要如何部署你的 API。 + +在思考這些概念之後,你將能夠評估與設計最適合部署你自己 API 的方式。 + +在接下來的章節,我會提供更具體的部署 FastAPI 應用的食譜。 + +但現在,先來看看這些重要的概念想法。這些概念同樣適用於任何其他類型的 Web API。💡 + +## 安全性 - HTTPS { #security-https } + +在[前一章關於 HTTPS](https.md){.internal-link target=_blank} 中,我們學到 HTTPS 如何為你的 API 提供加密。 + +我們也看到,HTTPS 通常由應用伺服器外部的元件提供,即 TLS Termination Proxy。 + +而且必須有某個東西負責續期 HTTPS 憑證,可能是同一個元件,也可能是不同的東西。 + +### HTTPS 工具範例 { #example-tools-for-https } + +你可以用來作為 TLS Termination Proxy 的工具包括: + +- Traefik + - 自動處理憑證續期 ✨ +- Caddy + - 自動處理憑證續期 ✨ +- Nginx + - 搭配像 Certbot 這類外部元件進行憑證續期 +- HAProxy + - 搭配像 Certbot 這類外部元件進行憑證續期 +- Kubernetes,使用如 Nginx 的 Ingress Controller + - 搭配像 cert-manager 這類外部元件進行憑證續期 +- 由雲端供應商在其服務內部處理(見下文 👇) + +另一個選項是使用能幫你做更多事情的雲端服務(包含設定 HTTPS)。它可能有一些限制或要額外付費等。但在那種情況下,你就不必自己設定 TLS Termination Proxy。 + +我會在後續章節展示一些具體例子。 + +--- + +接下來要考慮的概念都與實際執行你的 API 的程式(例如 Uvicorn)有關。 + +## 程式與行程 { #program-and-process } + +我們會常提到執行中的「行程(process)」,因此先釐清它的意思,以及與「程式(program)」的差異很有幫助。 + +### 什麼是程式 { #what-is-a-program } + +「程式(program)」一詞常用來描述許多東西: + +- 你寫的原始碼,也就是 Python 檔案。 +- 可由作業系統執行的檔案,例如:`python`、`python.exe` 或 `uvicorn`。 +- 在作業系統上執行中的特定程式,使用 CPU 並將資料存於記憶體。這也稱為「行程」。 + +### 什麼是行程 { #what-is-a-process } + +「行程(process)」通常以更特定的方式使用,只指作業系統中正在執行的東西(如上面最後一點): + +- 在作業系統上「執行中」的特定程式。 + - 這不是指檔案或原始碼,而是特指正在被作業系統執行並管理的那個東西。 +- 任何程式、任何程式碼,只有在「被執行」時才能做事。所以,當有「行程在執行」時才能運作。 +- 行程可以被你或作業系統終止(kill)。此時它就停止執行,無法再做任何事。 +- 你電腦上執行的每個應用程式、每個視窗等,背後都有一些行程。而且在電腦開機時,通常會同時有許多行程在跑。 +- 同一個程式可以同時有多個行程在執行。 + +如果你打開作業系統的「工作管理員」或「系統監控器」(或類似工具),就能看到許多正在執行的行程。 + +例如,你大概會看到同一個瀏覽器(Firefox、Chrome、Edge 等)會有多個行程在執行。它們通常每個分頁一個行程,外加其他一些額外行程。 + + + +--- + +現在我們知道「行程」與「程式」的差異了,繼續談部署。 + +## 開機自動執行 { #running-on-startup } + +多數情況下,當你建立一個 Web API,你會希望它「一直在執行」,不中斷,讓客戶端隨時可用。除非你有特定理由只在某些情況下才執行,但大部分時候你會希望它持續運作並且可用。 + +### 在遠端伺服器上 { #in-a-remote-server } + +當你設定一台遠端伺服器(雲端伺服器、虛擬機等),最簡單的作法就是像本機開發時一樣,手動使用 `fastapi run`(它使用 Uvicorn)或類似的方式。 + +這在「開發期間」會運作良好而且有用。 + +但如果你與伺服器的連線中斷,正在執行的行程很可能會死掉。 + +而如果伺服器被重新啟動(例如更新後、或雲端供應商進行遷移),你大概「不會注意到」。因此你甚至不知道要手動重啟行程。你的 API 就會一直掛著。😱 + +### 開機自動啟動 { #run-automatically-on-startup } + +通常你會希望伺服器程式(例如 Uvicorn)在伺服器開機時自動啟動,且不需任何「人工介入」,讓你的 API(例如 Uvicorn 執行你的 FastAPI 應用)總是有行程在跑。 + +### 獨立程式 { #separate-program } + +為了達成這點,你通常會有一個「獨立的程式」來確保你的應用在開機時會被啟動。很多情況下,它也會確保其他元件或應用一併啟動,例如資料庫。 + +### 開機自動啟動的工具範例 { #example-tools-to-run-at-startup } + +能做到這件事的工具包括: + +- Docker +- Kubernetes +- Docker Compose +- Docker 的 Swarm 模式 +- Systemd +- Supervisor +- 由雲端供應商在其服務內部處理 +- 其他... + +我會在後續章節給出更具體的例子。 + +## 重新啟動 { #restarts } + +和確保你的應用在開機時會執行一樣,你大概也會希望在發生失敗之後,它能「自動重新啟動」。 + +### 人都會犯錯 { #we-make-mistakes } + +我們身為人,常常會犯錯。軟體幾乎總是有藏在各處的「臭蟲(bugs)」🐛 + +而我們開發者會在發現這些 bug 後持續改進程式碼、實作新功能(也可能順便加進新的 bug 😅)。 + +### 小錯誤自動處理 { #small-errors-automatically-handled } + +使用 FastAPI 建構 Web API 時,如果我們的程式碼出錯,FastAPI 通常會把它限制在觸發該錯誤的單次請求之中。🛡 + +用戶端會收到「500 Internal Server Error」,但應用會繼續處理之後的請求,而不是整個崩潰。 + +### 更嚴重的錯誤 - 當機 { #bigger-errors-crashes } + +然而,仍可能有一些情況,我們寫的程式碼「讓整個應用當機」,使 Uvicorn 與 Python 都崩潰。💥 + +即便如此,你大概也不會希望應用因為某處錯誤就一直處於死亡狀態,你可能會希望它「繼續運作」,至少讓沒有壞掉的「路徑操作(path operations)」能持續服務。 + +### 當機後重新啟動 { #restart-after-crash } + +在這些會讓「執行中行程」整個崩潰的嚴重錯誤案例裡,你會希望有個外部元件負責「重新啟動」該行程,至少嘗試幾次... + +/// tip + +...不過,如果整個應用「一啟動就立刻」崩潰,那持續無止境地重啟大概沒有意義。但在這類情況下,你很可能會在開發過程中就發現,或至少在部署後馬上注意到。 + +所以讓我們專注在主要情境:應用在未來某些特定案例中可能會整體崩潰,但此時重新啟動仍然是有意義的。 + +/// + +你大概會希望把負責重新啟動應用的東西放在「外部元件」,因為那個時候,應用本身連同 Uvicorn 與 Python 都已經掛了,在同一個應用的程式碼裡也無法做什麼。 + +### 自動重新啟動的工具範例 { #example-tools-to-restart-automatically } + +多數情況下,用來「在開機時啟動程式」的同一套工具,也會負責處理自動「重新啟動」。 + +例如,可以由下列工具處理: + +- Docker +- Kubernetes +- Docker Compose +- Docker 的 Swarm 模式 +- Systemd +- Supervisor +- 由雲端供應商在其服務內部處理 +- 其他... + +## 複本:行程與記憶體 { #replication-processes-and-memory } + +在 FastAPI 應用中,使用像 `fastapi` 指令(執行 Uvicorn)的伺服器程式,即使只在「一個行程」中執行,也能同時服務多個客戶端。 + +但很多情況下,你會想同時執行多個工作行程(workers)。 + +### 多個行程 - Workers { #multiple-processes-workers } + +如果你的客戶端比單一行程所能處理的更多(例如虛擬機規格不大),而伺服器 CPU 有「多核心」,那你可以同時執行「多個行程」載入相同的應用,並把所有請求分散給它們。 + +當你執行同一個 API 程式的「多個行程」時,通常稱為「workers(工作行程)」。 + +### 工作行程與連接埠 { #worker-processes-and-ports } + +還記得文件中[關於 HTTPS](https.md){.internal-link target=_blank} 的說明嗎:在一台伺服器上,一組 IP 與連接埠的組合只能由「一個行程」監聽? + +這裡同樣適用。 + +因此,若要同時擁有「多個行程」,就必須有「單一行程」在該連接埠上監聽,然後以某種方式把通信傳遞給各個工作行程。 + +### 每個行程的記憶體 { #memory-per-process } + +當程式把東西載入記憶體時,例如把機器學習模型存到變數中,或把大型檔案內容讀到變數中,這些都會「消耗一些伺服器的記憶體(RAM)」。 + +而多個行程通常「不共享記憶體」。這表示每個執行中的行程都有自己的東西、變數與記憶體。如果你的程式碼會用掉大量記憶體,「每個行程」都會消耗等量的記憶體。 + +### 伺服器記憶體 { #server-memory } + +例如,如果你的程式碼載入一個「1 GB 大小」的機器學習模型,當你用一個行程執行你的 API,它就會至少吃掉 1 GB 的 RAM。若你啟動「4 個行程」(4 個 workers),每個會吃 1 GB RAM。總計你的 API 會吃掉「4 GB RAM」。 + +如果你的遠端伺服器或虛擬機只有 3 GB RAM,嘗試載入超過 4 GB 的 RAM 就會出問題。🚨 + +### 多個行程 - 範例 { #multiple-processes-an-example } + +在這個例子中,有一個「管理行程(Manager Process)」會啟動並控制兩個「工作行程(Worker Processes)」。 + +這個管理行程大概就是在 IP 的「連接埠」上監聽的那個。它會把所有通信轉發到各個工作行程。 + +那些工作行程才是實際執行你的應用的,它們會完成主要的計算,接收「請求」並回傳「回應」,也會把你放在變數中的東西載入 RAM。 + + + +當然,同一台機器上除了你的應用之外,通常也會有「其他行程」在執行。 + +有個有趣的細節是,每個行程的「CPU 使用率」百分比會隨時間大幅「變動」,但「記憶體(RAM)」通常維持相對「穩定」。 + +如果你的 API 每次做的計算量相近,且客戶很多,那「CPU 使用率」也可能「相對穩定」(而不是快速上下起伏)。 + +### 複本與擴展的工具與策略範例 { #examples-of-replication-tools-and-strategies } + +要達成這些有很多種作法。我會在後續章節(例如談到 Docker 與容器時)介紹更具體的策略。 + +主要的限制是:必須有「單一」元件負責處理「公開 IP」上的「連接埠」。接著它必須能把通信「轉發」到被複製的「行程/workers」。 + +以下是一些可能的組合與策略: + +- Uvicorn 搭配 `--workers` + - 一個 Uvicorn「管理行程」會在「IP」與「連接埠」上監聽,並啟動「多個 Uvicorn 工作行程」。 +- Kubernetes 與其他分散式「容器系統」 + - 由「Kubernetes」層在「IP」與「連接埠」上監聽。複本的方式是有「多個容器」,每個容器內執行「一個 Uvicorn 行程」。 +- 由「雲端服務」替你處理 + - 雲端服務很可能「替你處理複本」。它可能讓你定義「要執行的行程」或「容器映像」,無論如何,多半會是「單一 Uvicorn 行程」,而由雲端服務負責進行複製。 + +/// tip + +先別擔心這裡提到的「容器」、Docker 或 Kubernetes 如果現在還不太懂。 + +我會在未來的章節進一步說明容器映像、Docker、Kubernetes 等等:[容器中的 FastAPI - Docker](docker.md){.internal-link target=_blank}。 + +/// + +## 啟動前的前置步驟 { #previous-steps-before-starting } + +很多情況下,你會希望在應用「啟動之前」先執行一些步驟。 + +例如,你可能想先執行「資料庫遷移」。 + +但在多數情況下,你會希望這些步驟只執行「一次」。 + +所以,你會希望用「單一行程」來執行那些「前置步驟」,在啟動應用之前完成。 + +而且即使之後你要為應用本身啟動「多個行程」(多個 workers),你也必須確保只有一個行程在跑那些前置步驟。若由「多個行程」去跑,會在「平行」中重複同樣的工作;而如果那些步驟像是資料庫遷移這類敏感操作,它們之間可能會互相衝突。 + +當然,也有一些情況,重複執行前置步驟不會有問題;在那種情況下就容易處理得多。 + +/// tip + +另外請記住,依照你的設定,在某些情況下你「甚至可能不需要任何前置步驟」才能啟動應用。 + +這種情況下,你就不用為此費心了。🤷 + +/// + +### 前置步驟策略範例 { #examples-of-previous-steps-strategies } + +這會「高度取決於」你「部署系統」的方式,而且很可能與你如何啟動程式、處理重新啟動等有關。 + +以下是一些可能的做法: + +- 在 Kubernetes 中使用一個「Init Container」,它會在你的應用容器之前先執行 +- 一個 bash 腳本先跑前置步驟,然後再啟動你的應用 + - 你仍然需要有機制來啟動/重新啟動「那個」bash 腳本、偵測錯誤等 + +/// tip + +我會在未來關於容器的章節提供更具體的範例:[容器中的 FastAPI - Docker](docker.md){.internal-link target=_blank}。 + +/// + +## 資源使用率 { #resource-utilization } + +你的伺服器(群)是可以被「消耗/利用」的「資源」,你的程式會使用 CPU 的計算時間,以及可用的 RAM 記憶體。 + +你想要消耗/利用多少系統資源?直覺上可能會想「不要太多」,但實際上,你大概會希望在「不當機」的前提下「盡可能用多一點」。 + +如果你花錢租了 3 台伺服器,卻只用了它們少量的 RAM 與 CPU,那你可能是在「浪費金錢」💸、也「浪費伺服器電力」🌎 等。 + +在那種情況下,可能更好的是只用 2 台伺服器,並以更高的比例使用它們的資源(CPU、記憶體、磁碟、網路頻寬等)。 + +另一方面,如果你有 2 台伺服器,且你使用了它們「100% 的 CPU 與 RAM」,某個時刻一個行程會要求更多記憶體,伺服器就得用磁碟當作「記憶體」(這可能慢上數千倍),甚至「當機」。或是某個行程需要做計算時,必須等到 CPU 再度空閒。 + +這種情況下,最好是再加一台伺服器,並在上面跑部分行程,讓所有行程都有「足夠的 RAM 與 CPU 時間」。 + +也有機會因為某些原因,你的 API 使用量出現「尖峰」。也許它爆紅了,或是其他服務或機器人開始使用它。在這些情況下,你可能會希望留有一些額外資源以策安全。 + +你可以設定一個「目標數字」,例如資源使用率落在「50% 到 90%」之間。重點是,這些大概就是你會想測量並用來調校部署的主要指標。 + +你可以用像 `htop` 這樣的簡單工具,查看伺服器的 CPU 與 RAM 使用量,或各行程的使用量。也可以用更複雜的監控工具,分散式地監看多台伺服器,等等。 + +## 重點回顧 { #recap } + +這裡介紹了一些你在決定如何部署應用時應該記住的主要概念: + +- 安全性 - HTTPS +- 開機自動執行 +- 重新啟動 +- 複本(執行中的行程數量) +- 記憶體 +- 啟動前的前置步驟 + +理解這些想法與如何套用它們,應能給你足夠的直覺,在設定與調整部署時做出各種決策。🤓 + +在接下來的章節,我會提供更多可行策略的具體範例。🚀 diff --git a/docs/zh-hant/docs/deployment/docker.md b/docs/zh-hant/docs/deployment/docker.md new file mode 100644 index 0000000000..87f4e6f9f0 --- /dev/null +++ b/docs/zh-hant/docs/deployment/docker.md @@ -0,0 +1,618 @@ +# 在容器中使用 FastAPI - Docker { #fastapi-in-containers-docker } + +部署 FastAPI 應用時,一個常見做法是建置一個「Linux 容器映像(container image)」。通常使用 Docker 來完成。之後你可以用多種方式部署該容器映像。 + +使用 Linux 容器有多種優點,包括安全性、可重現性、簡單性等。 + +/// tip | 提示 + +趕時間而且已經懂這些?直接跳到下面的 [`Dockerfile` 👇](#build-a-docker-image-for-fastapi)。 + +/// + +
+Dockerfile 預覽 👀 + +```Dockerfile +FROM python:3.14 + +WORKDIR /code + +COPY ./requirements.txt /code/requirements.txt + +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt + +COPY ./app /code/app + +CMD ["fastapi", "run", "app/main.py", "--port", "80"] + +# 若在 Nginx 或 Traefik 等代理伺服器後方執行,請加入 --proxy-headers +# CMD ["fastapi", "run", "app/main.py", "--port", "80", "--proxy-headers"] +``` + +
+ +## 什麼是容器 { #what-is-a-container } + +容器(主要是 Linux 容器)是一種非常輕量的方式,用來封裝應用及其所有相依與必要檔案,並讓其與同一系統中的其他容器(其他應用或元件)隔離。 + +Linux 容器使用與主機(機器、虛擬機、雲端伺服器等)相同的 Linux kernel。這意味著它們非常輕量(相較於完整模擬整個作業系統的虛擬機)。 + +因此,容器只消耗很少的資源,與直接執行行程相當(而虛擬機會消耗更多)。 + +容器也有其各自隔離的執行行程(通常只有一個行程)、檔案系統與網路,簡化部署、安全性與開發等。 + +## 什麼是容器映像 { #what-is-a-container-image } + +容器是由容器映像啟動執行的。 + +容器映像是所有檔案、環境變數,以及在容器中應該執行的預設指令/程式的靜態版本。這裡的「靜態」意指容器映像不在執行,它只是被封裝的檔案與 metadata。 + +相對於儲存的靜態內容「容器映像」,「容器」通常指執行中的實例,也就是正在被執行的東西。 + +當容器啟動並執行時(自容器映像啟動),它可以建立或變更檔案、環境變數等。這些變更只會存在於該容器中,不會持久化回底層的容器映像(不會寫回磁碟)。 + +容器映像可類比為程式檔與其內容,例如 `python` 與某個 `main.py` 檔案。 + +而容器本身(相對於容器映像)是映像的實際執行實例,類比為「行程」。事實上,容器只有在有行程執行時才在運作(通常只有單一行程)。當其中沒有行程在執行時,容器就會停止。 + +## 容器映像 { #container-images } + +Docker 是用來建立與管理容器映像與容器的主要工具之一。 + +也有一個公開的 Docker Hub,內含許多工具、環境、資料庫與應用的預先製作「官方映像」。 + +例如,有官方的 Python 映像。 + +也有許多其他針對不同用途的映像,例如資料庫: + +* PostgreSQL +* MySQL +* MongoDB +* Redis 等。 + +使用預製的容器映像很容易「組合」並使用不同工具。例如,嘗試一個新資料庫。多數情況下,你可以使用官方映像,並僅用環境變數加以設定。 + +如此,你可以學會關於容器與 Docker 的知識,並將這些知識重複運用到許多不同工具與元件上。 + +因此,你會執行多個容器,內容各不相同,例如一個資料庫、一個 Python 應用、一個帶有 React 前端應用的網頁伺服器,並透過它們的內部網路把它們連接在一起。 + +所有容器管理系統(例如 Docker 或 Kubernetes)都內建了這些網路功能。 + +## 容器與行程 { #containers-and-processes } + +容器映像通常在其 metadata 中包含當容器啟動時應執行的預設程式或指令,以及要傳給該程式的參數。這與在命令列要執行的內容非常類似。 + +當容器啟動時,它會執行該指令/程式(雖然你可以覆寫它,讓它執行不同的指令/程式)。 + +只要主要行程(指令或程式)在執行,容器就會運作。 + +容器通常只有單一行程,但也可以由主要行程啟動子行程,如此你會在同一個容器內有多個行程。 + +但不可能在沒有至少一個執行中行程的情況下讓容器運作。若主要行程停止,容器也會停止。 + +## 建置 FastAPI 的 Docker 映像 { #build-a-docker-image-for-fastapi } + +好了,現在來動手做點東西吧!🚀 + +我會示範如何從零開始,基於官方的 Python 映像,為 FastAPI 建置一個 Docker 映像。 + +這是你在多數情況下會想做的事,例如: + +* 使用 Kubernetes 或類似工具 +* 在 Raspberry Pi 上執行 +* 使用會替你執行容器映像的雲端服務等 + +### 套件需求 { #package-requirements } + +你的應用通常會把「套件需求」放在某個檔案中。 + +這主要取決於你用什麼工具來安裝那些需求。 + +最常見的方式是準備一個 `requirements.txt` 檔案,逐行列出套件名稱與版本。 + +當然,你會用與在 [關於 FastAPI 版本](versions.md){.internal-link target=_blank} 中讀到的相同概念,來設定版本範圍。 + +例如,你的 `requirements.txt` 可能像這樣: + +``` +fastapi[standard]>=0.113.0,<0.114.0 +pydantic>=2.7.0,<3.0.0 +``` + +接著你通常會用 `pip` 來安裝這些套件相依,例如: + +
+ +```console +$ pip install -r requirements.txt +---> 100% +Successfully installed fastapi pydantic +``` + +
+ +/// info | 資訊 + +還有其他格式與工具可以用來定義與安裝套件相依。 + +/// + +### 建立 FastAPI 程式碼 { #create-the-fastapi-code } + +* 建立一個 `app` 目錄並進入。 +* 建立一個空的 `__init__.py` 檔案。 +* 建立一個 `main.py` 檔案,內容如下: + +```Python +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 = None): + return {"item_id": item_id, "q": q} +``` + +### Dockerfile { #dockerfile } + +現在在同一個專案目錄建立一個 `Dockerfile` 檔案,內容如下: + +```{ .dockerfile .annotate } +# (1)! +FROM python:3.14 + +# (2)! +WORKDIR /code + +# (3)! +COPY ./requirements.txt /code/requirements.txt + +# (4)! +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt + +# (5)! +COPY ./app /code/app + +# (6)! +CMD ["fastapi", "run", "app/main.py", "--port", "80"] +``` + +1. 從官方的 Python 基底映像開始。 + +2. 將目前工作目錄設為 `/code`。 + + 我們會把 `requirements.txt` 檔案與 `app` 目錄放在這裡。 + +3. 將需求檔案複製到 `/code` 目錄。 + + 先只複製需求檔案,不要複製其他程式碼。 + + 因為這個檔案不常變動,Docker 能偵測並在此步驟使用快取,也能啟用下一步的快取。 + +4. 安裝需求檔案中的套件相依。 + + `--no-cache-dir` 選項告訴 `pip` 不要把下載的套件保存在本機,因為那只在 `pip` 之後還會再次安裝相同套件時才有用,而在使用容器時並非如此。 + + /// note | 注意 + + `--no-cache-dir` 只跟 `pip` 有關,與 Docker 或容器無關。 + + /// + + `--upgrade` 選項告訴 `pip` 若套件已安裝則升級它們。 + + 因為前一步複製檔案可能被 Docker 快取偵測到,這一步也會在可用時使用 Docker 快取。 + + 在此步驟使用快取可以在開發期間反覆建置映像時,為你省下大量時間,而不必每次都重新下載並安裝所有相依。 + +5. 將 `./app` 目錄複製到 `/code` 目錄中。 + + 由於這包含了所有程式碼,也是最常變動的部分,Docker 的快取在這一步或之後的步驟將不容易被使用。 + + 因此,重要的是把這一步放在 `Dockerfile` 的接近結尾處,以最佳化容器映像的建置時間。 + +6. 設定指令使用 `fastapi run`,其底層使用 Uvicorn。 + + `CMD` 接受字串清單,每個字串對應你在命令列中用空白分隔所輸入的內容。 + + 這個指令會從目前的工作目錄執行,也就是你先前用 `WORKDIR /code` 設定的 `/code` 目錄。 + +/// tip | 提示 + +點擊程式碼中的每個數字泡泡來查看每一行在做什麼。👆 + +/// + +/// warning | 警告 + +務必「總是」使用 `CMD` 指令的「exec 形式」,如下所述。 + +/// + +#### 使用 `CMD` 的 Exec 形式 { #use-cmd-exec-form } + +Docker 的 `CMD` 指令可以有兩種寫法: + +✅ Exec 形式: + +```Dockerfile +# ✅ 請這樣做 +CMD ["fastapi", "run", "app/main.py", "--port", "80"] +``` + +⛔️ Shell 形式: + +```Dockerfile +# ⛔️ 請不要這樣做 +CMD fastapi run app/main.py --port 80 +``` + +務必總是使用 exec 形式,以確保 FastAPI 能夠優雅地關閉,並觸發 [lifespan events](../advanced/events.md){.internal-link target=_blank}。 + +你可以在 Docker 關於 shell 與 exec 形式的文件閱讀更多。 + +使用 `docker compose` 時這會特別明顯。技術細節請見這段 Docker Compose 常見問題:為什麼我的服務要花 10 秒才重新建立或停止? + +#### 目錄結構 { #directory-structure } + +你現在應該會有如下的目錄結構: + +``` +. +├── app +│   ├── __init__.py +│ └── main.py +├── Dockerfile +└── requirements.txt +``` + +#### 位於 TLS 終止代理之後 { #behind-a-tls-termination-proxy } + +如果你在 TLS 終止代理(負載平衡器)如 Nginx 或 Traefik 之後執行容器,請加上 `--proxy-headers` 選項,這會告訴 Uvicorn(透過 FastAPI CLI)信任該代理所送來的標頭,表示應用在 HTTPS 後方執行等。 + +```Dockerfile +CMD ["fastapi", "run", "app/main.py", "--proxy-headers", "--port", "80"] +``` + +#### Docker 快取 { #docker-cache } + +這個 `Dockerfile` 中有個重要技巧:我們先只複製「相依檔案」,而不是其他程式碼。原因如下。 + +```Dockerfile +COPY ./requirements.txt /code/requirements.txt +``` + +Docker 與其他工具會「增量式」建置容器映像,從 `Dockerfile` 頂端開始,逐層加入,每個指令所建立的檔案都會形成一層。 + +Docker 與類似工具在建置映像時也會使用內部快取;如果某檔案自上次建置以來未變更,則會重用上次建立的同一層,而不是再次複製並從零建立新層。 + +僅僅避免複製檔案本身或許幫助不大,但因為該步驟使用了快取,接下來的步驟也就能「使用快取」。例如,安裝相依的這個指令就能使用快取: + +```Dockerfile +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt +``` + +套件相依的檔案「不會經常變動」。因此,只複製該檔案,Docker 就能在此步驟「使用快取」。 + +接著,Docker 也就能對下一步「下載並安裝這些相依」使用快取。這正是我們能「省下大量時間」的地方。✨ 也能避免無聊的等待。😪😆 + +下載與安裝套件相依「可能要花好幾分鐘」,但使用「快取」最多只需幾秒。 + +在開發期間,你會一再建置容器映像以測試程式碼變更是否生效,累積下來這能省下許多時間。 + +之後,在 `Dockerfile` 的接近結尾處,我們才複製所有程式碼。由於這是「最常變動」的部分,我們把它放在接近結尾,因為幾乎總是此步驟之後的任何步驟都無法使用快取。 + +```Dockerfile +COPY ./app /code/app +``` + +### 建置 Docker 映像 { #build-the-docker-image } + +現在所有檔案就緒,來建置容器映像。 + +* 進到專案目錄(你的 `Dockerfile` 所在,且包含 `app` 目錄)。 +* 建置你的 FastAPI 映像: + +
+ +```console +$ docker build -t myimage . + +---> 100% +``` + +
+ +/// tip | 提示 + +注意最後的 `.`,等同於 `./`,它告訴 Docker 要用哪個目錄來建置容器映像。 + +這裡是目前的目錄(`.`)。 + +/// + +### 啟動 Docker 容器 { #start-the-docker-container } + +* 以你的映像為基礎執行一個容器: + +
+ +```console +$ docker run -d --name mycontainer -p 80:80 myimage +``` + +
+ +## 檢查 { #check-it } + +你應該可以透過 Docker 容器的網址檢查,例如:http://192.168.99.100/items/5?q=somequeryhttp://127.0.0.1/items/5?q=somequery(或等效的、使用你的 Docker 主機)。 + +你會看到類似這樣: + +```JSON +{"item_id": 5, "q": "somequery"} +``` + +## 互動式 API 文件 { #interactive-api-docs } + +現在你可以前往 http://192.168.99.100/docshttp://127.0.0.1/docs(或等效的、使用你的 Docker 主機)。 + +你會看到自動產生的互動式 API 文件(由 Swagger UI 提供): + +![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png) + +## 替代的 API 文件 { #alternative-api-docs } + +你也可以前往 http://192.168.99.100/redochttp://127.0.0.1/redoc(或等效的、使用你的 Docker 主機)。 + +你會看到另一種自動產生的文件(由 ReDoc 提供): + +![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png) + +## 為單檔 FastAPI 建置 Docker 映像 { #build-a-docker-image-with-a-single-file-fastapi } + +如果你的 FastAPI 是單一檔案,例如沒有 `./app` 目錄的 `main.py`,你的檔案結構可能像這樣: + +``` +. +├── Dockerfile +├── main.py +└── requirements.txt +``` + +接著你只需要在 `Dockerfile` 中調整對應的路徑以複製該檔案: + +```{ .dockerfile .annotate hl_lines="10 13" } +FROM python:3.14 + +WORKDIR /code + +COPY ./requirements.txt /code/requirements.txt + +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt + +# (1)! +COPY ./main.py /code/ + +# (2)! +CMD ["fastapi", "run", "main.py", "--port", "80"] +``` + +1. 將 `main.py` 直接複製到 `/code` 目錄(不需要 `./app` 目錄)。 + +2. 使用 `fastapi run` 來服務單檔的 `main.py` 應用。 + +當你把檔案傳給 `fastapi run`,它會自動偵測這是一個單一檔案而非套件的一部分,並知道如何匯入並服務你的 FastAPI 應用。😎 + +## 部署概念 { #deployment-concepts } + +我們用容器的角度再談一次部分相同的[部署概念](concepts.md){.internal-link target=_blank}。 + +容器主要是簡化應用「建置與部署」流程的工具,但它們不強制特定的方式來處理這些「部署概念」,而是有多種策略可選。 + +好消息是,每種不同的策略都能涵蓋所有部署概念。🎉 + +讓我們用容器的角度回顧這些部署概念: + +* HTTPS +* 開機自動執行 +* 失敗重啟 +* 複本(執行的行程數量) +* 記憶體 +* 啟動前的前置步驟 + +## HTTPS { #https } + +若僅聚焦於 FastAPI 應用的「容器映像」(以及稍後的執行中「容器」),HTTPS 通常會由另一個工具在「外部」處理。 + +它可以是另一個容器,例如使用 Traefik,來處理「HTTPS」以及「自動」取得「憑證」。 + +/// tip | 提示 + +Traefik 與 Docker、Kubernetes 等整合良好,因此為你的容器設定與配置 HTTPS 非常容易。 + +/// + +或者,HTTPS 也可能由雲端供應商以其服務來處理(同時應用仍以容器執行)。 + +## 開機自動執行與重啟 { #running-on-startup-and-restarts } + +通常會有另一個工具負責「啟動並執行」你的容器。 + +可能是直接用 Docker、Docker Compose、Kubernetes、某個雲端服務等。 + +在大多數(或全部)情況下,都有簡單的選項可以在開機時自動執行容器,並在失敗時重啟。例如,在 Docker 中,可用命令列選項 `--restart`。 + +如果不使用容器,讓應用在開機時自動執行並支援重啟可能既繁瑣又困難。但在「使用容器」時,這類功能在多數情況下都是預設包含的。✨ + +## 複本 - 行程數量 { #replication-number-of-processes } + +如果你在有 Kubernetes、Docker Swarm Mode、Nomad,或其他類似的分散式容器管理系統的「叢集」上運作,那你大概會希望在「叢集層級」處理「複本」,而不是在每個容器內使用「行程管理器」(例如帶有 workers 的 Uvicorn)。 + +像 Kubernetes 這類的分散式容器管理系統,通常內建處理「容器複本」以及支援進入請求的「負載平衡」的能力——全部都在「叢集層級」。 + +在這些情況下,你大概會想要如[上面所述](#dockerfile)從零開始建置一個 Docker 映像,安裝你的相依,並且只執行「單一 Uvicorn 行程」,而不是使用多個 Uvicorn workers。 + +### 負載平衡器 { #load-balancer } + +使用容器時,通常會有某個元件在「主埠口」上監聽。它也可能是另一個同時做為「TLS 終止代理」的容器來處理「HTTPS」,或類似的工具。 + +由於這個元件會承接請求的「負載」,並將其分配給 workers,使其(希望)「平衡」,因此也常被稱為「負載平衡器(Load Balancer)」。 + +/// tip | 提示 + +用於 HTTPS 的同一個「TLS 終止代理」元件通常也會是「負載平衡器」。 + +/// + +而在使用容器時,你用來啓動與管理它們的系統,已內建把「網路通訊」(例如 HTTP 請求)從該「負載平衡器」(也可能是「TLS 終止代理」)傳遞到你的應用容器的工具。 + +### 一個負載平衡器 - 多個工作容器 { #one-load-balancer-multiple-worker-containers } + +使用 Kubernetes 或類似的分散式容器管理系統時,使用其內部網路機制可以讓在主「埠口」上監聽的單一「負載平衡器」,把通訊(請求)傳遞給可能的「多個執行你應用的容器」。 + +每個執行你應用的容器通常只有「單一行程」(例如執行你的 FastAPI 應用的 Uvicorn 行程)。它們都是「相同的容器」,執行相同的東西,但各自擁有自己的行程、記憶體等。如此即可在 CPU 的「不同核心」、甚至是「不同機器」上發揮「平行化」的效益。 + +而分散式容器系統中的「負載平衡器」會「輪流」把請求分配給各個執行你應用的容器。因此,每個請求都可能由多個「複製的容器」中的其中一個來處理。 + +通常這個「負載平衡器」也能處理送往叢集中「其他」應用的請求(例如不同網域,或不同 URL 路徑前綴),並把通訊轉送到該「其他」應用對應的容器。 + +### 每個容器一個行程 { #one-process-per-container } + +在這種情境中,你大概會希望「每個容器只有一個(Uvicorn)行程」,因為你已在叢集層級處理了複本。 + +所以這種情況下,你「不會」想在容器中使用多個 workers(例如用 `--workers` 命令列選項)。你會想每個容器只執行「一個 Uvicorn 行程」(但可能有多個容器)。 + +在容器內再放一個行程管理器(如同多 workers 的情況)只會增加「不必要的複雜度」,而你很可能已用叢集系統處理好了。 + +### 多行程容器與特殊情境 { #containers-with-multiple-processes-and-special-cases } + +當然,有些「特殊情況」你可能會想在「一個容器內」執行數個「Uvicorn worker 行程」。 + +在這些情況中,你可以用 `--workers` 命令列選項來設定要啟動的 workers 數量: + +```{ .dockerfile .annotate } +FROM python:3.14 + +WORKDIR /code + +COPY ./requirements.txt /code/requirements.txt + +RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt + +COPY ./app /code/app + +# (1)! +CMD ["fastapi", "run", "app/main.py", "--port", "80", "--workers", "4"] +``` + +1. 這裡我們使用 `--workers` 命令列選項把 worker 數量設定為 4。 + +以下是一些合理的例子: + +#### 簡單應用 { #a-simple-app } + +如果你的應用「足夠簡單」,可以在「單一伺服器」而非叢集上執行,你可能會希望在容器內使用行程管理器。 + +#### Docker Compose { #docker-compose } + +如果你部署到「單一伺服器」(非叢集),且使用「Docker Compose」,那麼你無法輕易(用 Docker Compose)在保有共用網路與「負載平衡」的同時管理容器複本。 + +那你可能會想要「單一容器」搭配「行程管理器」,在其中啟動「多個 worker 行程」。 + +--- + +重點是,這些「都不是」必須盲目遵守的「鐵律」。你可以用這些想法來「評估你的使用情境」,並決定對你的系統最好的做法,看看如何管理以下概念: + +* 安全性 - HTTPS +* 開機自動執行 +* 失敗重啟 +* 複本(執行的行程數量) +* 記憶體 +* 啟動前的前置步驟 + +## 記憶體 { #memory } + +如果你採用「每個容器一個行程」,那每個容器(若有複本則多個容器)所消耗的記憶體會是相對明確、穩定且有限的。 + +接著你可以在容器管理系統(例如 Kubernetes)的設定中為容器設定相同的記憶體限制與需求。如此,它就能在「可用的機器」上「複製容器」,並考量容器所需的記憶體量與叢集中機器的可用記憶體。 + +若你的應用「很簡單」,這可能「不是問題」,你可能不需要指定嚴格的記憶體限制。但如果你「使用大量記憶體」(例如使用機器學習模型),你應該檢查實際消耗的記憶體,並調整「每台機器上執行的容器數量」(也許還要為叢集加機器)。 + +若你採用「每個容器多個行程」,你就得確保啟動的行程數量不會「超過可用記憶體」。 + +## 啟動前的前置步驟與容器 { #previous-steps-before-starting-and-containers } + +如果你使用容器(例如 Docker、Kubernetes),那有兩種主要做法可用。 + +### 多個容器 { #multiple-containers } + +如果你有「多個容器」,且每個容器大概都只執行「單一行程」(例如在一個 Kubernetes 叢集中),那你可能會想要一個「獨立的容器」來完成「前置步驟」的工作,並只在單一容器、單一行程中執行,接著才啟動多個複本的工作容器。 + +/// info | 資訊 + +如果你使用 Kubernetes,這大概會是一個 Init Container。 + +/// + +如果你的情境中,讓那些前置步驟「平行重複執行多次」沒有問題(例如不是在跑資料庫遷移,而只是檢查資料庫是否就緒),那也可以把這些步驟放在每個容器中、在啟動主要行程前執行。 + +### 單一容器 { #single-container } + +如果你的架構很簡單,只有「單一容器」,接著在其中啟動多個「worker 行程」(或也可能就一個行程),那你可以在相同的容器中、於啟動應用行程前先執行這些前置步驟。 + +### 基底 Docker 映像 { #base-docker-image } + +曾經有一個官方的 FastAPI Docker 映像:tiangolo/uvicorn-gunicorn-fastapi。但現在已被棄用。⛔️ + +你大概「不應該」使用這個基底 Docker 映像(或其他類似的)。 + +如果你使用 Kubernetes(或其他)並已在叢集層級設定「複本」、使用多個「容器」。在這些情況下,更好的做法是如上所述[從零建置映像](#build-a-docker-image-for-fastapi)。 + +若你需要多個 workers,只要使用 `--workers` 命令列選項即可。 + +/// note | 技術細節 + +這個 Docker 映像是在 Uvicorn 尚未支援管理與重啟死亡 workers 的年代所建立,因此需要用 Gunicorn 搭配 Uvicorn,為了讓 Gunicorn 管理並重啟 Uvicorn workers,而引入了相當多的複雜度。 + +但現在 Uvicorn(以及 `fastapi` 指令)已支援使用 `--workers`,因此沒有理由使用一個基底 Docker 映像,而不是建置你自己的(而且實際上程式碼量也差不多 😅)。 + +/// + +## 部署容器映像 { #deploy-the-container-image } + +擁有容器(Docker)映像後,有多種部署方式。 + +例如: + +* 在單一伺服器上使用 Docker Compose +* 使用 Kubernetes 叢集 +* 使用 Docker Swarm Mode 叢集 +* 使用像 Nomad 之類的其他工具 +* 使用會接收你的容器映像並代為部署的雲端服務 + +## 使用 `uv` 的 Docker 映像 { #docker-image-with-uv } + +如果你使用 uv 來安裝與管理專案,你可以參考他們的 uv Docker 指南。 + +## 總結 { #recap } + +使用容器系統(例如 Docker 與 Kubernetes)可以相對直接地處理所有「部署概念」: + +* HTTPS +* 開機自動執行 +* 失敗重啟 +* 複本(執行的行程數量) +* 記憶體 +* 啟動前的前置步驟 + +多數情況下,你大概不會想用任何基底映像,而是「從零建置容器映像」,以官方的 Python Docker 映像為基礎。 + +善用 `Dockerfile` 中指令的「順序」與「Docker 快取」,你可以「最小化建置時間」,提升生產力(並避免無聊)。😎 diff --git a/docs/zh-hant/docs/deployment/fastapicloud.md b/docs/zh-hant/docs/deployment/fastapicloud.md new file mode 100644 index 0000000000..5663590d14 --- /dev/null +++ b/docs/zh-hant/docs/deployment/fastapicloud.md @@ -0,0 +1,65 @@ +# FastAPI Cloud { #fastapi-cloud } + +你可以用「一行指令」把你的 FastAPI 應用程式部署到 FastAPI Cloud。如果你還沒加入,快去登記等候名單吧!🚀 + +## 登入 { #login } + +請先確認你已經有 **FastAPI Cloud** 帳號(我們已從等候名單邀請你 😉)。 + +然後登入: + +
+ +```console +$ fastapi login + +You are logged in to FastAPI Cloud 🚀 +``` + +
+ +## 部署 { #deploy } + +現在用「一行指令」部署你的應用: + +
+ +```console +$ fastapi deploy + +Deploying to FastAPI Cloud... + +✅ Deployment successful! + +🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev +``` + +
+ +就這樣!現在你可以透過該 URL 造訪你的應用。✨ + +## 關於 FastAPI Cloud { #about-fastapi-cloud } + +**FastAPI Cloud** 由 **FastAPI** 的作者與團隊打造。 + +它以最少的心力,精簡化建立、部署與存取 API 的流程。 + +它把使用 FastAPI 開發應用的優異開發體驗,延伸到將它們部署到雲端。🎉 + +它也會為你處理部署應用時多數需要面對的事項,例如: + +* HTTPS +* 多副本,並可依據請求自動擴縮 +* 等等。 + +FastAPI Cloud 是 *FastAPI and friends* 開源專案的主要贊助者與資金提供者。✨ + +## 部署到其他雲端供應商 { #deploy-to-other-cloud-providers } + +FastAPI 是基於標準的開源專案。你可以把 FastAPI 應用部署到你選擇的任何雲端供應商。 + +請依照你的雲端供應商的指南,使用他們的方式部署 FastAPI 應用。🤓 + +## 部署到你自己的伺服器 { #deploy-your-own-server } + +在這份「部署」指南的後續內容中,我也會教你所有細節,讓你了解背後發生了什麼、需要做哪些事,以及如何自行部署 FastAPI 應用,包括在你自己的伺服器上。🤓 diff --git a/docs/zh-hant/docs/deployment/https.md b/docs/zh-hant/docs/deployment/https.md new file mode 100644 index 0000000000..0934b02831 --- /dev/null +++ b/docs/zh-hant/docs/deployment/https.md @@ -0,0 +1,231 @@ +# 關於 HTTPS { #about-https } + +人們很容易以為 HTTPS 只是「啟用或未啟用」的功能。 + +但實際上複雜得多。 + +/// tip + +如果你趕時間或不在意細節,可以直接看後續章節,依照逐步指引用不同方式完成設定。 + +/// + +想從使用者角度學習 HTTPS 基礎,請參考 https://howhttps.works/。 + +接著以開發者角度,談幾個關於 HTTPS 需要注意的重點: + +* 對於 HTTPS,伺服器需要擁有由**第三方**簽發的**「憑證」**。 + * 這些憑證實際上是向第三方**取得**,不是「自己產生」。 +* 憑證有**有效期**。 + * 會**過期**。 + * 過期後需要**續期**,也就是再向第三方**重新取得**。 +* 連線加密發生在 **TCP 層**。 + * 那是在 **HTTP 的下一層**。 + * 因此,**憑證與加密**的處理會在 **進入 HTTP 之前**完成。 +* **TCP 不知道「網域」**,只知道 IP 位址。 + * 關於**特定網域**的資訊會放在 **HTTP 資料**中。 +* **HTTPS 憑證**是為某個**特定網域**背書,但通訊協定與加密在 TCP 層進行,發生在**尚未知道**要處理哪個網域之前。 +* **預設**情況下,這表示你每個 IP 位址**只能**使用**一張 HTTPS 憑證**。 + * 不論你的伺服器多強或你在上面跑的應用多小。 + * 不過,這是有**解法**的。 +* 在 **TLS** 協定(在 HTTP 之前於 TCP 層處理加密的協定)上有個**擴充**稱為 **SNI**。 + * 這個 SNI 擴充讓單一伺服器(單一 IP 位址)可以擁有**多張 HTTPS 憑證**,並服務**多個 HTTPS 網域/應用**。 + * 要讓它運作,伺服器上必須有一個**單一**的元件(程式)在**公用 IP**上監聽,且持有伺服器上的**所有 HTTPS 憑證**。 +* 在取得安全連線**之後**,通訊協定**仍然是 HTTP**。 + * 雖然透過 **HTTP 協定**傳送,但內容是**加密**的。 + +常見做法是讓伺服器(機器、主機等)上跑**一個程式/HTTP 伺服器**來**管理所有 HTTPS 相關工作**:接收**加密的 HTTPS 請求**、將其**解密**成**純 HTTP 請求**轉交給同台伺服器上實際運行的 HTTP 應用(本例為 **FastAPI** 應用)、從應用取得 **HTTP 回應**、再用合適的 **HTTPS 憑證**將其**加密**並以 **HTTPS** 傳回給用戶端。這類伺服器常被稱為 **TLS 終止代理 (TLS Termination Proxy)**。 + +可作為 TLS 終止代理的選項包括: + +* Traefik(也可處理憑證續期) +* Caddy(也可處理憑證續期) +* Nginx +* HAProxy + +## Let's Encrypt { #lets-encrypt } + +在 Let's Encrypt 之前,這些 **HTTPS 憑證**是由受信任的第三方販售。 + +取得這些憑證的流程過去相當繁瑣,需要許多手續,且憑證相當昂貴。 + +之後出現了 **Let's Encrypt**。 + +它是 Linux Foundation 的專案,能**免費**且自動化地提供 **HTTPS 憑證**。這些憑證採用標準的密碼學安全機制,且有效期較短(約 3 個月),因此因為壽命短,**安全性其實更好**。 + +網域會被安全驗證,憑證會自動產生。這也讓憑證續期得以自動化。 + +目標是讓憑證的申請與續期自動化,讓你**永遠免費使用安全的 HTTPS**。 + +## 給開發者的 HTTPS { #https-for-developers } + +以下以逐步範例說明一個 HTTPS API 可能長什麼樣子,著重於對開發者重要的概念。 + +### 網域名稱 { #domain-name } + +通常會先**取得**一個**網域名稱**,接著在 DNS 伺服器(可能是同一個雲端供應商)中設定它。 + +你可能會租一台雲端伺服器(虛擬機)或類似的服務,並擁有一個固定的**公用 IP 位址**。 + +在 DNS 伺服器中,你會設定一個紀錄(「`A record`」)指向**你的網域**所對應的**伺服器公用 IP 位址**。 + +這通常在初次建置時設定一次即可。 + +/// tip + +「網域名稱」是發生在 HTTPS 之前的事情,但一切都依賴網域與 IP 位址,因此在此一併說明。 + +/// + +### DNS { #dns } + +現在聚焦在實際的 HTTPS 部分。 + +首先,瀏覽器會向 **DNS 伺服器**查詢該**網域的 IP**,例如 `someapp.example.com`。 + +DNS 伺服器會回覆要使用的**IP 位址**,那就是你在 DNS 伺服器中設定的、伺服器對外的公用 IP 位址。 + + + +### TLS 握手開始 { #tls-handshake-start } + +接著瀏覽器會連線到該 IP 的 **443 埠**(HTTPS 預設埠)。 + +通訊的第一部分是建立用戶端與伺服器之間的連線,並協商要使用哪些金鑰等密碼參數。 + + + +用戶端與伺服器為建立 TLS 連線而進行的這段互動稱為 **TLS 握手**。 + +### 帶 SNI 擴充的 TLS { #tls-with-sni-extension } + +在特定的**IP 位址**與特定**埠**上,同一時間**只能有一個行程**在監聽。可以在同一個 IP 上監聽不同埠,但每個 IP 與埠的組合只能有一個行程。 + +TLS(HTTPS)預設使用 `443` 埠,因此我們需要用到這個埠。 + +由於只能有一個行程監聽該埠,負責監聽的會是 **TLS 終止代理**。 + +TLS 終止代理會存取一張或多張 **TLS 憑證**(HTTPS 憑證)。 + +透過上面提到的 **SNI 擴充**,TLS 終止代理會根據用戶端預期的網域,從可用的 TLS(HTTPS)憑證中挑選本次連線要用的憑證。 + +在這個例子中,會使用 `someapp.example.com` 的憑證。 + + + +用戶端**信任**簽發該 TLS 憑證的單位(本例為 Let's Encrypt,稍後會再談),因此可以**驗證**憑證有效。 + +接著,用戶端與 TLS 終止代理會以該憑證為基礎,**協商後續如何加密**整段 **TCP 通訊**。至此完成 **TLS 握手**。 + +之後,用戶端與伺服器之間就有一條**已加密的 TCP 連線**,這就是 TLS 所提供的能力。接著他們可以在這條連線上開始實際的 **HTTP** 通訊。 + +這也就是 **HTTPS** 的本質:在**安全的 TLS 連線**內傳送一般的 **HTTP**,而非在純(未加密)的 TCP 連線上。 + +/// tip + +請注意,加密發生在 **TCP 層**,不是在 HTTP 層。 + +/// + +### HTTPS 請求 { #https-request } + +現在用戶端與伺服器(更精確地說,是瀏覽器與 TLS 終止代理)之間已有**加密的 TCP 連線**,他們可以開始進行 **HTTP** 通訊。 + +因此,用戶端送出一個 **HTTPS 請求**。它其實就是透過加密的 TLS 連線發送的一個 HTTP 請求。 + + + +### 解密請求 { #decrypt-the-request } + +TLS 終止代理會依照先前協商的方式**解密請求**,並將**純(已解密)的 HTTP 請求**轉交給運行應用的行程(例如以 Uvicorn 執行的 FastAPI 應用行程)。 + + + +### HTTP 回應 { #http-response } + +應用會處理該請求,並將**純(未加密)的 HTTP 回應**送回 TLS 終止代理。 + + + +### HTTPS 回應 { #https-response } + +TLS 終止代理接著會依照先前協商(起點是 `someapp.example.com` 的憑證)的方式**加密回應**,並傳回給瀏覽器。 + +接著,瀏覽器會驗證回應是否合法、是否使用正確的金鑰加密等。然後**解密回應**並處理。 + + + +用戶端(瀏覽器)會知道回應來自正確的伺服器,因為它使用了先前依據 **HTTPS 憑證**所協商的密碼機制。 + +### 多個應用 { #multiple-applications } + +同一台(或多台)伺服器上可以有**多個應用**,例如其他 API 程式或資料庫。 + +雖然只有一個行程可以處理特定 IP 與埠的組合(本例中的 TLS 終止代理),但其他應用/行程也都能在伺服器上運行,只要它們不使用相同的**公用 IP 與埠**組合即可。 + + + +如此一來,TLS 終止代理就能為**多個網域**、多個應用處理 HTTPS 與憑證,並把請求轉發到對應的應用。 + +### 憑證續期 { #certificate-renewal } + +在未來某個時間點,每張憑證都會**過期**(自取得起約 3 個月)。 + +之後,會有另一個程式(有時是另一個程式,有時也可能就是同一個 TLS 終止代理)與 Let's Encrypt 溝通並續期憑證。 + + + +**TLS 憑證**是**綁定網域名稱**,不是綁定 IP 位址。 + +因此,要續期憑證時,續期程式需要向憑證機構(Let's Encrypt)**證明**它的確**擁有並控制該網域**。 + +為了達成這點、並兼顧不同應用情境,有幾種常見方式: + +* **修改部分 DNS 紀錄**。 + * 為此,續期程式需要支援該 DNS 供應商的 API,因此依你使用的 DNS 供應商不同,這方式可能可行或不可行。 +* **作為伺服器運行**(至少在憑證申請過程中)於該網域對應的公用 IP 上。 + * 如前所述,同一時間只有一個行程能在特定 IP 與埠上監聽。 + * 這也是為什麼讓同一個 TLS 終止代理一併處理憑證續期非常實用的原因之一。 + * 否則你可能得暫停 TLS 終止代理、啟動續期程式申請憑證、將憑證配置到 TLS 終止代理,然後再重啟 TLS 終止代理。這並不理想,因為在 TLS 終止代理停機期間,你的應用將不可用。 + +在不中斷服務的同時完成整個續期流程,是你會想用**獨立系統(TLS 終止代理)來處理 HTTPS**、而不是直接把 TLS 憑證掛在應用伺服器(例如 Uvicorn)上的主要原因之一。 + +## 代理轉發標頭 { #proxy-forwarded-headers } + +當你使用代理處理 HTTPS 時,你的**應用伺服器**(例如透過 FastAPI CLI 啟動的 Uvicorn)其實不知道任何 HTTPS 的處理流程,它是用純 HTTP 與 **TLS 終止代理**通訊。 + +這個**代理**通常會在把請求轉發給**應用伺服器**之前,臨時加入一些 HTTP 標頭,讓應用伺服器知道該請求是由代理**轉發**過來的。 + +/// note | 技術細節 + +這些代理標頭包括: + +* X-Forwarded-For +* X-Forwarded-Proto +* X-Forwarded-Host + +/// + +然而,因為**應用伺服器**並不知道自己在受信任的**代理**之後,預設情況下它不會信任這些標頭。 + +但你可以設定**應用伺服器**去信任由**代理**送來的「轉發」標頭。若你使用 FastAPI CLI,可以用 *CLI 參數* `--forwarded-allow-ips` 指定應信任哪些 IP 來的「轉發」標頭。 + +例如,如果**應用伺服器**只會接收來自受信任**代理**的連線,你可以設定 `--forwarded-allow-ips="*"`,也就是信任所有來源 IP,因為實際上它只會收到**代理**那個 IP 送來的請求。 + +如此一來,應用就能知道自己的對外 URL、是否使用 HTTPS、網域為何等資訊。 + +這在正確處理重新導向等情境時很有用。 + +/// tip + +你可以在文件 [在代理後方 - 啟用代理轉發標頭](../advanced/behind-a-proxy.md#enable-proxy-forwarded-headers){.internal-link target=_blank} 中了解更多。 + +/// + +## 重點回顧 { #recap } + +擁有 **HTTPS** 非常重要,而且在多數情況都相當**關鍵**。作為開發者,你在 HTTPS 上的大部分投入其實是**理解這些概念**及其運作方式。 + +一旦掌握了**給開發者的 HTTPS 基礎**,你就能輕鬆組合並設定不同工具,讓一切管理變得簡單。 + +在接下來的章節中,我會示範幾個為 **FastAPI** 應用設定 **HTTPS** 的具體例子。🔒 diff --git a/docs/zh-hant/docs/deployment/index.md b/docs/zh-hant/docs/deployment/index.md index 9edd3368b2..ddf533efc9 100644 --- a/docs/zh-hant/docs/deployment/index.md +++ b/docs/zh-hant/docs/deployment/index.md @@ -8,7 +8,7 @@ 對於一個 **Web API**,部署通常涉及將其放置在**遠端伺服器**上,並使用性能優良且穩定的**伺服器程式**,確保使用者能夠高效、無中斷地存取應用程式,且不會遇到問題。 -這與**開發**階段形成鮮明對比,在**開發**階段,你會不斷更改程式碼、破壞程式碼、修復程式碼,然後停止和重新啟動伺服器等。 +這與**開發**階段形成鮮明對比,在**開發**階段,你會不斷更改程式碼、破壞程式碼、修復程式碼,然後停止和重新啟動開發伺服器等。 ## 部署策略 { #deployment-strategies } diff --git a/docs/zh-hant/docs/deployment/manually.md b/docs/zh-hant/docs/deployment/manually.md new file mode 100644 index 0000000000..bf9f6a93f4 --- /dev/null +++ b/docs/zh-hant/docs/deployment/manually.md @@ -0,0 +1,157 @@ +# 手動執行伺服器 { #run-a-server-manually } + +## 使用 `fastapi run` 指令 { #use-the-fastapi-run-command } + +簡而言之,使用 `fastapi run` 來啟動你的 FastAPI 應用: + +
+ +```console +$ fastapi run main.py + + FastAPI Starting production server 🚀 + + Searching for package file structure from directories + with __init__.py files + Importing from /home/user/code/awesomeapp + + module 🐍 main.py + + code Importing the FastAPI app object from the module with + the following code: + + from main import app + + app Using import string: main:app + + server Server started at http://0.0.0.0:8000 + server Documentation at http://0.0.0.0:8000/docs + + Logs: + + INFO Started server process [2306215] + INFO Waiting for application startup. + INFO Application startup complete. + INFO Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C + to quit) +``` + +
+ +這在多數情況下都適用。😎 + +你可以用這個指令在容器、伺服器等環境中啟動你的 FastAPI 應用。 + +## ASGI 伺服器 { #asgi-servers } + +我們再深入一些細節。 + +FastAPI 採用建立 Python 網頁框架與伺服器的標準 ASGI。FastAPI 是一個 ASGI 網頁框架。 + +在遠端伺服器機器上執行 FastAPI 應用(或任何 ASGI 應用)所需的關鍵是 ASGI 伺服器程式,例如 Uvicorn;`fastapi` 指令預設就是使用它。 + +有數個替代方案,包括: + +* Uvicorn:高效能 ASGI 伺服器。 +* Hypercorn:支援 HTTP/2 與 Trio 等功能的 ASGI 伺服器。 +* Daphne:為 Django Channels 打造的 ASGI 伺服器。 +* Granian:針對 Python 應用的 Rust HTTP 伺服器。 +* NGINX Unit:NGINX Unit 是輕量且多功能的網頁應用執行環境。 + +## 伺服器機器與伺服器程式 { #server-machine-and-server-program } + +有個命名上的小細節請留意。💡 + +「server(伺服器)」一詞常同時用來指遠端/雲端電腦(實體或虛擬機器),也用來指在該機器上執行的程式(例如 Uvicorn)。 + +因此看到「server」時,文意可能指這兩者之一。 + +指涉遠端機器時,常稱為 server、machine、VM(虛擬機器)、node 等,這些都指某種遠端機器(通常執行 Linux),你會在其上執行程式。 + +## 安裝伺服器程式 { #install-the-server-program } + +安裝 FastAPI 時會附帶一個可用於生產環境的伺服器 Uvicorn,你可以用 `fastapi run` 來啟動它。 + +但你也可以手動安裝 ASGI 伺服器。 + +請先建立並啟用一個 [虛擬環境](../virtual-environments.md){.internal-link target=_blank},接著再安裝伺服器程式。 + +例如,安裝 Uvicorn: + +
+ +```console +$ pip install "uvicorn[standard]" + +---> 100% +``` + +
+ +其他 ASGI 伺服器的安裝流程也大致相同。 + +/// tip + +加入 `standard` 會讓 Uvicorn 安裝並使用一些建議的額外相依套件。 + +其中包含 `uvloop`,它是 `asyncio` 的高效能替代實作,可大幅提升並行效能。 + +當你用 `pip install "fastapi[standard]"` 安裝 FastAPI 時,也會一併取得 `uvicorn[standard]`。 + +/// + +## 執行伺服器程式 { #run-the-server-program } + +如果你是手動安裝 ASGI 伺服器,通常需要提供特定格式的 import 字串,讓它能匯入你的 FastAPI 應用: + +
+ +```console +$ uvicorn main:app --host 0.0.0.0 --port 80 + +INFO: Uvicorn running on http://0.0.0.0:80 (Press CTRL+C to quit) +``` + +
+ +/// note + +指令 `uvicorn main:app` 指的是: + +* `main`:檔案 `main.py`(Python「模組」)。 +* `app`:在 `main.py` 中以 `app = FastAPI()` 建立的物件。 + +等同於: + +```Python +from main import app +``` + +/// + +其他 ASGI 伺服器也有類似的指令,詳見各自的文件。 + +/// warning + +Uvicorn 與其他伺服器支援 `--reload` 選項,對開發期間很有幫助。 + +`--reload` 會消耗更多資源,也較不穩定等。 + +它在開發階段很實用,但在生產環境中不應使用。 + +/// + +## 部署觀念 { #deployment-concepts } + +上述範例會啟動伺服器程式(如 Uvicorn),以單一行程在指定連接埠(如 `80`)上監聽所有 IP(`0.0.0.0`)。 + +這是基本概念。但你很可能還需要處理一些額外事項,例如: + +* 安全性 - HTTPS +* 開機自動啟動 +* 自動重啟 +* 多副本(執行的行程數量) +* 記憶體 +* 啟動前需要執行的前置步驟 + +在下一章節我會進一步說明這些觀念、思考方式,以及對應的處理策略與實作範例。🚀 diff --git a/docs/zh-hant/docs/deployment/server-workers.md b/docs/zh-hant/docs/deployment/server-workers.md new file mode 100644 index 0000000000..56569e49ad --- /dev/null +++ b/docs/zh-hant/docs/deployment/server-workers.md @@ -0,0 +1,139 @@ +# 伺服器工作處理序 - 使用 Uvicorn Workers { #server-workers-uvicorn-with-workers } + +我們回顧一下先前提到的部署概念: + +* 安全 - HTTPS +* 系統啟動時執行 +* 重啟 +* **副本(正在執行的處理序數量)** +* 記憶體 +* 啟動前的前置作業 + +到目前為止,依照文件中的教學,你大多是透過 `fastapi` 指令啟動一個執行 Uvicorn 的伺服器程式,且只跑單一處理序。 + +在部署應用時,你通常會希望有一些處理序的複製來善用多核心,並能處理更多請求。 + +如同前一章關於 [部署概念](concepts.md){.internal-link target=_blank} 所示,你可以採用多種策略。 + +這裡會示範如何使用 `fastapi` 指令或直接使用 `uvicorn` 指令,搭配 Uvicorn 的工作處理序(worker processes)。 + +/// info + +如果你使用容器(例如 Docker 或 Kubernetes),我會在下一章說明更多:[容器中的 FastAPI - Docker](docker.md){.internal-link target=_blank}。 + +特別是,在 **Kubernetes** 上執行時,你多半會選擇不要使用 workers,而是每個容器只跑一個 **Uvicorn 單一處理序**。我會在該章節中進一步說明。 + +/// + +## 多個工作處理序 { #multiple-workers } + +你可以用命令列選項 `--workers` 來啟動多個 workers: + +//// tab | `fastapi` + +如果你使用 `fastapi` 指令: + +
+ +```console +$ fastapi run --workers 4 main.py + + FastAPI Starting production server 🚀 + + Searching for package file structure from directories with + __init__.py files + Importing from /home/user/code/awesomeapp + + module 🐍 main.py + + code Importing the FastAPI app object from the module with the + following code: + + from main import app + + app Using import string: main:app + + server Server started at http://0.0.0.0:8000 + server Documentation at http://0.0.0.0:8000/docs + + Logs: + + INFO Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to + quit) + INFO Started parent process [27365] + INFO Started server process [27368] + INFO Started server process [27369] + INFO Started server process [27370] + INFO Started server process [27367] + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Waiting for application startup. + INFO Application startup complete. + INFO Application startup complete. + INFO Application startup complete. + INFO Application startup complete. +``` + +
+ +//// + +//// tab | `uvicorn` + +如果你偏好直接使用 `uvicorn` 指令: + +
+ +```console +$ uvicorn main:app --host 0.0.0.0 --port 8080 --workers 4 +INFO: Uvicorn running on http://0.0.0.0:8080 (Press CTRL+C to quit) +INFO: Started parent process [27365] +INFO: Started server process [27368] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27369] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27370] +INFO: Waiting for application startup. +INFO: Application startup complete. +INFO: Started server process [27367] +INFO: Waiting for application startup. +INFO: Application startup complete. +``` + +
+ +//// + +這裡唯一新增的選項是 `--workers`,告訴 Uvicorn 要啟動 4 個工作處理序。 + +你也會看到它顯示每個處理序的 **PID**,`27365` 是父處理序(這是**處理序管理器**),另外每個工作處理序各有一個:`27368`、`27369`、`27370`、`27367`。 + +## 部署概念 { #deployment-concepts } + +你已經看到如何使用多個 **workers** 來將應用的執行進行**平行化**,善用 CPU 的**多核心**,並能服務**更多請求**。 + +在上面的部署概念清單中,使用 workers 主要能幫助到**副本**這一塊,並對**重啟**也有一點幫助,但你仍需要處理其他部分: + +* **安全 - HTTPS** +* **系統啟動時執行** +* ***重啟*** +* 副本(正在執行的處理序數量) +* **記憶體** +* **啟動前的前置作業** + +## 容器與 Docker { #containers-and-docker } + +在下一章 [容器中的 FastAPI - Docker](docker.md){.internal-link target=_blank} 我會說明一些策略,幫你處理其他的**部署概念**。 + +我會示範如何**從零建立你的映像檔**來執行單一 Uvicorn 處理序。這個流程相當簡單,而且在使用像 **Kubernetes** 這類分散式容器管理系統時,大多情況也會這麼做。 + +## 重點回顧 { #recap } + +你可以在 `fastapi` 或 `uvicorn` 指令中使用 `--workers` 這個 CLI 選項來啟動多個工作處理序,以善用**多核心 CPU**,**平行**執行多個處理序。 + +如果你要自行建置**自己的部署系統**,你可以運用這些工具與想法,同時自行處理其他部署概念。 + +接著看看下一章關於在容器(例如 Docker 與 Kubernetes)中使用 **FastAPI**。你會看到那些工具也有簡單的方法來解決其他**部署概念**。✨ diff --git a/docs/zh-hant/docs/deployment/versions.md b/docs/zh-hant/docs/deployment/versions.md new file mode 100644 index 0000000000..c4f9c52624 --- /dev/null +++ b/docs/zh-hant/docs/deployment/versions.md @@ -0,0 +1,93 @@ +# 關於 FastAPI 版本 { #about-fastapi-versions } + +**FastAPI** 已經在許多應用與系統的生產環境中使用,且測試涵蓋率維持在 100%。同時開發仍在快速推進。 + +經常加入新功能、定期修復錯誤,程式碼也在持續改進。 + +這就是為什麼目前版本仍為 `0.x.x`,這表示每個版本都可能包含破壞性變更。這遵循 語意化版本(Semantic Versioning) 的慣例。 + +你現在就可以用 **FastAPI** 建置生產環境的應用(而且你可能已經這麼做一段時間了),只要確保你使用的版本能與其餘程式碼正確相容。 + +## 鎖定你的 `fastapi` 版本 { #pin-your-fastapi-version } + +首先,你應該將你使用的 **FastAPI** 版本「鎖定(pin)」到你知道對你的應用可正常運作的最新特定版本。 + +例如,假設你的應用使用 `0.112.0` 版本。 + +如果你使用 `requirements.txt` 檔案,可以這樣指定版本: + +```txt +fastapi[standard]==0.112.0 +``` + +這表示你會使用完全相同的 `0.112.0` 版本。 + +或你也可以這樣鎖定: + +```txt +fastapi[standard]>=0.112.0,<0.113.0 +``` + +這表示會使用 `0.112.0`(含)以上但小於 `0.113.0` 的版本,例如 `0.112.2` 也會被接受。 + +如果你使用其他安裝管理工具,例如 `uv`、Poetry、Pipenv 等,它們也都有可用來指定套件特定版本的方法。 + +## 可用版本 { #available-versions } + +你可以在 [發行說明](../release-notes.md){.internal-link target=_blank} 查看可用版本(例如用來確認目前最新版本)。 + +## 關於版本 { #about-versions } + +依照語意化版本的慣例,任何低於 `1.0.0` 的版本都可能加入破壞性變更。 + +FastAPI 也遵循慣例:任何「PATCH」版本變更僅用於修正錯誤與非破壞性變更。 + +/// tip + +「PATCH」是最後一個數字,例如在 `0.2.3` 中,PATCH 版本是 `3`。 + +/// + +因此,你可以將版本鎖定為如下形式: + +```txt +fastapi>=0.45.0,<0.46.0 +``` + +破壞性變更與新功能會在「MINOR」版本加入。 + +/// tip + +「MINOR」是中間的數字,例如在 `0.2.3` 中,MINOR 版本是 `2`。 + +/// + +## 升級 FastAPI 版本 { #upgrading-the-fastapi-versions } + +你應該為你的應用撰寫測試。 + +在 **FastAPI** 中這很容易(感謝 Starlette),請參考文件:[測試](../tutorial/testing.md){.internal-link target=_blank} + +有了測試之後,你就可以將 **FastAPI** 升級到較新的版本,並透過執行測試來確保所有程式碼都能正確運作。 + +如果一切正常,或在完成必要調整且所有測試通過之後,就可以把你的 `fastapi` 鎖定到該新的版本。 + +## 關於 Starlette { #about-starlette } + +你不應鎖定 `starlette` 的版本。 + +不同的 **FastAPI** 版本會使用特定較新的 Starlette 版本。 + +因此,你可以直接讓 **FastAPI** 使用正確的 Starlette 版本。 + +## 關於 Pydantic { #about-pydantic } + +Pydantic 在其測試中涵蓋了 **FastAPI** 的測試,因此 Pydantic 的新版本(高於 `1.0.0`)一律與 FastAPI 相容。 + +你可以將 Pydantic 鎖定到任何高於 `1.0.0`、適合你的版本。 + +例如: + +```txt +pydantic>=2.7.0,<3.0.0 +``` diff --git a/docs/zh-hant/docs/fastapi-cli.md b/docs/zh-hant/docs/fastapi-cli.md index b107e7e73f..57b5ec98f2 100644 --- a/docs/zh-hant/docs/fastapi-cli.md +++ b/docs/zh-hant/docs/fastapi-cli.md @@ -1,4 +1,4 @@ -# FastAPI CLI +# FastAPI CLI { #fastapi-cli } **FastAPI CLI** 是一個命令列程式,能用來運行你的 FastAPI 應用程式、管理你的 FastAPI 專案等。 @@ -9,72 +9,64 @@
```console -$ fastapi dev main.py -INFO Using path main.py -INFO Resolved absolute path /home/user/code/awesomeapp/main.py -INFO Searching for package file structure from directories with __init__.py files -INFO Importing from /home/user/code/awesomeapp +$ fastapi dev main.py - ╭─ Python module file ─╮ - │ │ - │ 🐍 main.py │ - │ │ - ╰──────────────────────╯ + FastAPI Starting development server 🚀 -INFO Importing module main -INFO Found importable FastAPI app + Searching for package file structure from directories with + __init__.py files + Importing from /home/user/code/awesomeapp - ╭─ Importable FastAPI app ─╮ - │ │ - │ from main import app │ - │ │ - ╰──────────────────────────╯ + module 🐍 main.py -INFO Using import string main:app + code Importing the FastAPI app object from the module with the + following code: - ╭────────── FastAPI CLI - Development mode ───────────╮ - │ │ - │ Serving at: http://127.0.0.1:8000 │ - │ │ - │ API docs: http://127.0.0.1:8000/docs │ - │ │ - │ Running in development mode, for production use: │ - │ │ - fastapi run - │ │ - ╰─────────────────────────────────────────────────────╯ + from main import app -INFO: Will watch for changes in these directories: ['/home/user/code/awesomeapp'] -INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) -INFO: Started reloader process [2265862] using WatchFiles -INFO: Started server process [2265873] -INFO: Waiting for application startup. -INFO: Application startup complete. + app Using import string: main:app + + server Server started at http://127.0.0.1:8000 + server Documentation at http://127.0.0.1:8000/docs + + tip Running in development mode, for production use: + fastapi run + + Logs: + + INFO Will watch for changes in these directories: + ['/home/user/code/awesomeapp'] + INFO Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to + quit) + INFO Started reloader process [383138] using WatchFiles + INFO Started server process [383153] + INFO Waiting for application startup. + INFO Application startup complete. ```
-`fastapi` 命令列程式就是 **FastAPI CLI**。 +名為 `fastapi` 的命令列程式就是 **FastAPI CLI**。 -FastAPI CLI 接收你的 Python 程式路徑(例如 `main.py`),並自動檢測 FastAPI 實例(通常命名為 `app`),確定正確的引入模組流程,然後運行該應用程式。 +FastAPI CLI 接收你的 Python 程式路徑(例如 `main.py`),並自動檢測 `FastAPI` 實例(通常命名為 `app`),確定正確的引入模組流程,然後運行該應用程式。 在生產環境,你應該使用 `fastapi run` 命令。 🚀 **FastAPI CLI** 內部使用了 Uvicorn,這是一個高效能、適合生產環境的 ASGI 伺服器。 😎 -## `fastapi dev` +## `fastapi dev` { #fastapi-dev } 執行 `fastapi dev` 會啟動開發模式。 預設情況下,**auto-reload** 功能是啟用的,當你對程式碼進行修改時,伺服器會自動重新載入。這會消耗較多資源,並且可能比禁用時更不穩定。因此,你應該只在開發環境中使用此功能。它也會在 IP 位址 `127.0.0.1` 上監聽,這是用於你的機器與自身通訊的 IP 位址(`localhost`)。 -## `fastapi run` +## `fastapi run` { #fastapi-run } 執行 `fastapi run` 會以生產模式啟動 FastAPI。 -預設情況下,**auto-reload** 功能是禁用的。它也會在 IP 位址 `0.0.0.0` 上監聽,表示會監聽所有可用的 IP 地址,這樣任何能與該機器通訊的人都可以公開存取它。這通常是你在生產環境中運行應用程式的方式,例如在容器中運行時。 +預設情況下,**auto-reload** 功能是禁用的。它也會在 IP 位址 `0.0.0.0` 上監聽,表示會監聽所有可用的 IP 位址,這樣任何能與該機器通訊的人都可以公開存取它。這通常是你在生產環境中運行應用程式的方式,例如在容器中運行時。 -在大多數情況下,你會(也應該)有一個「終止代理」來處理 HTTPS,這取決於你如何部署你的應用程式,你的服務供應商可能會為你做這件事,或者你需要自己設置它。 +在大多數情況下,你會(也應該)有一個「終止代理」在外層幫你處理 HTTPS;這取決於你如何部署應用程式,你的服務供應商可能會幫你處理,或者你需要自己設置。 /// tip diff --git a/docs/zh-hant/docs/features.md b/docs/zh-hant/docs/features.md index f44d28a7f8..77c0203073 100644 --- a/docs/zh-hant/docs/features.md +++ b/docs/zh-hant/docs/features.md @@ -1,17 +1,17 @@ -# 特性 +# 特性 { #features } -## FastAPI 特性 +## FastAPI 特性 { #fastapi-features } -**FastAPI** 提供了以下内容: +**FastAPI** 提供了以下內容: -### 建立在開放標準的基礎上 +### 建立在開放標準的基礎上 { #based-on-open-standards } -* 使用 OpenAPI 來建立 API,包含路徑操作、參數、請求內文、安全性等聲明。 +* 使用 OpenAPI 來建立 API,包含 路徑操作、參數、請求內文、安全性等宣告。 * 使用 JSON Schema(因為 OpenAPI 本身就是基於 JSON Schema)自動生成資料模型文件。 * 經過縝密的研究後圍繞這些標準進行設計,而不是事後在已有系統上附加的一層功能。 * 這也讓我們在多種語言中可以使用自動**用戶端程式碼生成**。 -### 能夠自動生成文件 +### 能夠自動生成文件 { #automatic-docs } FastAPI 能生成互動式 API 文件和探索性的 Web 使用者介面。由於該框架基於 OpenAPI,因此有多種選擇,預設提供了兩種。 @@ -19,12 +19,11 @@ FastAPI 能生成互動式 API 文件和探索性的 Web 使用者介面。由 ![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-03-swagger-02.png) -* ReDoc 提供結構性的文件,讓你可以在瀏覽器中查看。 +* 使用 ReDoc 的替代 API 文件。 ![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png) - -### 現代 Python +### 現代 Python { #just-modern-python } 這一切都基於標準的 **Python 型別**宣告(感謝 Pydantic)。無需學習新的語法,只需使用標準的現代 Python。 @@ -32,7 +31,7 @@ FastAPI 能生成互動式 API 文件和探索性的 Web 使用者介面。由 如果你寫帶有 Python 型別的程式碼: -```python +```Python from datetime import date from pydantic import BaseModel @@ -50,10 +49,9 @@ class User(BaseModel): joined: date ``` - 可以像這樣來使用: -```python +```Python my_user: User = User(id=3, name="John Doe", joined="2018-07-19") second_user_data = { @@ -65,7 +63,6 @@ second_user_data = { my_second_user: User = User(**second_user_data) ``` - /// info `**second_user_data` 意思是: @@ -74,11 +71,11 @@ my_second_user: User = User(**second_user_data) /// -### 多種編輯器支援 +### 多種編輯器支援 { #editor-support } 整個框架的設計是為了讓使用變得簡單且直觀,在開始開發之前,所有決策都在多個編輯器上進行了測試,以確保提供最佳的開發體驗。 -在最近的 Python 開發者調查中,我們能看到 被使用最多的功能是 autocompletion,此功能可以預測將要輸入文字,並自動補齊。 +在最近的 Python 開發者調查中,我們能看到 被使用最多的功能是 autocompletion。 整個 **FastAPI** 框架就是基於這一點,任何地方都可以進行自動補齊。 @@ -86,11 +83,11 @@ my_second_user: User = User(**second_user_data) 在這裡,你的編輯器可能會這樣幫助你: -* Visual Studio Code 中: +* 在 Visual Studio Code 中: ![editor support](https://fastapi.tiangolo.com/img/vscode-completion.png) -* PyCharm 中: +* 在 PyCharm 中: ![editor support](https://fastapi.tiangolo.com/img/pycharm-completion.png) @@ -98,17 +95,13 @@ my_second_user: User = User(**second_user_data) 這樣比較不會輸錯鍵名,不用來回翻看文件,也不用來回滾動尋找你最後使用的 `username` 或者 `user_name`。 - - -### 簡潔 +### 簡潔 { #short } FastAPI 為你提供了**預設值**,讓你不必在初期進行繁瑣的配置,一切都可以自動運作。如果你有更具體的需求,則可以進行調整和自定義, -但在大多數情況下,你只需要直接使用預設值,就能順利完成 API 開發。 +但預設情況下,一切都「直接可用」。 -### 驗證 - -所有的驗證都由完善且強大的 **Pydantic** 處理。 +### 驗證 { #validation } * 驗證大部分(甚至所有?)的 Python **資料型別**,包括: * JSON 物件 (`dict`)。 @@ -120,9 +113,11 @@ FastAPI 為你提供了**預設值**,讓你不必在初期進行繁瑣的配 * URL * Email * UUID + * ...等等。 +所有的驗證都由完善且強大的 **Pydantic** 處理。 -### 安全性及身份驗證 +### 安全性及身份驗證 { #security-and-authentication } FastAPI 已經整合了安全性和身份驗證的功能,但不會強制與特定的資料庫或資料模型進行綁定。 @@ -139,10 +134,9 @@ OpenAPI 中定義的安全模式,包括: 所有的這些都是可重複使用的工具和套件,可以輕鬆與你的系統、資料儲存(Data Stores)、關聯式資料庫(RDBMS)以及非關聯式資料庫(NoSQL)等等整合。 +### 依賴注入(Dependency Injection) { #dependency-injection } -### 依賴注入(Dependency Injection) - -FastAPI 有一個使用簡單,但是非常強大的依賴注入系統。 +FastAPI 有一個使用簡單,但是非常強大的 依賴注入 系統。 * 依賴項甚至可以有自己的依賴,從而形成一個層級或**依賴圖**的結構。 * 所有**自動化處理**都由框架完成。 @@ -151,23 +145,21 @@ FastAPI 有一個使用簡單,但是非常強大的Pydantic。所以,你有其他 Pydantic 程式碼也能正常工作。 -相容包括基於 Pydantic 的外部函式庫, 例如用於資料庫的 ORMs, ODMs。 +相容包括基於 Pydantic 的外部函式庫,例如用於資料庫的 ORMs、ODMs。 這也意味著在很多情況下,你可以把從請求中獲得的物件**直接傳到資料庫**,因為所有資料都會自動進行驗證。 @@ -196,7 +188,7 @@ FastAPI 有一個使用簡單,但是非常強大的發一則關於 **FastAPI** 的推文,讓我與其他人知道你為什麼喜歡它。🎉 + +我很樂於聽到 **FastAPI** 是如何被使用、你喜歡它的哪些地方、在哪個專案/公司使用它等等。 + +## 為 FastAPI 投票 { #vote-for-fastapi } + +* 在 Slant 為 **FastAPI** 投票。 +* 在 AlternativeTo 為 **FastAPI** 投票。 +* 在 StackShare 表示你使用 **FastAPI**。 + +## 在 GitHub 幫助他人解答問題 { #help-others-with-questions-in-github } + +你可以嘗試幫助他人回答以下地方的問題: + +* GitHub Discussions +* GitHub Issues + +很多時候你可能已經知道這些問題的解答。🤓 + +如果你經常幫大家解決問題,你會成為官方的 [FastAPI 專家](fastapi-people.md#fastapi-experts){.internal-link target=_blank}。🎉 + +請記得,最重要的是:盡量友善。大家可能帶著挫折而來,很多時候提問方式不夠理想,但請盡你所能保持友善。🤗 + +**FastAPI** 社群的理念是友善且歡迎大家。同時,也不要接受霸凌或對他人不尊重的行為。我們要彼此照顧。 + +--- + +以下是在(Discussions 或 Issues)中幫助他人解決問題的方式: + +### 先理解問題 { #understand-the-question } + +* 先確認你是否能理解提問者的**目的**與使用情境。 + +* 接著看看問題(絕大多數是提問)是否**清楚**。 + +* 很多時候,提問是基於使用者自己想像中的解法,但可能有**更好**的方法。如果你能更理解他們的問題與使用情境,你也許能提出更好的**替代解法**。 + +* 如果你無法理解問題,請要求提供更多**細節**。 + +### 重現問題 { #reproduce-the-problem } + +在大多數情況與問題中,都會與對方的**原始程式碼**有關。 + +很多時候他們只會貼出一小段程式碼,但那不足以**重現問題**。 + +* 你可以請他們提供一個最小可重現範例,讓你可以**複製貼上**並在本機執行,看到與他們相同的錯誤或行為,或更好地理解他們的使用情境。 + +* 如果你有心力,你也可以嘗試自己**建立一個範例**,僅依據問題描述來還原。不過請記得這可能很耗時,或許更好的是先請他們把問題說清楚。 + +### 提出解法建議 { #suggest-solutions } + +* 在能夠理解問題後,你可以給出可能的**答案**。 + +* 很多時候,最好能理解他們的**底層問題或使用情境**,因為可能有比他們嘗試的方法更好的解決之道。 + +### 請求關閉議題 { #ask-to-close } + +如果他們回覆了,你很可能已經解決了他們的問題,恭喜,**你是英雄**!🦸 + +* 現在,如果問題已解決,你可以請他們: + * 在 GitHub Discussions:把某則留言標記為**答案**。 + * 在 GitHub Issues:**關閉**該 issue。 + +## 追蹤 GitHub 儲存庫 { #watch-the-github-repository } + +你可以在 GitHub「watch」FastAPI(點擊右上角的「watch」按鈕):https://github.com/fastapi/fastapi。👀 + +如果你選擇「Watching」而不是「Releases only」,當有人建立新的 issue 或問題時你會收到通知。你也可以指定只想被通知新的 issues、discussions、PR 等等。 + +接著你就可以嘗試幫忙解決那些問題。 + +## 提問 { #ask-questions } + +你可以在 GitHub 儲存庫建立一個新的問題(Question),例如用來: + +* 提出**問題**或詢問某個**疑難**。 +* 建議一個新的**功能**。 + +**注意**:如果你這麼做,那我也會請你去幫助其他人。😉 + +## 審核 Pull Request { #review-pull-requests } + +你可以幫我審查他人的 Pull Request。 + +再強調一次,請盡量保持友善。🤗 + +--- + +以下是審查 Pull Request 時需要注意與如何進行: + +### 先理解要解的問題 { #understand-the-problem } + +* 首先,確認你**理解了該 Pull Request 想解決的問題**。可能在 GitHub Discussion 或 issue 中有更長的討論。 + +* 也很有可能這個 Pull Request 其實不需要,因為問題可以用**不同的方法**解決。那你就可以提出或詢問那個方向。 + +### 不用太在意風格 { #dont-worry-about-style } + +* 不要太擔心像是提交訊息(commit message)的風格,我會用 squash and merge 並手動調整提交內容。 + +* 也不用太在意程式碼風格規範,已經有自動化工具在檢查。 + +如果還有其他風格或一致性的需求,我會直接提出請求,或是在上面再補上需要的修改提交。 + +### 檢查程式碼 { #check-the-code } + +* 檢查並閱讀程式碼,看看是否合理,**在本機執行**並確認它是否真的解決了問題。 + +* 然後**留言**說你做了這些,這樣我才知道你真的檢查過了。 + +/// info + +很遺憾,我不能僅因為一個 PR 有好幾個核可就直接信任它。 + +發生過好幾次,PR 有 3、5 個甚至更多核可,可能是因為描述很吸引人,但當我實際檢查時,它其實是壞的、有 bug,或是根本沒有解決它宣稱要解決的問題。😅 + +所以,真的很重要的是你要實際閱讀並執行程式碼,並在留言中讓我知道你做過了。🤓 + +/// + +* 如果 PR 有機會再被簡化,你可以提出要求,但沒必要太過挑剔,很多事情是主觀的(我自己也會有主觀看法 🙈),所以最好聚焦在關鍵的事情上。 + +### 測試 { #tests } + +* 幫我確認 PR 有**測試**。 + +* 檢查在 PR 之前,測試會**失敗**。🚨 + +* 然後檢查在 PR 之後,測試會**通過**。✅ + +* 很多 PR 並沒有測試,你可以**提醒**他們加上測試,或甚至**建議**一些測試。這是最花時間的事之一,而你可以在這方面幫上很大的忙。 + +* 接著也請留言你嘗試了什麼,這樣我就知道你有檢查過。🤓 + +## 建立 Pull Request { #create-a-pull-request } + +你可以透過 Pull Request 來[貢獻](contributing.md){.internal-link target=_blank}原始碼,例如: + +* 修正文檔中你發現的錯字。 +* 分享你建立或發現的 FastAPI 相關文章、影片或 podcast,方法是編輯這個檔案。 + * 請確保把你的連結加到對應章節的開頭。 +* 協助把[文件翻譯](contributing.md#translations){.internal-link target=_blank}成你的語言。 + * 你也可以幫忙審查他人提交的翻譯。 +* 提議新的文件章節。 +* 修復既有的 issue/bug。 + * 記得要加上測試。 +* 新增一個功能。 + * 記得要加上測試。 + * 若相關,請記得補上文件。 + +## 協助維護 FastAPI { #help-maintain-fastapi } + +幫我一起維護 **FastAPI**!🤓 + +有很多事情要做,而其中大多數其實**你**就能完成。 + +你現在就能做的主要任務有: + +* [在 GitHub 幫助他人解答問題](#help-others-with-questions-in-github){.internal-link target=_blank}(見上方章節)。 +* [審核 Pull Request](#review-pull-requests){.internal-link target=_blank}(見上方章節)。 + +這兩件事是**最耗時**的。這也是維護 FastAPI 的主要工作。 + +如果你能在這方面幫我,**你就是在幫我維護 FastAPI**,並確保它能**更快更好地前進**。🚀 + +## 加入聊天室 { #join-the-chat } + +加入 👥 Discord 聊天伺服器 👥,與 FastAPI 社群的其他人一起交流。 + +/// tip + +若要提問,請到 GitHub Discussions,在那裡更有機會獲得[FastAPI 專家](fastapi-people.md#fastapi-experts){.internal-link target=_blank}的協助。 + +聊天室請僅用於其他一般性的交流。 + +/// + +### 不要在聊天室提問 { #dont-use-the-chat-for-questions } + +請記得,由於聊天室允許較「自由的對話」,很容易提出過於籠統、較難回答的問題,因此你可能不會得到答案。 + +在 GitHub 上,模板會引導你寫出合適的提問,讓你更容易得到好的解答,甚至在提問前就自己解決問題。而且在 GitHub 上,我能確保最終都會回覆(即使需要一些時間)。我個人無法在聊天系統做到這一點。😅 + +聊天系統中的對話也不像 GitHub 那樣容易被搜尋,因此問題與答案可能在對話中淹沒。而且只有 GitHub 上的問題與回答才會被計入成為[FastAPI 專家](fastapi-people.md#fastapi-experts){.internal-link target=_blank},因此你在 GitHub 上更有機會獲得關注。 + +另一方面,聊天室裡有成千上萬的使用者,所以幾乎隨時都有很大的機會能找到人聊天。😄 + +## 贊助作者 { #sponsor-the-author } + +如果你的**產品/公司**依賴或與 **FastAPI** 相關,且你想觸及它的使用者,你可以透過 GitHub sponsors 贊助作者(我)。依據不同級別,你可能會得到一些額外福利,例如在文件中顯示徽章。🎁 + +--- + +感謝!🚀 diff --git a/docs/zh-hant/docs/history-design-future.md b/docs/zh-hant/docs/history-design-future.md new file mode 100644 index 0000000000..b7f57a3636 --- /dev/null +++ b/docs/zh-hant/docs/history-design-future.md @@ -0,0 +1,79 @@ +# 歷史、設計與未來 { #history-design-and-future } + +不久之前,一位 **FastAPI** 使用者提問: + +> 這個專案的歷史是什麼?看起來它在短短幾週內從默默無名變得非常厲害 [...] + +以下是其中一小段歷史。 + +## 替代方案 { #alternatives } + +多年來我一直在打造具有複雜需求的 API(機器學習、分散式系統、非同步工作、NoSQL 資料庫等),並帶領多個開發團隊。 + +在此過程中,我需要調查、測試並使用許多替代方案。 + +**FastAPI** 的歷史,在很大程度上也是其前身工具的歷史。 + +如在[替代方案](alternatives.md){.internal-link target=_blank}章節所述: + +
+ +若沒有他人的前期成果,就不會有 **FastAPI**。 + +先前已有許多工具啟發了它的誕生。 + +我曾經多年避免再去打造一個新框架。起初我嘗試用各種不同的框架、外掛與工具,來滿足 **FastAPI** 涵蓋的所有功能。 + +但在某個時刻,別無選擇,只能打造一個同時提供所有這些功能的東西,取過去工具之長,並以可能的最佳方式加以結合,還運用了以往甚至不存在的語言功能(Python 3.6+ 的型別提示)。 + +
+ +## 調研 { #investigation } + +透過實際使用這些替代方案,我得以向它們學習、汲取想法,並以我能為自己與合作開發團隊找到的最佳方式加以整合。 + +例如,很清楚理想上應以標準的 Python 型別提示為基礎。 + +同時,最佳做法就是採用現有標準。 + +因此,在開始撰寫 **FastAPI** 之前,我花了好幾個月研究 OpenAPI、JSON Schema、OAuth2 等規範,了解它們之間的關係、重疊與差異。 + +## 設計 { #design } + +接著,我花時間設計作為使用者(作為使用 FastAPI 的開發者)時希望擁有的開發者「API」。 + +我在最受歡迎的 Python 編輯器中測試了多個想法:PyCharm、VS Code、基於 Jedi 的編輯器。 + +根據最新的 Python 開發者調查,這些工具涵蓋約 80% 的使用者。 + +這表示 **FastAPI** 已針對 80% 的 Python 開發者所使用的編輯器進行過專門測試。而由於其他多數編輯器的行為也類似,這些優點幾乎在所有編輯器上都能生效。 + +藉此我找到了盡可能減少程式碼重複、在各處提供自動補全、型別與錯誤檢查等的最佳方式。 + +一切都是為了讓所有開發者都能擁有最佳的開發體驗。 + +## 需求 { #requirements } + +在測試多種替代方案後,我決定採用 **Pydantic**,因為它的優勢。 + +隨後我也對它做出貢獻,使其完全符合 JSON Schema、支援以不同方式定義約束,並依據在多款編輯器中的測試結果改進編輯器支援(型別檢查、自動補全)。 + +在開發過程中,我也對 **Starlette**(另一個關鍵依賴)做出貢獻。 + +## 開發 { #development } + +當我開始著手實作 **FastAPI** 本身時,多數拼圖已經就緒,設計已定,需求與工具已備齊,對各項標準與規範的理解也清晰且新鮮。 + +## 未來 { #future } + +到目前為止,**FastAPI** 及其理念已經對許多人有幫助。 + +相較先前的替代方案,它更適合許多使用情境,因而被選用。 + +許多開發者與團隊(包括我和我的團隊)已經在他們的專案中依賴 **FastAPI**。 + +但仍有許多改進與功能即將到來。 + +**FastAPI** 的前景非常光明。 + +也非常感謝[你的幫助](help-fastapi.md){.internal-link target=_blank}。 diff --git a/docs/zh-hant/docs/how-to/authentication-error-status-code.md b/docs/zh-hant/docs/how-to/authentication-error-status-code.md new file mode 100644 index 0000000000..9a8de4c910 --- /dev/null +++ b/docs/zh-hant/docs/how-to/authentication-error-status-code.md @@ -0,0 +1,15 @@ +# 使用舊的 403 身分驗證錯誤狀態碼 { #use-old-403-authentication-error-status-codes } + +在 FastAPI 版本 `0.122.0` 之前,當內建的安全工具在身分驗證失敗後回傳錯誤給用戶端時,會使用 HTTP 狀態碼 `403 Forbidden`。 + +從 FastAPI 版本 `0.122.0` 起,改為使用更合適的 HTTP 狀態碼 `401 Unauthorized`,並在回應中依據 HTTP 規範加上合理的 `WWW-Authenticate` 標頭,參考 RFC 7235RFC 9110。 + +但如果你的用戶端因某些原因依賴於舊行為,你可以在你的 security 類別中覆寫 `make_not_authenticated_error` 方法以恢復舊的行為。 + +例如,你可以建立 `HTTPBearer` 的子類別,讓它回傳 `403 Forbidden` 錯誤,而不是預設的 `401 Unauthorized` 錯誤: + +{* ../../docs_src/authentication_error_status_code/tutorial001_an_py310.py hl[9:13] *} + +/// tip +注意這個函式回傳的是例外物件本身,而不是直接拋出它。拋出的動作會在其餘的內部程式碼中處理。 +/// diff --git a/docs/zh-hant/docs/how-to/conditional-openapi.md b/docs/zh-hant/docs/how-to/conditional-openapi.md new file mode 100644 index 0000000000..5c091e5b7b --- /dev/null +++ b/docs/zh-hant/docs/how-to/conditional-openapi.md @@ -0,0 +1,56 @@ +# 條件式 OpenAPI { #conditional-openapi } + +如果需要,你可以用設定與環境變數,依據執行環境有條件地調整 OpenAPI,甚至完全停用它。 + +## 關於安全性、API 與文件 { #about-security-apis-and-docs } + +在正式環境中隱藏文件 UI *不應該* 是用來保護 API 的方式。 + +這並不會為你的 API 增添任何額外的安全性,*路徑操作* 仍舊照常可用。 + +若你的程式碼有安全性缺陷,它依然會存在。 + +隱藏文件只會讓他人更難理解如何與你的 API 互動,也可能讓你在正式環境除錯更困難。這通常僅被視為一種 以隱匿求安全。 + +如果你想保護 API,有許多更好的作法,例如: + +- 確保針對請求本文與回應,具備定義良好的 Pydantic 模型。 +- 透過依賴設定所需的權限與角色。 +- 切勿儲存明文密碼,只儲存密碼雜湊。 +- 實作並使用成熟且廣為人知的密碼學工具,例如 pwdlib 與 JWT 權杖等。 +- 視需要以 OAuth2 scopes 新增更細緻的權限控管。 +- ...等。 + +儘管如此,在某些特定情境下,你可能確實需要在某些環境(例如正式環境)停用 API 文件,或依據環境變數的設定來決定是否啟用。 + +## 透過設定與環境變數的條件式 OpenAPI { #conditional-openapi-from-settings-and-env-vars } + +你可以用相同的 Pydantic 設定,來配置產生的 OpenAPI 與文件 UI。 + +例如: + +{* ../../docs_src/conditional_openapi/tutorial001_py310.py hl[6,11] *} + +這裡我們宣告 `openapi_url` 設定,預設值同樣是 `"/openapi.json"`。 + +接著在建立 `FastAPI` 應用時使用它。 + +然後你可以將環境變數 `OPENAPI_URL` 設為空字串,以停用 OpenAPI(包含文件 UI),如下: + +
+ +```console +$ OPENAPI_URL= uvicorn main:app + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +之後若你造訪 `/openapi.json`、`/docs` 或 `/redoc`,會看到如下的 `404 Not Found` 錯誤: + +```JSON +{ + "detail": "Not Found" +} +``` diff --git a/docs/zh-hant/docs/how-to/configure-swagger-ui.md b/docs/zh-hant/docs/how-to/configure-swagger-ui.md new file mode 100644 index 0000000000..e5b6d7d1e3 --- /dev/null +++ b/docs/zh-hant/docs/how-to/configure-swagger-ui.md @@ -0,0 +1,70 @@ +# 設定 Swagger UI { #configure-swagger-ui } + +你可以設定一些額外的 Swagger UI 參數。 + +要設定它們,建立 `FastAPI()` 應用物件時,或呼叫 `get_swagger_ui_html()` 函式時,傳入參數 `swagger_ui_parameters`。 + +`swagger_ui_parameters` 接受一個 dict,內容會直接傳給 Swagger UI 作為設定。 + +FastAPI 會把這些設定轉換成 JSON,以便與 JavaScript 相容,因為 Swagger UI 需要的是這種格式。 + +## 停用語法醒目提示 { #disable-syntax-highlighting } + +例如,你可以在 Swagger UI 中停用語法醒目提示(syntax highlighting)。 + +不更動設定時,語法醒目提示預設為啟用: + + + +但你可以將 `syntaxHighlight` 設為 `False` 來停用它: + +{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *} + +...然後 Swagger UI 就不會再顯示語法醒目提示: + + + +## 更換主題 { #change-the-theme } + +同樣地,你可以用鍵 `"syntaxHighlight.theme"` 設定語法醒目提示主題(注意中間有一個點): + +{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *} + +這個設定會變更語法醒目提示的配色主題: + + + +## 更改預設的 Swagger UI 參數 { #change-default-swagger-ui-parameters } + +FastAPI 內建一些預設參數,適用於大多數情境。 + +包含以下預設設定: + +{* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *} + +你可以在 `swagger_ui_parameters` 參數中提供不同的值來覆蓋其中任一項。 + +例如,要停用 `deepLinking`,可以在 `swagger_ui_parameters` 傳入以下設定: + +{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *} + +## 其他 Swagger UI 參數 { #other-swagger-ui-parameters } + +若要查看所有可用的設定,請參考官方的 Swagger UI 參數文件。 + +## 僅限 JavaScript 的設定 { #javascript-only-settings } + +Swagger UI 也允許某些設定是僅限 JavaScript 的物件(例如 JavaScript 函式)。 + +FastAPI 也包含以下僅限 JavaScript 的 `presets` 設定: + +```JavaScript +presets: [ + SwaggerUIBundle.presets.apis, + SwaggerUIBundle.SwaggerUIStandalonePreset +] +``` + +這些是 JavaScript 物件,而不是字串,因此無法直接從 Python 程式碼傳遞。 + +若需要使用這類僅限 JavaScript 的設定,你可以使用上面介紹的方法:覆寫所有 Swagger UI 的路徑操作(path operation),並手動撰寫所需的 JavaScript。 diff --git a/docs/zh-hant/docs/how-to/custom-docs-ui-assets.md b/docs/zh-hant/docs/how-to/custom-docs-ui-assets.md new file mode 100644 index 0000000000..4b53945891 --- /dev/null +++ b/docs/zh-hant/docs/how-to/custom-docs-ui-assets.md @@ -0,0 +1,185 @@ +# 自訂文件 UI 靜態資源(自我託管) { #custom-docs-ui-static-assets-self-hosting } + +API 文件使用 Swagger UI 與 ReDoc,它們各自需要一些 JavaScript 與 CSS 檔案。 + +預設情況下,這些檔案會從 CDN 提供。 + +但你可以自訂:你可以指定特定的 CDN,或自行提供這些檔案。 + +## 為 JavaScript 和 CSS 使用自訂 CDN { #custom-cdn-for-javascript-and-css } + +假設你想使用不同的 CDN,例如使用 `https://unpkg.com/`。 + +若你所在的國家限制部分網址,這會很有用。 + +### 停用自動產生的文件 { #disable-the-automatic-docs } + +第一步是停用自動文件,因為預設會使用預設的 CDN。 + +要停用它們,建立 `FastAPI` 應用時把相關 URL 設為 `None`: + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[8] *} + +### 加入自訂文件 { #include-the-custom-docs } + +現在你可以為自訂文件建立「路徑操作(path operation)」。 + +你可以重用 FastAPI 的內部函式來建立文件的 HTML 頁面,並傳入所需參數: + +* `openapi_url`:文件 HTML 頁面用來取得你 API 的 OpenAPI schema 的 URL。可使用屬性 `app.openapi_url`。 +* `title`:你的 API 標題。 +* `oauth2_redirect_url`:可使用 `app.swagger_ui_oauth2_redirect_url` 以沿用預設值。 +* `swagger_js_url`:Swagger UI 文件 HTML 用來取得「JavaScript」檔案的 URL。這是你的自訂 CDN 位址。 +* `swagger_css_url`:Swagger UI 文件 HTML 用來取得「CSS」檔案的 URL。這是你的自訂 CDN 位址。 + +ReDoc 也類似... + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[2:6,11:19,22:24,27:33] *} + +/// tip + +當你使用 OAuth2 時,`swagger_ui_redirect` 的路徑操作是個輔助端點。 + +如果你把 API 與 OAuth2 提供者整合,便能完成認證並帶著取得的憑證回到 API 文件,接著以真正的 OAuth2 驗證與之互動。 + +Swagger UI 會在背後幫你處理,不過它需要這個「redirect」輔助端點。 + +/// + +### 建立路徑操作以進行測試 { #create-a-path-operation-to-test-it } + +現在,為了測試一切是否正常,建立一個路徑操作: + +{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[36:38] *} + +### 測試 { #test-it } + +現在你應該能造訪 http://127.0.0.1:8000/docs,重新載入頁面後,資源會從新的 CDN 載入。 + +## 自行託管文件所需的 JavaScript 與 CSS { #self-hosting-javascript-and-css-for-docs } + +若你需要應用在離線、無公共網路或僅在區域網路中也能運作,自行託管 JavaScript 與 CSS 會很實用。 + +以下示範如何在同一個 FastAPI 應用中自行提供這些檔案,並設定文件使用它們。 + +### 專案檔案結構 { #project-file-structure } + +假設你的專案檔案結構如下: + +``` +. +├── app +│ ├── __init__.py +│ ├── main.py +``` + +現在建立一個目錄來存放這些靜態檔案。 + +新的檔案結構可能如下: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +└── static/ +``` + +### 下載檔案 { #download-the-files } + +下載文件所需的靜態檔案並放到 `static/` 目錄中。 + +你可以在各連結上按右鍵,選擇類似「另存連結為...」的選項。 + +Swagger UI 需要以下檔案: + +* `swagger-ui-bundle.js` +* `swagger-ui.css` + +而 ReDoc 需要以下檔案: + +* `redoc.standalone.js` + +之後,你的檔案結構可能如下: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +└── static + ├── redoc.standalone.js + ├── swagger-ui-bundle.js + └── swagger-ui.css +``` + +### 提供靜態檔案 { #serve-the-static-files } + +* 匯入 `StaticFiles`。 +* 在特定路徑「掛載」一個 `StaticFiles()` 實例。 + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[7,11] *} + +### 測試靜態檔案 { #test-the-static-files } + +啟動你的應用並前往 http://127.0.0.1:8000/static/redoc.standalone.js。 + +你應該會看到一個很長的 **ReDoc** JavaScript 檔案。 + +它可能會以如下內容開頭: + +```JavaScript +/*! For license information please see redoc.standalone.js.LICENSE.txt */ +!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("null")): +... +``` + +這表示你的應用已能提供靜態檔案,且文件用的靜態檔已放在正確位置。 + +接著把應用設定為讓文件使用這些靜態檔。 + +### 為靜態檔案停用自動文件 { #disable-the-automatic-docs-for-static-files } + +和使用自訂 CDN 一樣,第一步是停用自動文件,因為預設會使用 CDN。 + +要停用它們,建立 `FastAPI` 應用時把相關 URL 設為 `None`: + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[9] *} + +### 加入使用靜態檔案的自訂文件 { #include-the-custom-docs-for-static-files } + +同樣地,現在你可以為自訂文件建立路徑操作。 + +再次重用 FastAPI 的內部函式來建立文件的 HTML 頁面,並傳入所需參數: + +* `openapi_url`:文件 HTML 頁面用來取得你 API 的 OpenAPI schema 的 URL。可使用屬性 `app.openapi_url`。 +* `title`:你的 API 標題。 +* `oauth2_redirect_url`:可使用 `app.swagger_ui_oauth2_redirect_url` 以沿用預設值。 +* `swagger_js_url`:Swagger UI 文件 HTML 用來取得「JavaScript」檔案的 URL。這就是你的應用現在提供的檔案。 +* `swagger_css_url`:Swagger UI 文件 HTML 用來取得「CSS」檔案的 URL。這就是你的應用現在提供的檔案。 + +ReDoc 也類似... + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[2:6,14:22,25:27,30:36] *} + +/// tip + +當你使用 OAuth2 時,`swagger_ui_redirect` 的路徑操作是個輔助端點。 + +如果你把 API 與 OAuth2 提供者整合,便能完成認證並帶著取得的憑證回到 API 文件,接著以真正的 OAuth2 驗證與之互動。 + +Swagger UI 會在背後幫你處理,不過它需要這個「redirect」輔助端點。 + +/// + +### 建立路徑操作以測試靜態檔案 { #create-a-path-operation-to-test-static-files } + +現在,為了測試一切是否正常,建立一個路徑操作: + +{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[39:41] *} + +### 測試使用靜態檔案的 UI { #test-static-files-ui } + +現在,你應該可以關閉 WiFi,造訪你的文件 http://127.0.0.1:8000/docs,並重新載入頁面。 + +即使沒有網際網路,也能看到你的 API 文件並與之互動。 diff --git a/docs/zh-hant/docs/how-to/custom-request-and-route.md b/docs/zh-hant/docs/how-to/custom-request-and-route.md new file mode 100644 index 0000000000..99c3410e47 --- /dev/null +++ b/docs/zh-hant/docs/how-to/custom-request-and-route.md @@ -0,0 +1,109 @@ +# 自訂 Request 與 APIRoute 類別 { #custom-request-and-apiroute-class } + +在某些情況下,你可能想要覆寫 `Request` 與 `APIRoute` 類別所使用的邏輯。 + +特別是,這可能是替代中介軟體(middleware)中實作邏輯的一個好方法。 + +例如,如果你想在應用程式處理之前讀取或操作請求本文(request body)。 + +/// danger + +這是進階功能。 + +如果你剛開始使用 **FastAPI**,可以先跳過本節。 + +/// + +## 使用情境 { #use-cases } + +可能的使用情境包括: + +* 將非 JSON 的請求本文轉換為 JSON(例如 `msgpack`)。 +* 解壓縮以 gzip 壓縮的請求本文。 +* 自動記錄所有請求本文。 + +## 處理自訂請求本文編碼 { #handling-custom-request-body-encodings } + +讓我們看看如何使用自訂的 `Request` 子類別來解壓縮 gzip 請求。 + +並透過 `APIRoute` 子類別來使用該自訂的請求類別。 + +### 建立自訂的 `GzipRequest` 類別 { #create-a-custom-gziprequest-class } + +/// tip + +這是一個示範用的簡化範例;如果你需要 Gzip 支援,可以直接使用提供的 [`GzipMiddleware`](../advanced/middleware.md#gzipmiddleware){.internal-link target=_blank}。 + +/// + +首先,我們建立 `GzipRequest` 類別,它會覆寫 `Request.body()` 方法,當存在對應的標頭時解壓縮本文。 + +如果標頭中沒有 `gzip`,它就不會嘗試解壓縮本文。 + +如此一來,相同的路由類別即可同時處理經 gzip 壓縮與未壓縮的請求. + +{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[9:16] *} + +### 建立自訂的 `GzipRoute` 類別 { #create-a-custom-gziproute-class } + +接著,我們建立 `fastapi.routing.APIRoute` 的自訂子類別,讓它使用 `GzipRequest`。 + +這次,它會覆寫 `APIRoute.get_route_handler()` 方法。 + +這個方法會回傳一個函式,而該函式會接收請求並回傳回應。 + +在這裡,我們用它將原始的請求包裝成 `GzipRequest`。 + +{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[19:27] *} + +/// note | 技術細節 + +`Request` 具有 `request.scope` 屬性,它其實就是一個 Python 的 `dict`,包含與該請求相關的中繼資料。 + +`Request` 也有 `request.receive`,那是一個用來「接收」請求本文的函式。 + +`scope` 這個 `dict` 與 `receive` 函式都是 ASGI 規格的一部分。 + +而 `scope` 與 `receive` 這兩者,就是建立一個新的 `Request` 實例所需的資料。 + +想了解更多 `Request`,請參考 Starlette 的 Request 文件。 + +/// + +由 `GzipRequest.get_route_handler` 回傳的函式,唯一不同之處在於它會把 `Request` 轉換成 `GzipRequest`。 + +這麼做之後,`GzipRequest` 會在把資料交給 *路徑操作* 之前(若有需要)先負責解壓縮。 + +之後的處理邏輯完全相同。 + +但由於我們修改了 `GzipRequest.body`,在 **FastAPI** 需要讀取本文時,請求本文會自動解壓縮。 + +## 在例外處理器中存取請求本文 { #accessing-the-request-body-in-an-exception-handler } + +/// tip + +要解決相同問題,使用針對 `RequestValidationError` 的自訂處理器來讀取 `body` 通常更簡單([處理錯誤](../tutorial/handling-errors.md#use-the-requestvalidationerror-body){.internal-link target=_blank})。 + +但本範例仍然有效,並示範了如何與內部元件互動。 + +/// + +我們也可以用同樣的方法,在例外處理器中存取請求本文。 + +我們只需要在 `try`/`except` 區塊中處理請求即可: + +{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[14,16] *} + +若發生例外,`Request` 實例依然在作用域內,因此在處理錯誤時我們仍可讀取並使用請求本文: + +{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[17:19] *} + +## 在路由器中自訂 `APIRoute` 類別 { #custom-apiroute-class-in-a-router } + +你也可以在 `APIRouter` 上設定 `route_class` 參數: + +{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[26] *} + +在此範例中,`router` 底下的路徑操作會使用自訂的 `TimedRoute` 類別,並在回應中多加上一個 `X-Response-Time` 標頭,標示產生該回應所花費的時間: + +{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[13:20] *} diff --git a/docs/zh-hant/docs/how-to/extending-openapi.md b/docs/zh-hant/docs/how-to/extending-openapi.md new file mode 100644 index 0000000000..c51e896f32 --- /dev/null +++ b/docs/zh-hant/docs/how-to/extending-openapi.md @@ -0,0 +1,80 @@ +# 擴充 OpenAPI { #extending-openapi } + +有些情況你可能需要修改自動產生的 OpenAPI 結構(schema)。 + +本章將示範如何做。 + +## 一般流程 { #the-normal-process } + +一般(預設)的流程如下。 + +`FastAPI` 應用程式(實例)有一個 `.openapi()` 方法,會回傳 OpenAPI 結構。 + +在建立應用物件時,會同時註冊一個 `/openapi.json`(或你在 `openapi_url` 設定的路徑)的路徑操作(path operation)。 + +這個路徑只會回傳一個 JSON 回應,內容就是應用的 `.openapi()` 方法結果。 + +預設情況下,`.openapi()` 會先檢查 `.openapi_schema` 屬性是否已有內容,有的話就直接回傳。 + +若沒有,則會呼叫 `fastapi.openapi.utils.get_openapi` 這個工具函式來產生。 + +`get_openapi()` 函式會接收以下參數: + +* `title`:OpenAPI 的標題,會顯示在文件中。 +* `version`:你的 API 版本,例如 `2.5.0`。 +* `openapi_version`:所使用的 OpenAPI 規格版本。預設為最新版本:`3.1.0`。 +* `summary`:API 的簡短摘要。 +* `description`:API 的描述,可包含 Markdown,會顯示在文件中。 +* `routes`:路由列表,也就是所有已註冊的路徑操作。來源為 `app.routes`。 + +/// info + +`summary` 參數在 OpenAPI 3.1.0 以上可用,且需 FastAPI 0.99.0 以上版本支援。 + +/// + +## 覆寫預設行為 { #overriding-the-defaults } + +基於上述資訊,你可以用相同的工具函式來產生 OpenAPI 結構,並覆寫你需要客製的部分。 + +例如,我們要加入 ReDoc 的 OpenAPI 擴充,插入自訂 logo。 + +### 一般的 **FastAPI** { #normal-fastapi } + +先照常撰寫你的 **FastAPI** 應用: + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[1,4,7:9] *} + +### 產生 OpenAPI 結構 { #generate-the-openapi-schema } + +接著,在 `custom_openapi()` 函式內,使用相同的工具函式來產生 OpenAPI 結構: + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[2,15:21] *} + +### 修改 OpenAPI 結構 { #modify-the-openapi-schema } + +現在可以加入 ReDoc 擴充,在 OpenAPI 結構的 `info`「物件」中新增自訂的 `x-logo`: + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[22:24] *} + +### 快取 OpenAPI 結構 { #cache-the-openapi-schema } + +你可以把 `.openapi_schema` 屬性當作「快取」來儲存已產生的結構。 + +這樣使用者每次開啟 API 文件時,應用就不必重複產生結構。 + +結構只會產生一次,之後的請求都會使用相同的快取結果。 + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[13:14,25:26] *} + +### 覆寫方法 { #override-the-method } + +現在你可以用新的函式取代 `.openapi()` 方法。 + +{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[29] *} + +### 檢查看看 { #check-it } + +造訪 http://127.0.0.1:8000/redoc 後,你會看到自訂的 logo(此例為 **FastAPI** 的 logo): + + diff --git a/docs/zh-hant/docs/how-to/general.md b/docs/zh-hant/docs/how-to/general.md new file mode 100644 index 0000000000..96a71d62dd --- /dev/null +++ b/docs/zh-hant/docs/how-to/general.md @@ -0,0 +1,39 @@ +# 通用 - 操作指南 - 實用範例 { #general-how-to-recipes } + +以下是文件中其他位置的指引連結,適用於一般或常見問題。 + +## 篩選資料 - 安全性 { #filter-data-security } + +為確保你不會回傳超出應有的資料,請參閱[教學 - 回應模型 - 回傳型別](../tutorial/response-model.md){.internal-link target=_blank}。 + +## 文件標籤 - OpenAPI { #documentation-tags-openapi } + +要在你的*路徑操作(path operation)*加入標籤,並在文件 UI 中分組,請參閱[教學 - 路徑操作設定 - 標籤](../tutorial/path-operation-configuration.md#tags){.internal-link target=_blank}。 + +## 文件摘要與描述 - OpenAPI { #documentation-summary-and-description-openapi } + +要為你的*路徑操作*加入摘要與描述,並在文件 UI 中顯示,請參閱[教學 - 路徑操作設定 - 摘要與描述](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank}。 + +## 文件回應描述 - OpenAPI { #documentation-response-description-openapi } + +要定義在文件 UI 中顯示的回應描述,請參閱[教學 - 路徑操作設定 - 回應描述](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank}。 + +## 文件將*路徑操作*標記為已棄用 - OpenAPI { #documentation-deprecate-a-path-operation-openapi } + +要將*路徑操作*標記為已棄用,並在文件 UI 中顯示,請參閱[教學 - 路徑操作設定 - 棄用](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank}。 + +## 將任意資料轉換為 JSON 相容格式 { #convert-any-data-to-json-compatible } + +要將任意資料轉換為 JSON 相容格式,請參閱[教學 - JSON 相容編碼器](../tutorial/encoder.md){.internal-link target=_blank}。 + +## OpenAPI 中繼資料 - 文件 { #openapi-metadata-docs } + +要在你的 OpenAPI 綱要中加入中繼資料(包含授權、版本、聯絡方式等),請參閱[教學 - 中繼資料與文件 URL](../tutorial/metadata.md){.internal-link target=_blank}。 + +## 自訂 OpenAPI URL { #openapi-custom-url } + +要自訂(或移除)OpenAPI 的 URL,請參閱[教學 - 中繼資料與文件 URL](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}。 + +## OpenAPI 文件 URL { #openapi-docs-urls } + +要更新自動產生的文件使用者介面所使用的 URL,請參閱[教學 - 中繼資料與文件 URL](../tutorial/metadata.md#docs-urls){.internal-link target=_blank}。 diff --git a/docs/zh-hant/docs/how-to/graphql.md b/docs/zh-hant/docs/how-to/graphql.md new file mode 100644 index 0000000000..51933210c5 --- /dev/null +++ b/docs/zh-hant/docs/how-to/graphql.md @@ -0,0 +1,60 @@ +# GraphQL { #graphql } + +由於 FastAPI 基於 ASGI 標準,整合任何與 ASGI 相容的 GraphQL 函式庫都很容易。 + +你可以在同一個應用程式中同時使用一般的 FastAPI 路徑操作 (path operation) 與 GraphQL。 + +/// tip + +GraphQL 解決某些非常特定的使用情境。 + +與一般的 Web API 相比,它有優點也有缺點。 + +請確認在你的使用情境中,這些效益是否足以彌補其限制。 🤓 + +/// + +## GraphQL 函式庫 { #graphql-libraries } + +下面是支援 ASGI 的部分 GraphQL 函式庫,你可以與 FastAPI 一起使用: + +* Strawberry 🍓 + * 提供 FastAPI 文件 +* Ariadne + * 提供 FastAPI 文件 +* Tartiflette + * 使用 Tartiflette ASGI 提供 ASGI 整合 +* Graphene + * 搭配 starlette-graphene3 + +## 使用 Strawberry 的 GraphQL { #graphql-with-strawberry } + +如果你需要或想使用 GraphQL,Strawberry 是推薦的函式庫,因為它的設計與 FastAPI 最接近,全部都基於型別註解 (type annotations)。 + +視你的使用情境而定,你可能會偏好其他函式庫,但如果你問我,我大概會建議你先試試 Strawberry。 + +以下是如何將 Strawberry 與 FastAPI 整合的一個小例子: + +{* ../../docs_src/graphql_/tutorial001_py310.py hl[3,22,25] *} + +你可以在 Strawberry 文件 中進一步了解 Strawberry。 + +也可以參考關於 Strawberry 與 FastAPI 的文件。 + +## 來自 Starlette 的較舊 `GraphQLApp` { #older-graphqlapp-from-starlette } + +早期版本的 Starlette 提供 `GraphQLApp` 類別以整合 Graphene。 + +它已在 Starlette 中被棄用,但如果你的程式碼使用了它,可以輕鬆遷移到 starlette-graphene3,涵蓋相同的使用情境,且介面幾乎相同。 + +/// tip + +如果你需要 GraphQL,我仍建議你看看 Strawberry,因為它基於型別註解,而不是自訂的類別與型別。 + +/// + +## 進一步了解 { #learn-more } + +你可以在 官方 GraphQL 文件 中進一步了解 GraphQL。 + +你也可以透過上述連結閱讀各個函式庫的更多內容。 diff --git a/docs/zh-hant/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md b/docs/zh-hant/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md new file mode 100644 index 0000000000..109e57bc81 --- /dev/null +++ b/docs/zh-hant/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md @@ -0,0 +1,135 @@ +# 從 Pydantic v1 遷移到 Pydantic v2 { #migrate-from-pydantic-v1-to-pydantic-v2 } + +如果你有一個舊的 FastAPI 應用,可能正在使用 Pydantic 1 版。 + +FastAPI 0.100.0 同時支援 Pydantic v1 或 v2,會使用你已安裝的那個版本。 + +FastAPI 0.119.0 透過 Pydantic v2 內的 `pydantic.v1` 提供對 Pydantic v1 的部分支援,以便遷移到 v2。 + +FastAPI 0.126.0 移除了對 Pydantic v1 的支援,但在一段時間內仍支援 `pydantic.v1`。 + +/// warning + +Pydantic 團隊自 **Python 3.14** 起,已停止在最新的 Python 版本中支援 Pydantic v1。 + +這也包含 `pydantic.v1`,在 Python 3.14 及以上版本不再支援。 + +如果你想使用最新的 Python 功能,就需要確保使用 Pydantic v2。 + +/// + +如果你的舊 FastAPI 應用仍使用 Pydantic v1,這裡會示範如何遷移到 Pydantic v2,並介紹 **FastAPI 0.119.0** 中可協助你逐步遷移的功能。 + +## 官方指南 { #official-guide } + +Pydantic 提供從 v1 遷移到 v2 的官方遷移指南。 + +其中包含變更內容、驗證如何更正確且更嚴格、可能的注意事項等。 + +你可以先閱讀以更好理解具體變更。 + +## 測試 { #tests } + +確保你的應用有[測試](../tutorial/testing.md){.internal-link target=_blank},並在 CI(持續整合)上執行。 + +如此一來,你可以升級後確認一切仍如預期運作。 + +## `bump-pydantic` { #bump-pydantic } + +在許多情況下,若你使用的是未自訂的標準 Pydantic 模型,多數遷移步驟都能自動化完成。 + +你可以使用 Pydantic 團隊提供的 `bump-pydantic`。 + +這個工具會自動修改大部分需要變更的程式碼。 + +之後執行測試確認一切正常即可完成。😎 + +## v2 中的 Pydantic v1 { #pydantic-v1-in-v2 } + +Pydantic v2 內含子模組 `pydantic.v1`,提供 Pydantic v1 的所有內容。但在 Python 3.13 以上版本不再支援。 + +這表示你可以安裝最新的 Pydantic v2,並從該子模組匯入並使用舊的 Pydantic v1 元件,就像安裝了舊版 Pydantic v1 一樣。 + +{* ../../docs_src/pydantic_v1_in_v2/tutorial001_an_py310.py hl[1,4] *} + +### FastAPI 對 v2 中 Pydantic v1 的支援 { #fastapi-support-for-pydantic-v1-in-v2 } + +自 FastAPI 0.119.0 起,也支援透過 Pydantic v2 內的 Pydantic v1(部分)以協助遷移至 v2。 + +因此,你可以先升級到最新的 Pydantic v2,並將匯入改為使用 `pydantic.v1` 子模組,在多數情況下即可正常運作。 + +{* ../../docs_src/pydantic_v1_in_v2/tutorial002_an_py310.py hl[2,5,15] *} + +/// warning + +請注意,由於 Pydantic 團隊自 Python 3.14 起不再支援 Pydantic v1,因此在 Python 3.14 及以上版本中也不支援使用 `pydantic.v1`。 + +/// + +### 同一應用同時使用 Pydantic v1 與 v2 { #pydantic-v1-and-v2-on-the-same-app } + +Pydantic 不支援在 Pydantic v2 模型的欄位中使用 Pydantic v1 模型,反之亦然。 + +```mermaid +graph TB + subgraph "❌ Not Supported" + direction TB + subgraph V2["Pydantic v2 Model"] + V1Field["Pydantic v1 Model"] + end + subgraph V1["Pydantic v1 Model"] + V2Field["Pydantic v2 Model"] + end + end + + style V2 fill:#f9fff3 + style V1 fill:#fff6f0 + style V1Field fill:#fff6f0 + style V2Field fill:#f9fff3 +``` + +...但你可以在同一應用中同時存在分開的 Pydantic v1 與 v2 模型。 + +```mermaid +graph TB + subgraph "✅ Supported" + direction TB + subgraph V2["Pydantic v2 Model"] + V2Field["Pydantic v2 Model"] + end + subgraph V1["Pydantic v1 Model"] + V1Field["Pydantic v1 Model"] + end + end + + style V2 fill:#f9fff3 + style V1 fill:#fff6f0 + style V1Field fill:#fff6f0 + style V2Field fill:#f9fff3 +``` + +在某些情況下,你甚至可以在同一個 FastAPI 路徑操作(path operation)中同時使用 Pydantic v1 與 v2 模型: + +{* ../../docs_src/pydantic_v1_in_v2/tutorial003_an_py310.py hl[2:3,6,12,21:22] *} + +在上面的範例中,輸入模型是 Pydantic v1,輸出模型(於 `response_model=ItemV2` 定義)是 Pydantic v2。 + +### Pydantic v1 參數 { #pydantic-v1-parameters } + +若你需要在 Pydantic v1 模型上使用 FastAPI 的參數工具(例如 `Body`、`Query`、`Form` 等),在完成遷移到 Pydantic v2 之前,可以從 `fastapi.temp_pydantic_v1_params` 匯入: + +{* ../../docs_src/pydantic_v1_in_v2/tutorial004_an_py310.py hl[4,18] *} + +### 分步遷移 { #migrate-in-steps } + +/// tip + +先嘗試使用 `bump-pydantic`,如果測試通過且一切正常,你就能用一條指令完成遷移。✨ + +/// + +若 `bump-pydantic` 不適用於你的情境,可以利用在同一應用同時支援 Pydantic v1 與 v2 的能力,逐步完成遷移。 + +你可以先升級 Pydantic 到最新 v2,並將所有模型的匯入改為使用 `pydantic.v1`。 + +接著按群組逐步把模型從 Pydantic v1 遷移到 v2。🚶 diff --git a/docs/zh-hant/docs/how-to/separate-openapi-schemas.md b/docs/zh-hant/docs/how-to/separate-openapi-schemas.md new file mode 100644 index 0000000000..2ecb6afbc1 --- /dev/null +++ b/docs/zh-hant/docs/how-to/separate-openapi-schemas.md @@ -0,0 +1,102 @@ +# 是否將輸入與輸出使用不同的 OpenAPI 結構描述 { #separate-openapi-schemas-for-input-and-output-or-not } + +自從 Pydantic v2 發佈後,生成的 OpenAPI 比以往更精確也更正確。😎 + +實際上,在某些情況下,同一個 Pydantic 模型在 OpenAPI 中會同時有兩個 JSON Schema:分別用於輸入與輸出,這取決於它是否有預設值。 + +來看看它如何運作,以及若需要時該如何調整。 + +## 作為輸入與輸出的 Pydantic 模型 { #pydantic-models-for-input-and-output } + +假設你有一個帶有預設值的 Pydantic 模型,如下所示: + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *} + +### 輸入用模型 { #model-for-input } + +如果你把這個模型用作輸入,如下所示: + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *} + +...則 `description` 欄位將不是必填。因為它的預設值是 `None`。 + +### 文件中的輸入模型 { #input-model-in-docs } + +你可以在文件中確認,`description` 欄位沒有紅色星號,表示不是必填: + +
+ +
+ +### 輸出用模型 { #model-for-output } + +但如果你把同一個模型用作輸出,如下所示: + +{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py hl[19] *} + +...由於 `description` 有預設值,就算你沒有為該欄位回傳任何內容,它仍會有那個預設值。 + +### 輸出回應資料的模型 { #model-for-output-response-data } + +在互動式文件中試用並檢視回應時,儘管程式碼沒有為其中一個 `description` 欄位加入任何內容,JSON 回應仍包含預設值(`null`): + +
+ +
+ +這代表該欄位一定會有值,只是有時候值可能是 `None`(在 JSON 中為 `null`)。 + +因此,使用你 API 的用戶端不必檢查值是否存在,可以假設該欄位一定存在;只是有些情況下它的值會是預設的 `None`。 + +在 OpenAPI 中,描述這種情況的方式是將該欄位標記為必填,因為它一定存在。 + +因此,同一個模型的 JSON Schema 會依用於輸入或輸出而不同: + +- 用於輸入時,`description` 不是必填 +- 用於輸出時,`description` 是必填(且可能為 `None`,在 JSON 中為 `null`) + +### 文件中的輸出模型 { #model-for-output-in-docs } + +你也可以在文件中檢視輸出模型,`name` 與 `description` 都以紅色星號標示為必填: + +
+ +
+ +### 文件中的輸入與輸出模型 { #model-for-input-and-output-in-docs } + +如果你查看 OpenAPI 中所有可用的結構描述(JSON Schema),會看到有兩個:`Item-Input` 與 `Item-Output`。 + +對於 `Item-Input`,`description` 不是必填,沒有紅色星號。 + +但對於 `Item-Output`,`description` 是必填,有紅色星號。 + +
+ +
+ +有了 Pydantic v2 的這個特性,你的 API 文件會更精確;若你有自動產生的用戶端與 SDK,它們也會更精確,提供更好的開發者體驗與一致性。🎉 + +## 不要分開結構描述 { #do-not-separate-schemas } + +不過,在某些情況下,你可能會希望輸入與輸出使用相同的結構描述。 + +最常見的情境是:你已經有一些自動產生的用戶端程式碼/SDK,目前還不想全部更新;也許之後會做,但不是現在。 + +在這種情況下,你可以在 FastAPI 中透過參數 `separate_input_output_schemas=False` 停用這個功能。 + +/// info + +自 FastAPI `0.102.0` 起新增 `separate_input_output_schemas` 的支援。🤓 + +/// + +{* ../../docs_src/separate_openapi_schemas/tutorial002_py310.py hl[10] *} + +### 文件中輸入與輸出使用相同結構描述的模型 { #same-schema-for-input-and-output-models-in-docs } + +此時輸入與輸出將共用同一個模型結構描述,只有 `Item`,其中 `description` 不是必填: + +
+ +
diff --git a/docs/zh-hant/docs/how-to/testing-database.md b/docs/zh-hant/docs/how-to/testing-database.md new file mode 100644 index 0000000000..cbaecc2389 --- /dev/null +++ b/docs/zh-hant/docs/how-to/testing-database.md @@ -0,0 +1,7 @@ +# 測試資料庫 { #testing-a-database } + +你可以在 SQLModel 文件 中學習關於資料庫、SQL 與 SQLModel。 🤓 + +有一個迷你 將 SQLModel 與 FastAPI 搭配使用的教學。 ✨ + +該教學包含一節介紹 測試 SQL 資料庫。 😎 diff --git a/docs/zh-hant/docs/index.md b/docs/zh-hant/docs/index.md index a31647f3cd..77eba9b149 100644 --- a/docs/zh-hant/docs/index.md +++ b/docs/zh-hant/docs/index.md @@ -40,7 +40,7 @@ FastAPI 是一個現代、快速(高效能)的 Web 框架,用於以 Python * **快速**:非常高的效能,可與 **NodeJS** 和 **Go** 相當(歸功於 Starlette 和 Pydantic)。[最快的 Python 框架之一](#performance)。 * **極速開發**:開發功能的速度可提升約 200% 至 300%。* * **更少的 Bug**:減少約 40% 的人為(開發者)錯誤。* -* **直覺**:具有出色的編輯器支援,處處都有 自動補全。更少的偵錯時間。 +* **直覺**:具有出色的編輯器支援,處處都有 自動補全。更少的偵錯時間。 * **簡單**:設計上易於使用與學習。更少的讀文件時間。 * **簡潔**:最小化程式碼重複性。每個參數宣告可帶來多個功能。更少的錯誤。 * **穩健**:立即獲得可投入生產的程式碼,並自動生成互動式文件。 @@ -368,7 +368,7 @@ item: Item * 資料驗證: * 當資料無效時,自動且清楚的錯誤。 * 即使是深度巢狀的 JSON 物件也能驗證。 -* 輸入資料的 轉換:從網路讀入到 Python 資料與型別。包含: +* 輸入資料的 轉換:從網路讀入到 Python 資料與型別。包含: * JSON。 * 路徑參數。 * 查詢參數。 @@ -376,7 +376,7 @@ item: Item * 標頭。 * 表單。 * 檔案。 -* 輸出資料的 轉換:從 Python 資料與型別轉換為網路資料(JSON): +* 輸出資料的 轉換:從 Python 資料與型別轉換為網路資料(JSON): * 轉換 Python 型別(`str`、`int`、`float`、`bool`、`list` 等)。 * `datetime` 物件。 * `UUID` 物件。 @@ -439,7 +439,7 @@ item: Item * 來自不同來源的**參數**宣告:例如 **headers**、**cookies**、**form fields** 和 **files**。 * 如何設定**驗證限制**,如 `maximum_length` 或 `regex`。 -* 一個非常強大且易用的 **依賴注入** 系統。 +* 一個非常強大且易用的 **依賴注入** 系統。 * 安全與驗證,包含支援 **OAuth2** 搭配 **JWT tokens** 與 **HTTP Basic** 驗證。 * 宣告**深度巢狀 JSON 模型**的進階(但同樣簡單)技巧(感謝 Pydantic)。 * 與 Strawberry 及其他函式庫的 **GraphQL** 整合。 @@ -524,7 +524,7 @@ Starlette 會使用: * httpx - 若要使用 `TestClient` 必須安裝。 * jinja2 - 若要使用預設的模板設定必須安裝。 -* python-multipart - 若要支援表單 "解析",搭配 `request.form()`。 +* python-multipart - 若要支援表單 "解析",搭配 `request.form()`。 FastAPI 會使用: diff --git a/docs/zh-hant/docs/project-generation.md b/docs/zh-hant/docs/project-generation.md new file mode 100644 index 0000000000..7fa92ce558 --- /dev/null +++ b/docs/zh-hant/docs/project-generation.md @@ -0,0 +1,28 @@ +# 全端 FastAPI 範本 { #full-stack-fastapi-template } + +範本通常附帶特定的設定,但設計上具有彈性且可自訂。這讓你可以依專案需求調整與擴充,因此非常適合作為起點。🏁 + +你可以使用此範本快速起步,裡面已替你完成大量初始設定、安全性、資料庫,以及部分 API 端點。 + +GitHub 儲存庫:全端 FastAPI 範本 + +## 全端 FastAPI 範本 - 技術堆疊與功能 { #full-stack-fastapi-template-technology-stack-and-features } + +- ⚡ [**FastAPI**](https://fastapi.tiangolo.com/zh-hant) 作為 Python 後端 API。 + - 🧰 [SQLModel](https://sqlmodel.tiangolo.com) 作為 Python 與 SQL 資料庫互動(ORM)。 + - 🔍 [Pydantic](https://docs.pydantic.dev)(由 FastAPI 使用)用於資料驗證與設定管理。 + - 💾 [PostgreSQL](https://www.postgresql.org) 作為 SQL 資料庫。 +- 🚀 [React](https://react.dev) 作為前端。 + - 💃 使用 TypeScript、hooks、Vite,以及現代前端技術堆疊的其他組件。 + - 🎨 [Tailwind CSS](https://tailwindcss.com) 與 [shadcn/ui](https://ui.shadcn.com) 作為前端元件。 + - 🤖 自動產生的前端用戶端。 + - 🧪 [Playwright](https://playwright.dev) 用於端到端測試。 + - 🦇 支援深色模式。 +- 🐋 [Docker Compose](https://www.docker.com) 用於開發與正式環境。 +- 🔒 預設即採用安全的密碼雜湊。 +- 🔑 JWT(JSON Web Token)驗證。 +- 📫 以 Email 為基礎的密碼重設。 +- ✅ 使用 [Pytest](https://pytest.org) 的測試。 +- 📞 [Traefik](https://traefik.io) 作為反向代理/負載平衡器。 +- 🚢 使用 Docker Compose 的部署指引,包含如何設定前端 Traefik 代理以自動處理 HTTPS 憑證。 +- 🏭 基於 GitHub Actions 的 CI(持續整合)與 CD(持續部署)。 diff --git a/docs/zh-hant/docs/python-types.md b/docs/zh-hant/docs/python-types.md new file mode 100644 index 0000000000..4f498ab734 --- /dev/null +++ b/docs/zh-hant/docs/python-types.md @@ -0,0 +1,348 @@ +# Python 型別入門 { #python-types-intro } + +Python 支援可選用的「型別提示」(也稱為「型別註記」)。 + +這些「型別提示」或註記是一種特殊語法,用來宣告變數的型別。 + +為你的變數宣告型別後,編輯器與工具就能提供更好的支援。 + +這裡只是關於 Python 型別提示的快速教學/複習。它只涵蓋使用在 **FastAPI** 時所需的最低限度...其實非常少。 + +**FastAPI** 完全是以這些型別提示為基礎,並因此帶來許多優勢與好處。 + +但就算你從不使用 **FastAPI**,學一點型別提示也會有幫助。 + +/// note | 注意 + +如果你是 Python 專家,而且已經完全了解型別提示,可以直接跳到下一章。 + +/// + +## 動機 { #motivation } + +先從一個簡單的例子開始: + +{* ../../docs_src/python_types/tutorial001_py310.py *} + +執行這個程式會輸出: + +``` +John Doe +``` + +這個函式會做以下事情: + +* 接收 `first_name` 與 `last_name`。 +* 用 `title()` 把每個字的第一個字母轉成大寫。 +* 用一個空白把它們串接起來。 + +{* ../../docs_src/python_types/tutorial001_py310.py hl[2] *} + +### 編輯它 { #edit-it } + +這是一個非常簡單的程式。 + +但現在想像你正從零開始寫它。 + +在某個時間點你會開始定義函式,參數都準備好了... + +接著你需要呼叫「那個把第一個字母轉大寫的方法」。 + +是 `upper`?還是 `uppercase`?`first_uppercase`?`capitalize`? + +然後你試著用老牌程式設計師的好朋友——編輯器自動完成。 + +你輸入函式的第一個參數 `first_name`,接著打一個點(`.`),然後按下 `Ctrl+Space` 觸發自動完成。 + +但很遺憾,你什麼有用的也沒得到: + + + +### 加上型別 { #add-types } + +我們來修改前一版中的一行。 + +我們只要把函式參數這一段,從: + +```Python + first_name, last_name +``` + +改成: + +```Python + first_name: str, last_name: str +``` + +就這樣。 + +那些就是「型別提示」: + +{* ../../docs_src/python_types/tutorial002_py310.py hl[1] *} + +這和宣告預設值不同,例如: + +```Python + first_name="john", last_name="doe" +``` + +這是不同的東西。 + +我們使用的是冒號(`:`),不是等號(`=`)。 + +而且加上型別提示通常不會改變執行結果,和不加時是一樣的。 + +不過現在,想像你又在撰寫那個函式,但這次有型別提示。 + +在同樣的地方,你按 `Ctrl+Space` 嘗試自動完成,然後你會看到: + + + +有了這些,你可以往下捲動查看選項,直到找到一個「看起來眼熟」的: + + + +## 更多動機 { #more-motivation } + +看這個函式,它已經有型別提示了: + +{* ../../docs_src/python_types/tutorial003_py310.py hl[1] *} + +因為編輯器知道變數的型別,你不只會得到自動完成,還會得到錯誤檢查: + + + +現在你知道要修正它,把 `age` 用 `str(age)` 轉成字串: + +{* ../../docs_src/python_types/tutorial004_py310.py hl[2] *} + +## 宣告型別 { #declaring-types } + +你剛剛看到宣告型別提示的主要位置:函式參數。 + +這也是你在 **FastAPI** 中最常使用它們的地方。 + +### 簡單型別 { #simple-types } + +你可以宣告所有標準的 Python 型別,不只 `str`。 + +例如你可以用: + +* `int` +* `float` +* `bool` +* `bytes` + +{* ../../docs_src/python_types/tutorial005_py310.py hl[1] *} + +### `typing` 模組 { #typing-module } + +在一些其他情境中,你可能需要從標準程式庫的 `typing` 模組匯入一些東西,比如當你想宣告某個東西可以是「任何型別」時,可以用 `typing` 裡的 `Any`: + +```python +from typing import Any + + +def some_function(data: Any): + print(data) +``` + +### 泛型(Generic types) { #generic-types } + +有些型別可以在方括號中接收「型別參數」,以定義其內部元素的型別,例如「字串的 list」可以宣告為 `list[str]`。 + +這些能接收型別參數的型別稱為「泛型(Generic types)」或「Generics」。 + +你可以將相同的內建型別用作泛型(使用方括號並在裡面放型別): + +* `list` +* `tuple` +* `set` +* `dict` + +#### List { #list } + +例如,讓我們定義一個變數是 `str` 的 `list`。 + +宣告變數,使用相同的冒號(`:`)語法。 + +型別填 `list`。 + +由於 list 是一種包含內部型別的型別,你要把內部型別放在方括號中: + +{* ../../docs_src/python_types/tutorial006_py310.py hl[1] *} + +/// info | 資訊 + +方括號裡的那些內部型別稱為「型別參數」。 + +在這個例子中,`str` 是傳給 `list` 的型別參數。 + +/// + +這表示:「變數 `items` 是一個 `list`,而這個清單中的每個元素都是 `str`」。 + +這麼做之後,你的編輯器甚至在處理清單裡的項目時也能提供支援: + + + +沒有型別時,幾乎不可能做到這點。 + +請注意,變數 `item` 是清單 `items` 中的一個元素。 + +即便如此,編輯器仍然知道它是 `str`,並提供相應的支援。 + +#### Tuple 與 Set { #tuple-and-set } + +你也可以用相同方式來宣告 `tuple` 與 `set`: + +{* ../../docs_src/python_types/tutorial007_py310.py hl[1] *} + +這代表: + +* 變數 `items_t` 是一個有 3 個項目的 `tuple`,分別是 `int`、`int` 和 `str`。 +* 變數 `items_s` 是一個 `set`,而其中每個項目都是 `bytes` 型別。 + +#### Dict { #dict } + +定義 `dict` 時,你需要傳入 2 個以逗號分隔的型別參數。 + +第一個型別參數是 `dict` 的鍵(key)。 + +第二個型別參數是 `dict` 的值(value): + +{* ../../docs_src/python_types/tutorial008_py310.py hl[1] *} + +這代表: + +* 變數 `prices` 是個 `dict`: + * 這個 `dict` 的鍵是 `str`(例如每個項目的名稱)。 + * 這個 `dict` 的值是 `float`(例如每個項目的價格)。 + +#### Union { #union } + +你可以宣告一個變數可以是「多種型別」中的任一種,例如 `int` 或 `str`。 + +要這麼定義,你使用豎線(`|`)來分隔兩種型別。 + +這稱為「union」,因為變數可以是這兩種型別集合的聯集中的任一種。 + +```Python hl_lines="1" +{!> ../../docs_src/python_types/tutorial008b_py310.py!} +``` + +這表示 `item` 可以是 `int` 或 `str`。 + +#### 可能為 `None` { #possibly-none } + +你可以宣告某個值可以是某個型別(例如 `str`),但它也可能是 `None`。 + +//// tab | Python 3.10+ + +```Python hl_lines="1" +{!> ../../docs_src/python_types/tutorial009_py310.py!} +``` + +//// + +使用 `str | None` 而不是單純的 `str`,可以讓編輯器幫你偵測錯誤,例如你以為某個值一定是 `str`,但它其實也可能是 `None`。 + +### 類別作為型別 { #classes-as-types } + +你也可以用類別來宣告變數的型別。 + +假設你有一個 `Person` 類別,帶有名稱: + +{* ../../docs_src/python_types/tutorial010_py310.py hl[1:3] *} + +接著你可以宣告一個變數為 `Person` 型別: + +{* ../../docs_src/python_types/tutorial010_py310.py hl[6] *} + +然後,你一樣會得到完整的編輯器支援: + + + +請注意,這表示「`one_person` 是類別 `Person` 的『實例(instance)』」。 + +並不是「`one_person` 就是名為 `Person` 的『類別(class)』」。 + +## Pydantic 模型 { #pydantic-models } + +Pydantic 是一個用來做資料驗證的 Python 程式庫。 + +你以帶有屬性的類別來宣告資料的「形狀」。 + +而每個屬性都有其型別。 + +接著你用一些值建立這個類別的實例,它會驗證這些值、在需要時把它們轉換成適當的型別,然後回給你一個包含所有資料的物件。 + +你也會對這個產生的物件得到完整的編輯器支援。 + +以下是來自 Pydantic 官方文件的例子: + +{* ../../docs_src/python_types/tutorial011_py310.py *} + +/// info | 資訊 + +想了解更多 Pydantic,請查看它的文件。 + +/// + +**FastAPI** 完全是以 Pydantic 為基礎。 + +你會在[教學 - 使用者指南](tutorial/index.md){.internal-link target=_blank}中看到更多實際範例。 + +## 含中繼資料的型別提示 { #type-hints-with-metadata-annotations } + +Python 也有一個功能,允許使用 `Annotated` 在這些型別提示中放入額外的中繼資料。 + +你可以從 `typing` 匯入 `Annotated`。 + +{* ../../docs_src/python_types/tutorial013_py310.py hl[1,4] *} + +Python 本身不會對這個 `Annotated` 做任何事。對編輯器與其他工具而言,該型別仍然是 `str`。 + +但你可以利用 `Annotated` 這個空間,來提供 **FastAPI** 額外的中繼資料,告訴它你希望應用程式如何運作。 + +重要的是要記住,傳給 `Annotated` 的「第一個型別參數」才是「真正的型別」。其餘的,都是給其他工具用的中繼資料。 + +目前你只需要知道 `Annotated` 的存在,而且它是標準的 Python。😎 + +之後你會看到它有多「強大」。 + +/// tip | 提示 + +因為這是「標準 Python」,所以你在編輯器、分析與重構程式碼的工具等方面,仍然能獲得「最佳的開發體驗」。✨ + +而且你的程式碼也會與許多其他 Python 工具與程式庫非常相容。🚀 + +/// + +## 在 **FastAPI** 中的型別提示 { #type-hints-in-fastapi } + +**FastAPI** 善用這些型別提示來完成多項工作。 + +在 **FastAPI** 中,你用型別提示來宣告參數,然後你會得到: + +* 編輯器支援 +* 型別檢查 + +...而 **FastAPI** 也會用同樣的宣告來: + +* 定義需求:來自請求的路徑參數、查詢參數、標頭、主體(body)、相依性等 +* 轉換資料:把請求中的資料轉成所需型別 +* 驗證資料:來自每個請求的資料: + * 當資料無效時,自動產生錯誤並回傳給用戶端 +* 使用 OpenAPI 書寫 API 文件: + * 之後會由自動的互動式文件介面所使用 + +這些現在聽起來可能有點抽象。別擔心。你會在[教學 - 使用者指南](tutorial/index.md){.internal-link target=_blank}中看到它們的實際運作。 + +重點是,透過在單一位置使用標準的 Python 型別(而不是新增更多類別、裝飾器等),**FastAPI** 會幫你完成很多工作。 + +/// info | 資訊 + +如果你已經完整讀完整個教學,並回來想多看一些關於型別的內容,一個不錯的資源是 `mypy` 的「小抄」。 + +/// diff --git a/docs/zh-hant/docs/translation-banner.md b/docs/zh-hant/docs/translation-banner.md new file mode 100644 index 0000000000..58b49965a9 --- /dev/null +++ b/docs/zh-hant/docs/translation-banner.md @@ -0,0 +1,11 @@ +/// details | 🌐 AI 與人類共同完成的翻譯 + +此翻譯由人類指導的 AI 完成。🤝 + +可能會有對原意的誤解,或讀起來不自然等問題。🤖 + +你可以透過[協助我們更好地引導 AI LLM](https://fastapi.tiangolo.com/zh-hant/contributing/#translations)來改進此翻譯。 + +[英文版](ENGLISH_VERSION_URL) + +/// diff --git a/docs/zh-hant/docs/tutorial/background-tasks.md b/docs/zh-hant/docs/tutorial/background-tasks.md new file mode 100644 index 0000000000..63e4e5a160 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/background-tasks.md @@ -0,0 +1,84 @@ +# 背景任務 { #background-tasks } + +你可以定義背景任務,讓它們在傳回回應之後執行。 + +這對於那些需要在請求之後發生、但用戶端其實不必在收到回應前等它完成的操作很有用。 + +例如: + +* 在執行某個動作後發送電子郵件通知: + * 由於連線到郵件伺服器並寄送郵件通常較「慢」(數秒),你可以先立即回應,並在背景中發送郵件通知。 +* 處理資料: + * 例如,收到一個需要經過較慢處理流程的檔案時,你可以先回應「Accepted」(HTTP 202),再在背景處理該檔案。 + +## 使用 `BackgroundTasks` { #using-backgroundtasks } + +首先,匯入 `BackgroundTasks`,並在你的路徑操作函式中定義一個型別為 `BackgroundTasks` 的參數: + +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[1,13] *} + +**FastAPI** 會為你建立 `BackgroundTasks` 物件,並以該參數傳入。 + +## 建立任務函式 { #create-a-task-function } + +建立一個作為背景任務執行的函式。 + +它只是個可接收參數的一般函式。 + +它可以是 `async def`,也可以是一般的 `def`,**FastAPI** 都能正確處理。 + +在此例中,任務函式會寫入檔案(模擬寄送電子郵件)。 + +由於寫入操作未使用 `async` 與 `await`,因此以一般的 `def` 定義該函式: + +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[6:9] *} + +## 新增背景任務 { #add-the-background-task } + +在路徑操作函式內,使用 `.add_task()` 將任務函式加入背景任務物件: + +{* ../../docs_src/background_tasks/tutorial001_py310.py hl[14] *} + +`.add_task()` 的引數包括: + +* 要在背景執行的任務函式(`write_notification`)。 +* 依序傳給任務函式的位置引數(`email`)。 +* 要傳給任務函式的關鍵字引數(`message="some notification"`)。 + +## 相依性注入 { #dependency-injection } + +在相依性注入系統中也可使用 `BackgroundTasks`。你可以在多個層級宣告 `BackgroundTasks` 型別的參數:路徑操作函式、相依項(dependable)、次級相依項等。 + +**FastAPI** 會在各種情況下正確處理並重用同一個物件,將所有背景任務合併,並在之後於背景執行: + +{* ../../docs_src/background_tasks/tutorial002_an_py310.py hl[13,15,22,25] *} + +在此範例中,訊息會在回應送出之後寫入 `log.txt` 檔案。 + +如果請求中有查詢參數,會以背景任務寫入日誌。 + +接著,在路徑操作函式中建立的另一個背景任務會使用 `email` 路徑參數寫入訊息。 + +## 技術細節 { #technical-details } + +類別 `BackgroundTasks` 直接來自 `starlette.background`。 + +它被直接匯入/包含到 FastAPI 中,因此你可以從 `fastapi` 匯入它,並避免不小心從 `starlette.background` 匯入另一個同名的 `BackgroundTask`(結尾沒有 s)。 + +只使用 `BackgroundTasks`(而非 `BackgroundTask`)時,你就能把它當作路徑操作函式的參數,並讓 **FastAPI** 幫你處理其餘部分,就像直接使用 `Request` 物件一樣。 + +在 FastAPI 中仍可單獨使用 `BackgroundTask`,但你需要在程式碼中自行建立該物件,並回傳包含它的 Starlette `Response`。 + +更多細節請參閱 Starlette 官方的 Background Tasks 文件。 + +## 注意事項 { #caveat } + +如果你需要執行繁重的背景計算,且不一定要由同一個行程執行(例如不需要共用記憶體、變數等),可以考慮使用更大型的工具,例如 Celery。 + +這類工具通常需要較複雜的設定,以及訊息/工作佇列管理器(如 RabbitMQ 或 Redis),但它們允許你在多個行程,甚至多台伺服器上執行背景任務。 + +但如果你需要存取同一個 **FastAPI** 應用中的變數與物件,或只需執行小型的背景任務(例如寄送郵件通知),僅使用 `BackgroundTasks` 即可。 + +## 重點回顧 { #recap } + +在路徑操作函式與相依項中匯入並使用 `BackgroundTasks` 參數,以新增背景任務。 diff --git a/docs/zh-hant/docs/tutorial/bigger-applications.md b/docs/zh-hant/docs/tutorial/bigger-applications.md new file mode 100644 index 0000000000..d8b8c9bff8 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/bigger-applications.md @@ -0,0 +1,504 @@ +# 更大型的應用程式 - 多個檔案 { #bigger-applications-multiple-files } + +如果你正在建置一個應用程式或 Web API,很少會把所有東西都放在單一檔案裡。 + +FastAPI 提供了一個方便的工具,讓你在維持彈性的同時,幫你組織應用程式的結構。 + +/// info | 資訊 + +如果你來自 Flask,這相當於 Flask 的 Blueprints。 + +/// + +## 範例檔案結構 { #an-example-file-structure } + +假設你有如下的檔案結構: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +│   ├── dependencies.py +│   └── routers +│   │ ├── __init__.py +│   │ ├── items.py +│   │ └── users.py +│   └── internal +│   ├── __init__.py +│   └── admin.py +``` + +/// tip | 提示 + +有好幾個 `__init__.py` 檔案:每個目錄或子目錄各一個。 + +這讓我們可以把一個檔案中的程式碼匯入到另一個檔案。 + +例如,在 `app/main.py` 你可以有一行: + +``` +from app.routers import items +``` + +/// + +* `app` 目錄包含所有內容。它有一個空的 `app/__init__.py` 檔案,所以它是一個「Python 套件」(「Python 模組」的集合):`app`。 +* 它包含一個 `app/main.py` 檔案。因為它在一個 Python 套件中(有 `__init__.py` 檔案的目錄),它是該套件的一個「模組」:`app.main`。 +* 還有一個 `app/dependencies.py` 檔案,就像 `app/main.py` 一樣,它是一個「模組」:`app.dependencies`。 +* 有一個子目錄 `app/routers/`,裡面有另一個 `__init__.py` 檔案,所以它是一個「Python 子套件」:`app.routers`。 +* 檔案 `app/routers/items.py` 在一個套件 `app/routers/` 內,因此它是一個子模組:`app.routers.items`。 +* 同樣地,`app/routers/users.py` 是另一個子模組:`app.routers.users`。 +* 還有一個子目錄 `app/internal/`,裡面有另一個 `__init__.py` 檔案,所以它又是一個「Python 子套件」:`app.internal`。 +* 檔案 `app/internal/admin.py` 是另一個子模組:`app.internal.admin`。 + + + +同樣的檔案結構,附上註解: + +```bash +. +├── app # 「app」是一個 Python 套件 +│   ├── __init__.py # 這個檔案讓「app」成為「Python 套件」 +│   ├── main.py # 「main」模組,例如 import app.main +│   ├── dependencies.py # 「dependencies」模組,例如 import app.dependencies +│   └── routers # 「routers」是一個「Python 子套件」 +│   │ ├── __init__.py # 讓「routers」成為「Python 子套件」 +│   │ ├── items.py # 「items」子模組,例如 import app.routers.items +│   │ └── users.py # 「users」子模組,例如 import app.routers.users +│   └── internal # 「internal」是一個「Python 子套件」 +│   ├── __init__.py # 讓「internal」成為「Python 子套件」 +│   └── admin.py # 「admin」子模組,例如 import app.internal.admin +``` + +## `APIRouter` { #apirouter } + +假設專門處理使用者的檔案是位於 `/app/routers/users.py` 的子模組。 + +你希望把與使用者相關的「路徑操作 (path operation)」從其他程式碼分離,讓結構更有條理。 + +但它仍然是同一個 FastAPI 應用程式 / Web API 的一部分(屬於同一個「Python 套件」)。 + +你可以使用 `APIRouter` 為該模組建立路徑操作。 + +### 匯入 `APIRouter` { #import-apirouter } + +你可以像對 `FastAPI` 類別那樣匯入並建立一個「實例」: + +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *} + +### 使用 `APIRouter` 宣告路徑操作 { #path-operations-with-apirouter } + +然後用它來宣告你的路徑操作。 + +用法就和 `FastAPI` 類別一樣: + +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[6,11,16] title["app/routers/users.py"] *} + +你可以把 `APIRouter` 想成是「迷你版的 `FastAPI`」類別。 + +所有相同的選項都支援。 + +同樣的 `parameters`、`responses`、`dependencies`、`tags` 等全都可用。 + +/// tip | 提示 + +在這個範例中,變數名叫 `router`,但你可以用任何你想用的名稱。 + +/// + +我們稍後會把這個 `APIRouter` 加進主要的 `FastAPI` 應用程式中,但先來看看相依性與另一個 `APIRouter`。 + +## 相依性 { #dependencies } + +我們發現應用程式的多個地方會用到一些相依性。 + +所以把它們放進獨立的 `dependencies` 模組(`app/dependencies.py`)。 + +接下來我們會用一個簡單的相依性來讀取自訂的 `X-Token` 標頭: + +{* ../../docs_src/bigger_applications/app_an_py310/dependencies.py hl[3,6:8] title["app/dependencies.py"] *} + +/// tip | 提示 + +為了簡化範例,我們使用了一個虛構的標頭。 + +但在真實情況下,使用內建的[安全工具](security/index.md){.internal-link target=_blank}會有更好的效果。 + +/// + +## 另一個帶有 `APIRouter` 的模組 { #another-module-with-apirouter } + +假設你還有一個模組 `app/routers/items.py`,專門處理應用程式中的「items」。 + +你有以下路徑操作: + +* `/items/` +* `/items/{item_id}` + +其結構與 `app/routers/users.py` 相同。 + +但我們想要更聰明地簡化一些程式碼。 + +我們知道這個模組中的所有路徑操作都有相同的: + +* 路徑 `prefix`:`/items` +* `tags`:(只有一個標籤:`items`) +* 額外的 `responses` +* `dependencies`:它們都需要我們先前建立的 `X-Token` 相依性 + +因此,我們可以不必把這些都加在每個路徑操作上,而是把它們加在 `APIRouter` 上。 + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[5:10,16,21] title["app/routers/items.py"] *} + +由於每個路徑操作的路徑都必須以 `/` 開頭,例如: + +```Python hl_lines="1" +@router.get("/{item_id}") +async def read_item(item_id: str): + ... +``` + +...所以 prefix 末尾不能帶有 `/`。 + +因此,此處的 prefix 是 `/items`。 + +我們也可以加上一個 `tags` 清單,以及會套用在此 router 內所有路徑操作上的額外 `responses`。 + +我們還可以加上一個 `dependencies` 清單,這些相依性會加入此 router 內所有的路徑操作,並在對它們的每個請求上執行 / 解決。 + +/// tip | 提示 + +請注意,就像在[路徑操作裝飾器中的相依性](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}一樣,不會把任何值傳遞給你的路徑操作函式(path operation function)。 + +/// + +最後的結果是這些 item 的路徑如下: + +* `/items/` +* `/items/{item_id}` + +...正如我們預期的。 + +* 它們會被標記為只有一個字串 `"items"` 的標籤清單。 + * 這些「標籤」對自動互動式文件系統(使用 OpenAPI)特別有用。 +* 它們都會包含預先定義的 `responses`。 +* 這些路徑操作都會在執行前評估 / 執行其 `dependencies` 清單。 + * 如果你也在特定的路徑操作中宣告了相依性,這些相依性也會被執行。 + * Router 的相依性會先執行,然後是[裝飾器中的 `dependencies`](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank},最後是一般參數相依性。 + * 你也可以加入帶有 `scopes` 的 [`Security` 相依性](../advanced/security/oauth2-scopes.md){.internal-link target=_blank}。 + +/// tip | 提示 + +在 `APIRouter` 中設定 `dependencies`,例如可以用來對一整組路徑操作要求驗證。即使沒有在每個路徑操作個別加入相依性也沒關係。 + +/// + +/// check | 檢查 + +`prefix`、`tags`、`responses` 與 `dependencies` 參數(就像許多其他情況一樣)只是 FastAPI 提供的功能,幫助你避免重複程式碼。 + +/// + +### 匯入相依性 { #import-the-dependencies } + +這段程式碼在模組 `app.routers.items`(檔案 `app/routers/items.py`)中。 + +我們需要從模組 `app.dependencies`(檔案 `app/dependencies.py`)取得相依性函式。 + +因此我們用 `..` 做相對匯入相依性: + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[3] title["app/routers/items.py"] *} + +#### 相對匯入如何運作 { #how-relative-imports-work } + +/// tip | 提示 + +如果你對匯入的運作方式十分了解,可以直接跳到下一節。 + +/// + +單一的點號 `.`,如下: + +```Python +from .dependencies import get_token_header +``` + +代表: + +* 從此模組(檔案 `app/routers/items.py`)所在的相同套件(目錄 `app/routers/`)開始... +* 找到模組 `dependencies`(想像的檔案 `app/routers/dependencies.py`)... +* 並從中匯入函式 `get_token_header`。 + +但那個檔案不存在,我們的相依性在 `app/dependencies.py`。 + +回想一下我們的應用 / 檔案結構長這樣: + + + +--- + +兩個點號 `..`,如下: + +```Python +from ..dependencies import get_token_header +``` + +代表: + +* 從此模組(檔案 `app/routers/items.py`)所在的相同套件(目錄 `app/routers/`)開始... +* 前往其父套件(目錄 `app/`)... +* 然後在那裡找到模組 `dependencies`(檔案 `app/dependencies.py`)... +* 並從中匯入函式 `get_token_header`。 + +這就正確了!🎉 + +--- + +同樣地,如果我們用三個點號 `...`,如下: + +```Python +from ...dependencies import get_token_header +``` + +就代表: + +* 從此模組(檔案 `app/routers/items.py`)所在的相同套件(目錄 `app/routers/`)開始... +* 前往其父套件(目錄 `app/`)... +* 再前往那個套件的父層(沒有更上層的套件了,`app` 已是最上層 😱)... +* 然後在那裡找到模組 `dependencies`(檔案 `app/dependencies.py`)... +* 並從中匯入函式 `get_token_header`。 + +那會指向 `app/` 之上的某個套件,該套件需有自己的 `__init__.py` 等等。但我們沒有。所以在這個例子中會丟出錯誤。🚨 + +不過現在你知道它的運作方式了,因此無論你的應用有多複雜,你都可以使用相對匯入。🤓 + +### 加上一些自訂的 `tags`、`responses` 與 `dependencies` { #add-some-custom-tags-responses-and-dependencies } + +我們沒有把 `/items` 的 prefix 以及 `tags=["items"]` 加在每個路徑操作上,因為我們已經把它們加在 `APIRouter` 上了。 + +但我們仍可以在特定的路徑操作上再加上更多的 `tags`,以及一些只屬於該路徑操作的額外 `responses`: + +{* ../../docs_src/bigger_applications/app_an_py310/routers/items.py hl[30:31] title["app/routers/items.py"] *} + +/// tip | 提示 + +這最後一個路徑操作會有組合後的標籤:`["items", "custom"]`。 + +而且在文件中同時會有 `404` 與 `403` 兩種回應。 + +/// + +## 主程式 `FastAPI` { #the-main-fastapi } + +現在,來看看 `app/main.py` 這個模組。 + +你會在這裡匯入並使用 `FastAPI` 類別。 + +這會是你的應用程式中把一切串起來的主檔案。 + +而隨著大多數的邏輯都放在各自的模組中,主檔案會相當簡潔。 + +### 匯入 `FastAPI` { #import-fastapi } + +照常匯入並建立 `FastAPI` 類別。 + +我們甚至可以宣告[全域相依性](dependencies/global-dependencies.md){.internal-link target=_blank},它們會與各 `APIRouter` 的相依性合併: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[1,3,7] title["app/main.py"] *} + +### 匯入 `APIRouter` { #import-the-apirouter } + +現在我們匯入包含 `APIRouter` 的其他子模組: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[4:5] title["app/main.py"] *} + +由於 `app/routers/users.py` 與 `app/routers/items.py` 是同一個 Python 套件 `app` 的子模組,我們可以用單一的點號 `.` 來進行「相對匯入」。 + +### 匯入如何運作 { #how-the-importing-works } + +這段: + +```Python +from .routers import items, users +``` + +代表: + +* 從此模組(檔案 `app/main.py`)所在的相同套件(目錄 `app/`)開始... +* 尋找子套件 `routers`(目錄 `app/routers/`)... +* 並從中匯入子模組 `items`(檔案 `app/routers/items.py`)與 `users`(檔案 `app/routers/users.py`)... + +模組 `items` 會有一個變數 `router`(`items.router`)。這就是我們在 `app/routers/items.py` 建立的那個 `APIRouter` 物件。 + +接著我們對 `users` 模組做一樣的事。 + +我們也可以這樣匯入: + +```Python +from app.routers import items, users +``` + +/// info | 資訊 + +第一種是「相對匯入」: + +```Python +from .routers import items, users +``` + +第二種是「絕對匯入」: + +```Python +from app.routers import items, users +``` + +想了解更多關於 Python 套件與模組,請閱讀官方的模組說明文件。 + +/// + +### 避免名稱衝突 { #avoid-name-collisions } + +我們直接匯入子模組 `items`,而不是只匯入它的變數 `router`。 + +這是因為在子模組 `users` 中也有另一個名為 `router` 的變數。 + +如果我們像下面這樣一個接一個匯入: + +```Python +from .routers.items import router +from .routers.users import router +``` + +來自 `users` 的 `router` 會覆蓋掉 `items` 的 `router`,我們就無法同時使用兩者。 + +因此,為了能在同一個檔案中同時使用它們,我們直接匯入子模組: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[5] title["app/main.py"] *} + +### 將 `users` 與 `items` 的 `APIRouter` 納入 { #include-the-apirouters-for-users-and-items } + +現在,把子模組 `users` 與 `items` 的 `router` 納入: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[10:11] title["app/main.py"] *} + +/// info | 資訊 + +`users.router` 是位於 `app/routers/users.py` 檔案內的 `APIRouter`。 + +而 `items.router` 是位於 `app/routers/items.py` 檔案內的 `APIRouter`。 + +/// + +透過 `app.include_router()`,我們可以把每個 `APIRouter` 加到主要的 `FastAPI` 應用程式。 + +它會把該 router 的所有路由都納入成為應用的一部分。 + +/// note | 技術細節 + +實際上,它會在內部為 `APIRouter` 中宣告的每一個「路徑操作」建立一個對應的「路徑操作」。 + +所以在幕後,它實際運作起來就像是一個單一的應用。 + +/// + +/// check | 檢查 + +把 router 納入時不需要擔心效能。 + +這只會在啟動時花費微秒等級,且只發生一次。 + +因此不會影響效能。⚡ + +/// + +### 以自訂的 `prefix`、`tags`、`responses` 與 `dependencies` 納入一個 `APIRouter` { #include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies } + +現在,假設你的組織提供了一個 `app/internal/admin.py` 檔案給你。 + +它包含一個帶有一些管理員路徑操作的 `APIRouter`,並在組織內多個專案之間共用。 + +為了這個範例它會非常簡單。但假設因為它會與組織內的其他專案共用,我們不能直接修改它並把 `prefix`、`dependencies`、`tags` 等加在 `APIRouter` 上: + +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} + +但當我們把這個 `APIRouter` 納入時,仍然希望設定自訂的 `prefix`,讓它所有的路徑操作都以 `/admin` 開頭;我們想用這個專案已經有的 `dependencies` 來保護它,並且要加入 `tags` 與 `responses`。 + +我們可以在不修改原始 `APIRouter` 的情況下,將這些參數傳給 `app.include_router()` 來達成: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[14:17] title["app/main.py"] *} + +如此一來,原始的 `APIRouter` 將保持不變,因此我們仍然可以把同一個 `app/internal/admin.py` 檔案與組織中的其他專案共用。 + +結果是在我們的應用中,來自 `admin` 模組的每個路徑操作都會有: + +* 前綴 `/admin` +* 標籤 `admin` +* 相依性 `get_token_header` +* 回應 `418` 🍵 + +但這只會影響我們應用中的那個 `APIRouter`,不會影響任何其他使用它的程式碼。 + +例如,其他專案可以用不同的驗證方式搭配相同的 `APIRouter`。 + +### 加上一個路徑操作 { #include-a-path-operation } + +我們也可以直接把路徑操作加到 `FastAPI` 應用中。 + +這裡我們就加一下... 只是為了示範可以這麼做 🤷: + +{* ../../docs_src/bigger_applications/app_an_py310/main.py hl[21:23] title["app/main.py"] *} + +而且它會和透過 `app.include_router()` 加入的其他路徑操作正確地一起運作。 + +/// info | 非常技術細節 + +注意:這是個非常技術性的細節,你大概可以直接略過。 + +--- + +`APIRouter` 不是被「掛載 (mount)」的,它們不會與應用的其他部分隔離開來。 + +這是因為我們要把它們的路徑操作包含進 OpenAPI 結構與使用者介面中。 + +由於無法將它們隔離並獨立「掛載」,所以這些路徑操作會被「複製」(重新建立),而不是直接包含進來。 + +/// + +## 檢查自動產生的 API 文件 { #check-the-automatic-api-docs } + +現在,執行你的應用: + +
+ +```console +$ fastapi dev app/main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +然後開啟位於 http://127.0.0.1:8000/docs 的文件。 + +你會看到自動產生的 API 文件,包含來自所有子模組的路徑,使用正確的路徑(與前綴)與正確的標籤: + + + +## 以不同的 `prefix` 多次納入同一個 router { #include-the-same-router-multiple-times-with-different-prefix } + +你也可以用不同的前綴,對同一個 router 多次呼叫 `.include_router()`。 + +例如,這對於在不同前綴下提供相同的 API 很有用,如 `/api/v1` 與 `/api/latest`。 + +這是進階用法,你可能不會需要,但若有需要它就在那裡。 + +## 在另一個 `APIRouter` 中納入一個 `APIRouter` { #include-an-apirouter-in-another } + +就像你可以在 `FastAPI` 應用中納入一個 `APIRouter` 一樣,你也可以在另一個 `APIRouter` 中納入一個 `APIRouter`,用法如下: + +```Python +router.include_router(other_router) +``` + +請確保在把 `router` 納入 `FastAPI` 應用之前先這麼做,這樣 `other_router` 的路徑操作也會被包含進去。 diff --git a/docs/zh-hant/docs/tutorial/body-fields.md b/docs/zh-hant/docs/tutorial/body-fields.md new file mode 100644 index 0000000000..a16e756b7c --- /dev/null +++ b/docs/zh-hant/docs/tutorial/body-fields.md @@ -0,0 +1,61 @@ +# Body - 欄位 { #body-fields } + +就像你可以在「路徑操作函式 (path operation function)」的參數中用 `Query`、`Path` 和 `Body` 宣告額外的驗證與中繼資料一樣,你也可以在 Pydantic 模型中使用 Pydantic 的 `Field` 來宣告驗證與中繼資料。 + +## 匯入 `Field` { #import-field } + +首先,你需要匯入它: + +{* ../../docs_src/body_fields/tutorial001_an_py310.py hl[4] *} + + +/// warning + +請注意,`Field` 是直接從 `pydantic` 匯入的,不像其他(如 `Query`、`Path`、`Body` 等)是從 `fastapi` 匯入。 + +/// + +## 宣告模型屬性 { #declare-model-attributes } + +接著你可以在模型屬性上使用 `Field`: + +{* ../../docs_src/body_fields/tutorial001_an_py310.py hl[11:14] *} + +`Field` 的用法與 `Query`、`Path`、`Body` 相同,擁有相同的參數等。 + +/// note | 技術細節 + +實際上,你接下來會看到的 `Query`、`Path` 等,會建立共同父類別 `Param` 的子類別物件,而 `Param` 本身是 Pydantic 的 `FieldInfo` 類別的子類別。 + +而 Pydantic 的 `Field` 也會回傳一個 `FieldInfo` 的實例。 + +`Body` 也會直接回傳 `FieldInfo` 子類別的物件。稍後你會看到還有其他類別是 `Body` 類別的子類別。 + +記得,當你從 `fastapi` 匯入 `Query`、`Path` 等時,它們其實是回傳特殊類別的函式。 + +/// + +/// tip + +注意,每個帶有型別、預設值與 `Field` 的模型屬性,其結構和「路徑操作函式」的參數相同,只是把 `Path`、`Query`、`Body` 換成了 `Field`。 + +/// + +## 加入額外資訊 { #add-extra-information } + +你可以在 `Field`、`Query`、`Body` 等中宣告額外資訊。這些資訊會被包含在產生的 JSON Schema 中。 + +你會在後續文件中學到更多關於加入額外資訊的內容,特別是在宣告範例時。 + +/// warning + +傳入 `Field` 的額外鍵也會出現在你的應用程式所產生的 OpenAPI schema 中。 +由於這些鍵不一定屬於 OpenAPI 規格的一部分,一些 OpenAPI 工具(例如 [OpenAPI 驗證器](https://validator.swagger.io/))可能無法處理你產生的 schema。 + +/// + +## 回顧 { #recap } + +你可以使用 Pydantic 的 `Field` 為模型屬性宣告額外的驗證與中繼資料。 + +你也可以使用額外的關鍵字引數來傳遞額外的 JSON Schema 中繼資料。 diff --git a/docs/zh-hant/docs/tutorial/body-multiple-params.md b/docs/zh-hant/docs/tutorial/body-multiple-params.md new file mode 100644 index 0000000000..1c334f51f5 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/body-multiple-params.md @@ -0,0 +1,165 @@ +# Body - 多個參數 { #body-multiple-parameters } + +現在我們已經知道如何使用 `Path` 與 `Query`,接下來看看更進階的請求主體(request body)宣告用法。 + +## 混用 `Path`、`Query` 與 Body 參數 { #mix-path-query-and-body-parameters } + +首先,當然你可以自由混用 `Path`、`Query` 與請求 Body 參數的宣告,**FastAPI** 會知道該怎麼做。 + +你也可以將 Body 參數宣告為可選,方法是將預設值設為 `None`: + +{* ../../docs_src/body_multiple_params/tutorial001_an_py310.py hl[18:20] *} + +/// note | 注意 + +請注意,在此情況下,從 body 取得的 `item` 是可選的,因為它的預設值是 `None`。 + +/// + +## 多個 Body 參數 { #multiple-body-parameters } + +在前一個範例中,路徑操作(path operation)會期望一個包含 `Item` 屬性的 JSON 主體,例如: + +```JSON +{ + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2 +} +``` + +但你也可以宣告多個 Body 參數,例如 `item` 與 `user`: + +{* ../../docs_src/body_multiple_params/tutorial002_py310.py hl[20] *} + +在此情況下,**FastAPI** 會注意到函式中有多個 Body 參數(有兩個參數是 Pydantic 模型)。 + +因此,它會使用參數名稱作為 body 中的鍵(欄位名稱),並期望如下的主體: + +```JSON +{ + "item": { + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2 + }, + "user": { + "username": "dave", + "full_name": "Dave Grohl" + } +} +``` + +/// note | 注意 + +儘管 `item` 的宣告方式與先前相同,現在預期它會位於 body 內,且鍵為 `item`。 + +/// + +**FastAPI** 會自動從請求中進行轉換,讓參數 `item` 收到對應內容,`user` 亦同。 + +它會對複合資料進行驗證,並在 OpenAPI 結構與自動文件中如此描述。 + +## Body 中的單一值 { #singular-values-in-body } + +就像你可以用 `Query` 與 `Path` 為查詢與路徑參數定義額外資訊一樣,**FastAPI** 也提供對應的 `Body`。 + +例如,延伸前述模型,你可以決定在相同的 Body 中,除了 `item` 與 `user` 外,還要有另一個鍵 `importance`。 + +如果直接這樣宣告,因為它是單一值,**FastAPI** 會將其視為查詢參數。 + +但你可以使用 `Body` 指示 **FastAPI** 將其視為另一個 Body 鍵: + +{* ../../docs_src/body_multiple_params/tutorial003_an_py310.py hl[23] *} + +在此情況下,**FastAPI** 會期望如下的主體: + +```JSON +{ + "item": { + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2 + }, + "user": { + "username": "dave", + "full_name": "Dave Grohl" + }, + "importance": 5 +} +``` + +同樣地,它會進行型別轉換、驗證、文件化等。 + +## 多個 Body 參數與 Query { #multiple-body-params-and-query } + +當然,你也可以在任何 Body 參數之外,視需要宣告額外的查詢參數。 + +由於預設情況下,單一值會被解讀為查詢參數,你不必明確使用 `Query`,直接這樣寫即可: + +```Python +q: str | None = None +``` + +例如: + +{* ../../docs_src/body_multiple_params/tutorial004_an_py310.py hl[28] *} + +/// info | 注意 + +`Body` 也具有與 `Query`、`Path` 以及之後你會看到的其他工具相同的額外驗證與中繼資料參數。 + +/// + +## 嵌入單一 Body 參數 { #embed-a-single-body-parameter } + +假設你只有一個來自 Pydantic 模型 `Item` 的單一 `item` Body 參數。 + +預設情況下,**FastAPI** 會直接期望該模型的內容作為請求主體。 + +但如果你想讓它像宣告多個 Body 參數時那樣,期望一個帶有 `item` 鍵、其內含模型內容的 JSON,你可以使用 `Body` 的特殊參數 `embed`: + +```Python +item: Item = Body(embed=True) +``` + +如下: + +{* ../../docs_src/body_multiple_params/tutorial005_an_py310.py hl[17] *} + +在此情況下 **FastAPI** 會期望如下的主體: + +```JSON hl_lines="2" +{ + "item": { + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2 + } +} +``` + +而不是: + +```JSON +{ + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2 +} +``` + +## 小結 { #recap } + +即便一個請求只能有單一主體,你仍可在你的路徑操作函式中宣告多個 Body 參數。 + +但 **FastAPI** 會處理好這一切,在你的函式中提供正確的資料,並在路徑操作中驗證與文件化正確的結構。 + +你也可以將單一值宣告為 Body 的一部分來接收。 + +即使只宣告了一個參數,也可以指示 **FastAPI** 將 Body 以某個鍵進行嵌入。 diff --git a/docs/zh-hant/docs/tutorial/body-nested-models.md b/docs/zh-hant/docs/tutorial/body-nested-models.md new file mode 100644 index 0000000000..df4aff6972 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/body-nested-models.md @@ -0,0 +1,220 @@ +# Body - 巢狀模型 { #body-nested-models } + +使用 **FastAPI**,你可以定義、驗證、文件化,並使用任意深度的巢狀模型(感謝 Pydantic)。 + +## 列表欄位 { #list-fields } + +你可以將屬性定義為某個子型別。例如,Python 的 `list`: + +{* ../../docs_src/body_nested_models/tutorial001_py310.py hl[12] *} + +這會讓 `tags` 成為一個列表,儘管尚未宣告列表元素的型別。 + +## 具有型別參數的列表欄位 { #list-fields-with-type-parameter } + +不過,Python 有一種專門的方式來宣告具有內部型別(「型別參數」)的列表: + +### 宣告帶有型別參數的 `list` { #declare-a-list-with-a-type-parameter } + +要宣告具有型別參數(內部型別)的型別,例如 `list`、`dict`、`tuple`,使用方括號 `[` 與 `]` 傳入內部型別作為「型別參數」: + +```Python +my_list: list[str] +``` + +以上都是標準的 Python 型別宣告語法。 + +對於具有內部型別的模型屬性,也使用相同的標準語法。 + +因此,在我們的範例中,可以讓 `tags` 明確成為「字串的列表」: + +{* ../../docs_src/body_nested_models/tutorial002_py310.py hl[12] *} + +## 集合型別 { #set-types } + +但進一步思考後,我們會意識到 `tags` 不應該重覆,應該是唯一的字串。 + +而 Python 有一種用於唯一元素集合的特殊資料型別:`set`。 + +因此我們可以將 `tags` 宣告為字串的 `set`: + +{* ../../docs_src/body_nested_models/tutorial003_py310.py hl[12] *} + +這樣一來,即使收到包含重覆資料的請求,也會被轉換為由唯一元素組成的 `set`。 + +之後只要輸出該資料,即使來源有重覆,也會以唯一元素的 `set` 輸出。 + +並且也會在註解/文件中相應標示。 + +## 巢狀模型 { #nested-models } + +每個 Pydantic 模型的屬性都有型別。 + +而該型別本身也可以是另一個 Pydantic 模型。 + +因此,你可以宣告具有特定屬性名稱、型別與驗證的深度巢狀 JSON「物件」。 + +而且可以任意深度巢狀。 + +### 定義子模型 { #define-a-submodel } + +例如,我們可以定義一個 `Image` 模型: + +{* ../../docs_src/body_nested_models/tutorial004_py310.py hl[7:9] *} + +### 將子模型作為型別使用 { #use-the-submodel-as-a-type } + +然後把它作為某個屬性的型別使用: + +{* ../../docs_src/body_nested_models/tutorial004_py310.py hl[18] *} + +這表示 **FastAPI** 會期望一個類似如下的本文: + +```JSON +{ + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2, + "tags": ["rock", "metal", "bar"], + "image": { + "url": "http://example.com/baz.jpg", + "name": "The Foo live" + } +} +``` + +只需進行上述宣告,使用 **FastAPI** 你就能獲得: + +- 編輯器支援(自動完成等),即使是巢狀模型 +- 資料轉換 +- 資料驗證 +- 自動產生文件 + +## 特殊型別與驗證 { #special-types-and-validation } + +除了 `str`、`int`、`float` 等一般的單一型別外,你也可以使用繼承自 `str` 的更複雜單一型別。 + +若要查看所有可用選項,請參閱 Pydantic 的型別總覽。你會在下一章看到一些範例。 + +例如,在 `Image` 模型中有一個 `url` 欄位,我們可以將其宣告為 Pydantic 的 `HttpUrl`,而不是 `str`: + +{* ../../docs_src/body_nested_models/tutorial005_py310.py hl[2,8] *} + +該字串會被檢查是否為有效的 URL,並在 JSON Schema / OpenAPI 中相應註記。 + +## 具有子模型列表的屬性 { #attributes-with-lists-of-submodels } + +你也可以將 Pydantic 模型作為 `list`、`set` 等的子型別使用: + +{* ../../docs_src/body_nested_models/tutorial006_py310.py hl[18] *} + +這會期望(並進行轉換、驗證、文件化等)如下的 JSON 本文: + +```JSON hl_lines="11" +{ + "name": "Foo", + "description": "The pretender", + "price": 42.0, + "tax": 3.2, + "tags": [ + "rock", + "metal", + "bar" + ], + "images": [ + { + "url": "http://example.com/baz.jpg", + "name": "The Foo live" + }, + { + "url": "http://example.com/dave.jpg", + "name": "The Baz" + } + ] +} +``` + +/// info + +注意 `images` 鍵現在是一個由 image 物件組成的列表。 + +/// + +## 深度巢狀模型 { #deeply-nested-models } + +你可以定義任意深度的巢狀模型: + +{* ../../docs_src/body_nested_models/tutorial007_py310.py hl[7,12,18,21,25] *} + +/// info + +請注意,`Offer` 具有一個 `Item` 的列表,而每個 `Item` 又有一個可選的 `Image` 列表。 + +/// + +## 純列表的本文 { #bodies-of-pure-lists } + +如果你期望的 JSON 本文頂層值是一個 JSON `array`(Python 的 `list`),可以像在 Pydantic 模型中那樣,直接在函式參數上宣告其型別: + +```Python +images: list[Image] +``` + +如下所示: + +{* ../../docs_src/body_nested_models/tutorial008_py310.py hl[13] *} + +## 隨處可得的編輯器支援 { #editor-support-everywhere } + +你將在各處獲得編輯器支援。 + +即使是列表中的項目也一樣: + + + +若直接操作 `dict` 而不是使用 Pydantic 模型,就無法獲得這種等級的編輯器支援。 + +但你也不必擔心,傳入的 dict 會自動被轉換,而你的輸出也會自動轉換為 JSON。 + +## 任意 `dict` 的本文 { #bodies-of-arbitrary-dicts } + +你也可以將本文宣告為一個 `dict`,其鍵為某種型別、值為另一種型別。 + +如此一來,你無需事先知道有效的欄位/屬性名稱為何(不像使用 Pydantic 模型時需要)。 + +這在你想接收尚未預知的鍵時很有用。 + +--- + +另一個實用情境是當你希望鍵是其他型別(例如,`int`)時。 + +這正是我們在此要示範的。 + +在此情況下,只要是擁有 `int` 鍵且對應 `float` 值的 `dict` 都會被接受: + +{* ../../docs_src/body_nested_models/tutorial009_py310.py hl[7] *} + +/// tip + +請記住,JSON 只支援 `str` 作為鍵。 + +但 Pydantic 具有自動資料轉換。 + +這表示即使你的 API 用戶端只能以字串作為鍵,只要這些字串是純整數,Pydantic 會自動轉換並驗證它們。 + +而你作為 `weights` 所接收的 `dict`,實際上會擁有 `int` 鍵與 `float` 值。 + +/// + +## 總結 { #recap } + +使用 **FastAPI**,你在保持程式碼簡潔優雅的同時,亦可擁有 Pydantic 模型所提供的高度彈性。 + +同時還具備以下優點: + +- 編輯器支援(到處都有自動完成!) +- 資料轉換(亦即 parsing/serialization) +- 資料驗證 +- 結構描述(Schema)文件 +- 自動產生文件 diff --git a/docs/zh-hant/docs/tutorial/body-updates.md b/docs/zh-hant/docs/tutorial/body-updates.md new file mode 100644 index 0000000000..a309e3522c --- /dev/null +++ b/docs/zh-hant/docs/tutorial/body-updates.md @@ -0,0 +1,100 @@ +# Body - 更新 { #body-updates } + +## 使用 `PUT` 取代式更新 { #update-replacing-with-put } + +要更新一個項目,你可以使用 HTTP `PUT` 操作。 + +你可以使用 `jsonable_encoder` 將輸入資料轉換為可儲存為 JSON 的資料(例如用於 NoSQL 資料庫)。例如把 `datetime` 轉成 `str`。 + +{* ../../docs_src/body_updates/tutorial001_py310.py hl[28:33] *} + +`PUT` 用於接收應該取代現有資料的資料。 + +### 關於取代的警告 { #warning-about-replacing } + +這表示,如果你想用 `PUT` 並在 body 中包含以下內容來更新項目 `bar`: + +```Python +{ + "name": "Barz", + "price": 3, + "description": None, +} +``` + +由於這裡沒有包含已儲存的屬性 `"tax": 20.2`,輸入的模型會採用預設值 `"tax": 10.5`。 + +最終資料會以這個「新的」 `tax` 值 `10.5` 被儲存。 + +## 使用 `PATCH` 進行部分更新 { #partial-updates-with-patch } + +你也可以使用 HTTP `PATCH` 操作來進行*部分*更新。 + +這表示你只需傳送想要更新的資料,其餘保持不變。 + +/// note | 注意 + +`PATCH` 相較於 `PUT` 較少被使用、也較不為人知。 + +許多團隊甚至在部分更新時也只用 `PUT`。 + +你可以依需求自由選用,**FastAPI** 不會強制規範。 + +但本指南會大致示範它們各自的設計用法。 + +/// + +### 使用 Pydantic 的 `exclude_unset` 參數 { #using-pydantics-exclude-unset-parameter } + +如果要接收部分更新,在 Pydantic 模型的 `.model_dump()` 中使用 `exclude_unset` 參數非常實用。 + +例如 `item.model_dump(exclude_unset=True)`。 + +這會產生一個只包含建立 `item` 模型時實際設定過之欄位的 `dict`,不含預設值。 + +接著你可以用它來生成只包含實際設定(請求中傳來)的資料之 `dict`,省略預設值: + +{* ../../docs_src/body_updates/tutorial002_py310.py hl[32] *} + +### 使用 Pydantic 的 `update` 參數 { #using-pydantics-update-parameter } + +接著,你可以用 `.model_copy()` 建立現有模型的副本,並傳入含有要更新資料之 `dict` 到 `update` 參數。 + +例如 `stored_item_model.model_copy(update=update_data)`: + +{* ../../docs_src/body_updates/tutorial002_py310.py hl[33] *} + +### 部分更新摘要 { #partial-updates-recap } + +總結一下,若要套用部分更新,你可以: + +*(可選)使用 `PATCH` 取代 `PUT`。 +* 取回已儲存的資料。 +* 將該資料放入一個 Pydantic 模型。 +* 從輸入模型產生一個不含預設值的 `dict`(使用 `exclude_unset`)。 + * 如此即可只更新使用者實際設定的值,而不會以模型的預設值覆寫已儲存的值。 +* 建立已儲存模型的副本,並以收到的部分更新值更新其屬性(使用 `update` 參數)。 +* 將該副本模型轉成可儲存到資料庫的型別(例如使用 `jsonable_encoder`)。 + * 這與再次使用模型的 `.model_dump()` 類似,但它會確保(並轉換)所有值為可轉為 JSON 的資料型別,例如把 `datetime` 轉為 `str`。 +* 將資料儲存到資料庫。 +* 回傳更新後的模型。 + +{* ../../docs_src/body_updates/tutorial002_py310.py hl[28:35] *} + +/// tip | 提示 + +其實你也可以在 HTTP `PUT` 操作中使用同一套技巧。 + +但此處示例使用 `PATCH`,因為它正是為這類情境設計的。 + +/// + +/// note | 注意 + +請注意,輸入的模型依然會被驗證。 + +因此,如果你希望接收可以省略所有屬性的部分更新,你需要一個所有屬性皆為可選(具預設值或為 `None`)的模型。 + +為了區分用於更新(全部可選)與用於建立(欄位為必填)的模型,你可以參考 [額外模型](extra-models.md){.internal-link target=_blank} 中的做法。 + +/// diff --git a/docs/zh-hant/docs/tutorial/body.md b/docs/zh-hant/docs/tutorial/body.md new file mode 100644 index 0000000000..bddcbbf434 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/body.md @@ -0,0 +1,164 @@ +# 請求本文 { #request-body } + +當你需要從用戶端(例如瀏覽器)將資料傳送到你的 API 時,會把它作為**請求本文**送出。 + +**請求**本文是用戶端傳給你的 API 的資料。**回應**本文是你的 API 傳回給用戶端的資料。 + +你的 API 幾乎總是需要傳回**回應**本文。但用戶端不一定每次都要送出**請求本文**,有時只會請求某個路徑,可能帶一些查詢參數,但不會傳送本文。 + +要宣告**請求**本文,你會使用 Pydantic 模型,享受其完整的功能與優點。 + +/// info + +要傳送資料,應使用下列其中一種方法:`POST`(最常見)、`PUT`、`DELETE` 或 `PATCH`。 + +在規範中,於 `GET` 請求中攜帶本文的行為是未定義的。不過,FastAPI 仍支援它,但僅適用於非常複雜/極端的情境。 + +由於不建議這麼做,使用 Swagger UI 的互動式文件在使用 `GET` 時不會顯示本文的文件,而且中間的代理伺服器也可能不支援。 + +/// + +## 匯入 Pydantic 的 `BaseModel` { #import-pydantics-basemodel } + +首先,從 `pydantic` 匯入 `BaseModel`: + +{* ../../docs_src/body/tutorial001_py310.py hl[2] *} + +## 建立你的資料模型 { #create-your-data-model } + +接著,你將資料模型宣告為繼承自 `BaseModel` 的類別。 + +對所有屬性使用標準的 Python 型別: + +{* ../../docs_src/body/tutorial001_py310.py hl[5:9] *} + +就和宣告查詢參數時一樣,當模型屬性有預設值時,它就不是必填;否則就是必填。使用 `None` 可使其成為選填。 + +例如,上述模型對應的 JSON「`object`」(或 Python `dict`)如下: + +```JSON +{ + "name": "Foo", + "description": "An optional description", + "price": 45.2, + "tax": 3.5 +} +``` + +...由於 `description` 與 `tax` 是選填(預設為 `None`),以下這個 JSON「`object`」也有效: + +```JSON +{ + "name": "Foo", + "price": 45.2 +} +``` + +## 將它宣告為參數 { #declare-it-as-a-parameter } + +要把它加到你的*路徑操作(path operation)*中,宣告方式與路徑與查詢參數相同: + +{* ../../docs_src/body/tutorial001_py310.py hl[16] *} + +...並將其型別宣告為你建立的模型 `Item`。 + +## 效果 { #results } + +只靠這樣的 Python 型別宣告,**FastAPI** 會: + +- 將請求本文讀取為 JSON。 +- (必要時)轉換為對應的型別。 +- 驗證資料。 + - 若資料無效,會回傳清楚易懂的錯誤,指出哪裡、哪筆資料不正確。 +- 把接收到的資料放在參數 `item` 中提供給你。 + - 由於你在函式中將其宣告為 `Item` 型別,你也會獲得完整的編輯器支援(自動完成等)以及所有屬性與其型別。 +- 為你的模型產生 JSON Schema 定義,如有需要,你也可以在專案中的其他地方使用。 +- 這些 schema 會成為產生的 OpenAPI schema 的一部分,並由自動文件 UIs 使用。 + +## 自動文件 { #automatic-docs } + +你的模型的 JSON Schema 會納入產生的 OpenAPI schema,並顯示在互動式 API 文件中: + + + +也會用於每個需要它們的*路徑操作*內的 API 文件: + + + +## 編輯器支援 { #editor-support } + +在編輯器裡、於你的函式中,你會在各處獲得型別提示與自動完成(如果你接收的是 `dict` 而不是 Pydantic 模型,就不會有這些): + + + +你也會獲得對不正確型別操作的錯誤檢查: + + + +這不是偶然,整個框架就是圍繞這個設計而建。 + +而且在實作之前的設計階段就已徹底測試,確保能在各種編輯器中運作良好。 + +甚至為了支援這點,Pydantic 本身也做了些修改。 + +前面的螢幕截圖是使用 Visual Studio Code 拍的。 + +但你在 PyCharm 與大多數其它 Python 編輯器中也會得到相同的編輯器支援: + + + +/// tip + +如果你使用 PyCharm 作為編輯器,可以安裝 Pydantic PyCharm Plugin。 + +它能增強 Pydantic 模型的編輯器支援,包含: + +- 自動完成 +- 型別檢查 +- 重構 +- 搜尋 +- 程式碼檢查 + +/// + +## 使用該模型 { #use-the-model } + +在函式內,你可以直接存取模型物件的所有屬性: + +{* ../../docs_src/body/tutorial002_py310.py *} + +## 請求本文 + 路徑參數 { #request-body-path-parameters } + +你可以同時宣告路徑參數與請求本文。 + +**FastAPI** 會辨識出與路徑參數相符的函式參數應該從**路徑**取得,而宣告為 Pydantic 模型的函式參數應該從**請求本文**取得。 + +{* ../../docs_src/body/tutorial003_py310.py hl[15:16] *} + +## 請求本文 + 路徑 + 查詢參數 { #request-body-path-query-parameters } + +你也可以同時宣告**本文**、**路徑**與**查詢**參數。 + +**FastAPI** 會分別辨識並從正確的位置取得資料。 + +{* ../../docs_src/body/tutorial004_py310.py hl[16] *} + +函式參數的辨識方式如下: + +- 如果參數同時在**路徑**中宣告,則作為路徑參數。 +- 如果參數是**單一型別**(像是 `int`、`float`、`str`、`bool` 等),會被視為**查詢**參數。 +- 如果參數宣告為 **Pydantic 模型** 型別,會被視為請求**本文**。 + +/// note + +FastAPI 會因為預設值 `= None` 而知道 `q` 的值不是必填。 + +`str | None` 並非 FastAPI 用來判斷是否必填的依據;它會因為有預設值 `= None` 而知道不是必填。 + +但加入這些型別註解能讓你的編輯器提供更好的支援與錯誤偵測。 + +/// + +## 不使用 Pydantic { #without-pydantic } + +若你不想使用 Pydantic 模型,也可以使用 **Body** 參數。請參考[Body - 多個參數:本文中的單一值](body-multiple-params.md#singular-values-in-body){.internal-link target=_blank}。 diff --git a/docs/zh-hant/docs/tutorial/cookie-param-models.md b/docs/zh-hant/docs/tutorial/cookie-param-models.md new file mode 100644 index 0000000000..8997903e38 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/cookie-param-models.md @@ -0,0 +1,76 @@ +# Cookie 參數模型 { #cookie-parameter-models } + +如果你有一組彼此相關的「**Cookie**」,你可以建立一個「**Pydantic 模型**」來宣告它們。🍪 + +這樣你就能在**多處**重複使用該模型,並且能一次性為所有參數宣告**驗證**與**中繼資料**。😎 + +/// note | 注意 + +自 FastAPI 版本 `0.115.0` 起支援。🤓 + +/// + +/// tip + +同樣的技巧也適用於 `Query`、`Cookie` 與 `Header`。😎 + +/// + +## 以 Pydantic 模型宣告 Cookie { #cookies-with-a-pydantic-model } + +在 **Pydantic 模型**中宣告所需的 **Cookie** 參數,接著將參數宣告為 `Cookie`: + +{* ../../docs_src/cookie_param_models/tutorial001_an_py310.py hl[9:12,16] *} + +**FastAPI** 會從請求收到的 **Cookie** 中擷取 **每個欄位** 的資料,並交給你定義的 Pydantic 模型。 + +## 查看文件 { #check-the-docs } + +你可以在 `/docs` 的文件介面中看到已定義的 Cookie: + +
+ +
+ +/// info + +請注意,由於**瀏覽器會以特殊且在背景進行的方式處理 Cookie**,因此**不會**輕易允許 **JavaScript** 存取它們。 + +當你前往位於 `/docs` 的 **API 文件介面**時,可以看到路徑操作的 Cookie 說明。 + +但即使你**填入資料**並點擊「Execute」,因為該文件介面是以 **JavaScript** 運作,Cookie 不會被送出,你會看到**錯誤**訊息,就像完全沒有填任何值一樣。 + +/// + +## 禁止額外的 Cookie { #forbid-extra-cookies } + +在某些特殊情境(可能不太常見)下,你可能會想**限制**允許接收的 Cookie。 + +你的 API 現在也能掌控自己的 Cookie 同意。🤪🍪 + +你可以使用 Pydantic 的模型設定來 `forbid` 任何 `extra` 欄位: + +{* ../../docs_src/cookie_param_models/tutorial002_an_py310.py hl[10] *} + +如果客戶端嘗試送出**額外的 Cookie**,會收到**錯誤**回應。 + +可憐的 Cookie 橫幅辛苦收集你的同意,最後卻是為了讓 API 拒絕它。🍪 + +例如,若客戶端嘗試送出名為 `santa_tracker`、值為 `good-list-please` 的 Cookie,客戶端會收到**錯誤**回應,告知 `santa_tracker` 這個 Cookie 不被允許: + +```json +{ + "detail": [ + { + "type": "extra_forbidden", + "loc": ["cookie", "santa_tracker"], + "msg": "Extra inputs are not permitted", + "input": "good-list-please", + } + ] +} +``` + +## 摘要 { #summary } + +你可以在 **FastAPI** 中使用 **Pydantic 模型**來宣告 **Cookie**。😎 diff --git a/docs/zh-hant/docs/tutorial/cookie-params.md b/docs/zh-hant/docs/tutorial/cookie-params.md new file mode 100644 index 0000000000..cc9d4b6828 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/cookie-params.md @@ -0,0 +1,45 @@ +# Cookie 參數 { #cookie-parameters } + +你可以用與定義 `Query` 與 `Path` 參數相同的方式定義 Cookie 參數。 + +## 匯入 `Cookie` { #import-cookie } + +先匯入 `Cookie`: + +{* ../../docs_src/cookie_params/tutorial001_an_py310.py hl[3] *} + +## 宣告 `Cookie` 參數 { #declare-cookie-parameters } + +然後用與 `Path`、`Query` 相同的結構宣告 `Cookie` 參數。 + +你可以設定預設值,以及所有額外的驗證或註解參數: + +{* ../../docs_src/cookie_params/tutorial001_an_py310.py hl[9] *} + +/// note | 技術細節 + +`Cookie` 是 `Path` 與 `Query` 的「姊妹」類別。它同樣繼承自共同的 `Param` 類別。 + +但請記住,當你從 `fastapi` 匯入 `Query`、`Path`、`Cookie` 等時,它們實際上是回傳特殊類別的函式。 + +/// + +/// info + +要宣告 cookies,你需要使用 `Cookie`,否則參數會被當作查詢參數(query parameters)來解析。 + +/// + +/// info + +請注意,由於瀏覽器以特殊且在背後處理的方式管理 cookies,它們通常不允許 JavaScript 輕易存取它們。 + +如果你前往位於 `/docs` 的 API 文件介面,你可以在你的路徑操作(path operations)的文件中看到 cookies 的說明。 + +但即使你填入資料並點擊「Execute」,由於該文件介面是以 JavaScript 運作,cookies 不會被送出,你會看到一則錯誤訊息,就好像你沒有填任何值一樣。 + +/// + +## 總結 { #recap } + +使用 `Cookie` 來宣告 cookies,遵循與 `Query`、`Path` 相同的通用寫法。 diff --git a/docs/zh-hant/docs/tutorial/cors.md b/docs/zh-hant/docs/tutorial/cors.md new file mode 100644 index 0000000000..5fa497c081 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/cors.md @@ -0,0 +1,88 @@ +# CORS(跨來源資源共用) { #cors-cross-origin-resource-sharing } + +CORS 或「Cross-Origin Resource Sharing」指的是:當在瀏覽器中執行的前端以 JavaScript 與後端通訊,而後端與前端位於不同「來源(origin)」時的情境。 + +## 來源(Origin) { #origin } + +一個來源是由通訊協定(`http`、`https`)、網域(`myapp.com`、`localhost`、`localhost.tiangolo.com`)與連接埠(`80`、`443`、`8080`)三者組合而成。 + +因此,以下皆是不同的來源: + +* `http://localhost` +* `https://localhost` +* `http://localhost:8080` + +即使它們都在 `localhost`,但使用了不同的通訊協定或連接埠,所以它們是不同的「來源」。 + +## 步驟 { #steps } + +假設你的前端在瀏覽器中執行於 `http://localhost:8080`,其 JavaScript 嘗試與執行在 `http://localhost` 的後端通訊(因為未指定連接埠,瀏覽器會假設預設連接埠為 `80`)。 + +接著,瀏覽器會向 `:80` 的後端送出一個 HTTP `OPTIONS` 請求;若後端回傳適當的標頭,授權此不同來源(`http://localhost:8080`)的通訊,則在 `:8080` 的瀏覽器就會允許前端的 JavaScript 向 `:80` 的後端送出它的請求。 + +為了達成這點,`:80` 的後端必須有一份「允許的來源」清單。 + +在此情況下,該清單必須包含 `http://localhost:8080`,` :8080` 的前端才能正確運作。 + +## 萬用字元 { #wildcards } + +也可以將清單宣告為 `"*"`(「wildcard」萬用字元),表示全部都允許。 + +但那只會允許某些類型的通訊,凡是涉及憑證(credentials)的都會被排除:例如 Cookie、Authorization 標頭(像 Bearer Token 會用到的)等。 + +因此,為了讓一切正常運作,最好明確指定被允許的來源。 + +## 使用 `CORSMiddleware` { #use-corsmiddleware } + +你可以在 **FastAPI** 應用程式中使用 `CORSMiddleware` 來設定: + +* 匯入 `CORSMiddleware`。 +* 建立允許的來源清單(字串)。 +* 將它加入到你的 **FastAPI** 應用程式做為「中介軟體(middleware)」。 + +你也可以指定你的後端是否允許: + +* 憑證(credentials,例如 Authorization 標頭、Cookie 等)。 +* 特定的 HTTP 方法(如 `POST`、`PUT`),或使用萬用字元 `"*"` 表示全部。 +* 特定的 HTTP 標頭,或使用萬用字元 `"*"` 表示全部。 + +{* ../../docs_src/cors/tutorial001_py310.py hl[2,6:11,13:19] *} + +`CORSMiddleware` 的實作在預設參數上相當嚴格,因此你需要明確啟用特定的來源、方法或標頭,瀏覽器才會允許在跨網域情境中使用它們。 + +支援以下參數: + +* `allow_origins` - 允許進行跨來源請求的來源清單。例如 `['https://example.org', 'https://www.example.org']`。你可以使用 `['*']` 來允許任何來源。 +* `allow_origin_regex` - 允許進行跨來源請求的來源,使用正規表示式字串比對。例如 `'https://.*\.example\.org'`。 +* `allow_methods` - 允許跨來源請求的 HTTP 方法清單。預設為 `['GET']`。你可以使用 `['*']` 來允許所有標準方法。 +* `allow_headers` - 允許跨來源請求所支援的 HTTP 請求標頭清單。預設為 `[]`。你可以使用 `['*']` 來允許所有標頭。對於簡單 CORS 請求,`Accept`、`Accept-Language`、`Content-Language` 與 `Content-Type` 標頭一律被允許。 +* `allow_credentials` - 指示是否支援跨來源請求的 Cookie。預設為 `False`。 + + 當 `allow_credentials` 設為 `True` 時,`allow_origins`、`allow_methods` 與 `allow_headers` 都不能設為 `['*']`。上述各項必須明確指定。 + +* `expose_headers` - 指示哪些回應標頭應該讓瀏覽器可存取。預設為 `[]`。 +* `max_age` - 設定瀏覽器快取 CORS 回應的最長秒數。預設為 `600`。 + +此中介軟體會回應兩種特定的 HTTP 請求類型... + +### CORS 預檢請求 { #cors-preflight-requests } + +任何帶有 `Origin` 與 `Access-Control-Request-Method` 標頭的 `OPTIONS` 請求。 + +在這種情況下,中介軟體會攔截傳入的請求並回應適當的 CORS 標頭,並回傳 `200` 或 `400`(僅供資訊參考)。 + +### 簡單請求 { #simple-requests } + +任何帶有 `Origin` 標頭的請求。在這種情況下,中介軟體會如常將請求往下傳遞,但會在回應上加入適當的 CORS 標頭。 + +## 更多資訊 { #more-info } + +想進一步了解 CORS,請參考 Mozilla 的 CORS 文件。 + +/// note | 技術細節 + +你也可以使用 `from starlette.middleware.cors import CORSMiddleware`。 + +**FastAPI** 在 `fastapi.middleware` 中提供了幾個中介軟體,做為開發者的便利性。但多數可用的中介軟體其實直接來自 Starlette。 + +/// diff --git a/docs/zh-hant/docs/tutorial/debugging.md b/docs/zh-hant/docs/tutorial/debugging.md new file mode 100644 index 0000000000..cb82ee417b --- /dev/null +++ b/docs/zh-hant/docs/tutorial/debugging.md @@ -0,0 +1,113 @@ +# 偵錯 { #debugging } + +你可以在編輯器中連接偵錯器,例如 Visual Studio Code 或 PyCharm。 + +## 呼叫 `uvicorn` { #call-uvicorn } + +在你的 FastAPI 應用程式中,直接匯入並執行 `uvicorn`: + +{* ../../docs_src/debugging/tutorial001_py310.py hl[1,15] *} + +### 關於 `__name__ == "__main__"` { #about-name-main } + +`__name__ == "__main__"` 的主要目的是,當你的檔案以以下方式呼叫時,執行某些程式碼: + +
+ +```console +$ python myapp.py +``` + +
+ +但當其他檔案匯入它時不會執行,例如: + +```Python +from myapp import app +``` + +#### 更多細節 { #more-details } + +假設你的檔名是 `myapp.py`。 + +如果你用以下方式執行它: + +
+ +```console +$ python myapp.py +``` + +
+ +那麼在你的檔案中,由 Python 自動建立的內部變數 `__name__`,其值會是字串 `"__main__"`。 + +因此,這段: + +```Python + uvicorn.run(app, host="0.0.0.0", port=8000) +``` + +會被執行。 + +--- + +如果你是匯入該模組(檔案),就不會發生這件事。 + +所以,如果你有另一個檔案 `importer.py`,內容如下: + +```Python +from myapp import app + +# Some more code +``` + +在那種情況下,`myapp.py` 中自動建立的變數 `__name__` 就不會是 `"__main__"`。 + +因此,這一行: + +```Python + uvicorn.run(app, host="0.0.0.0", port=8000) +``` + +就不會被執行。 + +/// info | 說明 + +想了解更多,參考 Python 官方文件。 + +/// + +## 用偵錯器執行你的程式碼 { #run-your-code-with-your-debugger } + +因為你是直接從程式碼中執行 Uvicorn 伺服器,所以你可以直接從偵錯器呼叫你的 Python 程式(你的 FastAPI 應用程式)。 + +--- + +例如,在 Visual Studio Code 中,你可以: + +* 前往 "Debug" 面板 +* 點選 "Add configuration..." +* 選擇 "Python" +* 使用選項 "`Python: Current File (Integrated Terminal)`" 啟動偵錯器 + +接著它會用你的 **FastAPI** 程式碼啟動伺服器、在你的中斷點停下等。 + +可能會長這樣: + + + +--- + +如果你使用 PyCharm,你可以: + +* 開啟 "Run" 選單 +* 選擇 "Debug..." +* 會出現一個情境選單 +* 選擇要偵錯的檔案(此例為 `main.py`) + +接著它會用你的 **FastAPI** 程式碼啟動伺服器、在你的中斷點停下等。 + +可能會長這樣: + + diff --git a/docs/zh-hant/docs/tutorial/dependencies/classes-as-dependencies.md b/docs/zh-hant/docs/tutorial/dependencies/classes-as-dependencies.md new file mode 100644 index 0000000000..34b8732109 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/dependencies/classes-as-dependencies.md @@ -0,0 +1,288 @@ +# 以類別作為相依性 { #classes-as-dependencies } + +在更深入了解 **相依性注入(Dependency Injection)** 系統之前,我們先把前一個範例升級一下。 + +## 前一個範例中的 `dict` { #a-dict-from-the-previous-example } + +在前一個範例中,我們從相依項("dependable")回傳了一個 `dict`: + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[9] *} + +但接著我們在路徑操作函式(*path operation function*)的參數 `commons` 中取得的是一個 `dict`。 + +而我們知道,編輯器對 `dict` 無法提供太多輔助(例如自動完成),因為它無法預先知道其中的鍵與值的型別。 + +我們可以做得更好... + +## 什麼算是相依性 { #what-makes-a-dependency } + +到目前為止,你看到的相依性都是宣告成函式。 + +但那不是宣告相依性的唯一方式(雖然那大概是最常見的)。 + +關鍵在於,相依性應該要是「callable」。 + +在 Python 中,「**callable**」指的是任何可以像函式一樣被 Python「呼叫」的東西。 + +因此,如果你有一個物件 `something`(它可能不是函式),而你可以像這樣「呼叫」(執行)它: + +```Python +something() +``` + +或是 + +```Python +something(some_argument, some_keyword_argument="foo") +``` + +那它就是一個「callable」。 + +## 以類別作為相依性 { #classes-as-dependencies_1 } + +你可能已經注意到,建立一個 Python 類別的實例時,你用的語法也是一樣的。 + +例如: + +```Python +class Cat: + def __init__(self, name: str): + self.name = name + + +fluffy = Cat(name="Mr Fluffy") +``` + +在這個例子中,`fluffy` 是 `Cat` 類別的一個實例。 + +而要建立 `fluffy`,你其實是在「呼叫」`Cat`。 + +所以,Python 類別本身也是一種 **callable**。 + +因此,在 **FastAPI** 中,你可以將 Python 類別作為相依性。 + +FastAPI 其實檢查的是它是否為「callable」(函式、類別或其他),以及它所定義的參數。 + +如果你在 **FastAPI** 中傳入一個「callable」作為相依性,FastAPI 會分析該「callable」的參數,並以與路徑操作函式參數相同的方式來處理它們,包括子相依性。 + +這也適用於完全沒有參數的 callable,就和沒有參數的路徑操作函式一樣。 + +接著,我們可以把上面的相依項(dependable)`common_parameters` 改成類別 `CommonQueryParams`: + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[11:15] *} + +注意用來建立該類別實例的 `__init__` 方法: + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[12] *} + +...它的參數與我們之前的 `common_parameters` 相同: + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[8] *} + +**FastAPI** 會用這些參數來「解析」該相依性。 + +兩種情況下都會有: + +- 一個可選的查詢參數 `q`,型別為 `str`。 +- 一個查詢參數 `skip`,型別為 `int`,預設為 `0`。 +- 一個查詢參數 `limit`,型別為 `int`,預設為 `100`。 + +兩種情況下,資料都會被轉換、驗證,並記錄到 OpenAPI schema 中等。 + +## 如何使用 { #use-it } + +現在你可以用這個類別來宣告你的相依性。 + +{* ../../docs_src/dependencies/tutorial002_an_py310.py hl[19] *} + +**FastAPI** 會呼叫 `CommonQueryParams` 類別。這會建立該類別的一個「實例」,而該實例會以參數 `commons` 的形式傳給你的函式。 + +## 型別註解與 `Depends` { #type-annotation-vs-depends } + +注意上面程式碼裡我們寫了兩次 `CommonQueryParams`: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ 非 Annotated + +/// tip + +如有可能,優先使用 `Annotated` 版本。 + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +最後面的 `CommonQueryParams`,在: + +```Python +... Depends(CommonQueryParams) +``` + +...才是 **FastAPI** 實際用來知道相依性是什麼的依據。 + +FastAPI 會從這個物件中提取宣告的參數,並且實際呼叫它。 + +--- + +在這個例子中,前面的 `CommonQueryParams`,於: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, ... +``` + +//// + +//// tab | Python 3.10+ 非 Annotated + +/// tip + +如有可能,優先使用 `Annotated` 版本。 + +/// + +```Python +commons: CommonQueryParams ... +``` + +//// + +...對 **FastAPI** 來說沒有任何特殊意義。FastAPI 不會用它來做資料轉換、驗證等(因為這部分由 `Depends(CommonQueryParams)` 處理)。 + +其實你可以只寫: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[Any, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ 非 Annotated + +/// tip + +如有可能,優先使用 `Annotated` 版本。 + +/// + +```Python +commons = Depends(CommonQueryParams) +``` + +//// + +...像是: + +{* ../../docs_src/dependencies/tutorial003_an_py310.py hl[19] *} + +但仍建議宣告型別,這樣你的編輯器就知道會以何種型別作為參數 `commons` 傳入,進而幫助你做自動完成、型別檢查等: + + + +## 捷徑 { #shortcut } + +不過你會發現這裡有些重複程式碼,我們寫了兩次 `CommonQueryParams`: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ 非 Annotated + +/// tip + +如有可能,優先使用 `Annotated` 版本。 + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +**FastAPI** 為這類情況提供了一個捷徑:當相依性「明確」是一個類別,且 **FastAPI** 會「呼叫」它來建立該類別的實例時。 + +對這些特定情況,你可以這樣做: + +不要寫: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)] +``` + +//// + +//// tab | Python 3.10+ 非 Annotated + +/// tip + +如有可能,優先使用 `Annotated` 版本。 + +/// + +```Python +commons: CommonQueryParams = Depends(CommonQueryParams) +``` + +//// + +...而是改為: + +//// tab | Python 3.10+ + +```Python +commons: Annotated[CommonQueryParams, Depends()] +``` + +//// + +//// tab | Python 3.10+ 非 Annotated + +/// tip + +如有可能,優先使用 `Annotated` 版本。 + +/// + +```Python +commons: CommonQueryParams = Depends() +``` + +//// + +你把相依性宣告為參數的型別,並使用不帶任何參數的 `Depends()`,而不用在 `Depends(CommonQueryParams)` 裡「再」寫一次整個類別。 + +整個範例就會變成: + +{* ../../docs_src/dependencies/tutorial004_an_py310.py hl[19] *} + +...而 **FastAPI** 會知道該怎麼做。 + +/// tip + +如果你覺得這樣比幫助更令人困惑,那就忽略它吧,你並不「需要」這個技巧。 + +這只是個捷徑。因為 **FastAPI** 在意幫你減少重複的程式碼。 + +/// diff --git a/docs/zh-hant/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md b/docs/zh-hant/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md new file mode 100644 index 0000000000..e30c385375 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md @@ -0,0 +1,69 @@ +# 路徑操作裝飾器中的依賴 { #dependencies-in-path-operation-decorators } + +有時在你的路徑操作函式中,其實不需要某個依賴的回傳值。 + +或是該依賴根本沒有回傳值。 + +但你仍需要它被執行/解析。 + +這種情況下,你可以不在路徑操作函式的參數上使用 `Depends`,而是在路徑操作裝飾器加入一個 `dependencies` 的 `list`。 + +## 在路徑操作裝飾器加入 `dependencies` { #add-dependencies-to-the-path-operation-decorator } + +路徑操作裝飾器可接受一個可選參數 `dependencies`。 + +它應該是由 `Depends()` 組成的 `list`: + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[19] *} + +這些依賴會以與一般依賴相同的方式被執行/解析。但它們的值(如果有回傳)不會傳遞給你的路徑操作函式。 + +/// tip + +有些編輯器會檢查未使用的函式參數,並將其標示為錯誤。 + +把這些依賴放在路徑操作裝飾器中,可以確保它們被執行,同時避免編輯器/工具報錯。 + +這也有助於避免讓新加入的開發者看到未使用的參數時,以為它是不必要的而感到困惑。 + +/// + +/// info + +在這個範例中我們使用了自訂的(虛構的)標頭 `X-Key` 與 `X-Token`。 + +但在實際情況下,當你實作安全機制時,使用整合的 [Security utilities(下一章)](../security/index.md){.internal-link target=_blank} 會獲得更多好處。 + +/// + +## 依賴的錯誤與回傳值 { #dependencies-errors-and-return-values } + +你可以使用與平常相同的依賴函式。 + +### 依賴的需求 { #dependency-requirements } + +它們可以宣告請求需求(例如標頭(headers))或其他子依賴: + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[8,13] *} + +### 拋出例外 { #raise-exceptions } + +這些依賴可以 `raise` 例外,與一般依賴相同: + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[10,15] *} + +### 回傳值 { #return-values } + +它們可以回傳值,也可以不回傳;無論如何,回傳值都不會被使用。 + +因此,你可以重複使用在其他地方已使用過的一般依賴(會回傳值),即使回傳值不會被使用,該依賴仍會被執行: + +{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[11,16] *} + +## 一組路徑操作的依賴 { #dependencies-for-a-group-of-path-operations } + +之後在閱讀如何組織較大的應用程式([較大型應用程式——多個檔案](../../tutorial/bigger-applications.md){.internal-link target=_blank})時,你會學到如何為一組路徑操作宣告一個共同的 `dependencies` 參數。 + +## 全域依賴 { #global-dependencies } + +接著我們會看看如何把依賴加到整個 `FastAPI` 應用程式,使其套用到每個路徑操作。 diff --git a/docs/zh-hant/docs/tutorial/dependencies/dependencies-with-yield.md b/docs/zh-hant/docs/tutorial/dependencies/dependencies-with-yield.md new file mode 100644 index 0000000000..2339c6ef30 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/dependencies/dependencies-with-yield.md @@ -0,0 +1,288 @@ +# 使用 yield 的相依 { #dependencies-with-yield } + +FastAPI 支援在完成後執行一些額外步驟的相依。 + +要做到這點,使用 `yield` 取代 `return`,並把額外步驟(程式碼)寫在其後。 + +/// tip + +請確保每個相依內只使用一次 `yield`。 + +/// + +/// note | 技術細節 + +任何可用於下列裝飾器的函式: + +* `@contextlib.contextmanager` 或 +* `@contextlib.asynccontextmanager` + +都可以作為 **FastAPI** 的相依。 + +事實上,FastAPI 內部就是使用這兩個裝飾器。 + +/// + +## 使用 `yield` 的資料庫相依 { #a-database-dependency-with-yield } + +例如,你可以用它建立一個資料庫 session,並在完成後關閉。 + +只有 `yield` 之前(含 `yield` 本身)的程式碼會在產生回應之前執行: + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[2:4] *} + +由 `yield` 產生的值會被注入到路徑操作(path operation)與其他相依中: + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[4] *} + +位於 `yield` 之後的程式碼會在回應之後執行: + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[5:6] *} + +/// tip + +你可以使用 `async` 或一般函式。 + +**FastAPI** 都會正確處理,和一般相依相同。 + +/// + +## 同時使用 `yield` 與 `try` 的相依 { #a-dependency-with-yield-and-try } + +如果在含 `yield` 的相依中使用 `try` 區塊,你會接收到使用該相依時拋出的任何例外。 + +例如,如果在中途的某段程式碼、其他相依,或某個路徑操作中,讓資料庫交易「rollback」或產生了任何例外,你都會在你的相依中接收到該例外。 + +因此,你可以在相依內用 `except SomeException` 來攔截特定例外。 + +同樣地,你可以使用 `finally` 來確保無論是否有例外都會執行結束步驟。 + +{* ../../docs_src/dependencies/tutorial007_py310.py hl[3,5] *} + +## 含 `yield` 的子相依 { #sub-dependencies-with-yield } + +你可以擁有任何大小與形狀的子相依與相依樹,而它們都可以(或不)使用 `yield`。 + +**FastAPI** 會確保每個使用 `yield` 的相依,其「結束程式碼」會以正確的順序執行。 + +例如,`dependency_c` 可以相依於 `dependency_b`,而 `dependency_b` 相依於 `dependency_a`: + +{* ../../docs_src/dependencies/tutorial008_an_py310.py hl[6,14,22] *} + +而且它們都可以使用 `yield`。 + +在這個例子中,`dependency_c` 為了執行它的結束程式碼,需要來自 `dependency_b`(此處命名為 `dep_b`)的值仍然可用。 + +同理,`dependency_b` 為了執行它的結束程式碼,需要來自 `dependency_a`(此處命名為 `dep_a`)的值可用。 + +{* ../../docs_src/dependencies/tutorial008_an_py310.py hl[18:19,26:27] *} + +同樣地,你可以同時擁有使用 `yield` 的相依與使用 `return` 的相依,並讓其中一些相依彼此相依。 + +你也可以有一個相依同時需要多個使用 `yield` 的其他相依,等等。 + +你可以擁有任何你需要的相依組合。 + +**FastAPI** 會確保一切都以正確的順序執行。 + +/// note | 技術細節 + +這能運作,多虧了 Python 的 Context Managers。 + +**FastAPI** 在內部使用它們來達成這點。 + +/// + +## 含 `yield` 與 `HTTPException` 的相依 { #dependencies-with-yield-and-httpexception } + +你已看到可以在含 `yield` 的相依中使用 `try` 區塊,嘗試執行一些程式碼,然後在 `finally` 後執行結束程式碼。 + +你也可以用 `except` 來攔截被拋出的例外並加以處理。 + +例如,你可以拋出不同的例外,如 `HTTPException`。 + +/// tip + +這算是進階技巧;多數情況你並不需要,因為你可以在應用程式其他程式碼中(例如在路徑操作函式(path operation function)中)直接拋出例外(包含 `HTTPException`)。 + +但如果你需要,它就在這裡。🤓 + +/// + +{* ../../docs_src/dependencies/tutorial008b_an_py310.py hl[18:22,31] *} + +如果你想攔截例外並據此回傳自訂回應,請建立一個[自訂例外處理器](../handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank}。 + +## 含 `yield` 與 `except` 的相依 { #dependencies-with-yield-and-except } + +如果你在含 `yield` 的相依中用 `except` 攔截了例外,且沒有再次拋出它(或拋出新的例外),FastAPI 將無法察覺有例外發生,就像在一般的 Python 中一樣: + +{* ../../docs_src/dependencies/tutorial008c_an_py310.py hl[15:16] *} + +在這種情況下,客戶端會如預期地看到一個 *HTTP 500 Internal Server Error* 回應(因為我們沒有拋出 `HTTPException` 或類似的東西),但伺服器將不會有任何日誌或其他錯誤線索。😱 + +### 在含 `yield` 與 `except` 的相依中務必 `raise` { #always-raise-in-dependencies-with-yield-and-except } + +如果你在含 `yield` 的相依中攔截到了例外,除非你要拋出另一個 `HTTPException` 或類似的例外,否則**你應該重新拋出原本的例外**。 + +你可以使用 `raise` 重新拋出同一個例外: + +{* ../../docs_src/dependencies/tutorial008d_an_py310.py hl[17] *} + +現在客戶端仍會獲得同樣的 *HTTP 500 Internal Server Error* 回應,但伺服器的日誌中會有我們自訂的 `InternalError`。😎 + +## 含 `yield` 的相依執行順序 { #execution-of-dependencies-with-yield } + +執行順序大致如下圖。時間從上往下流動,每一欄代表一個互動或執行程式碼的部分。 + +```mermaid +sequenceDiagram + +participant client as Client +participant handler as Exception handler +participant dep as Dep with yield +participant operation as Path Operation +participant tasks as Background tasks + + Note over client,operation: Can raise exceptions, including HTTPException + client ->> dep: Start request + Note over dep: Run code up to yield + opt raise Exception + dep -->> handler: Raise Exception + handler -->> client: HTTP error response + end + dep ->> operation: Run dependency, e.g. DB session + opt raise + operation -->> dep: Raise Exception (e.g. HTTPException) + opt handle + dep -->> dep: Can catch exception, raise a new HTTPException, raise other exception + end + handler -->> client: HTTP error response + end + + operation ->> client: Return response to client + Note over client,operation: Response is already sent, can't change it anymore + opt Tasks + operation -->> tasks: Send background tasks + end + opt Raise other exception + tasks -->> tasks: Handle exceptions in the background task code + end +``` + +/// info + +只會向用戶端送出「一個回應」。可能是其中一個錯誤回應,或是來自該路徑操作的回應。 + +一旦送出了其中一個回應,就不能再送出其他回應。 + +/// + +/// tip + +如果你在路徑操作函式的程式碼中拋出任何例外,它會被傳遞到使用 `yield` 的相依中(包含 `HTTPException`)。大多數情況你會想在該使用 `yield` 的相依中重新拋出相同的例外或一個新的例外,以確保它被正確處理。 + +/// + +## 提早關閉與 `scope` { #early-exit-and-scope } + +通常,含 `yield` 的相依之結束程式碼會在回應送出給用戶端之後才執行。 + +但如果你確定在從路徑操作函式返回後就不會再使用該相依,你可以使用 `Depends(scope="function")`,告訴 FastAPI 應在路徑操作函式返回之後、但在回應送出之前關閉該相依。 + +{* ../../docs_src/dependencies/tutorial008e_an_py310.py hl[12,16] *} + +`Depends()` 接受一個 `scope` 參數,可以是: + +* `"function"`:在處理請求的路徑操作函式之前啟動相依,在路徑操作函式結束之後結束相依,但在回應送回用戶端之前。所以,相依函式會在路徑操作**函式**的「周圍」執行。 +* `"request"`:在處理請求的路徑操作函式之前啟動相依(與使用 `"function"` 類似),但在回應送回用戶端之後才結束相依。所以,相依函式會在整個**請求**與回應循環的「周圍」執行。 + +如果未指定且相依使用了 `yield`,則預設 `scope` 為 `"request"`。 + +### 子相依的 `scope` { #scope-for-sub-dependencies } + +當你宣告一個 `scope="request"`(預設值)的相依時,任何子相依也需要有 `"request"` 的 `scope`。 + +但一個 `scope` 為 `"function"` 的相依,可以擁有 `scope` 為 `"function"` 或 `"request"` 的子相依。 + +這是因為任何相依都需要能在子相依之前執行其結束程式碼,因為它可能在結束程式碼中仍需要使用那些子相依。 + +```mermaid +sequenceDiagram + +participant client as Client +participant dep_req as Dep scope="request" +participant dep_func as Dep scope="function" +participant operation as Path Operation + + client ->> dep_req: Start request + Note over dep_req: Run code up to yield + dep_req ->> dep_func: Pass dependency + Note over dep_func: Run code up to yield + dep_func ->> operation: Run path operation with dependency + operation ->> dep_func: Return from path operation + Note over dep_func: Run code after yield + Note over dep_func: ✅ Dependency closed + dep_func ->> client: Send response to client + Note over client: Response sent + Note over dep_req: Run code after yield + Note over dep_req: ✅ Dependency closed +``` + +## 含 `yield`、`HTTPException`、`except` 與背景任務的相依 { #dependencies-with-yield-httpexception-except-and-background-tasks } + +含 `yield` 的相依隨時間演進,以涵蓋不同的使用情境並修正一些問題。 + +如果你想了解在不同 FastAPI 版本中改了哪些內容,可以在進階指南中閱讀:[進階相依 — 含 `yield`、`HTTPException`、`except` 與背景任務的相依](../../advanced/advanced-dependencies.md#dependencies-with-yield-httpexception-except-and-background-tasks){.internal-link target=_blank}。 +## 情境管理器 { #context-managers } + +### 什麼是「情境管理器」 { #what-are-context-managers } + +「情境管理器」是那些你可以在 `with` 陳述式中使用的 Python 物件。 + +例如,你可以用 `with` 來讀取檔案: + +```Python +with open("./somefile.txt") as f: + contents = f.read() + print(contents) +``` + +在底層,`open("./somefile.txt")` 會建立一個稱為「情境管理器」的物件。 + +當 `with` 區塊結束時,它會確保關閉檔案,即使發生了例外也一樣。 + +當你建立一個含 `yield` 的相依時,**FastAPI** 會在內部為它建立一個情境管理器,並與其他相關工具結合。 + +### 在含 `yield` 的相依中使用情境管理器 { #using-context-managers-in-dependencies-with-yield } + +/// warning + +這大致算是一個「進階」概念。 + +如果你剛開始學習 **FastAPI**,此處可以先跳過。 + +/// + +在 Python 中,你可以透過建立一個擁有 `__enter__()` 與 `__exit__()` 兩個方法的類別來建立情境管理器。 + +你也可以在 **FastAPI** 的含 `yield` 相依中,於相依函式內使用 `with` 或 `async with` 陳述式來使用它們: + +{* ../../docs_src/dependencies/tutorial010_py310.py hl[1:9,13] *} + +/// tip + +建立情境管理器的另一種方式是: + +* `@contextlib.contextmanager` 或 +* `@contextlib.asynccontextmanager` + +用它們裝飾一個只包含單一 `yield` 的函式。 + +這正是 **FastAPI** 在內部為含 `yield` 的相依所使用的方法。 + +但你不需要(而且也不該)在 FastAPI 的相依上使用這些裝飾器。 + +FastAPI 會在內部替你處理好。 + +/// diff --git a/docs/zh-hant/docs/tutorial/dependencies/global-dependencies.md b/docs/zh-hant/docs/tutorial/dependencies/global-dependencies.md new file mode 100644 index 0000000000..3aac1a228b --- /dev/null +++ b/docs/zh-hant/docs/tutorial/dependencies/global-dependencies.md @@ -0,0 +1,15 @@ +# 全域依賴 { #global-dependencies } + +在某些類型的應用程式中,你可能想為整個應用程式新增依賴。 + +類似於你可以在[路徑操作(path operation)的裝飾器中新增 `dependencies`](dependencies-in-path-operation-decorators.md){.internal-link target=_blank} 的方式,你也可以把它們加到 `FastAPI` 應用程式上。 + +在這種情況下,它們會套用到應用程式中的所有路徑操作: + +{* ../../docs_src/dependencies/tutorial012_an_py310.py hl[17] *} + +而且,在[將 `dependencies` 新增到路徑操作裝飾器](dependencies-in-path-operation-decorators.md){.internal-link target=_blank} 那一節中的所有概念依然適用,只是這裡是套用到整個應用中的所有路徑操作。 + +## 路徑操作群組的依賴 { #dependencies-for-groups-of-path-operations } + +之後,在閱讀如何組織更大的應用程式([更大的應用程式 - 多個檔案](../../tutorial/bigger-applications.md){.internal-link target=_blank})時,可能會有多個檔案,你將會學到如何為一組路徑操作宣告單一的 `dependencies` 參數。 diff --git a/docs/zh-hant/docs/tutorial/dependencies/index.md b/docs/zh-hant/docs/tutorial/dependencies/index.md new file mode 100644 index 0000000000..39c05ab056 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/dependencies/index.md @@ -0,0 +1,248 @@ +# 依賴 { #dependencies } + +**FastAPI** 內建一套強大且直覺的 **依賴注入** 系統。 + +它被設計為易於使用,使任何開發者都能輕鬆將其他元件與 **FastAPI** 整合。 + +## 什麼是「依賴注入」 { #what-is-dependency-injection } + +在程式設計中,「依賴注入」的意思是:你的程式碼(此處指你的「路徑操作函式 (path operation functions)」)可以宣告它為了正常運作所需要的各種東西:也就是「依賴」。 + +接著,這個系統(此處是 **FastAPI**)會負責做任何必要的事,將這些所需的依賴提供給你的程式碼(「注入」依賴)。 + +當你需要以下情境時,這特別有用: + +* 共享邏輯(相同的邏輯一次又一次地使用)。 +* 共用資料庫連線。 +* 強制套用安全性、驗證、角色要求等。 +* 以及許多其他事情... + +同時把重複的程式碼降到最低。 + +## 入門 { #first-steps } + +先看一個非常簡單的範例。它現在還不太實用,但夠簡單,讓我們能專注在 **依賴注入** 的運作方式。 + +### 建立一個依賴,或稱「dependable」 { #create-a-dependency-or-dependable } + +先專注在依賴本身。 + +它就是一個函式,可以接受與「路徑操作函式」相同的各種參數: + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[8:9] *} + +就這樣。 + +僅僅兩行。 + +而且它的外觀與結構和你的所有「路徑操作函式」一樣。 + +你可以把它想成一個沒有「裝飾器」(沒有 `@app.get("/some-path")`)的「路徑操作函式」。 + +它可以回傳你想要的任何東西。 + +在這個例子中,這個依賴會期望: + +* 一個選用的查詢參數 `q`,型別為 `str`。 +* 一個選用的查詢參數 `skip`,型別為 `int`,預設為 `0`。 +* 一個選用的查詢參數 `limit`,型別為 `int`,預設為 `100`。 + +然後它只會回傳一個包含這些值的 `dict`。 + +/// info | 說明 + +FastAPI 在 0.95.0 版新增了對 `Annotated` 的支援(並開始建議使用)。 + +如果你使用較舊的版本,嘗試使用 `Annotated` 時會出現錯誤。 + +在使用 `Annotated` 之前,請先[升級 FastAPI 版本](../../deployment/versions.md#upgrading-the-fastapi-versions){.internal-link target=_blank}到至少 0.95.1。 + +/// + +### 匯入 `Depends` { #import-depends } + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[3] *} + +### 在「被依賴者」(dependant)中宣告依賴 { #declare-the-dependency-in-the-dependant } + +和你在「路徑操作函式」參數上使用 `Body`、`Query` 等方式一樣,針對新參數使用 `Depends`: + +{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[13,18] *} + +雖然你在函式參數上使用 `Depends` 的方式和 `Body`、`Query` 等相同,但 `Depends` 的運作方式有點不同。 + +你只需要傳給 `Depends` 一個參數。 + +這個參數必須是類似函式的東西。 + +你不需要直接呼叫它(不要在後面加上括號),只要把它作為參數傳給 `Depends()` 即可。 + +而該函式的參數宣告方式與「路徑操作函式」相同。 + +/// tip | 提示 + +除了函式之外,還有其他「東西」也能當作依賴,會在下一章介紹。 + +/// + +當有新的請求到達時,**FastAPI** 會負責: + +* 以正確的參數呼叫你的依賴(dependable)函式。 +* 取得該函式的回傳結果。 +* 將結果指定給你的「路徑操作函式」中的對應參數。 + +```mermaid +graph TB + +common_parameters(["common_parameters"]) +read_items["/items/"] +read_users["/users/"] + +common_parameters --> read_items +common_parameters --> read_users +``` + +如此一來,你只需撰寫一次共用程式碼,**FastAPI** 會替你的各個「路徑操作」呼叫它。 + +/// check | 檢查 + +注意,你不必建立特殊的類別並把它傳到 **FastAPI** 去「註冊」或做類似的事。 + +只要把它傳給 `Depends`,**FastAPI** 就知道該怎麼處理其餘的部分。 + +/// + +## 共用 `Annotated` 依賴 { #share-annotated-dependencies } + +在上面的範例中,可以看到有一點點的「重複程式碼」。 + +當你要使用 `common_parameters()` 這個依賴時,你得寫出完整的型別註解搭配 `Depends()`: + +```Python +commons: Annotated[dict, Depends(common_parameters)] +``` + +但因為我們在使用 `Annotated`,我們可以把這個 `Annotated` 的值存到一個變數中,並在多個地方重複使用: + +{* ../../docs_src/dependencies/tutorial001_02_an_py310.py hl[12,16,21] *} + +/// tip | 提示 + +這只是標準的 Python,用的是所謂的「型別別名 (type alias)」,其實和 **FastAPI** 本身無關。 + +但因為 **FastAPI** 是建立在 Python 標準之上(包含 `Annotated`),你就可以在程式碼中使用這個技巧。😎 + +/// + +這些依賴依然會如預期運作,而最棒的是「型別資訊會被保留」,代表你的編輯器仍能提供「自動完成」、「即時錯誤」等功能,像 `mypy` 等其他工具也一樣受益。 + +當你在「大型程式碼庫」中,於許多「路徑操作」反覆使用「相同的依賴」時,這會特別有用。 + +## 要不要使用 `async` { #to-async-or-not-to-async } + +因為依賴也會由 **FastAPI** 呼叫(就像你的「路徑操作函式」),所以在定義函式時套用相同的規則。 + +你可以使用 `async def` 或一般的 `def`。 + +而且你可以在一般 `def` 的「路徑操作函式」中宣告 `async def` 的依賴,或在 `async def` 的「路徑操作函式」中宣告 `def` 的依賴,等等。 + +都沒關係。**FastAPI** 會知道該怎麼做。 + +/// note | 注意 + +如果你不熟悉,請參考文件中的 [Async: "In a hurry?"](../../async.md#in-a-hurry){.internal-link target=_blank} 一節,瞭解 `async` 與 `await`。 + +/// + +## 與 OpenAPI 整合 { #integrated-with-openapi } + +你的依賴(以及其子依賴)所宣告的所有請求參數、驗證與需求,都會整合進同一份 OpenAPI 結構中。 + +因此,互動式文件也會包含來自這些依賴的所有資訊: + + + +## 簡單用法 { #simple-usage } + +想一想,「路徑操作函式」是宣告好讓框架在「路徑」與「操作」符合時使用的,然後 **FastAPI** 會負責帶入正確的參數、從請求中擷取資料,並呼叫該函式。 + +其實,所有(或大多數)Web 框架都是這樣運作。 + +你從不會直接呼叫這些函式。它們是由框架(此處是 **FastAPI**)呼叫的。 + +透過依賴注入系統,你也可以告訴 **FastAPI**:你的「路徑操作函式」還「依賴」其他東西,應在你的「路徑操作函式」之前執行,**FastAPI** 會負責執行它並「注入」其結果。 + +這個「依賴注入」概念的其他常見稱呼包括: + +* 資源 +* 提供者 +* 服務 +* 可注入項 +* 元件 + +## **FastAPI** 外掛 { #fastapi-plug-ins } + +各種整合與「外掛」都能以 **依賴注入** 系統來構建。但事實上,並不需要真的去打造「外掛」,因為透過依賴,你可以宣告無數的整合與互動,並讓它們供你的「路徑操作函式」使用。 + +而且依賴可以用非常簡單直覺的方式建立,你只需要匯入所需的 Python 套件,然後用幾行程式碼就能把它們與你的 API 函式整合,真的是「只要幾行」。 + +在接下來的章節中你會看到這方面的例子,例如關聯式與 NoSQL 資料庫、安全性等。 + +## **FastAPI** 相容性 { #fastapi-compatibility } + +依賴注入系統的簡潔,使 **FastAPI** 能與以下事物相容: + +* 所有關聯式資料庫 +* NoSQL 資料庫 +* 外部套件 +* 外部 API +* 驗證與授權系統 +* API 使用監控系統 +* 回應資料注入系統 +* 等等 + +## 簡單而強大 { #simple-and-powerful } + +雖然階層式的依賴注入系統相當容易定義與使用,但它依然非常強大。 + +你可以定義會進一步依賴其他依賴的依賴。 + +最終會形成一棵階層式的依賴樹,而 **依賴注入** 系統會負責為你解決所有這些依賴(以及它們的子依賴),並在每一步提供(注入)對應的結果。 + +例如,假設你有 4 個 API 端點(「路徑操作」): + +* `/items/public/` +* `/items/private/` +* `/users/{user_id}/activate` +* `/items/pro/` + +那麼你就能只透過依賴與子依賴,為每個端點加入不同的權限需求: + +```mermaid +graph TB + +current_user(["current_user"]) +active_user(["active_user"]) +admin_user(["admin_user"]) +paying_user(["paying_user"]) + +public["/items/public/"] +private["/items/private/"] +activate_user["/users/{user_id}/activate"] +pro_items["/items/pro/"] + +current_user --> active_user +active_user --> admin_user +active_user --> paying_user + +current_user --> public +active_user --> private +admin_user --> activate_user +paying_user --> pro_items +``` + +## 與 **OpenAPI** 整合 { #integrated-with-openapi_1 } + +所有這些依賴在宣告其需求的同時,也會為你的「路徑操作」新增參數、驗證等。 + +**FastAPI** 會負責把這一切加入 OpenAPI 結構中,讓它們顯示在互動式文件系統裡。 diff --git a/docs/zh-hant/docs/tutorial/dependencies/sub-dependencies.md b/docs/zh-hant/docs/tutorial/dependencies/sub-dependencies.md new file mode 100644 index 0000000000..50c4e17908 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/dependencies/sub-dependencies.md @@ -0,0 +1,105 @@ +# 子相依 { #sub-dependencies } + +你可以建立具有「子相依」的相依項。 + +它們可以按你的需要,層級任意加深。 + +**FastAPI** 會負責解析它們。 + +## 第一個相依項 "dependable" { #first-dependency-dependable } + +你可以建立第一個相依項("dependable")如下: + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[8:9] *} + +它宣告了一個可選的查詢參數 `q`(型別為 `str`),然後直接回傳它。 + +這很簡單(不太實用),但有助於我們專注於子相依如何運作。 + +## 第二個相依,同時是 "dependable" 也是 "dependant" { #second-dependency-dependable-and-dependant } + +接著你可以建立另一個相依函式("dependable"),同時它也宣告了自己的相依(因此它同時也是 "dependant"): + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[13] *} + +來看它所宣告的參數: + +- 即使這個函式本身是個相依項("dependable"),它也宣告了另一個相依(它「相依於」其他東西)。 + - 它相依 `query_extractor`,並把其回傳值指定給參數 `q`。 +- 它還宣告了一個可選的 `last_query` cookie,型別為 `str`。 + - 如果使用者沒有提供查詢 `q`,我們就使用先前儲存在 cookie 中的最後一次查詢值。 + +## 使用相依項 { #use-the-dependency } + +然後我們可以這樣使用這個相依項: + +{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[23] *} + +/// info + +注意,在路徑操作函式中我們只宣告了一個相依項 `query_or_cookie_extractor`。 + +但 **FastAPI** 會知道它必須先解析 `query_extractor`,在呼叫 `query_or_cookie_extractor` 時把其結果傳入。 + +/// + +```mermaid +graph TB + +query_extractor(["query_extractor"]) +query_or_cookie_extractor(["query_or_cookie_extractor"]) + +read_query["/items/"] + +query_extractor --> query_or_cookie_extractor --> read_query +``` + +## 多次使用同一個相依項 { #using-the-same-dependency-multiple-times } + +如果你的某個相依項在同一個路徑操作中被宣告了多次,例如多個相依共用同一個子相依,**FastAPI** 會知道只需在每次請求中呼叫該子相依一次。 + +它會把回傳值儲存在一個 「快取」 中,並在該次請求中傳遞給所有需要它的「相依者」,而不是為同一個請求多次呼叫相同的相依項。 + +在進階情境下,如果你確定需要在同一次請求的每個步驟都呼叫該相依(可能呼叫多次),而不是使用「快取」的值,你可以在使用 `Depends` 時設定參數 `use_cache=False`: + +//// tab | Python 3.10+ + +```Python hl_lines="1" +async def needy_dependency(fresh_value: Annotated[str, Depends(get_value, use_cache=False)]): + return {"fresh_value": fresh_value} +``` + +//// + +//// tab | Python 3.10+ 未使用 Annotated + +/// tip + +若可行,建議使用 `Annotated` 的版本。 + +/// + +```Python hl_lines="1" +async def needy_dependency(fresh_value: str = Depends(get_value, use_cache=False)): + return {"fresh_value": fresh_value} +``` + +//// + +## 回顧 { #recap } + +撇開這裡用到的術語不談,**相依性注入(Dependency Injection)** 系統其實很簡單。 + +它只是一些與路徑操作函式外觀相同的函式。 + +但它非常強大,允許你宣告任意深度巢狀的相依「圖」(樹)。 + +/// tip + +用這些簡單的例子看起來可能不那麼有用。 + +但在關於安全性的章節中,你會看到它有多實用。 + +你也會看到它能為你省下多少程式碼。 + +/// diff --git a/docs/zh-hant/docs/tutorial/encoder.md b/docs/zh-hant/docs/tutorial/encoder.md new file mode 100644 index 0000000000..03b7db6394 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/encoder.md @@ -0,0 +1,35 @@ +# JSON 相容編碼器 { #json-compatible-encoder } + +在某些情況下,你可能需要將某種資料型別(例如 Pydantic 模型)轉換為與 JSON 相容的類型(例如 `dict`、`list` 等)。 + +例如,當你需要把它儲存在資料庫中。 + +為此,**FastAPI** 提供了 `jsonable_encoder()` 函式。 + +## 使用 `jsonable_encoder` { #using-the-jsonable-encoder } + +想像你有一個只接受與 JSON 相容資料的資料庫 `fake_db`。 + +例如,它不接受 `datetime` 物件,因為那與 JSON 不相容。 + +因此,必須將 `datetime` 物件轉為一個以 ISO 格式 表示資料的 `str`。 + +同樣地,這個資料庫不會接受 Pydantic 模型(帶有屬性的物件),只接受 `dict`。 + +你可以使用 `jsonable_encoder` 來處理。 + +它接收一個物件(例如 Pydantic 模型),並回傳一個與 JSON 相容的版本: + +{* ../../docs_src/encoder/tutorial001_py310.py hl[4,21] *} + +在此範例中,它會把 Pydantic 模型轉成 `dict`,並將 `datetime` 轉成 `str`。 + +呼叫後的結果可以用 Python 標準的 `json.dumps()` 進行編碼。 + +它不會回傳一個包含 JSON 內容的大型 `str`(字串)。它會回傳 Python 標準的資料結構(例如 `dict`),其中的值與子值都與 JSON 相容。 + +/// note + +事實上,`jsonable_encoder` 在 **FastAPI** 內部也被用來轉換資料。不過在許多其他情境中它同樣實用。 + +/// diff --git a/docs/zh-hant/docs/tutorial/extra-data-types.md b/docs/zh-hant/docs/tutorial/extra-data-types.md new file mode 100644 index 0000000000..f516d965a4 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/extra-data-types.md @@ -0,0 +1,62 @@ +# 額外的資料型別 { #extra-data-types } + +到目前為止,你一直在使用常見的資料型別,例如: + +* `int` +* `float` +* `str` +* `bool` + +但你也可以使用更複雜的資料型別。 + +而且你仍然會擁有目前為止所見的同樣功能: + +* 極佳的編輯器支援。 +* 將傳入請求的資料轉換。 +* 回應資料的轉換。 +* 資料驗證。 +* 自動產生註解與文件。 + +## 其他資料型別 { #other-data-types } + +以下是你可以使用的一些其他資料型別: + +* `UUID`: + * 一種標準的「通用唯一識別碼 (Universally Unique Identifier)」,常見於許多資料庫與系統的 ID。 + * 在請求與回應中會以 `str` 表示。 +* `datetime.datetime`: + * Python 的 `datetime.datetime`。 + * 在請求與回應中會以 ISO 8601 格式的 `str` 表示,例如:`2008-09-15T15:53:00+05:00`。 +* `datetime.date`: + * Python 的 `datetime.date`。 + * 在請求與回應中會以 ISO 8601 格式的 `str` 表示,例如:`2008-09-15`。 +* `datetime.time`: + * Python 的 `datetime.time`。 + * 在請求與回應中會以 ISO 8601 格式的 `str` 表示,例如:`14:23:55.003`。 +* `datetime.timedelta`: + * Python 的 `datetime.timedelta`。 + * 在請求與回應中會以總秒數的 `float` 表示。 + * Pydantic 也允許用「ISO 8601 time diff encoding」來表示,詳情見文件。 +* `frozenset`: + * 在請求與回應中與 `set` 相同處理: + * 在請求中,會讀取一個 list,去除重複並轉為 `set`。 + * 在回應中,`set` 會被轉為 `list`。 + * 生成的 schema 會指定 `set` 的值為唯一(使用 JSON Schema 的 `uniqueItems`)。 +* `bytes`: + * 標準的 Python `bytes`。 + * 在請求與回應中會被當作 `str` 處理。 + * 生成的 schema 會指定其為 `str`,且 "format" 為 `binary`。 +* `Decimal`: + * 標準的 Python `Decimal`。 + * 在請求與回應中,與 `float` 的處理方式相同。 +* 你可以在此查閱所有可用的 Pydantic 資料型別:Pydantic 資料型別。 + +## 範例 { #example } + +以下是一個帶有參數、使用上述部分型別的 *路徑操作 (path operation)* 範例。 + +{* ../../docs_src/extra_data_types/tutorial001_an_py310.py hl[1,3,12:16] *} + +請注意,函式內的參數會是它們的自然資料型別,因此你可以進行一般的日期運算,例如: + +{* ../../docs_src/extra_data_types/tutorial001_an_py310.py hl[18:19] *} diff --git a/docs/zh-hant/docs/tutorial/extra-models.md b/docs/zh-hant/docs/tutorial/extra-models.md new file mode 100644 index 0000000000..8aae62f8e1 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/extra-models.md @@ -0,0 +1,211 @@ +# 額外的模型 { #extra-models } + +延續前一個範例,通常會有不只一個彼此相關的模型。 + +對使用者模型尤其如此,因為: + +* 「輸入模型」需要能包含密碼。 +* 「輸出模型」不應包含密碼。 +* 「資料庫模型」通常需要儲存雜湊後的密碼。 + +/// danger + +切勿儲存使用者的明文密碼。務必只儲存可供驗證的「安全雜湊」。 + +若你還不清楚,稍後會在[安全性章節](security/simple-oauth2.md#password-hashing){.internal-link target=_blank}學到什麼是「密碼雜湊」。 + +/// + +## 多個模型 { #multiple-models } + +以下是模型大致長相、與其密碼欄位以及它們被使用的位置: + +{* ../../docs_src/extra_models/tutorial001_py310.py hl[7,9,14,20,22,27:28,31:33,38:39] *} + +### 關於 `**user_in.model_dump()` { #about-user-in-model-dump } + +#### Pydantic 的 `.model_dump()` { #pydantics-model-dump } + +`user_in` 是一個 `UserIn` 類別的 Pydantic 模型。 + +Pydantic 模型有 `.model_dump()` 方法,會回傳包含該模型資料的 `dict`。 + +因此,若我們建立一個 Pydantic 物件 `user_in` 如: + +```Python +user_in = UserIn(username="john", password="secret", email="john.doe@example.com") +``` + +接著呼叫: + +```Python +user_dict = user_in.model_dump() +``` + +此時變數 `user_dict` 會是一個承載資料的 `dict`(也就是 `dict`,而非 Pydantic 模型物件)。 + +若再呼叫: + +```Python +print(user_dict) +``` + +我們會得到一個 Python `dict`: + +```Python +{ + 'username': 'john', + 'password': 'secret', + 'email': 'john.doe@example.com', + 'full_name': None, +} +``` + +#### 解包 `dict` { #unpacking-a-dict } + +若將像 `user_dict` 這樣的 `dict` 以 `**user_dict` 傳給函式(或類別),Python 會將其「解包」,把 `user_dict` 的鍵和值直接當作具名引數傳入。 + +因此,延續上面的 `user_dict`,寫成: + +```Python +UserInDB(**user_dict) +``` + +效果等同於: + +```Python +UserInDB( + username="john", + password="secret", + email="john.doe@example.com", + full_name=None, +) +``` + +更精確地說,直接使用 `user_dict`(未來內容可能有所不同)則等同於: + +```Python +UserInDB( + username = user_dict["username"], + password = user_dict["password"], + email = user_dict["email"], + full_name = user_dict["full_name"], +) +``` + +#### 由另一個模型內容建立 Pydantic 模型 { #a-pydantic-model-from-the-contents-of-another } + +如上例我們從 `user_in.model_dump()` 得到 `user_dict`,以下程式碼: + +```Python +user_dict = user_in.model_dump() +UserInDB(**user_dict) +``` + +等同於: + +```Python +UserInDB(**user_in.model_dump()) +``` + +...因為 `user_in.model_dump()` 回傳的是 `dict`,接著在傳給 `UserInDB` 時以 `**` 前綴讓 Python 進行解包。 + +因此,我們可以用一個 Pydantic 模型的資料建立另一個 Pydantic 模型。 + +#### 解包 `dict` 並加入額外參數 { #unpacking-a-dict-and-extra-keywords } + +接著加入額外的具名引數 `hashed_password=hashed_password`,如下: + +```Python +UserInDB(**user_in.model_dump(), hashed_password=hashed_password) +``` + +...結果等同於: + +```Python +UserInDB( + username = user_dict["username"], + password = user_dict["password"], + email = user_dict["email"], + full_name = user_dict["full_name"], + hashed_password = hashed_password, +) +``` + +/// warning + +輔助函式 `fake_password_hasher` 與 `fake_save_user` 只是用來示範資料流程,並不提供任何實際的安全性。 + +/// + +## 減少重複 { #reduce-duplication } + +減少程式碼重複是 FastAPI 的核心理念之一。 + +因為重複的程式碼會提高發生錯誤、安全性問題、程式不同步(某處更新但其他處未更新)等風險。 + +而這些模型共享大量資料,重複了屬性名稱與型別。 + +我們可以做得更好。 + +我們可以宣告一個作為基底的 `UserBase` 模型,其他模型繼承它成為子類別,沿用其屬性(型別宣告、驗證等)。 + +所有資料轉換、驗證、文件產生等仍可正常運作。 + +如此一來,我們只需要宣告模型之間的差異(含明文 `password`、含 `hashed_password`、或不含密碼): + +{* ../../docs_src/extra_models/tutorial002_py310.py hl[7,13:14,17:18,21:22] *} + +## `Union` 或 `anyOf` { #union-or-anyof } + +你可以將回應宣告為多個型別的 `Union`,表示回應可能是其中任一型別。 + +在 OpenAPI 中會以 `anyOf` 定義。 + +要達成這點,使用標準的 Python 型別提示 `typing.Union`: + +/// note + +在定義 `Union` 時,請先放置「更具體」的型別,再放「較不具體」的型別。以下範例中,較具體的 `PlaneItem` 置於 `CarItem` 之前:`Union[PlaneItem, CarItem]`。 + +/// + +{* ../../docs_src/extra_models/tutorial003_py310.py hl[1,14:15,18:20,33] *} + +### Python 3.10 中的 `Union` { #union-in-python-3-10 } + +此範例中,我們將 `Union[PlaneItem, CarItem]` 作為引數 `response_model` 的值。 + +由於這裡是把它當作引數的「值」傳入,而非用於型別註記,因此即使在 Python 3.10 也必須使用 `Union`。 + +若用於型別註記,則可以使用直線(|),如下: + +```Python +some_variable: PlaneItem | CarItem +``` + +但若寫成指定值 `response_model=PlaneItem | CarItem` 會發生錯誤,因為 Python 會嘗試在 `PlaneItem` 與 `CarItem` 之間執行「無效運算」,而非將其視為型別註記。 + +## 模型的清單 { #list-of-models } + +同樣地,你可以將回應宣告為物件的 `list`。 + +為此,使用標準的 Python `list`: + +{* ../../docs_src/extra_models/tutorial004_py310.py hl[18] *} + +## 以任意 `dict` 作為回應 { #response-with-arbitrary-dict } + +你也可以用一般的任意 `dict` 宣告回應,只需指定鍵和值的型別,而不必使用 Pydantic 模型。 + +當你事先不知道可用的欄位/屬性名稱(定義 Pydantic 模型所需)時,這很實用。 + +此時可使用 `dict`: + +{* ../../docs_src/extra_models/tutorial005_py310.py hl[6] *} + +## 重點回顧 { #recap } + +依情境使用多個 Pydantic 模型並靈活繼承。 + +當一個實體需要呈現不同「狀態」時,不必侷限於一個資料模型。例如使用者這個實體,可能有包含 `password`、包含 `password_hash`,或不含密碼等不同狀態。 diff --git a/docs/zh-hant/docs/tutorial/first-steps.md b/docs/zh-hant/docs/tutorial/first-steps.md index 6bcb453bff..3aa2d39ae1 100644 --- a/docs/zh-hant/docs/tutorial/first-steps.md +++ b/docs/zh-hant/docs/tutorial/first-steps.md @@ -2,7 +2,7 @@ 最簡單的 FastAPI 檔案可能看起來像這樣: -{* ../../docs_src/first_steps/tutorial001_py39.py *} +{* ../../docs_src/first_steps/tutorial001_py310.py *} 將其複製到一個名為 `main.py` 的文件中。 @@ -183,7 +183,7 @@ Deploying to FastAPI Cloud... ### 第一步:引入 `FastAPI` { #step-1-import-fastapi } -{* ../../docs_src/first_steps/tutorial001_py39.py hl[1] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[1] *} `FastAPI` 是一個 Python 類別,提供所有 API 的全部功能。 @@ -197,7 +197,7 @@ Deploying to FastAPI Cloud... ### 第二步:建立一個 `FastAPI`「實例」 { #step-2-create-a-fastapi-instance } -{* ../../docs_src/first_steps/tutorial001_py39.py hl[3] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[3] *} 這裡的 `app` 變數將會是 `FastAPI` 類別的「實例」。 @@ -266,12 +266,12 @@ https://example.com/items/foo #### 定義一個「路徑操作裝飾器」 { #define-a-path-operation-decorator } -{* ../../docs_src/first_steps/tutorial001_py39.py hl[6] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[6] *} `@app.get("/")` 告訴 **FastAPI** 那個函式負責處理請求: * 路徑 `/` -* 使用 get操作 +* 使用 get 操作 /// info | `@decorator` 說明 @@ -320,7 +320,7 @@ Python 中的 `@something` 語法被稱為「裝飾器」。 * **operation**:是 `get`。 * **function**:是裝飾器下面的函式(在 `@app.get("/")` 下面)。 -{* ../../docs_src/first_steps/tutorial001_py39.py hl[7] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[7] *} 這就是一個 Python 函式。 @@ -332,7 +332,7 @@ Python 中的 `@something` 語法被稱為「裝飾器」。 你也可以將它定義為一般函式,而不是 `async def`: -{* ../../docs_src/first_steps/tutorial003_py39.py hl[7] *} +{* ../../docs_src/first_steps/tutorial003_py310.py hl[7] *} /// note @@ -342,7 +342,7 @@ Python 中的 `@something` 語法被稱為「裝飾器」。 ### 第五步:回傳內容 { #step-5-return-the-content } -{* ../../docs_src/first_steps/tutorial001_py39.py hl[8] *} +{* ../../docs_src/first_steps/tutorial001_py310.py hl[8] *} 你可以返回一個 `dict`、`list`、單個值作為 `str`、`int` 等。 diff --git a/docs/zh-hant/docs/tutorial/handling-errors.md b/docs/zh-hant/docs/tutorial/handling-errors.md new file mode 100644 index 0000000000..f3a7573cd5 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/handling-errors.md @@ -0,0 +1,244 @@ +# 錯誤處理 { #handling-errors } + +在許多情況下,你需要通知使用你 API 的用戶端發生錯誤。 + +這個用戶端可能是帶有前端的瀏覽器、他人的程式碼、IoT 裝置等。 + +你可能需要告訴用戶端: + +* 用戶端沒有足夠權限執行該操作。 +* 用戶端沒有權限存取該資源。 +* 用戶端嘗試存取的項目不存在。 +* 等等。 + +在這些情況下,通常會回傳範圍為 400(400 到 499)的 HTTP 狀態碼。 + +這類似於 200 範圍的 HTTP 狀態碼(200 到 299)。那些「200」狀態碼表示請求在某種程度上是「成功」的。 + +400 範圍的狀態碼表示用戶端錯誤。 + +還記得那些「404 Not Found」錯誤(和梗)嗎? + +## 使用 `HTTPException` { #use-httpexception } + +要向用戶端回傳帶有錯誤的 HTTP 回應,使用 `HTTPException`。 + +### 匯入 `HTTPException` { #import-httpexception } + +{* ../../docs_src/handling_errors/tutorial001_py310.py hl[1] *} + +### 在程式中 raise 一個 `HTTPException` { #raise-an-httpexception-in-your-code } + +`HTTPException` 是一般的 Python 例外,但包含與 API 相關的附加資料。 + +因為它是 Python 的例外,你不是 `return`,而是 `raise`。 + +這也表示,如果你在某個工具函式中(該函式被你的「路徑操作函式」呼叫),並在該工具函式裡 raise `HTTPException`,那麼「路徑操作函式」剩下的程式碼將不會執行;該請求會立刻被終止,並將 `HTTPException` 的 HTTP 錯誤傳回給用戶端。 + +為何選擇 raise 例外而非回傳值的好處,會在相依性與安全性章節更為明顯。 + +在這個範例中,當用戶端以不存在的 ID 請求項目時,raise 一個狀態碼為 `404` 的例外: + +{* ../../docs_src/handling_errors/tutorial001_py310.py hl[11] *} + +### 回應結果 { #the-resulting-response } + +如果用戶端請求 `http://example.com/items/foo`(`item_id` 為 `"foo"`),會收到 200 的 HTTP 狀態碼,以及以下 JSON 回應: + +```JSON +{ + "item": "The Foo Wrestlers" +} +``` + +但如果用戶端請求 `http://example.com/items/bar`(不存在的 `item_id` `"bar"`),會收到 404("not found")的 HTTP 狀態碼,以及以下 JSON 回應: + +```JSON +{ + "detail": "Item not found" +} +``` + +/// tip + +在 raise 一個 `HTTPException` 時,你可以將任何可轉為 JSON 的值作為 `detail` 參數,不只限於 `str`。 + +你可以傳入 `dict`、`list` 等。 + +**FastAPI** 會自動處理並轉為 JSON。 + +/// + +## 新增自訂標頭 { #add-custom-headers } + +有些情況需要在 HTTP 錯誤回應中加入自訂標頭,例如某些安全性情境。 + +你大概不需要在程式碼中直接使用。 + +但若你在進階情境中需要,可以這樣加入自訂標頭: + +{* ../../docs_src/handling_errors/tutorial002_py310.py hl[14] *} + +## 安裝自訂例外處理器 { #install-custom-exception-handlers } + +你可以使用 Starlette 的相同例外工具 來加入自訂例外處理器。 + +假設你有一個自訂例外 `UnicornException`,你(或你使用的函式庫)可能會 `raise` 它。 + +而你想用 FastAPI 全域處理這個例外。 + +你可以使用 `@app.exception_handler()` 加入自訂例外處理器: + +{* ../../docs_src/handling_errors/tutorial003_py310.py hl[5:7,13:18,24] *} + +在這裡,如果你請求 `/unicorns/yolo`,該「路徑操作」會 `raise` 一個 `UnicornException`。 + +但它會被 `unicorn_exception_handler` 所處理。 + +因此你會得到一個乾淨的錯誤回應,HTTP 狀態碼為 `418`,JSON 內容如下: + +```JSON +{"message": "Oops! yolo did something. There goes a rainbow..."} +``` + +/// note | 技術細節 + +你也可以使用 `from starlette.requests import Request` 與 `from starlette.responses import JSONResponse`。 + +**FastAPI** 以便利性為由,提供和 `starlette.responses` 相同的介面於 `fastapi.responses`。但大多數可用的回應類型其實直接來自 Starlette。`Request` 也一樣。 + +/// + +## 覆寫預設例外處理器 { #override-the-default-exception-handlers } + +**FastAPI** 內建了一些預設例外處理器。 + +這些處理器負責在你 `raise` 一個 `HTTPException` 或請求帶有無效資料時,回傳預設的 JSON 回應。 + +你可以用自己的處理器來覆寫它們。 + +### 覆寫請求驗證例外 { #override-request-validation-exceptions } + +當請求包含無效資料時,**FastAPI** 會在內部 raise 一個 `RequestValidationError`。 + +它同時也包含了對應的預設例外處理器。 + +要覆寫它,匯入 `RequestValidationError`,並用 `@app.exception_handler(RequestValidationError)` 來裝飾你的例外處理器。 + +例外處理器會接收一個 `Request` 和該例外。 + +{* ../../docs_src/handling_errors/tutorial004_py310.py hl[2,14:19] *} + +現在,如果你前往 `/items/foo`,預設的 JSON 錯誤本應為: + +```JSON +{ + "detail": [ + { + "loc": [ + "path", + "item_id" + ], + "msg": "value is not a valid integer", + "type": "type_error.integer" + } + ] +} +``` + +你將會改而得到文字版: + +``` +Validation errors: +Field: ('path', 'item_id'), Error: Input should be a valid integer, unable to parse string as an integer +``` + +### 覆寫 `HTTPException` 的錯誤處理器 { #override-the-httpexception-error-handler } + +同樣地,你也可以覆寫 `HTTPException` 的處理器。 + +例如,你可能想在這些錯誤時回傳純文字而非 JSON: + +{* ../../docs_src/handling_errors/tutorial004_py310.py hl[3:4,9:11,25] *} + +/// note | 技術細節 + +你也可以使用 `from starlette.responses import PlainTextResponse`。 + +**FastAPI** 以便利性為由,提供和 `starlette.responses` 相同的介面於 `fastapi.responses`。但大多數可用的回應類型其實直接來自 Starlette。 + +/// + +/// warning + +請注意,`RequestValidationError` 內含驗證錯誤發生的檔名與行號,如果你願意,可以在日誌中顯示這些相關資訊。 + +但這也代表如果你只是把它轉成字串並直接回傳,可能會洩漏一些關於你系統的資訊。因此這裡的程式碼會分別擷取並顯示每個錯誤。 + +/// + +### 使用 `RequestValidationError` 的 body { #use-the-requestvalidationerror-body } + +`RequestValidationError` 包含它收到的(但無效的)`body`。 + +在開發應用時,你可以用它來記錄 body 並除錯、回傳給使用者等。 + +{* ../../docs_src/handling_errors/tutorial005_py310.py hl[14] *} + +現在嘗試送出一個無效的項目,例如: + +```JSON +{ + "title": "towel", + "size": "XL" +} +``` + +你會收到一個告知資料無效、且包含所收到 body 的回應: + +```JSON hl_lines="12-15" +{ + "detail": [ + { + "loc": [ + "body", + "size" + ], + "msg": "value is not a valid integer", + "type": "type_error.integer" + } + ], + "body": { + "title": "towel", + "size": "XL" + } +} +``` + +#### FastAPI 的 `HTTPException` 與 Starlette 的 `HTTPException` { #fastapis-httpexception-vs-starlettes-httpexception } + +**FastAPI** 有自己定義的 `HTTPException`。 + +而 **FastAPI** 的 `HTTPException` 錯誤類別是繼承自 Starlette 的 `HTTPException` 錯誤類別。 + +唯一的差異是,**FastAPI** 的 `HTTPException` 在 `detail` 欄位接受任何可轉為 JSON 的資料,而 Starlette 的 `HTTPException` 只接受字串。 + +因此,在你的程式碼中,你可以一如往常地 raise **FastAPI** 的 `HTTPException`。 + +但當你註冊例外處理器時,應該針對 Starlette 的 `HTTPException` 來註冊。 + +如此一來,如果 Starlette 的內部程式碼,或任何 Starlette 擴充/外掛 raise 了 Starlette 的 `HTTPException`,你的處理器就能攔截並處理它。 + +在這個範例中,為了能在同一份程式碼中同時使用兩種 `HTTPException`,我們把 Starlette 的例外重新命名為 `StarletteHTTPException`: + +```Python +from starlette.exceptions import HTTPException as StarletteHTTPException +``` + +### 重用 **FastAPI** 的例外處理器 { #reuse-fastapis-exception-handlers } + +如果你想在使用例外的同時,沿用 **FastAPI** 的預設例外處理器,你可以從 `fastapi.exception_handlers` 匯入並重用預設的處理器: + +{* ../../docs_src/handling_errors/tutorial006_py310.py hl[2:5,15,21] *} + +在這個範例中,你只是用一段很生動的訊息把錯誤印出來,不過重點是:你可以使用該例外,然後直接重用預設的例外處理器。 diff --git a/docs/zh-hant/docs/tutorial/header-param-models.md b/docs/zh-hant/docs/tutorial/header-param-models.md new file mode 100644 index 0000000000..ca2b1f8dee --- /dev/null +++ b/docs/zh-hant/docs/tutorial/header-param-models.md @@ -0,0 +1,72 @@ +# 標頭參數模型 { #header-parameter-models } + +如果你有一組相關的標頭參數,可以建立一個 Pydantic 模型來宣告它們。 + +這能讓你在多處重複使用該模型,並一次性為所有參數宣告驗證與中繼資料。😎 + +/// note | 注意 + +自 FastAPI 版本 `0.115.0` 起支援。🤓 + +/// + +## 以 Pydantic 模型宣告標頭參數 { #header-parameters-with-a-pydantic-model } + +在 Pydantic 模型中宣告你需要的標頭參數,然後將參數宣告為 `Header`: + +{* ../../docs_src/header_param_models/tutorial001_an_py310.py hl[9:14,18] *} + +FastAPI 會從請求的標頭為每個欄位擷取資料,並交給你已定義的 Pydantic 模型實例。 + +## 檢視文件 { #check-the-docs } + +你可以在 `/docs` 的文件介面看到所需的標頭: + +
+ +
+ +## 禁止額外標頭 { #forbid-extra-headers } + +在某些特殊情境(可能不常見)下,你可能想限制允許接收的標頭。 + +你可以使用 Pydantic 的模型設定來 `forbid` 任何 `extra` 欄位: + +{* ../../docs_src/header_param_models/tutorial002_an_py310.py hl[10] *} + +如果用戶端嘗試傳送額外的標頭,會收到錯誤回應。 + +例如,用戶端若傳送名為 `tool`、值為 `plumbus` 的標頭,會收到錯誤回應,指出不允許標頭參數 `tool`: + +```json +{ + "detail": [ + { + "type": "extra_forbidden", + "loc": ["header", "tool"], + "msg": "Extra inputs are not permitted", + "input": "plumbus", + } + ] +} +``` + +## 停用底線轉換 { #disable-convert-underscores } + +與一般標頭參數相同,當參數名稱包含底線字元時,會自動轉換為連字號。 + +例如,若在程式碼中有標頭參數 `save_data`,實際期望的 HTTP 標頭為 `save-data`,在文件中也會如此顯示。 + +如果因某些原因需要停用這個自動轉換,你也可以在標頭參數的 Pydantic 模型上設定。 + +{* ../../docs_src/header_param_models/tutorial003_an_py310.py hl[19] *} + +/// warning | 警告 + +在將 `convert_underscores` 設為 `False` 之前,請注意有些 HTTP 代理與伺服器不允許含有底線的標頭。 + +/// + +## 摘要 { #summary } + +你可以在 FastAPI 中使用 Pydantic 模型宣告標頭。😎 diff --git a/docs/zh-hant/docs/tutorial/header-params.md b/docs/zh-hant/docs/tutorial/header-params.md new file mode 100644 index 0000000000..2d6aade4bb --- /dev/null +++ b/docs/zh-hant/docs/tutorial/header-params.md @@ -0,0 +1,91 @@ +# Header 參數 { #header-parameters } + +你可以用與定義 `Query`、`Path`、`Cookie` 參數相同的方式來定義 Header 參數。 + +## 匯入 `Header` { #import-header } + +先匯入 `Header`: + +{* ../../docs_src/header_params/tutorial001_an_py310.py hl[3] *} + +## 宣告 `Header` 參數 { #declare-header-parameters } + +接著使用與 `Path`、`Query`、`Cookie` 相同的結構來宣告標頭參數。 + +你可以設定預設值,以及所有額外的驗證或註解參數: + +{* ../../docs_src/header_params/tutorial001_an_py310.py hl[9] *} + +/// note | 注意 + +`Header` 與 `Path`、`Query`、`Cookie` 是「姊妹」類別,同樣繼承自共同的 `Param` 類別。 + +但請記得,當你從 `fastapi` 匯入 `Query`、`Path`、`Header` 等時,它們其實是會回傳特殊類別的函式。 + +/// + +/// info | 說明 + +要宣告標頭,必須使用 `Header`,否則參數會被解讀為查詢參數。 + +/// + +## 自動轉換 { #automatic-conversion } + +在 `Path`、`Query`、`Cookie` 提供的功能之上,`Header` 還有一些額外的小功能。 + +大多數標準標頭的單字以連字號(減號,`-`)分隔。 + +但像 `user-agent` 這樣的變數名稱在 Python 中是無效的。 + +因此,`Header` 會在預設情況下把參數名稱中的底線(`_`)轉換為連字號(`-`),以便讀取並在文件中顯示該標頭。 + +此外,HTTP 標頭不區分大小寫,所以你可以使用標準的 Python 命名風格(snake_case)來宣告。 + +因此,你可以像在 Python 程式中一樣使用 `user_agent`,不需要把首字母大寫成 `User_Agent` 或類似寫法。 + +若因某些原因需要停用底線自動轉連字號的行為,將 `Header` 的 `convert_underscores` 參數設為 `False`: + +{* ../../docs_src/header_params/tutorial002_an_py310.py hl[10] *} + +/// warning | 警告 + +在將 `convert_underscores` 設為 `False` 之前,請注意有些 HTTP 代理與伺服器不允許使用帶有底線的標頭。 + +/// + +## 重複的標頭 { #duplicate-headers } + +有時可能會收到重複的標頭,也就是同一個標頭會有多個值。 + +可以在型別宣告中使用 list 來定義這種情況。 + +你會以 Python 的 `list` 形式收到該重複標頭的所有值。 + +例如,要宣告可以出現多次的 `X-Token` 標頭,可以這樣寫: + +{* ../../docs_src/header_params/tutorial003_an_py310.py hl[9] *} + +如果你在與該*路徑操作 (path operation)* 溝通時送出兩個 HTTP 標頭如下: + +``` +X-Token: foo +X-Token: bar +``` + +回應會像這樣: + +```JSON +{ + "X-Token values": [ + "bar", + "foo" + ] +} +``` + +## 小結 { #recap } + +使用 `Header` 宣告標頭,套用與 `Query`、`Path`、`Cookie` 相同的通用模式。 + +而且別擔心變數名稱中的底線,**FastAPI** 會自動幫你轉換。 diff --git a/docs/zh-hant/docs/tutorial/metadata.md b/docs/zh-hant/docs/tutorial/metadata.md new file mode 100644 index 0000000000..3243efa89c --- /dev/null +++ b/docs/zh-hant/docs/tutorial/metadata.md @@ -0,0 +1,120 @@ +# 中繼資料與文件 URL { #metadata-and-docs-urls } + +你可以在你的 FastAPI 應用程式中自訂多項中繼資料設定。 + +## API 的中繼資料 { #metadata-for-api } + +你可以設定下列欄位,這些欄位會用在 OpenAPI 規格與自動產生的 API 文件介面中: + +| 參數 | 型別 | 說明 | +|------------|------|-------------| +| `title` | `str` | API 的標題。 | +| `summary` | `str` | API 的簡短摘要。自 OpenAPI 3.1.0、FastAPI 0.99.0 起可用。 | +| `description` | `str` | API 的簡短說明。可使用 Markdown。 | +| `version` | `string` | API 的版本號。這是你自己的應用程式版本,不是 OpenAPI 的版本,例如 `2.5.0`。 | +| `terms_of_service` | `str` | 指向 API 服務條款的 URL。若提供,必須是 URL。 | +| `contact` | `dict` | 對外公開的 API 聯絡資訊。可包含多個欄位。
contact 欄位
參數型別說明
namestr聯絡人/組織的識別名稱。
urlstr指向聯絡資訊的 URL。必須是 URL 格式。
emailstr聯絡人/組織的電子郵件地址。必須是電子郵件格式。
| +| `license_info` | `dict` | 對外公開的 API 授權資訊。可包含多個欄位。
license_info 欄位
參數型別說明
namestr必填(若有設定 license_info)。API 使用的授權名稱。
identifierstrAPI 的 SPDX 授權表示式。identifier 欄位與 url 欄位互斥。自 OpenAPI 3.1.0、FastAPI 0.99.0 起可用。
urlstrAPI 所採用授權的 URL。必須是 URL 格式。
| + +你可以這樣設定它們: + +{* ../../docs_src/metadata/tutorial001_py310.py hl[3:16, 19:32] *} + +/// tip | 提示 + +你可以在 `description` 欄位中撰寫 Markdown,輸出時會被正確渲染。 + +/// + +使用這些設定後,自動產生的 API 文件會像這樣: + + + +## 授權識別碼 { #license-identifier } + +自 OpenAPI 3.1.0 與 FastAPI 0.99.0 起,你也可以在 `license_info` 中使用 `identifier` 來取代 `url`。 + +例如: + +{* ../../docs_src/metadata/tutorial001_1_py310.py hl[31] *} + +## 標籤的中繼資料 { #metadata-for-tags } + +你也可以透過 `openapi_tags` 參數,為用來分組你的路徑操作(path operation)的各個標籤加入額外中繼資料。 + +它接收一個 list,其中每個標籤對應一個 dictionary。 + +每個 dictionary 可包含: + +* `name`(**必填**):一個 `str`,其值需與你在路徑操作與 `APIRouter`s 的 `tags` 參數中使用的標籤名稱相同。 +* `description`:一個 `str`,為該標籤的簡短描述。可使用 Markdown,並會顯示在文件介面中。 +* `externalDocs`:一個 `dict`,描述外部文件,包含: + * `description`:一個 `str`,外部文件的簡短描述。 + * `url`(**必填**):一個 `str`,外部文件的 URL。 + +### 建立標籤的中繼資料 { #create-metadata-for-tags } + +我們用 `users` 與 `items` 兩個標籤來示範。 + +先為你的標籤建立中繼資料,然後將它傳給 `openapi_tags` 參數: + +{* ../../docs_src/metadata/tutorial004_py310.py hl[3:16,18] *} + +注意你可以在描述中使用 Markdown,例如「login」會以粗體(**login**)顯示,而「fancy」會以斜體(_fancy_)顯示。 + +/// tip | 提示 + +你不必為你使用到的每個標籤都加入中繼資料。 + +/// + +### 使用你的標籤 { #use-your-tags } + +在你的路徑操作(以及 `APIRouter`s)上使用 `tags` 參數,將它們歸類到不同標籤下: + +{* ../../docs_src/metadata/tutorial004_py310.py hl[21,26] *} + +/// info | 資訊 + +在[路徑操作設定]中閱讀更多關於標籤的內容:[Path Operation Configuration](path-operation-configuration.md#tags){.internal-link target=_blank}。 + +/// + +### 檢視文件 { #check-the-docs } + +現在檢視文件時,會看到所有額外的中繼資料: + + + +### 標籤順序 { #order-of-tags } + +每個標籤中繼資料 dictionary 在清單中的順序,也會決定它們在文件介面中的顯示順序。 + +例如,雖然按字母排序時 `users` 會排在 `items` 之後,但因為我們在清單中將它的中繼資料放在第一個,所以它會先顯示。 + +## OpenAPI URL { #openapi-url } + +預設情況下,OpenAPI 綱要(schema)會提供在 `/openapi.json`。 + +但你可以用 `openapi_url` 參數來調整。 + +例如,將它設定為提供在 `/api/v1/openapi.json`: + +{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *} + +如果你想完全停用 OpenAPI 綱要,可以設定 `openapi_url=None`,同時也會停用依賴它的文件使用者介面。 + +## 文件 URL { #docs-urls } + +你可以設定內建的兩個文件使用者介面: + +* Swagger UI:提供於 `/docs`。 + * 可用 `docs_url` 參數設定其 URL。 + * 設定 `docs_url=None` 可停用。 +* ReDoc:提供於 `/redoc`。 + * 可用 `redoc_url` 參數設定其 URL。 + * 設定 `redoc_url=None` 可停用。 + +例如,將 Swagger UI 提供於 `/documentation`,並停用 ReDoc: + +{* ../../docs_src/metadata/tutorial003_py310.py hl[3] *} diff --git a/docs/zh-hant/docs/tutorial/middleware.md b/docs/zh-hant/docs/tutorial/middleware.md new file mode 100644 index 0000000000..ac6f5367d0 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/middleware.md @@ -0,0 +1,95 @@ +# 中介軟體 { #middleware } + +你可以在 **FastAPI** 應用程式中加入中介軟體。 + +「中介軟體」是一個函式,在任何特定的*路徑操作*處理之前先處理每個**請求**;在回傳之前,也會處理每個**回應**。 + +- 它會攔截進到應用程式的每個**請求**。 +- 然後可以對該**請求**做一些處理或執行所需的程式碼。 +- 接著把**請求**傳遞給應用程式的其餘部分(某個*路徑操作*)處理。 +- 之後再接收應用程式(某個*路徑操作*)所產生的**回應**。 +- 可以對該**回應**做一些處理或執行所需的程式碼。 +- 然後回傳**回應**。 + +/// note | 技術細節 + +如果你有使用帶有 `yield` 的相依性,其釋放階段的程式碼會在中介軟體之後執行。 + +若有背景工作(在[背景工作](background-tasks.md){.internal-link target=_blank}一節會介紹,你稍後會看到),它們會在所有中介軟體之後執行。 + +/// + +## 建立中介軟體 { #create-a-middleware } + +要建立中介軟體,將裝飾器 `@app.middleware("http")` 加在函式上方。 + +中介軟體函式會接收: + +- `request`。 +- 一個函式 `call_next`,會以 `request` 作為參數。 + - 這個函式會把 `request` 傳給對應的*路徑操作*。 + - 然後回傳對應*路徑操作*所產生的 `response`。 +- 然後你可以在回傳之前進一步修改 `response`。 + +{* ../../docs_src/middleware/tutorial001_py310.py hl[8:9,11,14] *} + +/// tip + +請記得,自訂的非標準標頭可以使用 `X-` 前綴。 + +但如果你有自訂標頭並希望瀏覽器端的用戶端能看到它們,你需要在 CORS 設定([CORS(Cross-Origin Resource Sharing)](cors.md){.internal-link target=_blank})中使用 Starlette 的 CORS 文件所記載的參數 `expose_headers` 將它們加入。 + +/// + +/// note | 技術細節 + +你也可以使用 `from starlette.requests import Request`。 + +**FastAPI** 為了方便開發者而提供了它,但實際上它直接來自 Starlette。 + +/// + +### 在 `response` 之前與之後 { #before-and-after-the-response } + +你可以在任何*路徑操作*接收 `request` 之前,加入要執行的程式碼。 + +也可以在產生出 `response` 之後、回傳之前執行程式碼。 + +例如,你可以新增一個自訂標頭 `X-Process-Time`,其內容為處理請求並產生回應所花費的秒數: + +{* ../../docs_src/middleware/tutorial001_py310.py hl[10,12:13] *} + +/// tip + +這裡我們使用 `time.perf_counter()` 而不是 `time.time()`,因為在這些用例中它可能更精確。🤓 + +/// + +## 多個中介軟體的執行順序 { #multiple-middleware-execution-order } + +當你使用 `@app.middleware()` 裝飾器或 `app.add_middleware()` 方法加入多個中介軟體時,每個新的中介軟體都會包裹應用程式,形成一個堆疊。最後加入的中介軟體位於最外層,最先加入的位於最內層。 + +在請求路徑上,最外層的中介軟體最先執行。 + +在回應路徑上,它最後執行。 + +例如: + +```Python +app.add_middleware(MiddlewareA) +app.add_middleware(MiddlewareB) +``` + +執行順序如下: + +- **請求**:MiddlewareB → MiddlewareA → 路由 + +- **回應**:路由 → MiddlewareA → MiddlewareB + +這種堆疊行為可確保中介軟體以可預期且可控制的順序執行。 + +## 其他中介軟體 { #other-middlewares } + +你之後可以在[進階使用者指南:進階中介軟體](../advanced/middleware.md){.internal-link target=_blank}閱讀更多關於其他中介軟體的內容。 + +下一節你將會讀到如何使用中介軟體處理 CORS。 diff --git a/docs/zh-hant/docs/tutorial/path-operation-configuration.md b/docs/zh-hant/docs/tutorial/path-operation-configuration.md new file mode 100644 index 0000000000..45c101434d --- /dev/null +++ b/docs/zh-hant/docs/tutorial/path-operation-configuration.md @@ -0,0 +1,107 @@ +# 路徑操作設定 { #path-operation-configuration } + +你可以在你的「路徑操作裝飾器」中傳入多個參數來進行設定。 + +/// warning | 警告 + +請注意,這些參數是直接傳給「路徑操作裝飾器」,而不是傳給你的「路徑操作函式」。 + +/// + +## 回應狀態碼 { #response-status-code } + +你可以為「路徑操作」的回應設定 (HTTP) `status_code`。 + +你可以直接傳入整數代碼,例如 `404`。 + +如果不記得每個數字代碼代表什麼,你可以使用 `status` 中的速記常數: + +{* ../../docs_src/path_operation_configuration/tutorial001_py310.py hl[1,15] *} + +該狀態碼會用於回應,並被加入至 OpenAPI 結構描述中。 + +/// note | 技術細節 + +你也可以使用 `from starlette import status`。 + +**FastAPI** 提供與 `starlette.status` 相同的 `fastapi.status`,僅為了方便你這位開發者,但它其實直接來自 Starlette。 + +/// + +## 標籤 { #tags } + +你可以為「路徑操作」加入標籤,傳入參數 `tags`,其值為由 `str` 組成的 `list`(通常只是一個 `str`): + +{* ../../docs_src/path_operation_configuration/tutorial002_py310.py hl[15,20,25] *} + +這些標籤會被加入到 OpenAPI 結構描述,並由自動化文件介面使用: + + + +### 含 Enum 的標籤 { #tags-with-enums } + +如果你的應用很大,可能會累積數個標籤,你會希望對相關的「路徑操作」始終使用相同的標籤。 + +在這種情況下,可以考慮把標籤存放在 `Enum` 中。 + +**FastAPI** 對此的支援方式與使用普通字串相同: + +{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *} + +## 摘要與描述 { #summary-and-description } + +你可以加入 `summary` 與 `description`: + +{* ../../docs_src/path_operation_configuration/tutorial003_py310.py hl[17:18] *} + +## 從 docstring 取得描述 { #description-from-docstring } + +由於描述常常較長、跨越多行,你可以在函式的 文件字串(docstring) 中宣告「路徑操作」的描述,**FastAPI** 會從那裡讀取。 + +你可以在 docstring 中書寫 Markdown,它會被正確解析並顯示(會考慮 docstring 的縮排)。 + +{* ../../docs_src/path_operation_configuration/tutorial004_py310.py hl[17:25] *} + +這會用於互動式文件: + + + +## 回應描述 { #response-description } + +你可以用參數 `response_description` 指定回應的描述: + +{* ../../docs_src/path_operation_configuration/tutorial005_py310.py hl[18] *} + +/// info | 資訊 + +請注意,`response_description` 專指回應,而 `description` 則是針對整個「路徑操作」的一般描述。 + +/// + +/// check | 檢查 + +OpenAPI 規範要求每個「路徑操作」都必須有一個回應描述。 + +因此,如果你未提供,**FastAPI** 會自動產生 "Successful response"。 + +/// + + + +## 將「路徑操作」標記為已棄用 { #deprecate-a-path-operation } + +若需要將「路徑操作」標記為 已棄用,但不移除它,請傳入參數 `deprecated`: + +{* ../../docs_src/path_operation_configuration/tutorial006_py310.py hl[16] *} + +在互動式文件中,它會被清楚標示為已棄用: + + + +比較已棄用與未棄用的「路徑操作」在文件中的呈現: + + + +## 總結 { #recap } + +你可以透過將參數傳給「路徑操作裝飾器」,輕鬆地設定並為你的「路徑操作」加入中繼資料。 diff --git a/docs/zh-hant/docs/tutorial/path-params-numeric-validations.md b/docs/zh-hant/docs/tutorial/path-params-numeric-validations.md new file mode 100644 index 0000000000..a07f825b05 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/path-params-numeric-validations.md @@ -0,0 +1,154 @@ +# 路徑參數與數值驗證 { #path-parameters-and-numeric-validations } + +就像使用 `Query` 為查詢參數宣告更多驗證與中繼資料一樣,你也可以用 `Path` 為路徑參數宣告相同類型的驗證與中繼資料。 + +## 匯入 `Path` { #import-path } + +首先,從 `fastapi` 匯入 `Path`,並匯入 `Annotated`: + +{* ../../docs_src/path_params_numeric_validations/tutorial001_an_py310.py hl[1,3] *} + +/// info + +FastAPI 在 0.95.0 版加入並開始推薦使用 `Annotated`。 + +如果你使用更舊的版本,嘗試使用 `Annotated` 會出錯。 + +請確保在使用 `Annotated` 前,先[升級 FastAPI 版本](../deployment/versions.md#upgrading-the-fastapi-versions){.internal-link target=_blank}到至少 0.95.1。 + +/// + +## 宣告中繼資料 { #declare-metadata } + +你可以宣告與 `Query` 相同的所有參數。 + +例如,若要為路徑參數 `item_id` 宣告 `title` 中繼資料,可以這樣寫: + +{* ../../docs_src/path_params_numeric_validations/tutorial001_an_py310.py hl[10] *} + +/// note + +路徑參數一定是必填,因為它必須是路徑的一部分。即使你將其宣告為 `None` 或設定預設值,也不會有任何影響,它仍然是必填。 + +/// + +## 依需求調整參數順序 { #order-the-parameters-as-you-need } + +/// tip + +如果你使用 `Annotated`,這點大概沒那麼重要或必要。 + +/// + +假設你想把查詢參數 `q` 宣告為必要的 `str`。 + +而你不需要為該參數宣告其他內容,所以其實不需要用 `Query`。 + +但你仍需要為路徑參數 `item_id` 使用 `Path`,而且基於某些理由你不想用 `Annotated`。 + +如果你把有「預設值」的參數放在沒有「預設值」的參數之前,Python 會抱怨。 + +但你可以調整它們的順序,先放沒有預設值(查詢參數 `q`)的參數。 + +對 **FastAPI** 來說沒差。它會依參數名稱、型別與預設宣告(`Query`、`Path` 等)來辨識參數,並不在意順序。 + +因此,你可以這樣宣告你的函式: + +{* ../../docs_src/path_params_numeric_validations/tutorial002_py310.py hl[7] *} + +但請記住,若使用 `Annotated`,你就不會有這個問題,因為你不是用函式參數預設值來放 `Query()` 或 `Path()`。 + +{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py310.py *} + +## 依需求調整參數順序的技巧 { #order-the-parameters-as-you-need-tricks } + +/// tip + +如果你使用 `Annotated`,這點大概沒那麼重要或必要。 + +/// + +這裡有個小技巧偶爾很好用,不過你大概不常需要。 + +如果你想要: + +* 不用 `Query`、也不給預設值就宣告查詢參數 `q` +* 使用 `Path` 宣告路徑參數 `item_id` +* 讓它們的順序不同 +* 不使用 `Annotated` + +…Python 有個小語法可以做到。 + +在函式的參數列表最前面放一個 `*`。 + +Python 不會對這個 `*` 做任何事,但它會知道後續的所有參數都必須以關鍵字引數(key-value pairs)方式呼叫,也就是所謂的 kwargs。即便它們沒有預設值也一樣。 + +{* ../../docs_src/path_params_numeric_validations/tutorial003_py310.py hl[7] *} + +### 使用 `Annotated` 更好 { #better-with-annotated } + +記住,如果你使用 `Annotated`,因為不是用函式參數預設值,所以你不會遇到這個問題,也可能不需要使用 `*`。 + +{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py310.py hl[10] *} + +## 數值驗證:大於或等於 { #number-validations-greater-than-or-equal } + +使用 `Query` 和 `Path`(以及你之後會看到的其他類別)可以宣告數值限制。 + +這裡用 `ge=1`,代表 `item_id` 必須是「大於(`g`reater)或等於(`e`qual)」`1` 的整數。 + +{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py310.py hl[10] *} + +## 數值驗證:大於與小於或等於 { #number-validations-greater-than-and-less-than-or-equal } + +同樣也適用於: + +* `gt`:大於(`g`reater `t`han) +* `le`:小於或等於(`l`ess than or `e`qual) + +{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py310.py hl[10] *} + +## 數值驗證:浮點數、大於與小於 { #number-validations-floats-greater-than-and-less-than } + +數值驗證也適用於 `float`。 + +這時就能看出能宣告 gt(不只是 ge)的重要性。因為你可以要求數值必須大於 `0`,即便它小於 `1`。 + +所以,`0.5` 是有效的值,但 `0.0` 或 `0` 則無效。 + +lt 也是同樣的道理。 + +{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py310.py hl[13] *} + +## 小結 { #recap } + +使用 `Query`、`Path`(以及你尚未看到的其他類別)時,你可以像在[查詢參數與字串驗證](query-params-str-validations.md){.internal-link target=_blank}中一樣,宣告中繼資料與字串驗證。 + +你也可以宣告數值驗證: + +* `gt`:大於(`g`reater `t`han) +* `ge`:大於或等於(`g`reater than or `e`qual) +* `lt`:小於(`l`ess `t`han) +* `le`:小於或等於(`l`ess than or `e`qual) + +/// info + +你之後會看到的 `Query`、`Path` 與其他類別,都是共同父類別 `Param` 的子類別。 + +它們共享你已經看到的那些用於額外驗證與中繼資料的參數。 + +/// + +/// note | 技術細節 + +當你從 `fastapi` 匯入 `Query`、`Path` 等時,它們其實是函式。 + +呼叫它們時,會回傳同名類別的實例。 + +也就是說,你匯入的是名為 `Query` 的函式,而當你呼叫它時,它會回傳同名的 `Query` 類別實例。 + +這些函式之所以存在(而不是直接使用類別),是為了避免編輯器標記它們的型別錯誤。 + +如此一來,你就能使用一般的編輯器與開發工具,而不需要額外設定來忽略那些錯誤。 + +/// diff --git a/docs/zh-hant/docs/tutorial/path-params.md b/docs/zh-hant/docs/tutorial/path-params.md new file mode 100644 index 0000000000..373f430cde --- /dev/null +++ b/docs/zh-hant/docs/tutorial/path-params.md @@ -0,0 +1,251 @@ +# 路徑參數 { #path-parameters } + +你可以用與 Python 格式化字串相同的語法來宣告路徑「參數」或「變數」: + +{* ../../docs_src/path_params/tutorial001_py310.py hl[6:7] *} + +路徑參數 `item_id` 的值會作為引數 `item_id` 傳入你的函式。 + +所以,如果你執行這個範例並前往 http://127.0.0.1:8000/items/foo,你會看到這樣的回應: + +```JSON +{"item_id":"foo"} +``` + +## 具型別的路徑參數 { #path-parameters-with-types } + +你可以在函式中使用標準的 Python 型別註記為路徑參數宣告型別: + +{* ../../docs_src/path_params/tutorial002_py310.py hl[7] *} + +在這個例子裡,`item_id` 被宣告為 `int`。 + +/// check + +這會在你的函式中提供編輯器支援,包括錯誤檢查、自動完成等。 + +/// + +## 資料 轉換 { #data-conversion } + +如果你執行這個範例並在瀏覽器開啟 http://127.0.0.1:8000/items/3,你會看到這樣的回應: + +```JSON +{"item_id":3} +``` + +/// check + +注意你的函式接收(並回傳)的值是 `3`,也就是 Python 的 `int`,而不是字串 `"3"`。 + +因此,有了這個型別宣告,**FastAPI** 會自動為你處理請求的 「解析」。 + +/// + +## 資料驗證 { #data-validation } + +但如果你在瀏覽器前往 http://127.0.0.1:8000/items/foo,你會看到漂亮的 HTTP 錯誤: + +```JSON +{ + "detail": [ + { + "type": "int_parsing", + "loc": [ + "path", + "item_id" + ], + "msg": "Input should be a valid integer, unable to parse string as an integer", + "input": "foo" + } + ] +} +``` + +因為路徑參數 `item_id` 的值是 `"foo"`,它不是 `int`。 + +同樣的錯誤也會在你提供 `float` 而不是 `int` 時出現,例如:http://127.0.0.1:8000/items/4.2 + +/// check + +因此,搭配相同的 Python 型別宣告,**FastAPI** 會為你進行資料驗證。 + +注意錯誤也清楚指出驗證未通過的確切位置。 + +這在開發與除錯與你的 API 互動的程式碼時非常有幫助。 + +/// + +## 文件 { #documentation } + +當你在瀏覽器開啟 http://127.0.0.1:8000/docs,你會看到自動產生、可互動的 API 文件,例如: + + + +/// check + +同樣地,只要使用那個 Python 型別宣告,**FastAPI** 就會提供自動、互動式的文件(整合 Swagger UI)。 + +注意路徑參數被宣告為整數。 + +/// + +## 基於標準的優勢與替代文件 { #standards-based-benefits-alternative-documentation } + +而且因為產生的 schema 來自 OpenAPI 標準,有很多相容的工具可用。 + +因此,**FastAPI** 本身也提供另一種 API 文件(使用 ReDoc),你可以在 http://127.0.0.1:8000/redoc 存取: + + + +同樣地,也有許多相容工具可用,包括支援多種語言的程式碼產生工具。 + +## Pydantic { #pydantic } + +所有資料驗證都由 Pydantic 在底層處理,因此你能直接受惠。而且你可以放心使用。 + +你可以用相同的型別宣告搭配 `str`、`float`、`bool` 與許多更複雜的資料型別。 + +這些之中的好幾個會在接下來的教學章節中介紹。 + +## 順序很重要 { #order-matters } + +在建立「路徑操作」時,你可能會遇到有固定路徑的情況。 + +像是 `/users/me`,假設它用來取得目前使用者的資料。 + +然後你也可能有一個路徑 `/users/{user_id}` 用來依使用者 ID 取得特定使用者的資料。 + +因為「路徑操作」會依宣告順序來比對,你必須確保 `/users/me` 的路徑在 `/users/{user_id}` 之前宣告: + +{* ../../docs_src/path_params/tutorial003_py310.py hl[6,11] *} + +否則,`/users/{user_id}` 的路徑也會匹配 `/users/me`,並「認為」它收到一個值為 `"me"` 的 `user_id` 參數。 + +同樣地,你不能重新定義同一路徑操作: + +{* ../../docs_src/path_params/tutorial003b_py310.py hl[6,11] *} + +因為第一個會被優先使用(路徑先匹配到)。 + +## 預先定義的值 { #predefined-values } + +如果你有一個接收「路徑參數」的「路徑操作」,但你希望可用的「路徑參數」值是預先定義好的,你可以使用標準的 Python `Enum`。 + +### 建立 `Enum` 類別 { #create-an-enum-class } + +匯入 `Enum` 並建立一個同時繼承自 `str` 與 `Enum` 的子類別。 + +繼承自 `str` 之後,API 文件就能知道這些值的型別必須是 `string`,並能正確地呈現。 + +然後建立具有固定值的類別屬性,這些就是可用的有效值: + +{* ../../docs_src/path_params/tutorial005_py310.py hl[1,6:9] *} + +/// tip + +如果你在想,「AlexNet」、「ResNet」和「LeNet」只是一些機器學習 模型 的名字。 + +/// + +### 宣告一個「路徑參數」 { #declare-a-path-parameter } + +接著使用你建立的列舉類別(`ModelName`)作為型別註記,建立一個「路徑參數」: + +{* ../../docs_src/path_params/tutorial005_py310.py hl[16] *} + +### 查看文件 { #check-the-docs } + +因為「路徑參數」的可用值是預先定義的,互動式文件可以很漂亮地顯示它們: + + + +### 使用 Python「列舉」 { #working-with-python-enumerations } + +「路徑參數」的值會是一個「列舉成員」。 + +#### 比較「列舉成員」 { #compare-enumeration-members } + +你可以把它與你建立的列舉 `ModelName` 中的「列舉成員」比較: + +{* ../../docs_src/path_params/tutorial005_py310.py hl[17] *} + +#### 取得「列舉值」 { #get-the-enumeration-value } + +你可以用 `model_name.value` 取得實際的值(在這個例子中是 `str`),一般而言就是 `your_enum_member.value`: + +{* ../../docs_src/path_params/tutorial005_py310.py hl[20] *} + +/// tip + +你也可以用 `ModelName.lenet.value` 取得值 `"lenet"`。 + +/// + +#### 回傳「列舉成員」 { #return-enumeration-members } + +你可以從「路徑操作」回傳「列舉成員」,即使是巢狀在 JSON 主體(例如 `dict`)裡。 + +在回傳給用戶端之前,它們會被轉成對應的值(此例為字串): + +{* ../../docs_src/path_params/tutorial005_py310.py hl[18,21,23] *} + +你的用戶端會收到像這樣的 JSON 回應: + +```JSON +{ + "model_name": "alexnet", + "message": "Deep Learning FTW!" +} +``` + +## 包含路徑的路徑參數 { #path-parameters-containing-paths } + +假設你有一個路徑為 `/files/{file_path}` 的「路徑操作」。 + +但你需要 `file_path` 本身就包含一個「路徑」,像是 `home/johndoe/myfile.txt`。 + +所以,該檔案的 URL 會是:`/files/home/johndoe/myfile.txt`。 + +### OpenAPI 支援 { #openapi-support } + +OpenAPI 並不支援直接宣告一個「路徑參數」內再包含一個「路徑」,因為那會導致難以測試與定義的情況。 + +然而,你仍可在 **FastAPI** 中這樣做,方法是使用 Starlette 的其中一個內部工具。 + +而文件依然能運作,只是它不會額外說明該參數應該包含一個路徑。 + +### 路徑轉換器 { #path-convertor } + +使用 Starlette 提供的選項,你可以用像這樣的 URL 來宣告一個包含「路徑」的「路徑參數」: + +``` +/files/{file_path:path} +``` + +在這個例子裡,參數名稱是 `file_path`,而最後面的 `:path` 表示該參數應該匹配任意「路徑」。 + +所以你可以這樣使用它: + +{* ../../docs_src/path_params/tutorial004_py310.py hl[6] *} + +/// tip + +你可能需要這個參數包含 `/home/johndoe/myfile.txt`,也就是前面帶有斜線(`/`)。 + +在那種情況下,URL 會是:`/files//home/johndoe/myfile.txt`,在 `files` 與 `home` 之間有兩個斜線(`//`)。 + +/// + +## 回顧 { #recap } + +使用 **FastAPI**,只要撰寫簡短、直覺且標準的 Python 型別宣告,你就能獲得: + +* 編輯器支援:錯誤檢查、自動完成等 +* 資料 "解析" +* 資料驗證 +* API 註解與自動產生文件 + +而且你只要宣告一次就好。 + +這大概是 **FastAPI** 相較於其他框架最明顯的優勢之一(除了原始效能之外)。 diff --git a/docs/zh-hant/docs/tutorial/query-params-str-validations.md b/docs/zh-hant/docs/tutorial/query-params-str-validations.md new file mode 100644 index 0000000000..ea84234c0e --- /dev/null +++ b/docs/zh-hant/docs/tutorial/query-params-str-validations.md @@ -0,0 +1,449 @@ +# 查詢參數與字串驗證 { #query-parameters-and-string-validations } + +FastAPI 允許你為參數宣告額外的資訊與驗證。 + +以下面這個應用為例: + +{* ../../docs_src/query_params_str_validations/tutorial001_py310.py hl[7] *} + +查詢參數 `q` 的型別是 `str | None`,表示它是 `str` 但也可以是 `None`,而且預設值就是 `None`,因此 FastAPI 會知道它不是必填。 + +/// note | 注意 + +FastAPI 會因為預設值是 `= None` 而知道 `q` 不是必填。 + +使用 `str | None` 也能讓你的編輯器提供更好的支援並偵測錯誤。 + +/// + +## 額外驗證 { #additional-validation } + +我們要強制:即使 `q` 是可選,只要提供了,長度就不能超過 50 個字元。 + +### 匯入 `Query` 與 `Annotated` { #import-query-and-annotated } + +要達成這點,先匯入: + +- 從 `fastapi` 匯入 `Query` +- 從 `typing` 匯入 `Annotated` + +{* ../../docs_src/query_params_str_validations/tutorial002_an_py310.py hl[1,3] *} + +/// info | 說明 + +FastAPI 自 0.95.0 版起加入並開始推薦使用 `Annotated`。 + +如果你的版本較舊,嘗試使用 `Annotated` 會出錯。 + +請先至少 [升級 FastAPI 版本](../deployment/versions.md#upgrading-the-fastapi-versions){.internal-link target=_blank} 到 0.95.1 再使用 `Annotated`。 + +/// + +## 在 `q` 參數的型別中使用 `Annotated` { #use-annotated-in-the-type-for-the-q-parameter } + +還記得先前在 [Python 型別介紹](../python-types.md#type-hints-with-metadata-annotations){.internal-link target=_blank} 提到可以用 `Annotated` 為參數加入中繼資料嗎? + +現在就用在 FastAPI 上吧。🚀 + +我們原本的型別註記是: + +```Python +q: str | None = None +``` + +接著把它用 `Annotated` 包起來,變成: + +```Python +q: Annotated[str | None] = None +``` + +這兩種寫法代表的意思相同:`q` 可以是 `str` 或 `None`,且預設是 `None`。 + +現在來做有趣的部分。🎉 + +## 在 `q` 參數的 `Annotated` 中加入 `Query` { #add-query-to-annotated-in-the-q-parameter } + +既然我們有可以放更多資訊的 `Annotated`(在此是額外驗證),就把 `Query` 放進 `Annotated`,並把參數 `max_length` 設為 `50`: + +{* ../../docs_src/query_params_str_validations/tutorial002_an_py310.py hl[9] *} + +注意預設值仍然是 `None`,所以這個參數仍是可選。 + +不過,現在在 `Annotated` 裡有 `Query(max_length=50)`,我們就告訴 FastAPI 要對這個值做「額外驗證」,最多 50 個字元即可。😎 + +/// tip | 提示 + +這裡用的是 `Query()`,因為這是「查詢參數」。稍後你會看到 `Path()`、`Body()`、`Header()`、`Cookie()` 等,它們也接受與 `Query()` 相同的參數。 + +/// + +FastAPI 現在會: + +- 驗證資料,確保長度最多 50 個字元 +- 當資料不合法時,回給用戶端清楚的錯誤 +- 在 OpenAPI 的路徑操作中文件化該參數(因此會出現在自動文件 UI) + +## 替代方式(舊):將 `Query` 作為預設值 { #alternative-old-query-as-the-default-value } + +舊版 FastAPI(0.95.0 以前)需要把 `Query` 當成參數的預設值,而不是放在 `Annotated` 裡。你很可能會在各處看到這種寫法,所以我也會說明一下。 + +/// tip | 提示 + +新程式碼且在可能的情況下,請依上面說明使用 `Annotated`。它有多項優點(如下所述),而沒有缺點。🍰 + +/// + +這是把 `Query()` 作為函式參數預設值的寫法,並把參數 `max_length` 設為 50: + +{* ../../docs_src/query_params_str_validations/tutorial002_py310.py hl[7] *} + +在這種情況下(未使用 `Annotated`),我們必須用 `Query()` 取代函式中的預設值 `None`,因此需要用 `Query(default=None)` 來設定預設值;對 FastAPI 而言,這達到相同目的。 + +所以: + +```Python +q: str | None = Query(default=None) +``` + +…會讓參數變為可選、預設值是 `None`,等同於: + +```Python +q: str | None = None +``` + +但用 `Query` 的版本會明確宣告它是查詢參數。 + +接著,我們可以傳更多參數給 `Query`。此例中是用於字串的 `max_length` 參數: + +```Python +q: str | None = Query(default=None, max_length=50) +``` + +這一樣會驗證資料、在資料不合法時顯示清楚錯誤,並在 OpenAPI 的路徑操作中文件化該參數。 + +### 將 `Query` 作為預設值或放在 `Annotated` 中 { #query-as-the-default-value-or-in-annotated } + +注意,把 `Query` 放在 `Annotated` 內時,不能使用 `Query` 的 `default` 參數。 + +請改用函式參數的實際預設值。否則會不一致。 + +例如,這是不允許的: + +```Python +q: Annotated[str, Query(default="rick")] = "morty" +``` + +…因為不清楚預設值到底該是 `"rick"` 還是 `"morty"`。 + +因此,你可以(且更推薦)這樣寫: + +```Python +q: Annotated[str, Query()] = "rick" +``` + +…或在較舊的程式碼中你會看到: + +```Python +q: str = Query(default="rick") +``` + +### `Annotated` 的優點 { #advantages-of-annotated } + +建議使用 `Annotated`,而不是在函式參數上使用(舊式的)預設值寫法,理由很多,且更好。🤓 + +函式參數的「預設值」就是「實際的預設值」,這在 Python 的直覺上更一致。😌 + +你也可以在沒有 FastAPI 的其他地方「直接呼叫」同一個函式,而且能「如預期」運作。若有「必填」參數(沒有預設值),你的「編輯器」會提示錯誤,「Python」在執行時也會抱怨你未傳遞必填參數。 + +若不使用 `Annotated`、改用「(舊式)預設值」寫法,你在沒有 FastAPI 的「其他地方」呼叫該函式時,就得「記得」傳入正確參數,否則值會和預期不同(例如會得到 `QueryInfo` 或類似的東西,而不是 `str`)。你的編輯器不會提示,Python 執行該函式時也不會抱怨,只有在內部操作失敗時才會出錯。 + +因為 `Annotated` 可以有多個中繼資料註解,你甚至可以用同一個函式配合其他工具,例如 Typer。🚀 + +## 加入更多驗證 { #add-more-validations } + +你也可以加入 `min_length` 參數: + +{* ../../docs_src/query_params_str_validations/tutorial003_an_py310.py hl[10] *} + +## 加入正規表示式 { #add-regular-expressions } + +你可以定義參數必須符合的 regular expression `pattern`: + +{* ../../docs_src/query_params_str_validations/tutorial004_an_py310.py hl[11] *} + +這個特定的正規表示式樣式會檢查收到的參數值是否: + +- `^`:以後續的字元開頭,前面不能有其他字元。 +- `fixedquery`:必須正好等於 `fixedquery`。 +- `$`:在此結束,`fixedquery` 後面不能再有其他字元。 + +如果你對「正規表示式」感到困惑,別擔心。這對很多人來說都不容易。你仍然可以先不使用正規表示式就完成很多事情。 + +現在你知道,當你需要它們時,可以在 FastAPI 中使用它們。 + +## 預設值 { #default-values } + +當然,你可以使用 `None` 以外的預設值。 + +假設你想宣告查詢參數 `q` 的 `min_length` 是 `3`,且預設值是 `"fixedquery"`: + +{* ../../docs_src/query_params_str_validations/tutorial005_an_py310.py hl[9] *} + +/// note | 注意 + +只要有任何型別的預設值(包含 `None`),參數就是可選(非必填)。 + +/// + +## 必填參數 { #required-parameters } + +當我們不需要宣告更多的驗證或中繼資料時,只要不提供預設值,就能讓查詢參數 `q` 成為必填,例如: + +```Python +q: str +``` + +而不是: + +```Python +q: str | None = None +``` + +但現在我們要搭配 `Query` 來宣告,例如: + +```Python +q: Annotated[str | None, Query(min_length=3)] = None +``` + +因此,在使用 `Query` 時若要宣告值為必填,只要不要宣告預設值即可: + +{* ../../docs_src/query_params_str_validations/tutorial006_an_py310.py hl[9] *} + +### 必填,但可為 `None` { #required-can-be-none } + +你可以宣告參數可以接受 `None`,但仍然是必填。這會強制用戶端一定要送出一個值,即使該值是 `None`。 + +要做到這點,你可以宣告 `None` 是合法型別,但不要宣告預設值: + +{* ../../docs_src/query_params_str_validations/tutorial006c_an_py310.py hl[9] *} + +## 查詢參數清單/多個值 { #query-parameter-list-multiple-values } + +當你用 `Query` 明確定義查詢參數時,也可以讓它接收一個值的清單;換句話說,就是「多個值」。 + +例如,要宣告查詢參數 `q` 可以在 URL 中出現多次,你可以這樣寫: + +{* ../../docs_src/query_params_str_validations/tutorial011_an_py310.py hl[9] *} + +若使用這樣的 URL: + +``` +http://localhost:8000/items/?q=foo&q=bar +``` + +你會在路徑操作函式的參數 `q` 中,收到多個 `q` 查詢參數的值(`foo` 與 `bar`),以 Python 的 `list` 形式。 + +因此,對該 URL 的回應會是: + +```JSON +{ + "q": [ + "foo", + "bar" + ] +} +``` + +/// tip | 提示 + +要宣告型別為 `list` 的查詢參數(如上例),需要明確使用 `Query`,否則它會被解讀為請求本文。 + +/// + +互動式 API 文件也會相應更新,以便支援多個值: + + + +### 查詢參數清單/多個值的預設值 { #query-parameter-list-multiple-values-with-defaults } + +也可以在未提供任何值時,定義 `list` 型別的預設值: + +{* ../../docs_src/query_params_str_validations/tutorial012_an_py310.py hl[9] *} + +如果你前往: + +``` +http://localhost:8000/items/ +``` + +`q` 的預設值會是:`["foo", "bar"]`,而回應會是: + +```JSON +{ + "q": [ + "foo", + "bar" + ] +} +``` + +#### 只使用 `list` { #using-just-list } + +你也可以直接使用 `list`,而不是 `list[str]`: + +{* ../../docs_src/query_params_str_validations/tutorial013_an_py310.py hl[9] *} + +/// note | 注意 + +注意,在這種情況下,FastAPI 不會檢查清單的內容。 + +例如,`list[int]` 會檢查(並文件化)清單內容為整數;但單獨使用 `list` 則不會。 + +/// + +## 宣告更多中繼資料 { #declare-more-metadata } + +你可以為參數加入更多資訊。 + +這些資訊會被包含在產生的 OpenAPI 中,供文件 UI 與外部工具使用。 + +/// note | 注意 + +請留意,不同工具對 OpenAPI 的支援程度可能不同。 + +有些工具可能暫時還不會顯示所有額外資訊;不過多半這些缺漏功能已在開發規劃中。 + +/// + +你可以加入 `title`: + +{* ../../docs_src/query_params_str_validations/tutorial007_an_py310.py hl[10] *} + +以及 `description`: + +{* ../../docs_src/query_params_str_validations/tutorial008_an_py310.py hl[14] *} + +## 別名參數 { #alias-parameters } + +想像你希望參數名稱是 `item-query`。 + +像這樣: + +``` +http://127.0.0.1:8000/items/?item-query=foobaritems +``` + +但 `item-query` 不是合法的 Python 變數名稱。 + +最接近的大概是 `item_query`。 + +但你仍然需要它就是 `item-query`... + +那你可以宣告一個 `alias`,實際上就會用這個別名來讀取參數值: + +{* ../../docs_src/query_params_str_validations/tutorial009_an_py310.py hl[9] *} + +## 棄用參數 { #deprecating-parameters } + +現在假設你不再喜歡這個參數了。 + +你必須暫時保留它,因為還有用戶端在用,但你希望文件能清楚標示它是已棄用。 + +接著把參數 `deprecated=True` 傳給 `Query`: + +{* ../../docs_src/query_params_str_validations/tutorial010_an_py310.py hl[19] *} + +文件會這樣顯示: + + + +## 從 OpenAPI 排除參數 { #exclude-parameters-from-openapi } + +若要把某個查詢參數從產生的 OpenAPI(以及自動文件系統)中排除,將 `Query` 的 `include_in_schema` 設為 `False`: + +{* ../../docs_src/query_params_str_validations/tutorial014_an_py310.py hl[10] *} + +## 自訂驗證 { #custom-validation } + +有時你需要做一些上述參數無法處理的「自訂驗證」。 + +這種情況下,你可以使用「自訂驗證函式」,它會在一般驗證之後套用(例如先確認值是 `str` 之後)。 + +你可以在 `Annotated` 中使用 Pydantic 的 `AfterValidator` 來達成。 + +/// tip | 提示 + +Pydantic 也有 `BeforeValidator` 等等。🤓 + +/// + +例如,以下自訂驗證器會檢查項目 ID 是否以 `isbn-` 開頭(ISBN 書籍編號),或以 `imdb-` 開頭(IMDB 電影 URL 的 ID): + +{* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py hl[5,16:19,24] *} + +/// info | 說明 + +這需搭配 Pydantic 2 或以上版本。😎 + +/// + +/// tip | 提示 + +如果你需要做任何需要與「外部元件」溝通的驗證(例如資料庫或其他 API),應該改用「FastAPI 依賴」(FastAPI Dependencies),你稍後會學到。 + +這些自訂驗證器適用於只需使用請求中「同一份資料」即可完成的檢查。 + +/// + +### 理解這段程式碼 { #understand-that-code } + +重點就是在 `Annotated` 中使用「`AfterValidator` 搭配函式」。如果你願意,可以略過這一節。🤸 + +--- + +但如果你對這個範例感到好奇且仍有興致,以下是一些額外細節。 + +#### 使用 `value.startswith()` 的字串 { #string-with-value-startswith } + +你注意到了嗎?字串的 `value.startswith()` 可以接收一個 tuple,並逐一檢查 tuple 中的每個值: + +{* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py ln[16:19] hl[17] *} + +#### 隨機項目 { #a-random-item } + +透過 `data.items()` 我們會得到一個包含每個字典項目鍵值對 tuple 的 iterable object。 + +我們用 `list(data.items())` 把這個可疊代物件轉成正式的 `list`。 + +接著用 `random.choice()` 從清單中取得一個「隨機值」,也就是一個 `(id, name)` 的 tuple。可能像是 `("imdb-tt0371724", "The Hitchhiker's Guide to the Galaxy")`。 + +然後把這個 tuple 的兩個值分別指定給變數 `id` 和 `name`。 + +因此,即使使用者沒有提供 item ID,仍然會收到一個隨機建議。 + +……而這全部只用一行簡單的程式碼完成。🤯 你不愛 Python 嗎?🐍 + +{* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py ln[22:30] hl[29] *} + +## 重點回顧 { #recap } + +你可以為參數宣告額外的驗證與中繼資料。 + +通用的驗證與中繼資料: + +- `alias` +- `title` +- `description` +- `deprecated` + +字串專用的驗證: + +- `min_length` +- `max_length` +- `pattern` + +使用 `AfterValidator` 的自訂驗證。 + +在這些範例中,你看到了如何為 `str` 值宣告驗證。 + +接下來的章節會示範如何為其他型別(像是數字)宣告驗證。 diff --git a/docs/zh-hant/docs/tutorial/query-params.md b/docs/zh-hant/docs/tutorial/query-params.md new file mode 100644 index 0000000000..f21bf40506 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/query-params.md @@ -0,0 +1,187 @@ +# 查詢參數 { #query-parameters } + +當你宣告不是路徑參數的其他函式參數時,會自動被視為「查詢(query)」參數。 + +{* ../../docs_src/query_params/tutorial001_py310.py hl[9] *} + +查詢是出現在 URL 中 `?` 之後的一組鍵值對,以 `&` 字元分隔。 + +例如,URL: + +``` +http://127.0.0.1:8000/items/?skip=0&limit=10 +``` + +...查詢參數為: + +* `skip`:值為 `0` +* `limit`:值為 `10` + +因為它們是 URL 的一部分,天生是字串。 + +但當你以 Python 型別宣告它們(如上例中的 `int`),它們會被轉換成該型別並據此驗證。 + +對於查詢參數,會套用與路徑參數相同的處理流程: + +* 編輯器支援(當然) +* 資料 「解析」 +* 資料驗證 +* 自動文件 + +## 預設值 { #defaults } + +由於查詢參數不是路徑的固定部分,因此可以是選填並具有預設值。 + +在上面的例子中,預設值為 `skip=0` 與 `limit=10`。 + +因此,造訪下列 URL: + +``` +http://127.0.0.1:8000/items/ +``` + +等同於造訪: + +``` +http://127.0.0.1:8000/items/?skip=0&limit=10 +``` + +但如果你改為造訪: + +``` +http://127.0.0.1:8000/items/?skip=20 +``` + +函式中的參數值會是: + +* `skip=20`:因為你在 URL 中設定了它 +* `limit=10`:因為那是預設值 + +## 選用參數 { #optional-parameters } + +同樣地,你可以將預設值設為 `None` 來宣告選用的查詢參數: + +{* ../../docs_src/query_params/tutorial002_py310.py hl[7] *} + +在這種情況下,函式參數 `q` 為選用,且預設為 `None`。 + +/// check | 注意 + +另外請注意,FastAPI 能辨識出路徑參數 `item_id` 是路徑參數,而 `q` 不是,因此 `q` 會被當作查詢參數。 + +/// + +## 查詢參數型別轉換 { #query-parameter-type-conversion } + +你也可以宣告 `bool` 型別,值會被自動轉換: + +{* ../../docs_src/query_params/tutorial003_py310.py hl[7] *} + +在這種情況下,如果你造訪: + +``` +http://127.0.0.1:8000/items/foo?short=1 +``` + +或 + +``` +http://127.0.0.1:8000/items/foo?short=True +``` + +或 + +``` +http://127.0.0.1:8000/items/foo?short=true +``` + +或 + +``` +http://127.0.0.1:8000/items/foo?short=on +``` + +或 + +``` +http://127.0.0.1:8000/items/foo?short=yes +``` + +或任何其他大小寫變化(全大寫、首字母大寫等),你的函式會將參數 `short` 視為 `bool` 值 `True`。否則為 `False`。 + +## 多個路徑與查詢參數 { #multiple-path-and-query-parameters } + +你可以同時宣告多個路徑參數與查詢參數,FastAPI 會自動分辨。 + +而且不必按特定順序宣告。 + +會依名稱辨識: + +{* ../../docs_src/query_params/tutorial004_py310.py hl[6,8] *} + +## 必填查詢參數 { #required-query-parameters } + +當你為非路徑參數(目前我們只看到查詢參數)宣告了預設值時,它就不是必填。 + +若你不想提供特定預設值、只想讓它為選填,將預設值設為 `None`。 + +但若你要讓查詢參數成為必填,只要不要宣告任何預設值: + +{* ../../docs_src/query_params/tutorial005_py310.py hl[6:7] *} + +此處查詢參數 `needy` 是必填的 `str`。 + +如果你在瀏覽器中開啟如下的 URL: + +``` +http://127.0.0.1:8000/items/foo-item +``` + +...沒有加上必填的 `needy` 參數,你會看到類似這樣的錯誤: + +```JSON +{ + "detail": [ + { + "type": "missing", + "loc": [ + "query", + "needy" + ], + "msg": "Field required", + "input": null + } + ] +} +``` + +由於 `needy` 是必填參數,你需要在 URL 中設定它: + +``` +http://127.0.0.1:8000/items/foo-item?needy=sooooneedy +``` + +...這樣就會成功: + +```JSON +{ + "item_id": "foo-item", + "needy": "sooooneedy" +} +``` + +當然,你可以同時定義部分參數為必填、部分有預設值、部分為選填: + +{* ../../docs_src/query_params/tutorial006_py310.py hl[8] *} + +在此例中,有 3 個查詢參數: + +* `needy`,必填的 `str`。 +* `skip`,具有預設值 `0` 的 `int`。 +* `limit`,選填的 `int`。 + +/// tip | 提示 + +你也可以像在[路徑參數](path-params.md#predefined-values){.internal-link target=_blank}中一樣使用 `Enum`。 + +/// diff --git a/docs/zh-hant/docs/tutorial/request-files.md b/docs/zh-hant/docs/tutorial/request-files.md new file mode 100644 index 0000000000..c8606a3f23 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/request-files.md @@ -0,0 +1,176 @@ +# 請求中的檔案 { #request-files } + +你可以使用 `File` 定義由用戶端上傳的檔案。 + +/// info + +若要接收上傳的檔案,請先安裝 `python-multipart`。 + +請先建立並啟用一個[虛擬環境](../virtual-environments.md){.internal-link target=_blank},然後安裝,例如: + +```console +$ pip install python-multipart +``` + +因為上傳的檔案是以「表單資料」送出的。 + +/// + +## 匯入 `File` { #import-file } + +從 `fastapi` 匯入 `File` 與 `UploadFile`: + +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[3] *} + +## 定義 `File` 參數 { #define-file-parameters } + +和 `Body` 或 `Form` 一樣的方式建立檔案參數: + +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[9] *} + +/// info + +`File` 是直接繼承自 `Form` 的類別。 + +但請記住,當你從 `fastapi` 匯入 `Query`、`Path`、`File` 等時,它們其實是回傳特殊類別的函式。 + +/// + +/// tip + +要宣告檔案本文,必須使用 `File`,否則參數會被解讀為查詢參數或本文(JSON)參數。 + +/// + +檔案會以「表單資料」上傳。 + +如果你將路徑操作函式(path operation function)的參數型別宣告為 `bytes`,**FastAPI** 會替你讀取檔案,你會以 `bytes` 取得內容。 + +請注意,這表示整個內容會存放在記憶體中,適合小檔案。 + +但在許多情況下,使用 `UploadFile` 會更好。 + +## 使用 `UploadFile` 的檔案參數 { #file-parameters-with-uploadfile } + +將檔案參數型別設為 `UploadFile`: + +{* ../../docs_src/request_files/tutorial001_an_py310.py hl[14] *} + +使用 `UploadFile` 相較於 `bytes` 有數個優點: + +* 你不必在參數的預設值使用 `File()`。 +* 它使用「spooled」檔案: + * 檔案在記憶體中保存到某個大小上限,超過上限後會存到磁碟。 +* 因此適合處理大型檔案(例如圖片、影片、大型二進位檔等),而不會耗盡記憶體。 +* 你可以取得上傳檔案的中繼資料。 +* 它提供一個類檔案的 `async` 介面。 +* 它會提供實際的 Python `SpooledTemporaryFile` 物件,你可以直接傳給需要類檔案物件的其他函式或函式庫。 + +### `UploadFile` { #uploadfile } + +`UploadFile` 具有以下屬性: + +* `filename`:一個 `str`,為上傳的原始檔名(例如 `myimage.jpg`)。 +* `content_type`:一個 `str`,為內容類型(MIME type / media type)(例如 `image/jpeg`)。 +* `file`:一個 `SpooledTemporaryFile`類檔案物件)。這是真正的 Python 檔案物件,你可以直接傳給期待「類檔案」物件的其他函式或函式庫。 + +`UploadFile` 有以下 `async` 方法。它們底層會呼叫對應的檔案方法(使用內部的 `SpooledTemporaryFile`)。 + +* `write(data)`:將 `data`(`str` 或 `bytes`)寫入檔案。 +* `read(size)`:讀取檔案的 `size`(`int`)個位元組/字元。 +* `seek(offset)`:移動到檔案中的位元組位置 `offset`(`int`)。 + * 例如,`await myfile.seek(0)` 會移到檔案開頭。 + * 當你已經執行過 `await myfile.read()`,之後需要再次讀取內容時特別有用。 +* `close()`:關閉檔案。 + +由於這些都是 `async` 方法,你需要以 await 呼叫它們。 + +例如,在 `async` 的路徑操作函式中可這樣讀取內容: + +```Python +contents = await myfile.read() +``` + +若是在一般的 `def` 路徑操作函式中,你可以直接存取 `UploadFile.file`,例如: + +```Python +contents = myfile.file.read() +``` + +/// note | `async` 技術細節 + +當你使用這些 `async` 方法時,**FastAPI** 會在執行緒池中執行對應的檔案方法並等待結果。 + +/// + +/// note | Starlette 技術細節 + +**FastAPI** 的 `UploadFile` 直接繼承自 **Starlette** 的 `UploadFile`,但新增了一些必要部分,使其與 **Pydantic** 及 FastAPI 其他部分相容。 + +/// + +## 什麼是「表單資料」 { #what-is-form-data } + +HTML 表單(`
`)送到伺服器的資料通常使用一種「特殊」編碼,與 JSON 不同。 + +**FastAPI** 會從正確的位置讀取該資料,而不是當作 JSON。 + +/// note | 技術細節 + +表單資料在不包含檔案時,通常使用媒體型別 `application/x-www-form-urlencoded` 編碼。 + +但當表單包含檔案時,會使用 `multipart/form-data` 編碼。若你使用 `File`,**FastAPI** 會知道要從請求本文的正確部分取得檔案。 + +若想進一步了解這些編碼與表單欄位,請參考 MDN Web Docs 的 POST。 + +/// + +/// warning + +你可以在一個路徑操作中宣告多個 `File` 與 `Form` 參數,但不能同時宣告預期以 JSON 接收的 `Body` 欄位,因為此請求的本文會使用 `multipart/form-data` 而不是 `application/json`。 + +這不是 **FastAPI** 的限制,而是 HTTP 協定本身的規範。 + +/// + +## 可選的檔案上傳 { #optional-file-upload } + +可透過一般型別註解並將預設值設為 `None` 使檔案成為可選: + +{* ../../docs_src/request_files/tutorial001_02_an_py310.py hl[9,17] *} + +## `UploadFile` 搭配額外中繼資料 { #uploadfile-with-additional-metadata } + +你也可以在 `UploadFile` 上搭配 `File()`,例如用來設定額外的中繼資料: + +{* ../../docs_src/request_files/tutorial001_03_an_py310.py hl[9,15] *} + +## 多檔案上傳 { #multiple-file-uploads } + +可以同時上傳多個檔案。 + +它們會同屬於以「表單資料」送出的同一個表單欄位。 + +要這麼做,將型別宣告為 `bytes` 或 `UploadFile` 的 `list`: + +{* ../../docs_src/request_files/tutorial002_an_py310.py hl[10,15] *} + +你會如宣告所示,收到由 `bytes` 或 `UploadFile` 組成的 `list`。 + +/// note | 技術細節 + +你也可以使用 `from starlette.responses import HTMLResponse`。 + +**FastAPI** 為了讓你(開發者)更方便,提供與 `starlette.responses` 相同的內容作為 `fastapi.responses`。但大多數可用的回應類型其實直接來自 Starlette。 + +/// + +### 多檔案上傳且包含額外中繼資料 { #multiple-file-uploads-with-additional-metadata } + +同樣地,即使對 `UploadFile`,你也可以用 `File()` 設定額外參數: + +{* ../../docs_src/request_files/tutorial003_an_py310.py hl[11,18:20] *} + +## 小結 { #recap } + +使用 `File`、`bytes` 與 `UploadFile` 來宣告請求中要上傳的檔案,這些檔案會以表單資料送出。 diff --git a/docs/zh-hant/docs/tutorial/request-form-models.md b/docs/zh-hant/docs/tutorial/request-form-models.md new file mode 100644 index 0000000000..8cf4a7c5e8 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/request-form-models.md @@ -0,0 +1,78 @@ +# 表單模型 { #form-models } + +你可以使用 **Pydantic 模型** 在 FastAPI 中宣告 **表單欄位**。 + +/// info | 說明 + +要使用表單,首先安裝 `python-multipart`。 + +請先建立[虛擬環境](../virtual-environments.md){.internal-link target=_blank}、啟用後再安裝,例如: + +```console +$ pip install python-multipart +``` + +/// + +/// note | 注意 + +此功能自 FastAPI 版本 `0.113.0` 起支援。🤓 + +/// + +## 針對表單的 Pydantic 模型 { #pydantic-models-for-forms } + +你只需要宣告一個 **Pydantic 模型**,包含你要接收為 **表單欄位** 的欄位,然後將參數宣告為 `Form`: + +{* ../../docs_src/request_form_models/tutorial001_an_py310.py hl[9:11,15] *} + +**FastAPI** 會從請求中的 **表單資料** 擷取 **各欄位** 的資料,並將這些資料組成你定義的 Pydantic 模型實例。 + +## 檢視文件 { #check-the-docs } + +你可以在 `/docs` 的文件 UI 中驗證: + +
+ +
+ +## 禁止額外的表單欄位 { #forbid-extra-form-fields } + +在某些特殊情況(可能不常見)下,你可能希望僅允許 Pydantic 模型中宣告的表單欄位,並禁止任何額外欄位。 + +/// note | 注意 + +此功能自 FastAPI 版本 `0.114.0` 起支援。🤓 + +/// + +你可以使用 Pydantic 的模型設定來 `forbid` 任何 `extra` 欄位: + +{* ../../docs_src/request_form_models/tutorial002_an_py310.py hl[12] *} + +如果用戶端嘗試傳送額外資料,將會收到錯誤回應。 + +例如,用戶端若送出以下表單欄位: + +* `username`: `Rick` +* `password`: `Portal Gun` +* `extra`: `Mr. Poopybutthole` + +他們會收到一個錯誤回應,告知欄位 `extra` 不被允許: + +```json +{ + "detail": [ + { + "type": "extra_forbidden", + "loc": ["body", "extra"], + "msg": "Extra inputs are not permitted", + "input": "Mr. Poopybutthole" + } + ] +} +``` + +## 摘要 { #summary } + +你可以使用 Pydantic 模型在 FastAPI 中宣告表單欄位。😎 diff --git a/docs/zh-hant/docs/tutorial/request-forms-and-files.md b/docs/zh-hant/docs/tutorial/request-forms-and-files.md new file mode 100644 index 0000000000..6dcc1c260f --- /dev/null +++ b/docs/zh-hant/docs/tutorial/request-forms-and-files.md @@ -0,0 +1,41 @@ +# 請求中的表單與檔案 { #request-forms-and-files } + +你可以使用 `File` 與 `Form` 同時定義檔案與表單欄位。 + +/// info + +要接收上傳的檔案與/或表單資料,請先安裝 `python-multipart`。 + +請先建立並啟用一個 [虛擬環境](../virtual-environments.md){.internal-link target=_blank},然後再安裝,例如: + +```console +$ pip install python-multipart +``` + +/// + +## 匯入 `File` 與 `Form` { #import-file-and-form } + +{* ../../docs_src/request_forms_and_files/tutorial001_an_py310.py hl[3] *} + +## 定義 `File` 與 `Form` 參數 { #define-file-and-form-parameters } + +以與 `Body` 或 `Query` 相同的方式建立檔案與表單參數: + +{* ../../docs_src/request_forms_and_files/tutorial001_an_py310.py hl[10:12] *} + +檔案與表單欄位會作為表單資料上傳,而你將能接收到這些檔案與欄位。 + +你也可以將部分檔案宣告為 `bytes`,另一些宣告為 `UploadFile`。 + +/// warning + +你可以在一個路徑操作 (path operation) 中宣告多個 `File` 與 `Form` 參數,但不能同時再宣告預期以 JSON 接收的 `Body` 欄位,因為該請求的本文會使用 `multipart/form-data` 而非 `application/json` 進行編碼。 + +這不是 **FastAPI** 的限制,這是 HTTP 通訊協定本身的規範。 + +/// + +## 小結 { #recap } + +當你需要在同一個請求中同時接收資料與檔案時,請搭配使用 `File` 與 `Form`。 diff --git a/docs/zh-hant/docs/tutorial/request-forms.md b/docs/zh-hant/docs/tutorial/request-forms.md new file mode 100644 index 0000000000..733a3e2869 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/request-forms.md @@ -0,0 +1,73 @@ +# 表單資料 { #form-data } + +當你需要接收表單欄位而不是 JSON 時,可以使用 `Form`。 + +/// info + +要使用表單,請先安裝 `python-multipart`。 + +請先建立並啟用一個[虛擬環境](../virtual-environments.md){.internal-link target=_blank},然後再安裝,例如: + +```console +$ pip install python-multipart +``` + +/// + +## 匯入 `Form` { #import-form } + +從 `fastapi` 匯入 `Form`: + +{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[3] *} + +## 定義 `Form` 參數 { #define-form-parameters } + +以與 `Body` 或 `Query` 相同的方式建立表單參數: + +{* ../../docs_src/request_forms/tutorial001_an_py310.py hl[9] *} + +例如,在 OAuth2 規範的一種用法(稱為「password flow」)中,必須以表單欄位傳送 `username` 與 `password`。 + +該 規範 要求欄位名稱必須正好是 `username` 和 `password`,而且必須以表單欄位傳送,而不是 JSON。 + +使用 `Form` 時,你可以宣告與 `Body`(以及 `Query`、`Path`、`Cookie`)相同的設定,包括驗證、範例、別名(例如用 `user-name` 取代 `username`)等。 + +/// info + +`Form` 是一個直接繼承自 `Body` 的類別。 + +/// + +/// tip + +要宣告表單的請求本文,你需要明確使用 `Form`,否則這些參數會被解讀為查詢參數或請求本文(JSON)參數。 + +/// + +## 關於「表單欄位」 { #about-form-fields } + +HTML 表單(`
`)向伺服器傳送資料時,通常會使用一種「特殊」的編碼方式,與 JSON 不同。 + +**FastAPI** 會從正確的位置讀取那些資料,而不是從 JSON。 + +/// note | 技術細節 + +表單資料通常會使用「媒體類型」`application/x-www-form-urlencoded` 進行編碼。 + +但當表單包含檔案時,會使用 `multipart/form-data`。你會在下一章閱讀如何處理檔案。 + +若想進一步了解這些編碼與表單欄位,請參考 MDNPOST 網頁文件。 + +/// + +/// warning + +你可以在一個 *路徑操作(path operation)* 中宣告多個 `Form` 參數,但不能同時再宣告期望以 JSON 接收的 `Body` 欄位,因為該請求的本文會使用 `application/x-www-form-urlencoded` 編碼,而不是 `application/json`。 + +這不是 **FastAPI** 的限制,而是 HTTP 協定本身的規定。 + +/// + +## 回顧 { #recap } + +使用 `Form` 來宣告表單資料的輸入參數。 diff --git a/docs/zh-hant/docs/tutorial/response-model.md b/docs/zh-hant/docs/tutorial/response-model.md new file mode 100644 index 0000000000..d22402e180 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/response-model.md @@ -0,0 +1,343 @@ +# 回應模型 - 回傳型別 { #response-model-return-type } + +你可以在「路徑操作函式」的回傳型別上加上註解,宣告用於回應的型別。 + +你可以像在函式「參數」的輸入資料那樣使用型別註解,你可以使用 Pydantic 模型、list、dictionary、整數、布林等純量值。 + +{* ../../docs_src/response_model/tutorial001_01_py310.py hl[16,21] *} + +FastAPI 會使用這個回傳型別來: + +* 驗證回傳的資料。 + * 如果資料無效(例如缺少欄位),代表你的應用程式程式碼有問題,沒有回傳應該回傳的內容,FastAPI 會回傳伺服器錯誤,而不是回傳不正確的資料。如此你和你的用戶端都能確定會收到預期的資料與資料結構。 +* 在 OpenAPI 的「路徑操作」中為回應新增 JSON Schema。 + * 這會被自動文件使用。 + * 也會被自動用戶端程式碼產生工具使用。 + +但更重要的是: + +* 它會將輸出資料限制並過濾為回傳型別中定義的內容。 + * 這對安全性特別重要,下面會再看到更多細節。 + +## `response_model` 參數 { #response-model-parameter } + +有些情況下,你需要或想要回傳的資料與你宣告的型別不完全相同。 + +例如,你可能想要回傳一個 dictionary 或資料庫物件,但把回應宣告為一個 Pydantic 模型。這樣 Pydantic 模型就會替你回傳的物件(例如 dictionary 或資料庫物件)處理所有的資料文件、驗證等。 + +如果你加了回傳型別註解,工具與編輯器會(正確地)抱怨你的函式回傳的型別(例如 dict)與你宣告的(例如 Pydantic 模型)不同。 + +在這些情況下,你可以使用「路徑操作裝飾器」參數 `response_model`,而不是函式的回傳型別。 + +你可以在任何「路徑操作」上使用 `response_model` 參數: + +* `@app.get()` +* `@app.post()` +* `@app.put()` +* `@app.delete()` +* 等等。 + +{* ../../docs_src/response_model/tutorial001_py310.py hl[17,22,24:27] *} + +/// note | 注意 + +注意 `response_model` 是「裝飾器」方法(`get`、`post` 等)的參數。不是你的「路徑操作函式」的參數(像其他參數與請求主體那樣)。 + +/// + +`response_model` 接受的型別與你在 Pydantic 模型欄位中宣告的相同,所以它可以是一個 Pydantic 模型,也可以是例如由 Pydantic 模型組成的 `list`,像是 `List[Item]`。 + +FastAPI 會使用這個 `response_model` 來做所有的資料文件、驗證等,並且也會將輸出資料轉換與過濾為其型別宣告。 + +/// tip | 提示 + +如果你在編輯器、mypy 等中有嚴格型別檢查,你可以把函式回傳型別宣告為 `Any`。 + +這樣你是在告訴編輯器你是刻意回傳任意型別。但 FastAPI 仍會用 `response_model` 做資料文件、驗證、過濾等。 + +/// + +### `response_model` 優先權 { #response-model-priority } + +如果同時宣告了回傳型別與 `response_model`,`response_model` 會有優先權並由 FastAPI 使用。 + +如此一來,即便你回傳的實際型別與回應模型不同,你仍可在函式上加上正確的型別註解,供編輯器與如 mypy 的工具使用。同時仍由 FastAPI 使用 `response_model` 做資料驗證、文件化等。 + +你也可以使用 `response_model=None` 來停用該「路徑操作」的回應模型產生;當你為不是有效 Pydantic 欄位的東西加上型別註解時,可能需要這麼做,你會在下方某節看到範例。 + +## 回傳與輸入相同的資料 { #return-the-same-input-data } + +這裡我們宣告一個 `UserIn` 模型,其中會包含明文密碼: + +{* ../../docs_src/response_model/tutorial002_py310.py hl[7,9] *} + +/// info | 說明 + +要使用 `EmailStr`,請先安裝 `email-validator`。 + +請先建立一個[虛擬環境](../virtual-environments.md){.internal-link target=_blank}、啟用它,然後安裝,例如: + +```console +$ pip install email-validator +``` + +或: + +```console +$ pip install "pydantic[email]" +``` + +/// + +而我們使用這個模型同時宣告輸入與輸出: + +{* ../../docs_src/response_model/tutorial002_py310.py hl[16] *} + +現在,當瀏覽器建立一個帶有密碼的使用者時,API 會在回應中回傳相同的密碼。 + +在這個例子中可能不是問題,因為是同一個使用者送出該密碼。 + +但如果我們對其他「路徑操作」使用相同的模型,我們可能會把使用者密碼送給所有用戶端。 + +/// danger | 警告 + +除非你非常清楚所有影響並確定自己在做什麼,否則永遠不要儲存使用者的明文密碼,也不要像這樣在回應中傳送。 + +/// + +## 新增一個輸出模型 { #add-an-output-model } + +我們可以改為建立一個包含明文密碼的輸入模型,以及一個不含密碼的輸出模型: + +{* ../../docs_src/response_model/tutorial003_py310.py hl[9,11,16] *} + +在這裡,雖然「路徑操作函式」回傳的是同一個包含密碼的輸入使用者: + +{* ../../docs_src/response_model/tutorial003_py310.py hl[24] *} + +...我們把 `response_model` 宣告為不包含密碼的 `UserOut` 模型: + +{* ../../docs_src/response_model/tutorial003_py310.py hl[22] *} + +因此,FastAPI 會負責(透過 Pydantic)過濾掉輸出模型中未宣告的所有資料。 + +### `response_model` 或回傳型別 { #response-model-or-return-type } + +在這種情況下,因為兩個模型不同,如果我們把函式回傳型別註解為 `UserOut`,編輯器和工具會抱怨我們回傳了無效的型別,因為它們是不同的類別。 + +這就是為什麼在這個例子中我們必須在 `response_model` 參數中宣告它。 + +...但繼續往下讀看看如何克服這個問題。 + +## 回傳型別與資料過濾 { #return-type-and-data-filtering } + +讓我們延續前一個範例。我們想要用一種型別來註解函式,但實際上希望能夠從函式回傳包含更多資料的內容。 + +我們希望 FastAPI 仍然用回應模型來過濾資料。這樣即使函式回傳更多資料,回應中也只會包含回應模型中宣告的欄位。 + +在前一個例子中,因為類別不同,我們必須使用 `response_model` 參數。但這也代表我們失去了編輯器與工具對函式回傳型別的檢查支援。 + +不過在大多數需要這樣做的情況下,我們只是想要像這個例子一樣,讓模型過濾/移除部分資料。 + +在這些情況下,我們可以利用類別與繼承,搭配函式的型別註解,取得更好的編輯器與工具支援,同時仍能讓 FastAPI 做資料過濾。 + +{* ../../docs_src/response_model/tutorial003_01_py310.py hl[7:10,13:14,18] *} + +這樣我們能得到工具支援,對於編輯器與 mypy 來說,這段程式碼在型別上是正確的,同時我們也能得到 FastAPI 的資料過濾。 + +這是怎麼運作的?來看一下。🤓 + +### 型別註解與工具支援 { #type-annotations-and-tooling } + +先看看編輯器、mypy 與其他工具會怎麼看這件事。 + +`BaseUser` 有基礎欄位。然後 `UserIn` 繼承自 `BaseUser` 並新增 `password` 欄位,因此它會包含兩個模型的所有欄位。 + +我們把函式回傳型別註解為 `BaseUser`,但實際上回傳的是 `UserIn` 實例。 + +編輯器、mypy 與其他工具不會抱怨,因為就型別學而言,`UserIn` 是 `BaseUser` 的子類別,這代表當預期任何 `BaseUser` 時,`UserIn` 是一個有效的型別。 + +### FastAPI 的資料過濾 { #fastapi-data-filtering } + +對 FastAPI 而言,它會查看回傳型別,並確保你回傳的內容只包含該型別中宣告的欄位。 + +FastAPI 在內部會搭配 Pydantic 做一些事情,來確保不會把類別繼承的那些規則直接用在回傳資料的過濾上,否則你可能會回傳比預期更多的資料。 + +如此,你就能同時擁有兩種好處:具備工具支援的型別註解,以及資料過濾。 + +## 在文件中查看 { #see-it-in-the-docs } + +在自動文件中,你可以看到輸入模型與輸出模型各自都有自己的 JSON Schema: + + + +而且兩個模型都會用在互動式 API 文件中: + + + +## 其他回傳型別註解 { #other-return-type-annotations } + +有時你回傳的東西不是有效的 Pydantic 欄位,你仍會在函式上加上註解,只為了獲得工具(編輯器、mypy 等)提供的支援。 + +### 直接回傳 Response { #return-a-response-directly } + +最常見的情況是[直接回傳 Response(在進階文件中稍後會解釋)](../advanced/response-directly.md){.internal-link target=_blank}。 + +{* ../../docs_src/response_model/tutorial003_02_py310.py hl[8,10:11] *} + +這個簡單情境會由 FastAPI 自動處理,因為回傳型別註解是 `Response` 類別(或其子類別)。 + +而工具也會滿意,因為 `RedirectResponse` 與 `JSONResponse` 都是 `Response` 的子類別,所以型別註解是正確的。 + +### 註解為某個 Response 的子類別 { #annotate-a-response-subclass } + +你也可以在型別註解中使用 `Response` 的子類別: + +{* ../../docs_src/response_model/tutorial003_03_py310.py hl[8:9] *} + +這同樣可行,因為 `RedirectResponse` 是 `Response` 的子類別,而 FastAPI 會自動處理這種簡單情況。 + +### 無效的回傳型別註解 { #invalid-return-type-annotations } + +但當你回傳其他任意物件(例如資料庫物件),它不是有效的 Pydantic 型別,並且你在函式上也這樣註解時,FastAPI 會嘗試從該型別註解建立一個 Pydantic 回應模型,因而失敗。 + +如果你有像是多種型別的聯集,其中一個或多個不是有效的 Pydantic 型別,也會發生相同的事情,例如這個就會失敗 💥: + +{* ../../docs_src/response_model/tutorial003_04_py310.py hl[8] *} + +...這會失敗,因為該型別註解不是 Pydantic 型別,且它也不只是一個單一的 `Response` 類別或其子類別,而是 `Response` 與 `dict` 的聯集(兩者任一)。 + +### 停用回應模型 { #disable-response-model } + +延續上面的例子,你可能不想要 FastAPI 執行預設的資料驗證、文件化、過濾等動作。 + +但你可能仍想在函式上保留回傳型別註解,以獲得編輯器與型別檢查工具(例如 mypy)的支援。 + +這種情況下,你可以設定 `response_model=None` 來停用回應模型的產生: + +{* ../../docs_src/response_model/tutorial003_05_py310.py hl[7] *} + +這會讓 FastAPI 略過回應模型的產生,如此你就能使用任何你需要的回傳型別註解,而不會影響你的 FastAPI 應用程式。🤓 + +## 回應模型編碼參數 { #response-model-encoding-parameters } + +你的回應模型可能有預設值,例如: + +{* ../../docs_src/response_model/tutorial004_py310.py hl[9,11:12] *} + +* `description: Union[str, None] = None`(或在 Python 3.10 中的 `str | None = None`)預設為 `None`。 +* `tax: float = 10.5` 預設為 `10.5`。 +* `tags: List[str] = []` 預設為空的 list:`[]`。 + +但如果這些值其實沒有被儲存,你可能想要在結果中省略它們。 + +例如,如果你在 NoSQL 資料庫中有包含許多選擇性屬性的模型,但你不想傳送充滿預設值的冗長 JSON 回應。 + +### 使用 `response_model_exclude_unset` 參數 { #use-the-response-model-exclude-unset-parameter } + +你可以在「路徑操作裝飾器」上設定 `response_model_exclude_unset=True`: + +{* ../../docs_src/response_model/tutorial004_py310.py hl[22] *} + +如此這些預設值就不會被包含在回應中,只有實際被設定的值才會包含。 + +因此,如果你對該「路徑操作」發送針對 ID 為 `foo` 的項目的請求,回應(不包含預設值)會是: + +```JSON +{ + "name": "Foo", + "price": 50.2 +} +``` + +/// info | 說明 + +你也可以使用: + +* `response_model_exclude_defaults=True` +* `response_model_exclude_none=True` + +如 Pydantic 文件中對 `exclude_defaults` 與 `exclude_none` 的說明。 + +/// + +#### 對於有預設值欄位也有實際值的資料 { #data-with-values-for-fields-with-defaults } + +但如果你的資料在模型中對於有預設值的欄位也有實際值,例如 ID 為 `bar` 的項目: + +```Python hl_lines="3 5" +{ + "name": "Bar", + "description": "The bartenders", + "price": 62, + "tax": 20.2 +} +``` + +它們會被包含在回應中。 + +#### 與預設值相同的資料 { #data-with-the-same-values-as-the-defaults } + +如果資料的值與預設值相同,例如 ID 為 `baz` 的項目: + +```Python hl_lines="3 5-6" +{ + "name": "Baz", + "description": None, + "price": 50.2, + "tax": 10.5, + "tags": [] +} +``` + +FastAPI 足夠聰明(其實是 Pydantic 足夠聰明)去判斷,儘管 `description`、`tax` 與 `tags` 的值與預設值相同,但它們是被明確設定的(而不是取自預設值)。 + +因此,它們會被包含在 JSON 回應中。 + +/// tip | 提示 + +注意預設值可以是任何東西,不只有 `None`。 + +它們可以是一個 list(`[]`)、一個 `float` 的 `10.5`,等等。 + +/// + +### `response_model_include` 與 `response_model_exclude` { #response-model-include-and-response-model-exclude } + +你也可以使用「路徑操作裝飾器」參數 `response_model_include` 與 `response_model_exclude`。 + +它們接受一個由屬性名稱字串所組成的 `set`,分別用來包含(省略其他)或排除(包含其他)屬性。 + +如果你只有一個 Pydantic 模型並且想從輸出移除部分資料,這可以作為一個快速捷徑。 + +/// tip | 提示 + +但仍建議使用上面提到的作法,使用多個類別,而不是這些參數。 + +因為在你的應用程式 OpenAPI(與文件)中所產生的 JSON Schema 仍會是完整模型的,即便你使用 `response_model_include` 或 `response_model_exclude` 省略了一些屬性。 + +`response_model_by_alias` 也有類似的情況。 + +/// + +{* ../../docs_src/response_model/tutorial005_py310.py hl[29,35] *} + +/// tip | 提示 + +語法 `{"name", "description"}` 會建立一個包含這兩個值的 `set`。 + +它等同於 `set(["name", "description"])`。 + +/// + +#### 使用 `list` 來代替 `set` { #using-lists-instead-of-sets } + +如果你忘了使用 `set` 而用了 `list` 或 `tuple`,FastAPI 仍會把它轉換成 `set`,並能正確運作: + +{* ../../docs_src/response_model/tutorial006_py310.py hl[29,35] *} + +## 重點回顧 { #recap } + +使用「路徑操作裝飾器」的 `response_model` 參數來定義回應模型,特別是為了確保私有資料被過濾掉。 + +使用 `response_model_exclude_unset` 僅回傳被明確設定的值。 diff --git a/docs/zh-hant/docs/tutorial/response-status-code.md b/docs/zh-hant/docs/tutorial/response-status-code.md new file mode 100644 index 0000000000..cbcc67ca55 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/response-status-code.md @@ -0,0 +1,101 @@ +# 回應狀態碼 { #response-status-code } + +就像你可以指定回應模型一樣,你也可以在任一個「路徑操作(path operation)」的參數 `status_code` 中宣告回應所使用的 HTTP 狀態碼: + +* `@app.get()` +* `@app.post()` +* `@app.put()` +* `@app.delete()` +* 等等 + +{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *} + +/// note | 注意 + +請注意,`status_code` 是「裝飾器(decorator)」方法(`get`、`post` 等等)的參數,而不是你的「路徑操作函式」的參數,就像所有的參數與 body 一樣。 + +/// + +參數 `status_code` 接受一個數字作為 HTTP 狀態碼。 + +/// info | 資訊 + +`status_code` 也可以接收一個 `IntEnum`,例如 Python 的 `http.HTTPStatus`。 + +/// + +它會: + +* 在回應中傳回該狀態碼。 +* 在 OpenAPI 結構中如此記錄(因此也會反映在使用者介面中): + + + +/// note | 注意 + +有些回應碼(見下一節)表示回應不包含本文(body)。 + +FastAPI 知道這點,並會產生聲明「無回應本文」的 OpenAPI 文件。 + +/// + +## 關於 HTTP 狀態碼 { #about-http-status-codes } + +/// note | 注意 + +如果你已經知道什麼是 HTTP 狀態碼,可以直接跳到下一節。 + +/// + +在 HTTP 中,你會在回應的一部分傳回 3 位數的狀態碼。 + +這些狀態碼有對應的名稱以便辨識,但重點是數字本身。 + +簡而言之: + +* `100 - 199` 表示「資訊」。你很少會直接使用它們。這些狀態碼的回應不可包含本文。 +* **`200 - 299`** 表示「成功」。這是你最常使用的一組。 + * `200` 是預設狀態碼,表示一切「OK」。 + * 另一個例子是 `201`,代表「已建立」。常用於在資料庫中建立新紀錄之後。 + * 一個特殊情況是 `204`,代表「無內容」。當沒有內容要回傳給用戶端時使用,因此回應不得有本文。 +* **`300 - 399`** 表示「重新導向」。這些狀態碼的回應可能有或沒有本文,唯獨 `304`(「未修改」)必須沒有本文。 +* **`400 - 499`** 表示「用戶端錯誤」。這大概是你第二常用的一組。 + * 例如 `404`,代表「找不到」。 + * 對於一般性的用戶端錯誤,你可以使用 `400`。 +* `500 - 599` 表示伺服器錯誤。你幾乎不會直接使用它們。當你的應用程式或伺服器某處出錯時,會自動回傳其中一個狀態碼。 + +/// tip | 提示 + +想深入瞭解各狀態碼與其用途,請參考 MDN 關於 HTTP 狀態碼的文件。 + +/// + +## 快速記住名稱 { #shortcut-to-remember-the-names } + +再看一次前面的範例: + +{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *} + +`201` 是「已建立(Created)」的狀態碼。 + +但你不需要背下每個代碼代表什麼。 + +你可以使用 `fastapi.status` 提供的便利變數。 + +{* ../../docs_src/response_status_code/tutorial002_py310.py hl[1,6] *} + +它們只是方便用的常數,值與數字相同,但這樣你可以用編輯器的自動完成來找到它們: + + + +/// note | 技術細節 + +你也可以使用 `from starlette import status`。 + +**FastAPI** 將同一個 `starlette.status` 以 `fastapi.status` 形式提供,純粹是為了讓你(開發者)方便。但它直接來自 Starlette。 + +/// + +## 變更預設值 { #changing-the-default } + +稍後在 [進階使用者指南](../advanced/response-change-status-code.md){.internal-link target=_blank} 中,你會看到如何回傳一個不同於此處所宣告預設值的狀態碼。 diff --git a/docs/zh-hant/docs/tutorial/schema-extra-example.md b/docs/zh-hant/docs/tutorial/schema-extra-example.md new file mode 100644 index 0000000000..661938ac26 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/schema-extra-example.md @@ -0,0 +1,202 @@ +# 宣告請求範例資料 { #declare-request-example-data } + +你可以宣告你的應用程式可接收資料的 examples。 + +以下有數種方式可達成。 + +## Pydantic 模型中的額外 JSON Schema 資料 { #extra-json-schema-data-in-pydantic-models } + +你可以為 Pydantic 模型宣告 `examples`,它們會加入到產生出的 JSON Schema 中。 + +{* ../../docs_src/schema_extra_example/tutorial001_py310.py hl[13:24] *} + +這些額外資訊會原封不動加入該模型輸出的 JSON Schema,並且會用在 API 文件裡。 + +你可以使用屬性 `model_config`(接收一個 `dict`),詳見 Pydantic 文件:Configuration。 + +你可以將 `"json_schema_extra"` 設為一個 `dict`,其中包含你想在產生的 JSON Schema 中出現的任何額外資料,包括 `examples`。 + +/// tip + +你可以用相同技巧擴充 JSON Schema,加入你自己的自訂額外資訊。 + +例如,你可以用它為前端使用者介面新增中繼資料等。 + +/// + +/// info + +OpenAPI 3.1.0(自 FastAPI 0.99.0 起使用)新增了對 `examples` 的支援,這是 **JSON Schema** 標準的一部分。 + +在那之前,只支援使用單一範例的關鍵字 `example`。OpenAPI 3.1.0 仍然支援 `example`,但它已被棄用,且不是 JSON Schema 標準的一部分。因此建議你將 `example` 遷移為 `examples`。🤓 + +你可以在本頁結尾閱讀更多。 + +/// + +## `Field` 其他參數 { #field-additional-arguments } + +在 Pydantic 模型中使用 `Field()` 時,你也可以宣告額外的 `examples`: + +{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *} + +## JSON Schema 的 `examples` - OpenAPI { #examples-in-json-schema-openapi } + +當使用下列任一項: + +* `Path()` +* `Query()` +* `Header()` +* `Cookie()` +* `Body()` +* `Form()` +* `File()` + +你也可以宣告一組 `examples`,包含會加入到 **OpenAPI** 中它們各自 **JSON Schemas** 的額外資訊。 + +### `Body` 搭配 `examples` { #body-with-examples } + +這裡我們傳入 `examples`,其中包含 `Body()` 預期資料的一個範例: + +{* ../../docs_src/schema_extra_example/tutorial003_an_py310.py hl[22:29] *} + +### 文件 UI 中的範例 { #example-in-the-docs-ui } + +使用以上任一方法,在 `/docs` 中看起來會像這樣: + + + +### `Body` 搭配多個 `examples` { #body-with-multiple-examples } + +當然,你也可以傳入多個 `examples`: + +{* ../../docs_src/schema_extra_example/tutorial004_an_py310.py hl[23:38] *} + +這麼做時,這些範例會成為該 body 資料內部 **JSON Schema** 的一部分。 + +然而,撰寫本文時,負責呈現文件 UI 的工具 Swagger UI 並不支援在 **JSON Schema** 中顯示多個範例。不過請繼續往下閱讀以取得變通方式。 + +### OpenAPI 特定的 `examples` { #openapi-specific-examples } + +在 **JSON Schema** 支援 `examples` 之前,OpenAPI 就已支援另一個同名的欄位 `examples`。 + +這個「OpenAPI 特定」的 `examples` 位於 OpenAPI 規範的另一個區塊:在每個「路徑操作」的詳細資訊中,而不是在各個 JSON Schema 內。 + +而 Swagger UI 早已支援這個欄位,因此你可以用它在文件 UI 中顯示不同的範例。 + +這個 OpenAPI 特定欄位 `examples` 的結構是一個包含「多個範例」的 `dict`(而非 `list`),每個範例都可包含會一併加入到 **OpenAPI** 的額外資訊。 + +它不會出現在 OpenAPI 所含的各個 JSON Schema 內,而是直接放在對應的「路徑操作」上。 + +### 使用 `openapi_examples` 參數 { #using-the-openapi-examples-parameter } + +你可以在 FastAPI 中透過參數 `openapi_examples` 為下列項目宣告 OpenAPI 特定的 `examples`: + +* `Path()` +* `Query()` +* `Header()` +* `Cookie()` +* `Body()` +* `Form()` +* `File()` + +該 `dict` 的鍵用來識別各個範例,而每個值則是另一個 `dict`。 + +在 `examples` 中,每個範例的 `dict` 可以包含: + +* `summary`:範例的簡短描述。 +* `description`:較長的描述,可包含 Markdown 文字。 +* `value`:實際顯示的範例,例如一個 `dict`。 +* `externalValue`:`value` 的替代方案,為指向範例的 URL。儘管這可能不如 `value` 被工具廣泛支援。 + +你可以這樣使用: + +{* ../../docs_src/schema_extra_example/tutorial005_an_py310.py hl[23:49] *} + +### 文件 UI 中的 OpenAPI 範例 { #openapi-examples-in-the-docs-ui } + +當在 `Body()` 加上 `openapi_examples`,`/docs` 會顯示為: + + + +## 技術細節 { #technical-details } + +/// tip + +如果你已經在使用 **FastAPI** **0.99.0 或以上**的版本,大概可以略過這些細節。 + +這些內容比較與舊版(在 OpenAPI 3.1.0 可用之前)相關。 + +你可以把這段當作一小堂 OpenAPI 與 JSON Schema 的歷史課。🤓 + +/// + +/// warning + +以下是關於 **JSON Schema** 與 **OpenAPI** 標準的技術細節。 + +如果上面的做法對你已經足夠可用,就不需要這些細節,儘管直接跳過。 + +/// + +在 OpenAPI 3.1.0 之前,OpenAPI 使用的是較舊且經過修改的 **JSON Schema** 版本。 + +當時 JSON Schema 沒有 `examples`,因此 OpenAPI 在它自訂修改的版本中新增了自己的 `example` 欄位。 + +OpenAPI 也在規範的其他部分新增了 `example` 與 `examples` 欄位: + +* `Parameter Object`(規範),對應到 FastAPI 的: + * `Path()` + * `Query()` + * `Header()` + * `Cookie()` +* `Request Body Object` 中的 `content` 欄位裡的 `Media Type Object`(規範),對應到 FastAPI 的: + * `Body()` + * `File()` + * `Form()` + +/// info + +這個舊的、OpenAPI 特定的 `examples` 參數,從 FastAPI `0.103.0` 起改名為 `openapi_examples`。 + +/// + +### JSON Schema 的 `examples` 欄位 { #json-schemas-examples-field } + +後來 JSON Schema 在新版本規範中新增了 `examples` 欄位。 + +接著新的 OpenAPI 3.1.0 以最新版本(JSON Schema 2020-12)為基礎,該版本就包含這個新的 `examples` 欄位。 + +現在這個新的 `examples` 欄位優先於舊的單一(且客製)`example` 欄位,後者已被棄用。 + +JSON Schema 中新的 `examples` 欄位「就是一個 `list`」的範例集合,而不是像 OpenAPI 其他地方(如上所述)那樣附帶額外中繼資料的 `dict`。 + +/// info + +即使 OpenAPI 3.1.0 已發佈並與 JSON Schema 有更簡潔的整合,一段時間內提供自動文件的 Swagger UI 並不支援 OpenAPI 3.1.0(自 5.0.0 版起支援 🎉)。 + +因此,FastAPI 0.99.0 之前的版本仍使用 3.1.0 以下的 OpenAPI 版本。 + +/// + +### Pydantic 與 FastAPI 的 `examples` { #pydantic-and-fastapi-examples } + +當你在 Pydantic 模型中加入 `examples`,不論是用 `schema_extra` 或 `Field(examples=["something"])`,該範例都會被加入該 Pydantic 模型的 **JSON Schema**。 + +而該 Pydantic 模型的 **JSON Schema** 會被包含到你的 API 的 **OpenAPI** 中,接著用於文件 UI。 + +在 FastAPI 0.99.0 之前的版本(0.99.0 起使用較新的 OpenAPI 3.1.0)中,當你對其他工具(`Query()`、`Body()` 等)使用 `example` 或 `examples` 時,這些範例不會被加入描述該資料的 JSON Schema(甚至不會加入到 OpenAPI 自己版本的 JSON Schema 中),而是直接加入到 OpenAPI 中的「路徑操作」宣告(在 OpenAPI 使用 JSON Schema 的那些部分之外)。 + +但現在 FastAPI 0.99.0 以上使用的 OpenAPI 3.1.0 搭配 JSON Schema 2020-12,以及 Swagger UI 5.0.0 以上版本,整體更加一致,範例會包含在 JSON Schema 中。 + +### Swagger UI 與 OpenAPI 特定的 `examples` { #swagger-ui-and-openapi-specific-examples } + +由於在(2023-08-26 時)Swagger UI 不支援多個 JSON Schema 範例,使用者無法在文件中顯示多個範例。 + +為了解決此問題,FastAPI `0.103.0` 透過新參數 `openapi_examples` **新增支援** 宣告舊的「OpenAPI 特定」`examples` 欄位。🤓 + +### 總結 { #summary } + +我以前常說我不太喜歡歷史……結果現在在這裡講「科技史」。😅 + +簡而言之,**升級到 FastAPI 0.99.0 或以上**,事情會更**簡單、一致又直覺**,而且你不需要了解這些歷史細節。😎 diff --git a/docs/zh-hant/docs/tutorial/security/first-steps.md b/docs/zh-hant/docs/tutorial/security/first-steps.md new file mode 100644 index 0000000000..109f59a37a --- /dev/null +++ b/docs/zh-hant/docs/tutorial/security/first-steps.md @@ -0,0 +1,203 @@ +# 安全性 - 入門 { #security-first-steps } + +想像你有一個部署在某個網域的後端 API。 + +還有一個前端在另一個網域,或同一網域的不同路徑(或是行動應用程式)。 + +你希望前端能用使用者名稱與密碼向後端進行身分驗證。 + +我們可以用 OAuth2 搭配 FastAPI 來實作。 + +但不必通讀整份冗長規格只為了找出你需要的幾個重點。 + +就用 FastAPI 提供的工具處理安全性。 + +## 看起來如何 { #how-it-looks } + +先直接跑範例看效果,再回頭理解其原理。 + +## 建立 `main.py` { #create-main-py } + +將範例複製到檔案 `main.py`: + +{* ../../docs_src/security/tutorial001_an_py310.py *} + +## 執行 { #run-it } + +/// info + +當你使用 `pip install "fastapi[standard]"` 指令安裝時,`python-multipart` 套件會隨 FastAPI 自動安裝。 + +不過若只執行 `pip install fastapi`,預設不會包含 `python-multipart`。 + +若要手動安裝,請先建立並啟用一個[虛擬環境](../../virtual-environments.md){.internal-link target=_blank},接著執行: + +```console +$ pip install python-multipart +``` + +因為 OAuth2 會以「form data」傳送 `username` 與 `password`。 + +/// + +用以下指令執行範例: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +## 檢查 { #check-it } + +開啟互動式文件:http://127.0.0.1:8000/docs。 + +你會看到類似這樣: + + + +/// check | Authorize 按鈕! + +你會看到一個新的「Authorize」按鈕。 + +而你的「路徑操作」右上角也會出現一個小鎖頭可以點擊。 + +/// + +點擊後會跳出一個小視窗,讓你輸入 `username` 與 `password`(以及其他可選欄位): + + + +/// note | 注意 + +不管你在表單輸入什麼,現在都還不會成功;等等我們會把它完成。 + +/// + +這當然不是給最終使用者用的前端,但它是用來互動式文件化整個 API 的極佳自動化工具。 + +前端團隊(也可能就是你)可以使用它。 + +第三方應用或系統也能使用它。 + +你也能用它來除錯、檢查與測試同一個應用。 + +## `password` 流程 { #the-password-flow } + +現在回頭理解剛剛那些是什麼。 + +在 OAuth2 中,`password` 是處理安全與身分驗證的其中一種「流程」(flow)。 + +OAuth2 的設計讓後端或 API 可以獨立於執行使用者驗證的伺服器。 + +但在這個例子中,同一個 FastAPI 應用會同時處理 API 與驗證。 + +簡化來看流程如下: + +- 使用者在前端輸入 `username` 與 `password`,按下 `Enter`。 +- 前端(在使用者的瀏覽器中執行)把 `username` 與 `password` 傳到我們 API 的特定 URL(在程式中宣告為 `tokenUrl="token"`)。 +- API 檢查 `username` 與 `password`,並回傳一個「token(權杖)」(我們還沒實作這部分)。 + - 「token(權杖)」就是一段字串,之後可用來識別並驗證此使用者。 + - 通常 token 會設定一段時間後失效。 + - 因此使用者之後需要重新登入。 + - 若 token 被竊取,風險也較低;它不像永遠有效的萬用鑰匙(多數情況下)。 +- 前端會暫存這個 token。 +- 使用者在前端點擊前往其他頁面/區段。 +- 前端需要再向 API 取得資料。 + - 但該端點需要驗證。 + - 因此為了向 API 驗證,請求會帶上一個 `Authorization` 標頭,值為 `Bearer ` 加上 token。 + - 例如 token 是 `foobar`,則 `Authorization` 標頭內容為:`Bearer foobar`。 + +## FastAPI 的 `OAuth2PasswordBearer` { #fastapis-oauth2passwordbearer } + +FastAPI 提供多層抽象的工具來實作這些安全機制。 + +本例將使用 OAuth2 的 Password 流程,並以 Bearer token 進行驗證;我們會用 `OAuth2PasswordBearer` 類別來完成。 + +/// info + +「Bearer」token 不是唯一選項。 + +但對本例最合適。 + +通常對多數情境也足夠,除非你是 OAuth2 專家並確信有更適合你的選項。 + +在那種情況下,FastAPI 也提供相應工具讓你自行組合。 + +/// + +當我們建立 `OAuth2PasswordBearer` 類別的實例時,會傳入 `tokenUrl` 參數。這個參數包含了客戶端(在使用者瀏覽器中執行的前端)用來送出 `username` 與 `password` 以取得 token 的 URL。 + +{* ../../docs_src/security/tutorial001_an_py310.py hl[8] *} + +/// tip + +這裡的 `tokenUrl="token"` 指的是尚未建立的相對 URL `token`。因為是相對 URL,所以等同於 `./token`。 + +由於使用了相對 URL,若你的 API 位於 `https://example.com/`,那它會指向 `https://example.com/token`;但若你的 API 位於 `https://example.com/api/v1/`,那它會指向 `https://example.com/api/v1/token`。 + +使用相對 URL 很重要,能確保你的應用在像是[在 Proxy 後方](../../advanced/behind-a-proxy.md){.internal-link target=_blank}這類進階情境中仍能正常運作。 + +/// + +這個參數不會建立該端點/「路徑操作」,而是宣告 `/token` 將是客戶端用來取得 token 的 URL。這些資訊會出現在 OpenAPI,並被互動式 API 文件系統使用。 + +我們很快也會建立實際的路徑操作。 + +/// info + +如果你是非常嚴格的「Pythonista」,可能不喜歡參數名稱用 `tokenUrl` 而不是 `token_url`。 + +那是因為它沿用了 OpenAPI 規格中的名稱。如此一來,若你要深入查閱這些安全方案,便能直接複製貼上去搜尋更多資訊。 + +/// + +變數 `oauth2_scheme` 是 `OAuth2PasswordBearer` 的實例,但同時它也是「可呼叫的」(callable)。 + +它可以這樣被呼叫: + +```Python +oauth2_scheme(some, parameters) +``` + +因此它可以配合 `Depends` 使用。 + +### 如何使用 { #use-it } + +現在你可以在相依性中傳入 `oauth2_scheme` 與 `Depends` 搭配。 + +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} + +此相依性會提供一個 `str`,指派給「路徑操作函式」的參數 `token`。 + +FastAPI 會知道可以使用這個相依性,在 OpenAPI(以及自動產生的 API 文件)中定義一個「安全性方案」。 + +/// info | 技術細節 + +FastAPI 之所以知道可以用(相依性中宣告的)`OAuth2PasswordBearer` 類別,在 OpenAPI 中定義安全性方案,是因為它繼承自 `fastapi.security.oauth2.OAuth2`,而後者又繼承自 `fastapi.security.base.SecurityBase`。 + +所有能與 OpenAPI(以及自動 API 文件)整合的安全工具都繼承自 `SecurityBase`,FastAPI 才能知道如何把它們整合進 OpenAPI。 + +/// + +## 它做了什麼 { #what-it-does } + +它會從請求中尋找 `Authorization` 標頭,檢查其值是否為 `Bearer ` 加上一段 token,並將該 token 以 `str` 回傳。 + +若未找到 `Authorization` 標頭,或其值不是 `Bearer ` token,則會直接回傳 401(`UNAUTHORIZED`)錯誤。 + +你不必再自行檢查 token 是否存在;你可以確信只要你的函式被執行,該 token 參數就一定會是 `str`。 + +你可以在互動式文件中試試看: + + + +我們還沒驗證 token 是否有效,但這已是個開始。 + +## 小結 { #recap } + +只需多寫 3、4 行,就能有一個基本的安全機制。 diff --git a/docs/zh-hant/docs/tutorial/security/get-current-user.md b/docs/zh-hant/docs/tutorial/security/get-current-user.md new file mode 100644 index 0000000000..b223d4823b --- /dev/null +++ b/docs/zh-hant/docs/tutorial/security/get-current-user.md @@ -0,0 +1,105 @@ +# 取得目前使用者 { #get-current-user } + +在前一章,基於依賴注入系統的安全機制會把一個 `token`(作為 `str`)提供給*路徑操作函式*: + +{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *} + +但這還不太有用。 + +讓它改為回傳目前使用者吧。 + +## 建立使用者模型 { #create-a-user-model } + +先建立一個 Pydantic 的使用者模型。 + +就像用 Pydantic 宣告請求體一樣,我們也可以在其他地方使用它: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[5,12:6] *} + +## 建立 `get_current_user` 依賴 { #create-a-get-current-user-dependency } + +讓我們建立一個依賴 `get_current_user`。 + +記得依賴可以有子依賴嗎? + +`get_current_user` 會依賴我們先前建立的相同 `oauth2_scheme`。 + +如同先前在*路徑操作*中直接做的一樣,新的依賴 `get_current_user` 會從子依賴 `oauth2_scheme` 接收一個作為 `str` 的 `token`: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[25] *} + +## 取得使用者 { #get-the-user } + +`get_current_user` 會使用我們建立的(假的)工具函式,它接收一個作為 `str` 的 token,並回傳我們的 Pydantic `User` 模型: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[19:22,26:27] *} + +## 注入目前使用者 { #inject-the-current-user } + +現在我們可以在*路徑操作*中用相同的 `Depends` 來使用 `get_current_user`: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[31] *} + +注意我們把 `current_user` 的型別宣告為 Pydantic 的 `User` 模型。 + +這能在函式內提供自動補全與型別檢查的協助。 + +/// tip | 提示 + +你可能記得,請求體也會用 Pydantic 模型宣告。 + +這裡因為你使用了 `Depends`,**FastAPI** 不會混淆。 + +/// + +/// check | 檢查 + +這個依賴系統的設計讓我們可以有不同的依賴(不同的 "dependables"),都回傳 `User` 模型。 + +我們不受限於只能有一個能回傳該類型資料的依賴。 + +/// + +## 其他模型 { #other-models } + +現在你可以在*路徑操作函式*中直接取得目前使用者,並在**依賴注入**層處理安全機制,使用 `Depends`。 + +而且你可以為安全需求使用任意模型或資料(本例中是 Pydantic 模型 `User`)。 + +但你不受限於某個特定的資料模型、類別或型別。 + +想在模型中只有 `id` 與 `email` 而沒有任何 `username`?當然可以。你可以用同樣的工具達成。 + +想只用一個 `str`?或只用一個 `dict`?或直接使用資料庫類別的模型實例?都可以,一樣運作。 + +你的應用其實沒有真人使用者登入,而是機器人、bot,或其他系統,只持有 access token?同樣沒有問題。 + +只要用任何你的應用需要的模型、類別或資料庫即可。**FastAPI** 的依賴注入系統都支援。 + +## 程式碼大小 { #code-size } + +這個範例看起來可能有點冗長。記住我們把安全、資料模型、工具函式與*路徑操作*混在同一個檔案中。 + +但重點在這裡。 + +安全與依賴注入相關的內容只需要寫一次。 + +你可以把它設計得再複雜都沒問題,仍然只需在單一位置寫一次,依然具備完整的彈性。 + +但你可以有成千上萬個端點(*路徑操作*)共用同一套安全系統。 + +而且它們全部(或你想要的一部分)都可以重用這些依賴,或你建立的其他依賴。 + +而所有這些上千個*路徑操作*都可以小到只要 3 行: + +{* ../../docs_src/security/tutorial002_an_py310.py hl[30:32] *} + +## 回顧 { #recap } + +現在你可以在*路徑操作函式*中直接取得目前使用者。 + +我們已經完成一半了。 + +我們只需要再新增一個*路徑操作*,讓使用者/用戶端實際送出 `username` 與 `password`。 + +下一步就會做。 diff --git a/docs/zh-hant/docs/tutorial/security/index.md b/docs/zh-hant/docs/tutorial/security/index.md new file mode 100644 index 0000000000..b5e3738bcd --- /dev/null +++ b/docs/zh-hant/docs/tutorial/security/index.md @@ -0,0 +1,101 @@ +# 安全性 { #security } + +有許多方式可以處理安全性、身分驗證與授權。 + +而且這通常是一個複雜且「困難」的主題。 + +在許多框架與系統中,光是處理安全性與身分驗證就要花費大量心力與程式碼(很多情況下可能佔了全部程式碼的 50% 以上)。 + +**FastAPI** 提供多種工具,讓你能以標準方式輕鬆、快速地處理「安全性」,而不必先研究並學會所有安全性規範。 + +但在此之前,先釐清幾個小概念。 + +## 急著上手? { #in-a-hurry } + +如果你不在意這些術語,只需要立刻加入以使用者名稱與密碼為基礎的身分驗證與安全性,就直接跳到後續章節。 + +## OAuth2 { #oauth2 } + +OAuth2 是一套規範,定義了多種處理身分驗證與授權的方法。 + +它相當龐大,涵蓋許多複雜的使用情境。 + +它也包含使用「第三方」進行身分驗證的方式。 + +這正是各種「使用 Facebook、Google、X(Twitter)、GitHub 登入」系統在底層採用的機制。 + +### OAuth 1 { #oauth-1 } + +過去有 OAuth 1,和 OAuth2 非常不同,也更複雜,因為它直接規範了如何加密通訊。 + +它現在並不流行,也很少被使用。 + +OAuth2 不規範通訊如何加密,而是假設你的應用會透過 HTTPS 提供服務。 + +/// tip | 提示 +在部署相關章節中,你會看到如何使用 Traefik 與 Let's Encrypt 免費設定 HTTPS。 +/// + +## OpenID Connect { #openid-connect } + +OpenID Connect 是基於 **OAuth2** 的另一套規範。 + +它只是擴充了 OAuth2,釐清了 OAuth2 中相對模糊的部份,以提升互通性。 + +例如,Google 登入使用的是 OpenID Connect(其底層使用 OAuth2)。 + +但 Facebook 登入不支援 OpenID Connect,它有自己風格的 OAuth2。 + +### OpenID(不是「OpenID Connect」) { #openid-not-openid-connect } + +過去也有一個「OpenID」規範。它試圖解決與 **OpenID Connect** 相同的問題,但不是建立在 OAuth2 之上。 + +因此,它是一套完全額外、獨立的系統。 + +它現在並不流行,也很少被使用。 + +## OpenAPI { #openapi } + +OpenAPI(先前稱為 Swagger)是一套用於構建 API 的開放規範(現為 Linux 基金會的一部分)。 + +**FastAPI** 建立在 **OpenAPI** 之上。 + +這使得它能提供多種自動化的互動式文件介面、程式碼產生等功能。 + +OpenAPI 提供定義多種安全性「方案」。 + +透過使用它們,你可以善用這些基於標準的工具,包括這些互動式文件系統。 + +OpenAPI 定義了下列安全性方案: + +* `apiKey`:應用程式特定的金鑰,來源可以是: + * 查詢參數。 + * 標頭(header)。 + * Cookie。 +* `http`:標準的 HTTP 驗證系統,包括: + * `bearer`:使用 `Authorization` 標頭,值為 `Bearer ` 加上一個 token。這是從 OAuth2 延伸而來。 + * HTTP Basic 驗證。 + * HTTP Digest 等。 +* `oauth2`:所有 OAuth2 的安全性處理方式(稱為「flows」)。 + * 其中數個 flow 適合用來建立 OAuth 2.0 身分驗證提供者(如 Google、Facebook、X(Twitter)、GitHub 等): + * `implicit` + * `clientCredentials` + * `authorizationCode` + * 但有一個特定的 flow 可直接在同一個應用中處理身分驗證: + * `password`:後續幾個章節會示範這個。 +* `openIdConnect`:提供一種方式來定義如何自動發現 OAuth2 的身分驗證資訊。 + * 這種自動探索機制即由 OpenID Connect 規範定義。 + +/// tip | 提示 +整合像 Google、Facebook、X(Twitter)、GitHub 等其他身分驗證/授權提供者也是可行而且相對容易。 + +最複雜的部分其實是打造一個類似那樣的身分驗證/授權提供者,但 **FastAPI** 提供了工具,能替你處理繁重工作,讓你更輕鬆完成。 +/// + +## **FastAPI** 工具 { #fastapi-utilities } + +FastAPI 在 `fastapi.security` 模組中為上述各種安全性方案提供了多種工具,讓這些機制更容易使用。 + +接下來的章節會示範如何使用這些 **FastAPI** 提供的工具,為你的 API 加入安全性。 + +你也會看到它如何自動整合到互動式文件系統中。 diff --git a/docs/zh-hant/docs/tutorial/security/oauth2-jwt.md b/docs/zh-hant/docs/tutorial/security/oauth2-jwt.md new file mode 100644 index 0000000000..d6761a0051 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/security/oauth2-jwt.md @@ -0,0 +1,277 @@ +# 使用密碼(與雜湊)的 OAuth2、以 Bearer 搭配 JWT 權杖 { #oauth2-with-password-and-hashing-bearer-with-jwt-tokens } + +現在我們已經有完整的安全流程了,接下來用 JWT 權杖與安全的密碼雜湊,讓應用真正安全。 + +這份程式碼可以直接用在你的應用中,把密碼雜湊存進資料庫等等。 + +我們會從上一章的內容繼續往下擴充。 + +## 關於 JWT { #about-jwt } + +JWT 的意思是「JSON Web Tokens」。 + +它是一種把 JSON 物件編碼成一段長且緊密(沒有空白)的字串的標準。看起來像這樣: + +``` +eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c +``` + +它不是加密的,所以任何人都可以從內容還原出資訊。 + +但它是簽名過的。因此當你收到一個你所簽發的權杖時,你可以驗證確實是你簽發的。 + +如此一來,你可以建立一個(例如)有效期為 1 週的權杖。當使用者隔天帶著這個權杖回來時,你就知道該使用者仍然登入在你的系統中。 + +一週後,權杖會過期,使用者就不再被授權,需要再次登入以取得新的權杖。而如果使用者(或第三方)試圖修改權杖來改變有效期,你也能發現,因為簽名不會相符。 + +如果你想玩玩看 JWT 權杖並了解其運作,請參考 https://jwt.io。 + +## 安裝 `PyJWT` { #install-pyjwt } + +我們需要安裝 `PyJWT` 才能在 Python 中產生與驗證 JWT 權杖。 + +請先建立並啟用一個[虛擬環境](../../virtual-environments.md){.internal-link target=_blank},然後安裝 `pyjwt`: + +
+ +```console +$ pip install pyjwt + +---> 100% +``` + +
+ +/// info | 說明 + +如果你打算使用像 RSA 或 ECDSA 這類的數位簽章演算法,應該安裝帶有加密函式庫相依的 `pyjwt[crypto]`。 + +更多內容可參考 PyJWT 安裝文件。 + +/// + +## 密碼雜湊 { #password-hashing } + +「雜湊」是指把某些內容(此處為密碼)轉換成一串看起來像亂碼的位元組序列(其實就是字串)。 + +每當你輸入完全相同的內容(完全相同的密碼),就會得到完全相同的亂碼。 + +但你無法從這串亂碼再反推回原本的密碼。 + +### 為什麼要用密碼雜湊 { #why-use-password-hashing } + +如果你的資料庫被偷了,竊賊拿到的不是使用者的明文密碼,而只是雜湊值。 + +因此,竊賊無法直接拿該密碼去嘗試登入其他系統(由於許多使用者在各處都用同一組密碼,這會很危險)。 + +## 安裝 `pwdlib` { #install-pwdlib } + +pwdlib 是一個很棒的 Python 套件,用來處理密碼雜湊。 + +它支援多種安全的雜湊演算法與相關工具。 + +建議使用的演算法是「Argon2」。 + +請先建立並啟用一個[虛擬環境](../../virtual-environments.md){.internal-link target=_blank},然後以 Argon2 支援安裝 pwdlib: + +
+ +```console +$ pip install "pwdlib[argon2]" + +---> 100% +``` + +
+ +/// tip | 提示 + +使用 `pwdlib`,你甚至可以把它設定為能讀取由 **Django**、**Flask** 的安全外掛或其他許多系統所建立的密碼。 + +例如,你可以讓 Django 應用與 FastAPI 應用共用同一個資料庫中的資料。或者逐步遷移一個 Django 應用,同樣使用該資料庫。 + +而你的使用者可以同時從 Django 應用或 **FastAPI** 應用登入。 + +/// + +## 雜湊與驗證密碼 { #hash-and-verify-the-passwords } + +從 `pwdlib` 匯入我們需要的工具。 + +用建議設定建立一個 PasswordHash 執行個體——它會用於雜湊與驗證密碼。 + +/// tip | 提示 + +pwdlib 也支援 bcrypt 雜湊演算法,但不包含傳統(legacy)演算法——若需要處理過時的雜湊,建議使用 passlib 函式庫。 + +例如,你可以用它讀取並驗證由其他系統(如 Django)產生的密碼,但針對任何新密碼則改用像 Argon2 或 Bcrypt 這類的不同演算法來雜湊。 + +並同時與所有這些格式相容。 + +/// + +建立一個工具函式來雜湊使用者送來的密碼。 + +再建立另一個工具來驗證收到的密碼是否符合已儲存的雜湊。 + +以及另一個用於驗證並回傳使用者的工具。 + +{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,51,58:59,62:63,72:79] *} + +當以不存在於資料庫的使用者名稱呼叫 `authenticate_user` 時,我們仍然會拿一個假的雜湊去跑一次 `verify_password`。 + +這可確保無論使用者名稱是否有效,端點的回應時間都大致相同,避免可用來枚舉既有使用者名稱的「計時攻擊」(timing attacks)。 + +/// note | 注意 + +如果你查看新的(假)資料庫 `fake_users_db`,你會看到雜湊後的密碼現在長這樣:`"$argon2id$v=19$m=65536,t=3,p=4$wagCPXjifgvUFBzq4hqe3w$CYaIb8sB+wtD+Vu/P4uod1+Qof8h+1g7bbDlBID48Rc"`。 + +/// + +## 處理 JWT 權杖 { #handle-jwt-tokens } + +匯入剛安裝的模組。 + +建立一把隨機的密鑰(secret key)用於簽署 JWT 權杖。 + +要產生安全的隨機密鑰可使用以下指令: + +
+ +```console +$ openssl rand -hex 32 + +09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7 +``` + +
+ +將輸出的值複製到變數 `SECRET_KEY`(不要使用範例中的那一組)。 + +建立變數 `ALGORITHM` 指定用來簽署 JWT 權杖的演算法,設為 `"HS256"`。 + +建立一個權杖有效期的變數。 + +定義一個用於權杖端點回應的 Pydantic Model。 + +建立一個工具函式來產生新的 access token。 + +{* ../../docs_src/security/tutorial004_an_py310.py hl[4,7,13:15,29:31,82:90] *} + +## 更新相依項目 { #update-the-dependencies } + +更新 `get_current_user`,讓它仍接收相同的權杖,但這次改用 JWT 權杖。 + +解碼收到的權杖、驗證它,並回傳目前的使用者。 + +如果權杖無效,立即回傳一個 HTTP 錯誤。 + +{* ../../docs_src/security/tutorial004_an_py310.py hl[93:110] *} + +## 更新 `/token` 路徑操作 { #update-the-token-path-operation } + +用權杖有效期建立一個 `timedelta`。 + +建立真正的 JWT access token 並回傳它。 + +{* ../../docs_src/security/tutorial004_an_py310.py hl[121:136] *} + +### 關於 JWT「主體」`sub` 的技術細節 { #technical-details-about-the-jwt-subject-sub } + +JWT 規範說有個鍵 `sub`,代表權杖的主體(subject)。 + +使用它是可選的,但通常會把使用者的識別資訊放在這裡,所以我們在此採用。 + +JWT 除了用來識別使用者並允許他直接對你的 API 執行操作外,也可用於其他用途。 + +例如,你可以識別一台「車」或一篇「部落格文章」。 + +接著可以替該實體加上權限,如「drive」(對車而言)或「edit」(對文章而言)。 + +然後你可以把該 JWT 權杖交給某個使用者(或機器人),他們就能用它來執行那些動作(開車、或編輯文章),甚至不需要有帳號,只要使用你的 API 所產生的 JWT 權杖即可。 + +基於這些概念,JWT 能用在更複雜的情境中。 + +在那些情境裡,數個實體可能擁有相同的 ID,例如 `foo`(使用者 `foo`、車 `foo`、以及文章 `foo`)。 + +為了避免 ID 衝突,在為使用者建立 JWT 權杖時,你可以替 `sub` 的值加上前綴,例如 `username:`。因此在這個例子中,`sub` 的值可以是:`username:johndoe`。 + +要記住的重要點是:`sub` 必須是在整個應用中唯一的識別子,並且必須是字串。 + +## 試試看 { #check-it } + +啟動伺服器並前往文件頁:http://127.0.0.1:8000/docs。 + +你會看到這樣的介面: + + + +用和先前相同的方式授權應用。 + +使用下列認證資訊: + +Username: `johndoe` +Password: `secret` + +/// check | 檢查 + +注意在程式碼中完全沒有明文密碼「`secret`」,我們只有雜湊後的版本。 + +/// + + + +呼叫端點 `/users/me/`,你會得到類似這樣的回應: + +```JSON +{ + "username": "johndoe", + "email": "johndoe@example.com", + "full_name": "John Doe", + "disabled": false +} +``` + + + +如果你打開開發者工具,可以看到送出的資料只包含權杖;密碼只會在第一次請求(用來驗證使用者並取得 access token)時送出,之後就不會再送: + + + +/// note | 注意 + +留意標頭 `Authorization`,其值是以 `Bearer ` 開頭。 + +/// + +## 進階用法:`scopes` { #advanced-usage-with-scopes } + +OAuth2 有「scopes」的概念。 + +你可以用它們替 JWT 權杖加上一組特定的權限。 + +接著你可以把這個權杖直接交給某個使用者或第三方,讓他們在一組受限條件下與你的 API 互動。 + +你可以在之後的「進階使用者指南」學到如何使用它們,以及它們如何整合進 **FastAPI**。 + +## 小結 { #recap } + +依照你目前學到的內容,你可以用 OAuth2 與 JWT 等標準,設定一個安全的 **FastAPI** 應用。 + +在幾乎任何框架中,安全性處理都會很快變得相當複雜。 + +許多能大幅簡化工作的套件,往往必須在資料模型、資料庫與可用功能上做出很多取捨。而有些過度簡化的套件底層其實存在安全弱點。 + +--- + +**FastAPI** 不會在任何資料庫、資料模型或工具上做妥協。 + +它給你完全的彈性,讓你挑選最適合你專案的組合。 + +而且你可以直接使用許多維護良好且被廣泛採用的套件,例如 `pwdlib` 與 `PyJWT`,因為 **FastAPI** 不需要任何複雜機制就能整合外部套件。 + +同時它也提供工具來在不犧牲彈性、穩健或安全的前提下,盡可能地簡化流程。 + +你可以用相對簡單的方式使用並實作像 OAuth2 這樣的安全標準協定。 + +你可以在「進階使用者指南」進一步了解如何使用 OAuth2 的「scopes」,以實作更細緻的權限系統,並遵循相同的標準。帶有 scopes 的 OAuth2 是許多大型身份驗證供應商(如 Facebook、Google、GitHub、Microsoft、X(Twitter)等)用來授權第三方應用代表其使用者與其 API 互動的機制。 diff --git a/docs/zh-hant/docs/tutorial/security/simple-oauth2.md b/docs/zh-hant/docs/tutorial/security/simple-oauth2.md new file mode 100644 index 0000000000..3b9aae3416 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/security/simple-oauth2.md @@ -0,0 +1,289 @@ +# 簡易 OAuth2:Password 與 Bearer { #simple-oauth2-with-password-and-bearer } + +現在從上一章延伸,補上缺少的部分,完成整個安全流程。 + +## 取得 `username` 與 `password` { #get-the-username-and-password } + +我們要使用 **FastAPI** 提供的安全性工具來取得 `username` 與 `password`。 + +OAuth2 規範中,當使用「password flow」(我們現在使用的)時,用戶端/使用者必須以表單資料送出 `username` 與 `password` 欄位。 + +而且規範要求欄位名稱必須就是這兩個,所以像是 `user-name` 或 `email` 都不行。 + +但別擔心,你在前端要怎麼呈現給最終使用者都可以。 + +而你的資料庫模型也可以使用任何你想要的欄位名稱。 + +不過在登入的路徑操作(path operation)裡,我們需要使用這些名稱,才能符合規範(例如才能使用整合的 API 文件系統)。 + +規範也說明 `username` 與 `password` 必須以表單資料傳送(也就是這裡不能用 JSON)。 + +### `scope` { #scope } + +規範也說用戶端可以再送一個表單欄位「`scope`」。 + +欄位名稱是單數的 `scope`,但實際上是由多個以空白分隔的「scopes」組成的一長串字串。 + +每個「scope」就是一個(不含空白的)字串。 + +它們通常用來宣告特定的權限,例如: + +- `users:read` 或 `users:write` 是常見的例子 +- `instagram_basic` 用在 Facebook / Instagram +- `https://www.googleapis.com/auth/drive` 用在 Google + +/// info + +在 OAuth2 裡,「scope」只是用來宣告特定所需權限的一個字串。 + +不論裡面是否包含像 `:` 之類的字元,或是否是一個 URL,都沒差。 + +那些都是實作細節。 + +對 OAuth2 而言,它們就是字串而已。 + +/// + +## 取得 `username` 與 `password` 的程式碼 { #code-to-get-the-username-and-password } + +現在用 **FastAPI** 提供的工具來處理。 + +### `OAuth2PasswordRequestForm` { #oauth2passwordrequestform } + +先匯入 `OAuth2PasswordRequestForm`,並在 `/token` 的路徑操作中,搭配 `Depends` 當作依賴使用: + +{* ../../docs_src/security/tutorial003_an_py310.py hl[4,78] *} + +`OAuth2PasswordRequestForm` 是一個類別型依賴,它宣告了一個表單本文,包含: + +- `username` +- `password` +- 可選的 `scope` 欄位,內容是一個由空白分隔的長字串 +- 可選的 `grant_type` + +/// tip + +依規範,實際上需要一個 `grant_type` 欄位且固定值為 `password`,但 `OAuth2PasswordRequestForm` 並不會強制檢查。 + +如果你需要強制檢查,請改用 `OAuth2PasswordRequestFormStrict` 取代 `OAuth2PasswordRequestForm`。 + +/// + +- 可選的 `client_id`(本例不需要) +- 可選的 `client_secret`(本例不需要) + +/// info + +`OAuth2PasswordRequestForm` 並不是像 `OAuth2PasswordBearer` 那樣對 **FastAPI** 來說的特殊類別。 + +`OAuth2PasswordBearer` 會讓 **FastAPI** 知道它是一個 security scheme,因此會以那種方式加入 OpenAPI。 + +但 `OAuth2PasswordRequestForm` 只是你也可以自己撰寫的一個類別型依賴,或是你也可以直接宣告 `Form` 參數。 + +只是因為這是很常見的用例,所以 **FastAPI** 直接內建提供,讓事情更簡單。 + +/// + +### 使用表單資料 { #use-the-form-data } + +/// tip + +`OAuth2PasswordRequestForm` 這個依賴類別的實例不會有以空白分隔長字串的 `scope` 屬性,而是會有一個 `scopes` 屬性,裡面是各個 scope 的實際字串清單。 + +本示例沒有使用 `scopes`,但如果你需要,功能已經在那裡了。 + +/// + +現在,從(假的)資料庫裡用表單欄位的 `username` 取得使用者資料。 + +如果沒有該使用者,就回傳「Incorrect username or password」的錯誤。 + +我們用 `HTTPException` 這個例外來回傳錯誤: + +{* ../../docs_src/security/tutorial003_an_py310.py hl[3,79:81] *} + +### 檢查密碼 { #check-the-password } + +這時我們已經有來自資料庫的使用者資料,但還沒檢查密碼。 + +先把那些資料放進 Pydantic 的 `UserInDB` 模型。 + +你絕對不要以純文字儲存密碼,所以我們會使用(假的)密碼雜湊系統。 + +如果密碼不匹配,我們回傳同樣的錯誤。 + +#### 密碼雜湊(hashing) { #password-hashing } + +「雜湊」的意思是:把一些內容(這裡是密碼)轉換成一串看起來像亂碼的位元組序列(就是字串)。 + +只要你輸入完全相同的內容(完全相同的密碼),就會得到完全相同的亂碼。 + +但你無法從這串亂碼還原回原本的密碼。 + +##### 為何要做密碼雜湊 { #why-use-password-hashing } + +如果你的資料庫被竊取,攻擊者拿到的不是使用者的純文字密碼,而只是雜湊值。 + +因此攻擊者無法嘗試把那些密碼用在其他系統上(因為很多使用者在各處都用同一組密碼,這會很危險)。 + +{* ../../docs_src/security/tutorial003_an_py310.py hl[82:85] *} + +#### 關於 `**user_dict**` { #about-user-dict } + +`UserInDB(**user_dict)` 的意思是: + +把 `user_dict` 的鍵和值直接當作具名參數傳入,等同於: + +```Python +UserInDB( + username = user_dict["username"], + email = user_dict["email"], + full_name = user_dict["full_name"], + disabled = user_dict["disabled"], + hashed_password = user_dict["hashed_password"], +) +``` + +/// info + +想更完整地了解 `**user_dict`,請回到[**額外模型** 的文件](../extra-models.md#about-user-in-dict){.internal-link target=_blank}。 + +/// + +## 回傳 token { #return-the-token } + +`token` 端點的回應必須是 JSON 物件。 + +它應該有一個 `token_type`。在本例中,我們使用「Bearer」tokens,token 類型應該是「`bearer`」。 + +而且它還應該有一個 `access_token`,其值為包含我們存取權杖的字串。 + +在這個簡單示例中,我們會不安全地直接回傳相同的 `username` 當作 token。 + +/// tip + +下一章你會看到真正安全的實作,包含密碼雜湊與 JWT tokens。 + +但現在先把注意力放在我們需要的這些細節上。 + +/// + +{* ../../docs_src/security/tutorial003_an_py310.py hl[87] *} + +/// tip + +依照規範,你應該回傳一個包含 `access_token` 與 `token_type` 的 JSON,就像這個範例。 + +這部分需要你自己在程式中完成,並確保使用這些 JSON key。 + +這幾乎是你為了符合規範而必須自行記得正確處理的唯一事情。 + +其餘的 **FastAPI** 都會幫你處理。 + +/// + +## 更新依賴項 { #update-the-dependencies } + +接著我們要更新依賴項。 + +我們只想在使用者為啟用狀態時取得 `current_user`。 + +所以,我們新增一個依賴 `get_current_active_user`,而它本身又依賴 `get_current_user`。 + +這兩個依賴會在使用者不存在或未啟用時回傳 HTTP 錯誤。 + +因此,在端點中,只有在使用者存在、已正確驗證且為啟用狀態時,我們才會取得使用者: + +{* ../../docs_src/security/tutorial003_an_py310.py hl[58:66,69:74,94] *} + +/// info + +這裡我們一併回傳值為 `Bearer` 的額外標頭 `WWW-Authenticate`,這也是規範的一部分。 + +任何 HTTP(錯誤)狀態碼 401「UNAUTHORIZED」都應該同時回傳 `WWW-Authenticate` 標頭。 + +在 bearer tokens(我們的情況)下,該標頭的值應該是 `Bearer`。 + +其實你可以省略這個額外標頭,功能仍會正常。 + +但此處加上它是為了遵循規範。 + +同時也可能有工具會期待並使用它(現在或未來),而這可能對你或你的使用者有幫助,現在或未來皆然。 + +這就是標準的好處... + +/// + +## 實際操作看看 { #see-it-in-action } + +開啟互動式文件:http://127.0.0.1:8000/docs。 + +### 驗證身分 { #authenticate } + +點選「Authorize」按鈕。 + +使用下列帳密: + +User: `johndoe` + +Password: `secret` + + + +在系統中完成驗證後,你會看到如下畫面: + + + +### 取得自己的使用者資料 { #get-your-own-user-data } + +現在使用 `GET` 方法呼叫路徑 `/users/me`。 + +你會取得自己的使用者資料,如: + +```JSON +{ + "username": "johndoe", + "email": "johndoe@example.com", + "full_name": "John Doe", + "disabled": false, + "hashed_password": "fakehashedsecret" +} +``` + + + +如果你點擊鎖頭圖示登出,然後再次嘗試相同操作,你會得到 HTTP 401 錯誤: + +```JSON +{ + "detail": "Not authenticated" +} +``` + +### 未啟用的使用者 { #inactive-user } + +現在改用一個未啟用的使用者,使用以下帳密驗證: + +User: `alice` + +Password: `secret2` + +然後再呼叫 `GET` 方法的 `/users/me`。 + +你會得到「Inactive user」的錯誤,例如: + +```JSON +{ + "detail": "Inactive user" +} +``` + +## 小結 { #recap } + +你現在已經有足夠的工具,能為你的 API 以 `username` 與 `password` 實作一個完整的安全性系統。 + +使用這些工具,你可以讓安全性系統相容於任何資料庫,以及任何使用者或資料模型。 + +唯一尚未補上的細節是:它現在其實還不「安全」。 + +在下一章,你會看到如何使用安全的密碼雜湊函式庫與 JWT tokens。 diff --git a/docs/zh-hant/docs/tutorial/sql-databases.md b/docs/zh-hant/docs/tutorial/sql-databases.md new file mode 100644 index 0000000000..930dc4e8a5 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/sql-databases.md @@ -0,0 +1,357 @@ +# SQL(關聯式)資料庫 { #sql-relational-databases } + +FastAPI 不強制你使用 SQL(關聯式)資料庫。你可以使用任何你想要的資料庫。 + +這裡我們會用 SQLModel 作為範例。 + +SQLModel 建立在 SQLAlchemy 與 Pydantic 之上。它由 FastAPI 的作者開發,非常適合需要使用 SQL 資料庫的 FastAPI 應用。 + +/// tip | 提示 + +你可以使用任何你想用的 SQL 或 NoSQL 資料庫函式庫(有時稱為 "ORMs"),FastAPI 不會強迫你使用特定工具。😎 + +/// + +因為 SQLModel 建立在 SQLAlchemy 之上,你可以輕鬆使用 SQLAlchemy 所支援的任何資料庫(因此 SQLModel 也支援),例如: + +* PostgreSQL +* MySQL +* SQLite +* Oracle +* Microsoft SQL Server,等等。 + +在這個範例中,我們會使用 SQLite,因為它只用到單一檔案,而且 Python 內建支援。你可以直接複製這個範例並原樣執行。 + +之後,在你的正式環境應用中,你可能會想使用像 PostgreSQL 這類的資料庫伺服器。 + +/// tip | 提示 + +有一個包含 FastAPI 與 PostgreSQL 的官方專案腳手架,還有前端與更多工具:https://github.com/fastapi/full-stack-fastapi-template + +/// + +這是一份非常簡短的教學,如果你想更全面學習資料庫、SQL,或更進階的功能,請參考 SQLModel 文件。 + +## 安裝 `SQLModel` { #install-sqlmodel } + +首先,請先建立你的[虛擬環境](../virtual-environments.md){.internal-link target=_blank}、啟用它,然後安裝 `sqlmodel`: + +
+ +```console +$ pip install sqlmodel +---> 100% +``` + +
+ +## 建立只有單一模型的應用 { #create-the-app-with-a-single-model } + +我們先用單一 SQLModel 模型建立這個應用的最簡版。 + +接著我們會在下方用多個模型來提升安全性與彈性。🤓 + +### 建立模型 { #create-models } + +匯入 `SQLModel` 並建立一個資料庫模型: + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[1:11] hl[7:11] *} + +`Hero` 類別與 Pydantic 模型非常相似(事實上,在底層它就是一個 Pydantic 模型)。 + +有幾點差異: + +* `table=True` 告訴 SQLModel 這是一個「資料表模型」(table model),它應該代表 SQL 資料庫中的一個資料表,而不僅僅是「資料模型」(就像一般的 Pydantic 類別)。 + +* `Field(primary_key=True)` 告訴 SQLModel,`id` 是 SQL 資料庫中的「主鍵」。 (你可以在 SQLModel 文件中進一步了解 SQL 主鍵) + + 注意:我們在主鍵欄位使用 `int | None`,這樣在 Python 程式碼中我們可以「在沒有 `id` 的情況下建立物件」(`id=None`),假設資料庫在儲存時會「自動產生」。SQLModel 瞭解資料庫會提供 `id`,並且在資料庫綱要中「將該欄位定義為非空的 `INTEGER`」。詳情請見 SQLModel 文件:主鍵。 + +* `Field(index=True)` 告訴 SQLModel 應為此欄位建立「SQL 索引」,以便在用此欄位過濾讀取資料時更快查詢。 + + SQLModel 會知道宣告為 `str` 的欄位在 SQL 中會是 `TEXT`(或 `VARCHAR`,依資料庫而定)。 + +### 建立引擎 { #create-an-engine } + +SQLModel 的 `engine`(底層實際上是 SQLAlchemy 的 `engine`)是用來「維護與資料庫連線」的東西。 + +你的程式中應該只有「單一 `engine` 物件」來連到同一個資料庫。 + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[14:18] hl[14:15,17:18] *} + +使用 `check_same_thread=False` 允許 FastAPI 在不同執行緒中使用同一個 SQLite 資料庫。這是必要的,因為「單一請求」可能會使用「多個執行緒」(例如在依賴項中)。 + +別擔心,依照我們的程式結構,稍後我們會確保「每個請求只使用單一 SQLModel 的 session」,這其實就是 `check_same_thread` 想要達成的事。 + +### 建立資料表 { #create-the-tables } + +接著我們新增一個函式,使用 `SQLModel.metadata.create_all(engine)` 為所有「資料表模型」建立資料表。 + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[21:22] hl[21:22] *} + +### 建立 Session 依賴 { #create-a-session-dependency } + +「`Session`」會在記憶體中保存物件並追蹤資料需要的任何變更,然後透過「`engine`」與資料庫溝通。 + +我們會用 `yield` 建立一個 FastAPI 的「依賴」,為每個請求提供一個新的 `Session`。這可確保每個請求只使用單一的 session。🤓 + +接著我們建立一個 `Annotated` 的依賴 `SessionDep`,讓後續使用這個依賴的程式碼更簡潔。 + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[25:30] hl[25:27,30] *} + +### 在啟動時建立資料表 { #create-database-tables-on-startup } + +我們會在應用啟動時建立資料庫的資料表。 + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[32:37] hl[35:37] *} + +這裡我們在應用的啟動事件中建立資料表。 + +在正式環境中,你大概會在啟動應用前使用遷移腳本來處理。🤓 + +/// tip | 提示 + +SQLModel 之後會提供包裝 Alembic 的遷移工具,但目前你可以直接使用 Alembic。 + +/// + +### 建立 Hero { #create-a-hero } + +因為每個 SQLModel 模型同時也是一個 Pydantic 模型,你可以在「型別標註」中像使用 Pydantic 模型一樣使用它。 + +例如,如果你宣告一個參數型別為 `Hero`,它會從「JSON body」中讀取。 + +同樣地,你也可以將它宣告為函式的「回傳型別」,然後在自動產生的 API 文件 UI 中就會顯示其資料結構。 + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[40:45] hl[40:45] *} + +這裡我們使用 `SessionDep` 依賴(即一個 `Session`),把新的 `Hero` 加入 `Session` 實例,提交變更到資料庫,刷新 `hero` 的資料,然後回傳它。 + +### 讀取多個 Hero { #read-heroes } + +我們可以用 `select()` 從資料庫「讀取」多個 `Hero`。可以加入 `limit` 與 `offset` 來分頁。 + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[48:55] hl[51:52,54] *} + +### 讀取單一 Hero { #read-one-hero } + +我們可以「讀取」單一的 `Hero`。 + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[58:63] hl[60] *} + +### 刪除 Hero { #delete-a-hero } + +我們也可以「刪除」一個 `Hero`。 + +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[66:73] hl[71] *} + +### 執行應用 { #run-the-app } + +你可以執行應用: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +然後前往 `/docs` 的 UI,你會看到 FastAPI 使用這些模型來「文件化」API,也會用它們來「序列化」與「驗證」資料。 + +
+ +
+ +## 用多個模型更新應用 { #update-the-app-with-multiple-models } + +現在我們稍微「重構」一下這個應用,以提升「安全性」與「彈性」。 + +如果你檢查前一版的應用,在 UI 中你會看到,到目前為止它讓用戶端自己決定要建立的 `Hero` 的 `id`。😱 + +我們不該允許這樣,因為他們可能會覆蓋資料庫中我們已分配的 `id`。決定 `id` 應該由「後端」或「資料庫」來做,「不是用戶端」。 + +另外,我們為 hero 建立了 `secret_name`,但目前我們在各處都把它回傳出去,這一點都不「保密」... 😅 + +我們會透過加入一些「額外模型」來修正這些問題。這正是 SQLModel 大放異彩的地方。✨ + +### 建立多個模型 { #create-multiple-models } + +在 SQLModel 中,任何設了 `table=True` 的模型類別都是「資料表模型」。 + +而沒有設 `table=True` 的模型類別就是「資料模型」,這些其實就是 Pydantic 模型(只有一點小增強)。🤓 + +使用 SQLModel,我們可以利用「繼承」來「避免重複」在各種情況下一再宣告所有欄位。 + +#### `HeroBase` - 基底類別 { #herobase-the-base-class } + +先從 `HeroBase` 模型開始,它包含所有模型「共享」的欄位: + +* `name` +* `age` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:9] hl[7:9] *} + +#### `Hero` - 資料表模型 { #hero-the-table-model } + +接著建立 `Hero`,也就是實際的「資料表模型」,它包含不一定會出現在其他模型中的「額外欄位」: + +* `id` +* `secret_name` + +因為 `Hero` 繼承自 `HeroBase`,它「也」擁有 `HeroBase` 中宣告的「欄位」,因此 `Hero` 的完整欄位為: + +* `id` +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:14] hl[12:14] *} + +#### `HeroPublic` - 公開的資料模型 { #heropublic-the-public-data-model } + +接下來建立 `HeroPublic` 模型,它是要「回傳」給 API 用戶端的模型。 + +它擁有與 `HeroBase` 相同的欄位,因此不會包含 `secret_name`。 + +終於,我們英雄的真實身分受保護了!🥷 + +它也重新宣告了 `id: int`。這麼做是與 API 用戶端訂立一個「契約」,讓他們可以確定 `id` 一定存在而且是 `int`(不會是 `None`)。 + +/// tip | 提示 + +讓回傳模型保證某個值一定存在、而且一定是 `int`(不是 `None`),對 API 用戶端非常有幫助。他們在有這個確信下可以寫出更簡單的程式碼。 + +此外,透過「自動產生的客戶端」也會有更簡潔的介面,讓要使用你 API 的開發者能有更好的開發體驗。😎 + +/// + +`HeroPublic` 中的欄位與 `HeroBase` 相同,僅 `id` 宣告為 `int`(非 `None`): + +* `id` +* `name` +* `age` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:18] hl[17:18] *} + +#### `HeroCreate` - 用於建立 Hero 的資料模型 { #herocreate-the-data-model-to-create-a-hero } + +現在我們建立 `HeroCreate` 模型,這是用來「驗證」用戶端送來資料的模型。 + +它具有與 `HeroBase` 相同的欄位,並且還有 `secret_name`。 + +接下來,當用戶端「建立新 hero」時,他們會送上 `secret_name`,它會被儲存在資料庫中,但這些祕密名稱不會在 API 中回傳給用戶端。 + +/// tip | 提示 + +這也就是你處理「密碼」的方式。接收它們,但不要在 API 中回傳。 + +你也應該在儲存前先對密碼做「雜湊」,「永遠不要以明文儲存」。 + +/// + +`HeroCreate` 的欄位有: + +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:22] hl[21:22] *} + +#### `HeroUpdate` - 用於更新 Hero 的資料模型 { #heroupdate-the-data-model-to-update-a-hero } + +在前一版的應用中,我們沒有「更新 hero」的方式,但現在有了「多個模型」,我們就能做到。🎉 + +`HeroUpdate` 這個資料模型有點特別,它包含「建立新 hero 所需的所有欄位」,但所有欄位都是「可選的」(都有預設值)。這樣在更新時,你只需要送出想要更新的欄位即可。 + +因為所有欄位的「型別其實都改變了」(型別現在包含 `None`,而且預設值為 `None`),我們需要「重新宣告」它們。 + +其實不一定要繼承 `HeroBase`,因為我們會重新宣告所有欄位。我這裡保留繼承只是為了一致性,並非必要。這主要是個人偏好的問題。🤷 + +`HeroUpdate` 的欄位有: + +* `name` +* `age` +* `secret_name` + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:28] hl[25:28] *} + +### 用 `HeroCreate` 建立並回傳 `HeroPublic` { #create-with-herocreate-and-return-a-heropublic } + +現在我們有了「多個模型」,可以更新應用中使用它們的部分。 + +我們在請求中接收 `HeroCreate`(資料模型),並由它建立一個 `Hero`(資料表模型)。 + +這個新的資料表模型 `Hero` 會有用戶端傳來的欄位,並且會由資料庫產生一個 `id`。 + +然後我們直接從函式回傳這個資料表模型 `Hero`。但因為我們用 `HeroPublic` 當作 `response_model`,FastAPI 會用 `HeroPublic` 來驗證與序列化資料。 + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[56:62] hl[56:58] *} + +/// tip | 提示 + +現在我們用 `response_model=HeroPublic`,而不是用回傳型別標註 `-> HeroPublic`,因為我們實際回傳的值其實「不是」`HeroPublic`。 + +如果我們宣告 `-> HeroPublic`,你的編輯器與 linter 會(理所當然地)抱怨你回傳的是 `Hero` 而不是 `HeroPublic`。 + +在 `response_model` 中宣告,就是要讓 FastAPI 去做它該做的事,而不影響型別標註,以及你的編輯器與其他工具提供的協助。 + +/// + +### 使用 `HeroPublic` 讀取多個 Hero { #read-heroes-with-heropublic } + +我們可以像先前一樣「讀取」多個 `Hero`。同樣地,我們使用 `response_model=list[HeroPublic]` 來確保資料被正確驗證與序列化。 + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[65:72] hl[65] *} + +### 使用 `HeroPublic` 讀取單一 Hero { #read-one-hero-with-heropublic } + +我們可以「讀取」單一 hero: + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[75:80] hl[77] *} + +### 使用 `HeroUpdate` 更新 Hero { #update-a-hero-with-heroupdate } + +我們可以「更新 hero」。為此我們使用 HTTP 的 `PATCH` 操作。 + +在程式碼中,我們會取得一個只包含用戶端有傳送的資料的 `dict`,不包含只是因為有預設值而存在的欄位。為了達成這點,我們使用 `exclude_unset=True`。這是關鍵。🪄 + +然後我們使用 `hero_db.sqlmodel_update(hero_data)` 以 `hero_data` 的資料更新 `hero_db`。 + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[83:93] hl[83:84,88:89] *} + +### 再次刪除 Hero { #delete-a-hero-again } + +「刪除」 hero 基本上維持不變。 + +我們不會為了重構而重構一切。😅 + +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[96:103] hl[101] *} + +### 再次執行應用 { #run-the-app-again } + +你可以再次執行應用: + +
+ +```console +$ fastapi dev main.py + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +``` + +
+ +如果你前往 `/docs` 的 API UI,你會看到它已更新,建立 hero 時不再期待從用戶端接收 `id`,等等。 + +
+ +
+ +## 總結 { #recap } + +你可以使用 SQLModel 與 SQL 資料庫互動,並用「資料模型」與「資料表模型」讓程式碼更簡潔。 + +你可以在 SQLModel 文件學到更多內容,這裡還有一份更長的 使用 SQLModel 與 FastAPI 的教學。🚀 diff --git a/docs/zh-hant/docs/tutorial/static-files.md b/docs/zh-hant/docs/tutorial/static-files.md new file mode 100644 index 0000000000..06b6176760 --- /dev/null +++ b/docs/zh-hant/docs/tutorial/static-files.md @@ -0,0 +1,40 @@ +# 靜態檔案 { #static-files } + +你可以使用 `StaticFiles` 從某個目錄自動提供靜態檔案。 + +## 使用 `StaticFiles` { #use-staticfiles } + +- 匯入 `StaticFiles`。 +- 在特定路徑上「掛載」一個 `StaticFiles()` 實例。 + +{* ../../docs_src/static_files/tutorial001_py310.py hl[2,6] *} + +/// note | 技術細節 + +你也可以使用 `from starlette.staticfiles import StaticFiles`。 + +**FastAPI** 為了方便開發者,提供與 `starlette.staticfiles` 相同的介面作為 `fastapi.staticfiles`。但它其實是直接來自 Starlette。 + +/// + +### 什麼是「掛載」 { #what-is-mounting } + +「掛載(mounting)」是指在特定路徑下加入一個完整且「獨立」的應用,之後所有該路徑下的子路徑都由它處理。 + +這與使用 `APIRouter` 不同,因為被掛載的應用是完全獨立的。主應用的 OpenAPI 與文件不會包含掛載應用的任何內容,等等。 + +你可以在[進階使用者指南](../advanced/index.md){.internal-link target=_blank}中閱讀更多相關內容。 + +## 細節 { #details } + +第一個 `"/static"` 指的是這個「子應用」要被「掛載」的子路徑。因此,任何以 `"/static"` 開頭的路徑都會由它處理。 + +`directory="static"` 指向包含你靜態檔案的目錄名稱。 + +`name="static"` 為它指定一個可供 **FastAPI** 內部使用的名稱。 + +以上參數都不一定要是 "`static`",請依你的應用需求與細節調整。 + +## 更多資訊 { #more-info } + +如需更多細節與選項,請參考 Starlette 關於靜態檔案的文件。 diff --git a/docs/zh-hant/docs/tutorial/testing.md b/docs/zh-hant/docs/tutorial/testing.md new file mode 100644 index 0000000000..0d49fd5d7b --- /dev/null +++ b/docs/zh-hant/docs/tutorial/testing.md @@ -0,0 +1,193 @@ +# 測試 { #testing } + +多虧了 Starlette,測試 **FastAPI** 應用既簡單又好用。 + +它是基於 HTTPX 打造,而 HTTPX 的設計又參考了 Requests,所以用起來非常熟悉、直覺。 + +借助它,你可以直接用 pytest 來測試 **FastAPI**。 + +## 使用 `TestClient` { #using-testclient } + +/// info + +要使用 `TestClient`,請先安裝 `httpx`。 + +請先建立並啟用一個[虛擬環境](../virtual-environments.md){.internal-link target=_blank},然後安裝,例如: + +```console +$ pip install httpx +``` + +/// + +匯入 `TestClient`。 + +建立一個 `TestClient`,把你的 **FastAPI** 應用傳入其中。 + +建立名稱以 `test_` 開頭的函式(這是 `pytest` 的慣例)。 + +像使用 `httpx` 一樣使用 `TestClient` 物件。 + +用簡單的 `assert` 敘述搭配標準的 Python 運算式來檢查(同樣是 `pytest` 的標準用法)。 + +{* ../../docs_src/app_testing/tutorial001_py310.py hl[2,12,15:18] *} + +/// tip + +注意測試函式是一般的 `def`,不是 `async def`。 + +而且對 client 的呼叫也都是一般呼叫,不需要使用 `await`。 + +這讓你可以直接使用 `pytest`,不必費心處理非同步。 + +/// + +/// note | 技術細節 + +你也可以使用 `from starlette.testclient import TestClient`。 + +**FastAPI** 為了方便開發者,也提供與 `starlette.testclient` 相同的 `fastapi.testclient`。但它其實直接來自 Starlette。 + +/// + +/// tip + +如果你想在測試中呼叫其他 `async` 函式,而不只是對 FastAPI 應用發送請求(例如非同步的資料庫函式),請參考進階教學中的[非同步測試](../advanced/async-tests.md){.internal-link target=_blank}。 + +/// + +## 分離測試 { #separating-tests } + +在真實專案中,你大概會把測試放在不同的檔案中。 + +你的 **FastAPI** 應用也可能由多個檔案/模組組成,等等。 + +### **FastAPI** 應用檔案 { #fastapi-app-file } + +假設你的檔案結構如[更大型的應用](bigger-applications.md){.internal-link target=_blank}所述: + +``` +. +├── app +│   ├── __init__.py +│   └── main.py +``` + +在 `main.py` 檔案中有你的 **FastAPI** 應用: + + +{* ../../docs_src/app_testing/app_a_py310/main.py *} + +### 測試檔案 { #testing-file } + +然後你可以建立一個 `test_main.py` 放你的測試。它可以與應用位於同一個 Python 套件(同一個包含 `__init__.py` 的目錄): + +``` hl_lines="5" +. +├── app +│   ├── __init__.py +│   ├── main.py +│   └── test_main.py +``` + +因為這個檔案在同一個套件中,你可以使用相對匯入,從 `main` 模組(`main.py`)匯入 `app` 這個物件: + +{* ../../docs_src/app_testing/app_a_py310/test_main.py hl[3] *} + + +...然後測試的程式碼就和先前一樣。 + +## 測試:進階範例 { #testing-extended-example } + +現在我們延伸這個範例並加入更多細節,看看如何測試不同部分。 + +### 擴充的 **FastAPI** 應用檔案 { #extended-fastapi-app-file } + +沿用先前相同的檔案結構: + +``` +. +├── app +│   ├── __init__.py +│   ├── main.py +│   └── test_main.py +``` + +假設現在你的 **FastAPI** 應用所在的 `main.py` 有一些其他的路徑操作(path operations)。 + +它有一個可能回傳錯誤的 `GET` 操作。 + +它有一個可能回傳多種錯誤的 `POST` 操作。 + +兩個路徑操作都需要一個 `X-Token` 標頭(header)。 + +{* ../../docs_src/app_testing/app_b_an_py310/main.py *} + +### 擴充的測試檔案 { #extended-testing-file } + +接著你可以把 `test_main.py` 更新為擴充後的測試: + +{* ../../docs_src/app_testing/app_b_an_py310/test_main.py *} + + +每當你需要在請求中讓 client 帶一些資料,但不確定該怎麼做時,你可以搜尋(Google)在 `httpx` 要如何傳遞,甚至用 Requests 怎麼做,因為 HTTPX 的設計是基於 Requests。 + +然後在你的測試中做一樣的事即可。 + +例如: + +* 要傳遞路徑或查詢參數,直接把它加在 URL 上。 +* 要傳遞 JSON 本文,將 Python 物件(例如 `dict`)傳給 `json` 參數。 +* 如果需要送出表單資料(Form Data)而不是 JSON,改用 `data` 參數。 +* 要傳遞標頭(headers),在 `headers` 參數中放一個 `dict`。 +* 對於 Cookie(cookies),在 `cookies` 參數中放一個 `dict`。 + +關於如何把資料傳給後端(使用 `httpx` 或 `TestClient`),更多資訊請參考 HTTPX 文件。 + +/// info + +請注意,`TestClient` 接收的是可轉為 JSON 的資料,而不是 Pydantic models。 + +如果你的測試裡有一個 Pydantic model,並想在測試時把它的資料送給應用,你可以使用[JSON 相容編碼器](encoder.md){.internal-link target=_blank}中介紹的 `jsonable_encoder`。 + +/// + +## 執行 { #run-it } + +接下來,你只需要安裝 `pytest`。 + +請先建立並啟用一個[虛擬環境](../virtual-environments.md){.internal-link target=_blank},然後安裝,例如: + +
+ +```console +$ pip install pytest + +---> 100% +``` + +
+ +它會自動偵測檔案與測試、執行它們,並把結果回報給你。 + +用以下指令執行測試: + +
+ +```console +$ pytest + +================ test session starts ================ +platform linux -- Python 3.6.9, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 +rootdir: /home/user/code/superawesome-cli/app +plugins: forked-1.1.3, xdist-1.31.0, cov-2.8.1 +collected 6 items + +---> 100% + +test_main.py ...... [100%] + +================= 1 passed in 0.03s ================= +``` + +
diff --git a/docs/zh-hant/docs/virtual-environments.md b/docs/zh-hant/docs/virtual-environments.md index acd1d914ea..74b8b9f8c8 100644 --- a/docs/zh-hant/docs/virtual-environments.md +++ b/docs/zh-hant/docs/virtual-environments.md @@ -30,7 +30,7 @@ 首先,為你的專案建立一個目錄。 -我(指原作者 —— 譯者注)通常會在我的主目錄下建立一個名為 `code` 的目錄。 +我通常會在我的主目錄下建立一個名為 `code` 的目錄。 在這個目錄下,我再為每個專案建立一個目錄。 @@ -53,7 +53,7 @@ $ cd awesome-project ## 建立一個虛擬環境 { #create-a-virtual-environment } -在開始一個 Python 專案的**第一時間**,**在你的專案內部**建立一個虛擬環境。 +在開始一個 Python 專案的**第一時間**,**在你的專案內部**建立一個虛擬環境。 /// tip @@ -412,7 +412,7 @@ Hello World ## 設定編輯器 { #configure-your-editor } -你可能會用到編輯器,請確保設定它使用你建立的相同虛擬環境(它可能會自動偵測到),以便你可以獲得自動完成和内嵌錯誤提示。 +你可能會用到編輯器,請確保設定它使用你建立的相同虛擬環境(它可能會自動偵測到),以便你可以獲得自動完成和內嵌錯誤提示。 例如: diff --git a/docs_src/additional_responses/tutorial001_py39.py b/docs_src/additional_responses/tutorial001_py39.py deleted file mode 100644 index ffa821b910..0000000000 --- a/docs_src/additional_responses/tutorial001_py39.py +++ /dev/null @@ -1,22 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import JSONResponse -from pydantic import BaseModel - - -class Item(BaseModel): - id: str - value: str - - -class Message(BaseModel): - message: str - - -app = FastAPI() - - -@app.get("/items/{item_id}", response_model=Item, responses={404: {"model": Message}}) -async def read_item(item_id: str): - if item_id == "foo": - return {"id": "foo", "value": "there goes my hero"} - return JSONResponse(status_code=404, content={"message": "Item not found"}) diff --git a/docs_src/additional_responses/tutorial003_py39.py b/docs_src/additional_responses/tutorial003_py39.py deleted file mode 100644 index f3e41e8d26..0000000000 --- a/docs_src/additional_responses/tutorial003_py39.py +++ /dev/null @@ -1,37 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import JSONResponse -from pydantic import BaseModel - - -class Item(BaseModel): - id: str - value: str - - -class Message(BaseModel): - message: str - - -app = FastAPI() - - -@app.get( - "/items/{item_id}", - response_model=Item, - responses={ - 404: {"model": Message, "description": "The item was not found"}, - 200: { - "description": "Item requested by ID", - "content": { - "application/json": { - "example": {"id": "bar", "value": "The bar tenders"} - } - }, - }, - }, -) -async def read_item(item_id: str): - if item_id == "foo": - return {"id": "foo", "value": "there goes my hero"} - else: - return JSONResponse(status_code=404, content={"message": "Item not found"}) diff --git a/docs_src/advanced_middleware/tutorial001_py39.py b/docs_src/advanced_middleware/tutorial001_py39.py deleted file mode 100644 index 35dbd30461..0000000000 --- a/docs_src/advanced_middleware/tutorial001_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import FastAPI -from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware - -app = FastAPI() - -app.add_middleware(HTTPSRedirectMiddleware) - - -@app.get("/") -async def main(): - return {"message": "Hello World"} diff --git a/docs_src/advanced_middleware/tutorial002_py39.py b/docs_src/advanced_middleware/tutorial002_py39.py deleted file mode 100644 index 405235ab9b..0000000000 --- a/docs_src/advanced_middleware/tutorial002_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from fastapi import FastAPI -from fastapi.middleware.trustedhost import TrustedHostMiddleware - -app = FastAPI() - -app.add_middleware( - TrustedHostMiddleware, allowed_hosts=["example.com", "*.example.com"] -) - - -@app.get("/") -async def main(): - return {"message": "Hello World"} diff --git a/docs_src/advanced_middleware/tutorial003_py39.py b/docs_src/advanced_middleware/tutorial003_py39.py deleted file mode 100644 index e2c87e67d8..0000000000 --- a/docs_src/advanced_middleware/tutorial003_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import FastAPI -from fastapi.middleware.gzip import GZipMiddleware - -app = FastAPI() - -app.add_middleware(GZipMiddleware, minimum_size=1000, compresslevel=5) - - -@app.get("/") -async def main(): - return "somebigcontent" diff --git a/docs_src/app_testing/app_a_py39/__init__.py b/docs_src/app_testing/app_a_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/app_testing/app_a_py39/main.py b/docs_src/app_testing/app_a_py39/main.py deleted file mode 100644 index 4679aec9cc..0000000000 --- a/docs_src/app_testing/app_a_py39/main.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/") -async def read_main(): - return {"msg": "Hello World"} diff --git a/docs_src/app_testing/app_a_py39/test_main.py b/docs_src/app_testing/app_a_py39/test_main.py deleted file mode 100644 index ddc013f40c..0000000000 --- a/docs_src/app_testing/app_a_py39/test_main.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi.testclient import TestClient - -from .main import app - -client = TestClient(app) - - -def test_read_main(): - response = client.get("/") - assert response.status_code == 200 - assert response.json() == {"msg": "Hello World"} diff --git a/docs_src/app_testing/tutorial001_py39.py b/docs_src/app_testing/tutorial001_py39.py deleted file mode 100644 index 79a853b487..0000000000 --- a/docs_src/app_testing/tutorial001_py39.py +++ /dev/null @@ -1,18 +0,0 @@ -from fastapi import FastAPI -from fastapi.testclient import TestClient - -app = FastAPI() - - -@app.get("/") -async def read_main(): - return {"msg": "Hello World"} - - -client = TestClient(app) - - -def test_read_main(): - response = client.get("/") - assert response.status_code == 200 - assert response.json() == {"msg": "Hello World"} diff --git a/docs_src/app_testing/tutorial002_py39.py b/docs_src/app_testing/tutorial002_py39.py deleted file mode 100644 index 71c898b3cf..0000000000 --- a/docs_src/app_testing/tutorial002_py39.py +++ /dev/null @@ -1,31 +0,0 @@ -from fastapi import FastAPI -from fastapi.testclient import TestClient -from fastapi.websockets import WebSocket - -app = FastAPI() - - -@app.get("/") -async def read_main(): - return {"msg": "Hello World"} - - -@app.websocket("/ws") -async def websocket(websocket: WebSocket): - await websocket.accept() - await websocket.send_json({"msg": "Hello WebSocket"}) - await websocket.close() - - -def test_read_main(): - client = TestClient(app) - response = client.get("/") - assert response.status_code == 200 - assert response.json() == {"msg": "Hello World"} - - -def test_websocket(): - client = TestClient(app) - with client.websocket_connect("/ws") as websocket: - data = websocket.receive_json() - assert data == {"msg": "Hello WebSocket"} diff --git a/docs_src/app_testing/tutorial003_py39.py b/docs_src/app_testing/tutorial003_py39.py deleted file mode 100644 index ca6b45ce03..0000000000 --- a/docs_src/app_testing/tutorial003_py39.py +++ /dev/null @@ -1,24 +0,0 @@ -from fastapi import FastAPI -from fastapi.testclient import TestClient - -app = FastAPI() - -items = {} - - -@app.on_event("startup") -async def startup_event(): - items["foo"] = {"name": "Fighters"} - items["bar"] = {"name": "Tenders"} - - -@app.get("/items/{item_id}") -async def read_items(item_id: str): - return items[item_id] - - -def test_read_items(): - with TestClient(app) as client: - response = client.get("/items/foo") - assert response.status_code == 200 - assert response.json() == {"name": "Fighters"} diff --git a/docs_src/app_testing/tutorial004_py39.py b/docs_src/app_testing/tutorial004_py39.py deleted file mode 100644 index f83ac9ae9a..0000000000 --- a/docs_src/app_testing/tutorial004_py39.py +++ /dev/null @@ -1,43 +0,0 @@ -from contextlib import asynccontextmanager - -from fastapi import FastAPI -from fastapi.testclient import TestClient - -items = {} - - -@asynccontextmanager -async def lifespan(app: FastAPI): - items["foo"] = {"name": "Fighters"} - items["bar"] = {"name": "Tenders"} - yield - # clean up items - items.clear() - - -app = FastAPI(lifespan=lifespan) - - -@app.get("/items/{item_id}") -async def read_items(item_id: str): - return items[item_id] - - -def test_read_items(): - # Before the lifespan starts, "items" is still empty - assert items == {} - - with TestClient(app) as client: - # Inside the "with TestClient" block, the lifespan starts and items added - assert items == {"foo": {"name": "Fighters"}, "bar": {"name": "Tenders"}} - - response = client.get("/items/foo") - assert response.status_code == 200 - assert response.json() == {"name": "Fighters"} - - # After the requests is done, the items are still there - assert items == {"foo": {"name": "Fighters"}, "bar": {"name": "Tenders"}} - - # The end of the "with TestClient" block simulates terminating the app, so - # the lifespan ends and items are cleaned up - assert items == {} diff --git a/docs_src/async_tests/app_a_py39/__init__.py b/docs_src/async_tests/app_a_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/async_tests/app_a_py39/main.py b/docs_src/async_tests/app_a_py39/main.py deleted file mode 100644 index 9594f859c7..0000000000 --- a/docs_src/async_tests/app_a_py39/main.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/") -async def root(): - return {"message": "Tomato"} diff --git a/docs_src/async_tests/app_a_py39/test_main.py b/docs_src/async_tests/app_a_py39/test_main.py deleted file mode 100644 index a57a31f7d8..0000000000 --- a/docs_src/async_tests/app_a_py39/test_main.py +++ /dev/null @@ -1,14 +0,0 @@ -import pytest -from httpx import ASGITransport, AsyncClient - -from .main import app - - -@pytest.mark.anyio -async def test_root(): - async with AsyncClient( - transport=ASGITransport(app=app), base_url="http://test" - ) as ac: - response = await ac.get("/") - assert response.status_code == 200 - assert response.json() == {"message": "Tomato"} diff --git a/docs_src/authentication_error_status_code/tutorial001_an_py39.py b/docs_src/authentication_error_status_code/tutorial001_an_py39.py deleted file mode 100644 index 7bbc2f717d..0000000000 --- a/docs_src/authentication_error_status_code/tutorial001_an_py39.py +++ /dev/null @@ -1,21 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI, HTTPException, status -from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer - -app = FastAPI() - - -class HTTPBearer403(HTTPBearer): - def make_not_authenticated_error(self) -> HTTPException: - return HTTPException( - status_code=status.HTTP_403_FORBIDDEN, detail="Not authenticated" - ) - - -CredentialsDep = Annotated[HTTPAuthorizationCredentials, Depends(HTTPBearer403())] - - -@app.get("/me") -def read_me(credentials: CredentialsDep): - return {"message": "You are authenticated", "token": credentials.credentials} diff --git a/docs_src/background_tasks/tutorial001_py39.py b/docs_src/background_tasks/tutorial001_py39.py deleted file mode 100644 index 1720a74333..0000000000 --- a/docs_src/background_tasks/tutorial001_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from fastapi import BackgroundTasks, FastAPI - -app = FastAPI() - - -def write_notification(email: str, message=""): - with open("log.txt", mode="w") as email_file: - content = f"notification for {email}: {message}" - email_file.write(content) - - -@app.post("/send-notification/{email}") -async def send_notification(email: str, background_tasks: BackgroundTasks): - background_tasks.add_task(write_notification, email, message="some notification") - return {"message": "Notification sent in the background"} diff --git a/docs_src/behind_a_proxy/tutorial001_01_py39.py b/docs_src/behind_a_proxy/tutorial001_01_py39.py deleted file mode 100644 index 52b114395b..0000000000 --- a/docs_src/behind_a_proxy/tutorial001_01_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/items/") -def read_items(): - return ["plumbus", "portal gun"] diff --git a/docs_src/behind_a_proxy/tutorial001_py39.py b/docs_src/behind_a_proxy/tutorial001_py39.py deleted file mode 100644 index ede59ada11..0000000000 --- a/docs_src/behind_a_proxy/tutorial001_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI, Request - -app = FastAPI() - - -@app.get("/app") -def read_main(request: Request): - return {"message": "Hello World", "root_path": request.scope.get("root_path")} diff --git a/docs_src/behind_a_proxy/tutorial002_py39.py b/docs_src/behind_a_proxy/tutorial002_py39.py deleted file mode 100644 index c1600cde9e..0000000000 --- a/docs_src/behind_a_proxy/tutorial002_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI, Request - -app = FastAPI(root_path="/api/v1") - - -@app.get("/app") -def read_main(request: Request): - return {"message": "Hello World", "root_path": request.scope.get("root_path")} diff --git a/docs_src/behind_a_proxy/tutorial003_py39.py b/docs_src/behind_a_proxy/tutorial003_py39.py deleted file mode 100644 index 3b7d8be018..0000000000 --- a/docs_src/behind_a_proxy/tutorial003_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import FastAPI, Request - -app = FastAPI( - servers=[ - {"url": "https://stag.example.com", "description": "Staging environment"}, - {"url": "https://prod.example.com", "description": "Production environment"}, - ], - root_path="/api/v1", -) - - -@app.get("/app") -def read_main(request: Request): - return {"message": "Hello World", "root_path": request.scope.get("root_path")} diff --git a/docs_src/behind_a_proxy/tutorial004_py39.py b/docs_src/behind_a_proxy/tutorial004_py39.py deleted file mode 100644 index 51bd5babc1..0000000000 --- a/docs_src/behind_a_proxy/tutorial004_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from fastapi import FastAPI, Request - -app = FastAPI( - servers=[ - {"url": "https://stag.example.com", "description": "Staging environment"}, - {"url": "https://prod.example.com", "description": "Production environment"}, - ], - root_path="/api/v1", - root_path_in_servers=False, -) - - -@app.get("/app") -def read_main(request: Request): - return {"message": "Hello World", "root_path": request.scope.get("root_path")} diff --git a/docs_src/bigger_applications/app_an_py39/__init__.py b/docs_src/bigger_applications/app_an_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/bigger_applications/app_an_py39/dependencies.py b/docs_src/bigger_applications/app_an_py39/dependencies.py deleted file mode 100644 index 5c7612aa09..0000000000 --- a/docs_src/bigger_applications/app_an_py39/dependencies.py +++ /dev/null @@ -1,13 +0,0 @@ -from typing import Annotated - -from fastapi import Header, HTTPException - - -async def get_token_header(x_token: Annotated[str, Header()]): - if x_token != "fake-super-secret-token": - raise HTTPException(status_code=400, detail="X-Token header invalid") - - -async def get_query_token(token: str): - if token != "jessica": - raise HTTPException(status_code=400, detail="No Jessica token provided") diff --git a/docs_src/bigger_applications/app_an_py39/internal/__init__.py b/docs_src/bigger_applications/app_an_py39/internal/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/bigger_applications/app_an_py39/internal/admin.py b/docs_src/bigger_applications/app_an_py39/internal/admin.py deleted file mode 100644 index 99d3da86b9..0000000000 --- a/docs_src/bigger_applications/app_an_py39/internal/admin.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import APIRouter - -router = APIRouter() - - -@router.post("/") -async def update_admin(): - return {"message": "Admin getting schwifty"} diff --git a/docs_src/bigger_applications/app_an_py39/main.py b/docs_src/bigger_applications/app_an_py39/main.py deleted file mode 100644 index ae544a3aac..0000000000 --- a/docs_src/bigger_applications/app_an_py39/main.py +++ /dev/null @@ -1,23 +0,0 @@ -from fastapi import Depends, FastAPI - -from .dependencies import get_query_token, get_token_header -from .internal import admin -from .routers import items, users - -app = FastAPI(dependencies=[Depends(get_query_token)]) - - -app.include_router(users.router) -app.include_router(items.router) -app.include_router( - admin.router, - prefix="/admin", - tags=["admin"], - dependencies=[Depends(get_token_header)], - responses={418: {"description": "I'm a teapot"}}, -) - - -@app.get("/") -async def root(): - return {"message": "Hello Bigger Applications!"} diff --git a/docs_src/bigger_applications/app_an_py39/routers/__init__.py b/docs_src/bigger_applications/app_an_py39/routers/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/bigger_applications/app_an_py39/routers/items.py b/docs_src/bigger_applications/app_an_py39/routers/items.py deleted file mode 100644 index bde9ff4d55..0000000000 --- a/docs_src/bigger_applications/app_an_py39/routers/items.py +++ /dev/null @@ -1,38 +0,0 @@ -from fastapi import APIRouter, Depends, HTTPException - -from ..dependencies import get_token_header - -router = APIRouter( - prefix="/items", - tags=["items"], - dependencies=[Depends(get_token_header)], - responses={404: {"description": "Not found"}}, -) - - -fake_items_db = {"plumbus": {"name": "Plumbus"}, "gun": {"name": "Portal Gun"}} - - -@router.get("/") -async def read_items(): - return fake_items_db - - -@router.get("/{item_id}") -async def read_item(item_id: str): - if item_id not in fake_items_db: - raise HTTPException(status_code=404, detail="Item not found") - return {"name": fake_items_db[item_id]["name"], "item_id": item_id} - - -@router.put( - "/{item_id}", - tags=["custom"], - responses={403: {"description": "Operation forbidden"}}, -) -async def update_item(item_id: str): - if item_id != "plumbus": - raise HTTPException( - status_code=403, detail="You can only update the item: plumbus" - ) - return {"item_id": item_id, "name": "The great Plumbus"} diff --git a/docs_src/bigger_applications/app_an_py39/routers/users.py b/docs_src/bigger_applications/app_an_py39/routers/users.py deleted file mode 100644 index 39b3d7e7cf..0000000000 --- a/docs_src/bigger_applications/app_an_py39/routers/users.py +++ /dev/null @@ -1,18 +0,0 @@ -from fastapi import APIRouter - -router = APIRouter() - - -@router.get("/users/", tags=["users"]) -async def read_users(): - return [{"username": "Rick"}, {"username": "Morty"}] - - -@router.get("/users/me", tags=["users"]) -async def read_user_me(): - return {"username": "fakecurrentuser"} - - -@router.get("/users/{username}", tags=["users"]) -async def read_user(username: str): - return {"username": username} diff --git a/docs_src/bigger_applications/app_py39/__init__.py b/docs_src/bigger_applications/app_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/bigger_applications/app_py39/dependencies.py b/docs_src/bigger_applications/app_py39/dependencies.py deleted file mode 100644 index 8e45f004b4..0000000000 --- a/docs_src/bigger_applications/app_py39/dependencies.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import Header, HTTPException - - -async def get_token_header(x_token: str = Header()): - if x_token != "fake-super-secret-token": - raise HTTPException(status_code=400, detail="X-Token header invalid") - - -async def get_query_token(token: str): - if token != "jessica": - raise HTTPException(status_code=400, detail="No Jessica token provided") diff --git a/docs_src/bigger_applications/app_py39/main.py b/docs_src/bigger_applications/app_py39/main.py deleted file mode 100644 index ae544a3aac..0000000000 --- a/docs_src/bigger_applications/app_py39/main.py +++ /dev/null @@ -1,23 +0,0 @@ -from fastapi import Depends, FastAPI - -from .dependencies import get_query_token, get_token_header -from .internal import admin -from .routers import items, users - -app = FastAPI(dependencies=[Depends(get_query_token)]) - - -app.include_router(users.router) -app.include_router(items.router) -app.include_router( - admin.router, - prefix="/admin", - tags=["admin"], - dependencies=[Depends(get_token_header)], - responses={418: {"description": "I'm a teapot"}}, -) - - -@app.get("/") -async def root(): - return {"message": "Hello Bigger Applications!"} diff --git a/docs_src/body_nested_models/tutorial008_py39.py b/docs_src/body_nested_models/tutorial008_py39.py deleted file mode 100644 index 854a7a5a46..0000000000 --- a/docs_src/body_nested_models/tutorial008_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import FastAPI -from pydantic import BaseModel, HttpUrl - -app = FastAPI() - - -class Image(BaseModel): - url: HttpUrl - name: str - - -@app.post("/images/multiple/") -async def create_multiple_images(images: list[Image]): - return images diff --git a/docs_src/body_nested_models/tutorial009_py39.py b/docs_src/body_nested_models/tutorial009_py39.py deleted file mode 100644 index 59c1e50828..0000000000 --- a/docs_src/body_nested_models/tutorial009_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.post("/index-weights/") -async def create_index_weights(weights: dict[int, float]): - return weights diff --git a/docs_src/conditional_openapi/tutorial001_py39.py b/docs_src/conditional_openapi/tutorial001_py39.py deleted file mode 100644 index eedb0d2742..0000000000 --- a/docs_src/conditional_openapi/tutorial001_py39.py +++ /dev/null @@ -1,16 +0,0 @@ -from fastapi import FastAPI -from pydantic_settings import BaseSettings - - -class Settings(BaseSettings): - openapi_url: str = "/openapi.json" - - -settings = Settings() - -app = FastAPI(openapi_url=settings.openapi_url) - - -@app.get("/") -def root(): - return {"message": "Hello World"} diff --git a/docs_src/configure_swagger_ui/tutorial001_py39.py b/docs_src/configure_swagger_ui/tutorial001_py39.py deleted file mode 100644 index 6c24ce7583..0000000000 --- a/docs_src/configure_swagger_ui/tutorial001_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI(swagger_ui_parameters={"syntaxHighlight": False}) - - -@app.get("/users/{username}") -async def read_user(username: str): - return {"message": f"Hello {username}"} diff --git a/docs_src/configure_swagger_ui/tutorial002_py39.py b/docs_src/configure_swagger_ui/tutorial002_py39.py deleted file mode 100644 index cc75c21968..0000000000 --- a/docs_src/configure_swagger_ui/tutorial002_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI(swagger_ui_parameters={"syntaxHighlight": {"theme": "obsidian"}}) - - -@app.get("/users/{username}") -async def read_user(username: str): - return {"message": f"Hello {username}"} diff --git a/docs_src/configure_swagger_ui/tutorial003_py39.py b/docs_src/configure_swagger_ui/tutorial003_py39.py deleted file mode 100644 index b4449f5c6a..0000000000 --- a/docs_src/configure_swagger_ui/tutorial003_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI(swagger_ui_parameters={"deepLinking": False}) - - -@app.get("/users/{username}") -async def read_user(username: str): - return {"message": f"Hello {username}"} diff --git a/docs_src/cors/tutorial001_py39.py b/docs_src/cors/tutorial001_py39.py deleted file mode 100644 index d59ab27acc..0000000000 --- a/docs_src/cors/tutorial001_py39.py +++ /dev/null @@ -1,24 +0,0 @@ -from fastapi import FastAPI -from fastapi.middleware.cors import CORSMiddleware - -app = FastAPI() - -origins = [ - "http://localhost.tiangolo.com", - "https://localhost.tiangolo.com", - "http://localhost", - "http://localhost:8080", -] - -app.add_middleware( - CORSMiddleware, - allow_origins=origins, - allow_credentials=True, - allow_methods=["*"], - allow_headers=["*"], -) - - -@app.get("/") -async def main(): - return {"message": "Hello World"} diff --git a/docs_src/custom_docs_ui/tutorial001_py39.py b/docs_src/custom_docs_ui/tutorial001_py39.py deleted file mode 100644 index 1cfcce19aa..0000000000 --- a/docs_src/custom_docs_ui/tutorial001_py39.py +++ /dev/null @@ -1,38 +0,0 @@ -from fastapi import FastAPI -from fastapi.openapi.docs import ( - get_redoc_html, - get_swagger_ui_html, - get_swagger_ui_oauth2_redirect_html, -) - -app = FastAPI(docs_url=None, redoc_url=None) - - -@app.get("/docs", include_in_schema=False) -async def custom_swagger_ui_html(): - return get_swagger_ui_html( - openapi_url=app.openapi_url, - title=app.title + " - Swagger UI", - oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url, - swagger_js_url="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js", - swagger_css_url="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css", - ) - - -@app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False) -async def swagger_ui_redirect(): - return get_swagger_ui_oauth2_redirect_html() - - -@app.get("/redoc", include_in_schema=False) -async def redoc_html(): - return get_redoc_html( - openapi_url=app.openapi_url, - title=app.title + " - ReDoc", - redoc_js_url="https://unpkg.com/redoc@2/bundles/redoc.standalone.js", - ) - - -@app.get("/users/{username}") -async def read_user(username: str): - return {"message": f"Hello {username}"} diff --git a/docs_src/custom_docs_ui/tutorial002_py39.py b/docs_src/custom_docs_ui/tutorial002_py39.py deleted file mode 100644 index 23ea368f8b..0000000000 --- a/docs_src/custom_docs_ui/tutorial002_py39.py +++ /dev/null @@ -1,41 +0,0 @@ -from fastapi import FastAPI -from fastapi.openapi.docs import ( - get_redoc_html, - get_swagger_ui_html, - get_swagger_ui_oauth2_redirect_html, -) -from fastapi.staticfiles import StaticFiles - -app = FastAPI(docs_url=None, redoc_url=None) - -app.mount("/static", StaticFiles(directory="static"), name="static") - - -@app.get("/docs", include_in_schema=False) -async def custom_swagger_ui_html(): - return get_swagger_ui_html( - openapi_url=app.openapi_url, - title=app.title + " - Swagger UI", - oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url, - swagger_js_url="/static/swagger-ui-bundle.js", - swagger_css_url="/static/swagger-ui.css", - ) - - -@app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False) -async def swagger_ui_redirect(): - return get_swagger_ui_oauth2_redirect_html() - - -@app.get("/redoc", include_in_schema=False) -async def redoc_html(): - return get_redoc_html( - openapi_url=app.openapi_url, - title=app.title + " - ReDoc", - redoc_js_url="/static/redoc.standalone.js", - ) - - -@app.get("/users/{username}") -async def read_user(username: str): - return {"message": f"Hello {username}"} diff --git a/docs_src/custom_response/tutorial001_py39.py b/docs_src/custom_response/tutorial001_py39.py deleted file mode 100644 index 0f09bdf77f..0000000000 --- a/docs_src/custom_response/tutorial001_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import UJSONResponse - -app = FastAPI() - - -@app.get("/items/", response_class=UJSONResponse) -async def read_items(): - return [{"item_id": "Foo"}] diff --git a/docs_src/custom_response/tutorial001b_py39.py b/docs_src/custom_response/tutorial001b_py39.py deleted file mode 100644 index 95e6ca7637..0000000000 --- a/docs_src/custom_response/tutorial001b_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import ORJSONResponse - -app = FastAPI() - - -@app.get("/items/", response_class=ORJSONResponse) -async def read_items(): - return ORJSONResponse([{"item_id": "Foo"}]) diff --git a/docs_src/custom_response/tutorial002_py39.py b/docs_src/custom_response/tutorial002_py39.py deleted file mode 100644 index 23c495867b..0000000000 --- a/docs_src/custom_response/tutorial002_py39.py +++ /dev/null @@ -1,18 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import HTMLResponse - -app = FastAPI() - - -@app.get("/items/", response_class=HTMLResponse) -async def read_items(): - return """ - - - Some HTML in here - - -

Look ma! HTML!

- - - """ diff --git a/docs_src/custom_response/tutorial003_py39.py b/docs_src/custom_response/tutorial003_py39.py deleted file mode 100644 index 51ad3c146b..0000000000 --- a/docs_src/custom_response/tutorial003_py39.py +++ /dev/null @@ -1,19 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import HTMLResponse - -app = FastAPI() - - -@app.get("/items/") -async def read_items(): - html_content = """ - - - Some HTML in here - - -

Look ma! HTML!

- - - """ - return HTMLResponse(content=html_content, status_code=200) diff --git a/docs_src/custom_response/tutorial004_py39.py b/docs_src/custom_response/tutorial004_py39.py deleted file mode 100644 index 0e90f20126..0000000000 --- a/docs_src/custom_response/tutorial004_py39.py +++ /dev/null @@ -1,23 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import HTMLResponse - -app = FastAPI() - - -def generate_html_response(): - html_content = """ - - - Some HTML in here - - -

Look ma! HTML!

- - - """ - return HTMLResponse(content=html_content, status_code=200) - - -@app.get("/items/", response_class=HTMLResponse) -async def read_items(): - return generate_html_response() diff --git a/docs_src/custom_response/tutorial005_py39.py b/docs_src/custom_response/tutorial005_py39.py deleted file mode 100644 index 3d58f57fb6..0000000000 --- a/docs_src/custom_response/tutorial005_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import PlainTextResponse - -app = FastAPI() - - -@app.get("/", response_class=PlainTextResponse) -async def main(): - return "Hello World" diff --git a/docs_src/custom_response/tutorial006_py39.py b/docs_src/custom_response/tutorial006_py39.py deleted file mode 100644 index 332f8f87f1..0000000000 --- a/docs_src/custom_response/tutorial006_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import RedirectResponse - -app = FastAPI() - - -@app.get("/typer") -async def redirect_typer(): - return RedirectResponse("https://typer.tiangolo.com") diff --git a/docs_src/custom_response/tutorial006b_py39.py b/docs_src/custom_response/tutorial006b_py39.py deleted file mode 100644 index 03a7be3995..0000000000 --- a/docs_src/custom_response/tutorial006b_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import RedirectResponse - -app = FastAPI() - - -@app.get("/fastapi", response_class=RedirectResponse) -async def redirect_fastapi(): - return "https://fastapi.tiangolo.com" diff --git a/docs_src/custom_response/tutorial006c_py39.py b/docs_src/custom_response/tutorial006c_py39.py deleted file mode 100644 index 87c720364b..0000000000 --- a/docs_src/custom_response/tutorial006c_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import RedirectResponse - -app = FastAPI() - - -@app.get("/pydantic", response_class=RedirectResponse, status_code=302) -async def redirect_pydantic(): - return "https://docs.pydantic.dev/" diff --git a/docs_src/custom_response/tutorial007_py39.py b/docs_src/custom_response/tutorial007_py39.py deleted file mode 100644 index e2a53a2119..0000000000 --- a/docs_src/custom_response/tutorial007_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import StreamingResponse - -app = FastAPI() - - -async def fake_video_streamer(): - for i in range(10): - yield b"some fake video bytes" - - -@app.get("/") -async def main(): - return StreamingResponse(fake_video_streamer()) diff --git a/docs_src/custom_response/tutorial008_py39.py b/docs_src/custom_response/tutorial008_py39.py deleted file mode 100644 index fc071cbee4..0000000000 --- a/docs_src/custom_response/tutorial008_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import StreamingResponse - -some_file_path = "large-video-file.mp4" -app = FastAPI() - - -@app.get("/") -def main(): - def iterfile(): # (1) - with open(some_file_path, mode="rb") as file_like: # (2) - yield from file_like # (3) - - return StreamingResponse(iterfile(), media_type="video/mp4") diff --git a/docs_src/custom_response/tutorial009_py39.py b/docs_src/custom_response/tutorial009_py39.py deleted file mode 100644 index 71cf50cc18..0000000000 --- a/docs_src/custom_response/tutorial009_py39.py +++ /dev/null @@ -1,10 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import FileResponse - -some_file_path = "large-video-file.mp4" -app = FastAPI() - - -@app.get("/") -async def main(): - return FileResponse(some_file_path) diff --git a/docs_src/custom_response/tutorial009b_py39.py b/docs_src/custom_response/tutorial009b_py39.py deleted file mode 100644 index 27200ee4ba..0000000000 --- a/docs_src/custom_response/tutorial009b_py39.py +++ /dev/null @@ -1,10 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import FileResponse - -some_file_path = "large-video-file.mp4" -app = FastAPI() - - -@app.get("/", response_class=FileResponse) -async def main(): - return some_file_path diff --git a/docs_src/custom_response/tutorial009c_py39.py b/docs_src/custom_response/tutorial009c_py39.py deleted file mode 100644 index de6b6688e6..0000000000 --- a/docs_src/custom_response/tutorial009c_py39.py +++ /dev/null @@ -1,19 +0,0 @@ -from typing import Any - -import orjson -from fastapi import FastAPI, Response - -app = FastAPI() - - -class CustomORJSONResponse(Response): - media_type = "application/json" - - def render(self, content: Any) -> bytes: - assert orjson is not None, "orjson must be installed" - return orjson.dumps(content, option=orjson.OPT_INDENT_2) - - -@app.get("/", response_class=CustomORJSONResponse) -async def main(): - return {"message": "Hello World"} diff --git a/docs_src/custom_response/tutorial010_py39.py b/docs_src/custom_response/tutorial010_py39.py deleted file mode 100644 index 57cb062604..0000000000 --- a/docs_src/custom_response/tutorial010_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import ORJSONResponse - -app = FastAPI(default_response_class=ORJSONResponse) - - -@app.get("/items/") -async def read_items(): - return [{"item_id": "Foo"}] diff --git a/docs_src/debugging/tutorial001_py39.py b/docs_src/debugging/tutorial001_py39.py deleted file mode 100644 index 3de21d2a82..0000000000 --- a/docs_src/debugging/tutorial001_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -import uvicorn -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/") -def root(): - a = "a" - b = "b" + a - return {"hello world": b} - - -if __name__ == "__main__": - uvicorn.run(app, host="0.0.0.0", port=8000) diff --git a/docs_src/dependencies/tutorial006_an_py39.py b/docs_src/dependencies/tutorial006_an_py39.py deleted file mode 100644 index 11976ed6a2..0000000000 --- a/docs_src/dependencies/tutorial006_an_py39.py +++ /dev/null @@ -1,21 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI, Header, HTTPException - -app = FastAPI() - - -async def verify_token(x_token: Annotated[str, Header()]): - if x_token != "fake-super-secret-token": - raise HTTPException(status_code=400, detail="X-Token header invalid") - - -async def verify_key(x_key: Annotated[str, Header()]): - if x_key != "fake-super-secret-key": - raise HTTPException(status_code=400, detail="X-Key header invalid") - return x_key - - -@app.get("/items/", dependencies=[Depends(verify_token), Depends(verify_key)]) -async def read_items(): - return [{"item": "Foo"}, {"item": "Bar"}] diff --git a/docs_src/dependencies/tutorial006_py39.py b/docs_src/dependencies/tutorial006_py39.py deleted file mode 100644 index 9aff4154f4..0000000000 --- a/docs_src/dependencies/tutorial006_py39.py +++ /dev/null @@ -1,19 +0,0 @@ -from fastapi import Depends, FastAPI, Header, HTTPException - -app = FastAPI() - - -async def verify_token(x_token: str = Header()): - if x_token != "fake-super-secret-token": - raise HTTPException(status_code=400, detail="X-Token header invalid") - - -async def verify_key(x_key: str = Header()): - if x_key != "fake-super-secret-key": - raise HTTPException(status_code=400, detail="X-Key header invalid") - return x_key - - -@app.get("/items/", dependencies=[Depends(verify_token), Depends(verify_key)]) -async def read_items(): - return [{"item": "Foo"}, {"item": "Bar"}] diff --git a/docs_src/dependencies/tutorial007_py39.py b/docs_src/dependencies/tutorial007_py39.py deleted file mode 100644 index 2e4ab4777b..0000000000 --- a/docs_src/dependencies/tutorial007_py39.py +++ /dev/null @@ -1,6 +0,0 @@ -async def get_db(): - db = DBSession() - try: - yield db - finally: - db.close() diff --git a/docs_src/dependencies/tutorial008_an_py39.py b/docs_src/dependencies/tutorial008_an_py39.py deleted file mode 100644 index acc804c320..0000000000 --- a/docs_src/dependencies/tutorial008_an_py39.py +++ /dev/null @@ -1,27 +0,0 @@ -from typing import Annotated - -from fastapi import Depends - - -async def dependency_a(): - dep_a = generate_dep_a() - try: - yield dep_a - finally: - dep_a.close() - - -async def dependency_b(dep_a: Annotated[DepA, Depends(dependency_a)]): - dep_b = generate_dep_b() - try: - yield dep_b - finally: - dep_b.close(dep_a) - - -async def dependency_c(dep_b: Annotated[DepB, Depends(dependency_b)]): - dep_c = generate_dep_c() - try: - yield dep_c - finally: - dep_c.close(dep_b) diff --git a/docs_src/dependencies/tutorial008_py39.py b/docs_src/dependencies/tutorial008_py39.py deleted file mode 100644 index 8472f642de..0000000000 --- a/docs_src/dependencies/tutorial008_py39.py +++ /dev/null @@ -1,25 +0,0 @@ -from fastapi import Depends - - -async def dependency_a(): - dep_a = generate_dep_a() - try: - yield dep_a - finally: - dep_a.close() - - -async def dependency_b(dep_a=Depends(dependency_a)): - dep_b = generate_dep_b() - try: - yield dep_b - finally: - dep_b.close(dep_a) - - -async def dependency_c(dep_b=Depends(dependency_b)): - dep_c = generate_dep_c() - try: - yield dep_c - finally: - dep_c.close(dep_b) diff --git a/docs_src/dependencies/tutorial008b_an_py39.py b/docs_src/dependencies/tutorial008b_an_py39.py deleted file mode 100644 index 3b8434c816..0000000000 --- a/docs_src/dependencies/tutorial008b_an_py39.py +++ /dev/null @@ -1,32 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI, HTTPException - -app = FastAPI() - - -data = { - "plumbus": {"description": "Freshly pickled plumbus", "owner": "Morty"}, - "portal-gun": {"description": "Gun to create portals", "owner": "Rick"}, -} - - -class OwnerError(Exception): - pass - - -def get_username(): - try: - yield "Rick" - except OwnerError as e: - raise HTTPException(status_code=400, detail=f"Owner error: {e}") - - -@app.get("/items/{item_id}") -def get_item(item_id: str, username: Annotated[str, Depends(get_username)]): - if item_id not in data: - raise HTTPException(status_code=404, detail="Item not found") - item = data[item_id] - if item["owner"] != username: - raise OwnerError(username) - return item diff --git a/docs_src/dependencies/tutorial008b_py39.py b/docs_src/dependencies/tutorial008b_py39.py deleted file mode 100644 index 163e96600f..0000000000 --- a/docs_src/dependencies/tutorial008b_py39.py +++ /dev/null @@ -1,30 +0,0 @@ -from fastapi import Depends, FastAPI, HTTPException - -app = FastAPI() - - -data = { - "plumbus": {"description": "Freshly pickled plumbus", "owner": "Morty"}, - "portal-gun": {"description": "Gun to create portals", "owner": "Rick"}, -} - - -class OwnerError(Exception): - pass - - -def get_username(): - try: - yield "Rick" - except OwnerError as e: - raise HTTPException(status_code=400, detail=f"Owner error: {e}") - - -@app.get("/items/{item_id}") -def get_item(item_id: str, username: str = Depends(get_username)): - if item_id not in data: - raise HTTPException(status_code=404, detail="Item not found") - item = data[item_id] - if item["owner"] != username: - raise OwnerError(username) - return item diff --git a/docs_src/dependencies/tutorial008c_an_py39.py b/docs_src/dependencies/tutorial008c_an_py39.py deleted file mode 100644 index da92efa9c3..0000000000 --- a/docs_src/dependencies/tutorial008c_an_py39.py +++ /dev/null @@ -1,29 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI, HTTPException - -app = FastAPI() - - -class InternalError(Exception): - pass - - -def get_username(): - try: - yield "Rick" - except InternalError: - print("Oops, we didn't raise again, Britney 😱") - - -@app.get("/items/{item_id}") -def get_item(item_id: str, username: Annotated[str, Depends(get_username)]): - if item_id == "portal-gun": - raise InternalError( - f"The portal gun is too dangerous to be owned by {username}" - ) - if item_id != "plumbus": - raise HTTPException( - status_code=404, detail="Item not found, there's only a plumbus here" - ) - return item_id diff --git a/docs_src/dependencies/tutorial008c_py39.py b/docs_src/dependencies/tutorial008c_py39.py deleted file mode 100644 index 4b99a5a311..0000000000 --- a/docs_src/dependencies/tutorial008c_py39.py +++ /dev/null @@ -1,27 +0,0 @@ -from fastapi import Depends, FastAPI, HTTPException - -app = FastAPI() - - -class InternalError(Exception): - pass - - -def get_username(): - try: - yield "Rick" - except InternalError: - print("Oops, we didn't raise again, Britney 😱") - - -@app.get("/items/{item_id}") -def get_item(item_id: str, username: str = Depends(get_username)): - if item_id == "portal-gun": - raise InternalError( - f"The portal gun is too dangerous to be owned by {username}" - ) - if item_id != "plumbus": - raise HTTPException( - status_code=404, detail="Item not found, there's only a plumbus here" - ) - return item_id diff --git a/docs_src/dependencies/tutorial008d_an_py39.py b/docs_src/dependencies/tutorial008d_an_py39.py deleted file mode 100644 index 99bd5cb911..0000000000 --- a/docs_src/dependencies/tutorial008d_an_py39.py +++ /dev/null @@ -1,30 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI, HTTPException - -app = FastAPI() - - -class InternalError(Exception): - pass - - -def get_username(): - try: - yield "Rick" - except InternalError: - print("We don't swallow the internal error here, we raise again 😎") - raise - - -@app.get("/items/{item_id}") -def get_item(item_id: str, username: Annotated[str, Depends(get_username)]): - if item_id == "portal-gun": - raise InternalError( - f"The portal gun is too dangerous to be owned by {username}" - ) - if item_id != "plumbus": - raise HTTPException( - status_code=404, detail="Item not found, there's only a plumbus here" - ) - return item_id diff --git a/docs_src/dependencies/tutorial008d_py39.py b/docs_src/dependencies/tutorial008d_py39.py deleted file mode 100644 index 93039343d1..0000000000 --- a/docs_src/dependencies/tutorial008d_py39.py +++ /dev/null @@ -1,28 +0,0 @@ -from fastapi import Depends, FastAPI, HTTPException - -app = FastAPI() - - -class InternalError(Exception): - pass - - -def get_username(): - try: - yield "Rick" - except InternalError: - print("We don't swallow the internal error here, we raise again 😎") - raise - - -@app.get("/items/{item_id}") -def get_item(item_id: str, username: str = Depends(get_username)): - if item_id == "portal-gun": - raise InternalError( - f"The portal gun is too dangerous to be owned by {username}" - ) - if item_id != "plumbus": - raise HTTPException( - status_code=404, detail="Item not found, there's only a plumbus here" - ) - return item_id diff --git a/docs_src/dependencies/tutorial008e_an_py39.py b/docs_src/dependencies/tutorial008e_an_py39.py deleted file mode 100644 index 80a44c7e23..0000000000 --- a/docs_src/dependencies/tutorial008e_an_py39.py +++ /dev/null @@ -1,17 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI - -app = FastAPI() - - -def get_username(): - try: - yield "Rick" - finally: - print("Cleanup up before response is sent") - - -@app.get("/users/me") -def get_user_me(username: Annotated[str, Depends(get_username, scope="function")]): - return username diff --git a/docs_src/dependencies/tutorial008e_py39.py b/docs_src/dependencies/tutorial008e_py39.py deleted file mode 100644 index 1ed056e91e..0000000000 --- a/docs_src/dependencies/tutorial008e_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from fastapi import Depends, FastAPI - -app = FastAPI() - - -def get_username(): - try: - yield "Rick" - finally: - print("Cleanup up before response is sent") - - -@app.get("/users/me") -def get_user_me(username: str = Depends(get_username, scope="function")): - return username diff --git a/docs_src/dependencies/tutorial010_py39.py b/docs_src/dependencies/tutorial010_py39.py deleted file mode 100644 index c27f1b1702..0000000000 --- a/docs_src/dependencies/tutorial010_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -class MySuperContextManager: - def __init__(self): - self.db = DBSession() - - def __enter__(self): - return self.db - - def __exit__(self, exc_type, exc_value, traceback): - self.db.close() - - -async def get_db(): - with MySuperContextManager() as db: - yield db diff --git a/docs_src/dependencies/tutorial011_an_py39.py b/docs_src/dependencies/tutorial011_an_py39.py deleted file mode 100644 index 68b7434ec2..0000000000 --- a/docs_src/dependencies/tutorial011_an_py39.py +++ /dev/null @@ -1,23 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI - -app = FastAPI() - - -class FixedContentQueryChecker: - def __init__(self, fixed_content: str): - self.fixed_content = fixed_content - - def __call__(self, q: str = ""): - if q: - return self.fixed_content in q - return False - - -checker = FixedContentQueryChecker("bar") - - -@app.get("/query-checker/") -async def read_query_check(fixed_content_included: Annotated[bool, Depends(checker)]): - return {"fixed_content_in_query": fixed_content_included} diff --git a/docs_src/dependencies/tutorial011_py39.py b/docs_src/dependencies/tutorial011_py39.py deleted file mode 100644 index 5d22f68237..0000000000 --- a/docs_src/dependencies/tutorial011_py39.py +++ /dev/null @@ -1,21 +0,0 @@ -from fastapi import Depends, FastAPI - -app = FastAPI() - - -class FixedContentQueryChecker: - def __init__(self, fixed_content: str): - self.fixed_content = fixed_content - - def __call__(self, q: str = ""): - if q: - return self.fixed_content in q - return False - - -checker = FixedContentQueryChecker("bar") - - -@app.get("/query-checker/") -async def read_query_check(fixed_content_included: bool = Depends(checker)): - return {"fixed_content_in_query": fixed_content_included} diff --git a/docs_src/dependencies/tutorial012_an_py39.py b/docs_src/dependencies/tutorial012_an_py39.py deleted file mode 100644 index 6503591fc3..0000000000 --- a/docs_src/dependencies/tutorial012_an_py39.py +++ /dev/null @@ -1,27 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI, Header, HTTPException - - -async def verify_token(x_token: Annotated[str, Header()]): - if x_token != "fake-super-secret-token": - raise HTTPException(status_code=400, detail="X-Token header invalid") - - -async def verify_key(x_key: Annotated[str, Header()]): - if x_key != "fake-super-secret-key": - raise HTTPException(status_code=400, detail="X-Key header invalid") - return x_key - - -app = FastAPI(dependencies=[Depends(verify_token), Depends(verify_key)]) - - -@app.get("/items/") -async def read_items(): - return [{"item": "Portal Gun"}, {"item": "Plumbus"}] - - -@app.get("/users/") -async def read_users(): - return [{"username": "Rick"}, {"username": "Morty"}] diff --git a/docs_src/dependencies/tutorial012_py39.py b/docs_src/dependencies/tutorial012_py39.py deleted file mode 100644 index 36ce6c7111..0000000000 --- a/docs_src/dependencies/tutorial012_py39.py +++ /dev/null @@ -1,25 +0,0 @@ -from fastapi import Depends, FastAPI, Header, HTTPException - - -async def verify_token(x_token: str = Header()): - if x_token != "fake-super-secret-token": - raise HTTPException(status_code=400, detail="X-Token header invalid") - - -async def verify_key(x_key: str = Header()): - if x_key != "fake-super-secret-key": - raise HTTPException(status_code=400, detail="X-Key header invalid") - return x_key - - -app = FastAPI(dependencies=[Depends(verify_token), Depends(verify_key)]) - - -@app.get("/items/") -async def read_items(): - return [{"item": "Portal Gun"}, {"item": "Plumbus"}] - - -@app.get("/users/") -async def read_users(): - return [{"username": "Rick"}, {"username": "Morty"}] diff --git a/docs_src/events/tutorial001_py39.py b/docs_src/events/tutorial001_py39.py deleted file mode 100644 index 128004c9fb..0000000000 --- a/docs_src/events/tutorial001_py39.py +++ /dev/null @@ -1,16 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - -items = {} - - -@app.on_event("startup") -async def startup_event(): - items["foo"] = {"name": "Fighters"} - items["bar"] = {"name": "Tenders"} - - -@app.get("/items/{item_id}") -async def read_items(item_id: str): - return items[item_id] diff --git a/docs_src/events/tutorial002_py39.py b/docs_src/events/tutorial002_py39.py deleted file mode 100644 index a71fea8025..0000000000 --- a/docs_src/events/tutorial002_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.on_event("shutdown") -def shutdown_event(): - with open("log.txt", mode="a") as log: - log.write("Application shutdown") - - -@app.get("/items/") -async def read_items(): - return [{"name": "Foo"}] diff --git a/docs_src/events/tutorial003_py39.py b/docs_src/events/tutorial003_py39.py deleted file mode 100644 index 2b650590b0..0000000000 --- a/docs_src/events/tutorial003_py39.py +++ /dev/null @@ -1,28 +0,0 @@ -from contextlib import asynccontextmanager - -from fastapi import FastAPI - - -def fake_answer_to_everything_ml_model(x: float): - return x * 42 - - -ml_models = {} - - -@asynccontextmanager -async def lifespan(app: FastAPI): - # Load the ML model - ml_models["answer_to_everything"] = fake_answer_to_everything_ml_model - yield - # Clean up the ML models and release the resources - ml_models.clear() - - -app = FastAPI(lifespan=lifespan) - - -@app.get("/predict") -async def predict(x: float): - result = ml_models["answer_to_everything"](x) - return {"result": result} diff --git a/docs_src/extending_openapi/tutorial001_py39.py b/docs_src/extending_openapi/tutorial001_py39.py deleted file mode 100644 index 35e31c0e0c..0000000000 --- a/docs_src/extending_openapi/tutorial001_py39.py +++ /dev/null @@ -1,29 +0,0 @@ -from fastapi import FastAPI -from fastapi.openapi.utils import get_openapi - -app = FastAPI() - - -@app.get("/items/") -async def read_items(): - return [{"name": "Foo"}] - - -def custom_openapi(): - if app.openapi_schema: - return app.openapi_schema - openapi_schema = get_openapi( - title="Custom title", - version="2.5.0", - summary="This is a very custom OpenAPI schema", - description="Here's a longer description of the custom **OpenAPI** schema", - routes=app.routes, - ) - openapi_schema["info"]["x-logo"] = { - "url": "https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" - } - app.openapi_schema = openapi_schema - return app.openapi_schema - - -app.openapi = custom_openapi diff --git a/docs_src/extra_models/tutorial003_py310.py b/docs_src/extra_models/tutorial003_py310.py index 06675cbc09..8fe6f7136e 100644 --- a/docs_src/extra_models/tutorial003_py310.py +++ b/docs_src/extra_models/tutorial003_py310.py @@ -1,5 +1,3 @@ -from typing import Union - from fastapi import FastAPI from pydantic import BaseModel @@ -30,6 +28,6 @@ items = { } -@app.get("/items/{item_id}", response_model=Union[PlaneItem, CarItem]) +@app.get("/items/{item_id}", response_model=PlaneItem | CarItem) async def read_item(item_id: str): return items[item_id] diff --git a/docs_src/extra_models/tutorial004_py39.py b/docs_src/extra_models/tutorial004_py39.py deleted file mode 100644 index 28cacde4d4..0000000000 --- a/docs_src/extra_models/tutorial004_py39.py +++ /dev/null @@ -1,20 +0,0 @@ -from fastapi import FastAPI -from pydantic import BaseModel - -app = FastAPI() - - -class Item(BaseModel): - name: str - description: str - - -items = [ - {"name": "Foo", "description": "There comes my hero"}, - {"name": "Red", "description": "It's my aeroplane"}, -] - - -@app.get("/items/", response_model=list[Item]) -async def read_items(): - return items diff --git a/docs_src/extra_models/tutorial005_py39.py b/docs_src/extra_models/tutorial005_py39.py deleted file mode 100644 index 9da2a0a0f4..0000000000 --- a/docs_src/extra_models/tutorial005_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/keyword-weights/", response_model=dict[str, float]) -async def read_keyword_weights(): - return {"foo": 2.3, "bar": 3.4} diff --git a/docs_src/first_steps/tutorial001_py39.py b/docs_src/first_steps/tutorial001_py39.py deleted file mode 100644 index ee60be1f96..0000000000 --- a/docs_src/first_steps/tutorial001_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/") -async def root(): - return {"message": "Hello World"} diff --git a/docs_src/first_steps/tutorial003_py39.py b/docs_src/first_steps/tutorial003_py39.py deleted file mode 100644 index e30b827eab..0000000000 --- a/docs_src/first_steps/tutorial003_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/") -def root(): - return {"message": "Hello World"} diff --git a/docs_src/generate_clients/tutorial001_py39.py b/docs_src/generate_clients/tutorial001_py39.py deleted file mode 100644 index 6a5ae23202..0000000000 --- a/docs_src/generate_clients/tutorial001_py39.py +++ /dev/null @@ -1,26 +0,0 @@ -from fastapi import FastAPI -from pydantic import BaseModel - -app = FastAPI() - - -class Item(BaseModel): - name: str - price: float - - -class ResponseMessage(BaseModel): - message: str - - -@app.post("/items/", response_model=ResponseMessage) -async def create_item(item: Item): - return {"message": "item received"} - - -@app.get("/items/", response_model=list[Item]) -async def get_items(): - return [ - {"name": "Plumbus", "price": 3}, - {"name": "Portal Gun", "price": 9001}, - ] diff --git a/docs_src/generate_clients/tutorial002_py39.py b/docs_src/generate_clients/tutorial002_py39.py deleted file mode 100644 index 83309760b9..0000000000 --- a/docs_src/generate_clients/tutorial002_py39.py +++ /dev/null @@ -1,36 +0,0 @@ -from fastapi import FastAPI -from pydantic import BaseModel - -app = FastAPI() - - -class Item(BaseModel): - name: str - price: float - - -class ResponseMessage(BaseModel): - message: str - - -class User(BaseModel): - username: str - email: str - - -@app.post("/items/", response_model=ResponseMessage, tags=["items"]) -async def create_item(item: Item): - return {"message": "Item received"} - - -@app.get("/items/", response_model=list[Item], tags=["items"]) -async def get_items(): - return [ - {"name": "Plumbus", "price": 3}, - {"name": "Portal Gun", "price": 9001}, - ] - - -@app.post("/users/", response_model=ResponseMessage, tags=["users"]) -async def create_user(user: User): - return {"message": "User received"} diff --git a/docs_src/generate_clients/tutorial003_py39.py b/docs_src/generate_clients/tutorial003_py39.py deleted file mode 100644 index 40722cf103..0000000000 --- a/docs_src/generate_clients/tutorial003_py39.py +++ /dev/null @@ -1,42 +0,0 @@ -from fastapi import FastAPI -from fastapi.routing import APIRoute -from pydantic import BaseModel - - -def custom_generate_unique_id(route: APIRoute): - return f"{route.tags[0]}-{route.name}" - - -app = FastAPI(generate_unique_id_function=custom_generate_unique_id) - - -class Item(BaseModel): - name: str - price: float - - -class ResponseMessage(BaseModel): - message: str - - -class User(BaseModel): - username: str - email: str - - -@app.post("/items/", response_model=ResponseMessage, tags=["items"]) -async def create_item(item: Item): - return {"message": "Item received"} - - -@app.get("/items/", response_model=list[Item], tags=["items"]) -async def get_items(): - return [ - {"name": "Plumbus", "price": 3}, - {"name": "Portal Gun", "price": 9001}, - ] - - -@app.post("/users/", response_model=ResponseMessage, tags=["users"]) -async def create_user(user: User): - return {"message": "User received"} diff --git a/docs_src/generate_clients/tutorial004_py39.py b/docs_src/generate_clients/tutorial004_py39.py deleted file mode 100644 index 894dc7f8df..0000000000 --- a/docs_src/generate_clients/tutorial004_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -import json -from pathlib import Path - -file_path = Path("./openapi.json") -openapi_content = json.loads(file_path.read_text()) - -for path_data in openapi_content["paths"].values(): - for operation in path_data.values(): - tag = operation["tags"][0] - operation_id = operation["operationId"] - to_remove = f"{tag}-" - new_operation_id = operation_id[len(to_remove) :] - operation["operationId"] = new_operation_id - -file_path.write_text(json.dumps(openapi_content)) diff --git a/docs_src/graphql_/tutorial001_py39.py b/docs_src/graphql_/tutorial001_py39.py deleted file mode 100644 index e92b2d71c4..0000000000 --- a/docs_src/graphql_/tutorial001_py39.py +++ /dev/null @@ -1,25 +0,0 @@ -import strawberry -from fastapi import FastAPI -from strawberry.fastapi import GraphQLRouter - - -@strawberry.type -class User: - name: str - age: int - - -@strawberry.type -class Query: - @strawberry.field - def user(self) -> User: - return User(name="Patrick", age=100) - - -schema = strawberry.Schema(query=Query) - - -graphql_app = GraphQLRouter(schema) - -app = FastAPI() -app.include_router(graphql_app, prefix="/graphql") diff --git a/docs_src/handling_errors/tutorial001_py39.py b/docs_src/handling_errors/tutorial001_py39.py deleted file mode 100644 index e5f32aac29..0000000000 --- a/docs_src/handling_errors/tutorial001_py39.py +++ /dev/null @@ -1,12 +0,0 @@ -from fastapi import FastAPI, HTTPException - -app = FastAPI() - -items = {"foo": "The Foo Wrestlers"} - - -@app.get("/items/{item_id}") -async def read_item(item_id: str): - if item_id not in items: - raise HTTPException(status_code=404, detail="Item not found") - return {"item": items[item_id]} diff --git a/docs_src/handling_errors/tutorial002_py39.py b/docs_src/handling_errors/tutorial002_py39.py deleted file mode 100644 index e48c295c9c..0000000000 --- a/docs_src/handling_errors/tutorial002_py39.py +++ /dev/null @@ -1,16 +0,0 @@ -from fastapi import FastAPI, HTTPException - -app = FastAPI() - -items = {"foo": "The Foo Wrestlers"} - - -@app.get("/items-header/{item_id}") -async def read_item_header(item_id: str): - if item_id not in items: - raise HTTPException( - status_code=404, - detail="Item not found", - headers={"X-Error": "There goes my error"}, - ) - return {"item": items[item_id]} diff --git a/docs_src/handling_errors/tutorial003_py39.py b/docs_src/handling_errors/tutorial003_py39.py deleted file mode 100644 index 791cd6838c..0000000000 --- a/docs_src/handling_errors/tutorial003_py39.py +++ /dev/null @@ -1,25 +0,0 @@ -from fastapi import FastAPI, Request -from fastapi.responses import JSONResponse - - -class UnicornException(Exception): - def __init__(self, name: str): - self.name = name - - -app = FastAPI() - - -@app.exception_handler(UnicornException) -async def unicorn_exception_handler(request: Request, exc: UnicornException): - return JSONResponse( - status_code=418, - content={"message": f"Oops! {exc.name} did something. There goes a rainbow..."}, - ) - - -@app.get("/unicorns/{name}") -async def read_unicorn(name: str): - if name == "yolo": - raise UnicornException(name=name) - return {"unicorn_name": name} diff --git a/docs_src/handling_errors/tutorial004_py39.py b/docs_src/handling_errors/tutorial004_py39.py deleted file mode 100644 index ae50807e97..0000000000 --- a/docs_src/handling_errors/tutorial004_py39.py +++ /dev/null @@ -1,26 +0,0 @@ -from fastapi import FastAPI, HTTPException -from fastapi.exceptions import RequestValidationError -from fastapi.responses import PlainTextResponse -from starlette.exceptions import HTTPException as StarletteHTTPException - -app = FastAPI() - - -@app.exception_handler(StarletteHTTPException) -async def http_exception_handler(request, exc): - return PlainTextResponse(str(exc.detail), status_code=exc.status_code) - - -@app.exception_handler(RequestValidationError) -async def validation_exception_handler(request, exc: RequestValidationError): - message = "Validation errors:" - for error in exc.errors(): - message += f"\nField: {error['loc']}, Error: {error['msg']}" - return PlainTextResponse(message, status_code=400) - - -@app.get("/items/{item_id}") -async def read_item(item_id: int): - if item_id == 3: - raise HTTPException(status_code=418, detail="Nope! I don't like 3.") - return {"item_id": item_id} diff --git a/docs_src/handling_errors/tutorial005_py39.py b/docs_src/handling_errors/tutorial005_py39.py deleted file mode 100644 index 0e04fa0864..0000000000 --- a/docs_src/handling_errors/tutorial005_py39.py +++ /dev/null @@ -1,25 +0,0 @@ -from fastapi import FastAPI, Request -from fastapi.encoders import jsonable_encoder -from fastapi.exceptions import RequestValidationError -from fastapi.responses import JSONResponse -from pydantic import BaseModel - -app = FastAPI() - - -@app.exception_handler(RequestValidationError) -async def validation_exception_handler(request: Request, exc: RequestValidationError): - return JSONResponse( - status_code=422, - content=jsonable_encoder({"detail": exc.errors(), "body": exc.body}), - ) - - -class Item(BaseModel): - title: str - size: int - - -@app.post("/items/") -async def create_item(item: Item): - return item diff --git a/docs_src/handling_errors/tutorial006_py39.py b/docs_src/handling_errors/tutorial006_py39.py deleted file mode 100644 index e05160d7e1..0000000000 --- a/docs_src/handling_errors/tutorial006_py39.py +++ /dev/null @@ -1,28 +0,0 @@ -from fastapi import FastAPI, HTTPException -from fastapi.exception_handlers import ( - http_exception_handler, - request_validation_exception_handler, -) -from fastapi.exceptions import RequestValidationError -from starlette.exceptions import HTTPException as StarletteHTTPException - -app = FastAPI() - - -@app.exception_handler(StarletteHTTPException) -async def custom_http_exception_handler(request, exc): - print(f"OMG! An HTTP error!: {repr(exc)}") - return await http_exception_handler(request, exc) - - -@app.exception_handler(RequestValidationError) -async def validation_exception_handler(request, exc): - print(f"OMG! The client sent invalid data!: {exc}") - return await request_validation_exception_handler(request, exc) - - -@app.get("/items/{item_id}") -async def read_item(item_id: int): - if item_id == 3: - raise HTTPException(status_code=418, detail="Nope! I don't like 3.") - return {"item_id": item_id} diff --git a/docs_src/metadata/tutorial001_1_py39.py b/docs_src/metadata/tutorial001_1_py39.py deleted file mode 100644 index 419232d861..0000000000 --- a/docs_src/metadata/tutorial001_1_py39.py +++ /dev/null @@ -1,38 +0,0 @@ -from fastapi import FastAPI - -description = """ -ChimichangApp API helps you do awesome stuff. 🚀 - -## Items - -You can **read items**. - -## Users - -You will be able to: - -* **Create users** (_not implemented_). -* **Read users** (_not implemented_). -""" - -app = FastAPI( - title="ChimichangApp", - description=description, - summary="Deadpool's favorite app. Nuff said.", - version="0.0.1", - terms_of_service="http://example.com/terms/", - contact={ - "name": "Deadpoolio the Amazing", - "url": "http://x-force.example.com/contact/", - "email": "dp@x-force.example.com", - }, - license_info={ - "name": "Apache 2.0", - "identifier": "Apache-2.0", - }, -) - - -@app.get("/items/") -async def read_items(): - return [{"name": "Katana"}] diff --git a/docs_src/metadata/tutorial001_py39.py b/docs_src/metadata/tutorial001_py39.py deleted file mode 100644 index 76656e81b4..0000000000 --- a/docs_src/metadata/tutorial001_py39.py +++ /dev/null @@ -1,38 +0,0 @@ -from fastapi import FastAPI - -description = """ -ChimichangApp API helps you do awesome stuff. 🚀 - -## Items - -You can **read items**. - -## Users - -You will be able to: - -* **Create users** (_not implemented_). -* **Read users** (_not implemented_). -""" - -app = FastAPI( - title="ChimichangApp", - description=description, - summary="Deadpool's favorite app. Nuff said.", - version="0.0.1", - terms_of_service="http://example.com/terms/", - contact={ - "name": "Deadpoolio the Amazing", - "url": "http://x-force.example.com/contact/", - "email": "dp@x-force.example.com", - }, - license_info={ - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html", - }, -) - - -@app.get("/items/") -async def read_items(): - return [{"name": "Katana"}] diff --git a/docs_src/metadata/tutorial002_py39.py b/docs_src/metadata/tutorial002_py39.py deleted file mode 100644 index cf9ed7087e..0000000000 --- a/docs_src/metadata/tutorial002_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI(openapi_url="/api/v1/openapi.json") - - -@app.get("/items/") -async def read_items(): - return [{"name": "Foo"}] diff --git a/docs_src/metadata/tutorial003_py39.py b/docs_src/metadata/tutorial003_py39.py deleted file mode 100644 index ee09c7f37b..0000000000 --- a/docs_src/metadata/tutorial003_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI(docs_url="/documentation", redoc_url=None) - - -@app.get("/items/") -async def read_items(): - return [{"name": "Foo"}] diff --git a/docs_src/metadata/tutorial004_py39.py b/docs_src/metadata/tutorial004_py39.py deleted file mode 100644 index 465bd659d5..0000000000 --- a/docs_src/metadata/tutorial004_py39.py +++ /dev/null @@ -1,28 +0,0 @@ -from fastapi import FastAPI - -tags_metadata = [ - { - "name": "users", - "description": "Operations with users. The **login** logic is also here.", - }, - { - "name": "items", - "description": "Manage items. So _fancy_ they have their own docs.", - "externalDocs": { - "description": "Items external docs", - "url": "https://fastapi.tiangolo.com/", - }, - }, -] - -app = FastAPI(openapi_tags=tags_metadata) - - -@app.get("/users/", tags=["users"]) -async def get_users(): - return [{"name": "Harry"}, {"name": "Ron"}] - - -@app.get("/items/", tags=["items"]) -async def get_items(): - return [{"name": "wand"}, {"name": "flying broom"}] diff --git a/docs_src/middleware/tutorial001_py39.py b/docs_src/middleware/tutorial001_py39.py deleted file mode 100644 index e65a7dade1..0000000000 --- a/docs_src/middleware/tutorial001_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -import time - -from fastapi import FastAPI, Request - -app = FastAPI() - - -@app.middleware("http") -async def add_process_time_header(request: Request, call_next): - start_time = time.perf_counter() - response = await call_next(request) - process_time = time.perf_counter() - start_time - response.headers["X-Process-Time"] = str(process_time) - return response diff --git a/docs_src/openapi_webhooks/tutorial001_py39.py b/docs_src/openapi_webhooks/tutorial001_py39.py deleted file mode 100644 index 55822bb48f..0000000000 --- a/docs_src/openapi_webhooks/tutorial001_py39.py +++ /dev/null @@ -1,25 +0,0 @@ -from datetime import datetime - -from fastapi import FastAPI -from pydantic import BaseModel - -app = FastAPI() - - -class Subscription(BaseModel): - username: str - monthly_fee: float - start_date: datetime - - -@app.webhooks.post("new-subscription") -def new_subscription(body: Subscription): - """ - When a new user subscribes to your service we'll send you a POST request with this - data to the URL that you register for the event `new-subscription` in the dashboard. - """ - - -@app.get("/users/") -def read_users(): - return ["Rick", "Morty"] diff --git a/docs_src/path_operation_advanced_configuration/tutorial001_py39.py b/docs_src/path_operation_advanced_configuration/tutorial001_py39.py deleted file mode 100644 index fafa8ffb8e..0000000000 --- a/docs_src/path_operation_advanced_configuration/tutorial001_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/items/", operation_id="some_specific_id_you_define") -async def read_items(): - return [{"item_id": "Foo"}] diff --git a/docs_src/path_operation_advanced_configuration/tutorial002_py39.py b/docs_src/path_operation_advanced_configuration/tutorial002_py39.py deleted file mode 100644 index 3aaae9b371..0000000000 --- a/docs_src/path_operation_advanced_configuration/tutorial002_py39.py +++ /dev/null @@ -1,24 +0,0 @@ -from fastapi import FastAPI -from fastapi.routing import APIRoute - -app = FastAPI() - - -@app.get("/items/") -async def read_items(): - return [{"item_id": "Foo"}] - - -def use_route_names_as_operation_ids(app: FastAPI) -> None: - """ - Simplify operation IDs so that generated API clients have simpler function - names. - - Should be called only after all routes have been added. - """ - for route in app.routes: - if isinstance(route, APIRoute): - route.operation_id = route.name # in this case, 'read_items' - - -use_route_names_as_operation_ids(app) diff --git a/docs_src/path_operation_advanced_configuration/tutorial003_py39.py b/docs_src/path_operation_advanced_configuration/tutorial003_py39.py deleted file mode 100644 index dcc358e323..0000000000 --- a/docs_src/path_operation_advanced_configuration/tutorial003_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/items/", include_in_schema=False) -async def read_items(): - return [{"item_id": "Foo"}] diff --git a/docs_src/path_operation_advanced_configuration/tutorial005_py39.py b/docs_src/path_operation_advanced_configuration/tutorial005_py39.py deleted file mode 100644 index 5837ad8351..0000000000 --- a/docs_src/path_operation_advanced_configuration/tutorial005_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/items/", openapi_extra={"x-aperture-labs-portal": "blue"}) -async def read_items(): - return [{"item_id": "portal-gun"}] diff --git a/docs_src/path_operation_advanced_configuration/tutorial006_py39.py b/docs_src/path_operation_advanced_configuration/tutorial006_py39.py deleted file mode 100644 index 403c3ee3fb..0000000000 --- a/docs_src/path_operation_advanced_configuration/tutorial006_py39.py +++ /dev/null @@ -1,41 +0,0 @@ -from fastapi import FastAPI, Request - -app = FastAPI() - - -def magic_data_reader(raw_body: bytes): - return { - "size": len(raw_body), - "content": { - "name": "Maaaagic", - "price": 42, - "description": "Just kiddin', no magic here. ✨", - }, - } - - -@app.post( - "/items/", - openapi_extra={ - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": ["name", "price"], - "type": "object", - "properties": { - "name": {"type": "string"}, - "price": {"type": "number"}, - "description": {"type": "string"}, - }, - } - } - }, - "required": True, - }, - }, -) -async def create_item(request: Request): - raw_body = await request.body() - data = magic_data_reader(raw_body) - return data diff --git a/docs_src/path_operation_advanced_configuration/tutorial007_py39.py b/docs_src/path_operation_advanced_configuration/tutorial007_py39.py deleted file mode 100644 index ff64ef7923..0000000000 --- a/docs_src/path_operation_advanced_configuration/tutorial007_py39.py +++ /dev/null @@ -1,32 +0,0 @@ -import yaml -from fastapi import FastAPI, HTTPException, Request -from pydantic import BaseModel, ValidationError - -app = FastAPI() - - -class Item(BaseModel): - name: str - tags: list[str] - - -@app.post( - "/items/", - openapi_extra={ - "requestBody": { - "content": {"application/x-yaml": {"schema": Item.model_json_schema()}}, - "required": True, - }, - }, -) -async def create_item(request: Request): - raw_body = await request.body() - try: - data = yaml.safe_load(raw_body) - except yaml.YAMLError: - raise HTTPException(status_code=422, detail="Invalid YAML") - try: - item = Item.model_validate(data) - except ValidationError as e: - raise HTTPException(status_code=422, detail=e.errors(include_url=False)) - return item diff --git a/docs_src/path_operation_configuration/tutorial002b_py39.py b/docs_src/path_operation_configuration/tutorial002b_py39.py deleted file mode 100644 index d53b4d817d..0000000000 --- a/docs_src/path_operation_configuration/tutorial002b_py39.py +++ /dev/null @@ -1,20 +0,0 @@ -from enum import Enum - -from fastapi import FastAPI - -app = FastAPI() - - -class Tags(Enum): - items = "items" - users = "users" - - -@app.get("/items/", tags=[Tags.items]) -async def get_items(): - return ["Portal gun", "Plumbus"] - - -@app.get("/users/", tags=[Tags.users]) -async def read_users(): - return ["Rick", "Morty"] diff --git a/docs_src/path_operation_configuration/tutorial006_py39.py b/docs_src/path_operation_configuration/tutorial006_py39.py deleted file mode 100644 index 7c1aa9b206..0000000000 --- a/docs_src/path_operation_configuration/tutorial006_py39.py +++ /dev/null @@ -1,18 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/items/", tags=["items"]) -async def read_items(): - return [{"name": "Foo", "price": 42}] - - -@app.get("/users/", tags=["users"]) -async def read_users(): - return [{"username": "johndoe"}] - - -@app.get("/elements/", tags=["items"], deprecated=True) -async def read_elements(): - return [{"item_id": "Foo"}] diff --git a/docs_src/path_params/tutorial001_py39.py b/docs_src/path_params/tutorial001_py39.py deleted file mode 100644 index 7bbf70e6c8..0000000000 --- a/docs_src/path_params/tutorial001_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_item(item_id): - return {"item_id": item_id} diff --git a/docs_src/path_params/tutorial002_py39.py b/docs_src/path_params/tutorial002_py39.py deleted file mode 100644 index 8272ad70d4..0000000000 --- a/docs_src/path_params/tutorial002_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_item(item_id: int): - return {"item_id": item_id} diff --git a/docs_src/path_params/tutorial003_py39.py b/docs_src/path_params/tutorial003_py39.py deleted file mode 100644 index 5f0aa09234..0000000000 --- a/docs_src/path_params/tutorial003_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/users/me") -async def read_user_me(): - return {"user_id": "the current user"} - - -@app.get("/users/{user_id}") -async def read_user(user_id: str): - return {"user_id": user_id} diff --git a/docs_src/path_params/tutorial003b_py39.py b/docs_src/path_params/tutorial003b_py39.py deleted file mode 100644 index 822d373694..0000000000 --- a/docs_src/path_params/tutorial003b_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/users") -async def read_users(): - return ["Rick", "Morty"] - - -@app.get("/users") -async def read_users2(): - return ["Bean", "Elfo"] diff --git a/docs_src/path_params/tutorial004_py39.py b/docs_src/path_params/tutorial004_py39.py deleted file mode 100644 index 2961e6178e..0000000000 --- a/docs_src/path_params/tutorial004_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/files/{file_path:path}") -async def read_file(file_path: str): - return {"file_path": file_path} diff --git a/docs_src/path_params/tutorial005_py39.py b/docs_src/path_params/tutorial005_py39.py deleted file mode 100644 index 9a24a4963a..0000000000 --- a/docs_src/path_params/tutorial005_py39.py +++ /dev/null @@ -1,23 +0,0 @@ -from enum import Enum - -from fastapi import FastAPI - - -class ModelName(str, Enum): - alexnet = "alexnet" - resnet = "resnet" - lenet = "lenet" - - -app = FastAPI() - - -@app.get("/models/{model_name}") -async def get_model(model_name: ModelName): - if model_name is ModelName.alexnet: - return {"model_name": model_name, "message": "Deep Learning FTW!"} - - if model_name.value == "lenet": - return {"model_name": model_name, "message": "LeCNN all the images"} - - return {"model_name": model_name, "message": "Have some residuals"} diff --git a/docs_src/path_params_numeric_validations/tutorial002_an_py39.py b/docs_src/path_params_numeric_validations/tutorial002_an_py39.py deleted file mode 100644 index cd882abb2c..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial002_an_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Path - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items( - q: str, item_id: Annotated[int, Path(title="The ID of the item to get")] -): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial002_py39.py b/docs_src/path_params_numeric_validations/tutorial002_py39.py deleted file mode 100644 index 63ac691a83..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial002_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import FastAPI, Path - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items(q: str, item_id: int = Path(title="The ID of the item to get")): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial003_an_py39.py b/docs_src/path_params_numeric_validations/tutorial003_an_py39.py deleted file mode 100644 index 1588556e78..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial003_an_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Path - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items( - item_id: Annotated[int, Path(title="The ID of the item to get")], q: str -): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial003_py39.py b/docs_src/path_params_numeric_validations/tutorial003_py39.py deleted file mode 100644 index 8df0ffc620..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial003_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import FastAPI, Path - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items(*, item_id: int = Path(title="The ID of the item to get"), q: str): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial004_an_py39.py b/docs_src/path_params_numeric_validations/tutorial004_an_py39.py deleted file mode 100644 index f67f6450e7..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial004_an_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Path - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items( - item_id: Annotated[int, Path(title="The ID of the item to get", ge=1)], q: str -): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial004_py39.py b/docs_src/path_params_numeric_validations/tutorial004_py39.py deleted file mode 100644 index 86651d47cf..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial004_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from fastapi import FastAPI, Path - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items( - *, item_id: int = Path(title="The ID of the item to get", ge=1), q: str -): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial005_an_py39.py b/docs_src/path_params_numeric_validations/tutorial005_an_py39.py deleted file mode 100644 index 571dd583ce..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial005_an_py39.py +++ /dev/null @@ -1,16 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Path - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items( - item_id: Annotated[int, Path(title="The ID of the item to get", gt=0, le=1000)], - q: str, -): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial005_py39.py b/docs_src/path_params_numeric_validations/tutorial005_py39.py deleted file mode 100644 index 8f12f2da02..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial005_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from fastapi import FastAPI, Path - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items( - *, - item_id: int = Path(title="The ID of the item to get", gt=0, le=1000), - q: str, -): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial006_an_py39.py b/docs_src/path_params_numeric_validations/tutorial006_an_py39.py deleted file mode 100644 index 426ec37764..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial006_an_py39.py +++ /dev/null @@ -1,20 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Path, Query - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items( - *, - item_id: Annotated[int, Path(title="The ID of the item to get", ge=0, le=1000)], - q: str, - size: Annotated[float, Query(gt=0, lt=10.5)], -): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - if size: - results.update({"size": size}) - return results diff --git a/docs_src/path_params_numeric_validations/tutorial006_py39.py b/docs_src/path_params_numeric_validations/tutorial006_py39.py deleted file mode 100644 index f07629aa0a..0000000000 --- a/docs_src/path_params_numeric_validations/tutorial006_py39.py +++ /dev/null @@ -1,18 +0,0 @@ -from fastapi import FastAPI, Path, Query - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_items( - *, - item_id: int = Path(title="The ID of the item to get", ge=0, le=1000), - q: str, - size: float = Query(gt=0, lt=10.5), -): - results = {"item_id": item_id} - if q: - results.update({"q": q}) - if size: - results.update({"size": size}) - return results diff --git a/docs_src/python_types/tutorial001_py39.py b/docs_src/python_types/tutorial001_py39.py deleted file mode 100644 index 09039435f1..0000000000 --- a/docs_src/python_types/tutorial001_py39.py +++ /dev/null @@ -1,6 +0,0 @@ -def get_full_name(first_name, last_name): - full_name = first_name.title() + " " + last_name.title() - return full_name - - -print(get_full_name("john", "doe")) diff --git a/docs_src/python_types/tutorial002_py39.py b/docs_src/python_types/tutorial002_py39.py deleted file mode 100644 index c0857a1160..0000000000 --- a/docs_src/python_types/tutorial002_py39.py +++ /dev/null @@ -1,6 +0,0 @@ -def get_full_name(first_name: str, last_name: str): - full_name = first_name.title() + " " + last_name.title() - return full_name - - -print(get_full_name("john", "doe")) diff --git a/docs_src/python_types/tutorial003_py39.py b/docs_src/python_types/tutorial003_py39.py deleted file mode 100644 index d021d82113..0000000000 --- a/docs_src/python_types/tutorial003_py39.py +++ /dev/null @@ -1,3 +0,0 @@ -def get_name_with_age(name: str, age: int): - name_with_age = name + " is this old: " + age - return name_with_age diff --git a/docs_src/python_types/tutorial004_py39.py b/docs_src/python_types/tutorial004_py39.py deleted file mode 100644 index 9400269e26..0000000000 --- a/docs_src/python_types/tutorial004_py39.py +++ /dev/null @@ -1,3 +0,0 @@ -def get_name_with_age(name: str, age: int): - name_with_age = name + " is this old: " + str(age) - return name_with_age diff --git a/docs_src/python_types/tutorial006_py39.py b/docs_src/python_types/tutorial006_py39.py deleted file mode 100644 index 486b67cafd..0000000000 --- a/docs_src/python_types/tutorial006_py39.py +++ /dev/null @@ -1,3 +0,0 @@ -def process_items(items: list[str]): - for item in items: - print(item) diff --git a/docs_src/python_types/tutorial007_py39.py b/docs_src/python_types/tutorial007_py39.py deleted file mode 100644 index ea96c79642..0000000000 --- a/docs_src/python_types/tutorial007_py39.py +++ /dev/null @@ -1,2 +0,0 @@ -def process_items(items_t: tuple[int, int, str], items_s: set[bytes]): - return items_t, items_s diff --git a/docs_src/python_types/tutorial008_py39.py b/docs_src/python_types/tutorial008_py39.py deleted file mode 100644 index a393385b05..0000000000 --- a/docs_src/python_types/tutorial008_py39.py +++ /dev/null @@ -1,4 +0,0 @@ -def process_items(prices: dict[str, float]): - for item_name, item_price in prices.items(): - print(item_name) - print(item_price) diff --git a/docs_src/python_types/tutorial008b_py39.py b/docs_src/python_types/tutorial008b_py39.py deleted file mode 100644 index e52539ead0..0000000000 --- a/docs_src/python_types/tutorial008b_py39.py +++ /dev/null @@ -1,5 +0,0 @@ -from typing import Union - - -def process_item(item: Union[int, str]): - print(item) diff --git a/docs_src/python_types/tutorial009_py39.py b/docs_src/python_types/tutorial009_py39.py deleted file mode 100644 index 6328a1495c..0000000000 --- a/docs_src/python_types/tutorial009_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from typing import Optional - - -def say_hi(name: Optional[str] = None): - if name is not None: - print(f"Hey {name}!") - else: - print("Hello World") diff --git a/docs_src/python_types/tutorial009b_py39.py b/docs_src/python_types/tutorial009b_py39.py deleted file mode 100644 index 9f1a05bc0f..0000000000 --- a/docs_src/python_types/tutorial009b_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from typing import Union - - -def say_hi(name: Union[str, None] = None): - if name is not None: - print(f"Hey {name}!") - else: - print("Hello World") diff --git a/docs_src/python_types/tutorial009c_py310.py b/docs_src/python_types/tutorial009c_py310.py deleted file mode 100644 index 96b1220fcc..0000000000 --- a/docs_src/python_types/tutorial009c_py310.py +++ /dev/null @@ -1,2 +0,0 @@ -def say_hi(name: str | None): - print(f"Hey {name}!") diff --git a/docs_src/python_types/tutorial009c_py39.py b/docs_src/python_types/tutorial009c_py39.py deleted file mode 100644 index 2f539a34b1..0000000000 --- a/docs_src/python_types/tutorial009c_py39.py +++ /dev/null @@ -1,5 +0,0 @@ -from typing import Optional - - -def say_hi(name: Optional[str]): - print(f"Hey {name}!") diff --git a/docs_src/python_types/tutorial010_py39.py b/docs_src/python_types/tutorial010_py39.py deleted file mode 100644 index 468cffc2dc..0000000000 --- a/docs_src/python_types/tutorial010_py39.py +++ /dev/null @@ -1,7 +0,0 @@ -class Person: - def __init__(self, name: str): - self.name = name - - -def get_person_name(one_person: Person): - return one_person.name diff --git a/docs_src/python_types/tutorial013_py39.py b/docs_src/python_types/tutorial013_py39.py deleted file mode 100644 index 65a0eaa939..0000000000 --- a/docs_src/python_types/tutorial013_py39.py +++ /dev/null @@ -1,5 +0,0 @@ -from typing import Annotated - - -def say_hello(name: Annotated[str, "this is just metadata"]) -> str: - return f"Hello {name}" diff --git a/docs_src/query_params/tutorial001_py39.py b/docs_src/query_params/tutorial001_py39.py deleted file mode 100644 index 74e1a17604..0000000000 --- a/docs_src/query_params/tutorial001_py39.py +++ /dev/null @@ -1,10 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - -fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}] - - -@app.get("/items/") -async def read_item(skip: int = 0, limit: int = 10): - return fake_items_db[skip : skip + limit] diff --git a/docs_src/query_params/tutorial005_py39.py b/docs_src/query_params/tutorial005_py39.py deleted file mode 100644 index e16a40574d..0000000000 --- a/docs_src/query_params/tutorial005_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/items/{item_id}") -async def read_user_item(item_id: str, needy: str): - item = {"item_id": item_id, "needy": needy} - return item diff --git a/docs_src/query_params_str_validations/tutorial005_an_py39.py b/docs_src/query_params_str_validations/tutorial005_an_py39.py deleted file mode 100644 index b1f6046b50..0000000000 --- a/docs_src/query_params_str_validations/tutorial005_an_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Query - -app = FastAPI() - - -@app.get("/items/") -async def read_items(q: Annotated[str, Query(min_length=3)] = "fixedquery"): - results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/query_params_str_validations/tutorial005_py39.py b/docs_src/query_params_str_validations/tutorial005_py39.py deleted file mode 100644 index 8ab42869e6..0000000000 --- a/docs_src/query_params_str_validations/tutorial005_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import FastAPI, Query - -app = FastAPI() - - -@app.get("/items/") -async def read_items(q: str = Query(default="fixedquery", min_length=3)): - results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/query_params_str_validations/tutorial006_an_py39.py b/docs_src/query_params_str_validations/tutorial006_an_py39.py deleted file mode 100644 index 3b4a676d2e..0000000000 --- a/docs_src/query_params_str_validations/tutorial006_an_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Query - -app = FastAPI() - - -@app.get("/items/") -async def read_items(q: Annotated[str, Query(min_length=3)]): - results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/query_params_str_validations/tutorial006_py39.py b/docs_src/query_params_str_validations/tutorial006_py39.py deleted file mode 100644 index 9a90eb64ef..0000000000 --- a/docs_src/query_params_str_validations/tutorial006_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import FastAPI, Query - -app = FastAPI() - - -@app.get("/items/") -async def read_items(q: str = Query(min_length=3)): - results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]} - if q: - results.update({"q": q}) - return results diff --git a/docs_src/query_params_str_validations/tutorial012_an_py39.py b/docs_src/query_params_str_validations/tutorial012_an_py39.py deleted file mode 100644 index 9b5a9c2fb2..0000000000 --- a/docs_src/query_params_str_validations/tutorial012_an_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Query - -app = FastAPI() - - -@app.get("/items/") -async def read_items(q: Annotated[list[str], Query()] = ["foo", "bar"]): - query_items = {"q": q} - return query_items diff --git a/docs_src/query_params_str_validations/tutorial012_py39.py b/docs_src/query_params_str_validations/tutorial012_py39.py deleted file mode 100644 index 070d0b04bf..0000000000 --- a/docs_src/query_params_str_validations/tutorial012_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI, Query - -app = FastAPI() - - -@app.get("/items/") -async def read_items(q: list[str] = Query(default=["foo", "bar"])): - query_items = {"q": q} - return query_items diff --git a/docs_src/query_params_str_validations/tutorial013_an_py39.py b/docs_src/query_params_str_validations/tutorial013_an_py39.py deleted file mode 100644 index 602734145d..0000000000 --- a/docs_src/query_params_str_validations/tutorial013_an_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Query - -app = FastAPI() - - -@app.get("/items/") -async def read_items(q: Annotated[list, Query()] = []): - query_items = {"q": q} - return query_items diff --git a/docs_src/query_params_str_validations/tutorial013_py39.py b/docs_src/query_params_str_validations/tutorial013_py39.py deleted file mode 100644 index 0b0f44869f..0000000000 --- a/docs_src/query_params_str_validations/tutorial013_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI, Query - -app = FastAPI() - - -@app.get("/items/") -async def read_items(q: list = Query(default=[])): - query_items = {"q": q} - return query_items diff --git a/docs_src/request_files/tutorial001_03_an_py39.py b/docs_src/request_files/tutorial001_03_an_py39.py deleted file mode 100644 index 93098a677a..0000000000 --- a/docs_src/request_files/tutorial001_03_an_py39.py +++ /dev/null @@ -1,17 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, File, UploadFile - -app = FastAPI() - - -@app.post("/files/") -async def create_file(file: Annotated[bytes, File(description="A file read as bytes")]): - return {"file_size": len(file)} - - -@app.post("/uploadfile/") -async def create_upload_file( - file: Annotated[UploadFile, File(description="A file read as UploadFile")], -): - return {"filename": file.filename} diff --git a/docs_src/request_files/tutorial001_03_py39.py b/docs_src/request_files/tutorial001_03_py39.py deleted file mode 100644 index d8005cc7d2..0000000000 --- a/docs_src/request_files/tutorial001_03_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from fastapi import FastAPI, File, UploadFile - -app = FastAPI() - - -@app.post("/files/") -async def create_file(file: bytes = File(description="A file read as bytes")): - return {"file_size": len(file)} - - -@app.post("/uploadfile/") -async def create_upload_file( - file: UploadFile = File(description="A file read as UploadFile"), -): - return {"filename": file.filename} diff --git a/docs_src/request_files/tutorial001_an_py39.py b/docs_src/request_files/tutorial001_an_py39.py deleted file mode 100644 index 26a7672216..0000000000 --- a/docs_src/request_files/tutorial001_an_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, File, UploadFile - -app = FastAPI() - - -@app.post("/files/") -async def create_file(file: Annotated[bytes, File()]): - return {"file_size": len(file)} - - -@app.post("/uploadfile/") -async def create_upload_file(file: UploadFile): - return {"filename": file.filename} diff --git a/docs_src/request_files/tutorial001_py39.py b/docs_src/request_files/tutorial001_py39.py deleted file mode 100644 index 2e0ea63912..0000000000 --- a/docs_src/request_files/tutorial001_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from fastapi import FastAPI, File, UploadFile - -app = FastAPI() - - -@app.post("/files/") -async def create_file(file: bytes = File()): - return {"file_size": len(file)} - - -@app.post("/uploadfile/") -async def create_upload_file(file: UploadFile): - return {"filename": file.filename} diff --git a/docs_src/request_files/tutorial002_an_py39.py b/docs_src/request_files/tutorial002_an_py39.py deleted file mode 100644 index db524ceab6..0000000000 --- a/docs_src/request_files/tutorial002_an_py39.py +++ /dev/null @@ -1,33 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, File, UploadFile -from fastapi.responses import HTMLResponse - -app = FastAPI() - - -@app.post("/files/") -async def create_files(files: Annotated[list[bytes], File()]): - return {"file_sizes": [len(file) for file in files]} - - -@app.post("/uploadfiles/") -async def create_upload_files(files: list[UploadFile]): - return {"filenames": [file.filename for file in files]} - - -@app.get("/") -async def main(): - content = """ - -
- - -
-
- - -
- - """ - return HTMLResponse(content=content) diff --git a/docs_src/request_files/tutorial002_py39.py b/docs_src/request_files/tutorial002_py39.py deleted file mode 100644 index b64cf55987..0000000000 --- a/docs_src/request_files/tutorial002_py39.py +++ /dev/null @@ -1,31 +0,0 @@ -from fastapi import FastAPI, File, UploadFile -from fastapi.responses import HTMLResponse - -app = FastAPI() - - -@app.post("/files/") -async def create_files(files: list[bytes] = File()): - return {"file_sizes": [len(file) for file in files]} - - -@app.post("/uploadfiles/") -async def create_upload_files(files: list[UploadFile]): - return {"filenames": [file.filename for file in files]} - - -@app.get("/") -async def main(): - content = """ - -
- - -
-
- - -
- - """ - return HTMLResponse(content=content) diff --git a/docs_src/request_files/tutorial003_an_py39.py b/docs_src/request_files/tutorial003_an_py39.py deleted file mode 100644 index 5a8c5dab5c..0000000000 --- a/docs_src/request_files/tutorial003_an_py39.py +++ /dev/null @@ -1,39 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, File, UploadFile -from fastapi.responses import HTMLResponse - -app = FastAPI() - - -@app.post("/files/") -async def create_files( - files: Annotated[list[bytes], File(description="Multiple files as bytes")], -): - return {"file_sizes": [len(file) for file in files]} - - -@app.post("/uploadfiles/") -async def create_upload_files( - files: Annotated[ - list[UploadFile], File(description="Multiple files as UploadFile") - ], -): - return {"filenames": [file.filename for file in files]} - - -@app.get("/") -async def main(): - content = """ - -
- - -
-
- - -
- - """ - return HTMLResponse(content=content) diff --git a/docs_src/request_files/tutorial003_py39.py b/docs_src/request_files/tutorial003_py39.py deleted file mode 100644 index 96f5e8742d..0000000000 --- a/docs_src/request_files/tutorial003_py39.py +++ /dev/null @@ -1,35 +0,0 @@ -from fastapi import FastAPI, File, UploadFile -from fastapi.responses import HTMLResponse - -app = FastAPI() - - -@app.post("/files/") -async def create_files( - files: list[bytes] = File(description="Multiple files as bytes"), -): - return {"file_sizes": [len(file) for file in files]} - - -@app.post("/uploadfiles/") -async def create_upload_files( - files: list[UploadFile] = File(description="Multiple files as UploadFile"), -): - return {"filenames": [file.filename for file in files]} - - -@app.get("/") -async def main(): - content = """ - -
- - -
-
- - -
- - """ - return HTMLResponse(content=content) diff --git a/docs_src/request_form_models/tutorial001_an_py39.py b/docs_src/request_form_models/tutorial001_an_py39.py deleted file mode 100644 index 7cc81aae95..0000000000 --- a/docs_src/request_form_models/tutorial001_an_py39.py +++ /dev/null @@ -1,16 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Form -from pydantic import BaseModel - -app = FastAPI() - - -class FormData(BaseModel): - username: str - password: str - - -@app.post("/login/") -async def login(data: Annotated[FormData, Form()]): - return data diff --git a/docs_src/request_form_models/tutorial001_py39.py b/docs_src/request_form_models/tutorial001_py39.py deleted file mode 100644 index 98feff0b9f..0000000000 --- a/docs_src/request_form_models/tutorial001_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import FastAPI, Form -from pydantic import BaseModel - -app = FastAPI() - - -class FormData(BaseModel): - username: str - password: str - - -@app.post("/login/") -async def login(data: FormData = Form()): - return data diff --git a/docs_src/request_form_models/tutorial002_an_py39.py b/docs_src/request_form_models/tutorial002_an_py39.py deleted file mode 100644 index 3004e08524..0000000000 --- a/docs_src/request_form_models/tutorial002_an_py39.py +++ /dev/null @@ -1,17 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Form -from pydantic import BaseModel - -app = FastAPI() - - -class FormData(BaseModel): - username: str - password: str - model_config = {"extra": "forbid"} - - -@app.post("/login/") -async def login(data: Annotated[FormData, Form()]): - return data diff --git a/docs_src/request_form_models/tutorial002_py39.py b/docs_src/request_form_models/tutorial002_py39.py deleted file mode 100644 index 59b329e8d8..0000000000 --- a/docs_src/request_form_models/tutorial002_py39.py +++ /dev/null @@ -1,15 +0,0 @@ -from fastapi import FastAPI, Form -from pydantic import BaseModel - -app = FastAPI() - - -class FormData(BaseModel): - username: str - password: str - model_config = {"extra": "forbid"} - - -@app.post("/login/") -async def login(data: FormData = Form()): - return data diff --git a/docs_src/request_forms/tutorial001_an_py39.py b/docs_src/request_forms/tutorial001_an_py39.py deleted file mode 100644 index 8e9d2ea53a..0000000000 --- a/docs_src/request_forms/tutorial001_an_py39.py +++ /dev/null @@ -1,10 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, Form - -app = FastAPI() - - -@app.post("/login/") -async def login(username: Annotated[str, Form()], password: Annotated[str, Form()]): - return {"username": username} diff --git a/docs_src/request_forms/tutorial001_py39.py b/docs_src/request_forms/tutorial001_py39.py deleted file mode 100644 index a537700019..0000000000 --- a/docs_src/request_forms/tutorial001_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI, Form - -app = FastAPI() - - -@app.post("/login/") -async def login(username: str = Form(), password: str = Form()): - return {"username": username} diff --git a/docs_src/request_forms_and_files/tutorial001_an_py39.py b/docs_src/request_forms_and_files/tutorial001_an_py39.py deleted file mode 100644 index 12cc43e50a..0000000000 --- a/docs_src/request_forms_and_files/tutorial001_an_py39.py +++ /dev/null @@ -1,18 +0,0 @@ -from typing import Annotated - -from fastapi import FastAPI, File, Form, UploadFile - -app = FastAPI() - - -@app.post("/files/") -async def create_file( - file: Annotated[bytes, File()], - fileb: Annotated[UploadFile, File()], - token: Annotated[str, Form()], -): - return { - "file_size": len(file), - "token": token, - "fileb_content_type": fileb.content_type, - } diff --git a/docs_src/request_forms_and_files/tutorial001_py39.py b/docs_src/request_forms_and_files/tutorial001_py39.py deleted file mode 100644 index 7b5224ce53..0000000000 --- a/docs_src/request_forms_and_files/tutorial001_py39.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import FastAPI, File, Form, UploadFile - -app = FastAPI() - - -@app.post("/files/") -async def create_file( - file: bytes = File(), fileb: UploadFile = File(), token: str = Form() -): - return { - "file_size": len(file), - "token": token, - "fileb_content_type": fileb.content_type, - } diff --git a/docs_src/response_change_status_code/tutorial001_py39.py b/docs_src/response_change_status_code/tutorial001_py39.py deleted file mode 100644 index 197decbfbf..0000000000 --- a/docs_src/response_change_status_code/tutorial001_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from fastapi import FastAPI, Response, status - -app = FastAPI() - -tasks = {"foo": "Listen to the Bar Fighters"} - - -@app.put("/get-or-create-task/{task_id}", status_code=200) -def get_or_create_task(task_id: str, response: Response): - if task_id not in tasks: - tasks[task_id] = "This didn't exist before" - response.status_code = status.HTTP_201_CREATED - return tasks[task_id] diff --git a/docs_src/response_cookies/tutorial001_py39.py b/docs_src/response_cookies/tutorial001_py39.py deleted file mode 100644 index 33f8e8f6e9..0000000000 --- a/docs_src/response_cookies/tutorial001_py39.py +++ /dev/null @@ -1,12 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import JSONResponse - -app = FastAPI() - - -@app.post("/cookie/") -def create_cookie(): - content = {"message": "Come to the dark side, we have cookies"} - response = JSONResponse(content=content) - response.set_cookie(key="fakesession", value="fake-cookie-session-value") - return response diff --git a/docs_src/response_cookies/tutorial002_py39.py b/docs_src/response_cookies/tutorial002_py39.py deleted file mode 100644 index 76c06fdb9f..0000000000 --- a/docs_src/response_cookies/tutorial002_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI, Response - -app = FastAPI() - - -@app.post("/cookie-and-object/") -def create_cookie(response: Response): - response.set_cookie(key="fakesession", value="fake-cookie-session-value") - return {"message": "Come to the dark side, we have cookies"} diff --git a/docs_src/response_directly/tutorial002_py39.py b/docs_src/response_directly/tutorial002_py39.py deleted file mode 100644 index 6643da6e6d..0000000000 --- a/docs_src/response_directly/tutorial002_py39.py +++ /dev/null @@ -1,18 +0,0 @@ -from fastapi import FastAPI, Response - -app = FastAPI() - - -@app.get("/legacy/") -def get_legacy_data(): - data = """ - -
- Apply shampoo here. -
- - You'll have to use soap here. - -
- """ - return Response(content=data, media_type="application/xml") diff --git a/docs_src/response_headers/tutorial001_py39.py b/docs_src/response_headers/tutorial001_py39.py deleted file mode 100644 index 2da02a470b..0000000000 --- a/docs_src/response_headers/tutorial001_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import JSONResponse - -app = FastAPI() - - -@app.get("/headers/") -def get_headers(): - content = {"message": "Hello World"} - headers = {"X-Cat-Dog": "alone in the world", "Content-Language": "en-US"} - return JSONResponse(content=content, headers=headers) diff --git a/docs_src/response_headers/tutorial002_py39.py b/docs_src/response_headers/tutorial002_py39.py deleted file mode 100644 index d2c4983051..0000000000 --- a/docs_src/response_headers/tutorial002_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI, Response - -app = FastAPI() - - -@app.get("/headers-and-object/") -def get_headers(response: Response): - response.headers["X-Cat-Dog"] = "alone in the world" - return {"message": "Hello World"} diff --git a/docs_src/response_model/tutorial003_02_py39.py b/docs_src/response_model/tutorial003_02_py39.py deleted file mode 100644 index df6a09646d..0000000000 --- a/docs_src/response_model/tutorial003_02_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import FastAPI, Response -from fastapi.responses import JSONResponse, RedirectResponse - -app = FastAPI() - - -@app.get("/portal") -async def get_portal(teleport: bool = False) -> Response: - if teleport: - return RedirectResponse(url="https://www.youtube.com/watch?v=dQw4w9WgXcQ") - return JSONResponse(content={"message": "Here's your interdimensional portal."}) diff --git a/docs_src/response_model/tutorial003_03_py39.py b/docs_src/response_model/tutorial003_03_py39.py deleted file mode 100644 index 0d4bd8de57..0000000000 --- a/docs_src/response_model/tutorial003_03_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI -from fastapi.responses import RedirectResponse - -app = FastAPI() - - -@app.get("/teleport") -async def get_teleport() -> RedirectResponse: - return RedirectResponse(url="https://www.youtube.com/watch?v=dQw4w9WgXcQ") diff --git a/docs_src/response_status_code/tutorial001_py39.py b/docs_src/response_status_code/tutorial001_py39.py deleted file mode 100644 index 14b6d6e675..0000000000 --- a/docs_src/response_status_code/tutorial001_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.post("/items/", status_code=201) -async def create_item(name: str): - return {"name": name} diff --git a/docs_src/response_status_code/tutorial002_py39.py b/docs_src/response_status_code/tutorial002_py39.py deleted file mode 100644 index 4fcc9829db..0000000000 --- a/docs_src/response_status_code/tutorial002_py39.py +++ /dev/null @@ -1,8 +0,0 @@ -from fastapi import FastAPI, status - -app = FastAPI() - - -@app.post("/items/", status_code=status.HTTP_201_CREATED) -async def create_item(name: str): - return {"name": name} diff --git a/docs_src/security/tutorial001_an_py39.py b/docs_src/security/tutorial001_an_py39.py deleted file mode 100644 index de110402ef..0000000000 --- a/docs_src/security/tutorial001_an_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI -from fastapi.security import OAuth2PasswordBearer - -app = FastAPI() - -oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token") - - -@app.get("/items/") -async def read_items(token: Annotated[str, Depends(oauth2_scheme)]): - return {"token": token} diff --git a/docs_src/security/tutorial001_py39.py b/docs_src/security/tutorial001_py39.py deleted file mode 100644 index 224e59602e..0000000000 --- a/docs_src/security/tutorial001_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import Depends, FastAPI -from fastapi.security import OAuth2PasswordBearer - -app = FastAPI() - -oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token") - - -@app.get("/items/") -async def read_items(token: str = Depends(oauth2_scheme)): - return {"token": token} diff --git a/docs_src/security/tutorial006_an_py39.py b/docs_src/security/tutorial006_an_py39.py deleted file mode 100644 index 03c696a4b6..0000000000 --- a/docs_src/security/tutorial006_an_py39.py +++ /dev/null @@ -1,13 +0,0 @@ -from typing import Annotated - -from fastapi import Depends, FastAPI -from fastapi.security import HTTPBasic, HTTPBasicCredentials - -app = FastAPI() - -security = HTTPBasic() - - -@app.get("/users/me") -def read_current_user(credentials: Annotated[HTTPBasicCredentials, Depends(security)]): - return {"username": credentials.username, "password": credentials.password} diff --git a/docs_src/security/tutorial006_py39.py b/docs_src/security/tutorial006_py39.py deleted file mode 100644 index 29121ffd63..0000000000 --- a/docs_src/security/tutorial006_py39.py +++ /dev/null @@ -1,11 +0,0 @@ -from fastapi import Depends, FastAPI -from fastapi.security import HTTPBasic, HTTPBasicCredentials - -app = FastAPI() - -security = HTTPBasic() - - -@app.get("/users/me") -def read_current_user(credentials: HTTPBasicCredentials = Depends(security)): - return {"username": credentials.username, "password": credentials.password} diff --git a/docs_src/security/tutorial007_an_py39.py b/docs_src/security/tutorial007_an_py39.py deleted file mode 100644 index 87ef986574..0000000000 --- a/docs_src/security/tutorial007_an_py39.py +++ /dev/null @@ -1,36 +0,0 @@ -import secrets -from typing import Annotated - -from fastapi import Depends, FastAPI, HTTPException, status -from fastapi.security import HTTPBasic, HTTPBasicCredentials - -app = FastAPI() - -security = HTTPBasic() - - -def get_current_username( - credentials: Annotated[HTTPBasicCredentials, Depends(security)], -): - current_username_bytes = credentials.username.encode("utf8") - correct_username_bytes = b"stanleyjobson" - is_correct_username = secrets.compare_digest( - current_username_bytes, correct_username_bytes - ) - current_password_bytes = credentials.password.encode("utf8") - correct_password_bytes = b"swordfish" - is_correct_password = secrets.compare_digest( - current_password_bytes, correct_password_bytes - ) - if not (is_correct_username and is_correct_password): - raise HTTPException( - status_code=status.HTTP_401_UNAUTHORIZED, - detail="Incorrect username or password", - headers={"WWW-Authenticate": "Basic"}, - ) - return credentials.username - - -@app.get("/users/me") -def read_current_user(username: Annotated[str, Depends(get_current_username)]): - return {"username": username} diff --git a/docs_src/security/tutorial007_py39.py b/docs_src/security/tutorial007_py39.py deleted file mode 100644 index ac816eb0c1..0000000000 --- a/docs_src/security/tutorial007_py39.py +++ /dev/null @@ -1,33 +0,0 @@ -import secrets - -from fastapi import Depends, FastAPI, HTTPException, status -from fastapi.security import HTTPBasic, HTTPBasicCredentials - -app = FastAPI() - -security = HTTPBasic() - - -def get_current_username(credentials: HTTPBasicCredentials = Depends(security)): - current_username_bytes = credentials.username.encode("utf8") - correct_username_bytes = b"stanleyjobson" - is_correct_username = secrets.compare_digest( - current_username_bytes, correct_username_bytes - ) - current_password_bytes = credentials.password.encode("utf8") - correct_password_bytes = b"swordfish" - is_correct_password = secrets.compare_digest( - current_password_bytes, correct_password_bytes - ) - if not (is_correct_username and is_correct_password): - raise HTTPException( - status_code=status.HTTP_401_UNAUTHORIZED, - detail="Incorrect username or password", - headers={"WWW-Authenticate": "Basic"}, - ) - return credentials.username - - -@app.get("/users/me") -def read_current_user(username: str = Depends(get_current_username)): - return {"username": username} diff --git a/docs_src/settings/app01_py39/__init__.py b/docs_src/settings/app01_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/settings/app01_py39/config.py b/docs_src/settings/app01_py39/config.py deleted file mode 100644 index b31b8811d6..0000000000 --- a/docs_src/settings/app01_py39/config.py +++ /dev/null @@ -1,10 +0,0 @@ -from pydantic_settings import BaseSettings - - -class Settings(BaseSettings): - app_name: str = "Awesome API" - admin_email: str - items_per_user: int = 50 - - -settings = Settings() diff --git a/docs_src/settings/app01_py39/main.py b/docs_src/settings/app01_py39/main.py deleted file mode 100644 index 4a3a86ce20..0000000000 --- a/docs_src/settings/app01_py39/main.py +++ /dev/null @@ -1,14 +0,0 @@ -from fastapi import FastAPI - -from .config import settings - -app = FastAPI() - - -@app.get("/info") -async def info(): - return { - "app_name": settings.app_name, - "admin_email": settings.admin_email, - "items_per_user": settings.items_per_user, - } diff --git a/docs_src/settings/app02_an_py39/__init__.py b/docs_src/settings/app02_an_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/settings/app02_an_py39/config.py b/docs_src/settings/app02_an_py39/config.py deleted file mode 100644 index e17b5035dc..0000000000 --- a/docs_src/settings/app02_an_py39/config.py +++ /dev/null @@ -1,7 +0,0 @@ -from pydantic_settings import BaseSettings - - -class Settings(BaseSettings): - app_name: str = "Awesome API" - admin_email: str - items_per_user: int = 50 diff --git a/docs_src/settings/app02_an_py39/main.py b/docs_src/settings/app02_an_py39/main.py deleted file mode 100644 index 6d5db12a87..0000000000 --- a/docs_src/settings/app02_an_py39/main.py +++ /dev/null @@ -1,22 +0,0 @@ -from functools import lru_cache -from typing import Annotated - -from fastapi import Depends, FastAPI - -from .config import Settings - -app = FastAPI() - - -@lru_cache -def get_settings(): - return Settings() - - -@app.get("/info") -async def info(settings: Annotated[Settings, Depends(get_settings)]): - return { - "app_name": settings.app_name, - "admin_email": settings.admin_email, - "items_per_user": settings.items_per_user, - } diff --git a/docs_src/settings/app02_an_py39/test_main.py b/docs_src/settings/app02_an_py39/test_main.py deleted file mode 100644 index 7a04d7e8ee..0000000000 --- a/docs_src/settings/app02_an_py39/test_main.py +++ /dev/null @@ -1,23 +0,0 @@ -from fastapi.testclient import TestClient - -from .config import Settings -from .main import app, get_settings - -client = TestClient(app) - - -def get_settings_override(): - return Settings(admin_email="testing_admin@example.com") - - -app.dependency_overrides[get_settings] = get_settings_override - - -def test_app(): - response = client.get("/info") - data = response.json() - assert data == { - "app_name": "Awesome API", - "admin_email": "testing_admin@example.com", - "items_per_user": 50, - } diff --git a/docs_src/settings/app02_py39/__init__.py b/docs_src/settings/app02_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/settings/app02_py39/config.py b/docs_src/settings/app02_py39/config.py deleted file mode 100644 index e17b5035dc..0000000000 --- a/docs_src/settings/app02_py39/config.py +++ /dev/null @@ -1,7 +0,0 @@ -from pydantic_settings import BaseSettings - - -class Settings(BaseSettings): - app_name: str = "Awesome API" - admin_email: str - items_per_user: int = 50 diff --git a/docs_src/settings/app02_py39/main.py b/docs_src/settings/app02_py39/main.py deleted file mode 100644 index 941f82e6b3..0000000000 --- a/docs_src/settings/app02_py39/main.py +++ /dev/null @@ -1,21 +0,0 @@ -from functools import lru_cache - -from fastapi import Depends, FastAPI - -from .config import Settings - -app = FastAPI() - - -@lru_cache -def get_settings(): - return Settings() - - -@app.get("/info") -async def info(settings: Settings = Depends(get_settings)): - return { - "app_name": settings.app_name, - "admin_email": settings.admin_email, - "items_per_user": settings.items_per_user, - } diff --git a/docs_src/settings/app02_py39/test_main.py b/docs_src/settings/app02_py39/test_main.py deleted file mode 100644 index 7a04d7e8ee..0000000000 --- a/docs_src/settings/app02_py39/test_main.py +++ /dev/null @@ -1,23 +0,0 @@ -from fastapi.testclient import TestClient - -from .config import Settings -from .main import app, get_settings - -client = TestClient(app) - - -def get_settings_override(): - return Settings(admin_email="testing_admin@example.com") - - -app.dependency_overrides[get_settings] = get_settings_override - - -def test_app(): - response = client.get("/info") - data = response.json() - assert data == { - "app_name": "Awesome API", - "admin_email": "testing_admin@example.com", - "items_per_user": 50, - } diff --git a/docs_src/settings/app03_an_py39/__init__.py b/docs_src/settings/app03_an_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/settings/app03_an_py39/config.py b/docs_src/settings/app03_an_py39/config.py deleted file mode 100644 index 08f8f88c28..0000000000 --- a/docs_src/settings/app03_an_py39/config.py +++ /dev/null @@ -1,9 +0,0 @@ -from pydantic_settings import BaseSettings, SettingsConfigDict - - -class Settings(BaseSettings): - app_name: str = "Awesome API" - admin_email: str - items_per_user: int = 50 - - model_config = SettingsConfigDict(env_file=".env") diff --git a/docs_src/settings/app03_an_py39/main.py b/docs_src/settings/app03_an_py39/main.py deleted file mode 100644 index 2f64b9cd17..0000000000 --- a/docs_src/settings/app03_an_py39/main.py +++ /dev/null @@ -1,22 +0,0 @@ -from functools import lru_cache -from typing import Annotated - -from fastapi import Depends, FastAPI - -from . import config - -app = FastAPI() - - -@lru_cache -def get_settings(): - return config.Settings() - - -@app.get("/info") -async def info(settings: Annotated[config.Settings, Depends(get_settings)]): - return { - "app_name": settings.app_name, - "admin_email": settings.admin_email, - "items_per_user": settings.items_per_user, - } diff --git a/docs_src/settings/app03_py39/__init__.py b/docs_src/settings/app03_py39/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs_src/settings/app03_py39/config.py b/docs_src/settings/app03_py39/config.py deleted file mode 100644 index 08f8f88c28..0000000000 --- a/docs_src/settings/app03_py39/config.py +++ /dev/null @@ -1,9 +0,0 @@ -from pydantic_settings import BaseSettings, SettingsConfigDict - - -class Settings(BaseSettings): - app_name: str = "Awesome API" - admin_email: str - items_per_user: int = 50 - - model_config = SettingsConfigDict(env_file=".env") diff --git a/docs_src/settings/app03_py39/main.py b/docs_src/settings/app03_py39/main.py deleted file mode 100644 index ea64a5709c..0000000000 --- a/docs_src/settings/app03_py39/main.py +++ /dev/null @@ -1,21 +0,0 @@ -from functools import lru_cache - -from fastapi import Depends, FastAPI - -from . import config - -app = FastAPI() - - -@lru_cache -def get_settings(): - return config.Settings() - - -@app.get("/info") -async def info(settings: config.Settings = Depends(get_settings)): - return { - "app_name": settings.app_name, - "admin_email": settings.admin_email, - "items_per_user": settings.items_per_user, - } diff --git a/docs_src/settings/tutorial001_py39.py b/docs_src/settings/tutorial001_py39.py deleted file mode 100644 index d48c4c060c..0000000000 --- a/docs_src/settings/tutorial001_py39.py +++ /dev/null @@ -1,21 +0,0 @@ -from fastapi import FastAPI -from pydantic_settings import BaseSettings - - -class Settings(BaseSettings): - app_name: str = "Awesome API" - admin_email: str - items_per_user: int = 50 - - -settings = Settings() -app = FastAPI() - - -@app.get("/info") -async def info(): - return { - "app_name": settings.app_name, - "admin_email": settings.admin_email, - "items_per_user": settings.items_per_user, - } diff --git a/docs_src/static_files/tutorial001_py39.py b/docs_src/static_files/tutorial001_py39.py deleted file mode 100644 index 460352c7e1..0000000000 --- a/docs_src/static_files/tutorial001_py39.py +++ /dev/null @@ -1,6 +0,0 @@ -from fastapi import FastAPI -from fastapi.staticfiles import StaticFiles - -app = FastAPI() - -app.mount("/static", StaticFiles(directory="static"), name="static") diff --git a/docs_src/sub_applications/tutorial001_py39.py b/docs_src/sub_applications/tutorial001_py39.py deleted file mode 100644 index 57e627e804..0000000000 --- a/docs_src/sub_applications/tutorial001_py39.py +++ /dev/null @@ -1,19 +0,0 @@ -from fastapi import FastAPI - -app = FastAPI() - - -@app.get("/app") -def read_main(): - return {"message": "Hello World from main app"} - - -subapi = FastAPI() - - -@subapi.get("/sub") -def read_sub(): - return {"message": "Hello World from sub API"} - - -app.mount("/subapi", subapi) diff --git a/docs_src/templates/tutorial001_py39.py b/docs_src/templates/tutorial001_py39.py deleted file mode 100644 index 81ccc8d4d0..0000000000 --- a/docs_src/templates/tutorial001_py39.py +++ /dev/null @@ -1,18 +0,0 @@ -from fastapi import FastAPI, Request -from fastapi.responses import HTMLResponse -from fastapi.staticfiles import StaticFiles -from fastapi.templating import Jinja2Templates - -app = FastAPI() - -app.mount("/static", StaticFiles(directory="static"), name="static") - - -templates = Jinja2Templates(directory="templates") - - -@app.get("/items/{id}", response_class=HTMLResponse) -async def read_item(request: Request, id: str): - return templates.TemplateResponse( - request=request, name="item.html", context={"id": id} - ) diff --git a/docs_src/using_request_directly/tutorial001_py39.py b/docs_src/using_request_directly/tutorial001_py39.py deleted file mode 100644 index 2d7288b54d..0000000000 --- a/docs_src/using_request_directly/tutorial001_py39.py +++ /dev/null @@ -1,9 +0,0 @@ -from fastapi import FastAPI, Request - -app = FastAPI() - - -@app.get("/items/{item_id}") -def read_root(item_id: str, request: Request): - client_host = request.client.host - return {"client_host": client_host, "item_id": item_id} diff --git a/docs_src/websockets/tutorial001_py39.py b/docs_src/websockets/tutorial001_py39.py deleted file mode 100644 index a43a2be17c..0000000000 --- a/docs_src/websockets/tutorial001_py39.py +++ /dev/null @@ -1,51 +0,0 @@ -from fastapi import FastAPI, WebSocket -from fastapi.responses import HTMLResponse - -app = FastAPI() - -html = """ - - - - Chat - - -

WebSocket Chat

-
- - -
-
    -
- - - -""" - - -@app.get("/") -async def get(): - return HTMLResponse(html) - - -@app.websocket("/ws") -async def websocket_endpoint(websocket: WebSocket): - await websocket.accept() - while True: - data = await websocket.receive_text() - await websocket.send_text(f"Message text was: {data}") diff --git a/docs_src/websockets/tutorial003_py39.py b/docs_src/websockets/tutorial003_py39.py deleted file mode 100644 index 3162180889..0000000000 --- a/docs_src/websockets/tutorial003_py39.py +++ /dev/null @@ -1,81 +0,0 @@ -from fastapi import FastAPI, WebSocket, WebSocketDisconnect -from fastapi.responses import HTMLResponse - -app = FastAPI() - -html = """ - - - - Chat - - -

WebSocket Chat

-

Your ID:

-
- - -
-
    -
- - - -""" - - -class ConnectionManager: - def __init__(self): - self.active_connections: list[WebSocket] = [] - - async def connect(self, websocket: WebSocket): - await websocket.accept() - self.active_connections.append(websocket) - - def disconnect(self, websocket: WebSocket): - self.active_connections.remove(websocket) - - async def send_personal_message(self, message: str, websocket: WebSocket): - await websocket.send_text(message) - - async def broadcast(self, message: str): - for connection in self.active_connections: - await connection.send_text(message) - - -manager = ConnectionManager() - - -@app.get("/") -async def get(): - return HTMLResponse(html) - - -@app.websocket("/ws/{client_id}") -async def websocket_endpoint(websocket: WebSocket, client_id: int): - await manager.connect(websocket) - try: - while True: - data = await websocket.receive_text() - await manager.send_personal_message(f"You wrote: {data}", websocket) - await manager.broadcast(f"Client #{client_id} says: {data}") - except WebSocketDisconnect: - manager.disconnect(websocket) - await manager.broadcast(f"Client #{client_id} left the chat") diff --git a/docs_src/wsgi/tutorial001_py39.py b/docs_src/wsgi/tutorial001_py39.py deleted file mode 100644 index 8eeceb829e..0000000000 --- a/docs_src/wsgi/tutorial001_py39.py +++ /dev/null @@ -1,23 +0,0 @@ -from a2wsgi import WSGIMiddleware -from fastapi import FastAPI -from flask import Flask, request -from markupsafe import escape - -flask_app = Flask(__name__) - - -@flask_app.route("/") -def flask_main(): - name = request.args.get("name", "World") - return f"Hello, {escape(name)} from Flask!" - - -app = FastAPI() - - -@app.get("/v2") -def read_main(): - return {"message": "Hello World"} - - -app.mount("/v1", WSGIMiddleware(flask_app)) diff --git a/scripts/doc_parsing_utils.py b/scripts/doc_parsing_utils.py index 79f2e9ec0a..1cd2299e66 100644 --- a/scripts/doc_parsing_utils.py +++ b/scripts/doc_parsing_utils.py @@ -1,5 +1,5 @@ import re -from typing import TypedDict, Union +from typing import TypedDict CODE_INCLUDE_RE = re.compile(r"^\{\*\s*(\S+)\s*(.*)\*\}$") CODE_INCLUDE_PLACEHOLDER = "" @@ -50,8 +50,8 @@ class MarkdownLinkInfo(TypedDict): line_no: int url: str text: str - title: Union[str, None] - attributes: Union[str, None] + title: str | None + attributes: str | None full_match: str @@ -287,8 +287,8 @@ def _add_lang_code_to_url(url: str, lang_code: str) -> str: def _construct_markdown_link( url: str, text: str, - title: Union[str, None], - attributes: Union[str, None], + title: str | None, + attributes: str | None, lang_code: str, ) -> str: """ @@ -549,7 +549,7 @@ def extract_multiline_code_blocks(text: list[str]) -> list[MultilineCodeBlockInf return blocks -def _split_hash_comment(line: str) -> tuple[str, Union[str, None]]: +def _split_hash_comment(line: str) -> tuple[str, str | None]: match = HASH_COMMENT_RE.match(line) if match: code = match.group("code").rstrip() @@ -558,7 +558,7 @@ def _split_hash_comment(line: str) -> tuple[str, Union[str, None]]: return line.rstrip(), None -def _split_slashes_comment(line: str) -> tuple[str, Union[str, None]]: +def _split_slashes_comment(line: str) -> tuple[str, str | None]: match = SLASHES_COMMENT_RE.match(line) if match: code = match.group("code").rstrip() @@ -603,9 +603,9 @@ def replace_multiline_code_block( return block_a["content"].copy() # We don't handle mermaid code blocks for now code_block: list[str] = [] - for line_a, line_b in zip(block_a["content"], block_b["content"]): - line_a_comment: Union[str, None] = None - line_b_comment: Union[str, None] = None + for line_a, line_b in zip(block_a["content"], block_b["content"], strict=False): + line_a_comment: str | None = None + line_b_comment: str | None = None # Handle comments based on language if block_language in { @@ -659,7 +659,7 @@ def replace_multiline_code_blocks_in_text( ) modified_text = text.copy() - for block, original_block in zip(code_blocks, original_code_blocks): + for block, original_block in zip(code_blocks, original_code_blocks, strict=True): updated_content = replace_multiline_code_block(block, original_block) start_line_index = block["start_line_no"] - 1 diff --git a/scripts/mkdocs_hooks.py b/scripts/mkdocs_hooks.py index 567c0111dc..97006953d6 100644 --- a/scripts/mkdocs_hooks.py +++ b/scripts/mkdocs_hooks.py @@ -1,6 +1,6 @@ from functools import lru_cache from pathlib import Path -from typing import Any, Union +from typing import Any import material from mkdocs.config.defaults import MkDocsConfig @@ -105,9 +105,9 @@ def on_files(files: Files, *, config: MkDocsConfig) -> Files: def generate_renamed_section_items( - items: list[Union[Page, Section, Link]], *, config: MkDocsConfig -) -> list[Union[Page, Section, Link]]: - new_items: list[Union[Page, Section, Link]] = [] + items: list[Page | Section | Link], *, config: MkDocsConfig +) -> list[Page | Section | Link]: + new_items: list[Page | Section | Link] = [] for item in items: if isinstance(item, Section): new_title = item.title diff --git a/scripts/notify_translations.py b/scripts/notify_translations.py index 74cdf0dffe..3484b69c70 100644 --- a/scripts/notify_translations.py +++ b/scripts/notify_translations.py @@ -3,7 +3,7 @@ import random import sys import time from pathlib import Path -from typing import Any, Union, cast +from typing import Any, cast import httpx from github import Github @@ -181,9 +181,9 @@ class Settings(BaseSettings): github_repository: str github_token: SecretStr github_event_path: Path - github_event_name: Union[str, None] = None + github_event_name: str | None = None httpx_timeout: int = 30 - debug: Union[bool, None] = False + debug: bool | None = False number: int | None = None @@ -199,12 +199,12 @@ def get_graphql_response( *, settings: Settings, query: str, - after: Union[str, None] = None, - category_id: Union[str, None] = None, - discussion_number: Union[int, None] = None, - discussion_id: Union[str, None] = None, - comment_id: Union[str, None] = None, - body: Union[str, None] = None, + after: str | None = None, + category_id: str | None = None, + discussion_number: int | None = None, + discussion_id: str | None = None, + comment_id: str | None = None, + body: str | None = None, ) -> dict[str, Any]: headers = {"Authorization": f"token {settings.github_token.get_secret_value()}"} variables = { @@ -249,7 +249,7 @@ def get_graphql_translation_discussions( def get_graphql_translation_discussion_comments_edges( - *, settings: Settings, discussion_number: int, after: Union[str, None] = None + *, settings: Settings, discussion_number: int, after: str | None = None ) -> list[CommentsEdge]: data = get_graphql_response( settings=settings, @@ -372,8 +372,8 @@ def main() -> None: f"Found a translation discussion for language: {lang} in discussion: #{discussion.number}" ) - already_notified_comment: Union[Comment, None] = None - already_done_comment: Union[Comment, None] = None + already_notified_comment: Comment | None = None + already_done_comment: Comment | None = None logging.info( f"Checking current comments in discussion: #{discussion.number} to see if already notified about this PR: #{pr.number}" diff --git a/scripts/people.py b/scripts/people.py index 207ab46493..f3254ab606 100644 --- a/scripts/people.py +++ b/scripts/people.py @@ -6,7 +6,7 @@ from collections import Counter from collections.abc import Container from datetime import datetime, timedelta, timezone from pathlib import Path -from typing import Any, Union +from typing import Any import httpx import yaml @@ -70,7 +70,7 @@ class Author(BaseModel): class CommentsNode(BaseModel): createdAt: datetime - author: Union[Author, None] = None + author: Author | None = None class Replies(BaseModel): @@ -89,7 +89,7 @@ class DiscussionsComments(BaseModel): class DiscussionsNode(BaseModel): number: int - author: Union[Author, None] = None + author: Author | None = None title: str | None = None createdAt: datetime comments: DiscussionsComments @@ -127,8 +127,8 @@ def get_graphql_response( *, settings: Settings, query: str, - after: Union[str, None] = None, - category_id: Union[str, None] = None, + after: str | None = None, + category_id: str | None = None, ) -> dict[str, Any]: headers = {"Authorization": f"token {settings.github_token.get_secret_value()}"} variables = {"after": after, "category_id": category_id} @@ -156,7 +156,7 @@ def get_graphql_response( def get_graphql_question_discussion_edges( *, settings: Settings, - after: Union[str, None] = None, + after: str | None = None, ) -> list[DiscussionsEdge]: data = get_graphql_response( settings=settings, diff --git a/scripts/tests/test_translation_fixer/test_code_includes/data/en_doc.md b/scripts/tests/test_translation_fixer/test_code_includes/data/en_doc.md index 593da0b327..0e021dadea 100644 --- a/scripts/tests/test_translation_fixer/test_code_includes/data/en_doc.md +++ b/scripts/tests/test_translation_fixer/test_code_includes/data/en_doc.md @@ -4,7 +4,7 @@ Some text -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} Some more text diff --git a/scripts/tests/test_translation_fixer/test_code_includes/data/translated_doc_number_gt.md b/scripts/tests/test_translation_fixer/test_code_includes/data/translated_doc_number_gt.md index c1ad94d276..aca1464ff2 100644 --- a/scripts/tests/test_translation_fixer/test_code_includes/data/translated_doc_number_gt.md +++ b/scripts/tests/test_translation_fixer/test_code_includes/data/translated_doc_number_gt.md @@ -4,7 +4,7 @@ Some text -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} Some more text @@ -12,4 +12,4 @@ Some more text And even more text -{* ../../docs_src/python_types/tutorial001_py39.py *} +{* ../../docs_src/python_types/tutorial001_py310.py *} diff --git a/scripts/tests/test_translation_fixer/test_code_includes/data/translated_doc_number_lt.md b/scripts/tests/test_translation_fixer/test_code_includes/data/translated_doc_number_lt.md index 07eaf2c23d..12573aa196 100644 --- a/scripts/tests/test_translation_fixer/test_code_includes/data/translated_doc_number_lt.md +++ b/scripts/tests/test_translation_fixer/test_code_includes/data/translated_doc_number_lt.md @@ -4,7 +4,7 @@ Some text -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} Some more text diff --git a/scripts/tests/test_translation_fixer/test_complex_doc/data/en_doc.md b/scripts/tests/test_translation_fixer/test_complex_doc/data/en_doc.md index 69cd3f3fd7..d6c1e3d2fe 100644 --- a/scripts/tests/test_translation_fixer/test_complex_doc/data/en_doc.md +++ b/scripts/tests/test_translation_fixer/test_complex_doc/data/en_doc.md @@ -141,16 +141,16 @@ def hello_world(): ## Simple code includes { #simple-code-includes } -{* ../../docs_src/python_types/tutorial001_py39.py *} +{* ../../docs_src/python_types/tutorial001_py310.py *} -{* ../../docs_src/python_types/tutorial002_py39.py *} +{* ../../docs_src/python_types/tutorial002_py310.py *} ## Code includes with highlighting { #code-includes-with-highlighting } -{* ../../docs_src/python_types/tutorial002_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial002_py310.py hl[1] *} -{* ../../docs_src/python_types/tutorial006_py39.py hl[10] *} +{* ../../docs_src/python_types/tutorial006_py310.py hl[10] *} ## Code includes with line ranges { #code-includes-with-line-ranges } @@ -169,19 +169,19 @@ def hello_world(): ## Code includes qith title { #code-includes-with-title } -{* ../../docs_src/bigger_applications/app_an_py39/routers/users.py hl[1,3] title["app/routers/users.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *} -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} ## Code includes with unknown attributes { #code-includes-with-unknown-attributes } -{* ../../docs_src/python_types/tutorial001_py39.py unknown[123] *} +{* ../../docs_src/python_types/tutorial001_py310.py unknown[123] *} ## Some more code includes to test fixing { #some-more-code-includes-to-test-fixing } {* ../../docs_src/dependencies/tutorial013_an_py310.py ln[19:21] *} -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} {* ../../docs_src/dependencies/tutorial013_an_py310.py ln[30:38] hl[31:33] *} diff --git a/scripts/tests/test_translation_fixer/test_complex_doc/data/translated_doc.md b/scripts/tests/test_translation_fixer/test_complex_doc/data/translated_doc.md index c922d7b133..b27eef202c 100644 --- a/scripts/tests/test_translation_fixer/test_complex_doc/data/translated_doc.md +++ b/scripts/tests/test_translation_fixer/test_complex_doc/data/translated_doc.md @@ -139,16 +139,16 @@ def hello_world(): ## Простые включения кода { #simple-code-includes } -{* ../../docs_src/python_types/tutorial001_py39.py *} +{* ../../docs_src/python_types/tutorial001_py310.py *} -{* ../../docs_src/python_types/tutorial002_py39.py *} +{* ../../docs_src/python_types/tutorial002_py310.py *} ## Включения кода с подсветкой { #code-includes-with-highlighting } -{* ../../docs_src/python_types/tutorial002_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial002_py310.py hl[1] *} -{* ../../docs_src/python_types/tutorial006_py39.py hl[10] *} +{* ../../docs_src/python_types/tutorial006_py310.py hl[10] *} ## Включения кода с диапазонами строк { #code-includes-with-line-ranges } @@ -167,19 +167,19 @@ def hello_world(): ## Включения кода с заголовком { #code-includes-with-title } -{* ../../docs_src/bigger_applications/app_an_py39/routers/users.py hl[1,3] title["app/routers/users.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *} -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} ## Включения кода с неизвестными атрибутами { #code-includes-with-unknown-attributes } -{* ../../docs_src/python_types/tutorial001_py39.py unknown[123] *} +{* ../../docs_src/python_types/tutorial001_py310.py unknown[123] *} ## Ещё включения кода для тестирования исправления { #some-more-code-includes-to-test-fixing } {* ../../docs_src/dependencies/tutorial013_an_py310.py ln[19 : 21] *} -{* ../../docs_src/bigger_applications/app_an_py39/wrong.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/wrong.py hl[3] title["app/internal/admin.py"] *} {* ../../docs_src/dependencies/tutorial013_an_py310.py ln[1:30] hl[1:10] *} diff --git a/scripts/tests/test_translation_fixer/test_complex_doc/data/translated_doc_expected.md b/scripts/tests/test_translation_fixer/test_complex_doc/data/translated_doc_expected.md index b33f36e772..8e2394f14f 100644 --- a/scripts/tests/test_translation_fixer/test_complex_doc/data/translated_doc_expected.md +++ b/scripts/tests/test_translation_fixer/test_complex_doc/data/translated_doc_expected.md @@ -139,16 +139,16 @@ def hello_world(): ## Простые включения кода { #simple-code-includes } -{* ../../docs_src/python_types/tutorial001_py39.py *} +{* ../../docs_src/python_types/tutorial001_py310.py *} -{* ../../docs_src/python_types/tutorial002_py39.py *} +{* ../../docs_src/python_types/tutorial002_py310.py *} ## Включения кода с подсветкой { #code-includes-with-highlighting } -{* ../../docs_src/python_types/tutorial002_py39.py hl[1] *} +{* ../../docs_src/python_types/tutorial002_py310.py hl[1] *} -{* ../../docs_src/python_types/tutorial006_py39.py hl[10] *} +{* ../../docs_src/python_types/tutorial006_py310.py hl[10] *} ## Включения кода с диапазонами строк { #code-includes-with-line-ranges } @@ -167,19 +167,19 @@ def hello_world(): ## Включения кода с заголовком { #code-includes-with-title } -{* ../../docs_src/bigger_applications/app_an_py39/routers/users.py hl[1,3] title["app/routers/users.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *} -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} ## Включения кода с неизвестными атрибутами { #code-includes-with-unknown-attributes } -{* ../../docs_src/python_types/tutorial001_py39.py unknown[123] *} +{* ../../docs_src/python_types/tutorial001_py310.py unknown[123] *} ## Ещё включения кода для тестирования исправления { #some-more-code-includes-to-test-fixing } {* ../../docs_src/dependencies/tutorial013_an_py310.py ln[19:21] *} -{* ../../docs_src/bigger_applications/app_an_py39/internal/admin.py hl[3] title["app/internal/admin.py"] *} +{* ../../docs_src/bigger_applications/app_an_py310/internal/admin.py hl[3] title["app/internal/admin.py"] *} {* ../../docs_src/dependencies/tutorial013_an_py310.py ln[30:38] hl[31:33] *} diff --git a/tests/main.py b/tests/main.py index 7edb16c615..d2fbbe6153 100644 --- a/tests/main.py +++ b/tests/main.py @@ -1,5 +1,4 @@ import http -from typing import Optional from fastapi import FastAPI, Path, Query @@ -54,7 +53,7 @@ def get_bool_id(item_id: bool): @app.get("/path/param/{item_id}") -def get_path_param_id(item_id: Optional[str] = Path()): +def get_path_param_id(item_id: str | None = Path()): return item_id @@ -161,7 +160,7 @@ def get_query_type(query: int): @app.get("/query/int/optional") -def get_query_type_optional(query: Optional[int] = None): +def get_query_type_optional(query: int | None = None): if query is None: return "foo bar" return f"foo bar {query}" diff --git a/tests/test_additional_properties_bool.py b/tests/test_additional_properties_bool.py index c02841cde1..9a1e139eaa 100644 --- a/tests/test_additional_properties_bool.py +++ b/tests/test_additional_properties_bool.py @@ -1,5 +1,3 @@ -from typing import Union - from fastapi import FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -19,7 +17,7 @@ app = FastAPI() @app.post("/") async def post( - foo: Union[Foo, None] = None, + foo: Foo | None = None, ): return foo diff --git a/tests/test_additional_responses_union_duplicate_anyof.py b/tests/test_additional_responses_union_duplicate_anyof.py index 5d833fce4a..401bc0a744 100644 --- a/tests/test_additional_responses_union_duplicate_anyof.py +++ b/tests/test_additional_responses_union_duplicate_anyof.py @@ -4,8 +4,6 @@ don't accumulate duplicate $ref entries in anyOf arrays. See https://github.com/fastapi/fastapi/pull/14463 """ -from typing import Union - from fastapi import FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -23,7 +21,7 @@ class ModelB(BaseModel): app = FastAPI( responses={ 500: { - "model": Union[ModelA, ModelB], + "model": ModelA | ModelB, "content": {"application/json": {"examples": {"Case A": {"value": "a"}}}}, } } diff --git a/tests/test_callable_endpoint.py b/tests/test_callable_endpoint.py index 1882e9053a..28999d3833 100644 --- a/tests/test_callable_endpoint.py +++ b/tests/test_callable_endpoint.py @@ -1,11 +1,10 @@ from functools import partial -from typing import Optional from fastapi import FastAPI from fastapi.testclient import TestClient -def main(some_arg, q: Optional[str] = None): +def main(some_arg, q: str | None = None): return {"some_arg": some_arg, "q": q} diff --git a/tests/test_compat.py b/tests/test_compat.py index 0b5600f8f5..772bd305eb 100644 --- a/tests/test_compat.py +++ b/tests/test_compat.py @@ -1,5 +1,3 @@ -from typing import Union - from fastapi import FastAPI, UploadFile from fastapi._compat import ( Undefined, @@ -10,8 +8,6 @@ from fastapi.testclient import TestClient from pydantic import BaseModel, ConfigDict from pydantic.fields import FieldInfo -from .utils import needs_py310 - def test_model_field_default_required(): from fastapi._compat import v2 @@ -26,7 +22,7 @@ def test_complex(): app = FastAPI() @app.post("/") - def foo(foo: Union[str, list[int]]): + def foo(foo: str | list[int]): return foo client = TestClient(app) @@ -49,17 +45,17 @@ def test_propagates_pydantic2_model_config(): class EmbeddedModel(BaseModel): model_config = ConfigDict(arbitrary_types_allowed=True) - value: Union[str, Missing] = Missing() + value: str | Missing = Missing() class Model(BaseModel): model_config = ConfigDict( arbitrary_types_allowed=True, ) - value: Union[str, Missing] = Missing() + value: str | Missing = Missing() embedded_model: EmbeddedModel = EmbeddedModel() @app.post("/") - def foo(req: Model) -> dict[str, Union[str, None]]: + def foo(req: Model) -> dict[str, str | None]: return { "value": req.value or None, "embedded_value": req.embedded_model.value or None, @@ -89,7 +85,7 @@ def test_is_bytes_sequence_annotation_union(): # TODO: in theory this would allow declaring types that could be lists of bytes # to be read from files and other types, but I'm not even sure it's a good idea # to support it as a first class "feature" - assert is_bytes_sequence_annotation(Union[list[str], list[bytes]]) + assert is_bytes_sequence_annotation(list[str] | list[bytes]) def test_is_uploadfile_sequence_annotation(): @@ -97,21 +93,20 @@ def test_is_uploadfile_sequence_annotation(): # TODO: in theory this would allow declaring types that could be lists of UploadFile # and other types, but I'm not even sure it's a good idea to support it as a first # class "feature" - assert is_uploadfile_sequence_annotation(Union[list[str], list[UploadFile]]) + assert is_uploadfile_sequence_annotation(list[str] | list[UploadFile]) def test_serialize_sequence_value_with_optional_list(): """Test that serialize_sequence_value handles optional lists correctly.""" from fastapi._compat import v2 - field_info = FieldInfo(annotation=Union[list[str], None]) + field_info = FieldInfo(annotation=list[str] | None) field = v2.ModelField(name="items", field_info=field_info) result = v2.serialize_sequence_value(field=field, value=["a", "b", "c"]) assert result == ["a", "b", "c"] assert isinstance(result, list) -@needs_py310 def test_serialize_sequence_value_with_optional_list_pipe_union(): """Test that serialize_sequence_value handles optional lists correctly (with new syntax).""" from fastapi._compat import v2 @@ -125,9 +120,12 @@ def test_serialize_sequence_value_with_optional_list_pipe_union(): def test_serialize_sequence_value_with_none_first_in_union(): """Test that serialize_sequence_value handles Union[None, List[...]] correctly.""" + from typing import Union + from fastapi._compat import v2 - field_info = FieldInfo(annotation=Union[None, list[str]]) + # Use Union[None, list[str]] to ensure None comes first in the union args + field_info = FieldInfo(annotation=Union[None, list[str]]) # noqa: UP007 field = v2.ModelField(name="items", field_info=field_info) result = v2.serialize_sequence_value(field=field, value=["x", "y"]) assert result == ["x", "y"] diff --git a/tests/test_custom_middleware_exception.py b/tests/test_custom_middleware_exception.py index d9b81e7c2e..cf548f4aed 100644 --- a/tests/test_custom_middleware_exception.py +++ b/tests/test_custom_middleware_exception.py @@ -1,5 +1,4 @@ from pathlib import Path -from typing import Optional from fastapi import APIRouter, FastAPI, File, UploadFile from fastapi.exceptions import HTTPException @@ -17,7 +16,7 @@ class ContentSizeLimitMiddleware: max_content_size (optional): the maximum content size allowed in bytes, None for no limit """ - def __init__(self, app: APIRouter, max_content_size: Optional[int] = None): + def __init__(self, app: APIRouter, max_content_size: int | None = None): self.app = app self.max_content_size = max_content_size diff --git a/tests/test_custom_schema_fields.py b/tests/test_custom_schema_fields.py index 60b795e9ba..c907c54242 100644 --- a/tests/test_custom_schema_fields.py +++ b/tests/test_custom_schema_fields.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated from fastapi import FastAPI from fastapi.testclient import TestClient @@ -10,9 +10,9 @@ app = FastAPI() class Item(BaseModel): name: str - description: Annotated[ - Optional[str], WithJsonSchema({"type": ["string", "null"]}) - ] = None + description: Annotated[str | None, WithJsonSchema({"type": ["string", "null"]})] = ( + None + ) model_config = { "json_schema_extra": { diff --git a/tests/test_dependency_contextvars.py b/tests/test_dependency_contextvars.py index 0c2e5594b6..eba135785b 100644 --- a/tests/test_dependency_contextvars.py +++ b/tests/test_dependency_contextvars.py @@ -1,11 +1,11 @@ -from collections.abc import Awaitable +from collections.abc import Awaitable, Callable from contextvars import ContextVar -from typing import Any, Callable, Optional +from typing import Any from fastapi import Depends, FastAPI, Request, Response from fastapi.testclient import TestClient -legacy_request_state_context_var: ContextVar[Optional[dict[str, Any]]] = ContextVar( +legacy_request_state_context_var: ContextVar[dict[str, Any] | None] = ContextVar( "legacy_request_state_context_var", default=None ) diff --git a/tests/test_dependency_overrides.py b/tests/test_dependency_overrides.py index e25db624d8..7c99d9d9d3 100644 --- a/tests/test_dependency_overrides.py +++ b/tests/test_dependency_overrides.py @@ -1,5 +1,3 @@ -from typing import Optional - import pytest from fastapi import APIRouter, Depends, FastAPI from fastapi.testclient import TestClient @@ -38,7 +36,7 @@ app.include_router(router) client = TestClient(app) -async def overrider_dependency_simple(q: Optional[str] = None): +async def overrider_dependency_simple(q: str | None = None): return {"q": q, "skip": 5, "limit": 10} diff --git a/tests/test_dependency_paramless.py b/tests/test_dependency_paramless.py index 1774196fe4..62c977b825 100644 --- a/tests/test_dependency_paramless.py +++ b/tests/test_dependency_paramless.py @@ -1,4 +1,4 @@ -from typing import Annotated, Union +from typing import Annotated from fastapi import FastAPI, HTTPException, Security from fastapi.security import ( @@ -13,7 +13,7 @@ oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token") def process_auth( - credentials: Annotated[Union[str, None], Security(oauth2_scheme)], + credentials: Annotated[str | None, Security(oauth2_scheme)], security_scopes: SecurityScopes, ): # This is an incorrect way of using it, this is not checking if the scopes are diff --git a/tests/test_enforce_once_required_parameter.py b/tests/test_enforce_once_required_parameter.py index 0dee15c25d..9f8a964543 100644 --- a/tests/test_enforce_once_required_parameter.py +++ b/tests/test_enforce_once_required_parameter.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import Depends, FastAPI, Query from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -11,7 +9,7 @@ def _get_client_key(client_id: str = Query(...)) -> str: return f"{client_id}_key" -def _get_client_tag(client_id: Optional[str] = Query(None)) -> Optional[str]: +def _get_client_tag(client_id: str | None = Query(None)) -> str | None: if client_id is None: return None return f"{client_id}_tag" @@ -20,7 +18,7 @@ def _get_client_tag(client_id: Optional[str] = Query(None)) -> Optional[str]: @app.get("/foo") def foo_handler( client_key: str = Depends(_get_client_key), - client_tag: Optional[str] = Depends(_get_client_tag), + client_tag: str | None = Depends(_get_client_tag), ): return {"client_id": client_key, "client_tag": client_tag} diff --git a/tests/test_extra_routes.py b/tests/test_extra_routes.py index 96f85b4465..985adb9439 100644 --- a/tests/test_extra_routes.py +++ b/tests/test_extra_routes.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI from fastapi.responses import JSONResponse from fastapi.testclient import TestClient @@ -11,7 +9,7 @@ app = FastAPI() class Item(BaseModel): name: str - price: Optional[float] = None + price: float | None = None @app.api_route("/items/{item_id}", methods=["GET"]) diff --git a/tests/test_filter_pydantic_sub_model_pv2.py b/tests/test_filter_pydantic_sub_model_pv2.py index 1de2b50f7f..1f39581c23 100644 --- a/tests/test_filter_pydantic_sub_model_pv2.py +++ b/tests/test_filter_pydantic_sub_model_pv2.py @@ -1,5 +1,3 @@ -from typing import Optional - import pytest from dirty_equals import HasRepr from fastapi import Depends, FastAPI @@ -22,7 +20,7 @@ def get_client(): class ModelA(BaseModel): name: str - description: Optional[str] = None + description: str | None = None foo: ModelB tags: dict[str, str] = {} diff --git a/tests/test_form_default.py b/tests/test_form_default.py index 0b3eb8f2e2..c4d33e3fb6 100644 --- a/tests/test_form_default.py +++ b/tests/test_form_default.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated from fastapi import FastAPI, File, Form from starlette.testclient import TestClient @@ -7,14 +7,14 @@ app = FastAPI() @app.post("/urlencoded") -async def post_url_encoded(age: Annotated[Optional[int], Form()] = None): +async def post_url_encoded(age: Annotated[int | None, Form()] = None): return age @app.post("/multipart") async def post_multi_part( - age: Annotated[Optional[int], Form()] = None, - file: Annotated[Optional[bytes], File()] = None, + age: Annotated[int | None, Form()] = None, + file: Annotated[bytes | None, File()] = None, ): return {"file": file, "age": age} diff --git a/tests/test_forms_single_model.py b/tests/test_forms_single_model.py index 7d03d29572..4575e3335e 100644 --- a/tests/test_forms_single_model.py +++ b/tests/test_forms_single_model.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated from fastapi import FastAPI, Form from fastapi.testclient import TestClient @@ -10,7 +10,7 @@ app = FastAPI() class FormModel(BaseModel): username: str lastname: str - age: Optional[int] = None + age: int | None = None tags: list[str] = ["foo", "bar"] alias_with: str = Field(alias="with", default="nothing") diff --git a/tests/test_infer_param_optionality.py b/tests/test_infer_param_optionality.py index bb20a4a1aa..2cf74e187a 100644 --- a/tests/test_infer_param_optionality.py +++ b/tests/test_infer_param_optionality.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import APIRouter, FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -22,7 +20,7 @@ def get_user(user_id: str): @item_router.get("/") -def get_items(user_id: Optional[str] = None): +def get_items(user_id: str | None = None): if user_id is None: return [{"item_id": "i1", "user_id": "u1"}, {"item_id": "i2", "user_id": "u2"}] else: @@ -30,7 +28,7 @@ def get_items(user_id: Optional[str] = None): @item_router.get("/{item_id}") -def get_item(item_id: str, user_id: Optional[str] = None): +def get_item(item_id: str, user_id: str | None = None): if user_id is None: return {"item_id": item_id} else: diff --git a/tests/test_invalid_sequence_param.py b/tests/test_invalid_sequence_param.py index 3695344f7a..d137f6805e 100644 --- a/tests/test_invalid_sequence_param.py +++ b/tests/test_invalid_sequence_param.py @@ -1,5 +1,3 @@ -from typing import Optional - import pytest from fastapi import FastAPI, Query from pydantic import BaseModel @@ -61,5 +59,5 @@ def test_invalid_simple_dict(): title: str @app.get("/items/") - def read_items(q: Optional[dict] = Query(default=None)): + def read_items(q: dict | None = Query(default=None)): pass # pragma: no cover diff --git a/tests/test_openapi_examples.py b/tests/test_openapi_examples.py index deb74d8a0f..e27dd2be08 100644 --- a/tests/test_openapi_examples.py +++ b/tests/test_openapi_examples.py @@ -1,5 +1,3 @@ -from typing import Union - from fastapi import Body, Cookie, FastAPI, Header, Path, Query from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -57,7 +55,7 @@ def path_examples( @app.get("/query_examples/") def query_examples( - data: Union[str, None] = Query( + data: str | None = Query( default=None, examples=[ "json_schema_query1", @@ -80,7 +78,7 @@ def query_examples( @app.get("/header_examples/") def header_examples( - data: Union[str, None] = Header( + data: str | None = Header( default=None, examples=[ "json_schema_header1", @@ -103,7 +101,7 @@ def header_examples( @app.get("/cookie_examples/") def cookie_examples( - data: Union[str, None] = Cookie( + data: str | None = Cookie( default=None, examples=["json_schema_cookie1", "json_schema_cookie2"], openapi_examples={ diff --git a/tests/test_openapi_query_parameter_extension.py b/tests/test_openapi_query_parameter_extension.py index 836a0a7ee5..118d518149 100644 --- a/tests/test_openapi_query_parameter_extension.py +++ b/tests/test_openapi_query_parameter_extension.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -26,7 +24,7 @@ app = FastAPI() ] }, ) -def route_with_extra_query_parameters(standard_query_param: Optional[int] = 50): +def route_with_extra_query_parameters(standard_query_param: int | None = 50): return {} diff --git a/tests/test_openapi_schema_type.py b/tests/test_openapi_schema_type.py index 98d9787455..e8166d2fb9 100644 --- a/tests/test_openapi_schema_type.py +++ b/tests/test_openapi_schema_type.py @@ -1,5 +1,3 @@ -from typing import Optional, Union - import pytest from fastapi.openapi.models import Schema, SchemaType @@ -13,7 +11,7 @@ from fastapi.openapi.models import Schema, SchemaType ], ) def test_allowed_schema_type( - type_value: Optional[Union[SchemaType, list[SchemaType]]], + type_value: SchemaType | list[SchemaType] | None, ) -> None: """Test that Schema accepts SchemaType, List[SchemaType] and None for type field.""" schema = Schema(type=type_value) diff --git a/tests/test_openapi_separate_input_output_schemas.py b/tests/test_openapi_separate_input_output_schemas.py index 0efeece017..50255ed09a 100644 --- a/tests/test_openapi_separate_input_output_schemas.py +++ b/tests/test_openapi_separate_input_output_schemas.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -8,15 +6,15 @@ from pydantic import BaseModel, computed_field class SubItem(BaseModel): subname: str - sub_description: Optional[str] = None + sub_description: str | None = None tags: list[str] = [] model_config = {"json_schema_serialization_defaults_required": True} class Item(BaseModel): name: str - description: Optional[str] = None - sub: Optional[SubItem] = None + description: str | None = None + sub: SubItem | None = None model_config = {"json_schema_serialization_defaults_required": True} diff --git a/tests/test_optional_file_list.py b/tests/test_optional_file_list.py index 6860258643..a57e6358fd 100644 --- a/tests/test_optional_file_list.py +++ b/tests/test_optional_file_list.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI, File from fastapi.testclient import TestClient @@ -7,7 +5,7 @@ app = FastAPI() @app.post("/files") -async def upload_files(files: Optional[list[bytes]] = File(None)): +async def upload_files(files: list[bytes] | None = File(None)): if files is None: return {"files_count": 0} return {"files_count": len(files), "sizes": [len(f) for f in files]} diff --git a/tests/test_param_class.py b/tests/test_param_class.py index 1fd40dcd21..e6642daeac 100644 --- a/tests/test_param_class.py +++ b/tests/test_param_class.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI from fastapi.params import Param from fastapi.testclient import TestClient @@ -8,7 +6,7 @@ app = FastAPI() @app.get("/items/") -def read_items(q: Optional[str] = Param(default=None)): # type: ignore +def read_items(q: str | None = Param(default=None)): # type: ignore return {"q": q} diff --git a/tests/test_param_include_in_schema.py b/tests/test_param_include_in_schema.py index 463fb51b10..727552b466 100644 --- a/tests/test_param_include_in_schema.py +++ b/tests/test_param_include_in_schema.py @@ -1,5 +1,3 @@ -from typing import Optional - import pytest from fastapi import Cookie, FastAPI, Header, Path, Query from fastapi.testclient import TestClient @@ -10,14 +8,14 @@ app = FastAPI() @app.get("/hidden_cookie") async def hidden_cookie( - hidden_cookie: Optional[str] = Cookie(default=None, include_in_schema=False), + hidden_cookie: str | None = Cookie(default=None, include_in_schema=False), ): return {"hidden_cookie": hidden_cookie} @app.get("/hidden_header") async def hidden_header( - hidden_header: Optional[str] = Header(default=None, include_in_schema=False), + hidden_header: str | None = Header(default=None, include_in_schema=False), ): return {"hidden_header": hidden_header} @@ -29,7 +27,7 @@ async def hidden_path(hidden_path: str = Path(include_in_schema=False)): @app.get("/hidden_query") async def hidden_query( - hidden_query: Optional[str] = Query(default=None, include_in_schema=False), + hidden_query: str | None = Query(default=None, include_in_schema=False), ): return {"hidden_query": hidden_query} diff --git a/tests/test_pydantic_v1_error.py b/tests/test_pydantic_v1_error.py index 13229a3137..044fdf0d65 100644 --- a/tests/test_pydantic_v1_error.py +++ b/tests/test_pydantic_v1_error.py @@ -1,6 +1,5 @@ import sys import warnings -from typing import Union import pytest @@ -80,7 +79,7 @@ def test_raises_pydantic_v1_model_in_union() -> None: with pytest.raises(PydanticV1NotSupportedError): @app.post("/union") - def endpoint(data: Union[dict, ModelV1A]): # pragma: no cover + def endpoint(data: dict | ModelV1A): # pragma: no cover return data diff --git a/tests/test_pydanticv2_dataclasses_uuid_stringified_annotations.py b/tests/test_pydanticv2_dataclasses_uuid_stringified_annotations.py index b72b0518a1..4f7b0b2a0a 100644 --- a/tests/test_pydanticv2_dataclasses_uuid_stringified_annotations.py +++ b/tests/test_pydanticv2_dataclasses_uuid_stringified_annotations.py @@ -2,7 +2,6 @@ from __future__ import annotations import uuid from dataclasses import dataclass, field -from typing import Union from dirty_equals import IsUUID from fastapi import FastAPI @@ -16,8 +15,8 @@ class Item: name: str price: float tags: list[str] = field(default_factory=list) - description: Union[str, None] = None - tax: Union[float, None] = None + description: str | None = None + tax: float | None = None app = FastAPI() diff --git a/tests/test_request_params/test_body/test_list.py b/tests/test_request_params/test_body/test_list.py index 970e6a6607..aa9745f84f 100644 --- a/tests/test_request_params/test_body/test_list.py +++ b/tests/test_request_params/test_body/test_list.py @@ -1,4 +1,4 @@ -from typing import Annotated, Union +from typing import Annotated import pytest from dirty_equals import IsOneOf, IsPartialDict @@ -55,7 +55,7 @@ def test_required_list_str_schema(path: str): "path", ["/required-list-str", "/model-required-list-str"], ) -def test_required_list_str_missing(path: str, json: Union[dict, None]): +def test_required_list_str_missing(path: str, json: dict | None): client = TestClient(app) response = client.post(path, json=json) assert response.status_code == 422 @@ -132,7 +132,7 @@ def test_required_list_str_alias_schema(path: str): "path", ["/required-list-alias", "/model-required-list-alias"], ) -def test_required_list_alias_missing(path: str, json: Union[dict, None]): +def test_required_list_alias_missing(path: str, json: dict | None): client = TestClient(app) response = client.post(path, json=json) assert response.status_code == 422 @@ -236,7 +236,7 @@ def test_required_list_validation_alias_schema(path: str): "/model-required-list-validation-alias", ], ) -def test_required_list_validation_alias_missing(path: str, json: Union[dict, None]): +def test_required_list_validation_alias_missing(path: str, json: dict | None): client = TestClient(app) response = client.post(path, json=json) assert response.status_code == 422 diff --git a/tests/test_request_params/test_body/test_optional_list.py b/tests/test_request_params/test_body/test_optional_list.py index ba8ba9092e..2c5c5d61b6 100644 --- a/tests/test_request_params/test_body/test_optional_list.py +++ b/tests/test_request_params/test_body/test_optional_list.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import Body, FastAPI @@ -15,13 +15,13 @@ app = FastAPI() @app.post("/optional-list-str", operation_id="optional_list_str") async def read_optional_list_str( - p: Annotated[Optional[list[str]], Body(embed=True)] = None, + p: Annotated[list[str] | None, Body(embed=True)] = None, ): return {"p": p} class BodyModelOptionalListStr(BaseModel): - p: Optional[list[str]] = None + p: list[str] | None = None @app.post("/model-optional-list-str", operation_id="model_optional_list_str") @@ -103,13 +103,13 @@ def test_optional_list_str(path: str): @app.post("/optional-list-alias", operation_id="optional_list_alias") async def read_optional_list_alias( - p: Annotated[Optional[list[str]], Body(embed=True, alias="p_alias")] = None, + p: Annotated[list[str] | None, Body(embed=True, alias="p_alias")] = None, ): return {"p": p} class BodyModelOptionalListAlias(BaseModel): - p: Optional[list[str]] = Field(None, alias="p_alias") + p: list[str] | None = Field(None, alias="p_alias") @app.post("/model-optional-list-alias", operation_id="model_optional_list_alias") @@ -208,14 +208,14 @@ def test_optional_list_alias_by_alias(path: str): ) def read_optional_list_validation_alias( p: Annotated[ - Optional[list[str]], Body(embed=True, validation_alias="p_val_alias") + list[str] | None, Body(embed=True, validation_alias="p_val_alias") ] = None, ): return {"p": p} class BodyModelOptionalListValidationAlias(BaseModel): - p: Optional[list[str]] = Field(None, validation_alias="p_val_alias") + p: list[str] | None = Field(None, validation_alias="p_val_alias") @app.post( @@ -323,7 +323,7 @@ def test_optional_list_validation_alias_by_validation_alias(path: str): ) def read_optional_list_alias_and_validation_alias( p: Annotated[ - Optional[list[str]], + list[str] | None, Body(embed=True, alias="p_alias", validation_alias="p_val_alias"), ] = None, ): @@ -331,9 +331,7 @@ def read_optional_list_alias_and_validation_alias( class BodyModelOptionalListAliasAndValidationAlias(BaseModel): - p: Optional[list[str]] = Field( - None, alias="p_alias", validation_alias="p_val_alias" - ) + p: list[str] | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.post( diff --git a/tests/test_request_params/test_body/test_optional_str.py b/tests/test_request_params/test_body/test_optional_str.py index b9c18034da..184fc94cb2 100644 --- a/tests/test_request_params/test_body/test_optional_str.py +++ b/tests/test_request_params/test_body/test_optional_str.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import Body, FastAPI @@ -14,12 +14,12 @@ app = FastAPI() @app.post("/optional-str", operation_id="optional_str") -async def read_optional_str(p: Annotated[Optional[str], Body(embed=True)] = None): +async def read_optional_str(p: Annotated[str | None, Body(embed=True)] = None): return {"p": p} class BodyModelOptionalStr(BaseModel): - p: Optional[str] = None + p: str | None = None @app.post("/model-optional-str", operation_id="model_optional_str") @@ -98,13 +98,13 @@ def test_optional_str(path: str): @app.post("/optional-alias", operation_id="optional_alias") async def read_optional_alias( - p: Annotated[Optional[str], Body(embed=True, alias="p_alias")] = None, + p: Annotated[str | None, Body(embed=True, alias="p_alias")] = None, ): return {"p": p} class BodyModelOptionalAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias") + p: str | None = Field(None, alias="p_alias") @app.post("/model-optional-alias", operation_id="model_optional_alias") @@ -197,15 +197,13 @@ def test_optional_alias_by_alias(path: str): @app.post("/optional-validation-alias", operation_id="optional_validation_alias") def read_optional_validation_alias( - p: Annotated[ - Optional[str], Body(embed=True, validation_alias="p_val_alias") - ] = None, + p: Annotated[str | None, Body(embed=True, validation_alias="p_val_alias")] = None, ): return {"p": p} class BodyModelOptionalValidationAlias(BaseModel): - p: Optional[str] = Field(None, validation_alias="p_val_alias") + p: str | None = Field(None, validation_alias="p_val_alias") @app.post( @@ -309,14 +307,14 @@ def test_optional_validation_alias_by_validation_alias(path: str): ) def read_optional_alias_and_validation_alias( p: Annotated[ - Optional[str], Body(embed=True, alias="p_alias", validation_alias="p_val_alias") + str | None, Body(embed=True, alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"p": p} class BodyModelOptionalAliasAndValidationAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias", validation_alias="p_val_alias") + p: str | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.post( diff --git a/tests/test_request_params/test_body/test_required_str.py b/tests/test_request_params/test_body/test_required_str.py index 5b434fa1db..2e02f8d203 100644 --- a/tests/test_request_params/test_body/test_required_str.py +++ b/tests/test_request_params/test_body/test_required_str.py @@ -1,4 +1,4 @@ -from typing import Annotated, Any, Union +from typing import Annotated, Any import pytest from dirty_equals import IsOneOf @@ -51,7 +51,7 @@ def test_required_str_schema(path: str): "path", ["/required-str", "/model-required-str"], ) -def test_required_str_missing(path: str, json: Union[dict[str, Any], None]): +def test_required_str_missing(path: str, json: dict[str, Any] | None): client = TestClient(app) response = client.post(path, json=json) assert response.status_code == 422 @@ -124,7 +124,7 @@ def test_required_str_alias_schema(path: str): "path", ["/required-alias", "/model-required-alias"], ) -def test_required_alias_missing(path: str, json: Union[dict[str, Any], None]): +def test_required_alias_missing(path: str, json: dict[str, Any] | None): client = TestClient(app) response = client.post(path, json=json) assert response.status_code == 422 @@ -221,9 +221,7 @@ def test_required_validation_alias_schema(path: str): "/model-required-validation-alias", ], ) -def test_required_validation_alias_missing( - path: str, json: Union[dict[str, Any], None] -): +def test_required_validation_alias_missing(path: str, json: dict[str, Any] | None): client = TestClient(app) response = client.post(path, json=json) assert response.status_code == 422 @@ -338,7 +336,7 @@ def test_required_alias_and_validation_alias_schema(path: str): ], ) def test_required_alias_and_validation_alias_missing( - path: str, json: Union[dict[str, Any], None] + path: str, json: dict[str, Any] | None ): client = TestClient(app) response = client.post(path, json=json) diff --git a/tests/test_request_params/test_cookie/test_optional_str.py b/tests/test_request_params/test_cookie/test_optional_str.py index 1b2a18b072..227d2bccc2 100644 --- a/tests/test_request_params/test_cookie/test_optional_str.py +++ b/tests/test_request_params/test_cookie/test_optional_str.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import Cookie, FastAPI @@ -13,12 +13,12 @@ app = FastAPI() @app.get("/optional-str") -async def read_optional_str(p: Annotated[Optional[str], Cookie()] = None): +async def read_optional_str(p: Annotated[str | None, Cookie()] = None): return {"p": p} class CookieModelOptionalStr(BaseModel): - p: Optional[str] = None + p: str | None = None @app.get("/model-optional-str") @@ -75,13 +75,13 @@ def test_optional_str(path: str): @app.get("/optional-alias") async def read_optional_alias( - p: Annotated[Optional[str], Cookie(alias="p_alias")] = None, + p: Annotated[str | None, Cookie(alias="p_alias")] = None, ): return {"p": p} class CookieModelOptionalAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias") + p: str | None = Field(None, alias="p_alias") @app.get("/model-optional-alias") @@ -153,13 +153,13 @@ def test_optional_alias_by_alias(path: str): @app.get("/optional-validation-alias") def read_optional_validation_alias( - p: Annotated[Optional[str], Cookie(validation_alias="p_val_alias")] = None, + p: Annotated[str | None, Cookie(validation_alias="p_val_alias")] = None, ): return {"p": p} class CookieModelOptionalValidationAlias(BaseModel): - p: Optional[str] = Field(None, validation_alias="p_val_alias") + p: str | None = Field(None, validation_alias="p_val_alias") @app.get("/model-optional-validation-alias") @@ -237,14 +237,14 @@ def test_optional_validation_alias_by_validation_alias(path: str): @app.get("/optional-alias-and-validation-alias") def read_optional_alias_and_validation_alias( p: Annotated[ - Optional[str], Cookie(alias="p_alias", validation_alias="p_val_alias") + str | None, Cookie(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"p": p} class CookieModelOptionalAliasAndValidationAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias", validation_alias="p_val_alias") + p: str | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.get("/model-optional-alias-and-validation-alias") diff --git a/tests/test_request_params/test_file/test_optional.py b/tests/test_request_params/test_file/test_optional.py index 45ef7bdec4..b4dc11a06a 100644 --- a/tests/test_request_params/test_file/test_optional.py +++ b/tests/test_request_params/test_file/test_optional.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import FastAPI, File, UploadFile @@ -13,12 +13,12 @@ app = FastAPI() @app.post("/optional-bytes", operation_id="optional_bytes") -async def read_optional_bytes(p: Annotated[Optional[bytes], File()] = None): +async def read_optional_bytes(p: Annotated[bytes | None, File()] = None): return {"file_size": len(p) if p else None} @app.post("/optional-uploadfile", operation_id="optional_uploadfile") -async def read_optional_uploadfile(p: Annotated[Optional[UploadFile], File()] = None): +async def read_optional_uploadfile(p: Annotated[UploadFile | None, File()] = None): return {"file_size": p.size if p else None} @@ -82,14 +82,14 @@ def test_optional(path: str): @app.post("/optional-bytes-alias", operation_id="optional_bytes_alias") async def read_optional_bytes_alias( - p: Annotated[Optional[bytes], File(alias="p_alias")] = None, + p: Annotated[bytes | None, File(alias="p_alias")] = None, ): return {"file_size": len(p) if p else None} @app.post("/optional-uploadfile-alias", operation_id="optional_uploadfile_alias") async def read_optional_uploadfile_alias( - p: Annotated[Optional[UploadFile], File(alias="p_alias")] = None, + p: Annotated[UploadFile | None, File(alias="p_alias")] = None, ): return {"file_size": p.size if p else None} @@ -170,7 +170,7 @@ def test_optional_alias_by_alias(path: str): "/optional-bytes-validation-alias", operation_id="optional_bytes_validation_alias" ) def read_optional_bytes_validation_alias( - p: Annotated[Optional[bytes], File(validation_alias="p_val_alias")] = None, + p: Annotated[bytes | None, File(validation_alias="p_val_alias")] = None, ): return {"file_size": len(p) if p else None} @@ -180,7 +180,7 @@ def read_optional_bytes_validation_alias( operation_id="optional_uploadfile_validation_alias", ) def read_optional_uploadfile_validation_alias( - p: Annotated[Optional[UploadFile], File(validation_alias="p_val_alias")] = None, + p: Annotated[UploadFile | None, File(validation_alias="p_val_alias")] = None, ): return {"file_size": p.size if p else None} @@ -263,7 +263,7 @@ def test_optional_validation_alias_by_validation_alias(path: str): ) def read_optional_bytes_alias_and_validation_alias( p: Annotated[ - Optional[bytes], File(alias="p_alias", validation_alias="p_val_alias") + bytes | None, File(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"file_size": len(p) if p else None} @@ -275,7 +275,7 @@ def read_optional_bytes_alias_and_validation_alias( ) def read_optional_uploadfile_alias_and_validation_alias( p: Annotated[ - Optional[UploadFile], File(alias="p_alias", validation_alias="p_val_alias") + UploadFile | None, File(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"file_size": p.size if p else None} diff --git a/tests/test_request_params/test_file/test_optional_list.py b/tests/test_request_params/test_file/test_optional_list.py index 162fbe08ae..a506ec991f 100644 --- a/tests/test_request_params/test_file/test_optional_list.py +++ b/tests/test_request_params/test_file/test_optional_list.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import FastAPI, File, UploadFile @@ -13,13 +13,13 @@ app = FastAPI() @app.post("/optional-list-bytes") -async def read_optional_list_bytes(p: Annotated[Optional[list[bytes]], File()] = None): +async def read_optional_list_bytes(p: Annotated[list[bytes] | None, File()] = None): return {"file_size": [len(file) for file in p] if p else None} @app.post("/optional-list-uploadfile") async def read_optional_list_uploadfile( - p: Annotated[Optional[list[UploadFile]], File()] = None, + p: Annotated[list[UploadFile] | None, File()] = None, ): return {"file_size": [file.size for file in p] if p else None} @@ -87,14 +87,14 @@ def test_optional_list(path: str): @app.post("/optional-list-bytes-alias") async def read_optional_list_bytes_alias( - p: Annotated[Optional[list[bytes]], File(alias="p_alias")] = None, + p: Annotated[list[bytes] | None, File(alias="p_alias")] = None, ): return {"file_size": [len(file) for file in p] if p else None} @app.post("/optional-list-uploadfile-alias") async def read_optional_list_uploadfile_alias( - p: Annotated[Optional[list[UploadFile]], File(alias="p_alias")] = None, + p: Annotated[list[UploadFile] | None, File(alias="p_alias")] = None, ): return {"file_size": [file.size for file in p] if p else None} @@ -176,16 +176,14 @@ def test_optional_list_alias_by_alias(path: str): @app.post("/optional-list-bytes-validation-alias") def read_optional_list_bytes_validation_alias( - p: Annotated[Optional[list[bytes]], File(validation_alias="p_val_alias")] = None, + p: Annotated[list[bytes] | None, File(validation_alias="p_val_alias")] = None, ): return {"file_size": [len(file) for file in p] if p else None} @app.post("/optional-list-uploadfile-validation-alias") def read_optional_list_uploadfile_validation_alias( - p: Annotated[ - Optional[list[UploadFile]], File(validation_alias="p_val_alias") - ] = None, + p: Annotated[list[UploadFile] | None, File(validation_alias="p_val_alias")] = None, ): return {"file_size": [file.size for file in p] if p else None} @@ -270,7 +268,7 @@ def test_optional_validation_alias_by_validation_alias(path: str): @app.post("/optional-list-bytes-alias-and-validation-alias") def read_optional_list_bytes_alias_and_validation_alias( p: Annotated[ - Optional[list[bytes]], File(alias="p_alias", validation_alias="p_val_alias") + list[bytes] | None, File(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"file_size": [len(file) for file in p] if p else None} @@ -279,7 +277,7 @@ def read_optional_list_bytes_alias_and_validation_alias( @app.post("/optional-list-uploadfile-alias-and-validation-alias") def read_optional_list_uploadfile_alias_and_validation_alias( p: Annotated[ - Optional[list[UploadFile]], + list[UploadFile] | None, File(alias="p_alias", validation_alias="p_val_alias"), ] = None, ): diff --git a/tests/test_request_params/test_form/test_optional_list.py b/tests/test_request_params/test_form/test_optional_list.py index 6d1957a18c..7ecf9c9bfc 100644 --- a/tests/test_request_params/test_form/test_optional_list.py +++ b/tests/test_request_params/test_form/test_optional_list.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import FastAPI, Form @@ -15,13 +15,13 @@ app = FastAPI() @app.post("/optional-list-str", operation_id="optional_list_str") async def read_optional_list_str( - p: Annotated[Optional[list[str]], Form()] = None, + p: Annotated[list[str] | None, Form()] = None, ): return {"p": p} class FormModelOptionalListStr(BaseModel): - p: Optional[list[str]] = None + p: list[str] | None = None @app.post("/model-optional-list-str", operation_id="model_optional_list_str") @@ -80,13 +80,13 @@ def test_optional_list_str(path: str): @app.post("/optional-list-alias", operation_id="optional_list_alias") async def read_optional_list_alias( - p: Annotated[Optional[list[str]], Form(alias="p_alias")] = None, + p: Annotated[list[str] | None, Form(alias="p_alias")] = None, ): return {"p": p} class FormModelOptionalListAlias(BaseModel): - p: Optional[list[str]] = Field(None, alias="p_alias") + p: list[str] | None = Field(None, alias="p_alias") @app.post("/model-optional-list-alias", operation_id="model_optional_list_alias") @@ -163,13 +163,13 @@ def test_optional_list_alias_by_alias(path: str): "/optional-list-validation-alias", operation_id="optional_list_validation_alias" ) def read_optional_list_validation_alias( - p: Annotated[Optional[list[str]], Form(validation_alias="p_val_alias")] = None, + p: Annotated[list[str] | None, Form(validation_alias="p_val_alias")] = None, ): return {"p": p} class FormModelOptionalListValidationAlias(BaseModel): - p: Optional[list[str]] = Field(None, validation_alias="p_val_alias") + p: list[str] | None = Field(None, validation_alias="p_val_alias") @app.post( @@ -251,16 +251,14 @@ def test_optional_list_validation_alias_by_validation_alias(path: str): ) def read_optional_list_alias_and_validation_alias( p: Annotated[ - Optional[list[str]], Form(alias="p_alias", validation_alias="p_val_alias") + list[str] | None, Form(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"p": p} class FormModelOptionalListAliasAndValidationAlias(BaseModel): - p: Optional[list[str]] = Field( - None, alias="p_alias", validation_alias="p_val_alias" - ) + p: list[str] | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.post( diff --git a/tests/test_request_params/test_form/test_optional_str.py b/tests/test_request_params/test_form/test_optional_str.py index 810e83caa3..4ef16756ef 100644 --- a/tests/test_request_params/test_form/test_optional_str.py +++ b/tests/test_request_params/test_form/test_optional_str.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import FastAPI, Form @@ -14,12 +14,12 @@ app = FastAPI() @app.post("/optional-str", operation_id="optional_str") -async def read_optional_str(p: Annotated[Optional[str], Form()] = None): +async def read_optional_str(p: Annotated[str | None, Form()] = None): return {"p": p} class FormModelOptionalStr(BaseModel): - p: Optional[str] = None + p: str | None = None @app.post("/model-optional-str", operation_id="model_optional_str") @@ -75,13 +75,13 @@ def test_optional_str(path: str): @app.post("/optional-alias", operation_id="optional_alias") async def read_optional_alias( - p: Annotated[Optional[str], Form(alias="p_alias")] = None, + p: Annotated[str | None, Form(alias="p_alias")] = None, ): return {"p": p} class FormModelOptionalAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias") + p: str | None = Field(None, alias="p_alias") @app.post("/model-optional-alias", operation_id="model_optional_alias") @@ -151,13 +151,13 @@ def test_optional_alias_by_alias(path: str): @app.post("/optional-validation-alias", operation_id="optional_validation_alias") def read_optional_validation_alias( - p: Annotated[Optional[str], Form(validation_alias="p_val_alias")] = None, + p: Annotated[str | None, Form(validation_alias="p_val_alias")] = None, ): return {"p": p} class FormModelOptionalValidationAlias(BaseModel): - p: Optional[str] = Field(None, validation_alias="p_val_alias") + p: str | None = Field(None, validation_alias="p_val_alias") @app.post( @@ -238,14 +238,14 @@ def test_optional_validation_alias_by_validation_alias(path: str): ) def read_optional_alias_and_validation_alias( p: Annotated[ - Optional[str], Form(alias="p_alias", validation_alias="p_val_alias") + str | None, Form(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"p": p} class FormModelOptionalAliasAndValidationAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias", validation_alias="p_val_alias") + p: str | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.post( diff --git a/tests/test_request_params/test_header/test_optional_list.py b/tests/test_request_params/test_header/test_optional_list.py index 3bbb73d544..9f4eacc235 100644 --- a/tests/test_request_params/test_header/test_optional_list.py +++ b/tests/test_request_params/test_header/test_optional_list.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import FastAPI, Header @@ -14,13 +14,13 @@ app = FastAPI() @app.get("/optional-list-str") async def read_optional_list_str( - p: Annotated[Optional[list[str]], Header()] = None, + p: Annotated[list[str] | None, Header()] = None, ): return {"p": p} class HeaderModelOptionalListStr(BaseModel): - p: Optional[list[str]] = None + p: list[str] | None = None @app.get("/model-optional-list-str") @@ -81,13 +81,13 @@ def test_optional_list_str(path: str): @app.get("/optional-list-alias") async def read_optional_list_alias( - p: Annotated[Optional[list[str]], Header(alias="p_alias")] = None, + p: Annotated[list[str] | None, Header(alias="p_alias")] = None, ): return {"p": p} class HeaderModelOptionalListAlias(BaseModel): - p: Optional[list[str]] = Field(None, alias="p_alias") + p: list[str] | None = Field(None, alias="p_alias") @app.get("/model-optional-list-alias") @@ -162,13 +162,13 @@ def test_optional_list_alias_by_alias(path: str): @app.get("/optional-list-validation-alias") def read_optional_list_validation_alias( - p: Annotated[Optional[list[str]], Header(validation_alias="p_val_alias")] = None, + p: Annotated[list[str] | None, Header(validation_alias="p_val_alias")] = None, ): return {"p": p} class HeaderModelOptionalListValidationAlias(BaseModel): - p: Optional[list[str]] = Field(None, validation_alias="p_val_alias") + p: list[str] | None = Field(None, validation_alias="p_val_alias") @app.get("/model-optional-list-validation-alias") @@ -246,16 +246,14 @@ def test_optional_list_validation_alias_by_validation_alias(path: str): @app.get("/optional-list-alias-and-validation-alias") def read_optional_list_alias_and_validation_alias( p: Annotated[ - Optional[list[str]], Header(alias="p_alias", validation_alias="p_val_alias") + list[str] | None, Header(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"p": p} class HeaderModelOptionalListAliasAndValidationAlias(BaseModel): - p: Optional[list[str]] = Field( - None, alias="p_alias", validation_alias="p_val_alias" - ) + p: list[str] | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.get("/model-optional-list-alias-and-validation-alias") diff --git a/tests/test_request_params/test_header/test_optional_str.py b/tests/test_request_params/test_header/test_optional_str.py index a5174e59af..04773c83f9 100644 --- a/tests/test_request_params/test_header/test_optional_str.py +++ b/tests/test_request_params/test_header/test_optional_str.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import FastAPI, Header @@ -13,12 +13,12 @@ app = FastAPI() @app.get("/optional-str") -async def read_optional_str(p: Annotated[Optional[str], Header()] = None): +async def read_optional_str(p: Annotated[str | None, Header()] = None): return {"p": p} class HeaderModelOptionalStr(BaseModel): - p: Optional[str] = None + p: str | None = None @app.get("/model-optional-str") @@ -74,13 +74,13 @@ def test_optional_str(path: str): @app.get("/optional-alias") async def read_optional_alias( - p: Annotated[Optional[str], Header(alias="p_alias")] = None, + p: Annotated[str | None, Header(alias="p_alias")] = None, ): return {"p": p} class HeaderModelOptionalAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias") + p: str | None = Field(None, alias="p_alias") @app.get("/model-optional-alias") @@ -150,13 +150,13 @@ def test_optional_alias_by_alias(path: str): @app.get("/optional-validation-alias") def read_optional_validation_alias( - p: Annotated[Optional[str], Header(validation_alias="p_val_alias")] = None, + p: Annotated[str | None, Header(validation_alias="p_val_alias")] = None, ): return {"p": p} class HeaderModelOptionalValidationAlias(BaseModel): - p: Optional[str] = Field(None, validation_alias="p_val_alias") + p: str | None = Field(None, validation_alias="p_val_alias") @app.get("/model-optional-validation-alias") @@ -232,14 +232,14 @@ def test_optional_validation_alias_by_validation_alias(path: str): @app.get("/optional-alias-and-validation-alias") def read_optional_alias_and_validation_alias( p: Annotated[ - Optional[str], Header(alias="p_alias", validation_alias="p_val_alias") + str | None, Header(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"p": p} class HeaderModelOptionalAliasAndValidationAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias", validation_alias="p_val_alias") + p: str | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.get("/model-optional-alias-and-validation-alias") diff --git a/tests/test_request_params/test_query/test_optional_list.py b/tests/test_request_params/test_query/test_optional_list.py index 5608c6499b..6b70b75a4f 100644 --- a/tests/test_request_params/test_query/test_optional_list.py +++ b/tests/test_request_params/test_query/test_optional_list.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import FastAPI, Query @@ -14,13 +14,13 @@ app = FastAPI() @app.get("/optional-list-str") async def read_optional_list_str( - p: Annotated[Optional[list[str]], Query()] = None, + p: Annotated[list[str] | None, Query()] = None, ): return {"p": p} class QueryModelOptionalListStr(BaseModel): - p: Optional[list[str]] = None + p: list[str] | None = None @app.get("/model-optional-list-str") @@ -81,13 +81,13 @@ def test_optional_list_str(path: str): @app.get("/optional-list-alias") async def read_optional_list_alias( - p: Annotated[Optional[list[str]], Query(alias="p_alias")] = None, + p: Annotated[list[str] | None, Query(alias="p_alias")] = None, ): return {"p": p} class QueryModelOptionalListAlias(BaseModel): - p: Optional[list[str]] = Field(None, alias="p_alias") + p: list[str] | None = Field(None, alias="p_alias") @app.get("/model-optional-list-alias") @@ -162,13 +162,13 @@ def test_optional_list_alias_by_alias(path: str): @app.get("/optional-list-validation-alias") def read_optional_list_validation_alias( - p: Annotated[Optional[list[str]], Query(validation_alias="p_val_alias")] = None, + p: Annotated[list[str] | None, Query(validation_alias="p_val_alias")] = None, ): return {"p": p} class QueryModelOptionalListValidationAlias(BaseModel): - p: Optional[list[str]] = Field(None, validation_alias="p_val_alias") + p: list[str] | None = Field(None, validation_alias="p_val_alias") @app.get("/model-optional-list-validation-alias") @@ -244,16 +244,14 @@ def test_optional_list_validation_alias_by_validation_alias(path: str): @app.get("/optional-list-alias-and-validation-alias") def read_optional_list_alias_and_validation_alias( p: Annotated[ - Optional[list[str]], Query(alias="p_alias", validation_alias="p_val_alias") + list[str] | None, Query(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"p": p} class QueryModelOptionalListAliasAndValidationAlias(BaseModel): - p: Optional[list[str]] = Field( - None, alias="p_alias", validation_alias="p_val_alias" - ) + p: list[str] | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.get("/model-optional-list-alias-and-validation-alias") diff --git a/tests/test_request_params/test_query/test_optional_str.py b/tests/test_request_params/test_query/test_optional_str.py index b181686b05..f7f35860b6 100644 --- a/tests/test_request_params/test_query/test_optional_str.py +++ b/tests/test_request_params/test_query/test_optional_str.py @@ -1,4 +1,4 @@ -from typing import Annotated, Optional +from typing import Annotated import pytest from fastapi import FastAPI, Query @@ -13,12 +13,12 @@ app = FastAPI() @app.get("/optional-str") -async def read_optional_str(p: Optional[str] = None): +async def read_optional_str(p: str | None = None): return {"p": p} class QueryModelOptionalStr(BaseModel): - p: Optional[str] = None + p: str | None = None @app.get("/model-optional-str") @@ -74,13 +74,13 @@ def test_optional_str(path: str): @app.get("/optional-alias") async def read_optional_alias( - p: Annotated[Optional[str], Query(alias="p_alias")] = None, + p: Annotated[str | None, Query(alias="p_alias")] = None, ): return {"p": p} class QueryModelOptionalAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias") + p: str | None = Field(None, alias="p_alias") @app.get("/model-optional-alias") @@ -150,13 +150,13 @@ def test_optional_alias_by_alias(path: str): @app.get("/optional-validation-alias") def read_optional_validation_alias( - p: Annotated[Optional[str], Query(validation_alias="p_val_alias")] = None, + p: Annotated[str | None, Query(validation_alias="p_val_alias")] = None, ): return {"p": p} class QueryModelOptionalValidationAlias(BaseModel): - p: Optional[str] = Field(None, validation_alias="p_val_alias") + p: str | None = Field(None, validation_alias="p_val_alias") @app.get("/model-optional-validation-alias") @@ -232,14 +232,14 @@ def test_optional_validation_alias_by_validation_alias(path: str): @app.get("/optional-alias-and-validation-alias") def read_optional_alias_and_validation_alias( p: Annotated[ - Optional[str], Query(alias="p_alias", validation_alias="p_val_alias") + str | None, Query(alias="p_alias", validation_alias="p_val_alias") ] = None, ): return {"p": p} class QueryModelOptionalAliasAndValidationAlias(BaseModel): - p: Optional[str] = Field(None, alias="p_alias", validation_alias="p_val_alias") + p: str | None = Field(None, alias="p_alias", validation_alias="p_val_alias") @app.get("/model-optional-alias-and-validation-alias") diff --git a/tests/test_required_noneable.py b/tests/test_required_noneable.py index 5da8cd4d09..c99f20212f 100644 --- a/tests/test_required_noneable.py +++ b/tests/test_required_noneable.py @@ -1,5 +1,3 @@ -from typing import Union - from fastapi import Body, FastAPI, Query from fastapi.testclient import TestClient @@ -7,17 +5,17 @@ app = FastAPI() @app.get("/query") -def read_query(q: Union[str, None]): +def read_query(q: str | None): return q @app.get("/explicit-query") -def read_explicit_query(q: Union[str, None] = Query()): +def read_explicit_query(q: str | None = Query()): return q @app.post("/body-embed") -def send_body_embed(b: Union[str, None] = Body(embed=True)): +def send_body_embed(b: str | None = Body(embed=True)): return b diff --git a/tests/test_response_model_as_return_annotation.py b/tests/test_response_model_as_return_annotation.py index ded5971027..7be7902ada 100644 --- a/tests/test_response_model_as_return_annotation.py +++ b/tests/test_response_model_as_return_annotation.py @@ -1,5 +1,3 @@ -from typing import Union - import pytest from fastapi import FastAPI from fastapi.exceptions import FastAPIError, ResponseValidationError @@ -216,7 +214,7 @@ def no_response_model_annotation_forward_ref_list_of_model() -> "list[User]": @app.get( "/response_model_union-no_annotation-return_model1", - response_model=Union[User, Item], + response_model=User | Item, ) def response_model_union_no_annotation_return_model1(): return DBUser(name="John", surname="Doe", password_hash="secret") @@ -224,19 +222,19 @@ def response_model_union_no_annotation_return_model1(): @app.get( "/response_model_union-no_annotation-return_model2", - response_model=Union[User, Item], + response_model=User | Item, ) def response_model_union_no_annotation_return_model2(): return Item(name="Foo", price=42.0) @app.get("/no_response_model-annotation_union-return_model1") -def no_response_model_annotation_union_return_model1() -> Union[User, Item]: +def no_response_model_annotation_union_return_model1() -> User | Item: return DBUser(name="John", surname="Doe", password_hash="secret") @app.get("/no_response_model-annotation_union-return_model2") -def no_response_model_annotation_union_return_model2() -> Union[User, Item]: +def no_response_model_annotation_union_return_model2() -> User | Item: return Item(name="Foo", price=42.0) @@ -503,7 +501,7 @@ def test_invalid_response_model_field(): with pytest.raises(FastAPIError) as e: @app.get("/") - def read_root() -> Union[Response, None]: + def read_root() -> Response | None: return Response(content="Foo") # pragma: no cover assert "valid Pydantic field type" in e.value.args[0] diff --git a/tests/test_router_events.py b/tests/test_router_events.py index a47d119139..7869a7afcd 100644 --- a/tests/test_router_events.py +++ b/tests/test_router_events.py @@ -1,6 +1,5 @@ from collections.abc import AsyncGenerator from contextlib import asynccontextmanager -from typing import Union import pytest from fastapi import APIRouter, FastAPI, Request @@ -176,7 +175,7 @@ def test_router_nested_lifespan_state_overriding_by_parent() -> None: @asynccontextmanager async def lifespan( app: FastAPI, - ) -> AsyncGenerator[dict[str, Union[str, bool]], None]: + ) -> AsyncGenerator[dict[str, str | bool], None]: yield { "app_specific": True, "overridden": "app", @@ -185,7 +184,7 @@ def test_router_nested_lifespan_state_overriding_by_parent() -> None: @asynccontextmanager async def router_lifespan( app: FastAPI, - ) -> AsyncGenerator[dict[str, Union[str, bool]], None]: + ) -> AsyncGenerator[dict[str, str | bool], None]: yield { "router_specific": True, "overridden": "router", # should override parent diff --git a/tests/test_schema_extra_examples.py b/tests/test_schema_extra_examples.py index 9ec41e7e84..32f5cea476 100644 --- a/tests/test_schema_extra_examples.py +++ b/tests/test_schema_extra_examples.py @@ -1,5 +1,3 @@ -from typing import Union - import pytest from fastapi import Body, Cookie, FastAPI, Header, Path, Query from fastapi.exceptions import FastAPIDeprecationWarning @@ -117,7 +115,7 @@ def create_app(): @app.get("/query_example/") def query_example( - data: Union[str, None] = Query( + data: str | None = Query( default=None, example="query1", ), @@ -126,7 +124,7 @@ def create_app(): @app.get("/query_examples/") def query_examples( - data: Union[str, None] = Query( + data: str | None = Query( default=None, examples=["query1", "query2"], ), @@ -137,7 +135,7 @@ def create_app(): @app.get("/query_example_examples/") def query_example_examples( - data: Union[str, None] = Query( + data: str | None = Query( default=None, example="query_overridden", examples=["query1", "query2"], @@ -149,7 +147,7 @@ def create_app(): @app.get("/header_example/") def header_example( - data: Union[str, None] = Header( + data: str | None = Header( default=None, example="header1", ), @@ -158,7 +156,7 @@ def create_app(): @app.get("/header_examples/") def header_examples( - data: Union[str, None] = Header( + data: str | None = Header( default=None, examples=[ "header1", @@ -172,7 +170,7 @@ def create_app(): @app.get("/header_example_examples/") def header_example_examples( - data: Union[str, None] = Header( + data: str | None = Header( default=None, example="header_overridden", examples=["header1", "header2"], @@ -184,7 +182,7 @@ def create_app(): @app.get("/cookie_example/") def cookie_example( - data: Union[str, None] = Cookie( + data: str | None = Cookie( default=None, example="cookie1", ), @@ -193,7 +191,7 @@ def create_app(): @app.get("/cookie_examples/") def cookie_examples( - data: Union[str, None] = Cookie( + data: str | None = Cookie( default=None, examples=["cookie1", "cookie2"], ), @@ -204,7 +202,7 @@ def create_app(): @app.get("/cookie_example_examples/") def cookie_example_examples( - data: Union[str, None] = Cookie( + data: str | None = Cookie( default=None, example="cookie_overridden", examples=["cookie1", "cookie2"], diff --git a/tests/test_security_api_key_cookie_optional.py b/tests/test_security_api_key_cookie_optional.py index 7988d80443..e911654fac 100644 --- a/tests/test_security_api_key_cookie_optional.py +++ b/tests/test_security_api_key_cookie_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import Depends, FastAPI, Security from fastapi.security import APIKeyCookie from fastapi.testclient import TestClient @@ -15,7 +13,7 @@ class User(BaseModel): username: str -def get_current_user(oauth_header: Optional[str] = Security(api_key)): +def get_current_user(oauth_header: str | None = Security(api_key)): if oauth_header is None: return None user = User(username=oauth_header) diff --git a/tests/test_security_api_key_header_optional.py b/tests/test_security_api_key_header_optional.py index 51abd0bb96..0a8cf420ed 100644 --- a/tests/test_security_api_key_header_optional.py +++ b/tests/test_security_api_key_header_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import Depends, FastAPI, Security from fastapi.security import APIKeyHeader from fastapi.testclient import TestClient @@ -15,7 +13,7 @@ class User(BaseModel): username: str -def get_current_user(oauth_header: Optional[str] = Security(api_key)): +def get_current_user(oauth_header: str | None = Security(api_key)): if oauth_header is None: return None user = User(username=oauth_header) @@ -23,7 +21,7 @@ def get_current_user(oauth_header: Optional[str] = Security(api_key)): @app.get("/users/me") -def read_current_user(current_user: Optional[User] = Depends(get_current_user)): +def read_current_user(current_user: User | None = Depends(get_current_user)): if current_user is None: return {"msg": "Create an account first"} return current_user diff --git a/tests/test_security_api_key_query_optional.py b/tests/test_security_api_key_query_optional.py index 26fbb9ee4f..e9fba30435 100644 --- a/tests/test_security_api_key_query_optional.py +++ b/tests/test_security_api_key_query_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import Depends, FastAPI, Security from fastapi.security import APIKeyQuery from fastapi.testclient import TestClient @@ -15,7 +13,7 @@ class User(BaseModel): username: str -def get_current_user(oauth_header: Optional[str] = Security(api_key)): +def get_current_user(oauth_header: str | None = Security(api_key)): if oauth_header is None: return None user = User(username=oauth_header) @@ -23,7 +21,7 @@ def get_current_user(oauth_header: Optional[str] = Security(api_key)): @app.get("/users/me") -def read_current_user(current_user: Optional[User] = Depends(get_current_user)): +def read_current_user(current_user: User | None = Depends(get_current_user)): if current_user is None: return {"msg": "Create an account first"} return current_user diff --git a/tests/test_security_http_base_optional.py b/tests/test_security_http_base_optional.py index 612a7909fe..1d1944ab0a 100644 --- a/tests/test_security_http_base_optional.py +++ b/tests/test_security_http_base_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI, Security from fastapi.security.http import HTTPAuthorizationCredentials, HTTPBase from fastapi.testclient import TestClient @@ -12,7 +10,7 @@ security = HTTPBase(scheme="Other", auto_error=False) @app.get("/users/me") def read_current_user( - credentials: Optional[HTTPAuthorizationCredentials] = Security(security), + credentials: HTTPAuthorizationCredentials | None = Security(security), ): if credentials is None: return {"msg": "Create an account first"} diff --git a/tests/test_security_http_basic_optional.py b/tests/test_security_http_basic_optional.py index e94565c7bb..78abf2b680 100644 --- a/tests/test_security_http_basic_optional.py +++ b/tests/test_security_http_basic_optional.py @@ -1,5 +1,4 @@ from base64 import b64encode -from typing import Optional from fastapi import FastAPI, Security from fastapi.security import HTTPBasic, HTTPBasicCredentials @@ -12,7 +11,7 @@ security = HTTPBasic(auto_error=False) @app.get("/users/me") -def read_current_user(credentials: Optional[HTTPBasicCredentials] = Security(security)): +def read_current_user(credentials: HTTPBasicCredentials | None = Security(security)): if credentials is None: return {"msg": "Create an account first"} return {"username": credentials.username, "password": credentials.password} diff --git a/tests/test_security_http_bearer_optional.py b/tests/test_security_http_bearer_optional.py index b49a6593ec..06d9d03db4 100644 --- a/tests/test_security_http_bearer_optional.py +++ b/tests/test_security_http_bearer_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI, Security from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer from fastapi.testclient import TestClient @@ -12,7 +10,7 @@ security = HTTPBearer(auto_error=False) @app.get("/users/me") def read_current_user( - credentials: Optional[HTTPAuthorizationCredentials] = Security(security), + credentials: HTTPAuthorizationCredentials | None = Security(security), ): if credentials is None: return {"msg": "Create an account first"} diff --git a/tests/test_security_http_digest_optional.py b/tests/test_security_http_digest_optional.py index 97e62634d8..d1056b1918 100644 --- a/tests/test_security_http_digest_optional.py +++ b/tests/test_security_http_digest_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI, Security from fastapi.security import HTTPAuthorizationCredentials, HTTPDigest from fastapi.testclient import TestClient @@ -12,7 +10,7 @@ security = HTTPDigest(auto_error=False) @app.get("/users/me") def read_current_user( - credentials: Optional[HTTPAuthorizationCredentials] = Security(security), + credentials: HTTPAuthorizationCredentials | None = Security(security), ): if credentials is None: return {"msg": "Create an account first"} diff --git a/tests/test_security_oauth2_authorization_code_bearer.py b/tests/test_security_oauth2_authorization_code_bearer.py index 1ba577e9ff..587486c76b 100644 --- a/tests/test_security_oauth2_authorization_code_bearer.py +++ b/tests/test_security_oauth2_authorization_code_bearer.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI, Security from fastapi.security import OAuth2AuthorizationCodeBearer from fastapi.testclient import TestClient @@ -13,7 +11,7 @@ oauth2_scheme = OAuth2AuthorizationCodeBearer( @app.get("/items/") -async def read_items(token: Optional[str] = Security(oauth2_scheme)): +async def read_items(token: str | None = Security(oauth2_scheme)): return {"token": token} diff --git a/tests/test_security_oauth2_authorization_code_bearer_description.py b/tests/test_security_oauth2_authorization_code_bearer_description.py index 73807c31a3..f878ede643 100644 --- a/tests/test_security_oauth2_authorization_code_bearer_description.py +++ b/tests/test_security_oauth2_authorization_code_bearer_description.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI, Security from fastapi.security import OAuth2AuthorizationCodeBearer from fastapi.testclient import TestClient @@ -16,7 +14,7 @@ oauth2_scheme = OAuth2AuthorizationCodeBearer( @app.get("/items/") -async def read_items(token: Optional[str] = Security(oauth2_scheme)): +async def read_items(token: str | None = Security(oauth2_scheme)): return {"token": token} diff --git a/tests/test_security_oauth2_authorization_code_bearer_scopes_openapi.py b/tests/test_security_oauth2_authorization_code_bearer_scopes_openapi.py index 583007c8b7..6fcce6fed7 100644 --- a/tests/test_security_oauth2_authorization_code_bearer_scopes_openapi.py +++ b/tests/test_security_oauth2_authorization_code_bearer_scopes_openapi.py @@ -1,6 +1,6 @@ # Ref: https://github.com/fastapi/fastapi/issues/14454 -from typing import Annotated, Optional +from typing import Annotated from fastapi import APIRouter, Depends, FastAPI, Security from fastapi.security import OAuth2AuthorizationCodeBearer @@ -46,13 +46,13 @@ router = APIRouter(dependencies=[Security(oauth2_scheme, scopes=["read"])]) @router.get("/items/") -async def read_items(token: Optional[str] = Depends(oauth2_scheme)): +async def read_items(token: str | None = Depends(oauth2_scheme)): return {"token": token} @router.post("/items/") async def create_item( - token: Optional[str] = Security(oauth2_scheme, scopes=["read", "write"]), + token: str | None = Security(oauth2_scheme, scopes=["read", "write"]), ): return {"token": token} diff --git a/tests/test_security_oauth2_optional.py b/tests/test_security_oauth2_optional.py index cb79afdb86..a7eaf59443 100644 --- a/tests/test_security_oauth2_optional.py +++ b/tests/test_security_oauth2_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - import pytest from fastapi import Depends, FastAPI, Security from fastapi.security import OAuth2, OAuth2PasswordRequestFormStrict @@ -24,7 +22,7 @@ class User(BaseModel): username: str -def get_current_user(oauth_header: Optional[str] = Security(reusable_oauth2)): +def get_current_user(oauth_header: str | None = Security(reusable_oauth2)): if oauth_header is None: return None user = User(username=oauth_header) @@ -37,7 +35,7 @@ def login(form_data: OAuth2PasswordRequestFormStrict = Depends()): @app.get("/users/me") -def read_users_me(current_user: Optional[User] = Depends(get_current_user)): +def read_users_me(current_user: User | None = Depends(get_current_user)): if current_user is None: return {"msg": "Create an account first"} return current_user diff --git a/tests/test_security_oauth2_optional_description.py b/tests/test_security_oauth2_optional_description.py index b3fae37a17..0918d352ea 100644 --- a/tests/test_security_oauth2_optional_description.py +++ b/tests/test_security_oauth2_optional_description.py @@ -1,5 +1,3 @@ -from typing import Optional - import pytest from fastapi import Depends, FastAPI, Security from fastapi.security import OAuth2, OAuth2PasswordRequestFormStrict @@ -25,7 +23,7 @@ class User(BaseModel): username: str -def get_current_user(oauth_header: Optional[str] = Security(reusable_oauth2)): +def get_current_user(oauth_header: str | None = Security(reusable_oauth2)): if oauth_header is None: return None user = User(username=oauth_header) @@ -38,7 +36,7 @@ def login(form_data: OAuth2PasswordRequestFormStrict = Depends()): @app.get("/users/me") -def read_users_me(current_user: Optional[User] = Depends(get_current_user)): +def read_users_me(current_user: User | None = Depends(get_current_user)): if current_user is None: return {"msg": "Create an account first"} return current_user diff --git a/tests/test_security_oauth2_password_bearer_optional.py b/tests/test_security_oauth2_password_bearer_optional.py index 01e2f65ed9..263359c950 100644 --- a/tests/test_security_oauth2_password_bearer_optional.py +++ b/tests/test_security_oauth2_password_bearer_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI, Security from fastapi.security import OAuth2PasswordBearer from fastapi.testclient import TestClient @@ -11,7 +9,7 @@ oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/token", auto_error=False) @app.get("/items/") -async def read_items(token: Optional[str] = Security(oauth2_scheme)): +async def read_items(token: str | None = Security(oauth2_scheme)): if token is None: return {"msg": "Create an account first"} return {"token": token} diff --git a/tests/test_security_oauth2_password_bearer_optional_description.py b/tests/test_security_oauth2_password_bearer_optional_description.py index fec8d03a7a..0deb7e48ff 100644 --- a/tests/test_security_oauth2_password_bearer_optional_description.py +++ b/tests/test_security_oauth2_password_bearer_optional_description.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI, Security from fastapi.security import OAuth2PasswordBearer from fastapi.testclient import TestClient @@ -15,7 +13,7 @@ oauth2_scheme = OAuth2PasswordBearer( @app.get("/items/") -async def read_items(token: Optional[str] = Security(oauth2_scheme)): +async def read_items(token: str | None = Security(oauth2_scheme)): if token is None: return {"msg": "Create an account first"} return {"token": token} diff --git a/tests/test_security_openid_connect_optional.py b/tests/test_security_openid_connect_optional.py index ebaf394dc9..44e1a4866e 100644 --- a/tests/test_security_openid_connect_optional.py +++ b/tests/test_security_openid_connect_optional.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import Depends, FastAPI, Security from fastapi.security.open_id_connect_url import OpenIdConnect from fastapi.testclient import TestClient @@ -15,7 +13,7 @@ class User(BaseModel): username: str -def get_current_user(oauth_header: Optional[str] = Security(oid)): +def get_current_user(oauth_header: str | None = Security(oid)): if oauth_header is None: return None user = User(username=oauth_header) @@ -23,7 +21,7 @@ def get_current_user(oauth_header: Optional[str] = Security(oid)): @app.get("/users/me") -def read_current_user(current_user: Optional[User] = Depends(get_current_user)): +def read_current_user(current_user: User | None = Depends(get_current_user)): if current_user is None: return {"msg": "Create an account first"} return current_user diff --git a/tests/test_serialize_response.py b/tests/test_serialize_response.py index 14f88dd931..114c3c6cb2 100644 --- a/tests/test_serialize_response.py +++ b/tests/test_serialize_response.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI from fastapi.testclient import TestClient from pydantic import BaseModel @@ -9,8 +7,8 @@ app = FastAPI() class Item(BaseModel): name: str - price: Optional[float] = None - owner_ids: Optional[list[int]] = None + price: float | None = None + owner_ids: list[int] | None = None @app.get("/items/valid", response_model=Item) diff --git a/tests/test_serialize_response_dataclass.py b/tests/test_serialize_response_dataclass.py index ee695368b8..ae05f14d1a 100644 --- a/tests/test_serialize_response_dataclass.py +++ b/tests/test_serialize_response_dataclass.py @@ -1,6 +1,5 @@ from dataclasses import dataclass from datetime import datetime -from typing import Optional from fastapi import FastAPI from fastapi.testclient import TestClient @@ -12,8 +11,8 @@ app = FastAPI() class Item: name: str date: datetime - price: Optional[float] = None - owner_ids: Optional[list[int]] = None + price: float | None = None + owner_ids: list[int] | None = None @app.get("/items/valid", response_model=Item) diff --git a/tests/test_serialize_response_model.py b/tests/test_serialize_response_model.py index 79c90c9c29..bb05f7bc40 100644 --- a/tests/test_serialize_response_model.py +++ b/tests/test_serialize_response_model.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI from pydantic import BaseModel, Field from starlette.testclient import TestClient @@ -9,8 +7,8 @@ app = FastAPI() class Item(BaseModel): name: str = Field(alias="aliased_name") - price: Optional[float] = None - owner_ids: Optional[list[int]] = None + price: float | None = None + owner_ids: list[int] | None = None @app.get("/items/valid", response_model=Item) diff --git a/tests/test_skip_defaults.py b/tests/test_skip_defaults.py index 02765291cb..238da7392f 100644 --- a/tests/test_skip_defaults.py +++ b/tests/test_skip_defaults.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import FastAPI from fastapi.testclient import TestClient from pydantic import BaseModel @@ -8,23 +6,23 @@ app = FastAPI() class SubModel(BaseModel): - a: Optional[str] = "foo" + a: str | None = "foo" class Model(BaseModel): - x: Optional[int] = None + x: int | None = None sub: SubModel class ModelSubclass(Model): y: int z: int = 0 - w: Optional[int] = None + w: int | None = None class ModelDefaults(BaseModel): - w: Optional[str] = None - x: Optional[str] = None + w: str | None = None + x: str | None = None y: str = "y" z: str = "z" diff --git a/tests/test_sub_callbacks.py b/tests/test_sub_callbacks.py index 86dc4d00e2..b8a9dd2921 100644 --- a/tests/test_sub_callbacks.py +++ b/tests/test_sub_callbacks.py @@ -1,5 +1,3 @@ -from typing import Optional - from fastapi import APIRouter, FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -10,7 +8,7 @@ app = FastAPI() class Invoice(BaseModel): id: str - title: Optional[str] = None + title: str | None = None customer: str total: float @@ -51,7 +49,7 @@ subrouter = APIRouter() @subrouter.post("/invoices/", callbacks=invoices_callback_router.routes) -def create_invoice(invoice: Invoice, callback_url: Optional[HttpUrl] = None): +def create_invoice(invoice: Invoice, callback_url: HttpUrl | None = None): """ Create an invoice. diff --git a/tests/test_tutorial/test_python_types/test_tutorial009c.py b/tests/test_tutorial/test_python_types/test_tutorial009c.py deleted file mode 100644 index 17c4b9e0c2..0000000000 --- a/tests/test_tutorial/test_python_types/test_tutorial009c.py +++ /dev/null @@ -1,33 +0,0 @@ -import importlib -import re -from types import ModuleType -from unittest.mock import patch - -import pytest - -from ...utils import needs_py310 - - -@pytest.fixture( - name="module", - params=[ - pytest.param("tutorial009c_py310"), - pytest.param("tutorial009c_py310", marks=needs_py310), - ], -) -def get_module(request: pytest.FixtureRequest): - mod = importlib.import_module(f"docs_src.python_types.{request.param}") - return mod - - -def test_say_hi(module: ModuleType): - with patch("builtins.print") as mock_print: - module.say_hi("FastAPI") - - mock_print.assert_called_once_with("Hey FastAPI!") - - with pytest.raises( - TypeError, - match=re.escape("say_hi() missing 1 required positional argument: 'name'"), - ): - module.say_hi() diff --git a/tests/test_union_body.py b/tests/test_union_body.py index e333e2499f..88f9e06cc8 100644 --- a/tests/test_union_body.py +++ b/tests/test_union_body.py @@ -1,5 +1,3 @@ -from typing import Optional, Union - from fastapi import FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -9,7 +7,7 @@ app = FastAPI() class Item(BaseModel): - name: Optional[str] = None + name: str | None = None class OtherItem(BaseModel): @@ -17,7 +15,7 @@ class OtherItem(BaseModel): @app.post("/items/") -def save_union_body(item: Union[OtherItem, Item]): +def save_union_body(item: OtherItem | Item): return {"item": item} diff --git a/tests/test_union_body_discriminator.py b/tests/test_union_body_discriminator.py index 4afe7be4b4..1b682c7751 100644 --- a/tests/test_union_body_discriminator.py +++ b/tests/test_union_body_discriminator.py @@ -1,10 +1,9 @@ -from typing import Annotated, Any, Union +from typing import Annotated, Any, Literal from fastapi import FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot from pydantic import BaseModel, Field -from typing_extensions import Literal def test_discriminator_pydantic_v2() -> None: @@ -21,7 +20,7 @@ def test_discriminator_pydantic_v2() -> None: price: float Item = Annotated[ - Union[Annotated[FirstItem, Tag("first")], Annotated[OtherItem, Tag("other")]], + Annotated[FirstItem, Tag("first")] | Annotated[OtherItem, Tag("other")], Field(discriminator="value"), ] diff --git a/tests/test_union_body_discriminator_annotated.py b/tests/test_union_body_discriminator_annotated.py index 6644d106c8..7e64ea75b4 100644 --- a/tests/test_union_body_discriminator_annotated.py +++ b/tests/test_union_body_discriminator_annotated.py @@ -1,6 +1,6 @@ # Ref: https://github.com/fastapi/fastapi/discussions/14495 -from typing import Annotated, Union +from typing import Annotated import pytest from fastapi import FastAPI @@ -27,7 +27,7 @@ def client_fixture() -> TestClient: return v.get("pet_type", "") Pet = Annotated[ - Union[Annotated[Cat, Tag("cat")], Annotated[Dog, Tag("dog")]], + Annotated[Cat, Tag("cat")] | Annotated[Dog, Tag("dog")], Discriminator(get_pet_type), ] diff --git a/tests/test_union_forms.py b/tests/test_union_forms.py index f6c2658f96..8cd7b4f017 100644 --- a/tests/test_union_forms.py +++ b/tests/test_union_forms.py @@ -1,4 +1,4 @@ -from typing import Annotated, Union +from typing import Annotated from fastapi import FastAPI, Form from fastapi.testclient import TestClient @@ -19,7 +19,7 @@ class CompanyForm(BaseModel): @app.post("/form-union/") -def post_union_form(data: Annotated[Union[UserForm, CompanyForm], Form()]): +def post_union_form(data: Annotated[UserForm | CompanyForm, Form()]): return {"received": data} diff --git a/tests/test_union_inherited_body.py b/tests/test_union_inherited_body.py index 5378880a47..c997a87a35 100644 --- a/tests/test_union_inherited_body.py +++ b/tests/test_union_inherited_body.py @@ -1,5 +1,3 @@ -from typing import Optional, Union - from fastapi import FastAPI from fastapi.testclient import TestClient from inline_snapshot import snapshot @@ -9,7 +7,7 @@ app = FastAPI() class Item(BaseModel): - name: Optional[str] = None + name: str | None = None class ExtendedItem(Item): @@ -17,7 +15,7 @@ class ExtendedItem(Item): @app.post("/items/") -def save_union_different_body(item: Union[ExtendedItem, Item]): +def save_union_different_body(item: ExtendedItem | Item): return {"item": item} diff --git a/tests/test_validate_response.py b/tests/test_validate_response.py index 938d419566..7288220eab 100644 --- a/tests/test_validate_response.py +++ b/tests/test_validate_response.py @@ -1,5 +1,3 @@ -from typing import Optional, Union - import pytest from fastapi import FastAPI from fastapi.exceptions import ResponseValidationError @@ -11,8 +9,8 @@ app = FastAPI() class Item(BaseModel): name: str - price: Optional[float] = None - owner_ids: Optional[list[int]] = None + price: float | None = None + owner_ids: list[int] | None = None @app.get("/items/invalid", response_model=Item) @@ -25,7 +23,7 @@ def get_invalid_none(): return None -@app.get("/items/validnone", response_model=Union[Item, None]) +@app.get("/items/validnone", response_model=Item | None) def get_valid_none(send_none: bool = False): if send_none: return None diff --git a/tests/test_validate_response_dataclass.py b/tests/test_validate_response_dataclass.py index 67282bcde1..03b7d5f338 100644 --- a/tests/test_validate_response_dataclass.py +++ b/tests/test_validate_response_dataclass.py @@ -1,5 +1,3 @@ -from typing import Optional - import pytest from fastapi import FastAPI from fastapi.exceptions import ResponseValidationError @@ -12,8 +10,8 @@ app = FastAPI() @dataclass class Item: name: str - price: Optional[float] = None - owner_ids: Optional[list[int]] = None + price: float | None = None + owner_ids: list[int] | None = None @app.get("/items/invalid", response_model=Item) diff --git a/tests/utils.py b/tests/utils.py index 4cbfee79f5..09c4e13b00 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -2,7 +2,6 @@ import sys import pytest -needs_py39 = pytest.mark.skipif(sys.version_info < (3, 9), reason="requires python3.9+") needs_py310 = pytest.mark.skipif( sys.version_info < (3, 10), reason="requires python3.10+" )