mirror of https://github.com/tiangolo/fastapi.git
Compare commits
No commits in common. "master" and "0.123.2" have entirely different histories.
|
|
@ -13,6 +13,7 @@ env:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
smokeshow:
|
smokeshow:
|
||||||
|
if: ${{ github.event.workflow_run.conclusion == 'success' }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
|
@ -23,10 +24,12 @@ jobs:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v6
|
||||||
- uses: actions/setup-python@v6
|
- uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version: '3.13'
|
python-version: '3.9'
|
||||||
- name: Setup uv
|
- name: Setup uv
|
||||||
uses: astral-sh/setup-uv@v7
|
uses: astral-sh/setup-uv@v7
|
||||||
with:
|
with:
|
||||||
|
version: "0.4.15"
|
||||||
|
enable-cache: true
|
||||||
cache-dependency-glob: |
|
cache-dependency-glob: |
|
||||||
requirements**.txt
|
requirements**.txt
|
||||||
pyproject.toml
|
pyproject.toml
|
||||||
|
|
|
||||||
|
|
@ -31,54 +31,35 @@ jobs:
|
||||||
- name: Setup uv
|
- name: Setup uv
|
||||||
uses: astral-sh/setup-uv@v7
|
uses: astral-sh/setup-uv@v7
|
||||||
with:
|
with:
|
||||||
|
version: "0.4.15"
|
||||||
|
enable-cache: true
|
||||||
cache-dependency-glob: |
|
cache-dependency-glob: |
|
||||||
requirements**.txt
|
requirements**.txt
|
||||||
pyproject.toml
|
pyproject.toml
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
run: uv pip install -r requirements-tests.txt
|
run: uv pip install -r requirements-tests.txt
|
||||||
|
- name: Install Pydantic v2
|
||||||
|
run: uv pip install --upgrade "pydantic>=2.0.2,<3.0.0"
|
||||||
- name: Lint
|
- name: Lint
|
||||||
run: bash scripts/lint.sh
|
run: bash scripts/lint.sh
|
||||||
|
|
||||||
test:
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ windows-latest, macos-latest ]
|
python-version:
|
||||||
python-version: [ "3.14" ]
|
- "3.14"
|
||||||
pydantic-version: [ "pydantic>=2.0.2,<3.0.0" ]
|
- "3.13"
|
||||||
include:
|
- "3.12"
|
||||||
- os: macos-latest
|
- "3.11"
|
||||||
python-version: "3.8"
|
- "3.10"
|
||||||
pydantic-version: "pydantic>=1.10.0,<2.0.0"
|
- "3.9"
|
||||||
- os: windows-latest
|
- "3.8"
|
||||||
python-version: "3.8"
|
pydantic-version: ["pydantic-v1", "pydantic-v2"]
|
||||||
pydantic-version: "pydantic>=2.0.2,<3.0.0"
|
exclude:
|
||||||
coverage: coverage
|
- python-version: "3.14"
|
||||||
- os: ubuntu-latest
|
pydantic-version: "pydantic-v1"
|
||||||
python-version: "3.9"
|
|
||||||
pydantic-version: "pydantic>=1.10.0,<2.0.0"
|
|
||||||
coverage: coverage
|
|
||||||
- os: macos-latest
|
|
||||||
python-version: "3.10"
|
|
||||||
pydantic-version: "pydantic>=2.0.2,<3.0.0"
|
|
||||||
- os: windows-latest
|
|
||||||
python-version: "3.11"
|
|
||||||
pydantic-version: "pydantic>=1.10.0,<2.0.0"
|
|
||||||
- os: ubuntu-latest
|
|
||||||
python-version: "3.12"
|
|
||||||
pydantic-version: "pydantic>=2.0.2,<3.0.0"
|
|
||||||
- os: macos-latest
|
|
||||||
python-version: "3.13"
|
|
||||||
pydantic-version: "pydantic>=1.10.0,<2.0.0"
|
|
||||||
- os: windows-latest
|
|
||||||
python-version: "3.13"
|
|
||||||
pydantic-version: "pydantic>=2.0.2,<3.0.0"
|
|
||||||
coverage: coverage
|
|
||||||
- os: ubuntu-latest
|
|
||||||
python-version: "3.14"
|
|
||||||
pydantic-version: "pydantic>=2.0.2,<3.0.0"
|
|
||||||
coverage: coverage
|
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
steps:
|
steps:
|
||||||
- name: Dump GitHub context
|
- name: Dump GitHub context
|
||||||
env:
|
env:
|
||||||
|
|
@ -99,8 +80,12 @@ jobs:
|
||||||
pyproject.toml
|
pyproject.toml
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
run: uv pip install -r requirements-tests.txt
|
run: uv pip install -r requirements-tests.txt
|
||||||
- name: Install Pydantic
|
- name: Install Pydantic v1
|
||||||
run: uv pip install "${{ matrix.pydantic-version }}"
|
if: matrix.pydantic-version == 'pydantic-v1'
|
||||||
|
run: uv pip install "pydantic>=1.10.0,<2.0.0"
|
||||||
|
- name: Install Pydantic v2
|
||||||
|
if: matrix.pydantic-version == 'pydantic-v2'
|
||||||
|
run: uv pip install --upgrade "pydantic>=2.0.2,<3.0.0"
|
||||||
# TODO: Remove this once Python 3.8 is no longer supported
|
# TODO: Remove this once Python 3.8 is no longer supported
|
||||||
- name: Install older AnyIO in Python 3.8
|
- name: Install older AnyIO in Python 3.8
|
||||||
if: matrix.python-version == '3.8'
|
if: matrix.python-version == '3.8'
|
||||||
|
|
@ -111,12 +96,10 @@ jobs:
|
||||||
env:
|
env:
|
||||||
COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}
|
COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}
|
||||||
CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
|
CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
|
||||||
# Do not store coverage for all possible combinations to avoid file size max errors in Smokeshow
|
|
||||||
- name: Store coverage files
|
- name: Store coverage files
|
||||||
if: matrix.coverage == 'coverage'
|
|
||||||
uses: actions/upload-artifact@v5
|
uses: actions/upload-artifact@v5
|
||||||
with:
|
with:
|
||||||
name: coverage-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/coverage/.coverage.*') }}
|
name: coverage-${{ matrix.python-version }}-${{ matrix.pydantic-version }}
|
||||||
path: coverage
|
path: coverage
|
||||||
include-hidden-files: true
|
include-hidden-files: true
|
||||||
|
|
||||||
|
|
@ -150,6 +133,7 @@ jobs:
|
||||||
merge-multiple: true
|
merge-multiple: true
|
||||||
- run: ls -la coverage
|
- run: ls -la coverage
|
||||||
- run: coverage combine coverage
|
- run: coverage combine coverage
|
||||||
|
- run: coverage report
|
||||||
- run: coverage html --title "Coverage for ${{ github.sha }}"
|
- run: coverage html --title "Coverage for ${{ github.sha }}"
|
||||||
- name: Store coverage HTML
|
- name: Store coverage HTML
|
||||||
uses: actions/upload-artifact@v5
|
uses: actions/upload-artifact@v5
|
||||||
|
|
@ -157,7 +141,6 @@ jobs:
|
||||||
name: coverage-html
|
name: coverage-html
|
||||||
path: htmlcov
|
path: htmlcov
|
||||||
include-hidden-files: true
|
include-hidden-files: true
|
||||||
- run: coverage report --fail-under=100
|
|
||||||
|
|
||||||
# https://github.com/marketplace/actions/alls-green#why
|
# https://github.com/marketplace/actions/alls-green#why
|
||||||
check: # This job does nothing and is only used for the branch protection
|
check: # This job does nothing and is only used for the branch protection
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,6 @@
|
||||||
name: Translate
|
name: Translate
|
||||||
|
|
||||||
on:
|
on:
|
||||||
schedule:
|
|
||||||
- cron: "0 5 15 * *" # Run at 05:00 on the 15 of every month
|
|
||||||
|
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
debug_enabled:
|
debug_enabled:
|
||||||
|
|
@ -19,7 +16,7 @@ on:
|
||||||
- update-outdated
|
- update-outdated
|
||||||
- add-missing
|
- add-missing
|
||||||
- update-and-add
|
- update-and-add
|
||||||
- remove-removable
|
- remove-all-removable
|
||||||
language:
|
language:
|
||||||
description: Language to translate to as a letter code (e.g. "es" for Spanish)
|
description: Language to translate to as a letter code (e.g. "es" for Spanish)
|
||||||
type: string
|
type: string
|
||||||
|
|
@ -35,42 +32,9 @@ env:
|
||||||
UV_SYSTEM_PYTHON: 1
|
UV_SYSTEM_PYTHON: 1
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
langs:
|
job:
|
||||||
runs-on: ubuntu-latest
|
|
||||||
outputs:
|
|
||||||
langs: ${{ steps.show-langs.outputs.langs }}
|
|
||||||
commands: ${{ steps.show-langs.outputs.commands }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v6
|
|
||||||
- name: Set up Python
|
|
||||||
uses: actions/setup-python@v6
|
|
||||||
with:
|
|
||||||
python-version: "3.11"
|
|
||||||
- name: Setup uv
|
|
||||||
uses: astral-sh/setup-uv@v7
|
|
||||||
with:
|
|
||||||
cache-dependency-glob: |
|
|
||||||
requirements**.txt
|
|
||||||
pyproject.toml
|
|
||||||
- name: Install Dependencies
|
|
||||||
run: uv pip install -r requirements-github-actions.txt -r requirements-translations.txt
|
|
||||||
- name: Export Language Codes
|
|
||||||
id: show-langs
|
|
||||||
run: |
|
|
||||||
echo "langs=$(python ./scripts/translate.py llm-translatable-json)" >> $GITHUB_OUTPUT
|
|
||||||
echo "commands=$(python ./scripts/translate.py commands-json)" >> $GITHUB_OUTPUT
|
|
||||||
env:
|
|
||||||
LANGUAGE: ${{ github.event.inputs.language }}
|
|
||||||
COMMAND: ${{ github.event.inputs.command }}
|
|
||||||
|
|
||||||
translate:
|
|
||||||
if: github.repository_owner == 'fastapi'
|
if: github.repository_owner == 'fastapi'
|
||||||
needs: langs
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
lang: ${{ fromJson(needs.langs.outputs.langs) }}
|
|
||||||
command: ${{ fromJson(needs.langs.outputs.commands) }}
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
steps:
|
steps:
|
||||||
|
|
@ -79,8 +43,6 @@ jobs:
|
||||||
GITHUB_CONTEXT: ${{ toJson(github) }}
|
GITHUB_CONTEXT: ${{ toJson(github) }}
|
||||||
run: echo "$GITHUB_CONTEXT"
|
run: echo "$GITHUB_CONTEXT"
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v6
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v6
|
uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
|
|
@ -88,6 +50,8 @@ jobs:
|
||||||
- name: Setup uv
|
- name: Setup uv
|
||||||
uses: astral-sh/setup-uv@v7
|
uses: astral-sh/setup-uv@v7
|
||||||
with:
|
with:
|
||||||
|
version: "0.4.15"
|
||||||
|
enable-cache: true
|
||||||
cache-dependency-glob: |
|
cache-dependency-glob: |
|
||||||
requirements**.txt
|
requirements**.txt
|
||||||
pyproject.toml
|
pyproject.toml
|
||||||
|
|
@ -104,11 +68,10 @@ jobs:
|
||||||
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
||||||
- name: FastAPI Translate
|
- name: FastAPI Translate
|
||||||
run: |
|
run: |
|
||||||
python ./scripts/translate.py ${{ matrix.command }}
|
python ./scripts/translate.py ${{ github.event.inputs.command }}
|
||||||
python ./scripts/translate.py make-pr
|
python ./scripts/translate.py make-pr
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.FASTAPI_TRANSLATIONS }}
|
GITHUB_TOKEN: ${{ secrets.FASTAPI_TRANSLATIONS }}
|
||||||
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
||||||
LANGUAGE: ${{ matrix.lang }}
|
LANGUAGE: ${{ github.event.inputs.language }}
|
||||||
EN_PATH: ${{ github.event.inputs.en_path }}
|
EN_PATH: ${{ github.event.inputs.en_path }}
|
||||||
COMMAND: ${{ matrix.command }}
|
|
||||||
|
|
|
||||||
|
|
@ -443,7 +443,7 @@ Für einige sprachspezifische Anweisungen, siehe z. B. den Abschnitt `### Headin
|
||||||
* die Workload
|
* die Workload
|
||||||
|
|
||||||
* das Deployment
|
* das Deployment
|
||||||
* deployen
|
* bereitstellen
|
||||||
|
|
||||||
* das SDK
|
* das SDK
|
||||||
* das Software Development Kit
|
* das Software Development Kit
|
||||||
|
|
|
||||||
|
|
@ -175,7 +175,7 @@ Sie können denselben `responses`-Parameter verwenden, um verschiedene Medientyp
|
||||||
|
|
||||||
Sie können beispielsweise einen zusätzlichen Medientyp `image/png` hinzufügen und damit deklarieren, dass Ihre *Pfadoperation* ein JSON-Objekt (mit dem Medientyp `application/json`) oder ein PNG-Bild zurückgeben kann:
|
Sie können beispielsweise einen zusätzlichen Medientyp `image/png` hinzufügen und damit deklarieren, dass Ihre *Pfadoperation* ein JSON-Objekt (mit dem Medientyp `application/json`) oder ein PNG-Bild zurückgeben kann:
|
||||||
|
|
||||||
{* ../../docs_src/additional_responses/tutorial002_py310.py hl[17:22,26] *}
|
{* ../../docs_src/additional_responses/tutorial002.py hl[19:24,28] *}
|
||||||
|
|
||||||
/// note | Hinweis
|
/// note | Hinweis
|
||||||
|
|
||||||
|
|
@ -237,7 +237,7 @@ Mit dieser Technik können Sie einige vordefinierte Responses in Ihren *Pfadoper
|
||||||
|
|
||||||
Zum Beispiel:
|
Zum Beispiel:
|
||||||
|
|
||||||
{* ../../docs_src/additional_responses/tutorial004_py310.py hl[11:15,24] *}
|
{* ../../docs_src/additional_responses/tutorial004.py hl[13:17,26] *}
|
||||||
|
|
||||||
## Weitere Informationen zu OpenAPI-Responses { #more-information-about-openapi-responses }
|
## Weitere Informationen zu OpenAPI-Responses { #more-information-about-openapi-responses }
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -144,7 +144,7 @@ Dies wurde in Version 0.110.0 geändert, um unbehandelten Speicherverbrauch durc
|
||||||
|
|
||||||
### Hintergrundtasks und Abhängigkeiten mit `yield`, Technische Details { #background-tasks-and-dependencies-with-yield-technical-details }
|
### Hintergrundtasks und Abhängigkeiten mit `yield`, Technische Details { #background-tasks-and-dependencies-with-yield-technical-details }
|
||||||
|
|
||||||
Vor FastAPI 0.106.0 war das Werfen von Exceptions nach `yield` nicht möglich, der Exit-Code in Abhängigkeiten mit `yield` wurde ausgeführt, nachdem die Response gesendet wurde, sodass [Exceptionhandler](../tutorial/handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank} bereits ausgeführt worden wären.
|
Vor FastAPI 0.106.0 war das Werfen von Exceptions nach `yield` nicht möglich, der Exit-Code in Abhängigkeiten mit `yield` wurde ausgeführt, nachdem die Response gesendet wurde, sodass [Exceptionhandler](../handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank} bereits ausgeführt worden wären.
|
||||||
|
|
||||||
Dies war so designt, hauptsächlich um die Verwendung derselben von Abhängigkeiten „geyieldeten“ Objekte in Hintergrundtasks zu ermöglichen, da der Exit-Code erst ausgeführt wurde, nachdem die Hintergrundtasks abgeschlossen waren.
|
Dies war so designt, hauptsächlich um die Verwendung derselben von Abhängigkeiten „geyieldeten“ Objekte in Hintergrundtasks zu ermöglichen, da der Exit-Code erst ausgeführt wurde, nachdem die Hintergrundtasks abgeschlossen waren.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -64,7 +64,7 @@ Wenn Sie mehr über HTTPS erfahren möchten, lesen Sie den Leitfaden [Über HTTP
|
||||||
|
|
||||||
///
|
///
|
||||||
|
|
||||||
### Wie Proxy-Forwarded-Header funktionieren { #how-proxy-forwarded-headers-work }
|
### Wie Proxy-Forwarded-Header funktionieren
|
||||||
|
|
||||||
Hier ist eine visuelle Darstellung, wie der **Proxy** weitergeleitete Header zwischen dem Client und dem **Anwendungsserver** hinzufügt:
|
Hier ist eine visuelle Darstellung, wie der **Proxy** weitergeleitete Header zwischen dem Client und dem **Anwendungsserver** hinzufügt:
|
||||||
|
|
||||||
|
|
@ -228,7 +228,7 @@ Die Übergabe des `root_path` an `FastAPI` wäre das Äquivalent zur Übergabe d
|
||||||
|
|
||||||
Beachten Sie, dass der Server (Uvicorn) diesen `root_path` für nichts anderes verwendet als für die Weitergabe an die Anwendung.
|
Beachten Sie, dass der Server (Uvicorn) diesen `root_path` für nichts anderes verwendet als für die Weitergabe an die Anwendung.
|
||||||
|
|
||||||
Aber wenn Sie mit Ihrem Browser auf <a href="http://127.0.0.1:8000/app" class="external-link" target="_blank">http://127.0.0.1:8000/app</a> gehen, sehen Sie die normale Response:
|
Aber wenn Sie mit Ihrem Browser auf <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000/app</a> gehen, sehen Sie die normale Response:
|
||||||
|
|
||||||
```JSON
|
```JSON
|
||||||
{
|
{
|
||||||
|
|
@ -443,14 +443,6 @@ Die Dokumentationsoberfläche interagiert mit dem von Ihnen ausgewählten Server
|
||||||
|
|
||||||
///
|
///
|
||||||
|
|
||||||
/// note | Technische Details
|
|
||||||
|
|
||||||
Die Eigenschaft `servers` in der OpenAPI-Spezifikation ist optional.
|
|
||||||
|
|
||||||
Wenn Sie den Parameter `servers` nicht angeben und `root_path` den Wert `/` hat, wird die Eigenschaft `servers` im generierten OpenAPI-Schema standardmäßig vollständig weggelassen, was dem Äquivalent eines einzelnen Servers mit einem `url`-Wert von `/` entspricht.
|
|
||||||
|
|
||||||
///
|
|
||||||
|
|
||||||
### Den automatischen Server von `root_path` deaktivieren { #disable-automatic-server-from-root-path }
|
### Den automatischen Server von `root_path` deaktivieren { #disable-automatic-server-from-root-path }
|
||||||
|
|
||||||
Wenn Sie nicht möchten, dass **FastAPI** einen automatischen Server inkludiert, welcher `root_path` verwendet, können Sie den Parameter `root_path_in_servers=False` verwenden:
|
Wenn Sie nicht möchten, dass **FastAPI** einen automatischen Server inkludiert, welcher `root_path` verwendet, können Sie den Parameter `root_path_in_servers=False` verwenden:
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ FastAPI basiert auf **Pydantic**, und ich habe Ihnen gezeigt, wie Sie Pydantic-M
|
||||||
|
|
||||||
Aber FastAPI unterstützt auf die gleiche Weise auch die Verwendung von <a href="https://docs.python.org/3/library/dataclasses.html" class="external-link" target="_blank">`dataclasses`</a>:
|
Aber FastAPI unterstützt auf die gleiche Weise auch die Verwendung von <a href="https://docs.python.org/3/library/dataclasses.html" class="external-link" target="_blank">`dataclasses`</a>:
|
||||||
|
|
||||||
{* ../../docs_src/dataclasses/tutorial001_py310.py hl[1,6:11,18:19] *}
|
{* ../../docs_src/dataclasses/tutorial001.py hl[1,7:12,19:20] *}
|
||||||
|
|
||||||
Das ist dank **Pydantic** ebenfalls möglich, da es <a href="https://docs.pydantic.dev/latest/concepts/dataclasses/#use-of-stdlib-dataclasses-with-basemodel" class="external-link" target="_blank">`dataclasses` intern unterstützt</a>.
|
Das ist dank **Pydantic** ebenfalls möglich, da es <a href="https://docs.pydantic.dev/latest/concepts/dataclasses/#use-of-stdlib-dataclasses-with-basemodel" class="external-link" target="_blank">`dataclasses` intern unterstützt</a>.
|
||||||
|
|
||||||
|
|
@ -32,7 +32,7 @@ Wenn Sie jedoch eine Menge Datenklassen herumliegen haben, ist dies ein guter Tr
|
||||||
|
|
||||||
Sie können `dataclasses` auch im Parameter `response_model` verwenden:
|
Sie können `dataclasses` auch im Parameter `response_model` verwenden:
|
||||||
|
|
||||||
{* ../../docs_src/dataclasses/tutorial002_py310.py hl[1,6:12,18] *}
|
{* ../../docs_src/dataclasses/tutorial002.py hl[1,7:13,19] *}
|
||||||
|
|
||||||
Die Datenklasse wird automatisch in eine Pydantic-Datenklasse konvertiert.
|
Die Datenklasse wird automatisch in eine Pydantic-Datenklasse konvertiert.
|
||||||
|
|
||||||
|
|
@ -48,7 +48,7 @@ In einigen Fällen müssen Sie möglicherweise immer noch Pydantics Version von
|
||||||
|
|
||||||
In diesem Fall können Sie einfach die Standard-`dataclasses` durch `pydantic.dataclasses` ersetzen, was einen direkten Ersatz darstellt:
|
In diesem Fall können Sie einfach die Standard-`dataclasses` durch `pydantic.dataclasses` ersetzen, was einen direkten Ersatz darstellt:
|
||||||
|
|
||||||
{* ../../docs_src/dataclasses/tutorial003_py310.py hl[1,4,7:10,13:16,22:24,27] *}
|
{* ../../docs_src/dataclasses/tutorial003.py hl[1,5,8:11,14:17,23:25,28] *}
|
||||||
|
|
||||||
1. Wir importieren `field` weiterhin von Standard-`dataclasses`.
|
1. Wir importieren `field` weiterhin von Standard-`dataclasses`.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ Sie verfügt über eine *Pfadoperation*, die einen `Invoice`-Body empfängt, und
|
||||||
|
|
||||||
Dieser Teil ist ziemlich normal, der größte Teil des Codes ist Ihnen wahrscheinlich bereits bekannt:
|
Dieser Teil ist ziemlich normal, der größte Teil des Codes ist Ihnen wahrscheinlich bereits bekannt:
|
||||||
|
|
||||||
{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[7:11,34:51] *}
|
{* ../../docs_src/openapi_callbacks/tutorial001.py hl[9:13,36:53] *}
|
||||||
|
|
||||||
/// tip | Tipp
|
/// tip | Tipp
|
||||||
|
|
||||||
|
|
@ -90,7 +90,7 @@ Wenn Sie diese Sichtweise (des *externen Entwicklers*) vorübergehend übernehme
|
||||||
|
|
||||||
Erstellen Sie zunächst einen neuen `APIRouter`, der einen oder mehrere Callbacks enthält.
|
Erstellen Sie zunächst einen neuen `APIRouter`, der einen oder mehrere Callbacks enthält.
|
||||||
|
|
||||||
{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[1,23] *}
|
{* ../../docs_src/openapi_callbacks/tutorial001.py hl[3,25] *}
|
||||||
|
|
||||||
### Die Callback-*Pfadoperation* erstellen { #create-the-callback-path-operation }
|
### Die Callback-*Pfadoperation* erstellen { #create-the-callback-path-operation }
|
||||||
|
|
||||||
|
|
@ -101,7 +101,7 @@ Sie sollte wie eine normale FastAPI-*Pfadoperation* aussehen:
|
||||||
* Sie sollte wahrscheinlich eine Deklaration des Bodys enthalten, die sie erhalten soll, z. B. `body: InvoiceEvent`.
|
* Sie sollte wahrscheinlich eine Deklaration des Bodys enthalten, die sie erhalten soll, z. B. `body: InvoiceEvent`.
|
||||||
* Und sie könnte auch eine Deklaration der Response enthalten, die zurückgegeben werden soll, z. B. `response_model=InvoiceEventReceived`.
|
* Und sie könnte auch eine Deklaration der Response enthalten, die zurückgegeben werden soll, z. B. `response_model=InvoiceEventReceived`.
|
||||||
|
|
||||||
{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[14:16,19:20,26:30] *}
|
{* ../../docs_src/openapi_callbacks/tutorial001.py hl[16:18,21:22,28:32] *}
|
||||||
|
|
||||||
Es gibt zwei Hauptunterschiede zu einer normalen *Pfadoperation*:
|
Es gibt zwei Hauptunterschiede zu einer normalen *Pfadoperation*:
|
||||||
|
|
||||||
|
|
@ -169,7 +169,7 @@ An diesem Punkt haben Sie die benötigte(n) *Callback-Pfadoperation(en)* (diejen
|
||||||
|
|
||||||
Verwenden Sie nun den Parameter `callbacks` im *Pfadoperation-Dekorator Ihrer API*, um das Attribut `.routes` (das ist eigentlich nur eine `list`e von Routen/*Pfadoperationen*) dieses Callback-Routers zu übergeben:
|
Verwenden Sie nun den Parameter `callbacks` im *Pfadoperation-Dekorator Ihrer API*, um das Attribut `.routes` (das ist eigentlich nur eine `list`e von Routen/*Pfadoperationen*) dieses Callback-Routers zu übergeben:
|
||||||
|
|
||||||
{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[33] *}
|
{* ../../docs_src/openapi_callbacks/tutorial001.py hl[35] *}
|
||||||
|
|
||||||
/// tip | Tipp
|
/// tip | Tipp
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -50,7 +50,7 @@ Das Hinzufügen eines `\f` (ein maskiertes „Form Feed“-Zeichen) führt dazu,
|
||||||
|
|
||||||
Sie wird nicht in der Dokumentation angezeigt, aber andere Tools (z. B. Sphinx) können den Rest verwenden.
|
Sie wird nicht in der Dokumentation angezeigt, aber andere Tools (z. B. Sphinx) können den Rest verwenden.
|
||||||
|
|
||||||
{* ../../docs_src/path_operation_advanced_configuration/tutorial004_py310.py hl[17:27] *}
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial004.py hl[19:29] *}
|
||||||
|
|
||||||
## Zusätzliche Responses { #additional-responses }
|
## Zusätzliche Responses { #additional-responses }
|
||||||
|
|
||||||
|
|
@ -155,13 +155,13 @@ In der folgenden Anwendung verwenden wir beispielsweise weder die integrierte Fu
|
||||||
|
|
||||||
//// tab | Pydantic v2
|
//// tab | Pydantic v2
|
||||||
|
|
||||||
{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py39.py hl[15:20, 22] *}
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial007.py hl[17:22, 24] *}
|
||||||
|
|
||||||
////
|
////
|
||||||
|
|
||||||
//// tab | Pydantic v1
|
//// tab | Pydantic v1
|
||||||
|
|
||||||
{* ../../docs_src/path_operation_advanced_configuration/tutorial007_pv1_py39.py hl[15:20, 22] *}
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial007_pv1.py hl[17:22, 24] *}
|
||||||
|
|
||||||
////
|
////
|
||||||
|
|
||||||
|
|
@ -179,13 +179,13 @@ Und dann parsen wir in unserem Code diesen YAML-Inhalt direkt und verwenden dann
|
||||||
|
|
||||||
//// tab | Pydantic v2
|
//// tab | Pydantic v2
|
||||||
|
|
||||||
{* ../../docs_src/path_operation_advanced_configuration/tutorial007_py39.py hl[24:31] *}
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial007.py hl[26:33] *}
|
||||||
|
|
||||||
////
|
////
|
||||||
|
|
||||||
//// tab | Pydantic v1
|
//// tab | Pydantic v1
|
||||||
|
|
||||||
{* ../../docs_src/path_operation_advanced_configuration/tutorial007_pv1_py39.py hl[24:31] *}
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial007_pv1.py hl[26:33] *}
|
||||||
|
|
||||||
////
|
////
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -34,7 +34,7 @@ Sie können beispielsweise kein Pydantic-Modell in eine `JSONResponse` einfügen
|
||||||
|
|
||||||
In diesen Fällen können Sie den `jsonable_encoder` verwenden, um Ihre Daten zu konvertieren, bevor Sie sie an eine Response übergeben:
|
In diesen Fällen können Sie den `jsonable_encoder` verwenden, um Ihre Daten zu konvertieren, bevor Sie sie an eine Response übergeben:
|
||||||
|
|
||||||
{* ../../docs_src/response_directly/tutorial001_py310.py hl[5:6,20:21] *}
|
{* ../../docs_src/response_directly/tutorial001.py hl[6:7,21:22] *}
|
||||||
|
|
||||||
/// note | Technische Details
|
/// note | Technische Details
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -148,7 +148,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:
|
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/config.py hl[10] *}
|
||||||
|
|
||||||
Beachten Sie, dass wir jetzt keine Standardinstanz `settings = Settings()` erstellen.
|
Beachten Sie, dass wir jetzt keine Standardinstanz `settings = Settings()` erstellen.
|
||||||
|
|
||||||
|
|
@ -174,7 +174,7 @@ Und dann können wir das von der *Pfadoperation-Funktion* als Abhängigkeit einf
|
||||||
|
|
||||||
Dann wäre es sehr einfach, beim Testen ein anderes Einstellungsobjekt bereitzustellen, indem man eine Abhängigkeitsüberschreibung für `get_settings` erstellt:
|
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/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.
|
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.
|
||||||
|
|
||||||
|
|
@ -217,7 +217,7 @@ Und dann aktualisieren Sie Ihre `config.py` mit:
|
||||||
|
|
||||||
//// tab | Pydantic v2
|
//// tab | Pydantic v2
|
||||||
|
|
||||||
{* ../../docs_src/settings/app03_an_py39/config.py hl[9] *}
|
{* ../../docs_src/settings/app03_an/config.py hl[9] *}
|
||||||
|
|
||||||
/// tip | Tipp
|
/// tip | Tipp
|
||||||
|
|
||||||
|
|
@ -229,7 +229,7 @@ Das Attribut `model_config` wird nur für die Pydantic-Konfiguration verwendet.
|
||||||
|
|
||||||
//// tab | Pydantic v1
|
//// tab | Pydantic v1
|
||||||
|
|
||||||
{* ../../docs_src/settings/app03_an_py39/config_pv1.py hl[9:10] *}
|
{* ../../docs_src/settings/app03_an/config_pv1.py hl[9:10] *}
|
||||||
|
|
||||||
/// tip | Tipp
|
/// tip | Tipp
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,24 +1,16 @@
|
||||||
# FastAPI bei Cloudanbietern deployen { #deploy-fastapi-on-cloud-providers }
|
# FastAPI bei Cloudanbietern bereitstellen { #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 bereitzustellen.
|
||||||
|
|
||||||
In den meisten Fällen bieten die großen Cloudanbieter Anleitungen zum Deployment von FastAPI an.
|
In den meisten Fällen bieten die großen Cloudanbieter Anleitungen zum Bereitstellen von FastAPI an.
|
||||||
|
|
||||||
## FastAPI Cloud { #fastapi-cloud }
|
|
||||||
|
|
||||||
**<a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>** wurde vom selben Autor und Team hinter **FastAPI** entwickelt.
|
|
||||||
|
|
||||||
Es vereinfacht den Prozess des **Erstellens**, **Deployens** und **Zugreifens** auf eine API mit minimalem Aufwand.
|
|
||||||
|
|
||||||
Es bringt die gleiche **Developer-Experience** beim Erstellen von Apps mit FastAPI auch zum **Deployment** in der Cloud. 🎉
|
|
||||||
|
|
||||||
FastAPI Cloud ist der Hauptsponsor und Finanzierungsgeber für die *FastAPI and friends* Open-Source-Projekte. ✨
|
|
||||||
|
|
||||||
## Cloudanbieter – Sponsoren { #cloud-providers-sponsors }
|
## Cloudanbieter – Sponsoren { #cloud-providers-sponsors }
|
||||||
|
|
||||||
Einige andere Cloudanbieter ✨ [**sponsern FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨ ebenfalls. 🙇
|
Einige Cloudanbieter ✨ [**sponsern FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨, dies stellt die kontinuierliche und gesunde **Entwicklung** von FastAPI und seinem **Ökosystem** sicher.
|
||||||
|
|
||||||
Sie könnten diese ebenfalls in Betracht ziehen, deren Anleitungen folgen und ihre Dienste ausprobieren:
|
Und es zeigt ihr wahres Engagement für FastAPI und seine **Community** (Sie), da sie Ihnen nicht nur einen **guten Service** bieten möchten, sondern auch sicherstellen möchten, dass Sie ein **gutes und gesundes Framework**, FastAPI, haben. 🙇
|
||||||
|
|
||||||
|
Vielleicht möchten Sie deren Dienste ausprobieren und deren Anleitungen folgen:
|
||||||
|
|
||||||
* <a href="https://docs.render.com/deploy-fastapi?utm_source=deploydoc&utm_medium=referral&utm_campaign=fastapi" class="external-link" target="_blank">Render</a>
|
* <a href="https://docs.render.com/deploy-fastapi?utm_source=deploydoc&utm_medium=referral&utm_campaign=fastapi" class="external-link" target="_blank">Render</a>
|
||||||
* <a href="https://docs.railway.com/guides/fastapi?utm_medium=integration&utm_source=docs&utm_campaign=fastapi" class="external-link" target="_blank">Railway</a>
|
* <a href="https://docs.railway.com/guides/fastapi?utm_medium=integration&utm_source=docs&utm_campaign=fastapi" class="external-link" target="_blank">Railway</a>
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Deployment-Konzepte { #deployments-concepts }
|
# Deployment-Konzepte { #deployments-concepts }
|
||||||
|
|
||||||
Bei dem Deployment – der Bereitstellung – einer **FastAPI**-Anwendung, oder eigentlich jeder Art von Web-API, gibt es mehrere Konzepte, die Sie wahrscheinlich interessieren, und mithilfe der Sie die **am besten geeignete** Methode zum **Deployment Ihrer Anwendung** finden können.
|
Bei dem Deployment – der Bereitstellung – einer **FastAPI**-Anwendung, oder eigentlich jeder Art von Web-API, gibt es mehrere Konzepte, die Sie wahrscheinlich interessieren, und mithilfe der Sie die **am besten geeignete** Methode zur **Bereitstellung Ihrer Anwendung** finden können.
|
||||||
|
|
||||||
Einige wichtige Konzepte sind:
|
Einige wichtige Konzepte sind:
|
||||||
|
|
||||||
|
|
@ -15,11 +15,11 @@ Wir werden sehen, wie diese sich auf das **Deployment** auswirken.
|
||||||
|
|
||||||
Letztendlich besteht das ultimative Ziel darin, **Ihre API-Clients** auf **sichere** Weise zu versorgen, um **Unterbrechungen** zu vermeiden und die **Rechenressourcen** (z. B. entfernte Server/virtuelle Maschinen) so effizient wie möglich zu nutzen. 🚀
|
Letztendlich besteht das ultimative Ziel darin, **Ihre API-Clients** auf **sichere** Weise zu versorgen, um **Unterbrechungen** zu vermeiden und die **Rechenressourcen** (z. B. entfernte Server/virtuelle Maschinen) so effizient wie möglich zu nutzen. 🚀
|
||||||
|
|
||||||
Ich erzähle Ihnen hier etwas mehr über diese **Konzepte**, was Ihnen hoffentlich die **Intuition** gibt, die Sie benötigen, um zu entscheiden, wie Sie Ihre API in sehr unterschiedlichen Umgebungen deployen, möglicherweise sogar in **zukünftigen**, die jetzt noch nicht existieren.
|
Ich erzähle Ihnen hier etwas mehr über diese **Konzepte**, was Ihnen hoffentlich die **Intuition** gibt, die Sie benötigen, um zu entscheiden, wie Sie Ihre API in sehr unterschiedlichen Umgebungen bereitstellen, möglicherweise sogar in **zukünftigen**, die jetzt noch nicht existieren.
|
||||||
|
|
||||||
Durch die Berücksichtigung dieser Konzepte können Sie die beste Variante des Deployments **Ihrer eigenen APIs** **evaluieren und konzipieren**.
|
Durch die Berücksichtigung dieser Konzepte können Sie die beste Variante der Bereitstellung **Ihrer eigenen APIs** **evaluieren und konzipieren**.
|
||||||
|
|
||||||
In den nächsten Kapiteln werde ich Ihnen mehr **konkrete Rezepte** für das Deployment von FastAPI-Anwendungen geben.
|
In den nächsten Kapiteln werde ich Ihnen mehr **konkrete Rezepte** für die Bereitstellung von FastAPI-Anwendungen geben.
|
||||||
|
|
||||||
Aber schauen wir uns zunächst einmal diese grundlegenden **konzeptionellen Ideen** an. Diese Konzepte gelten auch für jede andere Art von Web-API. 💡
|
Aber schauen wir uns zunächst einmal diese grundlegenden **konzeptionellen Ideen** an. Diese Konzepte gelten auch für jede andere Art von Web-API. 💡
|
||||||
|
|
||||||
|
|
@ -271,7 +271,7 @@ In diesem Fall müssen Sie sich darüber keine Sorgen machen. 🤷
|
||||||
|
|
||||||
### Beispiele für Strategien für Vorab-Schritte { #examples-of-previous-steps-strategies }
|
### Beispiele für Strategien für Vorab-Schritte { #examples-of-previous-steps-strategies }
|
||||||
|
|
||||||
Es hängt **stark** davon ab, wie Sie **Ihr System deployen**, und hängt wahrscheinlich mit der Art und Weise zusammen, wie Sie Programme starten, Neustarts durchführen, usw.
|
Es hängt **stark** davon ab, wie Sie **Ihr System bereitstellen**, und hängt wahrscheinlich mit der Art und Weise zusammen, wie Sie Programme starten, Neustarts durchführen, usw.
|
||||||
|
|
||||||
Hier sind einige mögliche Ideen:
|
Hier sind einige mögliche Ideen:
|
||||||
|
|
||||||
|
|
@ -307,7 +307,7 @@ Sie können einfache Tools wie `htop` verwenden, um die in Ihrem Server verwende
|
||||||
|
|
||||||
## Zusammenfassung { #recap }
|
## Zusammenfassung { #recap }
|
||||||
|
|
||||||
Sie haben hier einige der wichtigsten Konzepte gelesen, die Sie wahrscheinlich berücksichtigen müssen, wenn Sie entscheiden, wie Sie Ihre Anwendung deployen:
|
Sie haben hier einige der wichtigsten Konzepte gelesen, die Sie wahrscheinlich berücksichtigen müssen, wenn Sie entscheiden, wie Sie Ihre Anwendung bereitstellen:
|
||||||
|
|
||||||
* Sicherheit – HTTPS
|
* Sicherheit – HTTPS
|
||||||
* Beim Hochfahren ausführen
|
* Beim Hochfahren ausführen
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# FastAPI in Containern – Docker { #fastapi-in-containers-docker }
|
# FastAPI in Containern – Docker { #fastapi-in-containers-docker }
|
||||||
|
|
||||||
Beim Deployment von FastAPI-Anwendungen besteht ein gängiger Ansatz darin, ein **Linux-Containerimage** zu erstellen. Normalerweise erfolgt dies mit <a href="https://www.docker.com/" class="external-link" target="_blank">**Docker**</a>. Sie können dieses Containerimage dann auf eine von mehreren möglichen Arten deployen.
|
Beim Deployment von FastAPI-Anwendungen besteht ein gängiger Ansatz darin, ein **Linux-Containerimage** zu erstellen. Normalerweise erfolgt dies mit <a href="https://www.docker.com/" class="external-link" target="_blank">**Docker**</a>. Sie können dieses Containerimage dann auf eine von mehreren möglichen Arten bereitstellen.
|
||||||
|
|
||||||
Die Verwendung von Linux-Containern bietet mehrere Vorteile, darunter **Sicherheit**, **Replizierbarkeit**, **Einfachheit** und andere.
|
Die Verwendung von Linux-Containern bietet mehrere Vorteile, darunter **Sicherheit**, **Replizierbarkeit**, **Einfachheit** und andere.
|
||||||
|
|
||||||
|
|
@ -40,7 +40,7 @@ Linux-Container werden mit demselben Linux-Kernel des Hosts (Maschine, virtuelle
|
||||||
|
|
||||||
Auf diese Weise verbrauchen Container **wenig Ressourcen**, eine Menge vergleichbar mit der direkten Ausführung der Prozesse (eine virtuelle Maschine würde viel mehr verbrauchen).
|
Auf diese Weise verbrauchen Container **wenig Ressourcen**, eine Menge vergleichbar mit der direkten Ausführung der Prozesse (eine virtuelle Maschine würde viel mehr verbrauchen).
|
||||||
|
|
||||||
Container verfügen außerdem über ihre eigenen **isoliert** laufenden Prozesse (üblicherweise nur einen Prozess), über ihr eigenes Dateisystem und ihr eigenes Netzwerk, was Deployment, Sicherheit, Entwicklung usw. vereinfacht.
|
Container verfügen außerdem über ihre eigenen **isoliert** laufenden Prozesse (üblicherweise nur einen Prozess), über ihr eigenes Dateisystem und ihr eigenes Netzwerk, was die Bereitstellung, Sicherheit, Entwicklung usw. vereinfacht.
|
||||||
|
|
||||||
## Was ist ein Containerimage { #what-is-a-container-image }
|
## Was ist ein Containerimage { #what-is-a-container-image }
|
||||||
|
|
||||||
|
|
@ -598,7 +598,7 @@ Zum Beispiel:
|
||||||
* Mit einem **Kubernetes**-Cluster
|
* Mit einem **Kubernetes**-Cluster
|
||||||
* Mit einem Docker Swarm Mode-Cluster
|
* Mit einem Docker Swarm Mode-Cluster
|
||||||
* Mit einem anderen Tool wie Nomad
|
* Mit einem anderen Tool wie Nomad
|
||||||
* Mit einem Cloud-Dienst, der Ihr Containerimage nimmt und es deployt
|
* Mit einem Cloud-Dienst, der Ihr Containerimage nimmt und es bereitstellt
|
||||||
|
|
||||||
## Docker-Image mit `uv` { #docker-image-with-uv }
|
## Docker-Image mit `uv` { #docker-image-with-uv }
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
# FastAPI Cloud { #fastapi-cloud }
|
|
||||||
|
|
||||||
Sie können Ihre FastAPI-App in der <a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a> mit **einem einzigen Befehl** deployen – tragen Sie sich in die Warteliste ein, falls noch nicht geschehen. 🚀
|
|
||||||
|
|
||||||
## Anmelden { #login }
|
|
||||||
|
|
||||||
Stellen Sie sicher, dass Sie bereits ein **FastAPI-Cloud-Konto** haben (wir haben Sie von der Warteliste eingeladen 😉).
|
|
||||||
|
|
||||||
Melden Sie sich dann an:
|
|
||||||
|
|
||||||
<div class="termy">
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ fastapi login
|
|
||||||
|
|
||||||
You are logged in to FastAPI Cloud 🚀
|
|
||||||
```
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## Deployen { #deploy }
|
|
||||||
|
|
||||||
Stellen Sie Ihre App jetzt mit **einem einzigen Befehl** bereit:
|
|
||||||
|
|
||||||
<div class="termy">
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ fastapi deploy
|
|
||||||
|
|
||||||
Deploying to FastAPI Cloud...
|
|
||||||
|
|
||||||
✅ Deployment successful!
|
|
||||||
|
|
||||||
🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev
|
|
||||||
```
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Das war’s! Jetzt können Sie Ihre App unter dieser URL aufrufen. ✨
|
|
||||||
|
|
||||||
## Über FastAPI Cloud { #about-fastapi-cloud }
|
|
||||||
|
|
||||||
**<a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>** wird vom gleichen Autor und Team hinter **FastAPI** entwickelt.
|
|
||||||
|
|
||||||
Es vereinfacht den Prozess des **Erstellens**, **Deployens** und **Nutzens** einer API mit minimalem Aufwand.
|
|
||||||
|
|
||||||
Es bringt die gleiche **Developer-Experience** beim Erstellen von Apps mit FastAPI auch zum **Deployment** in der Cloud. 🎉
|
|
||||||
|
|
||||||
Es kümmert sich außerdem um das meiste, was beim Deployen einer App nötig ist, zum Beispiel:
|
|
||||||
|
|
||||||
* HTTPS
|
|
||||||
* Replikation, mit Autoscaling basierend auf Requests
|
|
||||||
* usw.
|
|
||||||
|
|
||||||
FastAPI Cloud ist Hauptsponsor und Finanzierer der Open-Source-Projekte *FastAPI and friends*. ✨
|
|
||||||
|
|
||||||
## Bei anderen Cloudanbietern deployen { #deploy-to-other-cloud-providers }
|
|
||||||
|
|
||||||
FastAPI ist Open Source und basiert auf Standards. Sie können FastAPI-Apps bei jedem Cloudanbieter Ihrer Wahl deployen.
|
|
||||||
|
|
||||||
Folgen Sie den Anleitungen Ihres Cloudanbieters, um dort FastAPI-Apps zu deployen. 🤓
|
|
||||||
|
|
||||||
## Auf den eigenen Server deployen { #deploy-your-own-server }
|
|
||||||
|
|
||||||
Ich werde Ihnen später in diesem **Deployment-Leitfaden** auch alle Details zeigen, sodass Sie verstehen, was passiert, was geschehen muss und wie Sie FastAPI-Apps selbst deployen können, auch auf Ihre eigenen Server. 🤓
|
|
||||||
|
|
@ -14,9 +14,7 @@ Das steht im Gegensatz zu den **Entwicklungsphasen**, in denen Sie ständig den
|
||||||
|
|
||||||
Es gibt mehrere Möglichkeiten, dies zu tun, abhängig von Ihrem spezifischen Anwendungsfall und den von Ihnen verwendeten Tools.
|
Es gibt mehrere Möglichkeiten, dies zu tun, abhängig von Ihrem spezifischen Anwendungsfall und den von Ihnen verwendeten Tools.
|
||||||
|
|
||||||
Sie könnten mithilfe einer Kombination von Tools selbst **einen Server deployen**, Sie könnten einen **Cloud-Dienst** nutzen, der einen Teil der Arbeit für Sie erledigt, oder andere mögliche Optionen.
|
Sie könnten mithilfe einer Kombination von Tools selbst **einen Server bereitstellen**, Sie könnten einen **Cloud-Dienst** nutzen, der einen Teil der Arbeit für Sie erledigt, oder andere mögliche Optionen.
|
||||||
|
|
||||||
Zum Beispiel haben wir, das Team hinter FastAPI, <a href="https://fastapicloud.com" class="external-link" target="_blank">**FastAPI Cloud**</a> entwickelt, um das Deployment von FastAPI-Apps in der Cloud so reibungslos wie möglich zu gestalten, mit derselben Developer-Experience wie beim Arbeiten mit FastAPI.
|
|
||||||
|
|
||||||
Ich zeige Ihnen einige der wichtigsten Konzepte, die Sie beim Deployment einer **FastAPI**-Anwendung wahrscheinlich berücksichtigen sollten (obwohl das meiste davon auch für jede andere Art von Webanwendung gilt).
|
Ich zeige Ihnen einige der wichtigsten Konzepte, die Sie beim Deployment einer **FastAPI**-Anwendung wahrscheinlich berücksichtigen sollten (obwohl das meiste davon auch für jede andere Art von Webanwendung gilt).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ Schauen wir uns die Deployment-Konzepte von früher noch einmal an:
|
||||||
|
|
||||||
Bis zu diesem Punkt, in allen Tutorials in der Dokumentation, haben Sie wahrscheinlich ein **Serverprogramm** ausgeführt, zum Beispiel mit dem `fastapi`-Befehl, der Uvicorn startet, und einen **einzelnen Prozess** ausführt.
|
Bis zu diesem Punkt, in allen Tutorials in der Dokumentation, haben Sie wahrscheinlich ein **Serverprogramm** ausgeführt, zum Beispiel mit dem `fastapi`-Befehl, der Uvicorn startet, und einen **einzelnen Prozess** ausführt.
|
||||||
|
|
||||||
Wenn Sie Anwendungen deployen, möchten Sie wahrscheinlich eine gewisse **Replikation von Prozessen**, um **mehrere Kerne** zu nutzen und mehr <abbr title="Request – Anfrage: Daten, die der Client zum Server sendet">Requests</abbr> bearbeiten zu können.
|
Wenn Sie Anwendungen bereitstellen, möchten Sie wahrscheinlich eine gewisse **Replikation von Prozessen**, um **mehrere Kerne** zu nutzen und mehr <abbr title="Request – Anfrage: Daten, die der Client zum Server sendet">Requests</abbr> bearbeiten zu können.
|
||||||
|
|
||||||
Wie Sie im vorherigen Kapitel über [Deployment-Konzepte](concepts.md){.internal-link target=_blank} gesehen haben, gibt es mehrere Strategien, die Sie anwenden können.
|
Wie Sie im vorherigen Kapitel über [Deployment-Konzepte](concepts.md){.internal-link target=_blank} gesehen haben, gibt es mehrere Strategien, die Sie anwenden können.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -66,7 +66,7 @@ Das Ausführen von `fastapi run` startet FastAPI standardmäßig im Produktionsm
|
||||||
|
|
||||||
Standardmäßig ist **Autoreload** deaktiviert. Es horcht auch auf der IP-Adresse `0.0.0.0`, was alle verfügbaren IP-Adressen bedeutet, so wird es öffentlich zugänglich für jeden, der mit der Maschine kommunizieren kann. So würden Sie es normalerweise in der Produktion ausführen, beispielsweise in einem Container.
|
Standardmäßig ist **Autoreload** deaktiviert. Es horcht auch auf der IP-Adresse `0.0.0.0`, was alle verfügbaren IP-Adressen bedeutet, so wird es öffentlich zugänglich für jeden, der mit der Maschine kommunizieren kann. So würden Sie es normalerweise in der Produktion ausführen, beispielsweise in einem Container.
|
||||||
|
|
||||||
In den meisten Fällen würden (und sollten) Sie einen „Terminierungsproxy“ haben, der HTTPS für Sie verwaltet. Dies hängt davon ab, wie Sie Ihre Anwendung deployen. Ihr Anbieter könnte dies für Sie erledigen, oder Sie müssen es selbst einrichten.
|
In den meisten Fällen würden (und sollten) Sie einen „Terminierungsproxy“ haben, der HTTPS für Sie verwaltet. Dies hängt davon ab, wie Sie Ihre Anwendung bereitstellen. Ihr Anbieter könnte dies für Sie erledigen, oder Sie müssen es selbst einrichten.
|
||||||
|
|
||||||
/// tip | Tipp
|
/// tip | Tipp
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
# Alte 403-Authentifizierungsfehler-Statuscodes verwenden { #use-old-403-authentication-error-status-codes }
|
|
||||||
|
|
||||||
Vor FastAPI-Version `0.122.0` verwendeten die integrierten Sicherheits-Utilities den HTTP-Statuscode `403 Forbidden`, wenn sie dem Client nach einer fehlgeschlagenen Authentifizierung einen Fehler zurückgaben.
|
|
||||||
|
|
||||||
Ab FastAPI-Version `0.122.0` verwenden sie den passenderen HTTP-Statuscode `401 Unauthorized` und geben in der Response einen sinnvollen `WWW-Authenticate`-Header zurück, gemäß den HTTP-Spezifikationen, <a href="https://datatracker.ietf.org/doc/html/rfc7235#section-3.1" class="external-link" target="_blank">RFC 7235</a>, <a href="https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized" class="external-link" target="_blank">RFC 9110</a>.
|
|
||||||
|
|
||||||
Aber falls Ihre Clients aus irgendeinem Grund vom alten Verhalten abhängen, können Sie darauf zurückgreifen, indem Sie in Ihren Sicherheitsklassen die Methode `make_not_authenticated_error` überschreiben.
|
|
||||||
|
|
||||||
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] *}
|
|
||||||
|
|
||||||
/// tip | Tipp
|
|
||||||
|
|
||||||
Beachten Sie, dass die Funktion die Exception-Instanz zurückgibt; sie wirft sie nicht. Das Werfen erfolgt im restlichen internen Code.
|
|
||||||
|
|
||||||
///
|
|
||||||
|
|
@ -40,7 +40,7 @@ FastAPI enthält einige Defaultkonfigurationsparameter, die für die meisten Anw
|
||||||
|
|
||||||
Es umfasst die folgenden Defaultkonfigurationen:
|
Es umfasst die folgenden Defaultkonfigurationen:
|
||||||
|
|
||||||
{* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *}
|
{* ../../fastapi/openapi/docs.py ln[8:23] hl[17:23] *}
|
||||||
|
|
||||||
Sie können jede davon überschreiben, indem Sie im Argument `swagger_ui_parameters` einen anderen Wert festlegen.
|
Sie können jede davon überschreiben, indem Sie im Argument `swagger_ui_parameters` einen anderen Wert festlegen.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ Wenn der Header kein `gzip` enthält, wird nicht versucht, den Body zu dekomprim
|
||||||
|
|
||||||
Auf diese Weise kann dieselbe Routenklasse gzip-komprimierte oder unkomprimierte Requests verarbeiten.
|
Auf diese Weise kann dieselbe Routenklasse gzip-komprimierte oder unkomprimierte Requests verarbeiten.
|
||||||
|
|
||||||
{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[9:16] *}
|
{* ../../docs_src/custom_request_and_route/tutorial001.py hl[8:15] *}
|
||||||
|
|
||||||
### Eine benutzerdefinierte `GzipRoute`-Klasse erstellen { #create-a-custom-gziproute-class }
|
### Eine benutzerdefinierte `GzipRoute`-Klasse erstellen { #create-a-custom-gziproute-class }
|
||||||
|
|
||||||
|
|
@ -54,7 +54,7 @@ Diese Methode gibt eine Funktion zurück. Und diese Funktion empfängt einen <ab
|
||||||
|
|
||||||
Hier verwenden wir sie, um aus dem ursprünglichen Request einen `GzipRequest` zu erstellen.
|
Hier verwenden wir sie, um aus dem ursprünglichen Request einen `GzipRequest` zu erstellen.
|
||||||
|
|
||||||
{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[19:27] *}
|
{* ../../docs_src/custom_request_and_route/tutorial001.py hl[18:26] *}
|
||||||
|
|
||||||
/// note | Technische Details
|
/// note | Technische Details
|
||||||
|
|
||||||
|
|
@ -92,18 +92,18 @@ Wir können denselben Ansatz auch verwenden, um in einem Exceptionhandler auf de
|
||||||
|
|
||||||
Alles, was wir tun müssen, ist, den Request innerhalb eines `try`/`except`-Blocks zu handhaben:
|
Alles, was wir tun müssen, ist, den Request innerhalb eines `try`/`except`-Blocks zu handhaben:
|
||||||
|
|
||||||
{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[14,16] *}
|
{* ../../docs_src/custom_request_and_route/tutorial002.py hl[13,15] *}
|
||||||
|
|
||||||
Wenn eine Exception auftritt, befindet sich die `Request`-Instanz weiterhin im Gültigkeitsbereich, sodass wir den Requestbody lesen und bei der Fehlerbehandlung verwenden können:
|
Wenn eine Exception auftritt, befindet sich die `Request`-Instanz weiterhin im Gültigkeitsbereich, sodass wir den Requestbody lesen und bei der Fehlerbehandlung verwenden können:
|
||||||
|
|
||||||
{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[17:19] *}
|
{* ../../docs_src/custom_request_and_route/tutorial002.py hl[16:18] *}
|
||||||
|
|
||||||
## Benutzerdefinierte `APIRoute`-Klasse in einem Router { #custom-apiroute-class-in-a-router }
|
## Benutzerdefinierte `APIRoute`-Klasse in einem Router { #custom-apiroute-class-in-a-router }
|
||||||
|
|
||||||
Sie können auch den Parameter `route_class` eines `APIRouter` festlegen:
|
Sie können auch den Parameter `route_class` eines `APIRouter` festlegen:
|
||||||
|
|
||||||
{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[26] *}
|
{* ../../docs_src/custom_request_and_route/tutorial003.py hl[26] *}
|
||||||
|
|
||||||
In diesem Beispiel verwenden die *Pfadoperationen* unter dem `router` die benutzerdefinierte `TimedRoute`-Klasse und haben in der Response einen zusätzlichen `X-Response-Time`-Header mit der Zeit, die zum Generieren der Response benötigt wurde:
|
In diesem Beispiel verwenden die *Pfadoperationen* unter dem `router` die benutzerdefinierte `TimedRoute`-Klasse und haben in der Response einen zusätzlichen `X-Response-Time`-Header mit der Zeit, die zum Generieren der Response benötigt wurde:
|
||||||
|
|
||||||
{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[13:20] *}
|
{* ../../docs_src/custom_request_and_route/tutorial003.py hl[13:20] *}
|
||||||
|
|
|
||||||
|
|
@ -46,26 +46,20 @@ Seine Schlüssel-Merkmale sind:
|
||||||
* **Robust**: Erhalten Sie produktionsreifen Code. Mit automatischer, interaktiver Dokumentation.
|
* **Robust**: Erhalten Sie produktionsreifen Code. Mit automatischer, interaktiver Dokumentation.
|
||||||
* **Standards-basiert**: Basierend auf (und vollständig kompatibel mit) den offenen Standards für APIs: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (früher bekannt als Swagger) und <a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>.
|
* **Standards-basiert**: Basierend auf (und vollständig kompatibel mit) den offenen Standards für APIs: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (früher bekannt als Swagger) und <a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>.
|
||||||
|
|
||||||
<small>* Schätzung basierend auf Tests, die von einem internen Entwicklungsteam durchgeführt wurden, das Produktionsanwendungen erstellt.</small>
|
<small>* Schätzung basierend auf Tests in einem internen Entwicklungsteam, das Produktionsanwendungen erstellt.</small>
|
||||||
|
|
||||||
## Sponsoren { #sponsors }
|
## Sponsoren { #sponsors }
|
||||||
|
|
||||||
<!-- sponsors -->
|
<!-- sponsors -->
|
||||||
|
|
||||||
### Keystone-Sponsor { #keystone-sponsor }
|
{% if sponsors %}
|
||||||
|
|
||||||
{% for sponsor in sponsors.keystone -%}
|
|
||||||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
|
||||||
{% endfor -%}
|
|
||||||
|
|
||||||
### Gold- und Silber-Sponsoren { #gold-and-silver-sponsors }
|
|
||||||
|
|
||||||
{% for sponsor in sponsors.gold -%}
|
{% for sponsor in sponsors.gold -%}
|
||||||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
||||||
{% endfor -%}
|
{% endfor -%}
|
||||||
{%- for sponsor in sponsors.silver -%}
|
{%- for sponsor in sponsors.silver -%}
|
||||||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
<!-- /sponsors -->
|
<!-- /sponsors -->
|
||||||
|
|
||||||
|
|
@ -450,58 +444,6 @@ Für ein vollständigeres Beispiel, mit weiteren Funktionen, siehe das <a href="
|
||||||
* **Cookie-Sessions**
|
* **Cookie-Sessions**
|
||||||
* ... und mehr.
|
* ... und mehr.
|
||||||
|
|
||||||
### Ihre App deployen (optional) { #deploy-your-app-optional }
|
|
||||||
|
|
||||||
Optional können Sie Ihre FastAPI-App in die <a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a> deployen, treten Sie der Warteliste bei, falls noch nicht geschehen. 🚀
|
|
||||||
|
|
||||||
Wenn Sie bereits ein **FastAPI Cloud**-Konto haben (wir haben Sie von der Warteliste eingeladen 😉), können Sie Ihre Anwendung mit einem einzigen Befehl deployen.
|
|
||||||
|
|
||||||
Stellen Sie vor dem Deployen sicher, dass Sie eingeloggt sind:
|
|
||||||
|
|
||||||
<div class="termy">
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ fastapi login
|
|
||||||
|
|
||||||
You are logged in to FastAPI Cloud 🚀
|
|
||||||
```
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Stellen Sie dann Ihre App bereit:
|
|
||||||
|
|
||||||
<div class="termy">
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ fastapi deploy
|
|
||||||
|
|
||||||
Deploying to FastAPI Cloud...
|
|
||||||
|
|
||||||
✅ Deployment successful!
|
|
||||||
|
|
||||||
🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev
|
|
||||||
```
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Das war’s! Jetzt können Sie unter dieser URL auf Ihre App zugreifen. ✨
|
|
||||||
|
|
||||||
#### Über FastAPI Cloud { #about-fastapi-cloud }
|
|
||||||
|
|
||||||
**<a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>** wird vom selben Autor und Team hinter **FastAPI** entwickelt.
|
|
||||||
|
|
||||||
Es vereinfacht den Prozess des **Erstellens**, **Deployens** und **Zugreifens** auf eine API mit minimalem Aufwand.
|
|
||||||
|
|
||||||
Es bringt die gleiche **Developer-Experience** beim Erstellen von Apps mit FastAPI auch zum **Deployment** in der Cloud. 🎉
|
|
||||||
|
|
||||||
FastAPI Cloud ist der Hauptsponsor und Finanzierer der „FastAPI and friends“ Open-Source-Projekte. ✨
|
|
||||||
|
|
||||||
#### Bei anderen Cloudanbietern deployen { #deploy-to-other-cloud-providers }
|
|
||||||
|
|
||||||
FastAPI ist Open Source und basiert auf Standards. Sie können FastAPI-Apps bei jedem Cloudanbieter Ihrer Wahl deployen.
|
|
||||||
|
|
||||||
Folgen Sie den Anleitungen Ihres Cloudanbieters, um FastAPI-Apps dort bereitzustellen. 🤓
|
|
||||||
|
|
||||||
## Performanz { #performance }
|
## Performanz { #performance }
|
||||||
|
|
||||||
Unabhängige TechEmpower-Benchmarks zeigen **FastAPI**-Anwendungen, die unter Uvicorn laufen, als <a href="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7" class="external-link" target="_blank">eines der schnellsten verfügbaren Python-Frameworks</a>, nur hinter Starlette und Uvicorn selbst (intern von FastAPI verwendet). (*)
|
Unabhängige TechEmpower-Benchmarks zeigen **FastAPI**-Anwendungen, die unter Uvicorn laufen, als <a href="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7" class="external-link" target="_blank">eines der schnellsten verfügbaren Python-Frameworks</a>, nur hinter Starlette und Uvicorn selbst (intern von FastAPI verwendet). (*)
|
||||||
|
|
|
||||||
|
|
@ -14,15 +14,15 @@ GitHub-Repository: <a href="https://github.com/tiangolo/full-stack-fastapi-templ
|
||||||
- 💾 [PostgreSQL](https://www.postgresql.org) als SQL-Datenbank.
|
- 💾 [PostgreSQL](https://www.postgresql.org) als SQL-Datenbank.
|
||||||
- 🚀 [React](https://react.dev) für das Frontend.
|
- 🚀 [React](https://react.dev) für das Frontend.
|
||||||
- 💃 Verwendung von TypeScript, Hooks, [Vite](https://vitejs.dev) und anderen Teilen eines modernen Frontend-Stacks.
|
- 💃 Verwendung von TypeScript, Hooks, [Vite](https://vitejs.dev) und anderen Teilen eines modernen Frontend-Stacks.
|
||||||
- 🎨 [Tailwind CSS](https://tailwindcss.com) und [shadcn/ui](https://ui.shadcn.com) für die Frontend-Komponenten.
|
- 🎨 [Chakra UI](https://chakra-ui.com) für die Frontend-Komponenten.
|
||||||
- 🤖 Ein automatisch generierter Frontend-Client.
|
- 🤖 Ein automatisch generierter Frontend-Client.
|
||||||
- 🧪 [Playwright](https://playwright.dev) für End-to-End-Tests.
|
- 🧪 [Playwright](https://playwright.dev) für End-to-End-Tests.
|
||||||
- 🦇 „Dark-Mode“-Unterstützung.
|
- 🦇 Unterstützung des Dunkelmodus.
|
||||||
- 🐋 [Docker Compose](https://www.docker.com) für Entwicklung und Produktion.
|
- 🐋 [Docker Compose](https://www.docker.com) für Entwicklung und Produktion.
|
||||||
- 🔒 Sicheres Passwort-Hashing standardmäßig.
|
- 🔒 Sicheres Passwort-Hashing standardmäßig.
|
||||||
- 🔑 JWT (JSON Web Token)-Token-Authentifizierung.
|
- 🔑 JWT-Token-Authentifizierung.
|
||||||
- 📫 E-Mail-basierte Passwortwiederherstellung.
|
- 📫 E-Mail-basierte Passwortwiederherstellung.
|
||||||
- ✅ Tests mit [Pytest](https://pytest.org).
|
- ✅ Tests mit [Pytest](https://pytest.org).
|
||||||
- 📞 [Traefik](https://traefik.io) als Reverse-Proxy / Load Balancer.
|
- 📞 [Traefik](https://traefik.io) als Reverse-Proxy / Load Balancer.
|
||||||
- 🚢 Deployment-Anleitungen unter Verwendung von Docker Compose, einschließlich der Einrichtung eines Frontend-Traefik-Proxys zur Handhabung automatischer HTTPS-Zertifikate.
|
- 🚢 Deployment-Anleitungen unter Verwendung von Docker Compose, einschließlich der Einrichtung eines Frontend-Traefik-Proxys zur Handhabung automatischer HTTPS-Zertifikate.
|
||||||
- 🏭 CI (kontinuierliche Integration) und CD (kontinuierliches Deployment) basierend auf GitHub Actions.
|
- 🏭 CI (kontinuierliche Integration) und CD (kontinuierliche Bereitstellung) basierend auf GitHub Actions.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,3 @@
|
||||||
# Ressourcen { #resources }
|
# Ressourcen { #resources }
|
||||||
|
|
||||||
Zusätzliche Ressourcen, externe Links und mehr. ✈️
|
Zusätzliche Ressourcen, externe Links, Artikel und mehr. ✈️
|
||||||
|
|
|
||||||
|
|
@ -85,7 +85,9 @@ 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`:
|
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"] *}
|
```Python hl_lines="1 3" title="app/routers/users.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/users.py!}
|
||||||
|
```
|
||||||
|
|
||||||
### *Pfadoperationen* mit `APIRouter` { #path-operations-with-apirouter }
|
### *Pfadoperationen* mit `APIRouter` { #path-operations-with-apirouter }
|
||||||
|
|
||||||
|
|
@ -93,7 +95,9 @@ Und dann verwenden Sie ihn, um Ihre *Pfadoperationen* zu deklarieren.
|
||||||
|
|
||||||
Verwenden Sie ihn auf die gleiche Weise wie die Klasse `FastAPI`:
|
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"] *}
|
```Python hl_lines="6 11 16" title="app/routers/users.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/users.py!}
|
||||||
|
```
|
||||||
|
|
||||||
Sie können sich `APIRouter` als eine „Mini-`FastAPI`“-Klasse vorstellen.
|
Sie können sich `APIRouter` als eine „Mini-`FastAPI`“-Klasse vorstellen.
|
||||||
|
|
||||||
|
|
@ -117,7 +121,35 @@ 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:
|
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"] *}
|
//// tab | Python 3.9+
|
||||||
|
|
||||||
|
```Python hl_lines="3 6-8" title="app/dependencies.py"
|
||||||
|
{!> ../../docs_src/bigger_applications/app_an_py39/dependencies.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | Python 3.8+
|
||||||
|
|
||||||
|
```Python hl_lines="1 5-7" title="app/dependencies.py"
|
||||||
|
{!> ../../docs_src/bigger_applications/app_an/dependencies.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | Python 3.8+ nicht annotiert
|
||||||
|
|
||||||
|
/// tip | Tipp
|
||||||
|
|
||||||
|
Bevorzugen Sie die `Annotated`-Version, falls möglich.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
```Python hl_lines="1 4-6" title="app/dependencies.py"
|
||||||
|
{!> ../../docs_src/bigger_applications/app/dependencies.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
/// tip | Tipp
|
/// tip | Tipp
|
||||||
|
|
||||||
|
|
@ -149,7 +181,9 @@ 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.
|
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"] *}
|
```Python hl_lines="5-10 16 21" title="app/routers/items.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/items.py!}
|
||||||
|
```
|
||||||
|
|
||||||
Da der Pfad jeder *Pfadoperation* mit `/` beginnen muss, wie in:
|
Da der Pfad jeder *Pfadoperation* mit `/` beginnen muss, wie in:
|
||||||
|
|
||||||
|
|
@ -208,7 +242,9 @@ 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:
|
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"] *}
|
```Python hl_lines="3" title="app/routers/items.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/items.py!}
|
||||||
|
```
|
||||||
|
|
||||||
#### Wie relative Importe funktionieren { #how-relative-imports-work }
|
#### Wie relative Importe funktionieren { #how-relative-imports-work }
|
||||||
|
|
||||||
|
|
@ -279,7 +315,9 @@ 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:
|
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"] *}
|
```Python hl_lines="30-31" title="app/routers/items.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/items.py!}
|
||||||
|
```
|
||||||
|
|
||||||
/// tip | Tipp
|
/// tip | Tipp
|
||||||
|
|
||||||
|
|
@ -305,13 +343,17 @@ 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:
|
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"] *}
|
```Python hl_lines="1 3 7" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
### Den `APIRouter` importieren { #import-the-apirouter }
|
### Den `APIRouter` importieren { #import-the-apirouter }
|
||||||
|
|
||||||
Jetzt importieren wir die anderen Submodule, die `APIRouter` haben:
|
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"] *}
|
```Python hl_lines="4-5" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/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.
|
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 +416,17 @@ 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:
|
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"] *}
|
```Python hl_lines="5" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
### Die `APIRouter` für `users` und `items` inkludieren { #include-the-apirouters-for-users-and-items }
|
### 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`:
|
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"] *}
|
```Python hl_lines="10-11" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
/// info | Info
|
/// info | Info
|
||||||
|
|
||||||
|
|
@ -420,13 +466,17 @@ 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:
|
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"] *}
|
```Python hl_lines="3" title="app/internal/admin.py"
|
||||||
|
{!../../docs_src/bigger_applications/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.
|
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:
|
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"] *}
|
```Python hl_lines="14-17" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/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.
|
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 +497,9 @@ Wir können *Pfadoperationen* auch direkt zur `FastAPI`-App hinzufügen.
|
||||||
|
|
||||||
Hier machen wir es ... nur um zu zeigen, dass wir es können 🤷:
|
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"] *}
|
```Python hl_lines="21-23" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
und es wird korrekt funktionieren, zusammen mit allen anderen *Pfadoperationen*, die mit `app.include_router()` hinzugefügt wurden.
|
und es wird korrekt funktionieren, zusammen mit allen anderen *Pfadoperationen*, die mit `app.include_router()` hinzugefügt wurden.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -50,7 +50,7 @@ Ihre API hat jetzt die Macht, ihre eigene <abbr title="Das ist ein Scherz, nur f
|
||||||
|
|
||||||
Sie können die Modellkonfiguration von Pydantic verwenden, um `extra` Felder zu verbieten (`forbid`):
|
Sie können die Modellkonfiguration von Pydantic verwenden, um `extra` Felder zu verbieten (`forbid`):
|
||||||
|
|
||||||
{* ../../docs_src/cookie_param_models/tutorial002_an_py310.py hl[10] *}
|
{* ../../docs_src/cookie_param_models/tutorial002_an_py39.py hl[10] *}
|
||||||
|
|
||||||
Wenn ein Client versucht, einige **zusätzliche Cookies** zu senden, erhält er eine **Error-<abbr title="Response – Antwort: Daten, die der Server zum anfragenden Client zurücksendet">Response</abbr>**.
|
Wenn ein Client versucht, einige **zusätzliche Cookies** zu senden, erhält er eine **Error-<abbr title="Response – Antwort: Daten, die der Server zum anfragenden Client zurücksendet">Response</abbr>**.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -143,42 +143,6 @@ Es gibt dutzende Alternativen, die alle auf OpenAPI basieren. Sie können jede d
|
||||||
|
|
||||||
Ebenfalls können Sie es verwenden, um automatisch Code für Clients zu generieren, die mit Ihrer API kommunizieren. Zum Beispiel für Frontend-, Mobile- oder IoT-Anwendungen.
|
Ebenfalls können Sie es verwenden, um automatisch Code für Clients zu generieren, die mit Ihrer API kommunizieren. Zum Beispiel für Frontend-, Mobile- oder IoT-Anwendungen.
|
||||||
|
|
||||||
### Ihre App deployen (optional) { #deploy-your-app-optional }
|
|
||||||
|
|
||||||
Sie können optional Ihre FastAPI-App in der <a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a> deployen, treten Sie der Warteliste bei, falls Sie es noch nicht getan haben. 🚀
|
|
||||||
|
|
||||||
Wenn Sie bereits ein **FastAPI Cloud**-Konto haben (wir haben Sie von der Warteliste eingeladen 😉), können Sie Ihre Anwendung mit einem Befehl deployen.
|
|
||||||
|
|
||||||
Vor dem Deployen, stellen Sie sicher, dass Sie eingeloggt sind:
|
|
||||||
|
|
||||||
<div class="termy">
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ fastapi login
|
|
||||||
|
|
||||||
You are logged in to FastAPI Cloud 🚀
|
|
||||||
```
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Dann stellen Sie Ihre App bereit:
|
|
||||||
|
|
||||||
<div class="termy">
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ fastapi deploy
|
|
||||||
|
|
||||||
Deploying to FastAPI Cloud...
|
|
||||||
|
|
||||||
✅ Deployment successful!
|
|
||||||
|
|
||||||
🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev
|
|
||||||
```
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Das war's! Jetzt können Sie Ihre App unter dieser URL aufrufen. ✨
|
|
||||||
|
|
||||||
## Zusammenfassung, Schritt für Schritt { #recap-step-by-step }
|
## Zusammenfassung, Schritt für Schritt { #recap-step-by-step }
|
||||||
|
|
||||||
### Schritt 1: `FastAPI` importieren { #step-1-import-fastapi }
|
### Schritt 1: `FastAPI` importieren { #step-1-import-fastapi }
|
||||||
|
|
@ -350,26 +314,6 @@ Sie können auch Pydantic-Modelle zurückgeben (dazu später mehr).
|
||||||
|
|
||||||
Es gibt viele andere Objekte und Modelle, die automatisch zu JSON konvertiert werden (einschließlich ORMs, usw.). Versuchen Sie, Ihre Lieblingsobjekte zu verwenden. Es ist sehr wahrscheinlich, dass sie bereits unterstützt werden.
|
Es gibt viele andere Objekte und Modelle, die automatisch zu JSON konvertiert werden (einschließlich ORMs, usw.). Versuchen Sie, Ihre Lieblingsobjekte zu verwenden. Es ist sehr wahrscheinlich, dass sie bereits unterstützt werden.
|
||||||
|
|
||||||
### Schritt 6: Deployen { #step-6-deploy-it }
|
|
||||||
|
|
||||||
Stellen Sie Ihre App in der **<a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>** mit einem Befehl bereit: `fastapi deploy`. 🎉
|
|
||||||
|
|
||||||
#### Über FastAPI Cloud { #about-fastapi-cloud }
|
|
||||||
|
|
||||||
**<a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>** wird vom selben Autor und Team hinter **FastAPI** entwickelt.
|
|
||||||
|
|
||||||
Es vereinfacht den Prozess des Erstellens, Deployens und des Zugriffs auf eine API mit minimalem Aufwand.
|
|
||||||
|
|
||||||
Es bringt die gleiche **Developer-Experience** beim Erstellen von Apps mit FastAPI auch zum **Deployment** in der Cloud. 🎉
|
|
||||||
|
|
||||||
FastAPI Cloud ist der Hauptsponsor und Finanzierer der „FastAPI and friends“ Open-Source-Projekte. ✨
|
|
||||||
|
|
||||||
#### Zu anderen Cloudanbietern deployen { #deploy-to-other-cloud-providers }
|
|
||||||
|
|
||||||
FastAPI ist Open Source und basiert auf Standards. Sie können FastAPI-Apps bei jedem Cloudanbieter Ihrer Wahl deployen.
|
|
||||||
|
|
||||||
Folgen Sie den Anleitungen Ihres Cloudanbieters, um dort FastAPI-Apps bereitzustellen. 🤓
|
|
||||||
|
|
||||||
## Zusammenfassung { #recap }
|
## Zusammenfassung { #recap }
|
||||||
|
|
||||||
* Importieren Sie `FastAPI`.
|
* Importieren Sie `FastAPI`.
|
||||||
|
|
@ -377,4 +321,3 @@ Folgen Sie den Anleitungen Ihres Cloudanbieters, um dort FastAPI-Apps bereitzust
|
||||||
* Schreiben Sie einen **Pfadoperation-Dekorator** unter Verwendung von Dekoratoren wie `@app.get("/")`.
|
* Schreiben Sie einen **Pfadoperation-Dekorator** unter Verwendung von Dekoratoren wie `@app.get("/")`.
|
||||||
* Definieren Sie eine **Pfadoperation-Funktion**, zum Beispiel `def root(): ...`.
|
* Definieren Sie eine **Pfadoperation-Funktion**, zum Beispiel `def root(): ...`.
|
||||||
* Starten Sie den Entwicklungsserver mit dem Befehl `fastapi dev`.
|
* Starten Sie den Entwicklungsserver mit dem Befehl `fastapi dev`.
|
||||||
* Optional: Ihre App mit `fastapi deploy` deployen.
|
|
||||||
|
|
|
||||||
|
|
@ -127,7 +127,7 @@ Um diesen zu überschreiben, importieren Sie den `RequestValidationError` und ve
|
||||||
|
|
||||||
Der Exceptionhandler erhält einen `Request` und die Exception.
|
Der Exceptionhandler erhält einen `Request` und die Exception.
|
||||||
|
|
||||||
{* ../../docs_src/handling_errors/tutorial004.py hl[2,14:19] *}
|
{* ../../docs_src/handling_errors/tutorial004.py hl[2,14:16] *}
|
||||||
|
|
||||||
Wenn Sie nun zu `/items/foo` gehen, erhalten Sie anstelle des standardmäßigen JSON-Fehlers mit:
|
Wenn Sie nun zu `/items/foo` gehen, erhalten Sie anstelle des standardmäßigen JSON-Fehlers mit:
|
||||||
|
|
||||||
|
|
@ -149,17 +149,36 @@ Wenn Sie nun zu `/items/foo` gehen, erhalten Sie anstelle des standardmäßigen
|
||||||
eine Textversion mit:
|
eine Textversion mit:
|
||||||
|
|
||||||
```
|
```
|
||||||
Validation errors:
|
1 validation error
|
||||||
Field: ('path', 'item_id'), Error: Input should be a valid integer, unable to parse string as an integer
|
path -> item_id
|
||||||
|
value is not a valid integer (type=type_error.integer)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### `RequestValidationError` vs. `ValidationError` { #requestvalidationerror-vs-validationerror }
|
||||||
|
|
||||||
|
/// warning | Achtung
|
||||||
|
|
||||||
|
Dies sind technische Details, die Sie überspringen können, wenn sie für Sie jetzt nicht wichtig sind.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
`RequestValidationError` ist eine Unterklasse von Pydantics <a href="https://docs.pydantic.dev/latest/concepts/models/#error-handling" class="external-link" target="_blank">`ValidationError`</a>.
|
||||||
|
|
||||||
|
**FastAPI** verwendet diesen so, dass, wenn Sie ein Pydantic-Modell in `response_model` verwenden und Ihre Daten einen Fehler haben, Sie den Fehler in Ihrem Log sehen.
|
||||||
|
|
||||||
|
Aber der Client/Benutzer wird ihn nicht sehen. Stattdessen erhält der Client einen „Internal Server Error“ mit einem HTTP-Statuscode `500`.
|
||||||
|
|
||||||
|
Es sollte so sein, denn wenn Sie einen Pydantic `ValidationError` in Ihrer *Response* oder irgendwo anders in Ihrem Code haben (nicht im *Request* des Clients), ist es tatsächlich ein Fehler in Ihrem Code.
|
||||||
|
|
||||||
|
Und während Sie den Fehler beheben, sollten Ihre Clients/Benutzer keinen Zugriff auf interne Informationen über den Fehler haben, da das eine Sicherheitslücke aufdecken könnte.
|
||||||
|
|
||||||
### Überschreiben des `HTTPException`-Fehlerhandlers { #override-the-httpexception-error-handler }
|
### Überschreiben des `HTTPException`-Fehlerhandlers { #override-the-httpexception-error-handler }
|
||||||
|
|
||||||
Auf die gleiche Weise können Sie den `HTTPException`-Handler überschreiben.
|
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:
|
Zum Beispiel könnten Sie eine Klartext-Response statt JSON für diese Fehler zurückgeben wollen:
|
||||||
|
|
||||||
{* ../../docs_src/handling_errors/tutorial004.py hl[3:4,9:11,25] *}
|
{* ../../docs_src/handling_errors/tutorial004.py hl[3:4,9:11,22] *}
|
||||||
|
|
||||||
/// note | Technische Details
|
/// note | Technische Details
|
||||||
|
|
||||||
|
|
@ -169,14 +188,6 @@ Sie könnten auch `from starlette.responses import PlainTextResponse` verwenden.
|
||||||
|
|
||||||
///
|
///
|
||||||
|
|
||||||
/// warning | Achtung
|
|
||||||
|
|
||||||
Beachten Sie, dass der `RequestValidationError` Informationen über den Dateinamen und die Zeile enthält, in der der Validierungsfehler auftritt, sodass Sie ihn bei Bedarf mit den relevanten Informationen in Ihren Logs anzeigen können.
|
|
||||||
|
|
||||||
Das bedeutet aber auch, dass, wenn Sie ihn einfach in einen String umwandeln und diese Informationen direkt zurückgeben, Sie möglicherweise ein paar Informationen über Ihr System preisgeben. Daher extrahiert und zeigt der Code hier jeden Fehler getrennt.
|
|
||||||
|
|
||||||
///
|
|
||||||
|
|
||||||
### Verwenden des `RequestValidationError`-Bodys { #use-the-requestvalidationerror-body }
|
### Verwenden des `RequestValidationError`-Bodys { #use-the-requestvalidationerror-body }
|
||||||
|
|
||||||
Der `RequestValidationError` enthält den empfangenen `body` mit den ungültigen Daten.
|
Der `RequestValidationError` enthält den empfangenen `body` mit den ungültigen Daten.
|
||||||
|
|
|
||||||
|
|
@ -65,7 +65,7 @@ Es gibt ein paar Unterschiede:
|
||||||
|
|
||||||
* `Field(primary_key=True)` sagt SQLModel, dass die `id` der **Primärschlüssel** in der SQL-Datenbank ist (Sie können mehr über SQL-Primärschlüssel in der SQLModel-Dokumentation erfahren).
|
* `Field(primary_key=True)` sagt SQLModel, dass die `id` der **Primärschlüssel** in der SQL-Datenbank ist (Sie können mehr über SQL-Primärschlüssel in der SQLModel-Dokumentation erfahren).
|
||||||
|
|
||||||
**Hinweis:** Wir verwenden für das Primärschlüsselfeld `int | None`, damit wir im Python-Code *ein Objekt ohne `id` erstellen* können (`id=None`), in der Annahme, dass die Datenbank sie *beim Speichern generiert*. SQLModel versteht, dass die Datenbank die `id` bereitstellt, und *definiert die Spalte im Datenbankschema als ein Nicht-Null-`INTEGER`*. Siehe die <a href="https://sqlmodel.tiangolo.com/tutorial/create-db-and-table/#primary-key-id" class="external-link" target="_blank">SQLModel-Dokumentation zu Primärschlüsseln</a> für Details.
|
Durch das Festlegen des Typs als `int | None` wird SQLModel wissen, dass diese Spalte ein `INTEGER` in der SQL-Datenbank sein sollte und dass sie `NULLABLE` sein sollte.
|
||||||
|
|
||||||
* `Field(index=True)` sagt SQLModel, dass es einen **SQL-Index** für diese Spalte erstellen soll, was schnelleres Suchen in der Datenbank ermöglicht, wenn Daten mittels dieser Spalte gefiltert werden.
|
* `Field(index=True)` sagt SQLModel, dass es einen **SQL-Index** für diese Spalte erstellen soll, was schnelleres Suchen in der Datenbank ermöglicht, wenn Daten mittels dieser Spalte gefiltert werden.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -122,13 +122,63 @@ Sie verfügt über eine `POST`-Operation, die mehrere Fehler zurückgeben könnt
|
||||||
|
|
||||||
Beide *Pfadoperationen* erfordern einen `X-Token`-Header.
|
Beide *Pfadoperationen* erfordern einen `X-Token`-Header.
|
||||||
|
|
||||||
{* ../../docs_src/app_testing/app_b_an_py310/main.py *}
|
//// tab | Python 3.10+
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!> ../../docs_src/app_testing/app_b_an_py310/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | Python 3.9+
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!> ../../docs_src/app_testing/app_b_an_py39/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | Python 3.8+
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!> ../../docs_src/app_testing/app_b_an/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | Python 3.10+ nicht annotiert
|
||||||
|
|
||||||
|
/// tip | Tipp
|
||||||
|
|
||||||
|
Bevorzugen Sie die `Annotated`-Version, falls möglich.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!> ../../docs_src/app_testing/app_b_py310/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | Python 3.8+ nicht annotiert
|
||||||
|
|
||||||
|
/// tip | Tipp
|
||||||
|
|
||||||
|
Bevorzugen Sie die `Annotated`-Version, falls möglich.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!> ../../docs_src/app_testing/app_b/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
### Erweiterte Testdatei { #extended-testing-file }
|
### Erweiterte Testdatei { #extended-testing-file }
|
||||||
|
|
||||||
Anschließend könnten Sie `test_main.py` mit den erweiterten Tests aktualisieren:
|
Anschließend könnten Sie `test_main.py` mit den erweiterten Tests aktualisieren:
|
||||||
|
|
||||||
{* ../../docs_src/app_testing/app_b_an_py310/test_main.py *}
|
{* ../../docs_src/app_testing/app_b/test_main.py *}
|
||||||
|
|
||||||
|
|
||||||
Wenn Sie möchten, dass der Client Informationen im Request übergibt und Sie nicht wissen, wie das geht, können Sie suchen (googeln), wie es mit `httpx` gemacht wird, oder sogar, wie es mit `requests` gemacht wird, da das Design von HTTPX auf dem Design von Requests basiert.
|
Wenn Sie möchten, dass der Client Informationen im Request übergibt und Sie nicht wissen, wie das geht, können Sie suchen (googeln), wie es mit `httpx` gemacht wird, oder sogar, wie es mit `requests` gemacht wird, da das Design von HTTPX auf dem Design von Requests basiert.
|
||||||
|
|
|
||||||
|
|
@ -242,26 +242,6 @@ $ python -m pip install --upgrade pip
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
/// tip | Tipp
|
|
||||||
|
|
||||||
Manchmal kann beim Versuch, `pip` zu aktualisieren, der Fehler **`No module named pip`** auftreten.
|
|
||||||
|
|
||||||
Wenn das passiert, installieren und aktualisieren Sie `pip` mit dem folgenden Befehl:
|
|
||||||
|
|
||||||
<div class="termy">
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ python -m ensurepip --upgrade
|
|
||||||
|
|
||||||
---> 100%
|
|
||||||
```
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Dieser Befehl installiert `pip`, falls es noch nicht installiert ist, und stellt außerdem sicher, dass die installierte Version von `pip` mindestens so aktuell ist wie die in `ensurepip` verfügbare.
|
|
||||||
|
|
||||||
///
|
|
||||||
|
|
||||||
## `.gitignore` hinzufügen { #add-gitignore }
|
## `.gitignore` hinzufügen { #add-gitignore }
|
||||||
|
|
||||||
Wenn Sie **Git** verwenden (was Sie sollten), fügen Sie eine `.gitignore`-Datei hinzu, um alles in Ihrem `.venv` von Git auszuschließen.
|
Wenn Sie **Git** verwenden (was Sie sollten), fügen Sie eine `.gitignore`-Datei hinzu, um alles in Ihrem `.venv` von Git auszuschließen.
|
||||||
|
|
|
||||||
|
|
@ -255,7 +255,6 @@ Below is a list of English terms and their preferred German translations, separa
|
||||||
* «the default value»: «der Defaultwert»
|
* «the default value»: «der Defaultwert»
|
||||||
* «the default value»: NOT «der Standardwert»
|
* «the default value»: NOT «der Standardwert»
|
||||||
* «the default declaration»: «die Default-Deklaration»
|
* «the default declaration»: «die Default-Deklaration»
|
||||||
* «the deployment»: «das Deployment»
|
|
||||||
* «the dict»: «das Dict»
|
* «the dict»: «das Dict»
|
||||||
* «the dictionary»: «das Dictionary»
|
* «the dictionary»: «das Dictionary»
|
||||||
* «the enumeration»: «die Enumeration»
|
* «the enumeration»: «die Enumeration»
|
||||||
|
|
@ -317,7 +316,6 @@ Below is a list of English terms and their preferred German translations, separa
|
||||||
* «the worker process»: «der Workerprozess»
|
* «the worker process»: «der Workerprozess»
|
||||||
* «the worker process»: NOT «der Arbeiterprozess»
|
* «the worker process»: NOT «der Arbeiterprozess»
|
||||||
* «to commit»: «committen»
|
* «to commit»: «committen»
|
||||||
* «to deploy» (in the cloud): «deployen»
|
|
||||||
* «to modify»: «ändern»
|
* «to modify»: «ändern»
|
||||||
* «to serve» (an application): «bereitstellen»
|
* «to serve» (an application): «bereitstellen»
|
||||||
* «to serve» (a response): «ausliefern»
|
* «to serve» (a response): «ausliefern»
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,247 @@
|
||||||
|
# 🌖 📨 🗄
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
👉 👍 🏧 ❔.
|
||||||
|
|
||||||
|
🚥 👆 ▶️ ⏮️ **FastAPI**, 👆 💪 🚫 💪 👉.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👆 💪 📣 🌖 📨, ⏮️ 🌖 👔 📟, 🔉 🆎, 📛, ♒️.
|
||||||
|
|
||||||
|
👈 🌖 📨 🔜 🔌 🗄 🔗, 👫 🔜 😑 🛠️ 🩺.
|
||||||
|
|
||||||
|
✋️ 👈 🌖 📨 👆 ✔️ ⚒ 💭 👆 📨 `Response` 💖 `JSONResponse` 🔗, ⏮️ 👆 👔 📟 & 🎚.
|
||||||
|
|
||||||
|
## 🌖 📨 ⏮️ `model`
|
||||||
|
|
||||||
|
👆 💪 🚶♀️ 👆 *➡ 🛠️ 👨🎨* 🔢 `responses`.
|
||||||
|
|
||||||
|
⚫️ 📨 `dict`, 🔑 👔 📟 🔠 📨, 💖 `200`, & 💲 🎏 `dict`Ⓜ ⏮️ ℹ 🔠 👫.
|
||||||
|
|
||||||
|
🔠 👈 📨 `dict`Ⓜ 💪 ✔️ 🔑 `model`, ⚗ Pydantic 🏷, 💖 `response_model`.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ✊ 👈 🏷, 🏗 🚮 🎻 🔗 & 🔌 ⚫️ ☑ 🥉 🗄.
|
||||||
|
|
||||||
|
🖼, 📣 ➕1️⃣ 📨 ⏮️ 👔 📟 `404` & Pydantic 🏷 `Message`, 👆 💪 ✍:
|
||||||
|
|
||||||
|
{* ../../docs_src/additional_responses/tutorial001.py hl[18,22] *}
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
✔️ 🤯 👈 👆 ✔️ 📨 `JSONResponse` 🔗.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
`model` 🔑 🚫 🍕 🗄.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ✊ Pydantic 🏷 ⚪️➡️ 📤, 🏗 `JSON Schema`, & 🚮 ⚫️ ☑ 🥉.
|
||||||
|
|
||||||
|
☑ 🥉:
|
||||||
|
|
||||||
|
* 🔑 `content`, 👈 ✔️ 💲 ➕1️⃣ 🎻 🎚 (`dict`) 👈 🔌:
|
||||||
|
* 🔑 ⏮️ 📻 🆎, ✅ `application/json`, 👈 🔌 💲 ➕1️⃣ 🎻 🎚, 👈 🔌:
|
||||||
|
* 🔑 `schema`, 👈 ✔️ 💲 🎻 🔗 ⚪️➡️ 🏷, 📥 ☑ 🥉.
|
||||||
|
* **FastAPI** 🚮 🔗 📥 🌐 🎻 🔗 ➕1️⃣ 🥉 👆 🗄 ↩️ ✅ ⚫️ 🔗. 👉 🌌, 🎏 🈸 & 👩💻 💪 ⚙️ 👈 🎻 🔗 🔗, 🚚 👻 📟 ⚡ 🧰, ♒️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🏗 📨 🗄 👉 *➡ 🛠️* 🔜:
|
||||||
|
|
||||||
|
```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"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
🔗 🔗 ➕1️⃣ 🥉 🔘 🗄 🔗:
|
||||||
|
|
||||||
|
```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"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌖 🔉 🆎 👑 📨
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 👉 🎏 `responses` 🔢 🚮 🎏 🔉 🆎 🎏 👑 📨.
|
||||||
|
|
||||||
|
🖼, 👆 💪 🚮 🌖 📻 🆎 `image/png`, 📣 👈 👆 *➡ 🛠️* 💪 📨 🎻 🎚 (⏮️ 📻 🆎 `application/json`) ⚖️ 🇩🇴 🖼:
|
||||||
|
|
||||||
|
{* ../../docs_src/additional_responses/tutorial002.py hl[19:24,28] *}
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
👀 👈 👆 ✔️ 📨 🖼 ⚙️ `FileResponse` 🔗.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🚥 👆 ✔ 🎏 📻 🆎 🎯 👆 `responses` 🔢, FastAPI 🔜 🤔 📨 ✔️ 🎏 📻 🆎 👑 📨 🎓 (🔢 `application/json`).
|
||||||
|
|
||||||
|
✋️ 🚥 👆 ✔️ ✔ 🛃 📨 🎓 ⏮️ `None` 🚮 📻 🆎, FastAPI 🔜 ⚙️ `application/json` 🙆 🌖 📨 👈 ✔️ 👨💼 🏷.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🌀 ℹ
|
||||||
|
|
||||||
|
👆 💪 🌀 📨 ℹ ⚪️➡️ 💗 🥉, 🔌 `response_model`, `status_code`, & `responses` 🔢.
|
||||||
|
|
||||||
|
👆 💪 📣 `response_model`, ⚙️ 🔢 👔 📟 `200` (⚖️ 🛃 1️⃣ 🚥 👆 💪), & ⤴️ 📣 🌖 ℹ 👈 🎏 📨 `responses`, 🔗 🗄 🔗.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 🚧 🌖 ℹ ⚪️➡️ `responses`, & 🌀 ⚫️ ⏮️ 🎻 🔗 ⚪️➡️ 👆 🏷.
|
||||||
|
|
||||||
|
🖼, 👆 💪 📣 📨 ⏮️ 👔 📟 `404` 👈 ⚙️ Pydantic 🏷 & ✔️ 🛃 `description`.
|
||||||
|
|
||||||
|
& 📨 ⏮️ 👔 📟 `200` 👈 ⚙️ 👆 `response_model`, ✋️ 🔌 🛃 `example`:
|
||||||
|
|
||||||
|
{* ../../docs_src/additional_responses/tutorial003.py hl[20:31] *}
|
||||||
|
|
||||||
|
⚫️ 🔜 🌐 🌀 & 🔌 👆 🗄, & 🎦 🛠️ 🩺:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/additional-responses/image01.png">
|
||||||
|
|
||||||
|
## 🌀 🔢 📨 & 🛃 🕐
|
||||||
|
|
||||||
|
👆 💪 💚 ✔️ 🔁 📨 👈 ✔ 📚 *➡ 🛠️*, ✋️ 👆 💚 🌀 👫 ⏮️ 🛃 📨 💚 🔠 *➡ 🛠️*.
|
||||||
|
|
||||||
|
📚 💼, 👆 💪 ⚙️ 🐍 ⚒ "🏗" `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.py hl[13:17,26] *}
|
||||||
|
|
||||||
|
## 🌖 ℹ 🔃 🗄 📨
|
||||||
|
|
||||||
|
👀 ⚫️❔ ⚫️❔ 👆 💪 🔌 📨, 👆 💪 ✅ 👉 📄 🗄 🔧:
|
||||||
|
|
||||||
|
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responsesObject" class="external-link" target="_blank">🗄 📨 🎚</a>, ⚫️ 🔌 `Response Object`.
|
||||||
|
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject" class="external-link" target="_blank">🗄 📨 🎚</a>, 👆 💪 🔌 🕳 ⚪️➡️ 👉 🔗 🔠 📨 🔘 👆 `responses` 🔢. ✅ `description`, `headers`, `content` (🔘 👉 👈 👆 📣 🎏 🔉 🆎 & 🎻 🔗), & `links`.
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# 🌖 👔 📟
|
||||||
|
|
||||||
|
🔢, **FastAPI** 🔜 📨 📨 ⚙️ `JSONResponse`, 🚮 🎚 👆 📨 ⚪️➡️ 👆 *➡ 🛠️* 🔘 👈 `JSONResponse`.
|
||||||
|
|
||||||
|
⚫️ 🔜 ⚙️ 🔢 👔 📟 ⚖️ 1️⃣ 👆 ⚒ 👆 *➡ 🛠️*.
|
||||||
|
|
||||||
|
## 🌖 👔 📟
|
||||||
|
|
||||||
|
🚥 👆 💚 📨 🌖 👔 📟 ↖️ ⚪️➡️ 👑 1️⃣, 👆 💪 👈 🛬 `Response` 🔗, 💖 `JSONResponse`, & ⚒ 🌖 👔 📟 🔗.
|
||||||
|
|
||||||
|
🖼, ➡️ 💬 👈 👆 💚 ✔️ *➡ 🛠️* 👈 ✔ ℹ 🏬, & 📨 🇺🇸🔍 👔 📟 2️⃣0️⃣0️⃣ "👌" 🕐❔ 🏆.
|
||||||
|
|
||||||
|
✋️ 👆 💚 ⚫️ 🚫 🆕 🏬. & 🕐❔ 🏬 🚫 🔀 ⏭, ⚫️ ✍ 👫, & 📨 🇺🇸🔍 👔 📟 2️⃣0️⃣1️⃣ "✍".
|
||||||
|
|
||||||
|
🏆 👈, 🗄 `JSONResponse`, & 📨 👆 🎚 📤 🔗, ⚒ `status_code` 👈 👆 💚:
|
||||||
|
|
||||||
|
{* ../../docs_src/additional_status_codes/tutorial001.py hl[4,25] *}
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
🕐❔ 👆 📨 `Response` 🔗, 💖 🖼 🔛, ⚫️ 🔜 📨 🔗.
|
||||||
|
|
||||||
|
⚫️ 🏆 🚫 🎻 ⏮️ 🏷, ♒️.
|
||||||
|
|
||||||
|
⚒ 💭 ⚫️ ✔️ 📊 👆 💚 ⚫️ ✔️, & 👈 💲 ☑ 🎻 (🚥 👆 ⚙️ `JSONResponse`).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.responses import JSONResponse`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 🎏 `starlette.responses` `fastapi.responses` 🏪 👆, 👩💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃. 🎏 ⏮️ `status`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🗄 & 🛠️ 🩺
|
||||||
|
|
||||||
|
🚥 👆 📨 🌖 👔 📟 & 📨 🔗, 👫 🏆 🚫 🔌 🗄 🔗 (🛠️ 🩺), ↩️ FastAPI 🚫 ✔️ 🌌 💭 ⏪ ⚫️❔ 👆 🚶 📨.
|
||||||
|
|
||||||
|
✋️ 👆 💪 📄 👈 👆 📟, ⚙️: [🌖 📨](additional-responses.md){.internal-link target=_blank}.
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
# 🏧 🔗
|
||||||
|
|
||||||
|
## 🔗 🔗
|
||||||
|
|
||||||
|
🌐 🔗 👥 ✔️ 👀 🔧 🔢 ⚖️ 🎓.
|
||||||
|
|
||||||
|
✋️ 📤 💪 💼 🌐❔ 👆 💚 💪 ⚒ 🔢 🔛 🔗, 🍵 ✔️ 📣 📚 🎏 🔢 ⚖️ 🎓.
|
||||||
|
|
||||||
|
➡️ 🌈 👈 👥 💚 ✔️ 🔗 👈 ✅ 🚥 🔢 🔢 `q` 🔌 🔧 🎚.
|
||||||
|
|
||||||
|
✋️ 👥 💚 💪 🔗 👈 🔧 🎚.
|
||||||
|
|
||||||
|
## "🇧🇲" 👐
|
||||||
|
|
||||||
|
🐍 📤 🌌 ⚒ 👐 🎓 "🇧🇲".
|
||||||
|
|
||||||
|
🚫 🎓 ⚫️ (❔ ⏪ 🇧🇲), ✋️ 👐 👈 🎓.
|
||||||
|
|
||||||
|
👈, 👥 📣 👩🔬 `__call__`:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial011.py hl[10] *}
|
||||||
|
|
||||||
|
👉 💼, 👉 `__call__` ⚫️❔ **FastAPI** 🔜 ⚙️ ✅ 🌖 🔢 & 🎧-🔗, & 👉 ⚫️❔ 🔜 🤙 🚶♀️ 💲 🔢 👆 *➡ 🛠️ 🔢* ⏪.
|
||||||
|
|
||||||
|
## 🔗 👐
|
||||||
|
|
||||||
|
& 🔜, 👥 💪 ⚙️ `__init__` 📣 🔢 👐 👈 👥 💪 ⚙️ "🔗" 🔗:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial011.py hl[7] *}
|
||||||
|
|
||||||
|
👉 💼, **FastAPI** 🏆 🚫 ⏱ 👆 ⚖️ 💅 🔃 `__init__`, 👥 🔜 ⚙️ ⚫️ 🔗 👆 📟.
|
||||||
|
|
||||||
|
## ✍ 👐
|
||||||
|
|
||||||
|
👥 💪 ✍ 👐 👉 🎓 ⏮️:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial011.py hl[16] *}
|
||||||
|
|
||||||
|
& 👈 🌌 👥 💪 "🔗" 👆 🔗, 👈 🔜 ✔️ `"bar"` 🔘 ⚫️, 🔢 `checker.fixed_content`.
|
||||||
|
|
||||||
|
## ⚙️ 👐 🔗
|
||||||
|
|
||||||
|
⤴️, 👥 💪 ⚙️ 👉 `checker` `Depends(checker)`, ↩️ `Depends(FixedContentQueryChecker)`, ↩️ 🔗 👐, `checker`, 🚫 🎓 ⚫️.
|
||||||
|
|
||||||
|
& 🕐❔ ❎ 🔗, **FastAPI** 🔜 🤙 👉 `checker` 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
checker(q="somequery")
|
||||||
|
```
|
||||||
|
|
||||||
|
...& 🚶♀️ ⚫️❔ 👈 📨 💲 🔗 👆 *➡ 🛠️ 🔢* 🔢 `fixed_content_included`:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial011.py hl[20] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🌐 👉 💪 😑 🎭. & ⚫️ 💪 🚫 📶 🆑 ❔ ⚫️ ⚠.
|
||||||
|
|
||||||
|
👫 🖼 😫 🙅, ✋️ 🎦 ❔ ⚫️ 🌐 👷.
|
||||||
|
|
||||||
|
📃 🔃 💂♂, 📤 🚙 🔢 👈 🛠️ 👉 🎏 🌌.
|
||||||
|
|
||||||
|
🚥 👆 🤔 🌐 👉, 👆 ⏪ 💭 ❔ 👈 🚙 🧰 💂♂ 👷 🔘.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,93 @@
|
||||||
|
# 🔁 💯
|
||||||
|
|
||||||
|
👆 ✔️ ⏪ 👀 ❔ 💯 👆 **FastAPI** 🈸 ⚙️ 🚚 `TestClient`. 🆙 🔜, 👆 ✔️ 🕴 👀 ❔ ✍ 🔁 💯, 🍵 ⚙️ `async` 🔢.
|
||||||
|
|
||||||
|
➖ 💪 ⚙️ 🔁 🔢 👆 💯 💪 ⚠, 🖼, 🕐❔ 👆 🔬 👆 💽 🔁. 🌈 👆 💚 💯 📨 📨 👆 FastAPI 🈸 & ⤴️ ✔ 👈 👆 👩💻 ⏪ ✍ ☑ 💽 💽, ⏪ ⚙️ 🔁 💽 🗃.
|
||||||
|
|
||||||
|
➡️ 👀 ❔ 👥 💪 ⚒ 👈 👷.
|
||||||
|
|
||||||
|
## pytest.mark.anyio
|
||||||
|
|
||||||
|
🚥 👥 💚 🤙 🔁 🔢 👆 💯, 👆 💯 🔢 ✔️ 🔁. AnyIO 🚚 👌 📁 👉, 👈 ✔ 👥 ✔ 👈 💯 🔢 🤙 🔁.
|
||||||
|
|
||||||
|
## 🇸🇲
|
||||||
|
|
||||||
|
🚥 👆 **FastAPI** 🈸 ⚙️ 😐 `def` 🔢 ↩️ `async def`, ⚫️ `async` 🈸 🔘.
|
||||||
|
|
||||||
|
`TestClient` 🔨 🎱 🔘 🤙 🔁 FastAPI 🈸 👆 😐 `def` 💯 🔢, ⚙️ 🐩 ✳. ✋️ 👈 🎱 🚫 👷 🚫🔜 🕐❔ 👥 ⚙️ ⚫️ 🔘 🔁 🔢. 🏃 👆 💯 🔁, 👥 💪 🙅♂ 📏 ⚙️ `TestClient` 🔘 👆 💯 🔢.
|
||||||
|
|
||||||
|
`TestClient` ⚓️ 🔛 <a href="https://www.python-httpx.org" class="external-link" target="_blank">🇸🇲</a>, & ↩️, 👥 💪 ⚙️ ⚫️ 🔗 💯 🛠️.
|
||||||
|
|
||||||
|
## 🖼
|
||||||
|
|
||||||
|
🙅 🖼, ➡️ 🤔 📁 📊 🎏 1️⃣ 🔬 [🦏 🈸](../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/main.py *}
|
||||||
|
|
||||||
|
📁 `test_main.py` 🔜 ✔️ 💯 `main.py`, ⚫️ 💪 👀 💖 👉 🔜:
|
||||||
|
|
||||||
|
{* ../../docs_src/async_tests/test_main.py *}
|
||||||
|
|
||||||
|
## 🏃 ⚫️
|
||||||
|
|
||||||
|
👆 💪 🏃 👆 💯 🐌 📨:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pytest
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## ℹ
|
||||||
|
|
||||||
|
📑 `@pytest.mark.anyio` 💬 ✳ 👈 👉 💯 🔢 🔜 🤙 🔁:
|
||||||
|
|
||||||
|
{* ../../docs_src/async_tests/test_main.py hl[7] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🗒 👈 💯 🔢 🔜 `async def` ↩️ `def` ⏭ 🕐❔ ⚙️ `TestClient`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
⤴️ 👥 💪 ✍ `AsyncClient` ⏮️ 📱, & 📨 🔁 📨 ⚫️, ⚙️ `await`.
|
||||||
|
|
||||||
|
{* ../../docs_src/async_tests/test_main.py hl[9:12] *}
|
||||||
|
|
||||||
|
👉 🌓:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
response = client.get('/')
|
||||||
|
```
|
||||||
|
|
||||||
|
...👈 👥 ⚙️ ⚒ 👆 📨 ⏮️ `TestClient`.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🗒 👈 👥 ⚙️ 🔁/⌛ ⏮️ 🆕 `AsyncClient` - 📨 🔁.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🎏 🔁 🔢 🤙
|
||||||
|
|
||||||
|
🔬 🔢 🔜 🔁, 👆 💪 🔜 🤙 (& `await`) 🎏 `async` 🔢 ↖️ ⚪️➡️ 📨 📨 👆 FastAPI 🈸 👆 💯, ⚫️❔ 👆 🔜 🤙 👫 🙆 🙆 👆 📟.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 ⚔ `RuntimeError: Task attached to a different loop` 🕐❔ 🛠️ 🔁 🔢 🤙 👆 💯 (✅ 🕐❔ ⚙️ <a href="https://stackoverflow.com/questions/41584243/runtimeerror-task-attached-to-a-different-loop" class="external-link" target="_blank">✳ MotorClient</a>) 💭 🔗 🎚 👈 💪 🎉 ➰ 🕴 🏞 🔁 🔢, ✅ `'@app.on_event("startup")` ⏲.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,359 @@
|
||||||
|
# ⛅ 🗳
|
||||||
|
|
||||||
|
⚠, 👆 5️⃣📆 💪 ⚙️ **🗳** 💽 💖 Traefik ⚖️ 👌 ⏮️ 📳 👈 🚮 ➕ ➡ 🔡 👈 🚫 👀 👆 🈸.
|
||||||
|
|
||||||
|
👫 💼 👆 💪 ⚙️ `root_path` 🔗 👆 🈸.
|
||||||
|
|
||||||
|
`root_path` 🛠️ 🚚 🔫 🔧 (👈 FastAPI 🏗 🔛, 🔘 💃).
|
||||||
|
|
||||||
|
`root_path` ⚙️ 🍵 👫 🎯 💼.
|
||||||
|
|
||||||
|
& ⚫️ ⚙️ 🔘 🕐❔ 🗜 🎧-🈸.
|
||||||
|
|
||||||
|
## 🗳 ⏮️ 🎞 ➡ 🔡
|
||||||
|
|
||||||
|
✔️ 🗳 ⏮️ 🎞 ➡ 🔡, 👉 💼, ⛓ 👈 👆 💪 📣 ➡ `/app` 👆 📟, ✋️ ⤴️, 👆 🚮 🧽 🔛 🔝 (🗳) 👈 🔜 🚮 👆 **FastAPI** 🈸 🔽 ➡ 💖 `/api/v1`.
|
||||||
|
|
||||||
|
👉 💼, ⏮️ ➡ `/app` 🔜 🤙 🍦 `/api/v1/app`.
|
||||||
|
|
||||||
|
✋️ 🌐 👆 📟 ✍ 🤔 📤 `/app`.
|
||||||
|
|
||||||
|
& 🗳 🔜 **"❎"** **➡ 🔡** 🔛 ✈ ⏭ 📶 📨 Uvicorn, 🚧 👆 🈸 🤔 👈 ⚫️ 🍦 `/app`, 👈 👆 🚫 ✔️ ℹ 🌐 👆 📟 🔌 🔡 `/api/v1`.
|
||||||
|
|
||||||
|
🆙 📥, 🌐 🔜 👷 🛎.
|
||||||
|
|
||||||
|
✋️ ⤴️, 🕐❔ 👆 📂 🛠️ 🩺 🎚 (🕸), ⚫️ 🔜 ⌛ 🤚 🗄 🔗 `/openapi.json`, ↩️ `/api/v1/openapi.json`.
|
||||||
|
|
||||||
|
, 🕸 (👈 🏃 🖥) 🔜 🔄 🏆 `/openapi.json` & 🚫🔜 💪 🤚 🗄 🔗.
|
||||||
|
|
||||||
|
↩️ 👥 ✔️ 🗳 ⏮️ ➡ 🔡 `/api/v1` 👆 📱, 🕸 💪 ☕ 🗄 🔗 `/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
|
||||||
|
|
||||||
|
📢 `0.0.0.0` 🛎 ⚙️ ⛓ 👈 📋 👂 🔛 🌐 📢 💪 👈 🎰/💽.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🩺 🎚 🔜 💪 🗄 🔗 📣 👈 👉 🛠️ `server` 🔎 `/api/v1` (⛅ 🗳). 🖼:
|
||||||
|
|
||||||
|
```JSON hl_lines="4-8"
|
||||||
|
{
|
||||||
|
"openapi": "3.0.2",
|
||||||
|
// More stuff here
|
||||||
|
"servers": [
|
||||||
|
{
|
||||||
|
"url": "/api/v1"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"paths": {
|
||||||
|
// More stuff here
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
👉 🖼, "🗳" 💪 🕳 💖 **Traefik**. & 💽 🔜 🕳 💖 **Uvicorn**, 🏃♂ 👆 FastAPI 🈸.
|
||||||
|
|
||||||
|
### 🚚 `root_path`
|
||||||
|
|
||||||
|
🏆 👉, 👆 💪 ⚙️ 📋 ⏸ 🎛 `--root-path` 💖:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --root-path /api/v1
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ Hypercorn, ⚫️ ✔️ 🎛 `--root-path`.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
🔫 🔧 🔬 `root_path` 👉 ⚙️ 💼.
|
||||||
|
|
||||||
|
& `--root-path` 📋 ⏸ 🎛 🚚 👈 `root_path`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ✅ ⏮️ `root_path`
|
||||||
|
|
||||||
|
👆 💪 🤚 ⏮️ `root_path` ⚙️ 👆 🈸 🔠 📨, ⚫️ 🍕 `scope` 📖 (👈 🍕 🔫 🔌).
|
||||||
|
|
||||||
|
📥 👥 ✅ ⚫️ 📧 🎦 🎯.
|
||||||
|
|
||||||
|
{* ../../docs_src/behind_a_proxy/tutorial001.py hl[8] *}
|
||||||
|
|
||||||
|
⤴️, 🚥 👆 ▶️ Uvicorn ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --root-path /api/v1
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
📨 🔜 🕳 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"message": "Hello World",
|
||||||
|
"root_path": "/api/v1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### ⚒ `root_path` FastAPI 📱
|
||||||
|
|
||||||
|
👐, 🚥 👆 🚫 ✔️ 🌌 🚚 📋 ⏸ 🎛 💖 `--root-path` ⚖️ 🌓, 👆 💪 ⚒ `root_path` 🔢 🕐❔ 🏗 👆 FastAPI 📱:
|
||||||
|
|
||||||
|
{* ../../docs_src/behind_a_proxy/tutorial002.py hl[3] *}
|
||||||
|
|
||||||
|
🚶♀️ `root_path` `FastAPI` 🔜 🌓 🚶♀️ `--root-path` 📋 ⏸ 🎛 Uvicorn ⚖️ Hypercorn.
|
||||||
|
|
||||||
|
### 🔃 `root_path`
|
||||||
|
|
||||||
|
✔️ 🤯 👈 💽 (Uvicorn) 🏆 🚫 ⚙️ 👈 `root_path` 🕳 🙆 🌘 🚶♀️ ⚫️ 📱.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 🚶 ⏮️ 👆 🖥 <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000/app</a> 👆 🔜 👀 😐 📨:
|
||||||
|
|
||||||
|
```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` 🔡 🔛 🔝.
|
||||||
|
|
||||||
|
## 🔃 🗳 ⏮️ 🎞 ➡ 🔡
|
||||||
|
|
||||||
|
✔️ 🤯 👈 🗳 ⏮️ 🎞 ➡ 🔡 🕴 1️⃣ 🌌 🔗 ⚫️.
|
||||||
|
|
||||||
|
🎲 📚 💼 🔢 🔜 👈 🗳 🚫 ✔️ 🏚 ➡ 🔡.
|
||||||
|
|
||||||
|
💼 💖 👈 (🍵 🎞 ➡ 🔡), 🗳 🔜 👂 🔛 🕳 💖 `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
|
||||||
|
|
||||||
|
👆 💪 💪 🏃 🥼 🌐 ⏮️ 🎞 ➡ 🔡 ⚙️ <a href="https://docs.traefik.io/" class="external-link" target="_blank">Traefik</a>.
|
||||||
|
|
||||||
|
<a href="https://github.com/containous/traefik/releases" class="external-link" target="_blank">⏬ Traefik</a>, ⚫️ 👁 💱, 👆 💪 ⚗ 🗜 📁 & 🏃 ⚫️ 🔗 ⚪️➡️ 📶.
|
||||||
|
|
||||||
|
⤴️ ✍ 📁 `traefik.toml` ⏮️:
|
||||||
|
|
||||||
|
```TOML hl_lines="3"
|
||||||
|
[entryPoints]
|
||||||
|
[entryPoints.http]
|
||||||
|
address = ":9999"
|
||||||
|
|
||||||
|
[providers]
|
||||||
|
[providers.file]
|
||||||
|
filename = "routes.toml"
|
||||||
|
```
|
||||||
|
|
||||||
|
👉 💬 Traefik 👂 🔛 ⛴ 9️⃣9️⃣9️⃣9️⃣ & ⚙️ ➕1️⃣ 📁 `routes.toml`.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👥 ⚙️ ⛴ 9️⃣9️⃣9️⃣9️⃣ ↩️ 🐩 🇺🇸🔍 ⛴ 8️⃣0️⃣ 👈 👆 🚫 ✔️ 🏃 ⚫️ ⏮️ 📡 (`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`.
|
||||||
|
|
||||||
|
& ⤴️ ⚫️ 🔜 ❎ 🚮 📨 👆 Uvicorn 🏃♂ 🔛 `http://127.0.0.1:8000`.
|
||||||
|
|
||||||
|
🔜 ▶️ Traefik:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ ./traefik --configFile=traefik.toml
|
||||||
|
|
||||||
|
INFO[0000] Configuration loaded from file: /home/user/awesomeapi/traefik.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
& 🔜 ▶️ 👆 📱 ⏮️ Uvicorn, ⚙️ `--root-path` 🎛:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --root-path /api/v1
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
### ✅ 📨
|
||||||
|
|
||||||
|
🔜, 🚥 👆 🚶 📛 ⏮️ ⛴ Uvicorn: <a href="http://127.0.0.1:8000/app" class="external-link" target="_blank">http://127.0.0.1:8000/app</a>, 👆 🔜 👀 😐 📨:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"message": "Hello World",
|
||||||
|
"root_path": "/api/v1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 👈 ✋️ 👆 🔐 ⚫️ `http://127.0.0.1:8000/app` ⚫️ 🎦 `root_path` `/api/v1`, ✊ ⚪️➡️ 🎛 `--root-path`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
& 🔜 📂 📛 ⏮️ ⛴ Traefik, ✅ ➡ 🔡: <a href="http://127.0.0.1:9999/api/v1/app" class="external-link" target="_blank">http://127.0.0.1:9999/api/v1/app</a>.
|
||||||
|
|
||||||
|
👥 🤚 🎏 📨:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"message": "Hello World",
|
||||||
|
"root_path": "/api/v1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
✋️ 👉 🕰 📛 ⏮️ 🔡 ➡ 🚚 🗳: `/api/v1`.
|
||||||
|
|
||||||
|
↗️, 💭 📥 👈 👱 🔜 🔐 📱 🔘 🗳, ⏬ ⏮️ ➡ 🔡 `/app/v1` "☑" 1️⃣.
|
||||||
|
|
||||||
|
& ⏬ 🍵 ➡ 🔡 (`http://127.0.0.1:8000/app`), 🚚 Uvicorn 🔗, 🔜 🎯 _🗳_ (Traefik) 🔐 ⚫️.
|
||||||
|
|
||||||
|
👈 🎦 ❔ 🗳 (Traefik) ⚙️ ➡ 🔡 & ❔ 💽 (Uvicorn) ⚙️ `root_path` ⚪️➡️ 🎛 `--root-path`.
|
||||||
|
|
||||||
|
### ✅ 🩺 🎚
|
||||||
|
|
||||||
|
✋️ 📥 🎊 🍕. 👶
|
||||||
|
|
||||||
|
"🛂" 🌌 🔐 📱 🔜 🔘 🗳 ⏮️ ➡ 🔡 👈 👥 🔬. , 👥 🔜 ⌛, 🚥 👆 🔄 🩺 🎚 🍦 Uvicorn 🔗, 🍵 ➡ 🔡 📛, ⚫️ 🏆 🚫 👷, ↩️ ⚫️ ⌛ 🔐 🔘 🗳.
|
||||||
|
|
||||||
|
👆 💪 ✅ ⚫️ <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/behind-a-proxy/image01.png">
|
||||||
|
|
||||||
|
✋️ 🚥 👥 🔐 🩺 🎚 "🛂" 📛 ⚙️ 🗳 ⏮️ ⛴ `9999`, `/api/v1/docs`, ⚫️ 👷 ☑ ❗ 👶
|
||||||
|
|
||||||
|
👆 💪 ✅ ⚫️ <a href="http://127.0.0.1:9999/api/v1/docs" class="external-link" target="_blank">http://127.0.0.1:9999/api/v1/docs</a>:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/behind-a-proxy/image02.png">
|
||||||
|
|
||||||
|
▶️️ 👥 💚 ⚫️. 👶 👶
|
||||||
|
|
||||||
|
👉 ↩️ FastAPI ⚙️ 👉 `root_path` ✍ 🔢 `server` 🗄 ⏮️ 📛 🚚 `root_path`.
|
||||||
|
|
||||||
|
## 🌖 💽
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
👉 🌅 🏧 ⚙️ 💼. 💭 🆓 🚶 ⚫️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🔢, **FastAPI** 🔜 ✍ `server` 🗄 🔗 ⏮️ 📛 `root_path`.
|
||||||
|
|
||||||
|
✋️ 👆 💪 🚚 🎏 🎛 `servers`, 🖼 🚥 👆 💚 *🎏* 🩺 🎚 🔗 ⏮️ 🏗 & 🏭 🌐.
|
||||||
|
|
||||||
|
🚥 👆 🚶♀️ 🛃 📇 `servers` & 📤 `root_path` (↩️ 👆 🛠️ 👨❤👨 ⛅ 🗳), **FastAPI** 🔜 📩 "💽" ⏮️ 👉 `root_path` ▶️ 📇.
|
||||||
|
|
||||||
|
🖼:
|
||||||
|
|
||||||
|
{* ../../docs_src/behind_a_proxy/tutorial003.py hl[4:7] *}
|
||||||
|
|
||||||
|
🔜 🏗 🗄 🔗 💖:
|
||||||
|
|
||||||
|
```JSON hl_lines="5-7"
|
||||||
|
{
|
||||||
|
"openapi": "3.0.2",
|
||||||
|
// More stuff here
|
||||||
|
"servers": [
|
||||||
|
{
|
||||||
|
"url": "/api/v1"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"url": "https://stag.example.com",
|
||||||
|
"description": "Staging environment"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"url": "https://prod.example.com",
|
||||||
|
"description": "Production environment"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"paths": {
|
||||||
|
// More stuff here
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 🚘-🏗 💽 ⏮️ `url` 💲 `/api/v1`, ✊ ⚪️➡️ `root_path`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🩺 🎚 <a href="http://127.0.0.1:9999/api/v1/docs" class="external-link" target="_blank">http://127.0.0.1:9999/api/v1/docs</a> ⚫️ 🔜 👀 💖:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/behind-a-proxy/image03.png">
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🩺 🎚 🔜 🔗 ⏮️ 💽 👈 👆 🖊.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ❎ 🏧 💽 ⚪️➡️ `root_path`
|
||||||
|
|
||||||
|
🚥 👆 🚫 💚 **FastAPI** 🔌 🏧 💽 ⚙️ `root_path`, 👆 💪 ⚙️ 🔢 `root_path_in_servers=False`:
|
||||||
|
|
||||||
|
{* ../../docs_src/behind_a_proxy/tutorial004.py hl[9] *}
|
||||||
|
|
||||||
|
& ⤴️ ⚫️ 🏆 🚫 🔌 ⚫️ 🗄 🔗.
|
||||||
|
|
||||||
|
## 🗜 🎧-🈸
|
||||||
|
|
||||||
|
🚥 👆 💪 🗻 🎧-🈸 (🔬 [🎧 🈸 - 🗻](sub-applications.md){.internal-link target=_blank}) ⏪ ⚙️ 🗳 ⏮️ `root_path`, 👆 💪 ⚫️ 🛎, 👆 🔜 ⌛.
|
||||||
|
|
||||||
|
FastAPI 🔜 🔘 ⚙️ `root_path` 🎆, ⚫️ 🔜 👷. 👶
|
||||||
|
|
@ -0,0 +1,303 @@
|
||||||
|
# 🛃 📨 - 🕸, 🎏, 📁, 🎏
|
||||||
|
|
||||||
|
🔢, **FastAPI** 🔜 📨 📨 ⚙️ `JSONResponse`.
|
||||||
|
|
||||||
|
👆 💪 🔐 ⚫️ 🛬 `Response` 🔗 👀 [📨 📨 🔗](response-directly.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 📨 `Response` 🔗, 📊 🏆 🚫 🔁 🗜, & 🧾 🏆 🚫 🔁 🏗 (🖼, 🔌 🎯 "📻 🆎", 🇺🇸🔍 🎚 `Content-Type` 🍕 🏗 🗄).
|
||||||
|
|
||||||
|
✋️ 👆 💪 📣 `Response` 👈 👆 💚 ⚙️, *➡ 🛠️ 👨🎨*.
|
||||||
|
|
||||||
|
🎚 👈 👆 📨 ⚪️➡️ 👆 *➡ 🛠️ 🔢* 🔜 🚮 🔘 👈 `Response`.
|
||||||
|
|
||||||
|
& 🚥 👈 `Response` ✔️ 🎻 📻 🆎 (`application/json`), 💖 💼 ⏮️ `JSONResponse` & `UJSONResponse`, 💽 👆 📨 🔜 🔁 🗜 (& ⛽) ⏮️ 🙆 Pydantic `response_model` 👈 👆 📣 *➡ 🛠️ 👨🎨*.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 📨 🎓 ⏮️ 🙅♂ 📻 🆎, FastAPI 🔜 ⌛ 👆 📨 ✔️ 🙅♂ 🎚, ⚫️ 🔜 🚫 📄 📨 📁 🚮 🏗 🗄 🩺.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⚙️ `ORJSONResponse`
|
||||||
|
|
||||||
|
🖼, 🚥 👆 ✊ 🎭, 👆 💪 ❎ & ⚙️ <a href="https://github.com/ijl/orjson" class="external-link" target="_blank">`orjson`</a> & ⚒ 📨 `ORJSONResponse`.
|
||||||
|
|
||||||
|
🗄 `Response` 🎓 (🎧-🎓) 👆 💚 ⚙️ & 📣 ⚫️ *➡ 🛠️ 👨🎨*.
|
||||||
|
|
||||||
|
⭕ 📨, 📨 `Response` 🔗 🌅 ⏩ 🌘 🛬 📖.
|
||||||
|
|
||||||
|
👉 ↩️ 🔢, FastAPI 🔜 ✔ 🔠 🏬 🔘 & ⚒ 💭 ⚫️ 🎻 ⏮️ 🎻, ⚙️ 🎏 [🎻 🔗 🔢](../tutorial/encoder.md){.internal-link target=_blank} 🔬 🔰. 👉 ⚫️❔ ✔ 👆 📨 **❌ 🎚**, 🖼 💽 🏷.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 🎯 👈 🎚 👈 👆 🛬 **🎻 ⏮️ 🎻**, 👆 💪 🚶♀️ ⚫️ 🔗 📨 🎓 & ❎ ➕ 🌥 👈 FastAPI 🔜 ✔️ 🚶♀️ 👆 📨 🎚 🔘 `jsonable_encoder` ⏭ 🚶♀️ ⚫️ 📨 🎓.
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial001b.py hl[2,7] *}
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🔢 `response_class` 🔜 ⚙️ 🔬 "📻 🆎" 📨.
|
||||||
|
|
||||||
|
👉 💼, 🇺🇸🔍 🎚 `Content-Type` 🔜 ⚒ `application/json`.
|
||||||
|
|
||||||
|
& ⚫️ 🔜 📄 ✅ 🗄.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
`ORJSONResponse` ⏳ 🕴 💪 FastAPI, 🚫 💃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🕸 📨
|
||||||
|
|
||||||
|
📨 📨 ⏮️ 🕸 🔗 ⚪️➡️ **FastAPI**, ⚙️ `HTMLResponse`.
|
||||||
|
|
||||||
|
* 🗄 `HTMLResponse`.
|
||||||
|
* 🚶♀️ `HTMLResponse` 🔢 `response_class` 👆 *➡ 🛠️ 👨🎨*.
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial002.py hl[2,7] *}
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🔢 `response_class` 🔜 ⚙️ 🔬 "📻 🆎" 📨.
|
||||||
|
|
||||||
|
👉 💼, 🇺🇸🔍 🎚 `Content-Type` 🔜 ⚒ `text/html`.
|
||||||
|
|
||||||
|
& ⚫️ 🔜 📄 ✅ 🗄.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 📨 `Response`
|
||||||
|
|
||||||
|
👀 [📨 📨 🔗](response-directly.md){.internal-link target=_blank}, 👆 💪 🔐 📨 🔗 👆 *➡ 🛠️*, 🛬 ⚫️.
|
||||||
|
|
||||||
|
🎏 🖼 ⚪️➡️ 🔛, 🛬 `HTMLResponse`, 💪 👀 💖:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial003.py hl[2,7,19] *}
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
`Response` 📨 🔗 👆 *➡ 🛠️ 🔢* 🏆 🚫 📄 🗄 (🖼, `Content-Type` 🏆 🚫 📄) & 🏆 🚫 ⭐ 🏧 🎓 🩺.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
↗️, ☑ `Content-Type` 🎚, 👔 📟, ♒️, 🔜 👟 ⚪️➡️ `Response` 🎚 👆 📨.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 📄 🗄 & 🔐 `Response`
|
||||||
|
|
||||||
|
🚥 👆 💚 🔐 📨 ⚪️➡️ 🔘 🔢 ✋️ 🎏 🕰 📄 "📻 🆎" 🗄, 👆 💪 ⚙️ `response_class` 🔢 & 📨 `Response` 🎚.
|
||||||
|
|
||||||
|
`response_class` 🔜 ⤴️ ⚙️ 🕴 📄 🗄 *➡ 🛠️*, ✋️ 👆 `Response` 🔜 ⚙️.
|
||||||
|
|
||||||
|
#### 📨 `HTMLResponse` 🔗
|
||||||
|
|
||||||
|
🖼, ⚫️ 💪 🕳 💖:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial004.py hl[7,21,23] *}
|
||||||
|
|
||||||
|
👉 🖼, 🔢 `generate_html_response()` ⏪ 🏗 & 📨 `Response` ↩️ 🛬 🕸 `str`.
|
||||||
|
|
||||||
|
🛬 🏁 🤙 `generate_html_response()`, 👆 ⏪ 🛬 `Response` 👈 🔜 🔐 🔢 **FastAPI** 🎭.
|
||||||
|
|
||||||
|
✋️ 👆 🚶♀️ `HTMLResponse` `response_class` 💁♂️, **FastAPI** 🔜 💭 ❔ 📄 ⚫️ 🗄 & 🎓 🩺 🕸 ⏮️ `text/html`:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/custom-response/image01.png">
|
||||||
|
|
||||||
|
## 💪 📨
|
||||||
|
|
||||||
|
📥 💪 📨.
|
||||||
|
|
||||||
|
✔️ 🤯 👈 👆 💪 ⚙️ `Response` 📨 🕳 🙆, ⚖️ ✍ 🛃 🎧-🎓.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.responses import HTMLResponse`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 🎏 `starlette.responses` `fastapi.responses` 🏪 👆, 👩💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### `Response`
|
||||||
|
|
||||||
|
👑 `Response` 🎓, 🌐 🎏 📨 😖 ⚪️➡️ ⚫️.
|
||||||
|
|
||||||
|
👆 💪 📨 ⚫️ 🔗.
|
||||||
|
|
||||||
|
⚫️ 🚫 📄 🔢:
|
||||||
|
|
||||||
|
* `content` - `str` ⚖️ `bytes`.
|
||||||
|
* `status_code` - `int` 🇺🇸🔍 👔 📟.
|
||||||
|
* `headers` - `dict` 🎻.
|
||||||
|
* `media_type` - `str` 🤝 📻 🆎. 🤶 Ⓜ. `"text/html"`.
|
||||||
|
|
||||||
|
FastAPI (🤙 💃) 🔜 🔁 🔌 🎚-📐 🎚. ⚫️ 🔜 🔌 🎚-🆎 🎚, ⚓️ 🔛 = & 🔁 = ✍ 🆎.
|
||||||
|
|
||||||
|
{* ../../docs_src/response_directly/tutorial002.py hl[1,18] *}
|
||||||
|
|
||||||
|
### `HTMLResponse`
|
||||||
|
|
||||||
|
✊ ✍ ⚖️ 🔢 & 📨 🕸 📨, 👆 ✍ 🔛.
|
||||||
|
|
||||||
|
### `PlainTextResponse`
|
||||||
|
|
||||||
|
✊ ✍ ⚖️ 🔢 & 📨 ✅ ✍ 📨.
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial005.py hl[2,7,9] *}
|
||||||
|
|
||||||
|
### `JSONResponse`
|
||||||
|
|
||||||
|
✊ 💽 & 📨 `application/json` 🗜 📨.
|
||||||
|
|
||||||
|
👉 🔢 📨 ⚙️ **FastAPI**, 👆 ✍ 🔛.
|
||||||
|
|
||||||
|
### `ORJSONResponse`
|
||||||
|
|
||||||
|
⏩ 🎛 🎻 📨 ⚙️ <a href="https://github.com/ijl/orjson" class="external-link" target="_blank">`orjson`</a>, 👆 ✍ 🔛.
|
||||||
|
|
||||||
|
### `UJSONResponse`
|
||||||
|
|
||||||
|
🎛 🎻 📨 ⚙️ <a href="https://github.com/ultrajson/ultrajson" class="external-link" target="_blank">`ujson`</a>.
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
`ujson` 🌘 💛 🌘 🐍 🏗-🛠️ ❔ ⚫️ 🍵 📐-💼.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial001.py hl[2,7] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
⚫️ 💪 👈 `ORJSONResponse` 💪 ⏩ 🎛.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### `RedirectResponse`
|
||||||
|
|
||||||
|
📨 🇺🇸🔍 ❎. ⚙️ 3️⃣0️⃣7️⃣ 👔 📟 (🍕 ❎) 🔢.
|
||||||
|
|
||||||
|
👆 💪 📨 `RedirectResponse` 🔗:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial006.py hl[2,9] *}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
⚖️ 👆 💪 ⚙️ ⚫️ `response_class` 🔢:
|
||||||
|
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial006b.py hl[2,7,9] *}
|
||||||
|
|
||||||
|
🚥 👆 👈, ⤴️ 👆 💪 📨 📛 🔗 ⚪️➡️ 👆 *➡ 🛠️* 🔢.
|
||||||
|
|
||||||
|
👉 💼, `status_code` ⚙️ 🔜 🔢 1️⃣ `RedirectResponse`, ❔ `307`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `status_code` 🔢 🌀 ⏮️ `response_class` 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial006c.py hl[2,7,9] *}
|
||||||
|
|
||||||
|
### `StreamingResponse`
|
||||||
|
|
||||||
|
✊ 🔁 🚂 ⚖️ 😐 🚂/🎻 & 🎏 📨 💪.
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial007.py hl[2,14] *}
|
||||||
|
|
||||||
|
#### ⚙️ `StreamingResponse` ⏮️ 📁-💖 🎚
|
||||||
|
|
||||||
|
🚥 👆 ✔️ 📁-💖 🎚 (✅ 🎚 📨 `open()`), 👆 💪 ✍ 🚂 🔢 🔁 🤭 👈 📁-💖 🎚.
|
||||||
|
|
||||||
|
👈 🌌, 👆 🚫 ✔️ ✍ ⚫️ 🌐 🥇 💾, & 👆 💪 🚶♀️ 👈 🚂 🔢 `StreamingResponse`, & 📨 ⚫️.
|
||||||
|
|
||||||
|
👉 🔌 📚 🗃 🔗 ⏮️ ☁ 💾, 📹 🏭, & 🎏.
|
||||||
|
|
||||||
|
```{ .python .annotate hl_lines="2 10-12 14" }
|
||||||
|
{!../../docs_src/custom_response/tutorial008.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
1️⃣. 👉 🚂 🔢. ⚫️ "🚂 🔢" ↩️ ⚫️ 🔌 `yield` 📄 🔘.
|
||||||
|
2️⃣. ⚙️ `with` 🍫, 👥 ⚒ 💭 👈 📁-💖 🎚 📪 ⏮️ 🚂 🔢 🔨. , ⏮️ ⚫️ 🏁 📨 📨.
|
||||||
|
3️⃣. 👉 `yield from` 💬 🔢 🔁 🤭 👈 👜 🌟 `file_like`. & ⤴️, 🔠 🍕 🔁, 🌾 👈 🍕 👟 ⚪️➡️ 👉 🚂 🔢.
|
||||||
|
|
||||||
|
, ⚫️ 🚂 🔢 👈 📨 "🏭" 👷 🕳 🙆 🔘.
|
||||||
|
|
||||||
|
🔨 ⚫️ 👉 🌌, 👥 💪 🚮 ⚫️ `with` 🍫, & 👈 🌌, 🚚 👈 ⚫️ 📪 ⏮️ 🏁.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 👈 📥 👥 ⚙️ 🐩 `open()` 👈 🚫 🐕🦺 `async` & `await`, 👥 📣 ➡ 🛠️ ⏮️ 😐 `def`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### `FileResponse`
|
||||||
|
|
||||||
|
🔁 🎏 📁 📨.
|
||||||
|
|
||||||
|
✊ 🎏 ⚒ ❌ 🔗 🌘 🎏 📨 🆎:
|
||||||
|
|
||||||
|
* `path` - 📁 📁 🎏.
|
||||||
|
* `headers` - 🙆 🛃 🎚 🔌, 📖.
|
||||||
|
* `media_type` - 🎻 🤝 📻 🆎. 🚥 🔢, 📁 ⚖️ ➡ 🔜 ⚙️ 🔑 📻 🆎.
|
||||||
|
* `filename` - 🚥 ⚒, 👉 🔜 🔌 📨 `Content-Disposition`.
|
||||||
|
|
||||||
|
📁 📨 🔜 🔌 ☑ `Content-Length`, `Last-Modified` & `ETag` 🎚.
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial009.py hl[2,10] *}
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `response_class` 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial009b.py hl[2,8,10] *}
|
||||||
|
|
||||||
|
👉 💼, 👆 💪 📨 📁 ➡ 🔗 ⚪️➡️ 👆 *➡ 🛠️* 🔢.
|
||||||
|
|
||||||
|
## 🛃 📨 🎓
|
||||||
|
|
||||||
|
👆 💪 ✍ 👆 👍 🛃 📨 🎓, 😖 ⚪️➡️ `Response` & ⚙️ ⚫️.
|
||||||
|
|
||||||
|
🖼, ➡️ 💬 👈 👆 💚 ⚙️ <a href="https://github.com/ijl/orjson" class="external-link" target="_blank">`orjson`</a>, ✋️ ⏮️ 🛃 ⚒ 🚫 ⚙️ 🔌 `ORJSONResponse` 🎓.
|
||||||
|
|
||||||
|
➡️ 💬 👆 💚 ⚫️ 📨 🔂 & 📁 🎻, 👆 💚 ⚙️ Orjson 🎛 `orjson.OPT_INDENT_2`.
|
||||||
|
|
||||||
|
👆 💪 ✍ `CustomORJSONResponse`. 👑 👜 👆 ✔️ ✍ `Response.render(content)` 👩🔬 👈 📨 🎚 `bytes`:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial009c.py hl[9:14,17] *}
|
||||||
|
|
||||||
|
🔜 ↩️ 🛬:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"message": "Hello World"}
|
||||||
|
```
|
||||||
|
|
||||||
|
...👉 📨 🔜 📨:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "Hello World"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
↗️, 👆 🔜 🎲 🔎 🌅 👍 🌌 ✊ 📈 👉 🌘 ❕ 🎻. 👶
|
||||||
|
|
||||||
|
## 🔢 📨 🎓
|
||||||
|
|
||||||
|
🕐❔ 🏗 **FastAPI** 🎓 👐 ⚖️ `APIRouter` 👆 💪 ✔ ❔ 📨 🎓 ⚙️ 🔢.
|
||||||
|
|
||||||
|
🔢 👈 🔬 👉 `default_response_class`.
|
||||||
|
|
||||||
|
🖼 🔛, **FastAPI** 🔜 ⚙️ `ORJSONResponse` 🔢, 🌐 *➡ 🛠️*, ↩️ `JSONResponse`.
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_response/tutorial010.py hl[2,4] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👆 💪 🔐 `response_class` *➡ 🛠️* ⏭.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🌖 🧾
|
||||||
|
|
||||||
|
👆 💪 📣 📻 🆎 & 📚 🎏 ℹ 🗄 ⚙️ `responses`: [🌖 📨 🗄](additional-responses.md){.internal-link target=_blank}.
|
||||||
|
|
@ -0,0 +1,97 @@
|
||||||
|
# ⚙️ 🎻
|
||||||
|
|
||||||
|
FastAPI 🏗 🔛 🔝 **Pydantic**, & 👤 ✔️ 🌏 👆 ❔ ⚙️ Pydantic 🏷 📣 📨 & 📨.
|
||||||
|
|
||||||
|
✋️ FastAPI 🐕🦺 ⚙️ <a href="https://docs.python.org/3/library/dataclasses.html" class="external-link" target="_blank">`dataclasses`</a> 🎏 🌌:
|
||||||
|
|
||||||
|
{* ../../docs_src/dataclasses/tutorial001.py hl[1,7:12,19:20] *}
|
||||||
|
|
||||||
|
👉 🐕🦺 👏 **Pydantic**, ⚫️ ✔️ <a href="https://docs.pydantic.dev/latest/concepts/dataclasses/#use-of-stdlib-dataclasses-with-basemodel" class="external-link" target="_blank">🔗 🐕🦺 `dataclasses`</a>.
|
||||||
|
|
||||||
|
, ⏮️ 📟 🔛 👈 🚫 ⚙️ Pydantic 🎯, FastAPI ⚙️ Pydantic 🗜 📚 🐩 🎻 Pydantic 👍 🍛 🎻.
|
||||||
|
|
||||||
|
& ↗️, ⚫️ 🐕🦺 🎏:
|
||||||
|
|
||||||
|
* 💽 🔬
|
||||||
|
* 💽 🛠️
|
||||||
|
* 💽 🧾, ♒️.
|
||||||
|
|
||||||
|
👉 👷 🎏 🌌 ⏮️ Pydantic 🏷. & ⚫️ 🤙 🏆 🎏 🌌 🔘, ⚙️ Pydantic.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
✔️ 🤯 👈 🎻 💪 🚫 🌐 Pydantic 🏷 💪.
|
||||||
|
|
||||||
|
, 👆 5️⃣📆 💪 ⚙️ Pydantic 🏷.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 ✔️ 📚 🎻 🤥 🤭, 👉 👌 🎱 ⚙️ 👫 🏋️ 🕸 🛠️ ⚙️ FastAPI. 👶
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🎻 `response_model`
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `dataclasses` `response_model` 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/dataclasses/tutorial002.py hl[1,7:13,19] *}
|
||||||
|
|
||||||
|
🎻 🔜 🔁 🗜 Pydantic 🎻.
|
||||||
|
|
||||||
|
👉 🌌, 🚮 🔗 🔜 🎦 🆙 🛠️ 🩺 👩💻 🔢:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/dataclasses/image01.png">
|
||||||
|
|
||||||
|
## 🎻 🔁 📊 📊
|
||||||
|
|
||||||
|
👆 💪 🌀 `dataclasses` ⏮️ 🎏 🆎 ✍ ⚒ 🐦 📊 📊.
|
||||||
|
|
||||||
|
💼, 👆 💪 ✔️ ⚙️ Pydantic ⏬ `dataclasses`. 🖼, 🚥 👆 ✔️ ❌ ⏮️ 🔁 🏗 🛠️ 🧾.
|
||||||
|
|
||||||
|
👈 💼, 👆 💪 🎯 💱 🐩 `dataclasses` ⏮️ `pydantic.dataclasses`, ❔ 💧-♻:
|
||||||
|
|
||||||
|
```{ .python .annotate hl_lines="1 5 8-11 14-17 23-25 28" }
|
||||||
|
{!../../docs_src/dataclasses/tutorial003.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
1️⃣. 👥 🗄 `field` ⚪️➡️ 🐩 `dataclasses`.
|
||||||
|
|
||||||
|
2️⃣. `pydantic.dataclasses` 💧-♻ `dataclasses`.
|
||||||
|
|
||||||
|
3️⃣. `Author` 🎻 🔌 📇 `Item` 🎻.
|
||||||
|
|
||||||
|
4️⃣. `Author` 🎻 ⚙️ `response_model` 🔢.
|
||||||
|
|
||||||
|
5️⃣. 👆 💪 ⚙️ 🎏 🐩 🆎 ✍ ⏮️ 🎻 📨 💪.
|
||||||
|
|
||||||
|
👉 💼, ⚫️ 📇 `Item` 🎻.
|
||||||
|
|
||||||
|
6️⃣. 📥 👥 🛬 📖 👈 🔌 `items` ❔ 📇 🎻.
|
||||||
|
|
||||||
|
FastAPI 🎯 <abbr title="converting the data to a format that can be transmitted">✍</abbr> 💽 🎻.
|
||||||
|
|
||||||
|
7️⃣. 📥 `response_model` ⚙️ 🆎 ✍ 📇 `Author` 🎻.
|
||||||
|
|
||||||
|
🔄, 👆 💪 🌀 `dataclasses` ⏮️ 🐩 🆎 ✍.
|
||||||
|
|
||||||
|
8️⃣. 👀 👈 👉 *➡ 🛠️ 🔢* ⚙️ 🥔 `def` ↩️ `async def`.
|
||||||
|
|
||||||
|
🕧, FastAPI 👆 💪 🌀 `def` & `async def` 💪.
|
||||||
|
|
||||||
|
🚥 👆 💪 ↗️ 🔃 🕐❔ ⚙️ ❔, ✅ 👅 📄 _"🏃 ❓" _ 🩺 🔃 <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank" class="internal-link">`async` & `await`</a>.
|
||||||
|
|
||||||
|
9️⃣. 👉 *➡ 🛠️ 🔢* 🚫 🛬 🎻 (👐 ⚫️ 💪), ✋️ 📇 📖 ⏮️ 🔗 💽.
|
||||||
|
|
||||||
|
FastAPI 🔜 ⚙️ `response_model` 🔢 (👈 🔌 🎻) 🗜 📨.
|
||||||
|
|
||||||
|
👆 💪 🌀 `dataclasses` ⏮️ 🎏 🆎 ✍ 📚 🎏 🌀 📨 🏗 📊 📊.
|
||||||
|
|
||||||
|
✅-📟 ✍ 💁♂ 🔛 👀 🌅 🎯 ℹ.
|
||||||
|
|
||||||
|
## 💡 🌅
|
||||||
|
|
||||||
|
👆 💪 🌀 `dataclasses` ⏮️ 🎏 Pydantic 🏷, 😖 ⚪️➡️ 👫, 🔌 👫 👆 👍 🏷, ♒️.
|
||||||
|
|
||||||
|
💡 🌅, ✅ <a href="https://docs.pydantic.dev/latest/concepts/dataclasses/" class="external-link" target="_blank">Pydantic 🩺 🔃 🎻</a>.
|
||||||
|
|
||||||
|
## ⏬
|
||||||
|
|
||||||
|
👉 💪 ↩️ FastAPI ⏬ `0.67.0`. 👶
|
||||||
|
|
@ -0,0 +1,163 @@
|
||||||
|
# 🔆 🎉
|
||||||
|
|
||||||
|
👆 💪 🔬 ⚛ (📟) 👈 🔜 🛠️ ⏭ 🈸 **▶️ 🆙**. 👉 ⛓ 👈 👉 📟 🔜 🛠️ **🕐**, **⏭** 🈸 **▶️ 📨 📨**.
|
||||||
|
|
||||||
|
🎏 🌌, 👆 💪 🔬 ⚛ (📟) 👈 🔜 🛠️ 🕐❔ 🈸 **🤫 🔽**. 👉 💼, 👉 📟 🔜 🛠️ **🕐**, **⏮️** ✔️ 🍵 🎲 **📚 📨**.
|
||||||
|
|
||||||
|
↩️ 👉 📟 🛠️ ⏭ 🈸 **▶️** ✊ 📨, & ▶️️ ⏮️ ⚫️ **🏁** 🚚 📨, ⚫️ 📔 🎂 🈸 **🔆** (🔤 "🔆" 🔜 ⚠ 🥈 👶).
|
||||||
|
|
||||||
|
👉 💪 📶 ⚠ ⚒ 🆙 **ℹ** 👈 👆 💪 ⚙️ 🎂 📱, & 👈 **💰** 👪 📨, &/⚖️ 👈 👆 💪 **🧹 🆙** ⏮️. 🖼, 💽 🔗 🎱, ⚖️ 🚚 🔗 🎰 🏫 🏷.
|
||||||
|
|
||||||
|
## ⚙️ 💼
|
||||||
|
|
||||||
|
➡️ ▶️ ⏮️ 🖼 **⚙️ 💼** & ⤴️ 👀 ❔ ❎ ⚫️ ⏮️ 👉.
|
||||||
|
|
||||||
|
➡️ 🌈 👈 👆 ✔️ **🎰 🏫 🏷** 👈 👆 💚 ⚙️ 🍵 📨. 👶
|
||||||
|
|
||||||
|
🎏 🏷 🔗 👪 📨,, ⚫️ 🚫 1️⃣ 🏷 📍 📨, ⚖️ 1️⃣ 📍 👩💻 ⚖️ 🕳 🎏.
|
||||||
|
|
||||||
|
➡️ 🌈 👈 🚚 🏷 💪 **✊ 🕰**, ↩️ ⚫️ ✔️ ✍ 📚 **💽 ⚪️➡️ 💾**. 👆 🚫 💚 ⚫️ 🔠 📨.
|
||||||
|
|
||||||
|
👆 💪 📐 ⚫️ 🔝 🎚 🕹/📁, ✋️ 👈 🔜 ⛓ 👈 ⚫️ 🔜 **📐 🏷** 🚥 👆 🏃♂ 🙅 🏧 💯, ⤴️ 👈 💯 🔜 **🐌** ↩️ ⚫️ 🔜 ✔️ ⌛ 🏷 📐 ⏭ 💆♂ 💪 🏃 🔬 🍕 📟.
|
||||||
|
|
||||||
|
👈 ⚫️❔ 👥 🔜 ❎, ➡️ 📐 🏷 ⏭ 📨 🍵, ✋️ 🕴 ▶️️ ⏭ 🈸 ▶️ 📨 📨, 🚫 ⏪ 📟 ➖ 📐.
|
||||||
|
|
||||||
|
## 🔆
|
||||||
|
|
||||||
|
👆 💪 🔬 👉 *🕴* & *🤫* ⚛ ⚙️ `lifespan` 🔢 `FastAPI` 📱, & "🔑 👨💼" (👤 🔜 🎦 👆 ⚫️❔ 👈 🥈).
|
||||||
|
|
||||||
|
➡️ ▶️ ⏮️ 🖼 & ⤴️ 👀 ⚫️ ℹ.
|
||||||
|
|
||||||
|
👥 ✍ 🔁 🔢 `lifespan()` ⏮️ `yield` 💖 👉:
|
||||||
|
|
||||||
|
{* ../../docs_src/events/tutorial003.py hl[16,19] *}
|
||||||
|
|
||||||
|
📥 👥 ⚖ 😥 *🕴* 🛠️ 🚚 🏷 🚮 (❌) 🏷 🔢 📖 ⏮️ 🎰 🏫 🏷 ⏭ `yield`. 👉 📟 🔜 🛠️ **⏭** 🈸 **▶️ ✊ 📨**, ⏮️ *🕴*.
|
||||||
|
|
||||||
|
& ⤴️, ▶️️ ⏮️ `yield`, 👥 🚚 🏷. 👉 📟 🔜 🛠️ **⏮️** 🈸 **🏁 🚚 📨**, ▶️️ ⏭ *🤫*. 👉 💪, 🖼, 🚀 ℹ 💖 💾 ⚖️ 💻.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
`shutdown` 🔜 🔨 🕐❔ 👆 **⛔️** 🈸.
|
||||||
|
|
||||||
|
🎲 👆 💪 ▶️ 🆕 ⏬, ⚖️ 👆 🤚 🎡 🏃 ⚫️. 🤷
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🔆 🔢
|
||||||
|
|
||||||
|
🥇 👜 👀, 👈 👥 ⚖ 🔁 🔢 ⏮️ `yield`. 👉 📶 🎏 🔗 ⏮️ `yield`.
|
||||||
|
|
||||||
|
{* ../../docs_src/events/tutorial003.py hl[14:19] *}
|
||||||
|
|
||||||
|
🥇 🍕 🔢, ⏭ `yield`, 🔜 🛠️ **⏭** 🈸 ▶️.
|
||||||
|
|
||||||
|
& 🍕 ⏮️ `yield` 🔜 🛠️ **⏮️** 🈸 ✔️ 🏁.
|
||||||
|
|
||||||
|
### 🔁 🔑 👨💼
|
||||||
|
|
||||||
|
🚥 👆 ✅, 🔢 🎀 ⏮️ `@asynccontextmanager`.
|
||||||
|
|
||||||
|
👈 🗜 🔢 🔘 🕳 🤙 "**🔁 🔑 👨💼**".
|
||||||
|
|
||||||
|
{* ../../docs_src/events/tutorial003.py hl[1,13] *}
|
||||||
|
|
||||||
|
**🔑 👨💼** 🐍 🕳 👈 👆 💪 ⚙️ `with` 📄, 🖼, `open()` 💪 ⚙️ 🔑 👨💼:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
with open("file.txt") as file:
|
||||||
|
file.read()
|
||||||
|
```
|
||||||
|
|
||||||
|
⏮️ ⏬ 🐍, 📤 **🔁 🔑 👨💼**. 👆 🔜 ⚙️ ⚫️ ⏮️ `async with`:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
async with lifespan(app):
|
||||||
|
await do_stuff()
|
||||||
|
```
|
||||||
|
|
||||||
|
🕐❔ 👆 ✍ 🔑 👨💼 ⚖️ 🔁 🔑 👨💼 💖 🔛, ⚫️❔ ⚫️ 🔨 👈, ⏭ 🛬 `with` 🍫, ⚫️ 🔜 🛠️ 📟 ⏭ `yield`, & ⏮️ ❎ `with` 🍫, ⚫️ 🔜 🛠️ 📟 ⏮️ `yield`.
|
||||||
|
|
||||||
|
👆 📟 🖼 🔛, 👥 🚫 ⚙️ ⚫️ 🔗, ✋️ 👥 🚶♀️ ⚫️ FastAPI ⚫️ ⚙️ ⚫️.
|
||||||
|
|
||||||
|
`lifespan` 🔢 `FastAPI` 📱 ✊ **🔁 🔑 👨💼**, 👥 💪 🚶♀️ 👆 🆕 `lifespan` 🔁 🔑 👨💼 ⚫️.
|
||||||
|
|
||||||
|
{* ../../docs_src/events/tutorial003.py hl[22] *}
|
||||||
|
|
||||||
|
## 🎛 🎉 (😢)
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
👍 🌌 🍵 *🕴* & *🤫* ⚙️ `lifespan` 🔢 `FastAPI` 📱 🔬 🔛.
|
||||||
|
|
||||||
|
👆 💪 🎲 🚶 👉 🍕.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
📤 🎛 🌌 🔬 👉 ⚛ 🛠️ ⏮️ *🕴* & ⏮️ *🤫*.
|
||||||
|
|
||||||
|
👆 💪 🔬 🎉 🐕🦺 (🔢) 👈 💪 🛠️ ⏭ 🈸 ▶️ 🆙, ⚖️ 🕐❔ 🈸 🤫 🔽.
|
||||||
|
|
||||||
|
👫 🔢 💪 📣 ⏮️ `async def` ⚖️ 😐 `def`.
|
||||||
|
|
||||||
|
### `startup` 🎉
|
||||||
|
|
||||||
|
🚮 🔢 👈 🔜 🏃 ⏭ 🈸 ▶️, 📣 ⚫️ ⏮️ 🎉 `"startup"`:
|
||||||
|
|
||||||
|
{* ../../docs_src/events/tutorial001.py hl[8] *}
|
||||||
|
|
||||||
|
👉 💼, `startup` 🎉 🐕🦺 🔢 🔜 🔢 🏬 "💽" ( `dict`) ⏮️ 💲.
|
||||||
|
|
||||||
|
👆 💪 🚮 🌅 🌘 1️⃣ 🎉 🐕🦺 🔢.
|
||||||
|
|
||||||
|
& 👆 🈸 🏆 🚫 ▶️ 📨 📨 ⏭ 🌐 `startup` 🎉 🐕🦺 ✔️ 🏁.
|
||||||
|
|
||||||
|
### `shutdown` 🎉
|
||||||
|
|
||||||
|
🚮 🔢 👈 🔜 🏃 🕐❔ 🈸 🤫 🔽, 📣 ⚫️ ⏮️ 🎉 `"shutdown"`:
|
||||||
|
|
||||||
|
{* ../../docs_src/events/tutorial002.py hl[6] *}
|
||||||
|
|
||||||
|
📥, `shutdown` 🎉 🐕🦺 🔢 🔜 ✍ ✍ ⏸ `"Application shutdown"` 📁 `log.txt`.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
`open()` 🔢, `mode="a"` ⛓ "🎻",, ⏸ 🔜 🚮 ⏮️ ⚫️❔ 🔛 👈 📁, 🍵 📁 ⏮️ 🎚.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 👈 👉 💼 👥 ⚙️ 🐩 🐍 `open()` 🔢 👈 🔗 ⏮️ 📁.
|
||||||
|
|
||||||
|
, ⚫️ 🔌 👤/🅾 (🔢/🔢), 👈 🚚 "⌛" 👜 ✍ 💾.
|
||||||
|
|
||||||
|
✋️ `open()` 🚫 ⚙️ `async` & `await`.
|
||||||
|
|
||||||
|
, 👥 📣 🎉 🐕🦺 🔢 ⏮️ 🐩 `def` ↩️ `async def`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
👆 💪 ✍ 🌅 🔃 👫 🎉 🐕🦺 <a href="https://www.starlette.dev/events/" class="external-link" target="_blank">💃 🎉' 🩺</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### `startup` & `shutdown` 👯♂️
|
||||||
|
|
||||||
|
📤 ↕ 🤞 👈 ⚛ 👆 *🕴* & *🤫* 🔗, 👆 💪 💚 ▶️ 🕳 & ⤴️ 🏁 ⚫️, 📎 ℹ & ⤴️ 🚀 ⚫️, ♒️.
|
||||||
|
|
||||||
|
🔨 👈 👽 🔢 👈 🚫 💰 ⚛ ⚖️ 🔢 👯♂️ 🌅 ⚠ 👆 🔜 💪 🏪 💲 🌐 🔢 ⚖️ 🎏 🎱.
|
||||||
|
|
||||||
|
↩️ 👈, ⚫️ 🔜 👍 ↩️ ⚙️ `lifespan` 🔬 🔛.
|
||||||
|
|
||||||
|
## 📡 ℹ
|
||||||
|
|
||||||
|
📡 ℹ 😟 🤓. 👶
|
||||||
|
|
||||||
|
🔘, 🔫 📡 🔧, 👉 🍕 <a href="https://asgi.readthedocs.io/en/latest/specs/lifespan.html" class="external-link" target="_blank">🔆 🛠️</a>, & ⚫️ 🔬 🎉 🤙 `startup` & `shutdown`.
|
||||||
|
|
||||||
|
## 🎧 🈸
|
||||||
|
|
||||||
|
👶 ✔️ 🤯 👈 👫 🔆 🎉 (🕴 & 🤫) 🔜 🕴 🛠️ 👑 🈸, 🚫 [🎧 🈸 - 🗻](sub-applications.md){.internal-link target=_blank}.
|
||||||
|
|
@ -0,0 +1,238 @@
|
||||||
|
# 🏗 👩💻
|
||||||
|
|
||||||
|
**FastAPI** ⚓️ 🔛 🗄 🔧, 👆 🤚 🏧 🔗 ⏮️ 📚 🧰, 🔌 🏧 🛠️ 🩺 (🚚 🦁 🎚).
|
||||||
|
|
||||||
|
1️⃣ 🎯 📈 👈 🚫 🎯 ⭐ 👈 👆 💪 **🏗 👩💻** (🕣 🤙 <abbr title="Software Development Kits">**📱**</abbr> ) 👆 🛠️, 📚 🎏 **🛠️ 🇪🇸**.
|
||||||
|
|
||||||
|
## 🗄 👩💻 🚂
|
||||||
|
|
||||||
|
📤 📚 🧰 🏗 👩💻 ⚪️➡️ **🗄**.
|
||||||
|
|
||||||
|
⚠ 🧰 <a href="https://openapi-generator.tech/" class="external-link" target="_blank">🗄 🚂</a>.
|
||||||
|
|
||||||
|
🚥 👆 🏗 **🕸**, 📶 😌 🎛 <a href="https://github.com/hey-api/openapi-ts" class="external-link" target="_blank">🗄-📕-🇦🇪</a>.
|
||||||
|
|
||||||
|
## 🏗 📕 🕸 👩💻
|
||||||
|
|
||||||
|
➡️ ▶️ ⏮️ 🙅 FastAPI 🈸:
|
||||||
|
|
||||||
|
{* ../../docs_src/generate_clients/tutorial001.py hl[9:11,14:15,18,19,23] *}
|
||||||
|
|
||||||
|
👀 👈 *➡ 🛠️* 🔬 🏷 👫 ⚙️ 📨 🚀 & 📨 🚀, ⚙️ 🏷 `Item` & `ResponseMessage`.
|
||||||
|
|
||||||
|
### 🛠️ 🩺
|
||||||
|
|
||||||
|
🚥 👆 🚶 🛠️ 🩺, 👆 🔜 👀 👈 ⚫️ ✔️ **🔗** 📊 📨 📨 & 📨 📨:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/generate-clients/image01.png">
|
||||||
|
|
||||||
|
👆 💪 👀 👈 🔗 ↩️ 👫 📣 ⏮️ 🏷 📱.
|
||||||
|
|
||||||
|
👈 ℹ 💪 📱 **🗄 🔗**, & ⤴️ 🎦 🛠️ 🩺 (🦁 🎚).
|
||||||
|
|
||||||
|
& 👈 🎏 ℹ ⚪️➡️ 🏷 👈 🔌 🗄 ⚫️❔ 💪 ⚙️ **🏗 👩💻 📟**.
|
||||||
|
|
||||||
|
### 🏗 📕 👩💻
|
||||||
|
|
||||||
|
🔜 👈 👥 ✔️ 📱 ⏮️ 🏷, 👥 💪 🏗 👩💻 📟 🕸.
|
||||||
|
|
||||||
|
#### ❎ `openapi-ts`
|
||||||
|
|
||||||
|
👆 💪 ❎ `openapi-ts` 👆 🕸 📟 ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ npm install @hey-api/openapi-ts --save-dev
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
#### 🏗 👩💻 📟
|
||||||
|
|
||||||
|
🏗 👩💻 📟 👆 💪 ⚙️ 📋 ⏸ 🈸 `openapi-ts` 👈 🔜 🔜 ❎.
|
||||||
|
|
||||||
|
↩️ ⚫️ ❎ 🇧🇿 🏗, 👆 🎲 🚫🔜 💪 🤙 👈 📋 🔗, ✋️ 👆 🔜 🚮 ⚫️ 🔛 👆 `package.json` 📁.
|
||||||
|
|
||||||
|
⚫️ 💪 👀 💖 👉:
|
||||||
|
|
||||||
|
```JSON hl_lines="7"
|
||||||
|
{
|
||||||
|
"name": "frontend-app",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "",
|
||||||
|
"main": "index.js",
|
||||||
|
"scripts": {
|
||||||
|
"generate-client": "openapi-ts --input http://localhost:8000/openapi.json --output ./src/client --client axios"
|
||||||
|
},
|
||||||
|
"author": "",
|
||||||
|
"license": "",
|
||||||
|
"devDependencies": {
|
||||||
|
"@hey-api/openapi-ts": "^0.27.38",
|
||||||
|
"typescript": "^4.6.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
⏮️ ✔️ 👈 ☕ `generate-client` ✍ 📤, 👆 💪 🏃 ⚫️ ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ npm run generate-client
|
||||||
|
|
||||||
|
frontend-app@1.0.0 generate-client /home/user/code/frontend-app
|
||||||
|
> openapi-ts --input http://localhost:8000/openapi.json --output ./src/client --client axios
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
👈 📋 🔜 🏗 📟 `./src/client` & 🔜 ⚙️ `axios` (🕸 🇺🇸🔍 🗃) 🔘.
|
||||||
|
|
||||||
|
### 🔄 👅 👩💻 📟
|
||||||
|
|
||||||
|
🔜 👆 💪 🗄 & ⚙️ 👩💻 📟, ⚫️ 💪 👀 💖 👉, 👀 👈 👆 🤚 ✍ 👩🔬:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/generate-clients/image02.png">
|
||||||
|
|
||||||
|
👆 🔜 🤚 ✍ 🚀 📨:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/generate-clients/image03.png">
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 ✍ `name` & `price`, 👈 🔬 FastAPI 🈸, `Item` 🏷.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👆 🔜 ✔️ ⏸ ❌ 📊 👈 👆 📨:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/generate-clients/image04.png">
|
||||||
|
|
||||||
|
📨 🎚 🔜 ✔️ ✍:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/generate-clients/image05.png">
|
||||||
|
|
||||||
|
## FastAPI 📱 ⏮️ 🔖
|
||||||
|
|
||||||
|
📚 💼 👆 FastAPI 📱 🔜 🦏, & 👆 🔜 🎲 ⚙️ 🔖 🎏 🎏 👪 *➡ 🛠️*.
|
||||||
|
|
||||||
|
🖼, 👆 💪 ✔️ 📄 **🏬** & ➕1️⃣ 📄 **👩💻**, & 👫 💪 👽 🔖:
|
||||||
|
|
||||||
|
|
||||||
|
{* ../../docs_src/generate_clients/tutorial002.py hl[23,28,36] *}
|
||||||
|
|
||||||
|
### 🏗 📕 👩💻 ⏮️ 🔖
|
||||||
|
|
||||||
|
🚥 👆 🏗 👩💻 FastAPI 📱 ⚙️ 🔖, ⚫️ 🔜 🛎 🎏 👩💻 📟 ⚓️ 🔛 🔖.
|
||||||
|
|
||||||
|
👉 🌌 👆 🔜 💪 ✔️ 👜 ✔ & 👪 ☑ 👩💻 📟:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/generate-clients/image06.png">
|
||||||
|
|
||||||
|
👉 💼 👆 ✔️:
|
||||||
|
|
||||||
|
* `ItemsService`
|
||||||
|
* `UsersService`
|
||||||
|
|
||||||
|
### 👩💻 👩🔬 📛
|
||||||
|
|
||||||
|
▶️️ 🔜 🏗 👩🔬 📛 💖 `createItemItemsPost` 🚫 👀 📶 🧹:
|
||||||
|
|
||||||
|
```TypeScript
|
||||||
|
ItemsService.createItemItemsPost({name: "Plumbus", price: 5})
|
||||||
|
```
|
||||||
|
|
||||||
|
...👈 ↩️ 👩💻 🚂 ⚙️ 🗄 🔗 **🛠️ 🆔** 🔠 *➡ 🛠️*.
|
||||||
|
|
||||||
|
🗄 🚚 👈 🔠 🛠️ 🆔 😍 🤭 🌐 *➡ 🛠️*, FastAPI ⚙️ **🔢 📛**, **➡**, & **🇺🇸🔍 👩🔬/🛠️** 🏗 👈 🛠️ 🆔, ↩️ 👈 🌌 ⚫️ 💪 ⚒ 💭 👈 🛠️ 🆔 😍.
|
||||||
|
|
||||||
|
✋️ 👤 🔜 🎦 👆 ❔ 📉 👈 ⏭. 👶
|
||||||
|
|
||||||
|
## 🛃 🛠️ 🆔 & 👍 👩🔬 📛
|
||||||
|
|
||||||
|
👆 💪 **🔀** 🌌 👫 🛠️ 🆔 **🏗** ⚒ 👫 🙅 & ✔️ **🙅 👩🔬 📛** 👩💻.
|
||||||
|
|
||||||
|
👉 💼 👆 🔜 ✔️ 🚚 👈 🔠 🛠️ 🆔 **😍** 🎏 🌌.
|
||||||
|
|
||||||
|
🖼, 👆 💪 ⚒ 💭 👈 🔠 *➡ 🛠️* ✔️ 🔖, & ⤴️ 🏗 🛠️ 🆔 ⚓️ 🔛 **🔖** & *➡ 🛠️* **📛** (🔢 📛).
|
||||||
|
|
||||||
|
### 🛃 🏗 😍 🆔 🔢
|
||||||
|
|
||||||
|
FastAPI ⚙️ **😍 🆔** 🔠 *➡ 🛠️*, ⚫️ ⚙️ **🛠️ 🆔** & 📛 🙆 💪 🛃 🏷, 📨 ⚖️ 📨.
|
||||||
|
|
||||||
|
👆 💪 🛃 👈 🔢. ⚫️ ✊ `APIRoute` & 🔢 🎻.
|
||||||
|
|
||||||
|
🖼, 📥 ⚫️ ⚙️ 🥇 🔖 (👆 🔜 🎲 ✔️ 🕴 1️⃣ 🔖) & *➡ 🛠️* 📛 (🔢 📛).
|
||||||
|
|
||||||
|
👆 💪 ⤴️ 🚶♀️ 👈 🛃 🔢 **FastAPI** `generate_unique_id_function` 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/generate_clients/tutorial003.py hl[8:9,12] *}
|
||||||
|
|
||||||
|
### 🏗 📕 👩💻 ⏮️ 🛃 🛠️ 🆔
|
||||||
|
|
||||||
|
🔜 🚥 👆 🏗 👩💻 🔄, 👆 🔜 👀 👈 ⚫️ ✔️ 📉 👩🔬 📛:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/generate-clients/image07.png">
|
||||||
|
|
||||||
|
👆 👀, 👩🔬 📛 🔜 ✔️ 🔖 & ⤴️ 🔢 📛, 🔜 👫 🚫 🔌 ℹ ⚪️➡️ 📛 ➡ & 🇺🇸🔍 🛠️.
|
||||||
|
|
||||||
|
### 🗜 🗄 🔧 👩💻 🚂
|
||||||
|
|
||||||
|
🏗 📟 ✔️ **❎ ℹ**.
|
||||||
|
|
||||||
|
👥 ⏪ 💭 👈 👉 👩🔬 🔗 **🏬** ↩️ 👈 🔤 `ItemsService` (✊ ⚪️➡️ 🔖), ✋️ 👥 ✔️ 📛 🔡 👩🔬 📛 💁♂️. 👶
|
||||||
|
|
||||||
|
👥 🔜 🎲 💚 🚧 ⚫️ 🗄 🏢, 👈 🔜 🚚 👈 🛠️ 🆔 **😍**.
|
||||||
|
|
||||||
|
✋️ 🏗 👩💻 👥 💪 **🔀** 🗄 🛠️ 🆔 ▶️️ ⏭ 🏭 👩💻, ⚒ 👈 👩🔬 📛 👌 & **🧹**.
|
||||||
|
|
||||||
|
👥 💪 ⏬ 🗄 🎻 📁 `openapi.json` & ⤴️ 👥 💪 **❎ 👈 🔡 🔖** ⏮️ ✍ 💖 👉:
|
||||||
|
|
||||||
|
{* ../../docs_src/generate_clients/tutorial004.py *}
|
||||||
|
|
||||||
|
⏮️ 👈, 🛠️ 🆔 🔜 📁 ⚪️➡️ 👜 💖 `items-get_items` `get_items`, 👈 🌌 👩💻 🚂 💪 🏗 🙅 👩🔬 📛.
|
||||||
|
|
||||||
|
### 🏗 📕 👩💻 ⏮️ 🗜 🗄
|
||||||
|
|
||||||
|
🔜 🔚 🏁 📁 `openapi.json`, 👆 🔜 🔀 `package.json` ⚙️ 👈 🇧🇿 📁, 🖼:
|
||||||
|
|
||||||
|
```JSON hl_lines="7"
|
||||||
|
{
|
||||||
|
"name": "frontend-app",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "",
|
||||||
|
"main": "index.js",
|
||||||
|
"scripts": {
|
||||||
|
"generate-client": "openapi-ts --input ./openapi.json --output ./src/client --client axios"
|
||||||
|
},
|
||||||
|
"author": "",
|
||||||
|
"license": "",
|
||||||
|
"devDependencies": {
|
||||||
|
"@hey-api/openapi-ts": "^0.27.38",
|
||||||
|
"typescript": "^4.6.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
⏮️ 🏭 🆕 👩💻, 👆 🔜 🔜 ✔️ **🧹 👩🔬 📛**, ⏮️ 🌐 **✍**, **⏸ ❌**, ♒️:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/generate-clients/image08.png">
|
||||||
|
|
||||||
|
## 💰
|
||||||
|
|
||||||
|
🕐❔ ⚙️ 🔁 🏗 👩💻 👆 🔜 **✍** :
|
||||||
|
|
||||||
|
* 👩🔬.
|
||||||
|
* 📨 🚀 💪, 🔢 🔢, ♒️.
|
||||||
|
* 📨 🚀.
|
||||||
|
|
||||||
|
👆 🔜 ✔️ **⏸ ❌** 🌐.
|
||||||
|
|
||||||
|
& 🕐❔ 👆 ℹ 👩💻 📟, & **♻** 🕸, ⚫️ 🔜 ✔️ 🙆 🆕 *➡ 🛠️* 💪 👩🔬, 🗝 🕐 ❎, & 🙆 🎏 🔀 🔜 🎨 🔛 🏗 📟. 👶
|
||||||
|
|
||||||
|
👉 ⛓ 👈 🚥 🕳 🔀 ⚫️ 🔜 **🎨** 🔛 👩💻 📟 🔁. & 🚥 👆 **🏗** 👩💻 ⚫️ 🔜 ❌ 👅 🚥 👆 ✔️ 🙆 **🔖** 📊 ⚙️.
|
||||||
|
|
||||||
|
, 👆 🔜 **🔍 📚 ❌** 📶 ⏪ 🛠️ 🛵 ↩️ ✔️ ⌛ ❌ 🎦 🆙 👆 🏁 👩💻 🏭 & ⤴️ 🔄 ℹ 🌐❔ ⚠. 👶
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
# 🏧 👩💻 🦮
|
||||||
|
|
||||||
|
## 🌖 ⚒
|
||||||
|
|
||||||
|
👑 [🔰 - 👩💻 🦮](../tutorial/index.md){.internal-link target=_blank} 🔜 🥃 🤝 👆 🎫 🔘 🌐 👑 ⚒ **FastAPI**.
|
||||||
|
|
||||||
|
⏭ 📄 👆 🔜 👀 🎏 🎛, 📳, & 🌖 ⚒.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
⏭ 📄 **🚫 🎯 "🏧"**.
|
||||||
|
|
||||||
|
& ⚫️ 💪 👈 👆 ⚙️ 💼, ⚗ 1️⃣ 👫.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ✍ 🔰 🥇
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🏆 ⚒ **FastAPI** ⏮️ 💡 ⚪️➡️ 👑 [🔰 - 👩💻 🦮](../tutorial/index.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
& ⏭ 📄 🤔 👆 ⏪ ✍ ⚫️, & 🤔 👈 👆 💭 👈 👑 💭.
|
||||||
|
|
||||||
|
## 🏎.🅾 ↗️
|
||||||
|
|
||||||
|
🚥 👆 🔜 💖 ✊ 🏧-🔰 ↗️ 🔗 👉 📄 🩺, 👆 💪 💚 ✅: <a href="https://testdriven.io/courses/tdd-fastapi/" class="external-link" target="_blank">💯-💾 🛠️ ⏮️ FastAPI & ☁</a> **🏎.🅾**.
|
||||||
|
|
||||||
|
👫 ⏳ 🩸 1️⃣0️⃣ 💯 🌐 💰 🛠️ **FastAPI**. 👶 👶
|
||||||
|
|
@ -0,0 +1,95 @@
|
||||||
|
# 🏧 🛠️
|
||||||
|
|
||||||
|
👑 🔰 👆 ✍ ❔ 🚮 [🛃 🛠️](../tutorial/middleware.md){.internal-link target=_blank} 👆 🈸.
|
||||||
|
|
||||||
|
& ⤴️ 👆 ✍ ❔ 🍵 [⚜ ⏮️ `CORSMiddleware`](../tutorial/cors.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
👉 📄 👥 🔜 👀 ❔ ⚙️ 🎏 🛠️.
|
||||||
|
|
||||||
|
## ❎ 🔫 🛠️
|
||||||
|
|
||||||
|
**FastAPI** ⚓️ 🔛 💃 & 🛠️ <abbr title="Asynchronous Server Gateway Interface">🔫</abbr> 🔧, 👆 💪 ⚙️ 🙆 🔫 🛠️.
|
||||||
|
|
||||||
|
🛠️ 🚫 ✔️ ⚒ FastAPI ⚖️ 💃 👷, 📏 ⚫️ ⏩ 🔫 🔌.
|
||||||
|
|
||||||
|
🏢, 🔫 🛠️ 🎓 👈 ⌛ 📨 🔫 📱 🥇 ❌.
|
||||||
|
|
||||||
|
, 🧾 🥉-🥳 🔫 🛠️ 👫 🔜 🎲 💬 👆 🕳 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from unicorn import UnicornMiddleware
|
||||||
|
|
||||||
|
app = SomeASGIApp()
|
||||||
|
|
||||||
|
new_app = UnicornMiddleware(app, some_config="rainbow")
|
||||||
|
```
|
||||||
|
|
||||||
|
✋️ FastAPI (🤙 💃) 🚚 🙅 🌌 ⚫️ 👈 ⚒ 💭 👈 🔗 🛠️ 🍵 💽 ❌ & 🛃 ⚠ 🐕🦺 👷 ☑.
|
||||||
|
|
||||||
|
👈, 👆 ⚙️ `app.add_middleware()` (🖼 ⚜).
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from fastapi import FastAPI
|
||||||
|
from unicorn import UnicornMiddleware
|
||||||
|
|
||||||
|
app = FastAPI()
|
||||||
|
|
||||||
|
app.add_middleware(UnicornMiddleware, some_config="rainbow")
|
||||||
|
```
|
||||||
|
|
||||||
|
`app.add_middleware()` 📨 🛠️ 🎓 🥇 ❌ & 🙆 🌖 ❌ 🚶♀️ 🛠️.
|
||||||
|
|
||||||
|
## 🛠️ 🛠️
|
||||||
|
|
||||||
|
**FastAPI** 🔌 📚 🛠️ ⚠ ⚙️ 💼, 👥 🔜 👀 ⏭ ❔ ⚙️ 👫.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
⏭ 🖼, 👆 💪 ⚙️ `from starlette.middleware.something import SomethingMiddleware`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 📚 🛠️ `fastapi.middleware` 🏪 👆, 👩💻. ✋️ 🌅 💪 🛠️ 👟 🔗 ⚪️➡️ 💃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## `HTTPSRedirectMiddleware`
|
||||||
|
|
||||||
|
🛠️ 👈 🌐 📨 📨 🔜 👯♂️ `https` ⚖️ `wss`.
|
||||||
|
|
||||||
|
🙆 📨 📨 `http` ⚖️ `ws` 🔜 ❎ 🔐 ⚖ ↩️.
|
||||||
|
|
||||||
|
{* ../../docs_src/advanced_middleware/tutorial001.py hl[2,6] *}
|
||||||
|
|
||||||
|
## `TrustedHostMiddleware`
|
||||||
|
|
||||||
|
🛠️ 👈 🌐 📨 📨 ✔️ ☑ ⚒ `Host` 🎚, ✔ 💂♂ 🛡 🇺🇸🔍 🦠 🎚 👊.
|
||||||
|
|
||||||
|
{* ../../docs_src/advanced_middleware/tutorial002.py hl[2,6:8] *}
|
||||||
|
|
||||||
|
📄 ❌ 🐕🦺:
|
||||||
|
|
||||||
|
* `allowed_hosts` - 📇 🆔 📛 👈 🔜 ✔ 📛. 🃏 🆔 ✅ `*.example.com` 🐕🦺 🎀 📁. ✔ 🙆 📛 👯♂️ ⚙️ `allowed_hosts=["*"]` ⚖️ 🚫 🛠️.
|
||||||
|
|
||||||
|
🚥 📨 📨 🔨 🚫 ✔ ☑ ⤴️ `400` 📨 🔜 📨.
|
||||||
|
|
||||||
|
## `GZipMiddleware`
|
||||||
|
|
||||||
|
🍵 🗜 📨 🙆 📨 👈 🔌 `"gzip"` `Accept-Encoding` 🎚.
|
||||||
|
|
||||||
|
🛠️ 🔜 🍵 👯♂️ 🐩 & 🎥 📨.
|
||||||
|
|
||||||
|
{* ../../docs_src/advanced_middleware/tutorial003.py hl[2,6] *}
|
||||||
|
|
||||||
|
📄 ❌ 🐕🦺:
|
||||||
|
|
||||||
|
* `minimum_size` - 🚫 🗜 📨 👈 🤪 🌘 👉 💯 📐 🔢. 🔢 `500`.
|
||||||
|
|
||||||
|
## 🎏 🛠️
|
||||||
|
|
||||||
|
📤 📚 🎏 🔫 🛠️.
|
||||||
|
|
||||||
|
🖼:
|
||||||
|
|
||||||
|
* <a href="https://github.com/encode/uvicorn/blob/master/uvicorn/middleware/proxy_headers.py" class="external-link" target="_blank">Uvicorn `ProxyHeadersMiddleware`</a>
|
||||||
|
* <a href="https://github.com/florimondmanca/msgpack-asgi" class="external-link" target="_blank">🇸🇲</a>
|
||||||
|
|
||||||
|
👀 🎏 💪 🛠️ ✅ <a href="https://www.starlette.dev/middleware/" class="external-link" target="_blank">💃 🛠️ 🩺</a> & <a href="https://github.com/florimondmanca/awesome-asgi" class="external-link" target="_blank">🔫 👌 📇</a>.
|
||||||
|
|
@ -0,0 +1,186 @@
|
||||||
|
# 🗄 ⏲
|
||||||
|
|
||||||
|
👆 💪 ✍ 🛠️ ⏮️ *➡ 🛠️* 👈 💪 ⏲ 📨 *🔢 🛠️* ✍ 👱 🙆 (🎲 🎏 👩💻 👈 🔜 *⚙️* 👆 🛠️).
|
||||||
|
|
||||||
|
🛠️ 👈 🔨 🕐❔ 👆 🛠️ 📱 🤙 *🔢 🛠️* 📛 "⏲". ↩️ 🖥 👈 🔢 👩💻 ✍ 📨 📨 👆 🛠️ & ⤴️ 👆 🛠️ *🤙 🔙*, 📨 📨 *🔢 🛠️* (👈 🎲 ✍ 🎏 👩💻).
|
||||||
|
|
||||||
|
👉 💼, 👆 💪 💚 📄 ❔ 👈 🔢 🛠️ *🔜* 👀 💖. ⚫️❔ *➡ 🛠️* ⚫️ 🔜 ✔️, ⚫️❔ 💪 ⚫️ 🔜 ⌛, ⚫️❔ 📨 ⚫️ 🔜 📨, ♒️.
|
||||||
|
|
||||||
|
## 📱 ⏮️ ⏲
|
||||||
|
|
||||||
|
➡️ 👀 🌐 👉 ⏮️ 🖼.
|
||||||
|
|
||||||
|
🌈 👆 🛠️ 📱 👈 ✔ 🏗 🧾.
|
||||||
|
|
||||||
|
👉 🧾 🔜 ✔️ `id`, `title` (📦), `customer`, & `total`.
|
||||||
|
|
||||||
|
👩💻 👆 🛠️ (🔢 👩💻) 🔜 ✍ 🧾 👆 🛠️ ⏮️ 🏤 📨.
|
||||||
|
|
||||||
|
⤴️ 👆 🛠️ 🔜 (➡️ 🌈):
|
||||||
|
|
||||||
|
* 📨 🧾 🕴 🔢 👩💻.
|
||||||
|
* 📈 💸.
|
||||||
|
* 📨 📨 🔙 🛠️ 👩💻 (🔢 👩💻).
|
||||||
|
* 👉 🔜 🔨 📨 🏤 📨 (⚪️➡️ *👆 🛠️*) *🔢 🛠️* 🚚 👈 🔢 👩💻 (👉 "⏲").
|
||||||
|
|
||||||
|
## 😐 **FastAPI** 📱
|
||||||
|
|
||||||
|
➡️ 🥇 👀 ❔ 😐 🛠️ 📱 🔜 👀 💖 ⏭ ❎ ⏲.
|
||||||
|
|
||||||
|
⚫️ 🔜 ✔️ *➡ 🛠️* 👈 🔜 📨 `Invoice` 💪, & 🔢 🔢 `callback_url` 👈 🔜 🔌 📛 ⏲.
|
||||||
|
|
||||||
|
👉 🍕 📶 😐, 🌅 📟 🎲 ⏪ 😰 👆:
|
||||||
|
|
||||||
|
{* ../../docs_src/openapi_callbacks/tutorial001.py hl[9:13,36:53] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
`callback_url` 🔢 🔢 ⚙️ Pydantic <a href="https://docs.pydantic.dev/latest/concepts/types/#urls" class="external-link" target="_blank">📛</a> 🆎.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🕴 🆕 👜 `callbacks=messages_callback_router.routes` ❌ *➡ 🛠️ 👨🎨*. 👥 🔜 👀 ⚫️❔ 👈 ⏭.
|
||||||
|
|
||||||
|
## 🔬 ⏲
|
||||||
|
|
||||||
|
☑ ⏲ 📟 🔜 🪀 🙇 🔛 👆 👍 🛠️ 📱.
|
||||||
|
|
||||||
|
& ⚫️ 🔜 🎲 🪀 📚 ⚪️➡️ 1️⃣ 📱 ⏭.
|
||||||
|
|
||||||
|
⚫️ 💪 1️⃣ ⚖️ 2️⃣ ⏸ 📟, 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
callback_url = "https://example.com/api/v1/invoices/events/"
|
||||||
|
httpx.post(callback_url, json={"description": "Invoice paid", "paid": True})
|
||||||
|
```
|
||||||
|
|
||||||
|
✋️ 🎲 🏆 ⚠ 🍕 ⏲ ⚒ 💭 👈 👆 🛠️ 👩💻 (🔢 👩💻) 🛠️ *🔢 🛠️* ☑, 🛄 💽 👈 *👆 🛠️* 🔜 📨 📨 💪 ⏲, ♒️.
|
||||||
|
|
||||||
|
, ⚫️❔ 👥 🔜 ⏭ 🚮 📟 📄 ❔ 👈 *🔢 🛠️* 🔜 👀 💖 📨 ⏲ ⚪️➡️ *👆 🛠️*.
|
||||||
|
|
||||||
|
👈 🧾 🔜 🎦 🆙 🦁 🎚 `/docs` 👆 🛠️, & ⚫️ 🔜 ➡️ 🔢 👩💻 💭 ❔ 🏗 *🔢 🛠️*.
|
||||||
|
|
||||||
|
👉 🖼 🚫 🛠️ ⏲ ⚫️ (👈 💪 ⏸ 📟), 🕴 🧾 🍕.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
☑ ⏲ 🇺🇸🔍 📨.
|
||||||
|
|
||||||
|
🕐❔ 🛠️ ⏲ 👆, 👆 💪 ⚙️ 🕳 💖 <a href="https://www.python-httpx.org" class="external-link" target="_blank">🇸🇲</a> ⚖️ <a href="https://requests.readthedocs.io/" class="external-link" target="_blank">📨</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ✍ ⏲ 🧾 📟
|
||||||
|
|
||||||
|
👉 📟 🏆 🚫 🛠️ 👆 📱, 👥 🕴 💪 ⚫️ *📄* ❔ 👈 *🔢 🛠️* 🔜 👀 💖.
|
||||||
|
|
||||||
|
✋️, 👆 ⏪ 💭 ❔ 💪 ✍ 🏧 🧾 🛠️ ⏮️ **FastAPI**.
|
||||||
|
|
||||||
|
👥 🔜 ⚙️ 👈 🎏 💡 📄 ❔ *🔢 🛠️* 🔜 👀 💖... 🏗 *➡ 🛠️(Ⓜ)* 👈 🔢 🛠️ 🔜 🛠️ (🕐 👆 🛠️ 🔜 🤙).
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🕐❔ ✍ 📟 📄 ⏲, ⚫️ 💪 ⚠ 🌈 👈 👆 👈 *🔢 👩💻*. & 👈 👆 ⏳ 🛠️ *🔢 🛠️*, 🚫 *👆 🛠️*.
|
||||||
|
|
||||||
|
🍕 🛠️ 👉 ☝ 🎑 ( *🔢 👩💻*) 💪 ℹ 👆 💭 💖 ⚫️ 🌅 ⭐ 🌐❔ 🚮 🔢, Pydantic 🏷 💪, 📨, ♒️. 👈 *🔢 🛠️*.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ✍ ⏲ `APIRouter`
|
||||||
|
|
||||||
|
🥇 ✍ 🆕 `APIRouter` 👈 🔜 🔌 1️⃣ ⚖️ 🌅 ⏲.
|
||||||
|
|
||||||
|
{* ../../docs_src/openapi_callbacks/tutorial001.py hl[3,25] *}
|
||||||
|
|
||||||
|
### ✍ ⏲ *➡ 🛠️*
|
||||||
|
|
||||||
|
✍ ⏲ *➡ 🛠️* ⚙️ 🎏 `APIRouter` 👆 ✍ 🔛.
|
||||||
|
|
||||||
|
⚫️ 🔜 👀 💖 😐 FastAPI *➡ 🛠️*:
|
||||||
|
|
||||||
|
* ⚫️ 🔜 🎲 ✔️ 📄 💪 ⚫️ 🔜 📨, ✅ `body: InvoiceEvent`.
|
||||||
|
* & ⚫️ 💪 ✔️ 📄 📨 ⚫️ 🔜 📨, ✅ `response_model=InvoiceEventReceived`.
|
||||||
|
|
||||||
|
{* ../../docs_src/openapi_callbacks/tutorial001.py hl[16:18,21:22,28:32] *}
|
||||||
|
|
||||||
|
📤 2️⃣ 👑 🔺 ⚪️➡️ 😐 *➡ 🛠️*:
|
||||||
|
|
||||||
|
* ⚫️ 🚫 💪 ✔️ 🙆 ☑ 📟, ↩️ 👆 📱 🔜 🙅 🤙 👉 📟. ⚫️ 🕴 ⚙️ 📄 *🔢 🛠️*. , 🔢 💪 ✔️ `pass`.
|
||||||
|
* *➡* 💪 🔌 <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#key-expression" class="external-link" target="_blank">🗄 3️⃣ 🧬</a> (👀 🌖 🔛) 🌐❔ ⚫️ 💪 ⚙️ 🔢 ⏮️ 🔢 & 🍕 ⏮️ 📨 📨 *👆 🛠️*.
|
||||||
|
|
||||||
|
### ⏲ ➡ 🧬
|
||||||
|
|
||||||
|
⏲ *➡* 💪 ✔️ <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#key-expression" class="external-link" target="_blank">🗄 3️⃣ 🧬</a> 👈 💪 🔌 🍕 ⏮️ 📨 📨 *👆 🛠️*.
|
||||||
|
|
||||||
|
👉 💼, ⚫️ `str`:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
"{$callback_url}/invoices/{$request.body.id}"
|
||||||
|
```
|
||||||
|
|
||||||
|
, 🚥 👆 🛠️ 👩💻 (🔢 👩💻) 📨 📨 *👆 🛠️* :
|
||||||
|
|
||||||
|
```
|
||||||
|
https://yourapi.com/invoices/?callback_url=https://www.external.org/events
|
||||||
|
```
|
||||||
|
|
||||||
|
⏮️ 🎻 💪:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"id": "2expen51ve",
|
||||||
|
"customer": "Mr. Richie Rich",
|
||||||
|
"total": "9999"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
⤴️ *👆 🛠️* 🔜 🛠️ 🧾, & ☝ ⏪, 📨 ⏲ 📨 `callback_url` ( *🔢 🛠️*):
|
||||||
|
|
||||||
|
```
|
||||||
|
https://www.external.org/events/invoices/2expen51ve
|
||||||
|
```
|
||||||
|
|
||||||
|
⏮️ 🎻 💪 ⚗ 🕳 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"description": "Payment celebration",
|
||||||
|
"paid": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
& ⚫️ 🔜 ⌛ 📨 ⚪️➡️ 👈 *🔢 🛠️* ⏮️ 🎻 💪 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"ok": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 ❔ ⏲ 📛 ⚙️ 🔌 📛 📨 🔢 🔢 `callback_url` (`https://www.external.org/events`) & 🧾 `id` ⚪️➡️ 🔘 🎻 💪 (`2expen51ve`).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🚮 ⏲ 📻
|
||||||
|
|
||||||
|
👉 ☝ 👆 ✔️ *⏲ ➡ 🛠️(Ⓜ)* 💪 (1️⃣(Ⓜ) 👈 *🔢 👩💻* 🔜 🛠️ *🔢 🛠️*) ⏲ 📻 👆 ✍ 🔛.
|
||||||
|
|
||||||
|
🔜 ⚙️ 🔢 `callbacks` *👆 🛠️ ➡ 🛠️ 👨🎨* 🚶♀️ 🔢 `.routes` (👈 🤙 `list` 🛣/*➡ 🛠️*) ⚪️➡️ 👈 ⏲ 📻:
|
||||||
|
|
||||||
|
{* ../../docs_src/openapi_callbacks/tutorial001.py hl[35] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 👈 👆 🚫 🚶♀️ 📻 ⚫️ (`invoices_callback_router`) `callback=`, ✋️ 🔢 `.routes`, `invoices_callback_router.routes`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ✅ 🩺
|
||||||
|
|
||||||
|
🔜 👆 💪 ▶️ 👆 📱 ⏮️ Uvicorn & 🚶 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
|
||||||
|
|
||||||
|
👆 🔜 👀 👆 🩺 ✅ "⏲" 📄 👆 *➡ 🛠️* 👈 🎦 ❔ *🔢 🛠️* 🔜 👀 💖:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/openapi-callbacks/image01.png">
|
||||||
|
|
@ -0,0 +1,172 @@
|
||||||
|
# ➡ 🛠️ 🏧 📳
|
||||||
|
|
||||||
|
## 🗄 {
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
🚥 👆 🚫 "🕴" 🗄, 👆 🎲 🚫 💪 👉.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👆 💪 ⚒ 🗄 `operationId` ⚙️ 👆 *➡ 🛠️* ⏮️ 🔢 `operation_id`.
|
||||||
|
|
||||||
|
👆 🔜 ✔️ ⚒ 💭 👈 ⚫️ 😍 🔠 🛠️.
|
||||||
|
|
||||||
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial001.py hl[6] *}
|
||||||
|
|
||||||
|
### ⚙️ *➡ 🛠️ 🔢* 📛 {
|
||||||
|
|
||||||
|
🚥 👆 💚 ⚙️ 👆 🔗' 🔢 📛 `operationId`Ⓜ, 👆 💪 🔁 🤭 🌐 👫 & 🔐 🔠 *➡ 🛠️* `operation_id` ⚙️ 👫 `APIRoute.name`.
|
||||||
|
|
||||||
|
👆 🔜 ⚫️ ⏮️ ❎ 🌐 👆 *➡ 🛠️*.
|
||||||
|
|
||||||
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial002.py hl[2,12:21,24] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 ❎ 🤙 `app.openapi()`, 👆 🔜 ℹ `operationId`Ⓜ ⏭ 👈.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
🚥 👆 👉, 👆 ✔️ ⚒ 💭 🔠 1️⃣ 👆 *➡ 🛠️ 🔢* ✔️ 😍 📛.
|
||||||
|
|
||||||
|
🚥 👫 🎏 🕹 (🐍 📁).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🚫 ⚪️➡️ 🗄
|
||||||
|
|
||||||
|
🚫 *➡ 🛠️* ⚪️➡️ 🏗 🗄 🔗 (& ➡️, ⚪️➡️ 🏧 🧾 ⚙️), ⚙️ 🔢 `include_in_schema` & ⚒ ⚫️ `False`:
|
||||||
|
|
||||||
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial003.py hl[6] *}
|
||||||
|
|
||||||
|
## 🏧 📛 ⚪️➡️ #️⃣
|
||||||
|
|
||||||
|
👆 💪 📉 ⏸ ⚙️ ⚪️➡️ #️⃣ *➡ 🛠️ 🔢* 🗄.
|
||||||
|
|
||||||
|
❎ `\f` (😖 "📨 🍼" 🦹) 🤕 **FastAPI** 🔁 🔢 ⚙️ 🗄 👉 ☝.
|
||||||
|
|
||||||
|
⚫️ 🏆 🚫 🎦 🆙 🧾, ✋️ 🎏 🧰 (✅ 🐉) 🔜 💪 ⚙️ 🎂.
|
||||||
|
|
||||||
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial004.py hl[19:29] *}
|
||||||
|
|
||||||
|
## 🌖 📨
|
||||||
|
|
||||||
|
👆 🎲 ✔️ 👀 ❔ 📣 `response_model` & `status_code` *➡ 🛠️*.
|
||||||
|
|
||||||
|
👈 🔬 🗃 🔃 👑 📨 *➡ 🛠️*.
|
||||||
|
|
||||||
|
👆 💪 📣 🌖 📨 ⏮️ 👫 🏷, 👔 📟, ♒️.
|
||||||
|
|
||||||
|
📤 🎂 📃 📥 🧾 🔃 ⚫️, 👆 💪 ✍ ⚫️ [🌖 📨 🗄](additional-responses.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
## 🗄 ➕
|
||||||
|
|
||||||
|
🕐❔ 👆 📣 *➡ 🛠️* 👆 🈸, **FastAPI** 🔁 🏗 🔗 🗃 🔃 👈 *➡ 🛠️* 🔌 🗄 🔗.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
🗄 🔧 ⚫️ 🤙 <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object" class="external-link" target="_blank">🛠️ 🎚</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
⚫️ ✔️ 🌐 ℹ 🔃 *➡ 🛠️* & ⚙️ 🏗 🏧 🧾.
|
||||||
|
|
||||||
|
⚫️ 🔌 `tags`, `parameters`, `requestBody`, `responses`, ♒️.
|
||||||
|
|
||||||
|
👉 *➡ 🛠️*-🎯 🗄 🔗 🛎 🏗 🔁 **FastAPI**, ✋️ 👆 💪 ↔ ⚫️.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👉 🔅 🎚 ↔ ☝.
|
||||||
|
|
||||||
|
🚥 👆 🕴 💪 📣 🌖 📨, 🌅 🏪 🌌 ⚫️ ⏮️ [🌖 📨 🗄](additional-responses.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👆 💪 ↔ 🗄 🔗 *➡ 🛠️* ⚙️ 🔢 `openapi_extra`.
|
||||||
|
|
||||||
|
### 🗄 ↔
|
||||||
|
|
||||||
|
👉 `openapi_extra` 💪 👍, 🖼, 📣 [🗄 ↔](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specificationExtensions):
|
||||||
|
|
||||||
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial005.py hl[6] *}
|
||||||
|
|
||||||
|
🚥 👆 📂 🏧 🛠️ 🩺, 👆 ↔ 🔜 🎦 🆙 🔝 🎯 *➡ 🛠️*.
|
||||||
|
|
||||||
|
<img src="/img/tutorial/path-operation-advanced-configuration/image01.png">
|
||||||
|
|
||||||
|
& 🚥 👆 👀 📉 🗄 ( `/openapi.json` 👆 🛠️), 👆 🔜 👀 👆 ↔ 🍕 🎯 *➡ 🛠️* 💁♂️:
|
||||||
|
|
||||||
|
```JSON hl_lines="22"
|
||||||
|
{
|
||||||
|
"openapi": "3.0.2",
|
||||||
|
"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_extra` 🔜 🙇 🔗 ⏮️ 🔁 🏗 🗄 🔗 *➡ 🛠️*.
|
||||||
|
|
||||||
|
, 👆 💪 🚮 🌖 💽 🔁 🏗 🔗.
|
||||||
|
|
||||||
|
🖼, 👆 💪 💭 ✍ & ✔ 📨 ⏮️ 👆 👍 📟, 🍵 ⚙️ 🏧 ⚒ FastAPI ⏮️ Pydantic, ✋️ 👆 💪 💚 🔬 📨 🗄 🔗.
|
||||||
|
|
||||||
|
👆 💪 👈 ⏮️ `openapi_extra`:
|
||||||
|
|
||||||
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial006.py hl[20:37,39:40] *}
|
||||||
|
|
||||||
|
👉 🖼, 👥 🚫 📣 🙆 Pydantic 🏷. 👐, 📨 💪 🚫 <abbr title="converted from some plain format, like bytes, into Python objects">🎻</abbr> 🎻, ⚫️ ✍ 🔗 `bytes`, & 🔢 `magic_data_reader()` 🔜 🈚 🎻 ⚫️ 🌌.
|
||||||
|
|
||||||
|
👐, 👥 💪 📣 📈 🔗 📨 💪.
|
||||||
|
|
||||||
|
### 🛃 🗄 🎚 🆎
|
||||||
|
|
||||||
|
⚙️ 👉 🎏 🎱, 👆 💪 ⚙️ Pydantic 🏷 🔬 🎻 🔗 👈 ⤴️ 🔌 🛃 🗄 🔗 📄 *➡ 🛠️*.
|
||||||
|
|
||||||
|
& 👆 💪 👉 🚥 💽 🆎 📨 🚫 🎻.
|
||||||
|
|
||||||
|
🖼, 👉 🈸 👥 🚫 ⚙️ FastAPI 🛠️ 🛠️ ⚗ 🎻 🔗 ⚪️➡️ Pydantic 🏷 🚫 🏧 🔬 🎻. 👐, 👥 📣 📨 🎚 🆎 📁, 🚫 🎻:
|
||||||
|
|
||||||
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial007.py hl[17:22,24] *}
|
||||||
|
|
||||||
|
👐, 👐 👥 🚫 ⚙️ 🔢 🛠️ 🛠️, 👥 ⚙️ Pydantic 🏷 ❎ 🏗 🎻 🔗 💽 👈 👥 💚 📨 📁.
|
||||||
|
|
||||||
|
⤴️ 👥 ⚙️ 📨 🔗, & ⚗ 💪 `bytes`. 👉 ⛓ 👈 FastAPI 🏆 🚫 🔄 🎻 📨 🚀 🎻.
|
||||||
|
|
||||||
|
& ⤴️ 👆 📟, 👥 🎻 👈 📁 🎚 🔗, & ⤴️ 👥 🔄 ⚙️ 🎏 Pydantic 🏷 ✔ 📁 🎚:
|
||||||
|
|
||||||
|
{* ../../docs_src/path_operation_advanced_configuration/tutorial007.py hl[26:33] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
📥 👥 🏤-⚙️ 🎏 Pydantic 🏷.
|
||||||
|
|
||||||
|
✋️ 🎏 🌌, 👥 💪 ✔️ ✔ ⚫️ 🎏 🌌.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
# 📨 - 🔀 👔 📟
|
||||||
|
|
||||||
|
👆 🎲 ✍ ⏭ 👈 👆 💪 ⚒ 🔢 [📨 👔 📟](../tutorial/response-status-code.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
✋️ 💼 👆 💪 📨 🎏 👔 📟 🌘 🔢.
|
||||||
|
|
||||||
|
## ⚙️ 💼
|
||||||
|
|
||||||
|
🖼, 🌈 👈 👆 💚 📨 🇺🇸🔍 👔 📟 "👌" `200` 🔢.
|
||||||
|
|
||||||
|
✋️ 🚥 💽 🚫 🔀, 👆 💚 ✍ ⚫️, & 📨 🇺🇸🔍 👔 📟 "✍" `201`.
|
||||||
|
|
||||||
|
✋️ 👆 💚 💪 ⛽ & 🗜 💽 👆 📨 ⏮️ `response_model`.
|
||||||
|
|
||||||
|
📚 💼, 👆 💪 ⚙️ `Response` 🔢.
|
||||||
|
|
||||||
|
## ⚙️ `Response` 🔢
|
||||||
|
|
||||||
|
👆 💪 📣 🔢 🆎 `Response` 👆 *➡ 🛠️ 🔢* (👆 💪 🍪 & 🎚).
|
||||||
|
|
||||||
|
& ⤴️ 👆 💪 ⚒ `status_code` 👈 *🔀* 📨 🎚.
|
||||||
|
|
||||||
|
{* ../../docs_src/response_change_status_code/tutorial001.py hl[1,9,12] *}
|
||||||
|
|
||||||
|
& ⤴️ 👆 💪 📨 🙆 🎚 👆 💪, 👆 🛎 🔜 ( `dict`, 💽 🏷, ♒️).
|
||||||
|
|
||||||
|
& 🚥 👆 📣 `response_model`, ⚫️ 🔜 ⚙️ ⛽ & 🗜 🎚 👆 📨.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ⚙️ 👈 *🔀* 📨 ⚗ 👔 📟 (🍪 & 🎚), & 🔜 🚮 👫 🏁 📨 👈 🔌 💲 👆 📨, ⛽ 🙆 `response_model`.
|
||||||
|
|
||||||
|
👆 💪 📣 `Response` 🔢 🔗, & ⚒ 👔 📟 👫. ✋️ ✔️ 🤯 👈 🏁 1️⃣ ⚒ 🔜 🏆.
|
||||||
|
|
@ -0,0 +1,51 @@
|
||||||
|
# 📨 🍪
|
||||||
|
|
||||||
|
## ⚙️ `Response` 🔢
|
||||||
|
|
||||||
|
👆 💪 📣 🔢 🆎 `Response` 👆 *➡ 🛠️ 🔢*.
|
||||||
|
|
||||||
|
& ⤴️ 👆 💪 ⚒ 🍪 👈 *🔀* 📨 🎚.
|
||||||
|
|
||||||
|
{* ../../docs_src/response_cookies/tutorial002.py hl[1,8:9] *}
|
||||||
|
|
||||||
|
& ⤴️ 👆 💪 📨 🙆 🎚 👆 💪, 👆 🛎 🔜 ( `dict`, 💽 🏷, ♒️).
|
||||||
|
|
||||||
|
& 🚥 👆 📣 `response_model`, ⚫️ 🔜 ⚙️ ⛽ & 🗜 🎚 👆 📨.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ⚙️ 👈 *🔀* 📨 ⚗ 🍪 (🎚 & 👔 📟), & 🔜 🚮 👫 🏁 📨 👈 🔌 💲 👆 📨, ⛽ 🙆 `response_model`.
|
||||||
|
|
||||||
|
👆 💪 📣 `Response` 🔢 🔗, & ⚒ 🍪 (& 🎚) 👫.
|
||||||
|
|
||||||
|
## 📨 `Response` 🔗
|
||||||
|
|
||||||
|
👆 💪 ✍ 🍪 🕐❔ 🛬 `Response` 🔗 👆 📟.
|
||||||
|
|
||||||
|
👈, 👆 💪 ✍ 📨 🔬 [📨 📨 🔗](response-directly.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
⤴️ ⚒ 🍪 ⚫️, & ⤴️ 📨 ⚫️:
|
||||||
|
|
||||||
|
{* ../../docs_src/response_cookies/tutorial001.py hl[10:12] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
✔️ 🤯 👈 🚥 👆 📨 📨 🔗 ↩️ ⚙️ `Response` 🔢, FastAPI 🔜 📨 ⚫️ 🔗.
|
||||||
|
|
||||||
|
, 👆 🔜 ✔️ ⚒ 💭 👆 💽 ☑ 🆎. 🤶 Ⓜ. ⚫️ 🔗 ⏮️ 🎻, 🚥 👆 🛬 `JSONResponse`.
|
||||||
|
|
||||||
|
& 👈 👆 🚫 📨 🙆 📊 👈 🔜 ✔️ ⛽ `response_model`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🌅 ℹ
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.responses import Response` ⚖️ `from starlette.responses import JSONResponse`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 🎏 `starlette.responses` `fastapi.responses` 🏪 👆, 👩💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃.
|
||||||
|
|
||||||
|
& `Response` 💪 ⚙️ 🛎 ⚒ 🎚 & 🍪, **FastAPI** 🚚 ⚫️ `fastapi.Response`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👀 🌐 💪 🔢 & 🎛, ✅ <a href="https://www.starlette.dev/responses/#set-cookie" class="external-link" target="_blank">🧾 💃</a>.
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
# 📨 📨 🔗
|
||||||
|
|
||||||
|
🕐❔ 👆 ✍ **FastAPI** *➡ 🛠️* 👆 💪 🛎 📨 🙆 📊 ⚪️➡️ ⚫️: `dict`, `list`, Pydantic 🏷, 💽 🏷, ♒️.
|
||||||
|
|
||||||
|
🔢, **FastAPI** 🔜 🔁 🗜 👈 📨 💲 🎻 ⚙️ `jsonable_encoder` 🔬 [🎻 🔗 🔢](../tutorial/encoder.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
⤴️, ⛅ 🎑, ⚫️ 🔜 🚮 👈 🎻-🔗 💽 (✅ `dict`) 🔘 `JSONResponse` 👈 🔜 ⚙️ 📨 📨 👩💻.
|
||||||
|
|
||||||
|
✋️ 👆 💪 📨 `JSONResponse` 🔗 ⚪️➡️ 👆 *➡ 🛠️*.
|
||||||
|
|
||||||
|
⚫️ 💪 ⚠, 🖼, 📨 🛃 🎚 ⚖️ 🍪.
|
||||||
|
|
||||||
|
## 📨 `Response`
|
||||||
|
|
||||||
|
👐, 👆 💪 📨 🙆 `Response` ⚖️ 🙆 🎧-🎓 ⚫️.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
`JSONResponse` ⚫️ 🎧-🎓 `Response`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
& 🕐❔ 👆 📨 `Response`, **FastAPI** 🔜 🚶♀️ ⚫️ 🔗.
|
||||||
|
|
||||||
|
⚫️ 🏆 🚫 🙆 💽 🛠️ ⏮️ Pydantic 🏷, ⚫️ 🏆 🚫 🗜 🎚 🙆 🆎, ♒️.
|
||||||
|
|
||||||
|
👉 🤝 👆 📚 💪. 👆 💪 📨 🙆 📊 🆎, 🔐 🙆 💽 📄 ⚖️ 🔬, ♒️.
|
||||||
|
|
||||||
|
## ⚙️ `jsonable_encoder` `Response`
|
||||||
|
|
||||||
|
↩️ **FastAPI** 🚫 🙆 🔀 `Response` 👆 📨, 👆 ✔️ ⚒ 💭 ⚫️ 🎚 🔜 ⚫️.
|
||||||
|
|
||||||
|
🖼, 👆 🚫🔜 🚮 Pydantic 🏷 `JSONResponse` 🍵 🥇 🏭 ⚫️ `dict` ⏮️ 🌐 📊 🆎 (💖 `datetime`, `UUID`, ♒️) 🗜 🎻-🔗 🆎.
|
||||||
|
|
||||||
|
📚 💼, 👆 💪 ⚙️ `jsonable_encoder` 🗜 👆 📊 ⏭ 🚶♀️ ⚫️ 📨:
|
||||||
|
|
||||||
|
{* ../../docs_src/response_directly/tutorial001.py hl[6:7,21:22] *}
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.responses import JSONResponse`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 🎏 `starlette.responses` `fastapi.responses` 🏪 👆, 👩💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🛬 🛃 `Response`
|
||||||
|
|
||||||
|
🖼 🔛 🎦 🌐 🍕 👆 💪, ✋️ ⚫️ 🚫 📶 ⚠, 👆 💪 ✔️ 📨 `item` 🔗, & **FastAPI** 🔜 🚮 ⚫️ `JSONResponse` 👆, 🏭 ⚫️ `dict`, ♒️. 🌐 👈 🔢.
|
||||||
|
|
||||||
|
🔜, ➡️ 👀 ❔ 👆 💪 ⚙️ 👈 📨 🛃 📨.
|
||||||
|
|
||||||
|
➡️ 💬 👈 👆 💚 📨 <a href="https://en.wikipedia.org/wiki/XML" class="external-link" target="_blank">📂</a> 📨.
|
||||||
|
|
||||||
|
👆 💪 🚮 👆 📂 🎚 🎻, 🚮 ⚫️ `Response`, & 📨 ⚫️:
|
||||||
|
|
||||||
|
{* ../../docs_src/response_directly/tutorial002.py hl[1,18] *}
|
||||||
|
|
||||||
|
## 🗒
|
||||||
|
|
||||||
|
🕐❔ 👆 📨 `Response` 🔗 🚮 📊 🚫 ✔, 🗜 (🎻), 🚫 📄 🔁.
|
||||||
|
|
||||||
|
✋️ 👆 💪 📄 ⚫️ 🔬 [🌖 📨 🗄](additional-responses.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
👆 💪 👀 ⏪ 📄 ❔ ⚙️/📣 👉 🛃 `Response`Ⓜ ⏪ ✔️ 🏧 💽 🛠️, 🧾, ♒️.
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# 📨 🎚
|
||||||
|
|
||||||
|
## ⚙️ `Response` 🔢
|
||||||
|
|
||||||
|
👆 💪 📣 🔢 🆎 `Response` 👆 *➡ 🛠️ 🔢* (👆 💪 🍪).
|
||||||
|
|
||||||
|
& ⤴️ 👆 💪 ⚒ 🎚 👈 *🔀* 📨 🎚.
|
||||||
|
|
||||||
|
{* ../../docs_src/response_headers/tutorial002.py hl[1,7:8] *}
|
||||||
|
|
||||||
|
& ⤴️ 👆 💪 📨 🙆 🎚 👆 💪, 👆 🛎 🔜 ( `dict`, 💽 🏷, ♒️).
|
||||||
|
|
||||||
|
& 🚥 👆 📣 `response_model`, ⚫️ 🔜 ⚙️ ⛽ & 🗜 🎚 👆 📨.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ⚙️ 👈 *🔀* 📨 ⚗ 🎚 (🍪 & 👔 📟), & 🔜 🚮 👫 🏁 📨 👈 🔌 💲 👆 📨, ⛽ 🙆 `response_model`.
|
||||||
|
|
||||||
|
👆 💪 📣 `Response` 🔢 🔗, & ⚒ 🎚 (& 🍪) 👫.
|
||||||
|
|
||||||
|
## 📨 `Response` 🔗
|
||||||
|
|
||||||
|
👆 💪 🚮 🎚 🕐❔ 👆 📨 `Response` 🔗.
|
||||||
|
|
||||||
|
✍ 📨 🔬 [📨 📨 🔗](response-directly.md){.internal-link target=_blank} & 🚶♀️ 🎚 🌖 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/response_headers/tutorial001.py hl[10:12] *}
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.responses import Response` ⚖️ `from starlette.responses import JSONResponse`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 🎏 `starlette.responses` `fastapi.responses` 🏪 👆, 👩💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃.
|
||||||
|
|
||||||
|
& `Response` 💪 ⚙️ 🛎 ⚒ 🎚 & 🍪, **FastAPI** 🚚 ⚫️ `fastapi.Response`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🛃 🎚
|
||||||
|
|
||||||
|
✔️ 🤯 👈 🛃 © 🎚 💪 🚮 <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers" class="external-link" target="_blank">⚙️ '✖-' 🔡</a>.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 ✔️ 🛃 🎚 👈 👆 💚 👩💻 🖥 💪 👀, 👆 💪 🚮 👫 👆 ⚜ 📳 (✍ 🌅 [⚜ (✖️-🇨🇳 ℹ 🤝)](../tutorial/cors.md){.internal-link target=_blank}), ⚙️ 🔢 `expose_headers` 📄 <a href="https://www.starlette.dev/middleware/#corsmiddleware" class="external-link" target="_blank">💃 ⚜ 🩺</a>.
|
||||||
|
|
@ -0,0 +1,107 @@
|
||||||
|
# 🇺🇸🔍 🔰 🔐
|
||||||
|
|
||||||
|
🙅 💼, 👆 💪 ⚙️ 🇺🇸🔍 🔰 🔐.
|
||||||
|
|
||||||
|
🇺🇸🔍 🔰 🔐, 🈸 ⌛ 🎚 👈 🔌 🆔 & 🔐.
|
||||||
|
|
||||||
|
🚥 ⚫️ 🚫 📨 ⚫️, ⚫️ 📨 🇺🇸🔍 4️⃣0️⃣1️⃣ "⛔" ❌.
|
||||||
|
|
||||||
|
& 📨 🎚 `WWW-Authenticate` ⏮️ 💲 `Basic`, & 📦 `realm` 🔢.
|
||||||
|
|
||||||
|
👈 💬 🖥 🎦 🛠️ 📋 🆔 & 🔐.
|
||||||
|
|
||||||
|
⤴️, 🕐❔ 👆 🆎 👈 🆔 & 🔐, 🖥 📨 👫 🎚 🔁.
|
||||||
|
|
||||||
|
## 🙅 🇺🇸🔍 🔰 🔐
|
||||||
|
|
||||||
|
* 🗄 `HTTPBasic` & `HTTPBasicCredentials`.
|
||||||
|
* ✍ "`security` ⚖" ⚙️ `HTTPBasic`.
|
||||||
|
* ⚙️ 👈 `security` ⏮️ 🔗 👆 *➡ 🛠️*.
|
||||||
|
* ⚫️ 📨 🎚 🆎 `HTTPBasicCredentials`:
|
||||||
|
* ⚫️ 🔌 `username` & `password` 📨.
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial006.py hl[2,6,10] *}
|
||||||
|
|
||||||
|
🕐❔ 👆 🔄 📂 📛 🥇 🕰 (⚖️ 🖊 "🛠️" 🔼 🩺) 🖥 🔜 💭 👆 👆 🆔 & 🔐:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/security/image12.png">
|
||||||
|
|
||||||
|
## ✅ 🆔
|
||||||
|
|
||||||
|
📥 🌅 🏁 🖼.
|
||||||
|
|
||||||
|
⚙️ 🔗 ✅ 🚥 🆔 & 🔐 ☑.
|
||||||
|
|
||||||
|
👉, ⚙️ 🐍 🐩 🕹 <a href="https://docs.python.org/3/library/secrets.html" class="external-link" target="_blank">`secrets`</a> ✅ 🆔 & 🔐.
|
||||||
|
|
||||||
|
`secrets.compare_digest()` 💪 ✊ `bytes` ⚖️ `str` 👈 🕴 🔌 🔠 🦹 (🕐 🇪🇸), 👉 ⛓ ⚫️ 🚫🔜 👷 ⏮️ 🦹 💖 `á`, `Sebastián`.
|
||||||
|
|
||||||
|
🍵 👈, 👥 🥇 🗜 `username` & `password` `bytes` 🔢 👫 ⏮️ 🔠-8️⃣.
|
||||||
|
|
||||||
|
⤴️ 👥 💪 ⚙️ `secrets.compare_digest()` 🚚 👈 `credentials.username` `"stanleyjobson"`, & 👈 `credentials.password` `"swordfish"`.
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial007.py hl[1,11:21] *}
|
||||||
|
|
||||||
|
👉 🔜 🎏:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
if not (credentials.username == "stanleyjobson") or not (credentials.password == "swordfish"):
|
||||||
|
# Return some error
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
✋️ ⚙️ `secrets.compare_digest()` ⚫️ 🔜 🔐 🛡 🆎 👊 🤙 "🕰 👊".
|
||||||
|
|
||||||
|
### ⏲ 👊
|
||||||
|
|
||||||
|
✋️ ⚫️❔ "⏲ 👊"❓
|
||||||
|
|
||||||
|
➡️ 🌈 👊 🔄 💭 🆔 & 🔐.
|
||||||
|
|
||||||
|
& 👫 📨 📨 ⏮️ 🆔 `johndoe` & 🔐 `love123`.
|
||||||
|
|
||||||
|
⤴️ 🐍 📟 👆 🈸 🔜 🌓 🕳 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
if "johndoe" == "stanleyjobson" and "love123" == "swordfish":
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
✋️ ▶️️ 🙍 🐍 🔬 🥇 `j` `johndoe` 🥇 `s` `stanleyjobson`, ⚫️ 🔜 📨 `False`, ↩️ ⚫️ ⏪ 💭 👈 📚 2️⃣ 🎻 🚫 🎏, 💭 👈 "📤 🙅♂ 💪 🗑 🌅 📊 ⚖ 🎂 🔤". & 👆 🈸 🔜 💬 "❌ 👩💻 ⚖️ 🔐".
|
||||||
|
|
||||||
|
✋️ ⤴️ 👊 🔄 ⏮️ 🆔 `stanleyjobsox` & 🔐 `love123`.
|
||||||
|
|
||||||
|
& 👆 🈸 📟 🔨 🕳 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
if "stanleyjobsox" == "stanleyjobson" and "love123" == "swordfish":
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
🐍 🔜 ✔️ 🔬 🎂 `stanleyjobso` 👯♂️ `stanleyjobsox` & `stanleyjobson` ⏭ 🤔 👈 👯♂️ 🎻 🚫 🎏. ⚫️ 🔜 ✊ ➕ ⏲ 📨 🔙 "❌ 👩💻 ⚖️ 🔐".
|
||||||
|
|
||||||
|
#### 🕰 ❔ ℹ 👊
|
||||||
|
|
||||||
|
👈 ☝, 👀 👈 💽 ✊ ⏲ 📏 📨 "❌ 👩💻 ⚖️ 🔐" 📨, 👊 🔜 💭 👈 👫 🤚 _🕳_ ▶️️, ▶️ 🔤 ▶️️.
|
||||||
|
|
||||||
|
& ⤴️ 👫 💪 🔄 🔄 🤔 👈 ⚫️ 🎲 🕳 🌖 🎏 `stanleyjobsox` 🌘 `johndoe`.
|
||||||
|
|
||||||
|
#### "🕴" 👊
|
||||||
|
|
||||||
|
↗️, 👊 🔜 🚫 🔄 🌐 👉 ✋, 👫 🔜 ✍ 📋 ⚫️, 🎲 ⏮️ 💯 ⚖️ 💯 💯 📍 🥈. & 🔜 🤚 1️⃣ ➕ ☑ 🔤 🕰.
|
||||||
|
|
||||||
|
✋️ 🔨 👈, ⏲ ⚖️ 📆 👊 🔜 ✔️ 💭 ☑ 🆔 & 🔐, ⏮️ "ℹ" 👆 🈸, ⚙️ 🕰 ✊ ❔.
|
||||||
|
|
||||||
|
#### 🔧 ⚫️ ⏮️ `secrets.compare_digest()`
|
||||||
|
|
||||||
|
✋️ 👆 📟 👥 🤙 ⚙️ `secrets.compare_digest()`.
|
||||||
|
|
||||||
|
📏, ⚫️ 🔜 ✊ 🎏 🕰 🔬 `stanleyjobsox` `stanleyjobson` 🌘 ⚫️ ✊ 🔬 `johndoe` `stanleyjobson`. & 🎏 🔐.
|
||||||
|
|
||||||
|
👈 🌌, ⚙️ `secrets.compare_digest()` 👆 🈸 📟, ⚫️ 🔜 🔒 🛡 👉 🎂 ↔ 💂♂ 👊.
|
||||||
|
|
||||||
|
### 📨 ❌
|
||||||
|
|
||||||
|
⏮️ 🔍 👈 🎓 ❌, 📨 `HTTPException` ⏮️ 👔 📟 4️⃣0️⃣1️⃣ (🎏 📨 🕐❔ 🙅♂ 🎓 🚚) & 🚮 🎚 `WWW-Authenticate` ⚒ 🖥 🎦 💳 📋 🔄:
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial007.py hl[23:27] *}
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
# 🏧 💂♂
|
||||||
|
|
||||||
|
## 🌖 ⚒
|
||||||
|
|
||||||
|
📤 ➕ ⚒ 🍵 💂♂ ↖️ ⚪️➡️ 🕐 📔 [🔰 - 👩💻 🦮: 💂♂](../../tutorial/security/index.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
⏭ 📄 **🚫 🎯 "🏧"**.
|
||||||
|
|
||||||
|
& ⚫️ 💪 👈 👆 ⚙️ 💼, ⚗ 1️⃣ 👫.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ✍ 🔰 🥇
|
||||||
|
|
||||||
|
⏭ 📄 🤔 👆 ⏪ ✍ 👑 [🔰 - 👩💻 🦮: 💂♂](../../tutorial/security/index.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
👫 🌐 ⚓️ 🔛 🎏 🔧, ✋️ ✔ ➕ 🛠️.
|
||||||
|
|
@ -0,0 +1,274 @@
|
||||||
|
# Oauth2️⃣ ↔
|
||||||
|
|
||||||
|
👆 💪 ⚙️ Oauth2️⃣ ↔ 🔗 ⏮️ **FastAPI**, 👫 🛠️ 👷 💎.
|
||||||
|
|
||||||
|
👉 🔜 ✔ 👆 ✔️ 🌖 👌-🧽 ✔ ⚙️, 📄 Oauth2️⃣ 🐩, 🛠️ 🔘 👆 🗄 🈸 (& 🛠️ 🩺).
|
||||||
|
|
||||||
|
Oauth2️⃣ ⏮️ ↔ 🛠️ ⚙️ 📚 🦏 🤝 🐕🦺, 💖 👱📔, 🇺🇸🔍, 📂, 🤸♂, 👱📔, ♒️. 👫 ⚙️ ⚫️ 🚚 🎯 ✔ 👩💻 & 🈸.
|
||||||
|
|
||||||
|
🔠 🕰 👆 "🕹 ⏮️" 👱📔, 🇺🇸🔍, 📂, 🤸♂, 👱📔, 👈 🈸 ⚙️ Oauth2️⃣ ⏮️ ↔.
|
||||||
|
|
||||||
|
👉 📄 👆 🔜 👀 ❔ 🛠️ 🤝 & ✔ ⏮️ 🎏 Oauth2️⃣ ⏮️ ↔ 👆 **FastAPI** 🈸.
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
👉 🌅 ⚖️ 🌘 🏧 📄. 🚥 👆 ▶️, 👆 💪 🚶 ⚫️.
|
||||||
|
|
||||||
|
👆 🚫 🎯 💪 Oauth2️⃣ ↔, & 👆 💪 🍵 🤝 & ✔ 👐 👆 💚.
|
||||||
|
|
||||||
|
✋️ Oauth2️⃣ ⏮️ ↔ 💪 🎆 🛠️ 🔘 👆 🛠️ (⏮️ 🗄) & 👆 🛠️ 🩺.
|
||||||
|
|
||||||
|
👐, 👆 🛠️ 📚 ↔, ⚖️ 🙆 🎏 💂♂/✔ 📄, 👐 👆 💪, 👆 📟.
|
||||||
|
|
||||||
|
📚 💼, Oauth2️⃣ ⏮️ ↔ 💪 👹.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 💭 👆 💪 ⚫️, ⚖️ 👆 😟, 🚧 👂.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## Oauth2️⃣ ↔ & 🗄
|
||||||
|
|
||||||
|
Oauth2️⃣ 🔧 🔬 "↔" 📇 🎻 🎏 🚀.
|
||||||
|
|
||||||
|
🎚 🔠 👉 🎻 💪 ✔️ 🙆 📁, ✋️ 🔜 🚫 🔌 🚀.
|
||||||
|
|
||||||
|
👫 ↔ 🎨 "✔".
|
||||||
|
|
||||||
|
🗄 (✅ 🛠️ 🩺), 👆 💪 🔬 "💂♂ ⚖".
|
||||||
|
|
||||||
|
🕐❔ 1️⃣ 👫 💂♂ ⚖ ⚙️ Oauth2️⃣, 👆 💪 📣 & ⚙️ ↔.
|
||||||
|
|
||||||
|
🔠 "↔" 🎻 (🍵 🚀).
|
||||||
|
|
||||||
|
👫 🛎 ⚙️ 📣 🎯 💂♂ ✔, 🖼:
|
||||||
|
|
||||||
|
* `users:read` ⚖️ `users:write` ⚠ 🖼.
|
||||||
|
* `instagram_basic` ⚙️ 👱📔 / 👱📔.
|
||||||
|
* `https://www.googleapis.com/auth/drive` ⚙️ 🇺🇸🔍.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
Oauth2️⃣ "↔" 🎻 👈 📣 🎯 ✔ ✔.
|
||||||
|
|
||||||
|
⚫️ 🚫 🤔 🚥 ⚫️ ✔️ 🎏 🦹 💖 `:` ⚖️ 🚥 ⚫️ 📛.
|
||||||
|
|
||||||
|
👈 ℹ 🛠️ 🎯.
|
||||||
|
|
||||||
|
Oauth2️⃣ 👫 🎻.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🌐 🎑
|
||||||
|
|
||||||
|
🥇, ➡️ 🔜 👀 🍕 👈 🔀 ⚪️➡️ 🖼 👑 **🔰 - 👩💻 🦮** [Oauth2️⃣ ⏮️ 🔐 (& 🔁), 📨 ⏮️ 🥙 🤝](../../tutorial/security/oauth2-jwt.md){.internal-link target=_blank}. 🔜 ⚙️ Oauth2️⃣ ↔:
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial005.py hl[2,4,8,12,46,64,105,107:115,121:125,129:135,140,156] *}
|
||||||
|
|
||||||
|
🔜 ➡️ 📄 👈 🔀 🔁 🔁.
|
||||||
|
|
||||||
|
## Oauth2️⃣ 💂♂ ⚖
|
||||||
|
|
||||||
|
🥇 🔀 👈 🔜 👥 📣 Oauth2️⃣ 💂♂ ⚖ ⏮️ 2️⃣ 💪 ↔, `me` & `items`.
|
||||||
|
|
||||||
|
`scopes` 🔢 📨 `dict` ⏮️ 🔠 ↔ 🔑 & 📛 💲:
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial005.py hl[62:65] *}
|
||||||
|
|
||||||
|
↩️ 👥 🔜 📣 📚 ↔, 👫 🔜 🎦 🆙 🛠️ 🩺 🕐❔ 👆 🕹-/✔.
|
||||||
|
|
||||||
|
& 👆 🔜 💪 🖊 ❔ ↔ 👆 💚 🤝 🔐: `me` & `items`.
|
||||||
|
|
||||||
|
👉 🎏 🛠️ ⚙️ 🕐❔ 👆 🤝 ✔ ⏪ 🚨 ⏮️ 👱📔, 🇺🇸🔍, 📂, ♒️:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/security/image11.png">
|
||||||
|
|
||||||
|
## 🥙 🤝 ⏮️ ↔
|
||||||
|
|
||||||
|
🔜, 🔀 🤝 *➡ 🛠️* 📨 ↔ 📨.
|
||||||
|
|
||||||
|
👥 ⚙️ 🎏 `OAuth2PasswordRequestForm`. ⚫️ 🔌 🏠 `scopes` ⏮️ `list` `str`, ⏮️ 🔠 ↔ ⚫️ 📨 📨.
|
||||||
|
|
||||||
|
& 👥 📨 ↔ 🍕 🥙 🤝.
|
||||||
|
|
||||||
|
/// danger
|
||||||
|
|
||||||
|
🦁, 📥 👥 ❎ ↔ 📨 🔗 🤝.
|
||||||
|
|
||||||
|
✋️ 👆 🈸, 💂♂, 👆 🔜 ⚒ 💭 👆 🕴 🚮 ↔ 👈 👩💻 🤙 💪 ✔️, ⚖️ 🕐 👆 ✔️ 🔁.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial005.py hl[156] *}
|
||||||
|
|
||||||
|
## 📣 ↔ *➡ 🛠️* & 🔗
|
||||||
|
|
||||||
|
🔜 👥 📣 👈 *➡ 🛠️* `/users/me/items/` 🚚 ↔ `items`.
|
||||||
|
|
||||||
|
👉, 👥 🗄 & ⚙️ `Security` ⚪️➡️ `fastapi`.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `Security` 📣 🔗 (💖 `Depends`), ✋️ `Security` 📨 🔢 `scopes` ⏮️ 📇 ↔ (🎻).
|
||||||
|
|
||||||
|
👉 💼, 👥 🚶♀️ 🔗 🔢 `get_current_active_user` `Security` (🎏 🌌 👥 🔜 ⏮️ `Depends`).
|
||||||
|
|
||||||
|
✋️ 👥 🚶♀️ `list` ↔, 👉 💼 ⏮️ 1️⃣ ↔: `items` (⚫️ 💪 ✔️ 🌅).
|
||||||
|
|
||||||
|
& 🔗 🔢 `get_current_active_user` 💪 📣 🎧-🔗, 🚫 🕴 ⏮️ `Depends` ✋️ ⏮️ `Security`. 📣 🚮 👍 🎧-🔗 🔢 (`get_current_user`), & 🌖 ↔ 📄.
|
||||||
|
|
||||||
|
👉 💼, ⚫️ 🚚 ↔ `me` (⚫️ 💪 🚚 🌅 🌘 1️⃣ ↔).
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
👆 🚫 🎯 💪 🚮 🎏 ↔ 🎏 🥉.
|
||||||
|
|
||||||
|
👥 🔨 ⚫️ 📥 🎦 ❔ **FastAPI** 🍵 ↔ 📣 🎏 🎚.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial005.py hl[4,140,169] *}
|
||||||
|
|
||||||
|
/// info | 📡 ℹ
|
||||||
|
|
||||||
|
`Security` 🤙 🏿 `Depends`, & ⚫️ ✔️ 1️⃣ ➕ 🔢 👈 👥 🔜 👀 ⏪.
|
||||||
|
|
||||||
|
✋️ ⚙️ `Security` ↩️ `Depends`, **FastAPI** 🔜 💭 👈 ⚫️ 💪 📣 💂♂ ↔, ⚙️ 👫 🔘, & 📄 🛠️ ⏮️ 🗄.
|
||||||
|
|
||||||
|
✋️ 🕐❔ 👆 🗄 `Query`, `Path`, `Depends`, `Security` & 🎏 ⚪️➡️ `fastapi`, 👈 🤙 🔢 👈 📨 🎁 🎓.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⚙️ `SecurityScopes`
|
||||||
|
|
||||||
|
🔜 ℹ 🔗 `get_current_user`.
|
||||||
|
|
||||||
|
👉 1️⃣ ⚙️ 🔗 🔛.
|
||||||
|
|
||||||
|
📥 👥 ⚙️ 🎏 Oauth2️⃣ ⚖ 👥 ✍ ⏭, 📣 ⚫️ 🔗: `oauth2_scheme`.
|
||||||
|
|
||||||
|
↩️ 👉 🔗 🔢 🚫 ✔️ 🙆 ↔ 📄 ⚫️, 👥 💪 ⚙️ `Depends` ⏮️ `oauth2_scheme`, 👥 🚫 ✔️ ⚙️ `Security` 🕐❔ 👥 🚫 💪 ✔ 💂♂ ↔.
|
||||||
|
|
||||||
|
👥 📣 🎁 🔢 🆎 `SecurityScopes`, 🗄 ⚪️➡️ `fastapi.security`.
|
||||||
|
|
||||||
|
👉 `SecurityScopes` 🎓 🎏 `Request` (`Request` ⚙️ 🤚 📨 🎚 🔗).
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial005.py hl[8,105] *}
|
||||||
|
|
||||||
|
## ⚙️ `scopes`
|
||||||
|
|
||||||
|
🔢 `security_scopes` 🔜 🆎 `SecurityScopes`.
|
||||||
|
|
||||||
|
⚫️ 🔜 ✔️ 🏠 `scopes` ⏮️ 📇 ⚗ 🌐 ↔ ✔ ⚫️ & 🌐 🔗 👈 ⚙️ 👉 🎧-🔗. 👈 ⛓, 🌐 "⚓️"... 👉 💪 🔊 😨, ⚫️ 🔬 🔄 ⏪ 🔛.
|
||||||
|
|
||||||
|
`security_scopes` 🎚 (🎓 `SecurityScopes`) 🚚 `scope_str` 🔢 ⏮️ 👁 🎻, 🔌 👈 ↔ 👽 🚀 (👥 🔜 ⚙️ ⚫️).
|
||||||
|
|
||||||
|
👥 ✍ `HTTPException` 👈 👥 💪 🏤-⚙️ (`raise`) ⏪ 📚 ☝.
|
||||||
|
|
||||||
|
👉 ⚠, 👥 🔌 ↔ 🚚 (🚥 🙆) 🎻 👽 🚀 (⚙️ `scope_str`). 👥 🚮 👈 🎻 ⚗ ↔ `WWW-Authenticate` 🎚 (👉 🍕 🔌).
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial005.py hl[105,107:115] *}
|
||||||
|
|
||||||
|
## ✔ `username` & 💽 💠
|
||||||
|
|
||||||
|
👥 ✔ 👈 👥 🤚 `username`, & ⚗ ↔.
|
||||||
|
|
||||||
|
& ⤴️ 👥 ✔ 👈 📊 ⏮️ Pydantic 🏷 (✊ `ValidationError` ⚠), & 🚥 👥 🤚 ❌ 👂 🥙 🤝 ⚖️ ⚖ 📊 ⏮️ Pydantic, 👥 🤚 `HTTPException` 👥 ✍ ⏭.
|
||||||
|
|
||||||
|
👈, 👥 ℹ Pydantic 🏷 `TokenData` ⏮️ 🆕 🏠 `scopes`.
|
||||||
|
|
||||||
|
⚖ 📊 ⏮️ Pydantic 👥 💪 ⚒ 💭 👈 👥 ✔️, 🖼, ⚫️❔ `list` `str` ⏮️ ↔ & `str` ⏮️ `username`.
|
||||||
|
|
||||||
|
↩️, 🖼, `dict`, ⚖️ 🕳 🙆, ⚫️ 💪 💔 🈸 ☝ ⏪, ⚒ ⚫️ 💂♂ ⚠.
|
||||||
|
|
||||||
|
👥 ✔ 👈 👥 ✔️ 👩💻 ⏮️ 👈 🆔, & 🚥 🚫, 👥 🤚 👈 🎏 ⚠ 👥 ✍ ⏭.
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial005.py hl[46,116:128] *}
|
||||||
|
|
||||||
|
## ✔ `scopes`
|
||||||
|
|
||||||
|
👥 🔜 ✔ 👈 🌐 ↔ ✔, 👉 🔗 & 🌐 ⚓️ (🔌 *➡ 🛠️*), 🔌 ↔ 🚚 🤝 📨, ⏪ 🤚 `HTTPException`.
|
||||||
|
|
||||||
|
👉, 👥 ⚙️ `security_scopes.scopes`, 👈 🔌 `list` ⏮️ 🌐 👫 ↔ `str`.
|
||||||
|
|
||||||
|
{* ../../docs_src/security/tutorial005.py hl[129:135] *}
|
||||||
|
|
||||||
|
## 🔗 🌲 & ↔
|
||||||
|
|
||||||
|
➡️ 📄 🔄 👉 🔗 🌲 & ↔.
|
||||||
|
|
||||||
|
`get_current_active_user` 🔗 ✔️ 🎧-🔗 🔛 `get_current_user`, ↔ `"me"` 📣 `get_current_active_user` 🔜 🔌 📇 ✔ ↔ `security_scopes.scopes` 🚶♀️ `get_current_user`.
|
||||||
|
|
||||||
|
*➡ 🛠️* ⚫️ 📣 ↔, `"items"`, 👉 🔜 📇 `security_scopes.scopes` 🚶♀️ `get_current_user`.
|
||||||
|
|
||||||
|
📥 ❔ 🔗 🔗 & ↔ 👀 💖:
|
||||||
|
|
||||||
|
* *➡ 🛠️* `read_own_items` ✔️:
|
||||||
|
* ✔ ↔ `["items"]` ⏮️ 🔗:
|
||||||
|
* `get_current_active_user`:
|
||||||
|
* 🔗 🔢 `get_current_active_user` ✔️:
|
||||||
|
* ✔ ↔ `["me"]` ⏮️ 🔗:
|
||||||
|
* `get_current_user`:
|
||||||
|
* 🔗 🔢 `get_current_user` ✔️:
|
||||||
|
* 🙅♂ ↔ ✔ ⚫️.
|
||||||
|
* 🔗 ⚙️ `oauth2_scheme`.
|
||||||
|
* `security_scopes` 🔢 🆎 `SecurityScopes`:
|
||||||
|
* 👉 `security_scopes` 🔢 ✔️ 🏠 `scopes` ⏮️ `list` ⚗ 🌐 👫 ↔ 📣 🔛,:
|
||||||
|
* `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`, 🚫 📣 🙆 `scope` 👯♂️.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
⚠ & "🎱" 👜 📥 👈 `get_current_user` 🔜 ✔️ 🎏 📇 `scopes` ✅ 🔠 *➡ 🛠️*.
|
||||||
|
|
||||||
|
🌐 ⚓️ 🔛 `scopes` 📣 🔠 *➡ 🛠️* & 🔠 🔗 🔗 🌲 👈 🎯 *➡ 🛠️*.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🌖 ℹ 🔃 `SecurityScopes`
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `SecurityScopes` 🙆 ☝, & 💗 🥉, ⚫️ 🚫 ✔️ "🌱" 🔗.
|
||||||
|
|
||||||
|
⚫️ 🔜 🕧 ✔️ 💂♂ ↔ 📣 ⏮️ `Security` 🔗 & 🌐 ⚓️ **👈 🎯** *➡ 🛠️* & **👈 🎯** 🔗 🌲.
|
||||||
|
|
||||||
|
↩️ `SecurityScopes` 🔜 ✔️ 🌐 ↔ 📣 ⚓️, 👆 💪 ⚙️ ⚫️ ✔ 👈 🤝 ✔️ 🚚 ↔ 🇨🇫 🔗 🔢, & ⤴️ 📣 🎏 ↔ 📄 🎏 *➡ 🛠️*.
|
||||||
|
|
||||||
|
👫 🔜 ✅ ➡ 🔠 *➡ 🛠️*.
|
||||||
|
|
||||||
|
## ✅ ⚫️
|
||||||
|
|
||||||
|
🚥 👆 📂 🛠️ 🩺, 👆 💪 🔓 & ✔ ❔ ↔ 👆 💚 ✔.
|
||||||
|
|
||||||
|
<img src="/img/tutorial/security/image11.png">
|
||||||
|
|
||||||
|
🚥 👆 🚫 🖊 🙆 ↔, 👆 🔜 "🔓", ✋️ 🕐❔ 👆 🔄 🔐 `/users/me/` ⚖️ `/users/me/items/` 👆 🔜 🤚 ❌ 💬 👈 👆 🚫 ✔️ 🥃 ✔. 👆 🔜 💪 🔐 `/status/`.
|
||||||
|
|
||||||
|
& 🚥 👆 🖊 ↔ `me` ✋️ 🚫 ↔ `items`, 👆 🔜 💪 🔐 `/users/me/` ✋️ 🚫 `/users/me/items/`.
|
||||||
|
|
||||||
|
👈 ⚫️❔ 🔜 🔨 🥉 🥳 🈸 👈 🔄 🔐 1️⃣ 👫 *➡ 🛠️* ⏮️ 🤝 🚚 👩💻, ⚓️ 🔛 ❔ 📚 ✔ 👩💻 🤝 🈸.
|
||||||
|
|
||||||
|
## 🔃 🥉 🥳 🛠️
|
||||||
|
|
||||||
|
👉 🖼 👥 ⚙️ Oauth2️⃣ "🔐" 💧.
|
||||||
|
|
||||||
|
👉 ☑ 🕐❔ 👥 🚨 👆 👍 🈸, 🎲 ⏮️ 👆 👍 🕸.
|
||||||
|
|
||||||
|
↩️ 👥 💪 💙 ⚫️ 📨 `username` & `password`, 👥 🎛 ⚫️.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 🏗 Oauth2️⃣ 🈸 👈 🎏 🔜 🔗 (➡, 🚥 👆 🏗 🤝 🐕🦺 🌓 👱📔, 🇺🇸🔍, 📂, ♒️.) 👆 🔜 ⚙️ 1️⃣ 🎏 💧.
|
||||||
|
|
||||||
|
🌅 ⚠ 🔑 💧.
|
||||||
|
|
||||||
|
🏆 🔐 📟 💧, ✋️ 🌖 🏗 🛠️ ⚫️ 🚚 🌅 📶. ⚫️ 🌅 🏗, 📚 🐕🦺 🔚 🆙 ✔ 🔑 💧.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
⚫️ ⚠ 👈 🔠 🤝 🐕🦺 📛 👫 💧 🎏 🌌, ⚒ ⚫️ 🍕 👫 🏷.
|
||||||
|
|
||||||
|
✋️ 🔚, 👫 🛠️ 🎏 Oauth2️⃣ 🐩.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
**FastAPI** 🔌 🚙 🌐 👫 Oauth2️⃣ 🤝 💧 `fastapi.security.oauth2`.
|
||||||
|
|
||||||
|
## `Security` 👨🎨 `dependencies`
|
||||||
|
|
||||||
|
🎏 🌌 👆 💪 🔬 `list` `Depends` 👨🎨 `dependencies` 🔢 (🔬 [🔗 ➡ 🛠️ 👨🎨](../../tutorial/dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}), 👆 💪 ⚙️ `Security` ⏮️ `scopes` 📤.
|
||||||
|
|
@ -0,0 +1,396 @@
|
||||||
|
# ⚒ & 🌐 🔢
|
||||||
|
|
||||||
|
📚 💼 👆 🈸 💪 💪 🔢 ⚒ ⚖️ 📳, 🖼 ㊙ 🔑, 💽 🎓, 🎓 📧 🐕🦺, ♒️.
|
||||||
|
|
||||||
|
🏆 👫 ⚒ 🔢 (💪 🔀), 💖 💽 📛. & 📚 💪 🚿, 💖 ㊙.
|
||||||
|
|
||||||
|
👉 🤔 ⚫️ ⚠ 🚚 👫 🌐 🔢 👈 ✍ 🈸.
|
||||||
|
|
||||||
|
## 🌐 🔢
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 ⏪ 💭 ⚫️❔ "🌐 🔢" & ❔ ⚙️ 👫, 💭 🆓 🚶 ⏭ 📄 🔛.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
<a href="https://en.wikipedia.org/wiki/Environment_variable" class="external-link" target="_blank">🌐 🔢</a> (💭 "🇨🇻 {") 🔢 👈 🖖 🏞 🐍 📟, 🏃♂ ⚙️, & 💪 ✍ 👆 🐍 📟 (⚖️ 🎏 📋 👍).
|
||||||
|
|
||||||
|
👆 💪 ✍ & ⚙️ 🌐 🔢 🐚, 🍵 💆♂ 🐍:
|
||||||
|
|
||||||
|
//// tab | 💾, 🇸🇻, 🚪 🎉
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
// You could create an env var MY_NAME with
|
||||||
|
$ export MY_NAME="Wade Wilson"
|
||||||
|
|
||||||
|
// Then you could use it with other programs, like
|
||||||
|
$ echo "Hello $MY_NAME"
|
||||||
|
|
||||||
|
Hello Wade Wilson
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🚪 📋
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
// Create an env var MY_NAME
|
||||||
|
$ $Env:MY_NAME = "Wade Wilson"
|
||||||
|
|
||||||
|
// Use it with other programs, like
|
||||||
|
$ echo "Hello $Env:MY_NAME"
|
||||||
|
|
||||||
|
Hello Wade Wilson
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
### ✍ 🇨🇻 {🐍
|
||||||
|
|
||||||
|
👆 💪 ✍ 🌐 🔢 🏞 🐍, 📶 (⚖️ ⏮️ 🙆 🎏 👩🔬), & ⤴️ ✍ 👫 🐍.
|
||||||
|
|
||||||
|
🖼 👆 💪 ✔️ 📁 `main.py` ⏮️:
|
||||||
|
|
||||||
|
```Python hl_lines="3"
|
||||||
|
import os
|
||||||
|
|
||||||
|
name = os.getenv("MY_NAME", "World")
|
||||||
|
print(f"Hello {name} from Python")
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🥈 ❌ <a href="https://docs.python.org/3.8/library/os.html#os.getenv" class="external-link" target="_blank">`os.getenv()`</a> 🔢 💲 📨.
|
||||||
|
|
||||||
|
🚥 🚫 🚚, ⚫️ `None` 🔢, 📥 👥 🚚 `"World"` 🔢 💲 ⚙️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
⤴️ 👆 💪 🤙 👈 🐍 📋:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
🌐 🔢 💪 ⚒ 🏞 📟, ✋️ 💪 ✍ 📟, & 🚫 ✔️ 🏪 (💕 `git`) ⏮️ 🎂 📁, ⚫️ ⚠ ⚙️ 👫 📳 ⚖️ ⚒.
|
||||||
|
|
||||||
|
👆 💪 ✍ 🌐 🔢 🕴 🎯 📋 👼, 👈 🕴 💪 👈 📋, & 🕴 🚮 📐.
|
||||||
|
|
||||||
|
👈, ✍ ⚫️ ▶️️ ⏭ 📋 ⚫️, 🔛 🎏 ⏸:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
// Create an env var MY_NAME in line for this program call
|
||||||
|
$ 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
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👆 💪 ✍ 🌅 🔃 ⚫️ <a href="https://12factor.net/config" class="external-link" target="_blank">1️⃣2️⃣-⚖ 📱: 📁</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🆎 & 🔬
|
||||||
|
|
||||||
|
👫 🌐 🔢 💪 🕴 🍵 ✍ 🎻, 👫 🔢 🐍 & ✔️ 🔗 ⏮️ 🎏 📋 & 🎂 ⚙️ (& ⏮️ 🎏 🏃♂ ⚙️, 💾, 🚪, 🇸🇻).
|
||||||
|
|
||||||
|
👈 ⛓ 👈 🙆 💲 ✍ 🐍 ⚪️➡️ 🌐 🔢 🔜 `str`, & 🙆 🛠️ 🎏 🆎 ⚖️ 🔬 ✔️ 🔨 📟.
|
||||||
|
|
||||||
|
## Pydantic `Settings`
|
||||||
|
|
||||||
|
👐, Pydantic 🚚 👑 🚙 🍵 👫 ⚒ 👟 ⚪️➡️ 🌐 🔢 ⏮️ <a href="https://docs.pydantic.dev/latest/concepts/pydantic_settings/" class="external-link" target="_blank">Pydantic: ⚒ 🧾</a>.
|
||||||
|
|
||||||
|
### ✍ `Settings` 🎚
|
||||||
|
|
||||||
|
🗄 `BaseSettings` ⚪️➡️ Pydantic & ✍ 🎧-🎓, 📶 🌅 💖 ⏮️ Pydantic 🏷.
|
||||||
|
|
||||||
|
🎏 🌌 ⏮️ Pydantic 🏷, 👆 📣 🎓 🔢 ⏮️ 🆎 ✍, & 🎲 🔢 💲.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🌐 🎏 🔬 ⚒ & 🧰 👆 ⚙️ Pydantic 🏷, 💖 🎏 📊 🆎 & 🌖 🔬 ⏮️ `Field()`.
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/tutorial001.py hl[2,5:8,11] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 💚 🕳 ⏩ 📁 & 📋, 🚫 ⚙️ 👉 🖼, ⚙️ 🏁 1️⃣ 🔛.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
⤴️, 🕐❔ 👆 ✍ 👐 👈 `Settings` 🎓 (👉 💼, `settings` 🎚), Pydantic 🔜 ✍ 🌐 🔢 💼-😛 🌌,, ↖-💼 🔢 `APP_NAME` 🔜 ✍ 🔢 `app_name`.
|
||||||
|
|
||||||
|
⏭ ⚫️ 🔜 🗜 & ✔ 💽. , 🕐❔ 👆 ⚙️ 👈 `settings` 🎚, 👆 🔜 ✔️ 📊 🆎 👆 📣 (✅ `items_per_user` 🔜 `int`).
|
||||||
|
|
||||||
|
### ⚙️ `settings`
|
||||||
|
|
||||||
|
⤴️ 👆 💪 ⚙️ 🆕 `settings` 🎚 👆 🈸:
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/tutorial001.py hl[18:20] *}
|
||||||
|
|
||||||
|
### 🏃 💽
|
||||||
|
|
||||||
|
⏭, 👆 🔜 🏃 💽 🚶♀️ 📳 🌐 🔢, 🖼 👆 💪 ⚒ `ADMIN_EMAIL` & `APP_NAME` ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp" uvicorn main:app
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
⚒ 💗 🇨🇻 {👁 📋 🎏 👫 ⏮️ 🚀, & 🚮 👫 🌐 ⏭ 📋.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
& ⤴️ `admin_email` ⚒ 🔜 ⚒ `"deadpool@example.com"`.
|
||||||
|
|
||||||
|
`app_name` 🔜 `"ChimichangApp"`.
|
||||||
|
|
||||||
|
& `items_per_user` 🔜 🚧 🚮 🔢 💲 `50`.
|
||||||
|
|
||||||
|
## ⚒ ➕1️⃣ 🕹
|
||||||
|
|
||||||
|
👆 💪 🚮 👈 ⚒ ➕1️⃣ 🕹 📁 👆 👀 [🦏 🈸 - 💗 📁](../tutorial/bigger-applications.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
🖼, 👆 💪 ✔️ 📁 `config.py` ⏮️:
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/app01/config.py *}
|
||||||
|
|
||||||
|
& ⤴️ ⚙️ ⚫️ 📁 `main.py`:
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/app01/main.py hl[3,11:13] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👆 🔜 💪 📁 `__init__.py` 👆 👀 🔛 [🦏 🈸 - 💗 📁](../tutorial/bigger-applications.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⚒ 🔗
|
||||||
|
|
||||||
|
🍾 ⚫️ 5️⃣📆 ⚠ 🚚 ⚒ ⚪️➡️ 🔗, ↩️ ✔️ 🌐 🎚 ⏮️ `settings` 👈 ⚙️ 🌐.
|
||||||
|
|
||||||
|
👉 💪 ✴️ ⚠ ⏮️ 🔬, ⚫️ 📶 ⏩ 🔐 🔗 ⏮️ 👆 👍 🛃 ⚒.
|
||||||
|
|
||||||
|
### 📁 📁
|
||||||
|
|
||||||
|
👟 ⚪️➡️ ⏮️ 🖼, 👆 `config.py` 📁 💪 👀 💖:
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/app02/config.py hl[10] *}
|
||||||
|
|
||||||
|
👀 👈 🔜 👥 🚫 ✍ 🔢 👐 `settings = Settings()`.
|
||||||
|
|
||||||
|
### 👑 📱 📁
|
||||||
|
|
||||||
|
🔜 👥 ✍ 🔗 👈 📨 🆕 `config.Settings()`.
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/app02/main.py hl[5,11:12] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👥 🔜 🔬 `@lru_cache` 🍖.
|
||||||
|
|
||||||
|
🔜 👆 💪 🤔 `get_settings()` 😐 🔢.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
& ⤴️ 👥 💪 🚚 ⚫️ ⚪️➡️ *➡ 🛠️ 🔢* 🔗 & ⚙️ ⚫️ 🙆 👥 💪 ⚫️.
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/app02/main.py hl[16,18:20] *}
|
||||||
|
|
||||||
|
### ⚒ & 🔬
|
||||||
|
|
||||||
|
⤴️ ⚫️ 🔜 📶 ⏩ 🚚 🎏 ⚒ 🎚 ⏮️ 🔬 🏗 🔗 🔐 `get_settings`:
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/app02/test_main.py hl[9:10,13,21] *}
|
||||||
|
|
||||||
|
🔗 🔐 👥 ⚒ 🆕 💲 `admin_email` 🕐❔ 🏗 🆕 `Settings` 🎚, & ⤴️ 👥 📨 👈 🆕 🎚.
|
||||||
|
|
||||||
|
⤴️ 👥 💪 💯 👈 ⚫️ ⚙️.
|
||||||
|
|
||||||
|
## 👂 `.env` 📁
|
||||||
|
|
||||||
|
🚥 👆 ✔️ 📚 ⚒ 👈 🎲 🔀 📚, 🎲 🎏 🌐, ⚫️ 5️⃣📆 ⚠ 🚮 👫 🔛 📁 & ⤴️ ✍ 👫 ⚪️➡️ ⚫️ 🚥 👫 🌐 🔢.
|
||||||
|
|
||||||
|
👉 💡 ⚠ 🥃 👈 ⚫️ ✔️ 📛, 👫 🌐 🔢 🛎 🥉 📁 `.env`, & 📁 🤙 "🇨🇻".
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
📁 ▶️ ⏮️ ❣ (`.`) 🕵♂ 📁 🖥-💖 ⚙️, 💖 💾 & 🇸🇻.
|
||||||
|
|
||||||
|
✋️ 🇨🇻 📁 🚫 🤙 ✔️ ✔️ 👈 ☑ 📁.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
Pydantic ✔️ 🐕🦺 👂 ⚪️➡️ 👉 🆎 📁 ⚙️ 🔢 🗃. 👆 💪 ✍ 🌖 <a href="https://docs.pydantic.dev/latest/concepts/pydantic_settings/#dotenv-env-support" class="external-link" target="_blank">Pydantic ⚒: 🇨🇻 (.🇨🇻) 🐕🦺</a>.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👉 👷, 👆 💪 `pip install python-dotenv`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### `.env` 📁
|
||||||
|
|
||||||
|
👆 💪 ✔️ `.env` 📁 ⏮️:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ADMIN_EMAIL="deadpool@example.com"
|
||||||
|
APP_NAME="ChimichangApp"
|
||||||
|
```
|
||||||
|
|
||||||
|
### ✍ ⚒ ⚪️➡️ `.env`
|
||||||
|
|
||||||
|
& ⤴️ ℹ 👆 `config.py` ⏮️:
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/app03/config.py hl[9:10] *}
|
||||||
|
|
||||||
|
📥 👥 ✍ 🎓 `Config` 🔘 👆 Pydantic `Settings` 🎓, & ⚒ `env_file` 📁 ⏮️ 🇨🇻 📁 👥 💚 ⚙️.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
`Config` 🎓 ⚙️ Pydantic 📳. 👆 💪 ✍ 🌖 <a href="https://docs.pydantic.dev/latest/api/config/" class="external-link" target="_blank">Pydantic 🏷 📁</a>
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🏗 `Settings` 🕴 🕐 ⏮️ `lru_cache`
|
||||||
|
|
||||||
|
👂 📁 ⚪️➡️ 💾 🛎 ⚠ (🐌) 🛠️, 👆 🎲 💚 ⚫️ 🕴 🕐 & ⤴️ 🏤-⚙️ 🎏 ⚒ 🎚, ↩️ 👂 ⚫️ 🔠 📨.
|
||||||
|
|
||||||
|
✋️ 🔠 🕰 👥:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
Settings()
|
||||||
|
```
|
||||||
|
|
||||||
|
🆕 `Settings` 🎚 🔜 ✍, & 🏗 ⚫️ 🔜 ✍ `.env` 📁 🔄.
|
||||||
|
|
||||||
|
🚥 🔗 🔢 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
def get_settings():
|
||||||
|
return Settings()
|
||||||
|
```
|
||||||
|
|
||||||
|
👥 🔜 ✍ 👈 🎚 🔠 📨, & 👥 🔜 👂 `.env` 📁 🔠 📨. 👶 👶
|
||||||
|
|
||||||
|
✋️ 👥 ⚙️ `@lru_cache` 👨🎨 🔛 🔝, `Settings` 🎚 🔜 ✍ 🕴 🕐, 🥇 🕰 ⚫️ 🤙. 👶 👶
|
||||||
|
|
||||||
|
{* ../../docs_src/settings/app03/main.py hl[1,10] *}
|
||||||
|
|
||||||
|
⤴️ 🙆 🏁 🤙 `get_settings()` 🔗 ⏭ 📨, ↩️ 🛠️ 🔗 📟 `get_settings()` & 🏗 🆕 `Settings` 🎚, ⚫️ 🔜 📨 🎏 🎚 👈 📨 🔛 🥇 🤙, 🔄 & 🔄.
|
||||||
|
|
||||||
|
#### `lru_cache` 📡 ℹ
|
||||||
|
|
||||||
|
`@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` ❔ 🍕 🐍 🐩 🗃, 👆 💪 ✍ 🌅 🔃 ⚫️ <a href="https://docs.python.org/3/library/functools.html#functools.lru_cache" class="external-link" target="_blank">🐍 🩺 `@lru_cache`</a>.
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
👆 💪 ⚙️ Pydantic ⚒ 🍵 ⚒ ⚖️ 📳 👆 🈸, ⏮️ 🌐 🏋️ Pydantic 🏷.
|
||||||
|
|
||||||
|
* ⚙️ 🔗 👆 💪 📉 🔬.
|
||||||
|
* 👆 💪 ⚙️ `.env` 📁 ⏮️ ⚫️.
|
||||||
|
* ⚙️ `@lru_cache` ➡️ 👆 ❎ 👂 🇨🇻 📁 🔄 & 🔄 🔠 📨, ⏪ 🤝 👆 🔐 ⚫️ ⏮️ 🔬.
|
||||||
|
|
@ -0,0 +1,67 @@
|
||||||
|
# 🎧 🈸 - 🗻
|
||||||
|
|
||||||
|
🚥 👆 💪 ✔️ 2️⃣ 🔬 FastAPI 🈸, ⏮️ 👫 👍 🔬 🗄 & 👫 👍 🩺 ⚜, 👆 💪 ✔️ 👑 📱 & "🗻" 1️⃣ (⚖️ 🌅) 🎧-🈸(Ⓜ).
|
||||||
|
|
||||||
|
## 🗜 **FastAPI** 🈸
|
||||||
|
|
||||||
|
"🗜" ⛓ ❎ 🍕 "🔬" 🈸 🎯 ➡, 👈 ⤴️ ✊ 💅 🚚 🌐 🔽 👈 ➡, ⏮️ _➡ 🛠️_ 📣 👈 🎧-🈸.
|
||||||
|
|
||||||
|
### 🔝-🎚 🈸
|
||||||
|
|
||||||
|
🥇, ✍ 👑, 🔝-🎚, **FastAPI** 🈸, & 🚮 *➡ 🛠️*:
|
||||||
|
|
||||||
|
{* ../../docs_src/sub_applications/tutorial001.py hl[3,6:8] *}
|
||||||
|
|
||||||
|
### 🎧-🈸
|
||||||
|
|
||||||
|
⤴️, ✍ 👆 🎧-🈸, & 🚮 *➡ 🛠️*.
|
||||||
|
|
||||||
|
👉 🎧-🈸 ➕1️⃣ 🐩 FastAPI 🈸, ✋️ 👉 1️⃣ 👈 🔜 "🗻":
|
||||||
|
|
||||||
|
{* ../../docs_src/sub_applications/tutorial001.py hl[11,14:16] *}
|
||||||
|
|
||||||
|
### 🗻 🎧-🈸
|
||||||
|
|
||||||
|
👆 🔝-🎚 🈸, `app`, 🗻 🎧-🈸, `subapi`.
|
||||||
|
|
||||||
|
👉 💼, ⚫️ 🔜 📌 ➡ `/subapi`:
|
||||||
|
|
||||||
|
{* ../../docs_src/sub_applications/tutorial001.py hl[11,19] *}
|
||||||
|
|
||||||
|
### ✅ 🏧 🛠️ 🩺
|
||||||
|
|
||||||
|
🔜, 🏃 `uvicorn` ⏮️ 👑 📱, 🚥 👆 📁 `main.py`, ⚫️ 🔜:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --reload
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
& 📂 🩺 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
|
||||||
|
|
||||||
|
👆 🔜 👀 🏧 🛠️ 🩺 👑 📱, 🔌 🕴 🚮 👍 _➡ 🛠️_:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/sub-applications/image01.png">
|
||||||
|
|
||||||
|
& ⤴️, 📂 🩺 🎧-🈸, <a href="http://127.0.0.1:8000/subapi/docs" class="external-link" target="_blank">http://127.0.0.1:8000/subapi/docs</a>.
|
||||||
|
|
||||||
|
👆 🔜 👀 🏧 🛠️ 🩺 🎧-🈸, ✅ 🕴 🚮 👍 _➡ 🛠️_, 🌐 🔽 ☑ 🎧-➡ 🔡 `/subapi`:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/sub-applications/image02.png">
|
||||||
|
|
||||||
|
🚥 👆 🔄 🔗 ⏮️ 🙆 2️⃣ 👩💻 🔢, 👫 🔜 👷 ☑, ↩️ 🖥 🔜 💪 💬 🔠 🎯 📱 ⚖️ 🎧-📱.
|
||||||
|
|
||||||
|
### 📡 ℹ: `root_path`
|
||||||
|
|
||||||
|
🕐❔ 👆 🗻 🎧-🈸 🔬 🔛, FastAPI 🔜 ✊ 💅 🔗 🗻 ➡ 🎧-🈸 ⚙️ 🛠️ ⚪️➡️ 🔫 🔧 🤙 `root_path`.
|
||||||
|
|
||||||
|
👈 🌌, 🎧-🈸 🔜 💭 ⚙️ 👈 ➡ 🔡 🩺 🎚.
|
||||||
|
|
||||||
|
& 🎧-🈸 💪 ✔️ 🚮 👍 📌 🎧-🈸 & 🌐 🔜 👷 ☑, ↩️ FastAPI 🍵 🌐 👉 `root_path`Ⓜ 🔁.
|
||||||
|
|
||||||
|
👆 🔜 💡 🌅 🔃 `root_path` & ❔ ⚙️ ⚫️ 🎯 📄 🔃 [⛅ 🗳](behind-a-proxy.md){.internal-link target=_blank}.
|
||||||
|
|
@ -0,0 +1,84 @@
|
||||||
|
# 📄
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🙆 📄 🚒 👆 💚 ⏮️ **FastAPI**.
|
||||||
|
|
||||||
|
⚠ ⚒ Jinja2️⃣, 🎏 1️⃣ ⚙️ 🏺 & 🎏 🧰.
|
||||||
|
|
||||||
|
📤 🚙 🔗 ⚫️ 💪 👈 👆 💪 ⚙️ 🔗 👆 **FastAPI** 🈸 (🚚 💃).
|
||||||
|
|
||||||
|
## ❎ 🔗
|
||||||
|
|
||||||
|
❎ `jinja2`:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install jinja2
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## ⚙️ `Jinja2Templates`
|
||||||
|
|
||||||
|
* 🗄 `Jinja2Templates`.
|
||||||
|
* ✍ `templates` 🎚 👈 👆 💪 🏤-⚙️ ⏪.
|
||||||
|
* 📣 `Request` 🔢 *➡ 🛠️* 👈 🔜 📨 📄.
|
||||||
|
* ⚙️ `templates` 👆 ✍ ✍ & 📨 `TemplateResponse`, 🚶♀️ `request` 1️⃣ 🔑-💲 👫 Jinja2️⃣ "🔑".
|
||||||
|
|
||||||
|
{* ../../docs_src/templates/tutorial001.py hl[4,11,15:18] *}
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
👀 👈 👆 ✔️ 🚶♀️ `request` 🍕 🔑-💲 👫 🔑 Jinja2️⃣. , 👆 ✔️ 📣 ⚫️ 👆 *➡ 🛠️*.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
📣 `response_class=HTMLResponse` 🩺 🎚 🔜 💪 💭 👈 📨 🔜 🕸.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.templating import Jinja2Templates`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 🎏 `starlette.templating` `fastapi.templating` 🏪 👆, 👩💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃. 🎏 ⏮️ `Request` & `StaticFiles`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ✍ 📄
|
||||||
|
|
||||||
|
⤴️ 👆 💪 ✍ 📄 `templates/item.html` ⏮️:
|
||||||
|
|
||||||
|
```jinja hl_lines="7"
|
||||||
|
{!../../docs_src/templates/templates/item.html!}
|
||||||
|
```
|
||||||
|
|
||||||
|
⚫️ 🔜 🎦 `id` ✊ ⚪️➡️ "🔑" `dict` 👆 🚶♀️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{"request": request, "id": id}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📄 & 🎻 📁
|
||||||
|
|
||||||
|
& 👆 💪 ⚙️ `url_for()` 🔘 📄, & ⚙️ ⚫️, 🖼, ⏮️ `StaticFiles` 👆 📌.
|
||||||
|
|
||||||
|
```jinja hl_lines="4"
|
||||||
|
{!../../docs_src/templates/templates/item.html!}
|
||||||
|
```
|
||||||
|
|
||||||
|
👉 🖼, ⚫️ 🔜 🔗 🎚 📁 `static/styles.css` ⏮️:
|
||||||
|
|
||||||
|
```CSS hl_lines="4"
|
||||||
|
{!../../docs_src/templates/static/styles.css!}
|
||||||
|
```
|
||||||
|
|
||||||
|
& ↩️ 👆 ⚙️ `StaticFiles`, 👈 🎚 📁 🔜 🍦 🔁 👆 **FastAPI** 🈸 📛 `/static/styles.css`.
|
||||||
|
|
||||||
|
## 🌅 ℹ
|
||||||
|
|
||||||
|
🌅 ℹ, 🔌 ❔ 💯 📄, ✅ <a href="https://www.starlette.dev/templates/" class="external-link" target="_blank">💃 🩺 🔛 📄</a>.
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
# 🔬 🔗 ⏮️ 🔐
|
||||||
|
|
||||||
|
## 🔑 🔗 ⏮️ 🔬
|
||||||
|
|
||||||
|
📤 😐 🌐❔ 👆 💪 💚 🔐 🔗 ⏮️ 🔬.
|
||||||
|
|
||||||
|
👆 🚫 💚 ⏮️ 🔗 🏃 (🚫 🙆 🎧-🔗 ⚫️ 💪 ✔️).
|
||||||
|
|
||||||
|
↩️, 👆 💚 🚚 🎏 🔗 👈 🔜 ⚙️ 🕴 ⏮️ 💯 (🎲 🕴 🎯 💯), & 🔜 🚚 💲 👈 💪 ⚙️ 🌐❔ 💲 ⏮️ 🔗 ⚙️.
|
||||||
|
|
||||||
|
### ⚙️ 💼: 🔢 🐕🦺
|
||||||
|
|
||||||
|
🖼 💪 👈 👆 ✔️ 🔢 🤝 🐕🦺 👈 👆 💪 🤙.
|
||||||
|
|
||||||
|
👆 📨 ⚫️ 🤝 & ⚫️ 📨 🔓 👩💻.
|
||||||
|
|
||||||
|
👉 🐕🦺 5️⃣📆 🔌 👆 📍 📨, & 🤙 ⚫️ 💪 ✊ ➕ 🕰 🌘 🚥 👆 ✔️ 🔧 🎁 👩💻 💯.
|
||||||
|
|
||||||
|
👆 🎲 💚 💯 🔢 🐕🦺 🕐, ✋️ 🚫 🎯 🤙 ⚫️ 🔠 💯 👈 🏃.
|
||||||
|
|
||||||
|
👉 💼, 👆 💪 🔐 🔗 👈 🤙 👈 🐕🦺, & ⚙️ 🛃 🔗 👈 📨 🎁 👩💻, 🕴 👆 💯.
|
||||||
|
|
||||||
|
### ⚙️ `app.dependency_overrides` 🔢
|
||||||
|
|
||||||
|
👫 💼, 👆 **FastAPI** 🈸 ✔️ 🔢 `app.dependency_overrides`, ⚫️ 🙅 `dict`.
|
||||||
|
|
||||||
|
🔐 🔗 🔬, 👆 🚮 🔑 ⏮️ 🔗 (🔢), & 💲, 👆 🔗 🔐 (➕1️⃣ 🔢).
|
||||||
|
|
||||||
|
& ⤴️ **FastAPI** 🔜 🤙 👈 🔐 ↩️ ⏮️ 🔗.
|
||||||
|
|
||||||
|
{* ../../docs_src/dependency_testing/tutorial001.py hl[28:29,32] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👆 💪 ⚒ 🔗 🔐 🔗 ⚙️ 🙆 👆 **FastAPI** 🈸.
|
||||||
|
|
||||||
|
⏮️ 🔗 💪 ⚙️ *➡ 🛠️ 🔢*, *➡ 🛠️ 👨🎨* (🕐❔ 👆 🚫 ⚙️ 📨 💲), `.include_router()` 🤙, ♒️.
|
||||||
|
|
||||||
|
FastAPI 🔜 💪 🔐 ⚫️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
⤴️ 👆 💪 ⏲ 👆 🔐 (❎ 👫) ⚒ `app.dependency_overrides` 🛁 `dict`:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
app.dependency_overrides = {}
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 💚 🔐 🔗 🕴 ⏮️ 💯, 👆 💪 ⚒ 🔐 ▶️ 💯 (🔘 💯 🔢) & ⏲ ⚫️ 🔚 (🔚 💯 🔢).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
# 🔬 🎉: 🕴 - 🤫
|
||||||
|
|
||||||
|
🕐❔ 👆 💪 👆 🎉 🐕🦺 (`startup` & `shutdown`) 🏃 👆 💯, 👆 💪 ⚙️ `TestClient` ⏮️ `with` 📄:
|
||||||
|
|
||||||
|
{* ../../docs_src/app_testing/tutorial003.py hl[9:12,20:24] *}
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
# 🔬 *️⃣
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🎏 `TestClient` 💯*️⃣.
|
||||||
|
|
||||||
|
👉, 👆 ⚙️ `TestClient` `with` 📄, 🔗*️⃣:
|
||||||
|
|
||||||
|
{* ../../docs_src/app_testing/tutorial002.py hl[27:31] *}
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
🌅 ℹ, ✅ 💃 🧾 <a href="https://www.starlette.dev/testclient/#testing-websocket-sessions" class="external-link" target="_blank">🔬 *️⃣ </a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,56 @@
|
||||||
|
# ⚙️ 📨 🔗
|
||||||
|
|
||||||
|
🆙 🔜, 👆 ✔️ 📣 🍕 📨 👈 👆 💪 ⏮️ 👫 🆎.
|
||||||
|
|
||||||
|
✊ 📊 ⚪️➡️:
|
||||||
|
|
||||||
|
* ➡ 🔢.
|
||||||
|
* 🎚.
|
||||||
|
* 🍪.
|
||||||
|
* ♒️.
|
||||||
|
|
||||||
|
& 🔨, **FastAPI** ⚖ 👈 💽, 🏭 ⚫️ & 🏭 🧾 👆 🛠️ 🔁.
|
||||||
|
|
||||||
|
✋️ 📤 ⚠ 🌐❔ 👆 💪 💪 🔐 `Request` 🎚 🔗.
|
||||||
|
|
||||||
|
## ℹ 🔃 `Request` 🎚
|
||||||
|
|
||||||
|
**FastAPI** 🤙 **💃** 🔘, ⏮️ 🧽 📚 🧰 🔛 🔝, 👆 💪 ⚙️ 💃 <a href="https://www.starlette.dev/requests/" class="external-link" target="_blank">`Request`</a> 🎚 🔗 🕐❔ 👆 💪.
|
||||||
|
|
||||||
|
⚫️ 🔜 ⛓ 👈 🚥 👆 🤚 📊 ⚪️➡️ `Request` 🎚 🔗 (🖼, ✍ 💪) ⚫️ 🏆 🚫 ✔, 🗜 ⚖️ 📄 (⏮️ 🗄, 🏧 🛠️ 👩💻 🔢) FastAPI.
|
||||||
|
|
||||||
|
👐 🙆 🎏 🔢 📣 🛎 (🖼, 💪 ⏮️ Pydantic 🏷) 🔜 ✔, 🗜, ✍, ♒️.
|
||||||
|
|
||||||
|
✋️ 📤 🎯 💼 🌐❔ ⚫️ ⚠ 🤚 `Request` 🎚.
|
||||||
|
|
||||||
|
## ⚙️ `Request` 🎚 🔗
|
||||||
|
|
||||||
|
➡️ 🌈 👆 💚 🤚 👩💻 📢 📢/🦠 🔘 👆 *➡ 🛠️ 🔢*.
|
||||||
|
|
||||||
|
👈 👆 💪 🔐 📨 🔗.
|
||||||
|
|
||||||
|
{* ../../docs_src/using_request_directly/tutorial001.py hl[1,7:8] *}
|
||||||
|
|
||||||
|
📣 *➡ 🛠️ 🔢* 🔢 ⏮️ 🆎 ➖ `Request` **FastAPI** 🔜 💭 🚶♀️ `Request` 👈 🔢.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🗒 👈 👉 💼, 👥 📣 ➡ 🔢 ⤴️ 📨 🔢.
|
||||||
|
|
||||||
|
, ➡ 🔢 🔜 ⚗, ✔, 🗜 ✔ 🆎 & ✍ ⏮️ 🗄.
|
||||||
|
|
||||||
|
🎏 🌌, 👆 💪 📣 🙆 🎏 🔢 🛎, & ➡, 🤚 `Request` 💁♂️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## `Request` 🧾
|
||||||
|
|
||||||
|
👆 💪 ✍ 🌅 ℹ 🔃 <a href="https://www.starlette.dev/requests/" class="external-link" target="_blank">`Request` 🎚 🛂 💃 🧾 🕸</a>.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.requests import Request`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 ⚫️ 🔗 🏪 👆, 👩💻. ✋️ ⚫️ 👟 🔗 ⚪️➡️ 💃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,186 @@
|
||||||
|
# *️⃣
|
||||||
|
|
||||||
|
👆 💪 ⚙️ <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API" class="external-link" target="_blank"> *️⃣ </a> ⏮️ **FastAPI**.
|
||||||
|
|
||||||
|
## ❎ `WebSockets`
|
||||||
|
|
||||||
|
🥇 👆 💪 ❎ `WebSockets`:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install websockets
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## *️⃣ 👩💻
|
||||||
|
|
||||||
|
### 🏭
|
||||||
|
|
||||||
|
👆 🏭 ⚙️, 👆 🎲 ✔️ 🕸 ✍ ⏮️ 🏛 🛠️ 💖 😥, Vue.js ⚖️ 📐.
|
||||||
|
|
||||||
|
& 🔗 ⚙️ *️⃣ ⏮️ 👆 👩💻 👆 🔜 🎲 ⚙️ 👆 🕸 🚙.
|
||||||
|
|
||||||
|
⚖️ 👆 💪 ✔️ 🇦🇸 📱 🈸 👈 🔗 ⏮️ 👆 *️⃣ 👩💻 🔗, 🇦🇸 📟.
|
||||||
|
|
||||||
|
⚖️ 👆 5️⃣📆 ✔️ 🙆 🎏 🌌 🔗 ⏮️ *️⃣ 🔗.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
✋️ 👉 🖼, 👥 🔜 ⚙️ 📶 🙅 🕸 📄 ⏮️ 🕸, 🌐 🔘 📏 🎻.
|
||||||
|
|
||||||
|
👉, ↗️, 🚫 ⚖ & 👆 🚫🔜 ⚙️ ⚫️ 🏭.
|
||||||
|
|
||||||
|
🏭 👆 🔜 ✔️ 1️⃣ 🎛 🔛.
|
||||||
|
|
||||||
|
✋️ ⚫️ 🙅 🌌 🎯 🔛 💽-🚄 *️⃣ & ✔️ 👷 🖼:
|
||||||
|
|
||||||
|
{* ../../docs_src/websockets/tutorial001.py hl[2,6:38,41:43] *}
|
||||||
|
|
||||||
|
## ✍ `websocket`
|
||||||
|
|
||||||
|
👆 **FastAPI** 🈸, ✍ `websocket`:
|
||||||
|
|
||||||
|
{* ../../docs_src/websockets/tutorial001.py hl[1,46:47] *}
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.websockets import WebSocket`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 🎏 `WebSocket` 🔗 🏪 👆, 👩💻. ✋️ ⚫️ 👟 🔗 ⚪️➡️ 💃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⌛ 📧 & 📨 📧
|
||||||
|
|
||||||
|
👆 *️⃣ 🛣 👆 💪 `await` 📧 & 📨 📧.
|
||||||
|
|
||||||
|
{* ../../docs_src/websockets/tutorial001.py hl[48:52] *}
|
||||||
|
|
||||||
|
👆 💪 📨 & 📨 💱, ✍, & 🎻 💽.
|
||||||
|
|
||||||
|
## 🔄 ⚫️
|
||||||
|
|
||||||
|
🚥 👆 📁 📛 `main.py`, 🏃 👆 🈸 ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --reload
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
📂 👆 🖥 <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000</a>.
|
||||||
|
|
||||||
|
👆 🔜 👀 🙅 📃 💖:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/websockets/image01.png">
|
||||||
|
|
||||||
|
👆 💪 🆎 📧 🔢 📦, & 📨 👫:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/websockets/image02.png">
|
||||||
|
|
||||||
|
& 👆 **FastAPI** 🈸 ⏮️ *️⃣ 🔜 📨 🔙:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/websockets/image03.png">
|
||||||
|
|
||||||
|
👆 💪 📨 (& 📨) 📚 📧:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/websockets/image04.png">
|
||||||
|
|
||||||
|
& 🌐 👫 🔜 ⚙️ 🎏 *️⃣ 🔗.
|
||||||
|
|
||||||
|
## ⚙️ `Depends` & 🎏
|
||||||
|
|
||||||
|
*️⃣ 🔗 👆 💪 🗄 ⚪️➡️ `fastapi` & ⚙️:
|
||||||
|
|
||||||
|
* `Depends`
|
||||||
|
* `Security`
|
||||||
|
* `Cookie`
|
||||||
|
* `Header`
|
||||||
|
* `Path`
|
||||||
|
* `Query`
|
||||||
|
|
||||||
|
👫 👷 🎏 🌌 🎏 FastAPI 🔗/*➡ 🛠️*:
|
||||||
|
|
||||||
|
{* ../../docs_src/websockets/tutorial002.py hl[66:77,76:91] *}
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
👉 *️⃣ ⚫️ 🚫 🤙 ⚒ 🔑 🤚 `HTTPException`, ↩️ 👥 🤚 `WebSocketException`.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 📪 📟 ⚪️➡️ <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1" class="external-link" target="_blank">☑ 📟 🔬 🔧</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🔄 *️⃣ ⏮️ 🔗
|
||||||
|
|
||||||
|
🚥 👆 📁 📛 `main.py`, 🏃 👆 🈸 ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --reload
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
📂 👆 🖥 <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000</a>.
|
||||||
|
|
||||||
|
📤 👆 💪 ⚒:
|
||||||
|
|
||||||
|
* "🏬 🆔", ⚙️ ➡.
|
||||||
|
* "🤝" ⚙️ 🔢 🔢.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 👈 🔢 `token` 🔜 🍵 🔗.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
⏮️ 👈 👆 💪 🔗 *️⃣ & ⤴️ 📨 & 📨 📧:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/websockets/image05.png">
|
||||||
|
|
||||||
|
## 🚚 🔀 & 💗 👩💻
|
||||||
|
|
||||||
|
🕐❔ *️⃣ 🔗 📪, `await websocket.receive_text()` 🔜 🤚 `WebSocketDisconnect` ⚠, ❔ 👆 💪 ⤴️ ✊ & 🍵 💖 👉 🖼.
|
||||||
|
|
||||||
|
{* ../../docs_src/websockets/tutorial003.py hl[81:83] *}
|
||||||
|
|
||||||
|
🔄 ⚫️ 👅:
|
||||||
|
|
||||||
|
* 📂 📱 ⏮️ 📚 🖥 📑.
|
||||||
|
* ✍ 📧 ⚪️➡️ 👫.
|
||||||
|
* ⤴️ 🔐 1️⃣ 📑.
|
||||||
|
|
||||||
|
👈 🔜 🤚 `WebSocketDisconnect` ⚠, & 🌐 🎏 👩💻 🔜 📨 📧 💖:
|
||||||
|
|
||||||
|
```
|
||||||
|
Client #1596980209979 left the chat
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
📱 🔛 ⭐ & 🙅 🖼 🎦 ❔ 🍵 & 📻 📧 📚 *️⃣ 🔗.
|
||||||
|
|
||||||
|
✋️ ✔️ 🤯 👈, 🌐 🍵 💾, 👁 📇, ⚫️ 🔜 🕴 👷 ⏪ 🛠️ 🏃, & 🔜 🕴 👷 ⏮️ 👁 🛠️.
|
||||||
|
|
||||||
|
🚥 👆 💪 🕳 ⏩ 🛠️ ⏮️ FastAPI ✋️ 👈 🌖 🏋️, 🐕🦺 ✳, ✳ ⚖️ 🎏, ✅ <a href="https://github.com/encode/broadcaster" class="external-link" target="_blank">🗜/📻</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🌅 ℹ
|
||||||
|
|
||||||
|
💡 🌅 🔃 🎛, ✅ 💃 🧾:
|
||||||
|
|
||||||
|
* <a href="https://www.starlette.dev/websockets/" class="external-link" target="_blank"> `WebSocket` 🎓</a>.
|
||||||
|
* <a href="https://www.starlette.dev/endpoints/#websocketendpoint" class="external-link" target="_blank">🎓-⚓️ *️⃣ 🚚</a>.
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
# ✅ 🇨🇻 - 🏺, ✳, 🎏
|
||||||
|
|
||||||
|
👆 💪 🗻 🇨🇻 🈸 👆 👀 ⏮️ [🎧 🈸 - 🗻](sub-applications.md){.internal-link target=_blank}, [⛅ 🗳](behind-a-proxy.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
👈, 👆 💪 ⚙️ `WSGIMiddleware` & ⚙️ ⚫️ 🎁 👆 🇨🇻 🈸, 🖼, 🏺, ✳, ♒️.
|
||||||
|
|
||||||
|
## ⚙️ `WSGIMiddleware`
|
||||||
|
|
||||||
|
👆 💪 🗄 `WSGIMiddleware`.
|
||||||
|
|
||||||
|
⤴️ 🎁 🇨🇻 (✅ 🏺) 📱 ⏮️ 🛠️.
|
||||||
|
|
||||||
|
& ⤴️ 🗻 👈 🔽 ➡.
|
||||||
|
|
||||||
|
{* ../../docs_src/wsgi/tutorial001.py hl[2:3,22] *}
|
||||||
|
|
||||||
|
## ✅ ⚫️
|
||||||
|
|
||||||
|
🔜, 🔠 📨 🔽 ➡ `/v1/` 🔜 🍵 🏺 🈸.
|
||||||
|
|
||||||
|
& 🎂 🔜 🍵 **FastAPI**.
|
||||||
|
|
||||||
|
🚥 👆 🏃 ⚫️ ⏮️ Uvicorn & 🚶 <a href="http://localhost:8000/v1/" class="external-link" target="_blank">http://localhost:8000/v1/</a> 👆 🔜 👀 📨 ⚪️➡️ 🏺:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
Hello, World from Flask!
|
||||||
|
```
|
||||||
|
|
||||||
|
& 🚥 👆 🚶 <a href="http://localhost:8000/v2" class="external-link" target="_blank">http://localhost:8000/v2</a> 👆 🔜 👀 📨 ⚪️➡️ FastAPI:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"message": "Hello World"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,485 @@
|
||||||
|
# 🎛, 🌈 & 🔺
|
||||||
|
|
||||||
|
⚫️❔ 😮 **FastAPI**, ❔ ⚫️ 🔬 🎏 🎛 & ⚫️❔ ⚫️ 🇭🇲 ⚪️➡️ 👫.
|
||||||
|
|
||||||
|
## 🎶
|
||||||
|
|
||||||
|
**FastAPI** 🚫🔜 🔀 🚥 🚫 ⏮️ 👷 🎏.
|
||||||
|
|
||||||
|
📤 ✔️ 📚 🧰 ✍ ⏭ 👈 ✔️ ℹ 😮 🚮 🏗.
|
||||||
|
|
||||||
|
👤 ✔️ ❎ 🏗 🆕 🛠️ 📚 1️⃣2️⃣🗓️. 🥇 👤 🔄 ❎ 🌐 ⚒ 📔 **FastAPI** ⚙️ 📚 🎏 🛠️, 🔌-🔌, & 🧰.
|
||||||
|
|
||||||
|
✋️ ☝, 📤 🙅♂ 🎏 🎛 🌘 🏗 🕳 👈 🚚 🌐 👫 ⚒, ✊ 🏆 💭 ⚪️➡️ ⏮️ 🧰, & 🌀 👫 🏆 🌌 💪, ⚙️ 🇪🇸 ⚒ 👈 ➖🚫 💪 ⏭ (🐍 3️⃣.6️⃣ ➕ 🆎 🔑).
|
||||||
|
|
||||||
|
## ⏮️ 🧰
|
||||||
|
|
||||||
|
### <a href="https://www.djangoproject.com/" class="external-link" target="_blank">✳</a>
|
||||||
|
|
||||||
|
⚫️ 🌅 🌟 🐍 🛠️ & 🛎 🕴. ⚫️ ⚙️ 🏗 ⚙️ 💖 👱📔.
|
||||||
|
|
||||||
|
⚫️ 📶 😆 🔗 ⏮️ 🔗 💽 (💖 ✳ ⚖️ ✳),, ✔️ ☁ 💽 (💖 🗄, ✳, 👸, ♒️) 👑 🏪 🚒 🚫 📶 ⏩.
|
||||||
|
|
||||||
|
⚫️ ✍ 🏗 🕸 👩💻, 🚫 ✍ 🔗 ⚙️ 🏛 🕸 (💖 😥, Vue.js & 📐) ⚖️ 🎏 ⚙️ (💖 <abbr title="Internet of Things">☁</abbr> 📳) 🔗 ⏮️ ⚫️.
|
||||||
|
|
||||||
|
### <a href="https://www.django-rest-framework.org/" class="external-link" target="_blank">✳ 🎂 🛠️</a>
|
||||||
|
|
||||||
|
✳ 🎂 🛠️ ✍ 🗜 🧰 🏗 🕸 🔗 ⚙️ ✳ 🔘, 📉 🚮 🛠️ 🛠️.
|
||||||
|
|
||||||
|
⚫️ ⚙️ 📚 🏢 ✅ 🦎, 🟥 👒 & 🎟.
|
||||||
|
|
||||||
|
⚫️ 🕐 🥇 🖼 **🏧 🛠️ 🧾**, & 👉 🎯 🕐 🥇 💭 👈 😮 "🔎" **FastAPI**.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
✳ 🎂 🛠️ ✍ ✡ 🇺🇸🏛. 🎏 👼 💃 & Uvicorn, 🔛 ❔ **FastAPI** ⚓️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
✔️ 🏧 🛠️ 🧾 🕸 👩💻 🔢.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://flask.palletsprojects.com" class="external-link" target="_blank">🏺</a>
|
||||||
|
|
||||||
|
🏺 "🕸", ⚫️ 🚫 🔌 💽 🛠️ 🚫 📚 👜 👈 👟 🔢 ✳.
|
||||||
|
|
||||||
|
👉 🦁 & 💪 ✔ 🔨 👜 💖 ⚙️ ☁ 💽 👑 💽 💾 ⚙️.
|
||||||
|
|
||||||
|
⚫️ 📶 🙅, ⚫️ 📶 🏋️ 💡, 👐 🧾 🤚 🙁 📡 ☝.
|
||||||
|
|
||||||
|
⚫️ 🛎 ⚙️ 🎏 🈸 👈 🚫 🎯 💪 💽, 👩💻 🧾, ⚖️ 🙆 📚 ⚒ 👈 👟 🏤-🏗 ✳. 👐 📚 👫 ⚒ 💪 🚮 ⏮️ 🔌-🔌.
|
||||||
|
|
||||||
|
👉 ⚖ 🍕, & ➖ "🕸" 👈 💪 ↔ 📔 ⚫️❔ ⚫️❔ 💪 🔑 ⚒ 👈 👤 💚 🚧.
|
||||||
|
|
||||||
|
👐 🦁 🏺, ⚫️ 😑 💖 👍 🏏 🏗 🔗. ⏭ 👜 🔎 "✳ 🎂 🛠️" 🏺.
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
◾-🛠️. ⚒ ⚫️ ⏩ 🌀 & 🏏 🧰 & 🍕 💪.
|
||||||
|
|
||||||
|
✔️ 🙅 & ⏩ ⚙️ 🕹 ⚙️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://requests.readthedocs.io" class="external-link" target="_blank">📨</a>
|
||||||
|
|
||||||
|
**FastAPI** 🚫 🤙 🎛 **📨**. 👫 ↔ 📶 🎏.
|
||||||
|
|
||||||
|
⚫️ 🔜 🤙 ⚠ ⚙️ 📨 *🔘* FastAPI 🈸.
|
||||||
|
|
||||||
|
✋️, FastAPI 🤚 🌈 ⚪️➡️ 📨.
|
||||||
|
|
||||||
|
**📨** 🗃 *🔗* ⏮️ 🔗 (👩💻), ⏪ **FastAPI** 🗃 *🏗* 🔗 (💽).
|
||||||
|
|
||||||
|
👫, 🌖 ⚖️ 🌘, 🔄 🔚, 🔗 🔠 🎏.
|
||||||
|
|
||||||
|
📨 ✔️ 📶 🙅 & 🏋️ 🔧, ⚫️ 📶 ⏩ ⚙️, ⏮️ 🤔 🔢. ✋️ 🎏 🕰, ⚫️ 📶 🏋️ & 🛃.
|
||||||
|
|
||||||
|
👈 ⚫️❔, 💬 🛂 🕸:
|
||||||
|
|
||||||
|
> 📨 1️⃣ 🏆 ⏬ 🐍 📦 🌐 🕰
|
||||||
|
|
||||||
|
🌌 👆 ⚙️ ⚫️ 📶 🙅. 🖼, `GET` 📨, 👆 🔜 ✍:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
response = requests.get("http://example.com/some/url")
|
||||||
|
```
|
||||||
|
|
||||||
|
FastAPI 😑 🛠️ *➡ 🛠️* 💪 👀 💖:
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
@app.get("/some/url")
|
||||||
|
def read_url():
|
||||||
|
return {"message": "Hello World"}
|
||||||
|
```
|
||||||
|
|
||||||
|
👀 🔀 `requests.get(...)` & `@app.get(...)`.
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
* ✔️ 🙅 & 🏋️ 🛠️.
|
||||||
|
* ⚙️ 🇺🇸🔍 👩🔬 📛 (🛠️) 🔗, 🎯 & 🏋️ 🌌.
|
||||||
|
* ✔️ 🤔 🔢, ✋️ 🏋️ 🛃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://swagger.io/" class="external-link" target="_blank">🦁</a> / <a href="https://github.com/OAI/OpenAPI-Specification/" class="external-link" target="_blank">🗄</a>
|
||||||
|
|
||||||
|
👑 ⚒ 👤 💚 ⚪️➡️ ✳ 🎂 🛠️ 🏧 🛠️ 🧾.
|
||||||
|
|
||||||
|
⤴️ 👤 🔎 👈 📤 🐩 📄 🔗, ⚙️ 🎻 (⚖️ 📁, ↔ 🎻) 🤙 🦁.
|
||||||
|
|
||||||
|
& 📤 🕸 👩💻 🔢 🦁 🛠️ ⏪ ✍. , 💆♂ 💪 🏗 🦁 🧾 🛠️ 🔜 ✔ ⚙️ 👉 🕸 👩💻 🔢 🔁.
|
||||||
|
|
||||||
|
☝, 🦁 👐 💾 🏛, 📁 🗄.
|
||||||
|
|
||||||
|
👈 ⚫️❔ 🕐❔ 💬 🔃 ⏬ 2️⃣.0️⃣ ⚫️ ⚠ 💬 "🦁", & ⏬ 3️⃣ ➕ "🗄".
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
🛠️ & ⚙️ 📂 🐩 🛠️ 🔧, ↩️ 🛃 🔗.
|
||||||
|
|
||||||
|
& 🛠️ 🐩-⚓️ 👩💻 🔢 🧰:
|
||||||
|
|
||||||
|
* <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">🦁 🎚</a>
|
||||||
|
* <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">📄</a>
|
||||||
|
|
||||||
|
👫 2️⃣ 👐 ➖ 📶 🌟 & ⚖, ✋️ 🔨 ⏩ 🔎, 👆 💪 🔎 💯 🌖 🎛 👩💻 🔢 🗄 (👈 👆 💪 ⚙️ ⏮️ **FastAPI**).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🏺 🎂 🛠️
|
||||||
|
|
||||||
|
📤 📚 🏺 🎂 🛠️, ✋️ ⏮️ 💰 🕰 & 👷 🔘 🔬 👫, 👤 🔎 👈 📚 😞 ⚖️ 🚫, ⏮️ 📚 🧍 ❔ 👈 ⚒ 👫 🙃.
|
||||||
|
|
||||||
|
### <a href="https://marshmallow.readthedocs.io/en/stable/" class="external-link" target="_blank">🍭</a>
|
||||||
|
|
||||||
|
1️⃣ 👑 ⚒ 💪 🛠️ ⚙️ 📊 "<abbr title="also called marshalling, conversion">🛠️</abbr>" ❔ ✊ 📊 ⚪️➡️ 📟 (🐍) & 🏭 ⚫️ 🔘 🕳 👈 💪 📨 🔘 🕸. 🖼, 🏭 🎚 ⚗ 📊 ⚪️➡️ 💽 🔘 🎻 🎚. 🏭 `datetime` 🎚 🔘 🎻, ♒️.
|
||||||
|
|
||||||
|
➕1️⃣ 🦏 ⚒ 💚 🔗 💽 🔬, ⚒ 💭 👈 💽 ☑, 🤝 🎯 🔢. 🖼, 👈 🏑 `int`, & 🚫 🎲 🎻. 👉 ✴️ ⚠ 📨 💽.
|
||||||
|
|
||||||
|
🍵 💽 🔬 ⚙️, 👆 🔜 ✔️ 🌐 ✅ ✋, 📟.
|
||||||
|
|
||||||
|
👫 ⚒ ⚫️❔ 🍭 🏗 🚚. ⚫️ 👑 🗃, & 👤 ✔️ ⚙️ ⚫️ 📚 ⏭.
|
||||||
|
|
||||||
|
✋️ ⚫️ ✍ ⏭ 📤 🔀 🐍 🆎 🔑. , 🔬 🔠 <abbr title="the definition of how data should be formed">🔗</abbr> 👆 💪 ⚙️ 🎯 🇨🇻 & 🎓 🚚 🍭.
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
⚙️ 📟 🔬 "🔗" 👈 🚚 💽 🆎 & 🔬, 🔁.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://webargs.readthedocs.io/en/latest/" class="external-link" target="_blank">Webarg</a>
|
||||||
|
|
||||||
|
➕1️⃣ 🦏 ⚒ ✔ 🔗 <abbr title="reading and converting to Python data">✍</abbr> 📊 ⚪️➡️ 📨 📨.
|
||||||
|
|
||||||
|
Webarg 🧰 👈 ⚒ 🚚 👈 🔛 🔝 📚 🛠️, 🔌 🏺.
|
||||||
|
|
||||||
|
⚫️ ⚙️ 🍭 🔘 💽 🔬. & ⚫️ ✍ 🎏 👩💻.
|
||||||
|
|
||||||
|
⚫️ 👑 🧰 & 👤 ✔️ ⚙️ ⚫️ 📚 💁♂️, ⏭ ✔️ **FastAPI**.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
Webarg ✍ 🎏 🍭 👩💻.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
✔️ 🏧 🔬 📨 📨 💽.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://apispec.readthedocs.io/en/stable/" class="external-link" target="_blank">APISpec</a>
|
||||||
|
|
||||||
|
🍭 & Webarg 🚚 🔬, ✍ & 🛠️ 🔌-🔌.
|
||||||
|
|
||||||
|
✋️ 🧾 ❌. ⤴️ APISpec ✍.
|
||||||
|
|
||||||
|
⚫️ 🔌-📚 🛠️ (& 📤 🔌-💃 💁♂️).
|
||||||
|
|
||||||
|
🌌 ⚫️ 👷 👈 👆 ✍ 🔑 🔗 ⚙️ 📁 📁 🔘 #️⃣ 🔠 🔢 🚚 🛣.
|
||||||
|
|
||||||
|
& ⚫️ 🏗 🗄 🔗.
|
||||||
|
|
||||||
|
👈 ❔ ⚫️ 👷 🏺, 💃, 🆘, ♒️.
|
||||||
|
|
||||||
|
✋️ ⤴️, 👥 ✔️ 🔄 ⚠ ✔️ ◾-❕, 🔘 🐍 🎻 (🦏 📁).
|
||||||
|
|
||||||
|
👨🎨 💪 🚫 ℹ 🌅 ⏮️ 👈. & 🚥 👥 🔀 🔢 ⚖️ 🍭 🔗 & 💭 🔀 👈 📁#️⃣, 🏗 🔗 🔜 ❌.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
APISpec ✍ 🎏 🍭 👩💻.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
🐕🦺 📂 🐩 🛠️, 🗄.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://flask-apispec.readthedocs.io/en/latest/" class="external-link" target="_blank">🏺-Apispec</a>
|
||||||
|
|
||||||
|
⚫️ 🏺 🔌 -, 👈 👔 👯♂️ Webarg, 🍭 & APISpec.
|
||||||
|
|
||||||
|
⚫️ ⚙️ ℹ ⚪️➡️ Webarg & 🍭 🔁 🏗 🗄 🔗, ⚙️ APISpec.
|
||||||
|
|
||||||
|
⚫️ 👑 🧰, 📶 🔽-📈. ⚫️ 🔜 🌌 🌖 🌟 🌘 📚 🏺 🔌-🔌 👅 📤. ⚫️ 💪 ↩️ 🚮 🧾 ➖ 💁♂️ 🩲 & 📝.
|
||||||
|
|
||||||
|
👉 ❎ ✔️ ✍ 📁 (➕1️⃣ ❕) 🔘 🐍 ✍.
|
||||||
|
|
||||||
|
👉 🌀 🏺, 🏺-Apispec ⏮️ 🍭 & Webarg 👇 💕 👩💻 📚 ⏭ 🏗 **FastAPI**.
|
||||||
|
|
||||||
|
⚙️ ⚫️ ↘️ 🏗 📚 🏺 🌕-📚 🚂. 👫 👑 📚 👤 (& 📚 🔢 🏉) ✔️ ⚙️ 🆙 🔜:
|
||||||
|
|
||||||
|
* <a href="https://github.com/tiangolo/full-stack" class="external-link" target="_blank">https://github.com/tiangolo/full-stack</a>
|
||||||
|
* <a href="https://github.com/tiangolo/full-stack-flask-couchbase" class="external-link" target="_blank">https://github.com/tiangolo/full-stack-flask-couchbase</a>
|
||||||
|
* <a href="https://github.com/tiangolo/full-stack-flask-couchdb" class="external-link" target="_blank">https://github.com/tiangolo/full-stack-flask-couchdb</a>
|
||||||
|
|
||||||
|
& 👫 🎏 🌕-📚 🚂 🧢 [**FastAPI** 🏗 🚂](project-generation.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🏺-Apispec ✍ 🎏 🍭 👩💻.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
🏗 🗄 🔗 🔁, ⚪️➡️ 🎏 📟 👈 🔬 🛠️ & 🔬.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://nestjs.com/" class="external-link" target="_blank">NestJS</a> (& <a href="https://angular.io/" class="external-link" target="_blank">📐</a>)
|
||||||
|
|
||||||
|
👉 ➖🚫 🚫 🐍, NestJS 🕸 (📕) ✳ 🛠️ 😮 📐.
|
||||||
|
|
||||||
|
⚫️ 🏆 🕳 🙁 🎏 ⚫️❔ 💪 🔨 ⏮️ 🏺-Apispec.
|
||||||
|
|
||||||
|
⚫️ ✔️ 🛠️ 🔗 💉 ⚙️, 😮 📐 2️⃣. ⚫️ 🚚 🏤-® "💉" (💖 🌐 🎏 🔗 💉 ⚙️ 👤 💭),, ⚫️ 🚮 🎭 & 📟 🔁.
|
||||||
|
|
||||||
|
🔢 🔬 ⏮️ 📕 🆎 (🎏 🐍 🆎 🔑), 👨🎨 🐕🦺 👍.
|
||||||
|
|
||||||
|
✋️ 📕 📊 🚫 🛡 ⏮️ 📹 🕸, ⚫️ 🚫🔜 ⚓️ 🔛 🆎 🔬 🔬, 🛠️ & 🧾 🎏 🕰. ↩️ 👉 & 🔧 🚫, 🤚 🔬, 🛠️ & 🏧 🔗 ⚡, ⚫️ 💪 🚮 👨🎨 📚 🥉. , ⚫️ ▶️️ 🔁.
|
||||||
|
|
||||||
|
⚫️ 💪 🚫 🍵 🔁 🏷 📶 👍. , 🚥 🎻 💪 📨 🎻 🎚 👈 ✔️ 🔘 🏑 👈 🔄 🐦 🎻 🎚, ⚫️ 🚫🔜 ☑ 📄 & ✔.
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
⚙️ 🐍 🆎 ✔️ 👑 👨🎨 🐕🦺.
|
||||||
|
|
||||||
|
✔️ 🏋️ 🔗 💉 ⚙️. 🔎 🌌 📉 📟 🔁.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://sanic.readthedocs.io/en/latest/" class="external-link" target="_blank">🤣</a>
|
||||||
|
|
||||||
|
⚫️ 🕐 🥇 📶 ⏩ 🐍 🛠️ ⚓️ 🔛 `asyncio`. ⚫️ ⚒ 📶 🎏 🏺.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
⚫️ ⚙️ <a href="https://github.com/MagicStack/uvloop" class="external-link" target="_blank">`uvloop`</a> ↩️ 🔢 🐍 `asyncio` ➰. 👈 ⚫️❔ ⚒ ⚫️ ⏩.
|
||||||
|
|
||||||
|
⚫️ 🎯 😮 Uvicorn & 💃, 👈 ⏳ ⏩ 🌘 🤣 📂 📇.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
🔎 🌌 ✔️ 😜 🎭.
|
||||||
|
|
||||||
|
👈 ⚫️❔ **FastAPI** ⚓️ 🔛 💃, ⚫️ ⏩ 🛠️ 💪 (💯 🥉-🥳 📇).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://falconframework.org/" class="external-link" target="_blank">🦅</a>
|
||||||
|
|
||||||
|
🦅 ➕1️⃣ ↕ 🎭 🐍 🛠️, ⚫️ 🔧 ⭐, & 👷 🏛 🎏 🛠️ 💖 🤗.
|
||||||
|
|
||||||
|
⚫️ 🏗 ✔️ 🔢 👈 📨 2️⃣ 🔢, 1️⃣ "📨" & 1️⃣ "📨". ⤴️ 👆 "✍" 🍕 ⚪️➡️ 📨, & "✍" 🍕 📨. ↩️ 👉 🔧, ⚫️ 🚫 💪 📣 📨 🔢 & 💪 ⏮️ 🐩 🐍 🆎 🔑 🔢 🔢.
|
||||||
|
|
||||||
|
, 💽 🔬, 🛠️, & 🧾, ✔️ ⌛ 📟, 🚫 🔁. ⚖️ 👫 ✔️ 🛠️ 🛠️ 🔛 🔝 🦅, 💖 🤗. 👉 🎏 🔺 🔨 🎏 🛠️ 👈 😮 🦅 🔧, ✔️ 1️⃣ 📨 🎚 & 1️⃣ 📨 🎚 🔢.
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
🔎 🌌 🤚 👑 🎭.
|
||||||
|
|
||||||
|
⤴️ ⏮️ 🤗 (🤗 ⚓️ 🔛 🦅) 😮 **FastAPI** 📣 `response` 🔢 🔢.
|
||||||
|
|
||||||
|
👐 FastAPI ⚫️ 📦, & ⚙️ ✴️ ⚒ 🎚, 🍪, & 🎛 👔 📟.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://moltenframework.com/" class="external-link" target="_blank">♨</a>
|
||||||
|
|
||||||
|
👤 🔎 ♨ 🥇 ▶️ 🏗 **FastAPI**. & ⚫️ ✔️ 🎏 💭:
|
||||||
|
|
||||||
|
* ⚓️ 🔛 🐍 🆎 🔑.
|
||||||
|
* 🔬 & 🧾 ⚪️➡️ 👫 🆎.
|
||||||
|
* 🔗 💉 ⚙️.
|
||||||
|
|
||||||
|
⚫️ 🚫 ⚙️ 💽 🔬, 🛠️ & 🧾 🥉-🥳 🗃 💖 Pydantic, ⚫️ ✔️ 🚮 👍. , 👫 💽 🆎 🔑 🔜 🚫 ♻ 💪.
|
||||||
|
|
||||||
|
⚫️ 🚚 🐥 🍖 🌅 🔁 📳. & ⚫️ ⚓️ 🔛 🇨🇻 (↩️ 🔫), ⚫️ 🚫 🔧 ✊ 📈 ↕-🎭 🚚 🧰 💖 Uvicorn, 💃 & 🤣.
|
||||||
|
|
||||||
|
🔗 💉 ⚙️ 🚚 🏤-® 🔗 & 🔗 ❎ 🧢 🔛 📣 🆎. , ⚫️ 🚫 💪 📣 🌅 🌘 1️⃣ "🦲" 👈 🚚 🎯 🆎.
|
||||||
|
|
||||||
|
🛣 📣 👁 🥉, ⚙️ 🔢 📣 🎏 🥉 (↩️ ⚙️ 👨🎨 👈 💪 🥉 ▶️️ 🔛 🔝 🔢 👈 🍵 🔗). 👉 🔐 ❔ ✳ 🔨 ⚫️ 🌘 ❔ 🏺 (& 💃) 🔨 ⚫️. ⚫️ 🎏 📟 👜 👈 📶 😆 🔗.
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
🔬 ➕ 🔬 💽 🆎 ⚙️ "🔢" 💲 🏷 🔢. 👉 📉 👨🎨 🐕🦺, & ⚫️ 🚫 💪 Pydantic ⏭.
|
||||||
|
|
||||||
|
👉 🤙 😮 🛠️ 🍕 Pydantic, 🐕🦺 🎏 🔬 📄 👗 (🌐 👉 🛠️ 🔜 ⏪ 💪 Pydantic).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://github.com/hugapi/hug" class="external-link" target="_blank">🤗</a>
|
||||||
|
|
||||||
|
🤗 🕐 🥇 🛠️ 🛠️ 📄 🛠️ 🔢 🆎 ⚙️ 🐍 🆎 🔑. 👉 👑 💭 👈 😮 🎏 🧰 🎏.
|
||||||
|
|
||||||
|
⚫️ ⚙️ 🛃 🆎 🚮 📄 ↩️ 🐩 🐍 🆎, ✋️ ⚫️ 🦏 🔁 ⏩.
|
||||||
|
|
||||||
|
⚫️ 🕐 🥇 🛠️ 🏗 🛃 🔗 📣 🎂 🛠️ 🎻.
|
||||||
|
|
||||||
|
⚫️ 🚫 ⚓️ 🔛 🐩 💖 🗄 & 🎻 🔗. ⚫️ 🚫🔜 🎯 🛠️ ⚫️ ⏮️ 🎏 🧰, 💖 🦁 🎚. ✋️ 🔄, ⚫️ 📶 💡 💭.
|
||||||
|
|
||||||
|
⚫️ ✔️ 😌, ⭐ ⚒: ⚙️ 🎏 🛠️, ⚫️ 💪 ✍ 🔗 & 🇳🇨.
|
||||||
|
|
||||||
|
⚫️ ⚓️ 🔛 ⏮️ 🐩 🔁 🐍 🕸 🛠️ (🇨🇻), ⚫️ 💪 🚫 🍵 *️⃣ & 🎏 👜, 👐 ⚫️ ✔️ ↕ 🎭 💁♂️.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🤗 ✍ ✡ 🗄, 🎏 👼 <a href="https://github.com/timothycrosley/isort" class="external-link" target="_blank">`isort`</a>, 👑 🧰 🔁 😇 🗄 🐍 📁.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check | 💭 😮 **FastAPI**
|
||||||
|
|
||||||
|
🤗 😮 🍕 APIStar, & 1️⃣ 🧰 👤 🔎 🏆 👍, 🌟 APIStar.
|
||||||
|
|
||||||
|
🤗 ℹ 😍 **FastAPI** ⚙️ 🐍 🆎 🔑 📣 🔢, & 🏗 🔗 ⚖ 🛠️ 🔁.
|
||||||
|
|
||||||
|
🤗 😮 **FastAPI** 📣 `response` 🔢 🔢 ⚒ 🎚 & 🍪.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://github.com/encode/apistar" class="external-link" target="_blank">APIStar</a> (<= 0️⃣.5️⃣)
|
||||||
|
|
||||||
|
▶️️ ⏭ 🤔 🏗 **FastAPI** 👤 🔎 **APIStar** 💽. ⚫️ ✔️ 🌖 🌐 👤 👀 & ✔️ 👑 🔧.
|
||||||
|
|
||||||
|
⚫️ 🕐 🥇 🛠️ 🛠️ ⚙️ 🐍 🆎 🔑 📣 🔢 & 📨 👈 👤 ⏱ 👀 (⏭ NestJS & ♨). 👤 🔎 ⚫️ 🌅 ⚖️ 🌘 🎏 🕰 🤗. ✋️ APIStar ⚙️ 🗄 🐩.
|
||||||
|
|
||||||
|
⚫️ ✔️ 🏧 💽 🔬, 💽 🛠️ & 🗄 🔗 ⚡ ⚓️ 🔛 🎏 🆎 🔑 📚 🥉.
|
||||||
|
|
||||||
|
💪 🔗 🔑 🚫 ⚙️ 🎏 🐍 🆎 🔑 💖 Pydantic, ⚫️ 🍖 🌅 🎏 🍭,, 👨🎨 🐕🦺 🚫🔜 👍, ✋️, APIStar 🏆 💪 🎛.
|
||||||
|
|
||||||
|
⚫️ ✔️ 🏆 🎭 📇 🕰 (🕴 💥 💃).
|
||||||
|
|
||||||
|
🥇, ⚫️ 🚫 ✔️ 🏧 🛠️ 🧾 🕸 🎚, ✋️ 👤 💭 👤 💪 🚮 🦁 🎚 ⚫️.
|
||||||
|
|
||||||
|
⚫️ ✔️ 🔗 💉 ⚙️. ⚫️ ✔ 🏤-® 🦲, 🎏 🧰 🔬 🔛. ✋️, ⚫️ 👑 ⚒.
|
||||||
|
|
||||||
|
👤 🙅 💪 ⚙️ ⚫️ 🌕 🏗, ⚫️ 🚫 ✔️ 💂♂ 🛠️,, 👤 🚫 🚫 ❎ 🌐 ⚒ 👤 ✔️ ⏮️ 🌕-📚 🚂 ⚓️ 🔛 🏺-Apispec. 👤 ✔️ 👇 📈 🏗 ✍ 🚲 📨 ❎ 👈 🛠️.
|
||||||
|
|
||||||
|
✋️ ⤴️, 🏗 🎯 🔀.
|
||||||
|
|
||||||
|
⚫️ 🙅♂ 📏 🛠️ 🕸 🛠️, 👼 💪 🎯 🔛 💃.
|
||||||
|
|
||||||
|
🔜 APIStar ⚒ 🧰 ✔ 🗄 🔧, 🚫 🕸 🛠️.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
APIStar ✍ ✡ 🇺🇸🏛. 🎏 👨 👈 ✍:
|
||||||
|
|
||||||
|
* ✳ 🎂 🛠️
|
||||||
|
* 💃 (❔ **FastAPI** ⚓️)
|
||||||
|
* Uvicorn (⚙️ 💃 & **FastAPI**)
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check | 😮 **FastAPI**
|
||||||
|
|
||||||
|
🔀.
|
||||||
|
|
||||||
|
💭 📣 💗 👜 (💽 🔬, 🛠️ & 🧾) ⏮️ 🎏 🐍 🆎, 👈 🎏 🕰 🚚 👑 👨🎨 🐕🦺, 🕳 👤 🤔 💎 💭.
|
||||||
|
|
||||||
|
& ⏮️ 🔎 📏 🕰 🎏 🛠️ & 🔬 📚 🎏 🎛, APIStar 🏆 🎛 💪.
|
||||||
|
|
||||||
|
⤴️ APIStar ⛔️ 🔀 💽 & 💃 ✍, & 🆕 👻 🏛 ✅ ⚙️. 👈 🏁 🌈 🏗 **FastAPI**.
|
||||||
|
|
||||||
|
👤 🤔 **FastAPI** "🛐 👨💼" APIStar, ⏪ 📉 & 📈 ⚒, ⌨ ⚙️, & 🎏 🍕, ⚓️ 🔛 🏫 ⚪️➡️ 🌐 👉 ⏮️ 🧰.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⚙️ **FastAPI**
|
||||||
|
|
||||||
|
### <a href="https://docs.pydantic.dev/" class="external-link" target="_blank">Pydantic</a>
|
||||||
|
|
||||||
|
Pydantic 🗃 🔬 💽 🔬, 🛠️ & 🧾 (⚙️ 🎻 🔗) ⚓️ 🔛 🐍 🆎 🔑.
|
||||||
|
|
||||||
|
👈 ⚒ ⚫️ 📶 🏋️.
|
||||||
|
|
||||||
|
⚫️ ⭐ 🍭. 👐 ⚫️ ⏩ 🌘 🍭 📇. & ⚫️ ⚓️ 🔛 🎏 🐍 🆎 🔑, 👨🎨 🐕🦺 👑.
|
||||||
|
|
||||||
|
/// check | **FastAPI** ⚙️ ⚫️
|
||||||
|
|
||||||
|
🍵 🌐 💽 🔬, 💽 🛠️ & 🏧 🏷 🧾 (⚓️ 🔛 🎻 🔗).
|
||||||
|
|
||||||
|
**FastAPI** ⤴️ ✊ 👈 🎻 🔗 💽 & 🚮 ⚫️ 🗄, ↖️ ⚪️➡️ 🌐 🎏 👜 ⚫️ 🔨.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://www.starlette.dev/" class="external-link" target="_blank">💃</a>
|
||||||
|
|
||||||
|
💃 💿 <abbr title="The new standard for building asynchronous Python web">🔫</abbr> 🛠️/🧰, ❔ 💯 🏗 ↕-🎭 ✳ 🐕🦺.
|
||||||
|
|
||||||
|
⚫️ 📶 🙅 & 🏋️. ⚫️ 🔧 💪 🏧, & ✔️ 🔧 🦲.
|
||||||
|
|
||||||
|
⚫️ ✔️:
|
||||||
|
|
||||||
|
* 🤙 🎆 🎭.
|
||||||
|
* *️⃣ 🐕🦺.
|
||||||
|
* -🛠️ 🖥 📋.
|
||||||
|
* 🕴 & 🤫 🎉.
|
||||||
|
* 💯 👩💻 🏗 🔛 🇸🇲.
|
||||||
|
* ⚜, 🗜, 🎻 📁, 🎏 📨.
|
||||||
|
* 🎉 & 🍪 🐕🦺.
|
||||||
|
* 1️⃣0️⃣0️⃣ 💯 💯 💰.
|
||||||
|
* 1️⃣0️⃣0️⃣ 💯 🆎 ✍ ✍.
|
||||||
|
* 👩❤👨 🏋️ 🔗.
|
||||||
|
|
||||||
|
💃 ⏳ ⏩ 🐍 🛠️ 💯. 🕴 💥 Uvicorn, ❔ 🚫 🛠️, ✋️ 💽.
|
||||||
|
|
||||||
|
💃 🚚 🌐 🔰 🕸 🕸 🛠️.
|
||||||
|
|
||||||
|
✋️ ⚫️ 🚫 🚚 🏧 💽 🔬, 🛠️ ⚖️ 🧾.
|
||||||
|
|
||||||
|
👈 1️⃣ 👑 👜 👈 **FastAPI** 🚮 🔛 🔝, 🌐 ⚓️ 🔛 🐍 🆎 🔑 (⚙️ Pydantic). 👈, ➕ 🔗 💉 ⚙️, 💂♂ 🚙, 🗄 🔗 ⚡, ♒️.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
🔫 🆕 "🐩" ➖ 🛠️ ✳ 🐚 🏉 👨🎓. ⚫️ 🚫 "🐍 🐩" (🇩🇬), 👐 👫 🛠️ 🔨 👈.
|
||||||
|
|
||||||
|
👐, ⚫️ ⏪ ➖ ⚙️ "🐩" 📚 🧰. 👉 📉 📉 🛠️, 👆 💪 🎛 Uvicorn 🙆 🎏 🔫 💽 (💖 👸 ⚖️ Hypercorn), ⚖️ 👆 💪 🚮 🔫 🔗 🧰, 💖 `python-socketio`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check | **FastAPI** ⚙️ ⚫️
|
||||||
|
|
||||||
|
🍵 🌐 🐚 🕸 🍕. ❎ ⚒ 🔛 🔝.
|
||||||
|
|
||||||
|
🎓 `FastAPI` ⚫️ 😖 🔗 ⚪️➡️ 🎓 `Starlette`.
|
||||||
|
|
||||||
|
, 🕳 👈 👆 💪 ⏮️ 💃, 👆 💪 ⚫️ 🔗 ⏮️ **FastAPI**, ⚫️ 🌖 💃 🔛 💊.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### <a href="https://www.uvicorn.dev/" class="external-link" target="_blank">Uvicorn</a>
|
||||||
|
|
||||||
|
Uvicorn 🌩-⏩ 🔫 💽, 🏗 🔛 uvloop & httptool.
|
||||||
|
|
||||||
|
⚫️ 🚫 🕸 🛠️, ✋️ 💽. 🖼, ⚫️ 🚫 🚚 🧰 🕹 ➡. 👈 🕳 👈 🛠️ 💖 💃 (⚖️ **FastAPI**) 🔜 🚚 🔛 🔝.
|
||||||
|
|
||||||
|
⚫️ 👍 💽 💃 & **FastAPI**.
|
||||||
|
|
||||||
|
/// check | **FastAPI** 👍 ⚫️
|
||||||
|
|
||||||
|
👑 🕸 💽 🏃 **FastAPI** 🈸.
|
||||||
|
|
||||||
|
👆 💪 🌀 ⚫️ ⏮️ 🐁, ✔️ 🔁 👁-🛠️ 💽.
|
||||||
|
|
||||||
|
✅ 🌅 ℹ [🛠️](deployment/index.md){.internal-link target=_blank} 📄.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 📇 & 🚅
|
||||||
|
|
||||||
|
🤔, 🔬, & 👀 🔺 🖖 Uvicorn, 💃 & FastAPI, ✅ 📄 🔃 [📇](benchmarks.md){.internal-link target=_blank}.
|
||||||
|
|
@ -0,0 +1,442 @@
|
||||||
|
# 🛠️ & 🔁 / ⌛
|
||||||
|
|
||||||
|
ℹ 🔃 `async def` ❕ *➡ 🛠️ 🔢* & 🖥 🔃 🔁 📟, 🛠️, & 🔁.
|
||||||
|
|
||||||
|
## 🏃 ❓
|
||||||
|
|
||||||
|
<abbr title="too long; didn't read"><strong>🆑;👩⚕️:</strong></abbr>
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 🥉 🥳 🗃 👈 💬 👆 🤙 👫 ⏮️ `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`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 🥉 🥳 🗃 👈 🔗 ⏮️ 🕳 (💽, 🛠️, 📁 ⚙️, ♒️.) & 🚫 ✔️ 🐕🦺 ⚙️ `await`, (👉 ⏳ 💼 🌅 💽 🗃), ⤴️ 📣 👆 *➡ 🛠️ 🔢* 🛎, ⏮️ `def`, 💖:
|
||||||
|
|
||||||
|
```Python hl_lines="2"
|
||||||
|
@app.get('/')
|
||||||
|
def results():
|
||||||
|
results = some_library()
|
||||||
|
return results
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🚥 👆 🈸 (😫) 🚫 ✔️ 🔗 ⏮️ 🕳 🙆 & ⌛ ⚫️ 📨, ⚙️ `async def`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🚥 👆 🚫 💭, ⚙️ 😐 `def`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**🗒**: 👆 💪 🌀 `def` & `async def` 👆 *➡ 🛠️ 🔢* 🌅 👆 💪 & 🔬 🔠 1️⃣ ⚙️ 🏆 🎛 👆. FastAPI 🔜 ▶️️ 👜 ⏮️ 👫.
|
||||||
|
|
||||||
|
😆, 🙆 💼 🔛, FastAPI 🔜 👷 🔁 & 📶 ⏩.
|
||||||
|
|
||||||
|
✋️ 📄 📶 🔛, ⚫️ 🔜 💪 🎭 🛠️.
|
||||||
|
|
||||||
|
## 📡 ℹ
|
||||||
|
|
||||||
|
🏛 ⏬ 🐍 ✔️ 🐕🦺 **"🔁 📟"** ⚙️ 🕳 🤙 **"🔁"**, ⏮️ **`async` & `await`** ❕.
|
||||||
|
|
||||||
|
➡️ 👀 👈 🔤 🍕 📄 🔛:
|
||||||
|
|
||||||
|
* **🔁 📟**
|
||||||
|
* **`async` & `await`**
|
||||||
|
* **🔁**
|
||||||
|
|
||||||
|
## 🔁 📟
|
||||||
|
|
||||||
|
🔁 📟 ⛓ 👈 🇪🇸 👶 ✔️ 🌌 💬 💻 / 📋 👶 👈 ☝ 📟, ⚫️ 👶 🔜 ✔️ ⌛ *🕳 🙆* 🏁 👱 🙆. ➡️ 💬 👈 *🕳 🙆* 🤙 "🐌-📁" 👶.
|
||||||
|
|
||||||
|
, ⏮️ 👈 🕰, 💻 💪 🚶 & 🎏 👷, ⏪ "🐌-📁" 👶 🏁.
|
||||||
|
|
||||||
|
⤴️ 💻 / 📋 👶 🔜 👟 🔙 🔠 🕰 ⚫️ ✔️ 🤞 ↩️ ⚫️ ⌛ 🔄, ⚖️ 🕐❔ ⚫️ 👶 🏁 🌐 👷 ⚫️ ✔️ 👈 ☝. & ⚫️ 👶 🔜 👀 🚥 🙆 📋 ⚫️ ⌛ ✔️ ⏪ 🏁, 🤸 ⚫️❔ ⚫️ ✔️.
|
||||||
|
|
||||||
|
⏭, ⚫️ 👶 ✊ 🥇 📋 🏁 (➡️ 💬, 👆 "🐌-📁" 👶) & 😣 ⚫️❔ ⚫️ ✔️ ⏮️ ⚫️.
|
||||||
|
|
||||||
|
👈 "⌛ 🕳 🙆" 🛎 🔗 <abbr title="Input and Output">👤/🅾</abbr> 🛠️ 👈 📶 "🐌" (🔬 🚅 🕹 & 💾 💾), 💖 ⌛:
|
||||||
|
|
||||||
|
* 📊 ⚪️➡️ 👩💻 📨 🔘 🕸
|
||||||
|
* 📊 📨 👆 📋 📨 👩💻 🔘 🕸
|
||||||
|
* 🎚 📁 💾 ✍ ⚙️ & 🤝 👆 📋
|
||||||
|
* 🎚 👆 📋 🤝 ⚙️ ✍ 💾
|
||||||
|
* 🛰 🛠️ 🛠️
|
||||||
|
* 💽 🛠️ 🏁
|
||||||
|
* 💽 🔢 📨 🏁
|
||||||
|
* ♒️.
|
||||||
|
|
||||||
|
🛠️ 🕰 🍴 ✴️ ⌛ <abbr title="Input and Output">👤/🅾</abbr> 🛠️, 👫 🤙 👫 "👤/🅾 🔗" 🛠️.
|
||||||
|
|
||||||
|
⚫️ 🤙 "🔁" ↩️ 💻 / 📋 🚫 ✔️ "🔁" ⏮️ 🐌 📋, ⌛ ☑ 🙍 👈 📋 🏁, ⏪ 🔨 🕳, 💪 ✊ 📋 🏁 & 😣 👷.
|
||||||
|
|
||||||
|
↩️ 👈, 💆♂ "🔁" ⚙️, 🕐 🏁, 📋 💪 ⌛ ⏸ 🐥 👄 (⏲) 💻 / 📋 🏁 ⚫️❔ ⚫️ 🚶, & ⤴️ 👟 🔙 ✊ 🏁 & 😣 👷 ⏮️ 👫.
|
||||||
|
|
||||||
|
"🔁" (👽 "🔁") 👫 🛎 ⚙️ ⚖ "🔁", ↩️ 💻 / 📋 ⏩ 🌐 📶 🔁 ⏭ 🔀 🎏 📋, 🚥 👈 🔁 🔌 ⌛.
|
||||||
|
|
||||||
|
### 🛠️ & 🍔
|
||||||
|
|
||||||
|
👉 💭 **🔁** 📟 🔬 🔛 🕣 🤙 **"🛠️"**. ⚫️ 🎏 ⚪️➡️ **"🔁"**.
|
||||||
|
|
||||||
|
**🛠️** & **🔁** 👯♂️ 🔗 "🎏 👜 😥 🌅 ⚖️ 🌘 🎏 🕰".
|
||||||
|
|
||||||
|
✋️ ℹ 🖖 *🛠️* & *🔁* 🎏.
|
||||||
|
|
||||||
|
👀 🔺, 🌈 📄 📖 🔃 🍔:
|
||||||
|
|
||||||
|
### 🛠️ 🍔
|
||||||
|
|
||||||
|
👆 🚶 ⏮️ 👆 🥰 🤚 ⏩ 🥕, 👆 🧍 ⏸ ⏪ 🏧 ✊ ✔ ⚪️➡️ 👫👫 🚪 👆. 👶
|
||||||
|
|
||||||
|
<img src="/img/async/concurrent-burgers/concurrent-burgers-01.png" class="illustration">
|
||||||
|
|
||||||
|
⤴️ ⚫️ 👆 🔄, 👆 🥉 👆 ✔ 2️⃣ 📶 🎀 🍔 👆 🥰 & 👆. 👶 👶
|
||||||
|
|
||||||
|
<img src="/img/async/concurrent-burgers/concurrent-burgers-02.png" class="illustration">
|
||||||
|
|
||||||
|
🏧 💬 🕳 🍳 👨🍳 👫 💭 👫 ✔️ 🏗 👆 🍔 (✋️ 👫 ⏳ 🏗 🕐 ⏮️ 👩💻).
|
||||||
|
|
||||||
|
<img src="/img/async/concurrent-burgers/concurrent-burgers-03.png" class="illustration">
|
||||||
|
|
||||||
|
👆 💸. 👶
|
||||||
|
|
||||||
|
🏧 🤝 👆 🔢 👆 🔄.
|
||||||
|
|
||||||
|
<img src="/img/async/concurrent-burgers/concurrent-burgers-04.png" class="illustration">
|
||||||
|
|
||||||
|
⏪ 👆 ⌛, 👆 🚶 ⏮️ 👆 🥰 & ⚒ 🏓, 👆 🧎 & 💬 ⏮️ 👆 🥰 📏 🕰 (👆 🍔 📶 🎀 & ✊ 🕰 🏗).
|
||||||
|
|
||||||
|
👆 🏖 🏓 ⏮️ 👆 🥰, ⏪ 👆 ⌛ 🍔, 👆 💪 💸 👈 🕰 😮 ❔ 👌, 🐨 & 🙃 👆 🥰 👶 👶 👶.
|
||||||
|
|
||||||
|
<img src="/img/async/concurrent-burgers/concurrent-burgers-05.png" class="illustration">
|
||||||
|
|
||||||
|
⏪ ⌛ & 💬 👆 🥰, ⚪️➡️ 🕰 🕰, 👆 ✅ 🔢 🖥 🔛 ⏲ 👀 🚥 ⚫️ 👆 🔄 ⏪.
|
||||||
|
|
||||||
|
⤴️ ☝, ⚫️ 😒 👆 🔄. 👆 🚶 ⏲, 🤚 👆 🍔 & 👟 🔙 🏓.
|
||||||
|
|
||||||
|
<img src="/img/async/concurrent-burgers/concurrent-burgers-06.png" class="illustration">
|
||||||
|
|
||||||
|
👆 & 👆 🥰 🍴 🍔 & ✔️ 👌 🕰. 👶
|
||||||
|
|
||||||
|
<img src="/img/async/concurrent-burgers/concurrent-burgers-07.png" class="illustration">
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🌹 🖼 <a href="https://www.instagram.com/ketrinadrawsalot" class="external-link" target="_blank">👯 🍏</a>. 👶
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🌈 👆 💻 / 📋 👶 👈 📖.
|
||||||
|
|
||||||
|
⏪ 👆 ⏸, 👆 ⛽ 👶, ⌛ 👆 🔄, 🚫 🔨 🕳 📶 "😌". ✋️ ⏸ ⏩ ↩️ 🏧 🕴 ✊ ✔ (🚫 🏗 👫), 👈 👌.
|
||||||
|
|
||||||
|
⤴️, 🕐❔ ⚫️ 👆 🔄, 👆 ☑ "😌" 👷, 👆 🛠️ 🍣, 💭 ⚫️❔ 👆 💚, 🤚 👆 🥰 ⚒, 💸, ✅ 👈 👆 🤝 ☑ 💵 ⚖️ 💳, ✅ 👈 👆 🈚 ☑, ✅ 👈 ✔ ✔️ ☑ 🏬, ♒️.
|
||||||
|
|
||||||
|
✋️ ⤴️, ✋️ 👆 🚫 ✔️ 👆 🍔, 👆 👷 ⏮️ 🏧 "🔛 ⏸" ⏸, ↩️ 👆 ✔️ ⌛ 👶 👆 🍔 🔜.
|
||||||
|
|
||||||
|
✋️ 👆 🚶 ↖️ ⚪️➡️ ⏲ & 🧎 🏓 ⏮️ 🔢 👆 🔄, 👆 💪 🎛 👶 👆 🙋 👆 🥰, & "👷" 👶 👶 🔛 👈. ⤴️ 👆 🔄 🔨 🕳 📶 "😌" 😏 ⏮️ 👆 🥰 👶.
|
||||||
|
|
||||||
|
⤴️ 🏧 👶 💬 "👤 🏁 ⏮️ 🔨 🍔" 🚮 👆 🔢 🔛 ⏲ 🖥, ✋️ 👆 🚫 🦘 💖 😜 ⏪ 🕐❔ 🖥 🔢 🔀 👆 🔄 🔢. 👆 💭 🙅♂ 1️⃣ 🔜 📎 👆 🍔 ↩️ 👆 ✔️ 🔢 👆 🔄, & 👫 ✔️ 👫.
|
||||||
|
|
||||||
|
👆 ⌛ 👆 🥰 🏁 📖 (🏁 ⏮️ 👷 👶 / 📋 ➖ 🛠️ 👶), 😀 🖐 & 💬 👈 👆 🔜 🍔 ⏸.
|
||||||
|
|
||||||
|
⤴️ 👆 🚶 ⏲ 👶, ▶️ 📋 👈 🔜 🏁 👶, ⚒ 🍔, 💬 👏 & ✊ 👫 🏓. 👈 🏁 👈 🔁 / 📋 🔗 ⏮️ ⏲ ⏹. 👈 🔄, ✍ 🆕 📋, "🍴 🍔" 👶 👶, ✋️ ⏮️ 1️⃣ "🤚 🍔" 🏁 ⏹.
|
||||||
|
|
||||||
|
### 🔗 🍔
|
||||||
|
|
||||||
|
🔜 ➡️ 🌈 👫 ➖🚫 🚫 "🛠️ 🍔", ✋️ "🔗 🍔".
|
||||||
|
|
||||||
|
👆 🚶 ⏮️ 👆 🥰 🤚 🔗 ⏩ 🥕.
|
||||||
|
|
||||||
|
👆 🧍 ⏸ ⏪ 📚 (➡️ 💬 8️⃣) 🏧 👈 🎏 🕰 🍳 ✊ ✔ ⚪️➡️ 👫👫 🚪 👆.
|
||||||
|
|
||||||
|
👱 ⏭ 👆 ⌛ 👫 🍔 🔜 ⏭ 🍂 ⏲ ↩️ 🔠 8️⃣ 🏧 🚶 & 🏗 🍔 ▶️️ ↖️ ⏭ 💆♂ ⏭ ✔.
|
||||||
|
|
||||||
|
<img src="/img/async/parallel-burgers/parallel-burgers-01.png" class="illustration">
|
||||||
|
|
||||||
|
⤴️ ⚫️ 😒 👆 🔄, 👆 🥉 👆 ✔ 2️⃣ 📶 🎀 🍔 👆 🥰 & 👆.
|
||||||
|
|
||||||
|
👆 💸 👶.
|
||||||
|
|
||||||
|
<img src="/img/async/parallel-burgers/parallel-burgers-02.png" class="illustration">
|
||||||
|
|
||||||
|
🏧 🚶 👨🍳.
|
||||||
|
|
||||||
|
👆 ⌛, 🧍 🚪 ⏲ 👶, 👈 🙅♂ 1️⃣ 🙆 ✊ 👆 🍔 ⏭ 👆, 📤 🙅♂ 🔢 🔄.
|
||||||
|
|
||||||
|
<img src="/img/async/parallel-burgers/parallel-burgers-03.png" class="illustration">
|
||||||
|
|
||||||
|
👆 & 👆 🥰 😩 🚫 ➡️ 🙆 🤚 🚪 👆 & ✊ 👆 🍔 🕐❔ 👫 🛬, 👆 🚫🔜 💸 🙋 👆 🥰. 👶
|
||||||
|
|
||||||
|
👉 "🔁" 👷, 👆 "🔁" ⏮️ 🏧/🍳 👶 👶. 👆 ✔️ ⌛ 👶 & 📤 ☑ 🙍 👈 🏧/🍳 👶 👶 🏁 🍔 & 🤝 👫 👆, ⚖️ ⏪, 👱 🙆 💪 ✊ 👫.
|
||||||
|
|
||||||
|
<img src="/img/async/parallel-burgers/parallel-burgers-04.png" class="illustration">
|
||||||
|
|
||||||
|
⤴️ 👆 🏧/🍳 👶 👶 😒 👟 🔙 ⏮️ 👆 🍔, ⏮️ 📏 🕰 ⌛ 👶 📤 🚪 ⏲.
|
||||||
|
|
||||||
|
<img src="/img/async/parallel-burgers/parallel-burgers-05.png" class="illustration">
|
||||||
|
|
||||||
|
👆 ✊ 👆 🍔 & 🚶 🏓 ⏮️ 👆 🥰.
|
||||||
|
|
||||||
|
👆 🍴 👫, & 👆 🔨. ⏹
|
||||||
|
|
||||||
|
<img src="/img/async/parallel-burgers/parallel-burgers-06.png" class="illustration">
|
||||||
|
|
||||||
|
📤 🚫 🌅 💬 ⚖️ 😏 🌅 🕰 💸 ⌛ 👶 🚪 ⏲. 👶
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🌹 🖼 <a href="https://www.instagram.com/ketrinadrawsalot" class="external-link" target="_blank">👯 🍏</a>. 👶
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👉 😐 🔗 🍔, 👆 💻 / 📋 👶 ⏮️ 2️⃣ 🕹 (👆 & 👆 🥰), 👯♂️ ⌛ 👶 & 💡 👫 🙋 👶 "⌛ 🔛 ⏲" 👶 📏 🕰.
|
||||||
|
|
||||||
|
⏩ 🥕 🏪 ✔️ 8️⃣ 🕹 (🏧/🍳). ⏪ 🛠️ 🍔 🏪 💪 ✔️ ✔️ 🕴 2️⃣ (1️⃣ 🏧 & 1️⃣ 🍳).
|
||||||
|
|
||||||
|
✋️, 🏁 💡 🚫 🏆. 👶
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👉 🔜 🔗 🌓 📖 🍔. 👶
|
||||||
|
|
||||||
|
🌅 "🎰 👨❤👨" 🖼 👉, 🌈 🏦.
|
||||||
|
|
||||||
|
🆙 ⏳, 🏆 🏦 ✔️ 💗 🏧 👶 👶 👶 👶 👶 👶 👶 👶 & 🦏 ⏸ 👶 👶 👶 👶 👶 👶 👶 👶.
|
||||||
|
|
||||||
|
🌐 🏧 🔨 🌐 👷 ⏮️ 1️⃣ 👩💻 ⏮️ 🎏 👶 👶 👶.
|
||||||
|
|
||||||
|
& 👆 ✔️ ⌛ 👶 ⏸ 📏 🕰 ⚖️ 👆 💸 👆 🔄.
|
||||||
|
|
||||||
|
👆 🎲 🚫🔜 💚 ✊ 👆 🥰 👶 ⏮️ 👆 👷 🏦 👶.
|
||||||
|
|
||||||
|
### 🍔 🏁
|
||||||
|
|
||||||
|
👉 😐 "⏩ 🥕 🍔 ⏮️ 👆 🥰", 📤 📚 ⌛ 👶, ⚫️ ⚒ 📚 🌅 🔑 ✔️ 🛠️ ⚙️ ⏸ 👶 👶.
|
||||||
|
|
||||||
|
👉 💼 🌅 🕸 🈸.
|
||||||
|
|
||||||
|
📚, 📚 👩💻, ✋️ 👆 💽 ⌛ 👶 👫 🚫--👍 🔗 📨 👫 📨.
|
||||||
|
|
||||||
|
& ⤴️ ⌛ 👶 🔄 📨 👟 🔙.
|
||||||
|
|
||||||
|
👉 "⌛" 👶 ⚖ ⏲, ✋️, ⚖ ⚫️ 🌐, ⚫️ 📚 ⌛ 🔚.
|
||||||
|
|
||||||
|
👈 ⚫️❔ ⚫️ ⚒ 📚 🔑 ⚙️ 🔁 ⏸ 👶 👶 📟 🕸 🔗.
|
||||||
|
|
||||||
|
👉 😇 🔀 ⚫️❔ ⚒ ✳ 🌟 (✋️ ✳ 🚫 🔗) & 👈 💪 🚶 🛠️ 🇪🇸.
|
||||||
|
|
||||||
|
& 👈 🎏 🎚 🎭 👆 🤚 ⏮️ **FastAPI**.
|
||||||
|
|
||||||
|
& 👆 💪 ✔️ 🔁 & 🔀 🎏 🕰, 👆 🤚 ↕ 🎭 🌘 🌅 💯 ✳ 🛠️ & 🔛 🇷🇪 ⏮️ 🚶, ❔ ✍ 🇪🇸 🔐 🅱 <a href="https://www.techempower.com/benchmarks/#section=data-r17&hw=ph&test=query&l=zijmkf-1" class="external-link" target="_blank">(🌐 👏 💃)</a>.
|
||||||
|
|
||||||
|
### 🛠️ 👍 🌘 🔁 ❓
|
||||||
|
|
||||||
|
😆 ❗ 👈 🚫 🛐 📖.
|
||||||
|
|
||||||
|
🛠️ 🎏 🌘 🔁. & ⚫️ 👻 🔛 **🎯** 😐 👈 🔌 📚 ⌛. ↩️ 👈, ⚫️ 🛎 📚 👍 🌘 🔁 🕸 🈸 🛠️. ✋️ 🚫 🌐.
|
||||||
|
|
||||||
|
, ⚖ 👈 👅, 🌈 📄 📏 📖:
|
||||||
|
|
||||||
|
> 👆 ✔️ 🧹 🦏, 💩 🏠.
|
||||||
|
|
||||||
|
*😆, 👈 🎂 📖*.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
📤 🙅♂ ⌛ 👶 🙆, 📚 👷 🔨, 🔛 💗 🥉 🏠.
|
||||||
|
|
||||||
|
👆 💪 ✔️ 🔄 🍔 🖼, 🥇 🏠 🧖♂, ⤴️ 👨🍳, ✋️ 👆 🚫 ⌛ 👶 🕳, 🧹 & 🧹, 🔄 🚫🔜 📉 🕳.
|
||||||
|
|
||||||
|
⚫️ 🔜 ✊ 🎏 💸 🕰 🏁 ⏮️ ⚖️ 🍵 🔄 (🛠️) & 👆 🔜 ✔️ ⌛ 🎏 💸 👷.
|
||||||
|
|
||||||
|
✋️ 👉 💼, 🚥 👆 💪 ✊️ 8️⃣ 👰-🏧/🍳/🔜-🧹, & 🔠 1️⃣ 👫 (➕ 👆) 💪 ✊ 🏒 🏠 🧹 ⚫️, 👆 💪 🌐 👷 **🔗**, ⏮️ ➕ ℹ, & 🏁 🌅 🔜.
|
||||||
|
|
||||||
|
👉 😐, 🔠 1️⃣ 🧹 (🔌 👆) 🔜 🕹, 🤸 👫 🍕 👨🏭.
|
||||||
|
|
||||||
|
& 🏆 🛠️ 🕰 ✊ ☑ 👷 (↩️ ⌛), & 👷 💻 ⌛ <abbr title="Central Processing Unit">💽</abbr>, 👫 🤙 👫 ⚠ "💽 🎁".
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
⚠ 🖼 💽 🔗 🛠️ 👜 👈 🚚 🏗 🧪 🏭.
|
||||||
|
|
||||||
|
🖼:
|
||||||
|
|
||||||
|
* **🎧** ⚖️ **🖼 🏭**.
|
||||||
|
* **💻 👓**: 🖼 ✍ 💯 🔅, 🔠 🔅 ✔️ 3️⃣ 💲 / 🎨, 🏭 👈 🛎 🚚 💻 🕳 🔛 📚 🔅, 🌐 🎏 🕰.
|
||||||
|
* **🎰 🏫**: ⚫️ 🛎 🚚 📚 "✖" & "🖼" ✖. 💭 🦏 📋 ⏮️ 🔢 & ✖ 🌐 👫 👯♂️ 🎏 🕰.
|
||||||
|
* **⏬ 🏫**: 👉 🎧-🏑 🎰 🏫,, 🎏 ✔. ⚫️ 👈 📤 🚫 👁 📋 🔢 ✖, ✋️ 🦏 ⚒ 👫, & 📚 💼, 👆 ⚙️ 🎁 🕹 🏗 & / ⚖️ ⚙️ 👈 🏷.
|
||||||
|
|
||||||
|
### 🛠️ ➕ 🔁: 🕸 ➕ 🎰 🏫
|
||||||
|
|
||||||
|
⏮️ **FastAPI** 👆 💪 ✊ 📈 🛠️ 👈 📶 ⚠ 🕸 🛠️ (🎏 👑 🧲 ✳).
|
||||||
|
|
||||||
|
✋️ 👆 💪 🐄 💰 🔁 & 💾 (✔️ 💗 🛠️ 🏃♂ 🔗) **💽 🎁** ⚖ 💖 👈 🎰 🏫 ⚙️.
|
||||||
|
|
||||||
|
👈, ➕ 🙅 👐 👈 🐍 👑 🇪🇸 **💽 🧪**, 🎰 🏫 & ✴️ ⏬ 🏫, ⚒ FastAPI 📶 👍 🏏 💽 🧪 / 🎰 🏫 🕸 🔗 & 🈸 (👪 📚 🎏).
|
||||||
|
|
||||||
|
👀 ❔ 🏆 👉 🔁 🏭 👀 📄 🔃 [🛠️](deployment/index.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
## `async` & `await`
|
||||||
|
|
||||||
|
🏛 ⏬ 🐍 ✔️ 📶 🏋️ 🌌 🔬 🔁 📟. 👉 ⚒ ⚫️ 👀 💖 😐 "🔁" 📟 & "⌛" 👆 ▶️️ 🙍.
|
||||||
|
|
||||||
|
🕐❔ 📤 🛠️ 👈 🔜 🚚 ⌛ ⏭ 🤝 🏁 & ✔️ 🐕🦺 👉 🆕 🐍 ⚒, 👆 💪 📟 ⚫️ 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
burgers = await get_burgers(2)
|
||||||
|
```
|
||||||
|
|
||||||
|
🔑 📥 `await`. ⚫️ 💬 🐍 👈 ⚫️ ✔️ ⌛ ⏸ `get_burgers(2)` 🏁 🔨 🚮 👜 👶 ⏭ ♻ 🏁 `burgers`. ⏮️ 👈, 🐍 🔜 💭 👈 ⚫️ 💪 🚶 & 🕳 🙆 👶 👶 👐 (💖 📨 ➕1️⃣ 📨).
|
||||||
|
|
||||||
|
`await` 👷, ⚫️ ✔️ 🔘 🔢 👈 🐕🦺 👉 🔀. 👈, 👆 📣 ⚫️ ⏮️ `async def`:
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
async def get_burgers(number: int):
|
||||||
|
# Do some asynchronous stuff to create the burgers
|
||||||
|
return burgers
|
||||||
|
```
|
||||||
|
|
||||||
|
...↩️ `def`:
|
||||||
|
|
||||||
|
```Python hl_lines="2"
|
||||||
|
# This is not asynchronous
|
||||||
|
def get_sequential_burgers(number: int):
|
||||||
|
# Do some sequential stuff to create the burgers
|
||||||
|
return burgers
|
||||||
|
```
|
||||||
|
|
||||||
|
⏮️ `async def`, 🐍 💭 👈, 🔘 👈 🔢, ⚫️ ✔️ 🤔 `await` 🧬, & 👈 ⚫️ 💪 "⏸" ⏸ 🛠️ 👈 🔢 & 🚶 🕳 🙆 👶 ⏭ 👟 🔙.
|
||||||
|
|
||||||
|
🕐❔ 👆 💚 🤙 `async def` 🔢, 👆 ✔️ "⌛" ⚫️. , 👉 🏆 🚫 👷:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
# This won't work, because get_burgers was defined with: 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
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🌅 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ✔️ 👀 👈 `await` 💪 🕴 ⚙️ 🔘 🔢 🔬 ⏮️ `async def`.
|
||||||
|
|
||||||
|
✋️ 🎏 🕰, 🔢 🔬 ⏮️ `async def` ✔️ "⌛". , 🔢 ⏮️ `async def` 💪 🕴 🤙 🔘 🔢 🔬 ⏮️ `async def` 💁♂️.
|
||||||
|
|
||||||
|
, 🔃 🥚 & 🐔, ❔ 👆 🤙 🥇 `async` 🔢 ❓
|
||||||
|
|
||||||
|
🚥 👆 👷 ⏮️ **FastAPI** 👆 🚫 ✔️ 😟 🔃 👈, ↩️ 👈 "🥇" 🔢 🔜 👆 *➡ 🛠️ 🔢*, & FastAPI 🔜 💭 ❔ ▶️️ 👜.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 💚 ⚙️ `async` / `await` 🍵 FastAPI, 👆 💪 ⚫️ 👍.
|
||||||
|
|
||||||
|
### ✍ 👆 👍 🔁 📟
|
||||||
|
|
||||||
|
💃 (& **FastAPI**) ⚓️ 🔛 <a href="https://anyio.readthedocs.io/en/stable/" class="external-link" target="_blank">AnyIO</a>, ❔ ⚒ ⚫️ 🔗 ⏮️ 👯♂️ 🐍 🐩 🗃 <a href="https://docs.python.org/3/library/asyncio-task.html" class="external-link" target="_blank">✳</a> & <a href="https://trio.readthedocs.io/en/stable/" class="external-link" target="_blank">🎻</a>.
|
||||||
|
|
||||||
|
🎯, 👆 💪 🔗 ⚙️ <a href="https://anyio.readthedocs.io/en/stable/" class="external-link" target="_blank">AnyIO</a> 👆 🏧 🛠️ ⚙️ 💼 👈 🚚 🌅 🏧 ⚓ 👆 👍 📟.
|
||||||
|
|
||||||
|
& 🚥 👆 🚫 ⚙️ FastAPI, 👆 💪 ✍ 👆 👍 🔁 🈸 ⏮️ <a href="https://anyio.readthedocs.io/en/stable/" class="external-link" target="_blank">AnyIO</a> 🏆 🔗 & 🤚 🚮 💰 (✅ *📊 🛠️*).
|
||||||
|
|
||||||
|
### 🎏 📨 🔁 📟
|
||||||
|
|
||||||
|
👉 👗 ⚙️ `async` & `await` 📶 🆕 🇪🇸.
|
||||||
|
|
||||||
|
✋️ ⚫️ ⚒ 👷 ⏮️ 🔁 📟 📚 ⏩.
|
||||||
|
|
||||||
|
👉 🎏 ❕ (⚖️ 🌖 🌓) 🔌 ⏳ 🏛 ⏬ 🕸 (🖥 & ✳).
|
||||||
|
|
||||||
|
✋️ ⏭ 👈, 🚚 🔁 📟 🌖 🏗 & ⚠.
|
||||||
|
|
||||||
|
⏮️ ⏬ 🐍, 👆 💪 ✔️ ⚙️ 🧵 ⚖️ <a href="https://www.gevent.org/" class="external-link" target="_blank">🐁</a>. ✋️ 📟 🌌 🌖 🏗 🤔, ℹ, & 💭 🔃.
|
||||||
|
|
||||||
|
⏮️ ⏬ ✳ / 🖥 🕸, 👆 🔜 ✔️ ⚙️ "⏲". ❔ ↘️ "⏲ 🔥😈".
|
||||||
|
|
||||||
|
## 🔁
|
||||||
|
|
||||||
|
**🔁** 📶 🎀 ⚖ 👜 📨 `async def` 🔢. 🐍 💭 👈 ⚫️ 🕳 💖 🔢 👈 ⚫️ 💪 ▶️ & 👈 ⚫️ 🔜 🔚 ☝, ✋️ 👈 ⚫️ 5️⃣📆 ⏸ ⏸ 🔘 💁♂️, 🕐❔ 📤 `await` 🔘 ⚫️.
|
||||||
|
|
||||||
|
✋️ 🌐 👉 🛠️ ⚙️ 🔁 📟 ⏮️ `async` & `await` 📚 🕰 🔬 ⚙️ "🔁". ⚫️ ⭐ 👑 🔑 ⚒ 🚶, "🔁".
|
||||||
|
|
||||||
|
## 🏁
|
||||||
|
|
||||||
|
➡️ 👀 🎏 🔤 ⚪️➡️ 🔛:
|
||||||
|
|
||||||
|
> 🏛 ⏬ 🐍 ✔️ 🐕🦺 **"🔁 📟"** ⚙️ 🕳 🤙 **"🔁"**, ⏮️ **`async` & `await`** ❕.
|
||||||
|
|
||||||
|
👈 🔜 ⚒ 🌅 🔑 🔜. 👶
|
||||||
|
|
||||||
|
🌐 👈 ⚫️❔ 🏋️ FastAPI (🔘 💃) & ⚫️❔ ⚒ ⚫️ ✔️ ✅ 🎆 🎭.
|
||||||
|
|
||||||
|
## 📶 📡 ℹ
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
👆 💪 🎲 🚶 👉.
|
||||||
|
|
||||||
|
👉 📶 📡 ℹ ❔ **FastAPI** 👷 🔘.
|
||||||
|
|
||||||
|
🚥 👆 ✔️ 📡 💡 (🈶-🏋, 🧵, 🍫, ♒️.) & 😟 🔃 ❔ FastAPI 🍵 `async def` 🆚 😐 `def`, 🚶 ⤴️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ➡ 🛠️ 🔢
|
||||||
|
|
||||||
|
🕐❔ 👆 📣 *➡ 🛠️ 🔢* ⏮️ 😐 `def` ↩️ `async def`, ⚫️ 🏃 🔢 🧵 👈 ⤴️ ⌛, ↩️ ➖ 🤙 🔗 (⚫️ 🔜 🍫 💽).
|
||||||
|
|
||||||
|
🚥 👆 👟 ⚪️➡️ ➕1️⃣ 🔁 🛠️ 👈 🔨 🚫 👷 🌌 🔬 🔛 & 👆 ⚙️ ⚖ 🙃 📊-🕴 *➡ 🛠️ 🔢* ⏮️ ✅ `def` 🤪 🎭 📈 (🔃 1️⃣0️⃣0️⃣ 💓), 🙏 🗒 👈 **FastAPI** ⭐ 🔜 🔄. 👫 💼, ⚫️ 👻 ⚙️ `async def` 🚥 👆 *➡ 🛠️ 🔢* ⚙️ 📟 👈 🎭 🚧 <abbr title="Input/Output: disk reading or writing, network communications.">👤/🅾</abbr>.
|
||||||
|
|
||||||
|
, 👯♂️ ⚠, 🤞 👈 **FastAPI** 🔜 [⏩](index.md#_15){.internal-link target=_blank} 🌘 (⚖️ 🌘 ⭐) 👆 ⏮️ 🛠️.
|
||||||
|
|
||||||
|
### 🔗
|
||||||
|
|
||||||
|
🎏 ✔ [🔗](tutorial/dependencies/index.md){.internal-link target=_blank}. 🚥 🔗 🐩 `def` 🔢 ↩️ `async def`, ⚫️ 🏃 🔢 🧵.
|
||||||
|
|
||||||
|
### 🎧-🔗
|
||||||
|
|
||||||
|
👆 💪 ✔️ 💗 🔗 & [🎧-🔗](tutorial/dependencies/sub-dependencies.md){.internal-link target=_blank} 🚫 🔠 🎏 (🔢 🔢 🔑), 👫 💪 ✍ ⏮️ `async def` & ⏮️ 😐 `def`. ⚫️ 🔜 👷, & 🕐 ✍ ⏮️ 😐 `def` 🔜 🤙 🔛 🔢 🧵 (⚪️➡️ 🧵) ↩️ ➖ "⌛".
|
||||||
|
|
||||||
|
### 🎏 🚙 🔢
|
||||||
|
|
||||||
|
🙆 🎏 🚙 🔢 👈 👆 🤙 🔗 💪 ✍ ⏮️ 😐 `def` ⚖️ `async def` & FastAPI 🏆 🚫 📉 🌌 👆 🤙 ⚫️.
|
||||||
|
|
||||||
|
👉 🔅 🔢 👈 FastAPI 🤙 👆: *➡ 🛠️ 🔢* & 🔗.
|
||||||
|
|
||||||
|
🚥 👆 🚙 🔢 😐 🔢 ⏮️ `def`, ⚫️ 🔜 🤙 🔗 (👆 ✍ ⚫️ 👆 📟), 🚫 🧵, 🚥 🔢 ✍ ⏮️ `async def` ⤴️ 👆 🔜 `await` 👈 🔢 🕐❔ 👆 🤙 ⚫️ 👆 📟.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🔄, 👉 📶 📡 ℹ 👈 🔜 🎲 ⚠ 🚥 👆 👟 🔎 👫.
|
||||||
|
|
||||||
|
⏪, 👆 🔜 👍 ⏮️ 📄 ⚪️➡️ 📄 🔛: <a href="#_2">🏃 ❓</a>.
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
# 📇
|
||||||
|
|
||||||
|
🔬 🇸🇲 📇 🎦 **FastAPI** 🈸 🏃♂ 🔽 Uvicorn <a href="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7" class="external-link" target="_blank">1️⃣ ⏩ 🐍 🛠️ 💪</a>, 🕴 🔛 💃 & Uvicorn 👫 (⚙️ 🔘 FastAPI). (*)
|
||||||
|
|
||||||
|
✋️ 🕐❔ ✅ 📇 & 🔺 👆 🔜 ✔️ 📄 🤯.
|
||||||
|
|
||||||
|
## 📇 & 🚅
|
||||||
|
|
||||||
|
🕐❔ 👆 ✅ 📇, ⚫️ ⚠ 👀 📚 🧰 🎏 🆎 🔬 🌓.
|
||||||
|
|
||||||
|
🎯, 👀 Uvicorn, 💃 & FastAPI 🔬 👯♂️ (👪 📚 🎏 🧰).
|
||||||
|
|
||||||
|
🙅 ⚠ ❎ 🧰, 👍 🎭 ⚫️ 🔜 🤚. & 🏆 📇 🚫 💯 🌖 ⚒ 🚚 🧰.
|
||||||
|
|
||||||
|
🔗 💖:
|
||||||
|
|
||||||
|
* **Uvicorn**: 🔫 💽
|
||||||
|
* **💃**: (⚙️ Uvicorn) 🕸 🕸
|
||||||
|
* **FastAPI**: (⚙️ 💃) 🛠️ 🕸 ⏮️ 📚 🌖 ⚒ 🏗 🔗, ⏮️ 💽 🔬, ♒️.
|
||||||
|
|
||||||
|
* **Uvicorn**:
|
||||||
|
* 🔜 ✔️ 🏆 🎭, ⚫️ 🚫 ✔️ 🌅 ➕ 📟 ↖️ ⚪️➡️ 💽 ⚫️.
|
||||||
|
* 👆 🚫🔜 ✍ 🈸 Uvicorn 🔗. 👈 🔜 ⛓ 👈 👆 📟 🔜 ✔️ 🔌 🌖 ⚖️ 🌘, 🌘, 🌐 📟 🚚 💃 (⚖️ **FastAPI**). & 🚥 👆 👈, 👆 🏁 🈸 🔜 ✔️ 🎏 🌥 ✔️ ⚙️ 🛠️ & 📉 👆 📱 📟 & 🐛.
|
||||||
|
* 🚥 👆 ⚖ Uvicorn, 🔬 ⚫️ 🛡 👸, Hypercorn, ✳, ♒️. 🈸 💽.
|
||||||
|
* **💃**:
|
||||||
|
* 🔜 ✔️ ⏭ 🏆 🎭, ⏮️ Uvicorn. 👐, 💃 ⚙️ Uvicorn 🏃. , ⚫️ 🎲 💪 🕴 🤚 "🐌" 🌘 Uvicorn ✔️ 🛠️ 🌅 📟.
|
||||||
|
* ✋️ ⚫️ 🚚 👆 🧰 🏗 🙅 🕸 🈸, ⏮️ 🕹 ⚓️ 🔛 ➡, ♒️.
|
||||||
|
* 🚥 👆 ⚖ 💃, 🔬 ⚫️ 🛡 🤣, 🏺, ✳, ♒️. 🕸 🛠️ (⚖️ 🕸).
|
||||||
|
* **FastAPI**:
|
||||||
|
* 🎏 🌌 👈 💃 ⚙️ Uvicorn & 🚫🔜 ⏩ 🌘 ⚫️, **FastAPI** ⚙️ 💃, ⚫️ 🚫🔜 ⏩ 🌘 ⚫️.
|
||||||
|
* FastAPI 🚚 🌅 ⚒ 🔛 🔝 💃. ⚒ 👈 👆 🌖 🕧 💪 🕐❔ 🏗 🔗, 💖 💽 🔬 & 🛠️. & ⚙️ ⚫️, 👆 🤚 🏧 🧾 🆓 (🏧 🧾 🚫 🚮 🌥 🏃♂ 🈸, ⚫️ 🏗 🔛 🕴).
|
||||||
|
* 🚥 👆 🚫 ⚙️ FastAPI & ⚙️ 💃 🔗 (⚖️ ➕1️⃣ 🧰, 💖 🤣, 🏺, 🆘, ♒️) 👆 🔜 ✔️ 🛠️ 🌐 💽 🔬 & 🛠️ 👆. , 👆 🏁 🈸 🔜 ✔️ 🎏 🌥 🚥 ⚫️ 🏗 ⚙️ FastAPI. & 📚 💼, 👉 💽 🔬 & 🛠️ 🦏 💸 📟 ✍ 🈸.
|
||||||
|
* , ⚙️ FastAPI 👆 ♻ 🛠️ 🕰, 🐛, ⏸ 📟, & 👆 🔜 🎲 🤚 🎏 🎭 (⚖️ 👍) 👆 🔜 🚥 👆 🚫 ⚙️ ⚫️ (👆 🔜 ✔️ 🛠️ ⚫️ 🌐 👆 📟).
|
||||||
|
* 🚥 👆 ⚖ FastAPI, 🔬 ⚫️ 🛡 🕸 🈸 🛠️ (⚖️ ⚒ 🧰) 👈 🚚 💽 🔬, 🛠️ & 🧾, 💖 🏺-apispec, NestJS, ♨, ♒️. 🛠️ ⏮️ 🛠️ 🏧 💽 🔬, 🛠️ & 🧾.
|
||||||
|
|
@ -0,0 +1,323 @@
|
||||||
|
# 🛠️ 🔧
|
||||||
|
|
||||||
|
🕐❔ 🛠️ **FastAPI** 🈸, ⚖️ 🤙, 🙆 🆎 🕸 🛠️, 📤 📚 🔧 👈 👆 🎲 💅 🔃, & ⚙️ 👫 👆 💪 🔎 **🏆 ☑** 🌌 **🛠️ 👆 🈸**.
|
||||||
|
|
||||||
|
⚠ 🔧:
|
||||||
|
|
||||||
|
* 💂♂ - 🇺🇸🔍
|
||||||
|
* 🏃♂ 🔛 🕴
|
||||||
|
* ⏏
|
||||||
|
* 🧬 (🔢 🛠️ 🏃)
|
||||||
|
* 💾
|
||||||
|
* ⏮️ 🔁 ⏭ ▶️
|
||||||
|
|
||||||
|
👥 🔜 👀 ❔ 👫 🔜 📉 **🛠️**.
|
||||||
|
|
||||||
|
🔚, 🏆 🎯 💪 **🍦 👆 🛠️ 👩💻** 🌌 👈 **🔐**, **❎ 📉**, & ⚙️ **📊 ℹ** (🖼 🛰 💽/🕹 🎰) ♻ 💪. 👶
|
||||||
|
|
||||||
|
👤 🔜 💬 👆 🍖 🌖 🔃 👫 **🔧** 📥, & 👈 🔜 🤞 🤝 👆 **🤔** 👆 🔜 💪 💭 ❔ 🛠️ 👆 🛠️ 📶 🎏 🌐, 🎲 **🔮** 🕐 👈 🚫 🔀.
|
||||||
|
|
||||||
|
🤔 👫 🔧, 👆 🔜 💪 **🔬 & 🔧** 🏆 🌌 🛠️ **👆 👍 🔗**.
|
||||||
|
|
||||||
|
⏭ 📃, 👤 🔜 🤝 👆 🌅 **🧱 🍮** 🛠️ FastAPI 🈸.
|
||||||
|
|
||||||
|
✋️ 🔜, ➡️ ✅ 👉 ⚠ **⚛ 💭**. 👫 🔧 ✔ 🙆 🎏 🆎 🕸 🛠️. 👶
|
||||||
|
|
||||||
|
## 💂♂ - 🇺🇸🔍
|
||||||
|
|
||||||
|
[⏮️ 📃 🔃 🇺🇸🔍](https.md){.internal-link target=_blank} 👥 🇭🇲 🔃 ❔ 🇺🇸🔍 🚚 🔐 👆 🛠️.
|
||||||
|
|
||||||
|
👥 👀 👈 🇺🇸🔍 🛎 🚚 🦲 **🔢** 👆 🈸 💽, **🤝 ❎ 🗳**.
|
||||||
|
|
||||||
|
& 📤 ✔️ 🕳 🈚 **♻ 🇺🇸🔍 📄**, ⚫️ 💪 🎏 🦲 ⚖️ ⚫️ 💪 🕳 🎏.
|
||||||
|
|
||||||
|
### 🖼 🧰 🇺🇸🔍
|
||||||
|
|
||||||
|
🧰 👆 💪 ⚙️ 🤝 ❎ 🗳:
|
||||||
|
|
||||||
|
* Traefik
|
||||||
|
* 🔁 🍵 📄 🔕 👶
|
||||||
|
* 📥
|
||||||
|
* 🔁 🍵 📄 🔕 👶
|
||||||
|
* 👌
|
||||||
|
* ⏮️ 🔢 🦲 💖 Certbot 📄 🔕
|
||||||
|
* ✳
|
||||||
|
* ⏮️ 🔢 🦲 💖 Certbot 📄 🔕
|
||||||
|
* Kubernetes ⏮️ 🚧 🕹 💖 👌
|
||||||
|
* ⏮️ 🔢 🦲 💖 🛂-👨💼 📄 🔕
|
||||||
|
* 🍵 🔘 ☁ 🐕🦺 🍕 👫 🐕🦺 (✍ 🔛 👶)
|
||||||
|
|
||||||
|
➕1️⃣ 🎛 👈 👆 💪 ⚙️ **☁ 🐕🦺** 👈 🔨 🌖 👷 ✅ ⚒ 🆙 🇺🇸🔍. ⚫️ 💪 ✔️ 🚫 ⚖️ 🈚 👆 🌅, ♒️. ✋️ 👈 💼, 👆 🚫🔜 ✔️ ⚒ 🆙 🤝 ❎ 🗳 👆.
|
||||||
|
|
||||||
|
👤 🔜 🎦 👆 🧱 🖼 ⏭ 📃.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
⤴️ ⏭ 🔧 🤔 🌐 🔃 📋 🏃 👆 ☑ 🛠️ (✅ Uvicorn).
|
||||||
|
|
||||||
|
## 📋 & 🛠️
|
||||||
|
|
||||||
|
👥 🔜 💬 📚 🔃 🏃 "**🛠️**", ⚫️ ⚠ ✔️ ☯ 🔃 ⚫️❔ ⚫️ ⛓, & ⚫️❔ 🔺 ⏮️ 🔤 "**📋**".
|
||||||
|
|
||||||
|
### ⚫️❔ 📋
|
||||||
|
|
||||||
|
🔤 **📋** 🛎 ⚙️ 🔬 📚 👜:
|
||||||
|
|
||||||
|
* **📟** 👈 👆 ✍, **🐍 📁**.
|
||||||
|
* **📁** 👈 💪 **🛠️** 🏃♂ ⚙️, 🖼: `python`, `python.exe` ⚖️ `uvicorn`.
|
||||||
|
* 🎯 📋 ⏪ ⚫️ **🏃♂** 🔛 🏗 ⚙️, ⚙️ 💽, & ♻ 👜 🔛 💾. 👉 🤙 **🛠️**.
|
||||||
|
|
||||||
|
### ⚫️❔ 🛠️
|
||||||
|
|
||||||
|
🔤 **🛠️** 🛎 ⚙️ 🌖 🎯 🌌, 🕴 🔗 👜 👈 🏃 🏃♂ ⚙️ (💖 🏁 ☝ 🔛):
|
||||||
|
|
||||||
|
* 🎯 📋 ⏪ ⚫️ **🏃♂** 🔛 🏃♂ ⚙️.
|
||||||
|
* 👉 🚫 🔗 📁, 🚫 📟, ⚫️ 🔗 **🎯** 👜 👈 ➖ **🛠️** & 🔄 🏃♂ ⚙️.
|
||||||
|
* 🙆 📋, 🙆 📟, **💪 🕴 👜** 🕐❔ ⚫️ ➖ **🛠️**. , 🕐❔ 📤 **🛠️ 🏃**.
|
||||||
|
* 🛠️ 💪 **❎** (⚖️ "💥") 👆, ⚖️ 🏃♂ ⚙️. 👈 ☝, ⚫️ ⛔️ 🏃/➖ 🛠️, & ⚫️ 💪 **🙅♂ 📏 👜**.
|
||||||
|
* 🔠 🈸 👈 👆 ✔️ 🏃 🔛 👆 💻 ✔️ 🛠️ ⛅ ⚫️, 🔠 🏃♂ 📋, 🔠 🚪, ♒️. & 📤 🛎 📚 🛠️ 🏃 **🎏 🕰** ⏪ 💻 🔛.
|
||||||
|
* 📤 💪 **💗 🛠️** **🎏 📋** 🏃 🎏 🕰.
|
||||||
|
|
||||||
|
🚥 👆 ✅ 👅 "📋 👨💼" ⚖️ "⚙️ 🖥" (⚖️ 🎏 🧰) 👆 🏃♂ ⚙️, 👆 🔜 💪 👀 📚 👈 🛠️ 🏃♂.
|
||||||
|
|
||||||
|
& , 🖼, 👆 🔜 🎲 👀 👈 📤 💗 🛠️ 🏃 🎏 🖥 📋 (🦎, 💄, 📐, ♒️). 👫 🛎 🏃 1️⃣ 🛠️ 📍 📑, ➕ 🎏 ➕ 🛠️.
|
||||||
|
|
||||||
|
<img class="shadow" src="/img/deployment/concepts/image01.png">
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🔜 👈 👥 💭 🔺 🖖 ⚖ **🛠️** & **📋**, ➡️ 😣 💬 🔃 🛠️.
|
||||||
|
|
||||||
|
## 🏃♂ 🔛 🕴
|
||||||
|
|
||||||
|
🌅 💼, 🕐❔ 👆 ✍ 🕸 🛠️, 👆 💚 ⚫️ **🕧 🏃♂**, ➡, 👈 👆 👩💻 💪 🕧 🔐 ⚫️. 👉 ↗️, 🚥 👆 ✔️ 🎯 🤔 ⚫️❔ 👆 💚 ⚫️ 🏃 🕴 🎯 ⚠, ✋️ 🌅 🕰 👆 💚 ⚫️ 🕧 🏃♂ & **💪**.
|
||||||
|
|
||||||
|
### 🛰 💽
|
||||||
|
|
||||||
|
🕐❔ 👆 ⚒ 🆙 🛰 💽 (☁ 💽, 🕹 🎰, ♒️.) 🙅 👜 👆 💪 🏃 Uvicorn (⚖️ 🎏) ❎, 🎏 🌌 👆 🕐❔ 🛠️ 🌐.
|
||||||
|
|
||||||
|
& ⚫️ 🔜 👷 & 🔜 ⚠ **⏮️ 🛠️**.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 🔗 💽 💸, **🏃♂ 🛠️** 🔜 🎲 ☠️.
|
||||||
|
|
||||||
|
& 🚥 💽 ⏏ (🖼 ⏮️ ℹ, ⚖️ 🛠️ ⚪️➡️ ☁ 🐕🦺) 👆 🎲 **🏆 🚫 👀 ⚫️**. & ↩️ 👈, 👆 🏆 🚫 💭 👈 👆 ✔️ ⏏ 🛠️ ❎. , 👆 🛠️ 🔜 🚧 ☠️. 👶
|
||||||
|
|
||||||
|
### 🏃 🔁 🔛 🕴
|
||||||
|
|
||||||
|
🏢, 👆 🔜 🎲 💚 💽 📋 (✅ Uvicorn) ▶️ 🔁 🔛 💽 🕴, & 🍵 💪 🙆 **🗿 🏥**, ✔️ 🛠️ 🕧 🏃 ⏮️ 👆 🛠️ (✅ Uvicorn 🏃♂ 👆 FastAPI 📱).
|
||||||
|
|
||||||
|
### 🎏 📋
|
||||||
|
|
||||||
|
🏆 👉, 👆 🔜 🛎 ✔️ **🎏 📋** 👈 🔜 ⚒ 💭 👆 🈸 🏃 🔛 🕴. & 📚 💼, ⚫️ 🔜 ⚒ 💭 🎏 🦲 ⚖️ 🈸 🏃, 🖼, 💽.
|
||||||
|
|
||||||
|
### 🖼 🧰 🏃 🕴
|
||||||
|
|
||||||
|
🖼 🧰 👈 💪 👉 👨🏭:
|
||||||
|
|
||||||
|
* ☁
|
||||||
|
* Kubernetes
|
||||||
|
* ☁ ✍
|
||||||
|
* ☁ 🐝 📳
|
||||||
|
* ✳
|
||||||
|
* 👨💻
|
||||||
|
* 🍵 🔘 ☁ 🐕🦺 🍕 👫 🐕🦺
|
||||||
|
* 🎏...
|
||||||
|
|
||||||
|
👤 🔜 🤝 👆 🌅 🧱 🖼 ⏭ 📃.
|
||||||
|
|
||||||
|
## ⏏
|
||||||
|
|
||||||
|
🎏 ⚒ 💭 👆 🈸 🏃 🔛 🕴, 👆 🎲 💚 ⚒ 💭 ⚫️ **⏏** ⏮️ ❌.
|
||||||
|
|
||||||
|
### 👥 ⚒ ❌
|
||||||
|
|
||||||
|
👥, 🗿, ⚒ **❌**, 🌐 🕰. 🖥 🌖 *🕧* ✔️ **🐛** 🕵♂ 🎏 🥉. 👶
|
||||||
|
|
||||||
|
& 👥 👩💻 🚧 📉 📟 👥 🔎 👈 🐛 & 👥 🛠️ 🆕 ⚒ (🎲 ❎ 🆕 🐛 💁♂️ 👶).
|
||||||
|
|
||||||
|
### 🤪 ❌ 🔁 🍵
|
||||||
|
|
||||||
|
🕐❔ 🏗 🕸 🔗 ⏮️ FastAPI, 🚥 📤 ❌ 👆 📟, FastAPI 🔜 🛎 🔌 ⚫️ 👁 📨 👈 ⏲ ❌. 🛡
|
||||||
|
|
||||||
|
👩💻 🔜 🤚 **5️⃣0️⃣0️⃣ 🔗 💽 ❌** 👈 📨, ✋️ 🈸 🔜 😣 👷 ⏭ 📨 ↩️ 💥 🍕.
|
||||||
|
|
||||||
|
### 🦏 ❌ - 💥
|
||||||
|
|
||||||
|
👐, 📤 5️⃣📆 💼 🌐❔ 👥 ✍ 📟 👈 **💥 🎂 🈸** ⚒ Uvicorn & 🐍 💥. 👶
|
||||||
|
|
||||||
|
& , 👆 🔜 🎲 🚫 💚 🈸 🚧 ☠️ ↩️ 📤 ❌ 1️⃣ 🥉, 👆 🎲 💚 ⚫️ **😣 🏃** 🌘 *➡ 🛠️* 👈 🚫 💔.
|
||||||
|
|
||||||
|
### ⏏ ⏮️ 💥
|
||||||
|
|
||||||
|
✋️ 👈 💼 ⏮️ 🤙 👎 ❌ 👈 💥 🏃♂ **🛠️**, 👆 🔜 💚 🔢 🦲 👈 🈚 **🔁** 🛠️, 🌘 👩❤👨 🕰...
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
...👐 🚥 🎂 🈸 **💥 ⏪** ⚫️ 🎲 🚫 ⚒ 🔑 🚧 🔁 ⚫️ ♾. ✋️ 📚 💼, 👆 🔜 🎲 👀 ⚫️ ⏮️ 🛠️, ⚖️ 🌘 ▶️️ ⏮️ 🛠️.
|
||||||
|
|
||||||
|
➡️ 🎯 🔛 👑 💼, 🌐❔ ⚫️ 💪 💥 🍕 🎯 💼 **🔮**, & ⚫️ ⚒ 🔑 ⏏ ⚫️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👆 🔜 🎲 💚 ✔️ 👜 🈚 🔁 👆 🈸 **🔢 🦲**, ↩️ 👈 ☝, 🎏 🈸 ⏮️ Uvicorn & 🐍 ⏪ 💥, 📤 🕳 🎏 📟 🎏 📱 👈 💪 🕳 🔃 ⚫️.
|
||||||
|
|
||||||
|
### 🖼 🧰 ⏏ 🔁
|
||||||
|
|
||||||
|
🏆 💼, 🎏 🧰 👈 ⚙️ **🏃 📋 🔛 🕴** ⚙️ 🍵 🏧 **⏏**.
|
||||||
|
|
||||||
|
🖼, 👉 💪 🍵:
|
||||||
|
|
||||||
|
* ☁
|
||||||
|
* Kubernetes
|
||||||
|
* ☁ ✍
|
||||||
|
* ☁ 🐝 📳
|
||||||
|
* ✳
|
||||||
|
* 👨💻
|
||||||
|
* 🍵 🔘 ☁ 🐕🦺 🍕 👫 🐕🦺
|
||||||
|
* 🎏...
|
||||||
|
|
||||||
|
## 🧬 - 🛠️ & 💾
|
||||||
|
|
||||||
|
⏮️ FastAPI 🈸, ⚙️ 💽 📋 💖 Uvicorn, 🏃♂ ⚫️ 🕐 **1️⃣ 🛠️** 💪 🍦 💗 👩💻 🔁.
|
||||||
|
|
||||||
|
✋️ 📚 💼, 👆 🔜 💚 🏃 📚 👨🏭 🛠️ 🎏 🕰.
|
||||||
|
|
||||||
|
### 💗 🛠️ - 👨🏭
|
||||||
|
|
||||||
|
🚥 👆 ✔️ 🌅 👩💻 🌘 ⚫️❔ 👁 🛠️ 💪 🍵 (🖼 🚥 🕹 🎰 🚫 💁♂️ 🦏) & 👆 ✔️ **💗 🐚** 💽 💽, ⤴️ 👆 💪 ✔️ **💗 🛠️** 🏃♂ ⏮️ 🎏 🈸 🎏 🕰, & 📎 🌐 📨 👪 👫.
|
||||||
|
|
||||||
|
🕐❔ 👆 🏃 **💗 🛠️** 🎏 🛠️ 📋, 👫 🛎 🤙 **👨🏭**.
|
||||||
|
|
||||||
|
### 👨🏭 🛠️ & ⛴
|
||||||
|
|
||||||
|
💭 ⚪️➡️ 🩺 [🔃 🇺🇸🔍](https.md){.internal-link target=_blank} 👈 🕴 1️⃣ 🛠️ 💪 👂 🔛 1️⃣ 🌀 ⛴ & 📢 📢 💽 ❓
|
||||||
|
|
||||||
|
👉 ☑.
|
||||||
|
|
||||||
|
, 💪 ✔️ **💗 🛠️** 🎏 🕰, 📤 ✔️ **👁 🛠️ 👂 🔛 ⛴** 👈 ⤴️ 📶 📻 🔠 👨🏭 🛠️ 🌌.
|
||||||
|
|
||||||
|
### 💾 📍 🛠️
|
||||||
|
|
||||||
|
🔜, 🕐❔ 📋 📐 👜 💾, 🖼, 🎰 🏫 🏷 🔢, ⚖️ 🎚 ⭕ 📁 🔢, 🌐 👈 **🍴 👄 💾 (💾)** 💽.
|
||||||
|
|
||||||
|
& 💗 🛠️ 🛎 **🚫 💰 🙆 💾**. 👉 ⛓ 👈 🔠 🏃 🛠️ ✔️ 🚮 👍 👜, 🔢, & 💾. & 🚥 👆 😩 ⭕ 💸 💾 👆 📟, **🔠 🛠️** 🔜 🍴 🌓 💸 💾.
|
||||||
|
|
||||||
|
### 💽 💾
|
||||||
|
|
||||||
|
🖼, 🚥 👆 📟 📐 🎰 🏫 🏷 ⏮️ **1️⃣ 💾 📐**, 🕐❔ 👆 🏃 1️⃣ 🛠️ ⏮️ 👆 🛠️, ⚫️ 🔜 🍴 🌘 1️⃣ 💾 💾. & 🚥 👆 ▶️ **4️⃣ 🛠️** (4️⃣ 👨🏭), 🔠 🔜 🍴 1️⃣ 💾 💾. 🌐, 👆 🛠️ 🔜 🍴 **4️⃣ 💾 💾**.
|
||||||
|
|
||||||
|
& 🚥 👆 🛰 💽 ⚖️ 🕹 🎰 🕴 ✔️ 3️⃣ 💾 💾, 🔄 📐 🌅 🌘 4️⃣ 💾 💾 🔜 🤕 ⚠. 👶
|
||||||
|
|
||||||
|
### 💗 🛠️ - 🖼
|
||||||
|
|
||||||
|
👉 🖼, 📤 **👨💼 🛠️** 👈 ▶️ & 🎛 2️⃣ **👨🏭 🛠️**.
|
||||||
|
|
||||||
|
👉 👨💼 🛠️ 🔜 🎲 1️⃣ 👂 🔛 **⛴** 📢. & ⚫️ 🔜 📶 🌐 📻 👨🏭 🛠️.
|
||||||
|
|
||||||
|
👈 👨🏭 🛠️ 🔜 🕐 🏃♂ 👆 🈸, 👫 🔜 🎭 👑 📊 📨 **📨** & 📨 **📨**, & 👫 🔜 📐 🕳 👆 🚮 🔢 💾.
|
||||||
|
|
||||||
|
<img src="/img/deployment/concepts/process-ram.drawio.svg">
|
||||||
|
|
||||||
|
& ↗️, 🎏 🎰 🔜 🎲 ✔️ **🎏 🛠️** 🏃 👍, ↖️ ⚪️➡️ 👆 🈸.
|
||||||
|
|
||||||
|
😌 ℹ 👈 🌐 **💽 ⚙️** 🔠 🛠️ 💪 **🪀** 📚 🤭 🕰, ✋️ **💾 (💾)** 🛎 🚧 🌖 ⚖️ 🌘 **⚖**.
|
||||||
|
|
||||||
|
🚥 👆 ✔️ 🛠️ 👈 🔨 ⭐ 💸 📊 🔠 🕰 & 👆 ✔️ 📚 👩💻, ⤴️ **💽 🛠️** 🔜 🎲 *⚖* (↩️ 🕧 🔜 🆙 & 🔽 🔜).
|
||||||
|
|
||||||
|
### 🖼 🧬 🧰 & 🎛
|
||||||
|
|
||||||
|
📤 💪 📚 🎯 🏆 👉, & 👤 🔜 💬 👆 🌅 🔃 🎯 🎛 ⏭ 📃, 🖼 🕐❔ 💬 🔃 ☁ & 📦.
|
||||||
|
|
||||||
|
👑 ⚛ 🤔 👈 📤 ✔️ **👁** 🦲 🚚 **⛴** **📢 📢**. & ⤴️ ⚫️ ✔️ ✔️ 🌌 **📶** 📻 🔁 **🛠️/👨🏭**.
|
||||||
|
|
||||||
|
📥 💪 🌀 & 🎛:
|
||||||
|
|
||||||
|
* **🐁** 🛠️ **Uvicorn 👨🏭**
|
||||||
|
* 🐁 🔜 **🛠️ 👨💼** 👂 🔛 **📢** & **⛴**, 🧬 🔜 ✔️ **💗 Uvicorn 👨🏭 🛠️**
|
||||||
|
* **Uvicorn** 🛠️ **Uvicorn 👨🏭**
|
||||||
|
* 1️⃣ Uvicorn **🛠️ 👨💼** 🔜 👂 🔛 **📢** & **⛴**, & ⚫️ 🔜 ▶️ **💗 Uvicorn 👨🏭 🛠️**
|
||||||
|
* **Kubernetes** & 🎏 📎 **📦 ⚙️**
|
||||||
|
* 🕳 **☁** 🧽 🔜 👂 🔛 **📢** & **⛴**. 🧬 🔜 ✔️ **💗 📦**, 🔠 ⏮️ **1️⃣ Uvicorn 🛠️** 🏃♂
|
||||||
|
* **☁ 🐕🦺** 👈 🍵 👉 👆
|
||||||
|
* ☁ 🐕🦺 🔜 🎲 **🍵 🧬 👆**. ⚫️ 🔜 🎲 ➡️ 👆 🔬 **🛠️ 🏃**, ⚖️ **📦 🖼** ⚙️, 🙆 💼, ⚫️ 🔜 🌅 🎲 **👁 Uvicorn 🛠️**, & ☁ 🐕🦺 🔜 🈚 🔁 ⚫️.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚫 😟 🚥 👫 🏬 🔃 **📦**, ☁, ⚖️ Kubernetes 🚫 ⚒ 📚 🔑.
|
||||||
|
|
||||||
|
👤 🔜 💬 👆 🌅 🔃 📦 🖼, ☁, Kubernetes, ♒️. 🔮 📃: [FastAPI 📦 - ☁](docker.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⏮️ 🔁 ⏭ ▶️
|
||||||
|
|
||||||
|
📤 📚 💼 🌐❔ 👆 💚 🎭 📶 **⏭ ▶️** 👆 🈸.
|
||||||
|
|
||||||
|
🖼, 👆 💪 💚 🏃 **💽 🛠️**.
|
||||||
|
|
||||||
|
✋️ 🌅 💼, 👆 🔜 💚 🎭 👉 🔁 🕴 **🕐**.
|
||||||
|
|
||||||
|
, 👆 🔜 💚 ✔️ **👁 🛠️** 🎭 👈 **⏮️ 🔁**, ⏭ ▶️ 🈸.
|
||||||
|
|
||||||
|
& 👆 🔜 ✔️ ⚒ 💭 👈 ⚫️ 👁 🛠️ 🏃 👈 ⏮️ 🔁 ** 🚥 ⏮️, 👆 ▶️ **💗 🛠️** (💗 👨🏭) 🈸 ⚫️. 🚥 👈 🔁 🏃 **💗 🛠️**, 👫 🔜 **❎** 👷 🏃♂ ⚫️ 🔛 **🔗**, & 🚥 📶 🕳 💎 💖 💽 🛠️, 👫 💪 🤕 ⚔ ⏮️ 🔠 🎏.
|
||||||
|
|
||||||
|
↗️, 📤 💼 🌐❔ 📤 🙅♂ ⚠ 🏃 ⏮️ 🔁 💗 🕰, 👈 💼, ⚫️ 📚 ⏩ 🍵.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
, ✔️ 🤯 👈 ⚓️ 🔛 👆 🖥, 💼 👆 **5️⃣📆 🚫 💪 🙆 ⏮️ 🔁** ⏭ ▶️ 👆 🈸.
|
||||||
|
|
||||||
|
👈 💼, 👆 🚫🔜 ✔️ 😟 🔃 🙆 👉. 🤷
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🖼 ⏮️ 🔁 🎛
|
||||||
|
|
||||||
|
👉 🔜 **🪀 🙇** 🔛 🌌 👆 **🛠️ 👆 ⚙️**, & ⚫️ 🔜 🎲 🔗 🌌 👆 ▶️ 📋, 🚚 ⏏, ♒️.
|
||||||
|
|
||||||
|
📥 💪 💭:
|
||||||
|
|
||||||
|
* "🕑 📦" Kubernetes 👈 🏃 ⏭ 👆 📱 📦
|
||||||
|
* 🎉 ✍ 👈 🏃 ⏮️ 🔁 & ⤴️ ▶️ 👆 🈸
|
||||||
|
* 👆 🔜 💪 🌌 ▶️/⏏ *👈* 🎉 ✍, 🔍 ❌, ♒️.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👤 🔜 🤝 👆 🌅 🧱 🖼 🔨 👉 ⏮️ 📦 🔮 📃: [FastAPI 📦 - ☁](docker.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ℹ 🛠️
|
||||||
|
|
||||||
|
👆 💽(Ⓜ) () **ℹ**, 👆 💪 🍴 ⚖️ **⚙️**, ⏮️ 👆 📋, 📊 🕰 🔛 💽, & 💾 💾 💪.
|
||||||
|
|
||||||
|
❔ 🌅 ⚙️ ℹ 👆 💚 😩/♻ ❓ ⚫️ 💪 ⏩ 💭 "🚫 🌅", ✋️ 🌌, 👆 🔜 🎲 💚 🍴 **🌅 💪 🍵 💥**.
|
||||||
|
|
||||||
|
🚥 👆 💸 3️⃣ 💽 ✋️ 👆 ⚙️ 🕴 🐥 🍖 👫 💾 & 💽, 👆 🎲 **🗑 💸** 👶, & 🎲 **🗑 💽 🔦 🏋️** 👶, ♒️.
|
||||||
|
|
||||||
|
👈 💼, ⚫️ 💪 👻 ✔️ 🕴 2️⃣ 💽 & ⚙️ ↕ 🌐 👫 ℹ (💽, 💾, 💾, 🕸 💿, ♒️).
|
||||||
|
|
||||||
|
🔛 🎏 ✋, 🚥 👆 ✔️ 2️⃣ 💽 & 👆 ⚙️ **1️⃣0️⃣0️⃣ 💯 👫 💽 & 💾**, ☝ 1️⃣ 🛠️ 🔜 💭 🌅 💾, & 💽 🔜 ✔️ ⚙️ 💾 "💾" (❔ 💪 💯 🕰 🐌), ⚖️ **💥**. ⚖️ 1️⃣ 🛠️ 💪 💪 📊 & 🔜 ✔️ ⌛ ⏭ 💽 🆓 🔄.
|
||||||
|
|
||||||
|
👉 💼, ⚫️ 🔜 👍 🤚 **1️⃣ ➕ 💽** & 🏃 🛠️ 🔛 ⚫️ 👈 👫 🌐 ✔️ **🥃 💾 & 💽 🕰**.
|
||||||
|
|
||||||
|
📤 🤞 👈 🤔 👆 ✔️ **🌵** ⚙️ 👆 🛠️. 🎲 ⚫️ 🚶 🦠, ⚖️ 🎲 🎏 🐕🦺 ⚖️ 🤖 ▶️ ⚙️ ⚫️. & 👆 💪 💚 ✔️ ➕ ℹ 🔒 👈 💼.
|
||||||
|
|
||||||
|
👆 💪 🚮 **❌ 🔢** 🎯, 🖼, 🕳 **🖖 5️⃣0️⃣ 💯 9️⃣0️⃣ 💯** ℹ 🛠️. ☝ 👈 📚 🎲 👑 👜 👆 🔜 💚 ⚖ & ⚙️ ⚒ 👆 🛠️.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🙅 🧰 💖 `htop` 👀 💽 & 💾 ⚙️ 👆 💽 ⚖️ 💸 ⚙️ 🔠 🛠️. ⚖️ 👆 💪 ⚙️ 🌖 🏗 ⚖ 🧰, ❔ 5️⃣📆 📎 🤭 💽, ♒️.
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
👆 ✔️ 👂 📥 👑 🔧 👈 👆 🔜 🎲 💪 ✔️ 🤯 🕐❔ 🤔 ❔ 🛠️ 👆 🈸:
|
||||||
|
|
||||||
|
* 💂♂ - 🇺🇸🔍
|
||||||
|
* 🏃♂ 🔛 🕴
|
||||||
|
* ⏏
|
||||||
|
* 🧬 (🔢 🛠️ 🏃)
|
||||||
|
* 💾
|
||||||
|
* ⏮️ 🔁 ⏭ ▶️
|
||||||
|
|
||||||
|
🤔 👉 💭 & ❔ ✔ 👫 🔜 🤝 👆 🤔 💪 ✊ 🙆 🚫 🕐❔ 🛠️ & 🛠️ 👆 🛠️. 👶
|
||||||
|
|
||||||
|
⏭ 📄, 👤 🔜 🤝 👆 🌅 🧱 🖼 💪 🎛 👆 💪 ⏩. 👶
|
||||||
|
|
@ -0,0 +1,731 @@
|
||||||
|
# FastAPI 📦 - ☁
|
||||||
|
|
||||||
|
🕐❔ 🛠️ FastAPI 🈸 ⚠ 🎯 🏗 **💾 📦 🖼**. ⚫️ 🛎 🔨 ⚙️ <a href="https://www.docker.com/" class="external-link" target="_blank">**☁**</a>. 👆 💪 ⤴️ 🛠️ 👈 📦 🖼 1️⃣ 👩❤👨 💪 🌌.
|
||||||
|
|
||||||
|
⚙️ 💾 📦 ✔️ 📚 📈 ✅ **💂♂**, **🔬**, **🦁**, & 🎏.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🏃 & ⏪ 💭 👉 💩 ❓ 🦘 [`Dockerfile` 🔛 👶](#fastapi).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>📁 🎮 👶</summary>
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
FROM python:3.9
|
||||||
|
|
||||||
|
WORKDIR /code
|
||||||
|
|
||||||
|
COPY ./requirements.txt /code/requirements.txt
|
||||||
|
|
||||||
|
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
|
||||||
|
|
||||||
|
COPY ./app /code/app
|
||||||
|
|
||||||
|
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
|
||||||
|
|
||||||
|
# If running behind a proxy like Nginx or Traefik add --proxy-headers
|
||||||
|
# CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80", "--proxy-headers"]
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## ⚫️❔ 📦
|
||||||
|
|
||||||
|
📦 (✴️ 💾 📦) 📶 **💿** 🌌 📦 🈸 ✅ 🌐 👫 🔗 & 💪 📁 ⏪ 🚧 👫 ❎ ⚪️➡️ 🎏 📦 (🎏 🈸 ⚖️ 🦲) 🎏 ⚙️.
|
||||||
|
|
||||||
|
💾 📦 🏃 ⚙️ 🎏 💾 💾 🦠 (🎰, 🕹 🎰, ☁ 💽, ♒️). 👉 ⛓ 👈 👫 📶 💿 (🔬 🌕 🕹 🎰 👍 🎂 🏃♂ ⚙️).
|
||||||
|
|
||||||
|
👉 🌌, 📦 🍴 **🐥 ℹ**, 💸 ⭐ 🏃♂ 🛠️ 🔗 (🕹 🎰 🔜 🍴 🌅 🌅).
|
||||||
|
|
||||||
|
📦 ✔️ 👫 👍 **❎** 🏃♂ 🛠️ (🛎 1️⃣ 🛠️), 📁 ⚙️, & 🕸, 🔬 🛠️, 💂♂, 🛠️, ♒️.
|
||||||
|
|
||||||
|
## ⚫️❔ 📦 🖼
|
||||||
|
|
||||||
|
**📦** 🏃 ⚪️➡️ **📦 🖼**.
|
||||||
|
|
||||||
|
📦 🖼 **🎻** ⏬ 🌐 📁, 🌐 🔢, & 🔢 📋/📋 👈 🔜 🎁 📦. **🎻** 📥 ⛓ 👈 📦 **🖼** 🚫 🏃, ⚫️ 🚫 ➖ 🛠️, ⚫️ 🕴 📦 📁 & 🗃.
|
||||||
|
|
||||||
|
🔅 "**📦 🖼**" 👈 🏪 🎻 🎚,"**📦**" 🛎 🔗 🏃♂ 👐, 👜 👈 ➖ **🛠️**.
|
||||||
|
|
||||||
|
🕐❔ **📦** ▶️ & 🏃♂ (▶️ ⚪️➡️ **📦 🖼**) ⚫️ 💪 ✍ ⚖️ 🔀 📁, 🌐 🔢, ♒️. 👈 🔀 🔜 🔀 🕴 👈 📦, ✋️ 🔜 🚫 😣 👽 📦 🖼 (🔜 🚫 🖊 💾).
|
||||||
|
|
||||||
|
📦 🖼 ⭐ **📋** 📁 & 🎚, ✅ `python` & 📁 `main.py`.
|
||||||
|
|
||||||
|
& **📦** ⚫️ (🔅 **📦 🖼**) ☑ 🏃 👐 🖼, ⭐ **🛠️**. 👐, 📦 🏃 🕴 🕐❔ ⚫️ ✔️ **🛠️ 🏃** (& 🛎 ⚫️ 🕴 👁 🛠️). 📦 ⛔️ 🕐❔ 📤 🙅♂ 🛠️ 🏃 ⚫️.
|
||||||
|
|
||||||
|
## 📦 🖼
|
||||||
|
|
||||||
|
☁ ✔️ 1️⃣ 👑 🧰 ✍ & 🛠️ **📦 🖼** & **📦**.
|
||||||
|
|
||||||
|
& 📤 📢 <a href="https://hub.docker.com/" class="external-link" target="_blank">☁ 🎡</a> ⏮️ 🏤-⚒ **🛂 📦 🖼** 📚 🧰, 🌐, 💽, & 🈸.
|
||||||
|
|
||||||
|
🖼, 📤 🛂 <a href="https://hub.docker.com/_/python" class="external-link" target="_blank">🐍 🖼</a>.
|
||||||
|
|
||||||
|
& 📤 📚 🎏 🖼 🎏 👜 💖 💽, 🖼:
|
||||||
|
|
||||||
|
* <a href="https://hub.docker.com/_/postgres" class="external-link" target="_blank">✳</a>
|
||||||
|
* <a href="https://hub.docker.com/_/mysql" class="external-link" target="_blank">✳</a>
|
||||||
|
* <a href="https://hub.docker.com/_/mongo" class="external-link" target="_blank">✳</a>
|
||||||
|
* <a href="https://hub.docker.com/_/redis" class="external-link" target="_blank">✳</a>, ♒️.
|
||||||
|
|
||||||
|
⚙️ 🏤-⚒ 📦 🖼 ⚫️ 📶 ⏩ **🌀** & ⚙️ 🎏 🧰. 🖼, 🔄 👅 🆕 💽. 🌅 💼, 👆 💪 ⚙️ **🛂 🖼**, & 🔗 👫 ⏮️ 🌐 🔢.
|
||||||
|
|
||||||
|
👈 🌌, 📚 💼 👆 💪 💡 🔃 📦 & ☁ & 🏤-⚙️ 👈 💡 ⏮️ 📚 🎏 🧰 & 🦲.
|
||||||
|
|
||||||
|
, 👆 🔜 🏃 **💗 📦** ⏮️ 🎏 👜, 💖 💽, 🐍 🈸, 🕸 💽 ⏮️ 😥 🕸 🈸, & 🔗 👫 👯♂️ 📨 👫 🔗 🕸.
|
||||||
|
|
||||||
|
🌐 📦 🧾 ⚙️ (💖 ☁ ⚖️ Kubernetes) ✔️ 👫 🕸 ⚒ 🛠️ 🔘 👫.
|
||||||
|
|
||||||
|
## 📦 & 🛠️
|
||||||
|
|
||||||
|
**📦 🖼** 🛎 🔌 🚮 🗃 🔢 📋 ⚖️ 📋 👈 🔜 🏃 🕐❔ **📦** ▶️ & 🔢 🚶♀️ 👈 📋. 📶 🎏 ⚫️❔ 🔜 🚥 ⚫️ 📋 ⏸.
|
||||||
|
|
||||||
|
🕐❔ **📦** ▶️, ⚫️ 🔜 🏃 👈 📋/📋 (👐 👆 💪 🔐 ⚫️ & ⚒ ⚫️ 🏃 🎏 📋/📋).
|
||||||
|
|
||||||
|
📦 🏃 📏 **👑 🛠️** (📋 ⚖️ 📋) 🏃.
|
||||||
|
|
||||||
|
📦 🛎 ✔️ **👁 🛠️**, ✋️ ⚫️ 💪 ▶️ ✳ ⚪️➡️ 👑 🛠️, & 👈 🌌 👆 🔜 ✔️ **💗 🛠️** 🎏 📦.
|
||||||
|
|
||||||
|
✋️ ⚫️ 🚫 💪 ✔️ 🏃♂ 📦 🍵 **🌘 1️⃣ 🏃♂ 🛠️**. 🚥 👑 🛠️ ⛔️, 📦 ⛔️.
|
||||||
|
|
||||||
|
## 🏗 ☁ 🖼 FastAPI
|
||||||
|
|
||||||
|
🆗, ➡️ 🏗 🕳 🔜 ❗ 👶
|
||||||
|
|
||||||
|
👤 🔜 🎦 👆 ❔ 🏗 **☁ 🖼** FastAPI **⚪️➡️ 🖌**, ⚓️ 🔛 **🛂 🐍** 🖼.
|
||||||
|
|
||||||
|
👉 ⚫️❔ 👆 🔜 💚 **🏆 💼**, 🖼:
|
||||||
|
|
||||||
|
* ⚙️ **Kubernetes** ⚖️ 🎏 🧰
|
||||||
|
* 🕐❔ 🏃♂ 🔛 **🍓 👲**
|
||||||
|
* ⚙️ ☁ 🐕🦺 👈 🔜 🏃 📦 🖼 👆, ♒️.
|
||||||
|
|
||||||
|
### 📦 📄
|
||||||
|
|
||||||
|
👆 🔜 🛎 ✔️ **📦 📄** 👆 🈸 📁.
|
||||||
|
|
||||||
|
⚫️ 🔜 🪀 ✴️ 🔛 🧰 👆 ⚙️ **❎** 👈 📄.
|
||||||
|
|
||||||
|
🌅 ⚠ 🌌 ⚫️ ✔️ 📁 `requirements.txt` ⏮️ 📦 📛 & 👫 ⏬, 1️⃣ 📍 ⏸.
|
||||||
|
|
||||||
|
👆 🔜 ↗️ ⚙️ 🎏 💭 👆 ✍ [🔃 FastAPI ⏬](versions.md){.internal-link target=_blank} ⚒ ↔ ⏬.
|
||||||
|
|
||||||
|
🖼, 👆 `requirements.txt` 💪 👀 💖:
|
||||||
|
|
||||||
|
```
|
||||||
|
fastapi>=0.68.0,<0.69.0
|
||||||
|
pydantic>=1.8.0,<2.0.0
|
||||||
|
uvicorn>=0.15.0,<0.16.0
|
||||||
|
```
|
||||||
|
|
||||||
|
& 👆 🔜 🛎 ❎ 👈 📦 🔗 ⏮️ `pip`, 🖼:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install -r requirements.txt
|
||||||
|
---> 100%
|
||||||
|
Successfully installed fastapi pydantic uvicorn
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
📤 🎏 📁 & 🧰 🔬 & ❎ 📦 🔗.
|
||||||
|
|
||||||
|
👤 🔜 🎦 👆 🖼 ⚙️ 🎶 ⏪ 📄 🔛. 👶
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ✍ **FastAPI** 📟
|
||||||
|
|
||||||
|
* ✍ `app` 📁 & ⛔ ⚫️.
|
||||||
|
* ✍ 🛁 📁 `__init__.py`.
|
||||||
|
* ✍ `main.py` 📁 ⏮️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from typing import Union
|
||||||
|
|
||||||
|
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: Union[str, None] = None):
|
||||||
|
return {"item_id": item_id, "q": q}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 📁
|
||||||
|
|
||||||
|
🔜 🎏 🏗 📁 ✍ 📁 `Dockerfile` ⏮️:
|
||||||
|
|
||||||
|
```{ .dockerfile .annotate }
|
||||||
|
# (1)
|
||||||
|
FROM python:3.9
|
||||||
|
|
||||||
|
# (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 ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
|
||||||
|
```
|
||||||
|
|
||||||
|
1️⃣. ▶️ ⚪️➡️ 🛂 🐍 🧢 🖼.
|
||||||
|
|
||||||
|
2️⃣. ⚒ ⏮️ 👷 📁 `/code`.
|
||||||
|
|
||||||
|
👉 🌐❔ 👥 🔜 🚮 `requirements.txt` 📁 & `app` 📁.
|
||||||
|
|
||||||
|
3️⃣. 📁 📁 ⏮️ 📄 `/code` 📁.
|
||||||
|
|
||||||
|
📁 **🕴** 📁 ⏮️ 📄 🥇, 🚫 🎂 📟.
|
||||||
|
|
||||||
|
👉 📁 **🚫 🔀 🛎**, ☁ 🔜 🔍 ⚫️ & ⚙️ **💾** 👉 🔁, 🛠️ 💾 ⏭ 🔁 💁♂️.
|
||||||
|
|
||||||
|
4️⃣. ❎ 📦 🔗 📄 📁.
|
||||||
|
|
||||||
|
`--no-cache-dir` 🎛 💬 `pip` 🚫 🖊 ⏬ 📦 🌐, 👈 🕴 🚥 `pip` 🔜 🏃 🔄 ❎ 🎏 📦, ✋️ 👈 🚫 💼 🕐❔ 👷 ⏮️ 📦.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
`--no-cache-dir` 🕴 🔗 `pip`, ⚫️ ✔️ 🕳 ⏮️ ☁ ⚖️ 📦.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
`--upgrade` 🎛 💬 `pip` ♻ 📦 🚥 👫 ⏪ ❎.
|
||||||
|
|
||||||
|
↩️ ⏮️ 🔁 🖨 📁 💪 🔍 **☁ 💾**, 👉 🔁 🔜 **⚙️ ☁ 💾** 🕐❔ 💪.
|
||||||
|
|
||||||
|
⚙️ 💾 👉 🔁 🔜 **🖊** 👆 📚 **🕰** 🕐❔ 🏗 🖼 🔄 & 🔄 ⏮️ 🛠️, ↩️ **⏬ & ❎** 🌐 🔗 **🔠 🕰**.
|
||||||
|
|
||||||
|
5️⃣. 📁 `./app` 📁 🔘 `/code` 📁.
|
||||||
|
|
||||||
|
👉 ✔️ 🌐 📟 ❔ ⚫️❔ **🔀 🌅 🛎** ☁ **💾** 🏆 🚫 ⚙️ 👉 ⚖️ 🙆 **📄 🔁** 💪.
|
||||||
|
|
||||||
|
, ⚫️ ⚠ 🚮 👉 **🏘 🔚** `Dockerfile`, 🔬 📦 🖼 🏗 🕰.
|
||||||
|
|
||||||
|
6️⃣. ⚒ **📋** 🏃 `uvicorn` 💽.
|
||||||
|
|
||||||
|
`CMD` ✊ 📇 🎻, 🔠 👫 🎻 ⚫️❔ 👆 🔜 🆎 📋 ⏸ 👽 🚀.
|
||||||
|
|
||||||
|
👉 📋 🔜 🏃 ⚪️➡️ **⏮️ 👷 📁**, 🎏 `/code` 📁 👆 ⚒ 🔛 ⏮️ `WORKDIR /code`.
|
||||||
|
|
||||||
|
↩️ 📋 🔜 ▶️ `/code` & 🔘 ⚫️ 📁 `./app` ⏮️ 👆 📟, **Uvicorn** 🔜 💪 👀 & **🗄** `app` ⚪️➡️ `app.main`.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
📄 ⚫️❔ 🔠 ⏸ 🔨 🖊 🔠 🔢 💭 📟. 👶
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👆 🔜 🔜 ✔️ 📁 📊 💖:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── app
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ └── main.py
|
||||||
|
├── Dockerfile
|
||||||
|
└── requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
#### ⛅ 🤝 ❎ 🗳
|
||||||
|
|
||||||
|
🚥 👆 🏃♂ 👆 📦 ⛅ 🤝 ❎ 🗳 (📐 ⚙) 💖 👌 ⚖️ Traefik, 🚮 🎛 `--proxy-headers`, 👉 🔜 💬 Uvicorn 💙 🎚 📨 👈 🗳 💬 ⚫️ 👈 🈸 🏃 ⛅ 🇺🇸🔍, ♒️.
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
CMD ["uvicorn", "app.main:app", "--proxy-headers", "--host", "0.0.0.0", "--port", "80"]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### ☁ 💾
|
||||||
|
|
||||||
|
📤 ⚠ 🎱 👉 `Dockerfile`, 👥 🥇 📁 **📁 ⏮️ 🔗 😞**, 🚫 🎂 📟. ➡️ 👤 💬 👆 ⚫️❔ 👈.
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
COPY ./requirements.txt /code/requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
☁ & 🎏 🧰 **🏗** 👉 📦 🖼 **🔁**, 🚮 **1️⃣ 🧽 🔛 🔝 🎏**, ▶️ ⚪️➡️ 🔝 `Dockerfile` & ❎ 🙆 📁 ✍ 🔠 👩🌾 `Dockerfile`.
|
||||||
|
|
||||||
|
☁ & 🎏 🧰 ⚙️ **🔗 💾** 🕐❔ 🏗 🖼, 🚥 📁 🚫 🔀 ↩️ 🏁 🕰 🏗 📦 🖼, ⤴️ ⚫️ 🔜 **🏤-⚙️ 🎏 🧽** ✍ 🏁 🕰, ↩️ 🖨 📁 🔄 & 🏗 🆕 🧽 ⚪️➡️ 🖌.
|
||||||
|
|
||||||
|
❎ 📁 📁 🚫 🎯 📉 👜 💁♂️ 🌅, ✋️ ↩️ ⚫️ ⚙️ 💾 👈 🔁, ⚫️ 💪 **⚙️ 💾 ⏭ 🔁**. 🖼, ⚫️ 💪 ⚙️ 💾 👩🌾 👈 ❎ 🔗 ⏮️:
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
📁 ⏮️ 📦 📄 **🏆 🚫 🔀 🛎**. , 🖨 🕴 👈 📁, ☁ 🔜 💪 **⚙️ 💾** 👈 🔁.
|
||||||
|
|
||||||
|
& ⤴️, ☁ 🔜 💪 **⚙️ 💾 ⏭ 🔁** 👈 ⏬ & ❎ 👈 🔗. & 📥 🌐❔ 👥 **🖊 📚 🕰**. 👶 ...& ❎ 😩 ⌛. 👶 👶
|
||||||
|
|
||||||
|
⏬ & ❎ 📦 🔗 **💪 ✊ ⏲**, ✋️ ⚙️ **💾** 🔜 **✊ 🥈** 🌅.
|
||||||
|
|
||||||
|
& 👆 🔜 🏗 📦 🖼 🔄 & 🔄 ⏮️ 🛠️ ✅ 👈 👆 📟 🔀 👷, 📤 📚 📈 🕰 👉 🔜 🖊.
|
||||||
|
|
||||||
|
⤴️, 🏘 🔚 `Dockerfile`, 👥 📁 🌐 📟. 👉 ⚫️❔ **🔀 🏆 🛎**, 👥 🚮 ⚫️ 🏘 🔚, ↩️ 🌖 🕧, 🕳 ⏮️ 👉 🔁 🔜 🚫 💪 ⚙️ 💾.
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
COPY ./app /code/app
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🏗 ☁ 🖼
|
||||||
|
|
||||||
|
🔜 👈 🌐 📁 🥉, ➡️ 🏗 📦 🖼.
|
||||||
|
|
||||||
|
* 🚶 🏗 📁 (🌐❔ 👆 `Dockerfile` , ⚗ 👆 `app` 📁).
|
||||||
|
* 🏗 👆 FastAPI 🖼:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker build -t myimage .
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 `.` 🔚, ⚫️ 🌓 `./`, ⚫️ 💬 ☁ 📁 ⚙️ 🏗 📦 🖼.
|
||||||
|
|
||||||
|
👉 💼, ⚫️ 🎏 ⏮️ 📁 (`.`).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ▶️ ☁ 📦
|
||||||
|
|
||||||
|
* 🏃 📦 ⚓️ 🔛 👆 🖼:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ docker run -d --name mycontainer -p 80:80 myimage
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## ✅ ⚫️
|
||||||
|
|
||||||
|
👆 🔜 💪 ✅ ⚫️ 👆 ☁ 📦 📛, 🖼: <a href="http://192.168.99.100/items/5?q=somequery" class="external-link" target="_blank">http://192.168.99.100/items/5?q=somequery</a> ⚖️ <a href="http://127.0.0.1/items/5?q=somequery" class="external-link" target="_blank">http://127.0.0.1/items/5?q=somequery</a> (⚖️ 🌓, ⚙️ 👆 ☁ 🦠).
|
||||||
|
|
||||||
|
👆 🔜 👀 🕳 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{"item_id": 5, "q": "somequery"}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎓 🛠️ 🩺
|
||||||
|
|
||||||
|
🔜 👆 💪 🚶 <a href="http://192.168.99.100/docs" class="external-link" target="_blank">http://192.168.99.100/docs</a> ⚖️ <a href="http://127.0.0.1/docs" class="external-link" target="_blank">http://127.0.0.1/docs</a> (⚖️ 🌓, ⚙️ 👆 ☁ 🦠).
|
||||||
|
|
||||||
|
👆 🔜 👀 🏧 🎓 🛠️ 🧾 (🚚 <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">🦁 🎚</a>):
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 🎛 🛠️ 🩺
|
||||||
|
|
||||||
|
& 👆 💪 🚶 <a href="http://192.168.99.100/redoc" class="external-link" target="_blank">http://192.168.99.100/redoc</a> ⚖️ <a href="http://127.0.0.1/redoc" class="external-link" target="_blank">http://127.0.0.1/redoc</a> (⚖️ 🌓, ⚙️ 👆 ☁ 🦠).
|
||||||
|
|
||||||
|
👆 🔜 👀 🎛 🏧 🧾 (🚚 <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">📄</a>):
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 🏗 ☁ 🖼 ⏮️ 👁-📁 FastAPI
|
||||||
|
|
||||||
|
🚥 👆 FastAPI 👁 📁, 🖼, `main.py` 🍵 `./app` 📁, 👆 📁 📊 💪 👀 💖 👉:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── Dockerfile
|
||||||
|
├── main.py
|
||||||
|
└── requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
⤴️ 👆 🔜 ✔️ 🔀 🔗 ➡ 📁 📁 🔘 `Dockerfile`:
|
||||||
|
|
||||||
|
```{ .dockerfile .annotate hl_lines="10 13" }
|
||||||
|
FROM python:3.9
|
||||||
|
|
||||||
|
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 ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
|
||||||
|
```
|
||||||
|
|
||||||
|
1️⃣. 📁 `main.py` 📁 `/code` 📁 🔗 (🍵 🙆 `./app` 📁).
|
||||||
|
|
||||||
|
2️⃣. 🏃 Uvicorn & 💬 ⚫️ 🗄 `app` 🎚 ⚪️➡️ `main` (↩️ 🏭 ⚪️➡️ `app.main`).
|
||||||
|
|
||||||
|
⤴️ 🔆 Uvicorn 📋 ⚙️ 🆕 🕹 `main` ↩️ `app.main` 🗄 FastAPI 🎚 `app`.
|
||||||
|
|
||||||
|
## 🛠️ 🔧
|
||||||
|
|
||||||
|
➡️ 💬 🔄 🔃 🎏 [🛠️ 🔧](concepts.md){.internal-link target=_blank} ⚖ 📦.
|
||||||
|
|
||||||
|
📦 ✴️ 🧰 📉 🛠️ **🏗 & 🛠️** 🈸, ✋️ 👫 🚫 🛠️ 🎯 🎯 🍵 👉 **🛠️ 🔧**, & 📤 📚 💪 🎛.
|
||||||
|
|
||||||
|
**👍 📰** 👈 ⏮️ 🔠 🎏 🎛 📤 🌌 📔 🌐 🛠️ 🔧. 👶
|
||||||
|
|
||||||
|
➡️ 📄 👉 **🛠️ 🔧** ⚖ 📦:
|
||||||
|
|
||||||
|
* 🇺🇸🔍
|
||||||
|
* 🏃♂ 🔛 🕴
|
||||||
|
* ⏏
|
||||||
|
* 🧬 (🔢 🛠️ 🏃)
|
||||||
|
* 💾
|
||||||
|
* ⏮️ 🔁 ⏭ ▶️
|
||||||
|
|
||||||
|
## 🇺🇸🔍
|
||||||
|
|
||||||
|
🚥 👥 🎯 🔛 **📦 🖼** FastAPI 🈸 (& ⏪ 🏃♂ **📦**), 🇺🇸🔍 🛎 🔜 🍵 **🗜** ➕1️⃣ 🧰.
|
||||||
|
|
||||||
|
⚫️ 💪 ➕1️⃣ 📦, 🖼 ⏮️ <a href="https://traefik.io/" class="external-link" target="_blank">Traefik</a>, 🚚 **🇺🇸🔍** & **🏧** 🛠️ **📄**.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
Traefik ✔️ 🛠️ ⏮️ ☁, Kubernetes, & 🎏, ⚫️ 📶 ⏩ ⚒ 🆙 & 🔗 🇺🇸🔍 👆 📦 ⏮️ ⚫️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👐, 🇺🇸🔍 💪 🍵 ☁ 🐕🦺 1️⃣ 👫 🐕🦺 (⏪ 🏃 🈸 📦).
|
||||||
|
|
||||||
|
## 🏃♂ 🔛 🕴 & ⏏
|
||||||
|
|
||||||
|
📤 🛎 ➕1️⃣ 🧰 🈚 **▶️ & 🏃♂** 👆 📦.
|
||||||
|
|
||||||
|
⚫️ 💪 **☁** 🔗, **☁ ✍**, **Kubernetes**, **☁ 🐕🦺**, ♒️.
|
||||||
|
|
||||||
|
🌅 (⚖️ 🌐) 💼, 📤 🙅 🎛 🛠️ 🏃 📦 🔛 🕴 & 🛠️ ⏏ 🔛 ❌. 🖼, ☁, ⚫️ 📋 ⏸ 🎛 `--restart`.
|
||||||
|
|
||||||
|
🍵 ⚙️ 📦, ⚒ 🈸 🏃 🔛 🕴 & ⏮️ ⏏ 💪 ⚠ & ⚠. ✋️ 🕐❔ **👷 ⏮️ 📦** 🌅 💼 👈 🛠️ 🔌 🔢. 👶
|
||||||
|
|
||||||
|
## 🧬 - 🔢 🛠️
|
||||||
|
|
||||||
|
🚥 👆 ✔️ <abbr title="A group of machines that are configured to be connected and work together in some way.">🌑</abbr> 🎰 ⏮️ **☁**, ☁ 🐝 📳, 🖖, ⚖️ ➕1️⃣ 🎏 🏗 ⚙️ 🛠️ 📎 📦 🔛 💗 🎰, ⤴️ 👆 🔜 🎲 💚 **🍵 🧬** **🌑 🎚** ↩️ ⚙️ **🛠️ 👨💼** (💖 🐁 ⏮️ 👨🏭) 🔠 📦.
|
||||||
|
|
||||||
|
1️⃣ 📚 📎 📦 🧾 ⚙️ 💖 Kubernetes 🛎 ✔️ 🛠️ 🌌 🚚 **🧬 📦** ⏪ 🔗 **📐 ⚖** 📨 📨. 🌐 **🌑 🎚**.
|
||||||
|
|
||||||
|
📚 💼, 👆 🔜 🎲 💚 🏗 **☁ 🖼 ⚪️➡️ 🖌** [🔬 🔛](#_6), ❎ 👆 🔗, & 🏃♂ **👁 Uvicorn 🛠️** ↩️ 🏃♂ 🕳 💖 🐁 ⏮️ Uvicorn 👨🏭.
|
||||||
|
|
||||||
|
### 📐 ⚙
|
||||||
|
|
||||||
|
🕐❔ ⚙️ 📦, 👆 🔜 🛎 ✔️ 🦲 **👂 🔛 👑 ⛴**. ⚫️ 💪 🎲 ➕1️⃣ 📦 👈 **🤝 ❎ 🗳** 🍵 **🇺🇸🔍** ⚖️ 🎏 🧰.
|
||||||
|
|
||||||
|
👉 🦲 🔜 ✊ **📐** 📨 & 📎 👈 👪 👨🏭 (🤞) **⚖** 🌌, ⚫️ 🛎 🤙 **📐 ⚙**.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🎏 **🤝 ❎ 🗳** 🦲 ⚙️ 🇺🇸🔍 🔜 🎲 **📐 ⚙**.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
& 🕐❔ 👷 ⏮️ 📦, 🎏 ⚙️ 👆 ⚙️ ▶️ & 🛠️ 👫 🔜 ⏪ ✔️ 🔗 🧰 📶 **🕸 📻** (✅ 🇺🇸🔍 📨) ⚪️➡️ 👈 **📐 ⚙** (👈 💪 **🤝 ❎ 🗳**) 📦(Ⓜ) ⏮️ 👆 📱.
|
||||||
|
|
||||||
|
### 1️⃣ 📐 ⚙ - 💗 👨🏭 📦
|
||||||
|
|
||||||
|
🕐❔ 👷 ⏮️ **Kubernetes** ⚖️ 🎏 📎 📦 🧾 ⚙️, ⚙️ 👫 🔗 🕸 🛠️ 🔜 ✔ 👁 **📐 ⚙** 👈 👂 🔛 👑 **⛴** 📶 📻 (📨) 🎲 **💗 📦** 🏃 👆 📱.
|
||||||
|
|
||||||
|
🔠 👫 📦 🏃♂ 👆 📱 🔜 🛎 ✔️ **1️⃣ 🛠️** (✅ Uvicorn 🛠️ 🏃 👆 FastAPI 🈸). 👫 🔜 🌐 **🌓 📦**, 🏃♂ 🎏 👜, ✋️ 🔠 ⏮️ 🚮 👍 🛠️, 💾, ♒️. 👈 🌌 👆 🔜 ✊ 📈 **🛠️** **🎏 🐚** 💽, ⚖️ **🎏 🎰**.
|
||||||
|
|
||||||
|
& 📎 📦 ⚙️ ⏮️ **📐 ⚙** 🔜 **📎 📨** 🔠 1️⃣ 📦 ⏮️ 👆 📱 **🔄**. , 🔠 📨 💪 🍵 1️⃣ 💗 **🔁 📦** 🏃 👆 📱.
|
||||||
|
|
||||||
|
& 🛎 👉 **📐 ⚙** 🔜 💪 🍵 📨 👈 🚶 *🎏* 📱 👆 🌑 (✅ 🎏 🆔, ⚖️ 🔽 🎏 📛 ➡ 🔡), & 🔜 📶 👈 📻 ▶️️ 📦 *👈 🎏* 🈸 🏃♂ 👆 🌑.
|
||||||
|
|
||||||
|
### 1️⃣ 🛠️ 📍 📦
|
||||||
|
|
||||||
|
👉 🆎 😐, 👆 🎲 🔜 💚 ✔️ **👁 (Uvicorn) 🛠️ 📍 📦**, 👆 🔜 ⏪ 🚚 🧬 🌑 🎚.
|
||||||
|
|
||||||
|
, 👉 💼, 👆 **🔜 🚫** 💚 ✔️ 🛠️ 👨💼 💖 🐁 ⏮️ Uvicorn 👨🏭, ⚖️ Uvicorn ⚙️ 🚮 👍 Uvicorn 👨🏭. 👆 🔜 💚 ✔️ **👁 Uvicorn 🛠️** 📍 📦 (✋️ 🎲 💗 📦).
|
||||||
|
|
||||||
|
✔️ ➕1️⃣ 🛠️ 👨💼 🔘 📦 (🔜 ⏮️ 🐁 ⚖️ Uvicorn 🛠️ Uvicorn 👨🏭) 🔜 🕴 🚮 **🙃 🔀** 👈 👆 🌅 🎲 ⏪ ✊ 💅 ⏮️ 👆 🌑 ⚙️.
|
||||||
|
|
||||||
|
### 📦 ⏮️ 💗 🛠️ & 🎁 💼
|
||||||
|
|
||||||
|
↗️, 📤 **🎁 💼** 🌐❔ 👆 💪 💚 ✔️ **📦** ⏮️ **🐁 🛠️ 👨💼** ▶️ 📚 **Uvicorn 👨🏭 🛠️** 🔘.
|
||||||
|
|
||||||
|
📚 💼, 👆 💪 ⚙️ **🛂 ☁ 🖼** 👈 🔌 **🐁** 🛠️ 👨💼 🏃♂ 💗 **Uvicorn 👨🏭 🛠️**, & 🔢 ⚒ 🔆 🔢 👨🏭 ⚓️ 🔛 ⏮️ 💽 🐚 🔁. 👤 🔜 💬 👆 🌅 🔃 ⚫️ 🔛 [🛂 ☁ 🖼 ⏮️ 🐁 - Uvicorn](#-uvicorn).
|
||||||
|
|
||||||
|
📥 🖼 🕐❔ 👈 💪 ⚒ 🔑:
|
||||||
|
|
||||||
|
#### 🙅 📱
|
||||||
|
|
||||||
|
👆 💪 💚 🛠️ 👨💼 📦 🚥 👆 🈸 **🙅 🥃** 👈 👆 🚫 💪 (🐥 🚫) 👌-🎶 🔢 🛠️ 💁♂️ 🌅, & 👆 💪 ⚙️ 🏧 🔢 (⏮️ 🛂 ☁ 🖼), & 👆 🏃♂ ⚫️ 🔛 **👁 💽**, 🚫 🌑.
|
||||||
|
|
||||||
|
#### ☁ ✍
|
||||||
|
|
||||||
|
👆 💪 🛠️ **👁 💽** (🚫 🌑) ⏮️ **☁ ✍**, 👆 🚫🔜 ✔️ ⏩ 🌌 🛠️ 🧬 📦 (⏮️ ☁ ✍) ⏪ 🛡 🔗 🕸 & **📐 ⚖**.
|
||||||
|
|
||||||
|
⤴️ 👆 💪 💚 ✔️ **👁 📦** ⏮️ **🛠️ 👨💼** ▶️ **📚 👨🏭 🛠️** 🔘.
|
||||||
|
|
||||||
|
#### 🤴 & 🎏 🤔
|
||||||
|
|
||||||
|
👆 💪 ✔️ **🎏 🤔** 👈 🔜 ⚒ ⚫️ ⏩ ✔️ **👁 📦** ⏮️ **💗 🛠️** ↩️ ✔️ **💗 📦** ⏮️ **👁 🛠️** 🔠 👫.
|
||||||
|
|
||||||
|
🖼 (🪀 🔛 👆 🖥) 👆 💪 ✔️ 🧰 💖 🤴 🏭 🎏 📦 👈 🔜 ✔️ 🔐 **🔠 📨** 👈 👟.
|
||||||
|
|
||||||
|
👉 💼, 🚥 👆 ✔️ **💗 📦**, 🔢, 🕐❔ 🤴 👟 **✍ ⚖**, ⚫️ 🔜 🤚 🕐 **👁 📦 🔠 🕰** (📦 👈 🍵 👈 🎯 📨), ↩️ 🤚 **📈 ⚖** 🌐 🔁 📦.
|
||||||
|
|
||||||
|
⤴️, 👈 💼, ⚫️ 💪 🙅 ✔️ **1️⃣ 📦** ⏮️ **💗 🛠️**, & 🇧🇿 🧰 (✅ 🤴 🏭) 🔛 🎏 📦 📈 🤴 ⚖ 🌐 🔗 🛠️ & 🎦 👈 ⚖ 🔛 👈 👁 📦.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👑 ☝, **👌** 👉 **🚫 ✍ 🗿** 👈 👆 ✔️ 😄 ⏩. 👆 💪 ⚙️ 👫 💭 **🔬 👆 👍 ⚙️ 💼** & 💭 ⚫️❔ 👍 🎯 👆 ⚙️, ✅ 👅 ❔ 🛠️ 🔧:
|
||||||
|
|
||||||
|
* 💂♂ - 🇺🇸🔍
|
||||||
|
* 🏃♂ 🔛 🕴
|
||||||
|
* ⏏
|
||||||
|
* 🧬 (🔢 🛠️ 🏃)
|
||||||
|
* 💾
|
||||||
|
* ⏮️ 🔁 ⏭ ▶️
|
||||||
|
|
||||||
|
## 💾
|
||||||
|
|
||||||
|
🚥 👆 🏃 **👁 🛠️ 📍 📦** 👆 🔜 ✔️ 🌅 ⚖️ 🌘 👍-🔬, ⚖, & 📉 💸 💾 🍴 🔠 👈 📦 (🌅 🌘 1️⃣ 🚥 👫 🔁).
|
||||||
|
|
||||||
|
& ⤴️ 👆 💪 ⚒ 👈 🎏 💾 📉 & 📄 👆 📳 👆 📦 🧾 ⚙️ (🖼 **Kubernetes**). 👈 🌌 ⚫️ 🔜 💪 **🔁 📦** **💪 🎰** ✊ 🔘 🏧 💸 💾 💪 👫, & 💸 💪 🎰 🌑.
|
||||||
|
|
||||||
|
🚥 👆 🈸 **🙅**, 👉 🔜 🎲 **🚫 ⚠**, & 👆 💪 🚫 💪 ✔ 🏋️ 💾 📉. ✋️ 🚥 👆 **⚙️ 📚 💾** (🖼 ⏮️ **🎰 🏫** 🏷), 👆 🔜 ✅ ❔ 🌅 💾 👆 😩 & 🔆 **🔢 📦** 👈 🏃 **🔠 🎰** (& 🎲 🚮 🌖 🎰 👆 🌑).
|
||||||
|
|
||||||
|
🚥 👆 🏃 **💗 🛠️ 📍 📦** (🖼 ⏮️ 🛂 ☁ 🖼) 👆 🔜 ✔️ ⚒ 💭 👈 🔢 🛠️ ▶️ 🚫 **🍴 🌖 💾** 🌘 ⚫️❔ 💪.
|
||||||
|
|
||||||
|
## ⏮️ 🔁 ⏭ ▶️ & 📦
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 📦 (✅ ☁, Kubernetes), ⤴️ 📤 2️⃣ 👑 🎯 👆 💪 ⚙️.
|
||||||
|
|
||||||
|
### 💗 📦
|
||||||
|
|
||||||
|
🚥 👆 ✔️ **💗 📦**, 🎲 🔠 1️⃣ 🏃 **👁 🛠️** (🖼, **Kubernetes** 🌑), ⤴️ 👆 🔜 🎲 💚 ✔️ **🎏 📦** 🔨 👷 **⏮️ 📶** 👁 📦, 🏃 👁 🛠️, **⏭** 🏃 🔁 👨🏭 📦.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ Kubernetes, 👉 🔜 🎲 <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-containers/" class="external-link" target="_blank">🕑 📦</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 💼 📤 🙅♂ ⚠ 🏃♂ 👈 ⏮️ 📶 **💗 🕰 🔗** (🖼 🚥 👆 🚫 🏃 💽 🛠️, ✋️ ✅ 🚥 💽 🔜), ⤴️ 👆 💪 🚮 👫 🔠 📦 ▶️️ ⏭ ▶️ 👑 🛠️.
|
||||||
|
|
||||||
|
### 👁 📦
|
||||||
|
|
||||||
|
🚥 👆 ✔️ 🙅 🖥, ⏮️ **👁 📦** 👈 ⤴️ ▶️ 💗 **👨🏭 🛠️** (⚖️ 1️⃣ 🛠️), ⤴️ 👆 💪 🏃 👈 ⏮️ 🔁 🎏 📦, ▶️️ ⏭ ▶️ 🛠️ ⏮️ 📱. 🛂 ☁ 🖼 🐕🦺 👉 🔘.
|
||||||
|
|
||||||
|
## 🛂 ☁ 🖼 ⏮️ 🐁 - Uvicorn
|
||||||
|
|
||||||
|
📤 🛂 ☁ 🖼 👈 🔌 🐁 🏃♂ ⏮️ Uvicorn 👨🏭, ℹ ⏮️ 📃: [💽 👨🏭 - 🐁 ⏮️ Uvicorn](server-workers.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
👉 🖼 🔜 ⚠ ✴️ ⚠ 🔬 🔛: [📦 ⏮️ 💗 🛠️ & 🎁 💼](#_18).
|
||||||
|
|
||||||
|
* <a href="https://github.com/tiangolo/uvicorn-gunicorn-fastapi-docker" class="external-link" target="_blank">tiangolo/uvicorn-🐁-fastapi</a>.
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
📤 ↕ 🤞 👈 👆 **🚫** 💪 👉 🧢 🖼 ⚖️ 🙆 🎏 🎏 1️⃣, & 🔜 👻 📆 🏗 🖼 ⚪️➡️ 🖌 [🔬 🔛: 🏗 ☁ 🖼 FastAPI](#fastapi).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👉 🖼 ✔️ **🚘-📳** 🛠️ 🔌 ⚒ **🔢 👨🏭 🛠️** ⚓️ 🔛 💽 🐚 💪.
|
||||||
|
|
||||||
|
⚫️ ✔️ **🤔 🔢**, ✋️ 👆 💪 🔀 & ℹ 🌐 📳 ⏮️ **🌐 🔢** ⚖️ 📳 📁.
|
||||||
|
|
||||||
|
⚫️ 🐕🦺 🏃 <a href="https://github.com/tiangolo/uvicorn-gunicorn-fastapi-docker#pre_start_path" class="external-link" target="_blank">**⏮️ 🔁 ⏭ ▶️**</a> ⏮️ ✍.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 🌐 📳 & 🎛, 🚶 ☁ 🖼 📃: <a href="https://github.com/tiangolo/uvicorn-gunicorn-fastapi-docker" class="external-link" target="_blank">Tiangolo/uvicorn-🐁-fastapi</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🔢 🛠️ 🔛 🛂 ☁ 🖼
|
||||||
|
|
||||||
|
**🔢 🛠️** 🔛 👉 🖼 **📊 🔁** ⚪️➡️ 💽 **🐚** 💪.
|
||||||
|
|
||||||
|
👉 ⛓ 👈 ⚫️ 🔜 🔄 **🗜** 🌅 **🎭** ⚪️➡️ 💽 💪.
|
||||||
|
|
||||||
|
👆 💪 🔆 ⚫️ ⏮️ 📳 ⚙️ **🌐 🔢**, ♒️.
|
||||||
|
|
||||||
|
✋️ ⚫️ ⛓ 👈 🔢 🛠️ 🪀 🔛 💽 📦 🏃, **💸 💾 🍴** 🔜 🪀 🔛 👈.
|
||||||
|
|
||||||
|
, 🚥 👆 🈸 🍴 📚 💾 (🖼 ⏮️ 🎰 🏫 🏷), & 👆 💽 ✔️ 📚 💽 🐚 **✋️ 🐥 💾**, ⤴️ 👆 📦 💪 🔚 🆙 🔄 ⚙️ 🌅 💾 🌘 ⚫️❔ 💪, & 🤕 🎭 📚 (⚖️ 💥). 👶
|
||||||
|
|
||||||
|
### ✍ `Dockerfile`
|
||||||
|
|
||||||
|
📥 ❔ 👆 🔜 ✍ `Dockerfile` ⚓️ 🔛 👉 🖼:
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
FROM tiangolo/uvicorn-gunicorn-fastapi:python3.9
|
||||||
|
|
||||||
|
COPY ./requirements.txt /app/requirements.txt
|
||||||
|
|
||||||
|
RUN pip install --no-cache-dir --upgrade -r /app/requirements.txt
|
||||||
|
|
||||||
|
COPY ./app /app
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🦏 🈸
|
||||||
|
|
||||||
|
🚥 👆 ⏩ 📄 🔃 🏗 [🦏 🈸 ⏮️ 💗 📁](../tutorial/bigger-applications.md){.internal-link target=_blank}, 👆 `Dockerfile` 💪 ↩️ 👀 💖:
|
||||||
|
|
||||||
|
```Dockerfile hl_lines="7"
|
||||||
|
FROM tiangolo/uvicorn-gunicorn-fastapi:python3.9
|
||||||
|
|
||||||
|
COPY ./requirements.txt /app/requirements.txt
|
||||||
|
|
||||||
|
RUN pip install --no-cache-dir --upgrade -r /app/requirements.txt
|
||||||
|
|
||||||
|
COPY ./app /app/app
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🕐❔ ⚙️
|
||||||
|
|
||||||
|
👆 🔜 🎲 **🚫** ⚙️ 👉 🛂 🧢 🖼 (⚖️ 🙆 🎏 🎏 1️⃣) 🚥 👆 ⚙️ **Kubernetes** (⚖️ 🎏) & 👆 ⏪ ⚒ **🧬** 🌑 🎚, ⏮️ 💗 **📦**. 📚 💼, 👆 👍 📆 **🏗 🖼 ⚪️➡️ 🖌** 🔬 🔛: [🏗 ☁ 🖼 FastAPI](#fastapi).
|
||||||
|
|
||||||
|
👉 🖼 🔜 ⚠ ✴️ 🎁 💼 🔬 🔛 [📦 ⏮️ 💗 🛠️ & 🎁 💼](#_18). 🖼, 🚥 👆 🈸 **🙅 🥃** 👈 ⚒ 🔢 🔢 🛠️ ⚓️ 🔛 💽 👷 👍, 👆 🚫 💚 😥 ⏮️ ❎ 🛠️ 🧬 🌑 🎚, & 👆 🚫 🏃 🌅 🌘 1️⃣ 📦 ⏮️ 👆 📱. ⚖️ 🚥 👆 🛠️ ⏮️ **☁ ✍**, 🏃 🔛 👁 💽, ♒️.
|
||||||
|
|
||||||
|
## 🛠️ 📦 🖼
|
||||||
|
|
||||||
|
⏮️ ✔️ 📦 (☁) 🖼 📤 📚 🌌 🛠️ ⚫️.
|
||||||
|
|
||||||
|
🖼:
|
||||||
|
|
||||||
|
* ⏮️ **☁ ✍** 👁 💽
|
||||||
|
* ⏮️ **Kubernetes** 🌑
|
||||||
|
* ⏮️ ☁ 🐝 📳 🌑
|
||||||
|
* ⏮️ ➕1️⃣ 🧰 💖 🖖
|
||||||
|
* ⏮️ ☁ 🐕🦺 👈 ✊ 👆 📦 🖼 & 🛠️ ⚫️
|
||||||
|
|
||||||
|
## ☁ 🖼 ⏮️ 🎶
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ <a href="https://python-poetry.org/" class="external-link" target="_blank">🎶</a> 🛠️ 👆 🏗 🔗, 👆 💪 ⚙️ ☁ 👁-▶️ 🏗:
|
||||||
|
|
||||||
|
```{ .dockerfile .annotate }
|
||||||
|
# (1)
|
||||||
|
FROM python:3.9 as requirements-stage
|
||||||
|
|
||||||
|
# (2)
|
||||||
|
WORKDIR /tmp
|
||||||
|
|
||||||
|
# (3)
|
||||||
|
RUN pip install poetry
|
||||||
|
|
||||||
|
# (4)
|
||||||
|
COPY ./pyproject.toml ./poetry.lock* /tmp/
|
||||||
|
|
||||||
|
# (5)
|
||||||
|
RUN poetry export -f requirements.txt --output requirements.txt --without-hashes
|
||||||
|
|
||||||
|
# (6)
|
||||||
|
FROM python:3.9
|
||||||
|
|
||||||
|
# (7)
|
||||||
|
WORKDIR /code
|
||||||
|
|
||||||
|
# (8)
|
||||||
|
COPY --from=requirements-stage /tmp/requirements.txt /code/requirements.txt
|
||||||
|
|
||||||
|
# (9)
|
||||||
|
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
|
||||||
|
|
||||||
|
# (10)
|
||||||
|
COPY ./app /code/app
|
||||||
|
|
||||||
|
# (11)
|
||||||
|
CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
|
||||||
|
```
|
||||||
|
|
||||||
|
1️⃣. 👉 🥇 ▶️, ⚫️ 🌟 `requirements-stage`.
|
||||||
|
|
||||||
|
2️⃣. ⚒ `/tmp` ⏮️ 👷 📁.
|
||||||
|
|
||||||
|
📥 🌐❔ 👥 🔜 🏗 📁 `requirements.txt`
|
||||||
|
|
||||||
|
3️⃣. ❎ 🎶 👉 ☁ ▶️.
|
||||||
|
|
||||||
|
4️⃣. 📁 `pyproject.toml` & `poetry.lock` 📁 `/tmp` 📁.
|
||||||
|
|
||||||
|
↩️ ⚫️ ⚙️ `./poetry.lock*` (▶️ ⏮️ `*`), ⚫️ 🏆 🚫 💥 🚥 👈 📁 🚫 💪.
|
||||||
|
|
||||||
|
5️⃣. 🏗 `requirements.txt` 📁.
|
||||||
|
|
||||||
|
6️⃣. 👉 🏁 ▶️, 🕳 📥 🔜 🛡 🏁 📦 🖼.
|
||||||
|
|
||||||
|
7️⃣. ⚒ ⏮️ 👷 📁 `/code`.
|
||||||
|
|
||||||
|
8️⃣. 📁 `requirements.txt` 📁 `/code` 📁.
|
||||||
|
|
||||||
|
👉 📁 🕴 🖖 ⏮️ ☁ ▶️, 👈 ⚫️❔ 👥 ⚙️ `--from-requirements-stage` 📁 ⚫️.
|
||||||
|
|
||||||
|
9️⃣. ❎ 📦 🔗 🏗 `requirements.txt` 📁.
|
||||||
|
|
||||||
|
1️⃣0️⃣. 📁 `app` 📁 `/code` 📁.
|
||||||
|
|
||||||
|
1️⃣1️⃣. 🏃 `uvicorn` 📋, 💬 ⚫️ ⚙️ `app` 🎚 🗄 ⚪️➡️ `app.main`.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🖊 💭 🔢 👀 ⚫️❔ 🔠 ⏸ 🔨.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
**☁ ▶️** 🍕 `Dockerfile` 👈 👷 **🍕 📦 🖼** 👈 🕴 ⚙️ 🏗 📁 ⚙️ ⏪.
|
||||||
|
|
||||||
|
🥇 ▶️ 🔜 🕴 ⚙️ **❎ 🎶** & **🏗 `requirements.txt`** ⏮️ 👆 🏗 🔗 ⚪️➡️ 🎶 `pyproject.toml` 📁.
|
||||||
|
|
||||||
|
👉 `requirements.txt` 📁 🔜 ⚙️ ⏮️ `pip` ⏪ **⏭ ▶️**.
|
||||||
|
|
||||||
|
🏁 📦 🖼 **🕴 🏁 ▶️** 🛡. ⏮️ ▶️(Ⓜ) 🔜 ❎.
|
||||||
|
|
||||||
|
🕐❔ ⚙️ 🎶, ⚫️ 🔜 ⚒ 🔑 ⚙️ **☁ 👁-▶️ 🏗** ↩️ 👆 🚫 🤙 💪 ✔️ 🎶 & 🚮 🔗 ❎ 🏁 📦 🖼, 👆 **🕴 💪** ✔️ 🏗 `requirements.txt` 📁 ❎ 👆 🏗 🔗.
|
||||||
|
|
||||||
|
⤴️ ⏭ (& 🏁) ▶️ 👆 🔜 🏗 🖼 🌅 ⚖️ 🌘 🎏 🌌 🔬 ⏭.
|
||||||
|
|
||||||
|
### ⛅ 🤝 ❎ 🗳 - 🎶
|
||||||
|
|
||||||
|
🔄, 🚥 👆 🏃♂ 👆 📦 ⛅ 🤝 ❎ 🗳 (📐 ⚙) 💖 👌 ⚖️ Traefik, 🚮 🎛 `--proxy-headers` 📋:
|
||||||
|
|
||||||
|
```Dockerfile
|
||||||
|
CMD ["uvicorn", "app.main:app", "--proxy-headers", "--host", "0.0.0.0", "--port", "80"]
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
⚙️ 📦 ⚙️ (✅ ⏮️ **☁** & **Kubernetes**) ⚫️ ▶️️ 📶 🎯 🍵 🌐 **🛠️ 🔧**:
|
||||||
|
|
||||||
|
* 🇺🇸🔍
|
||||||
|
* 🏃♂ 🔛 🕴
|
||||||
|
* ⏏
|
||||||
|
* 🧬 (🔢 🛠️ 🏃)
|
||||||
|
* 💾
|
||||||
|
* ⏮️ 🔁 ⏭ ▶️
|
||||||
|
|
||||||
|
🌅 💼, 👆 🎲 🏆 🚫 💚 ⚙️ 🙆 🧢 🖼, & ↩️ **🏗 📦 🖼 ⚪️➡️ 🖌** 1️⃣ ⚓️ 🔛 🛂 🐍 ☁ 🖼.
|
||||||
|
|
||||||
|
✊ 💅 **✔** 👩🌾 `Dockerfile` & **☁ 💾** 👆 💪 **📉 🏗 🕰**, 📉 👆 📈 (& ❎ 😩). 👶
|
||||||
|
|
||||||
|
🎯 🎁 💼, 👆 💪 💚 ⚙️ 🛂 ☁ 🖼 FastAPI. 👶
|
||||||
|
|
@ -0,0 +1,199 @@
|
||||||
|
# 🔃 🇺🇸🔍
|
||||||
|
|
||||||
|
⚫️ ⏩ 🤔 👈 🇺🇸🔍 🕳 👈 "🛠️" ⚖️ 🚫.
|
||||||
|
|
||||||
|
✋️ ⚫️ 🌌 🌖 🏗 🌘 👈.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 🏃 ⚖️ 🚫 💅, 😣 ⏮️ ⏭ 📄 🔁 🔁 👩🌾 ⚒ 🌐 🆙 ⏮️ 🎏 ⚒.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
**💡 🔰 🇺🇸🔍**, ⚪️➡️ 🏬 🤔, ✅ <a href="https://howhttps.works/" class="external-link" target="_blank">https://howhttps.works/</a>.
|
||||||
|
|
||||||
|
🔜, ⚪️➡️ **👩💻 🤔**, 📥 📚 👜 ✔️ 🤯 ⏪ 💭 🔃 🇺🇸🔍:
|
||||||
|
|
||||||
|
* 🇺🇸🔍, **💽** 💪 **✔️ "📄"** 🏗 **🥉 🥳**.
|
||||||
|
* 📚 📄 🤙 **🏆** ⚪️➡️ 🥉 🥳, 🚫 "🏗".
|
||||||
|
* 📄 ✔️ **1️⃣2️⃣🗓️**.
|
||||||
|
* 👫 **🕛**.
|
||||||
|
* & ⤴️ 👫 💪 **♻**, **🏆 🔄** ⚪️➡️ 🥉 🥳.
|
||||||
|
* 🔐 🔗 🔨 **🕸 🎚**.
|
||||||
|
* 👈 1️⃣ 🧽 **🔛 🇺🇸🔍**.
|
||||||
|
* , **📄 & 🔐** 🍵 🔨 **⏭ 🇺🇸🔍**.
|
||||||
|
* **🕸 🚫 💭 🔃 "🆔"**. 🕴 🔃 📢 📢.
|
||||||
|
* ℹ 🔃 **🎯 🆔** 📨 🚶 **🇺🇸🔍 💽**.
|
||||||
|
* **🇺🇸🔍 📄** "✔" **🎯 🆔**, ✋️ 🛠️ & 🔐 🔨 🕸 🎚, **⏭ 💭** ❔ 🆔 ➖ 🙅 ⏮️.
|
||||||
|
* **🔢**, 👈 🔜 ⛓ 👈 👆 💪 🕴 ✔️ **1️⃣ 🇺🇸🔍 📄 📍 📢 📢**.
|
||||||
|
* 🙅♂ 🤔 ❔ 🦏 👆 💽 ⚖️ ❔ 🤪 🔠 🈸 👆 ✔️ 🔛 ⚫️ 💪.
|
||||||
|
* 📤 **⚗** 👉, 👐.
|
||||||
|
* 📤 **↔** **🤝** 🛠️ (1️⃣ 🚚 🔐 🕸 🎚, ⏭ 🇺🇸🔍) 🤙 **<a href="https://en.wikipedia.org/wiki/Server_Name_Indication" class="external-link" target="_blank"><abbr title="Server Name Indication">👲</abbr></a>**.
|
||||||
|
* 👉 👲 ↔ ✔ 1️⃣ 👁 💽 (⏮️ **👁 📢 📢**) ✔️ **📚 🇺🇸🔍 📄** & 🍦 **💗 🇺🇸🔍 🆔/🈸**.
|
||||||
|
* 👉 👷, **👁** 🦲 (📋) 🏃 🔛 💽, 👂 🔛 **📢 📢 📢**, 🔜 ✔️ **🌐 🇺🇸🔍 📄** 💽.
|
||||||
|
* **⏮️** 🏆 🔐 🔗, 📻 🛠️ **🇺🇸🔍**.
|
||||||
|
* 🎚 **🗜**, ✋️ 👫 ➖ 📨 ⏮️ **🇺🇸🔍 🛠️**.
|
||||||
|
|
||||||
|
⚫️ ⚠ 💡 ✔️ **1️⃣ 📋/🇺🇸🔍 💽** 🏃 🔛 💽 (🎰, 🦠, ♒️.) & **🛠️ 🌐 🇺🇸🔍 🍕**: 📨 **🗜 🇺🇸🔍 📨**, 📨 **🗜 🇺🇸🔍 📨** ☑ 🇺🇸🔍 🈸 🏃 🎏 💽 ( **FastAPI** 🈸, 👉 💼), ✊ **🇺🇸🔍 📨** ⚪️➡️ 🈸, **🗜 ⚫️** ⚙️ ☑ **🇺🇸🔍 📄** & 📨 ⚫️ 🔙 👩💻 ⚙️ **🇺🇸🔍**. 👉 💽 🛎 🤙 **<a href="https://en.wikipedia.org/wiki/TLS_termination_proxy" class="external-link" target="_blank">🤝 ❎ 🗳</a>**.
|
||||||
|
|
||||||
|
🎛 👆 💪 ⚙️ 🤝 ❎ 🗳:
|
||||||
|
|
||||||
|
* Traefik (👈 💪 🍵 📄 🔕)
|
||||||
|
* 📥 (👈 💪 🍵 📄 🔕)
|
||||||
|
* 👌
|
||||||
|
* ✳
|
||||||
|
|
||||||
|
## ➡️ 🗜
|
||||||
|
|
||||||
|
⏭ ➡️ 🗜, 👫 **🇺🇸🔍 📄** 💲 💙 🥉 🥳.
|
||||||
|
|
||||||
|
🛠️ 📎 1️⃣ 👫 📄 ⚙️ ⚠, 🚚 📠 & 📄 😥.
|
||||||
|
|
||||||
|
✋️ ⤴️ **<a href="https://letsencrypt.org/" class="external-link" target="_blank">➡️ 🗜</a>** ✍.
|
||||||
|
|
||||||
|
⚫️ 🏗 ⚪️➡️ 💾 🏛. ⚫️ 🚚 **🇺🇸🔍 📄 🆓**, 🏧 🌌. 👫 📄 ⚙️ 🌐 🐩 🔐 💂♂, & 📏-🖖 (🔃 3️⃣ 🗓️), **💂♂ 🤙 👍** ↩️ 👫 📉 🔆.
|
||||||
|
|
||||||
|
🆔 🔐 ✔ & 📄 🏗 🔁. 👉 ✔ 🏧 🔕 👫 📄.
|
||||||
|
|
||||||
|
💭 🏧 🛠️ & 🔕 👫 📄 👈 👆 💪 ✔️ **🔐 🇺🇸🔍, 🆓, ♾**.
|
||||||
|
|
||||||
|
## 🇺🇸🔍 👩💻
|
||||||
|
|
||||||
|
📥 🖼 ❔ 🇺🇸🔍 🛠️ 💪 👀 💖, 🔁 🔁, 💸 🙋 ✴️ 💭 ⚠ 👩💻.
|
||||||
|
|
||||||
|
### 🆔 📛
|
||||||
|
|
||||||
|
⚫️ 🔜 🎲 🌐 ▶️ 👆 **🏗** **🆔 📛**. ⤴️, 👆 🔜 🔗 ⚫️ 🏓 💽 (🎲 👆 🎏 ☁ 🐕🦺).
|
||||||
|
|
||||||
|
👆 🔜 🎲 🤚 ☁ 💽 (🕹 🎰) ⚖️ 🕳 🎏, & ⚫️ 🔜 ✔️ <abbr title="That doesn't change">🔧</abbr> **📢 📢 📢**.
|
||||||
|
|
||||||
|
🏓 💽(Ⓜ) 👆 🔜 🔗 ⏺ ("`A record`") ☝ **👆 🆔** 📢 **📢 📢 👆 💽**.
|
||||||
|
|
||||||
|
👆 🔜 🎲 👉 🕐, 🥇 🕰, 🕐❔ ⚒ 🌐 🆙.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👉 🆔 📛 🍕 🌌 ⏭ 🇺🇸🔍, ✋️ 🌐 🪀 🔛 🆔 & 📢 📢, ⚫️ 💸 💬 ⚫️ 📥.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🏓
|
||||||
|
|
||||||
|
🔜 ➡️ 🎯 🔛 🌐 ☑ 🇺🇸🔍 🍕.
|
||||||
|
|
||||||
|
🥇, 🖥 🔜 ✅ ⏮️ **🏓 💽** ⚫️❔ **📢 🆔**, 👉 💼, `someapp.example.com`.
|
||||||
|
|
||||||
|
🏓 💽 🔜 💬 🖥 ⚙️ 🎯 **📢 📢**. 👈 🔜 📢 📢 📢 ⚙️ 👆 💽, 👈 👆 🔗 🏓 💽.
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https01.drawio.svg">
|
||||||
|
|
||||||
|
### 🤝 🤝 ▶️
|
||||||
|
|
||||||
|
🖥 🔜 ⤴️ 🔗 ⏮️ 👈 📢 📢 🔛 **⛴ 4️⃣4️⃣3️⃣** (🇺🇸🔍 ⛴).
|
||||||
|
|
||||||
|
🥇 🍕 📻 🛠️ 🔗 🖖 👩💻 & 💽 & 💭 🔐 🔑 👫 🔜 ⚙️, ♒️.
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https02.drawio.svg">
|
||||||
|
|
||||||
|
👉 🔗 🖖 👩💻 & 💽 🛠️ 🤝 🔗 🤙 **🤝 🤝**.
|
||||||
|
|
||||||
|
### 🤝 ⏮️ 👲 ↔
|
||||||
|
|
||||||
|
**🕴 1️⃣ 🛠️** 💽 💪 👂 🔛 🎯 **⛴** 🎯 **📢 📢**. 📤 💪 🎏 🛠️ 👂 🔛 🎏 ⛴ 🎏 📢 📢, ✋️ 🕴 1️⃣ 🔠 🌀 📢 📢 & ⛴.
|
||||||
|
|
||||||
|
🤝 (🇺🇸🔍) ⚙️ 🎯 ⛴ `443` 🔢. 👈 ⛴ 👥 🔜 💪.
|
||||||
|
|
||||||
|
🕴 1️⃣ 🛠️ 💪 👂 🔛 👉 ⛴, 🛠️ 👈 🔜 ⚫️ 🔜 **🤝 ❎ 🗳**.
|
||||||
|
|
||||||
|
🤝 ❎ 🗳 🔜 ✔️ 🔐 1️⃣ ⚖️ 🌅 **🤝 📄** (🇺🇸🔍 📄).
|
||||||
|
|
||||||
|
⚙️ **👲 ↔** 🔬 🔛, 🤝 ❎ 🗳 🔜 ✅ ❔ 🤝 (🇺🇸🔍) 📄 💪 ⚫️ 🔜 ⚙️ 👉 🔗, ⚙️ 1️⃣ 👈 🏏 🆔 📈 👩💻.
|
||||||
|
|
||||||
|
👉 💼, ⚫️ 🔜 ⚙️ 📄 `someapp.example.com`.
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https03.drawio.svg">
|
||||||
|
|
||||||
|
👩💻 ⏪ **💙** 👨💼 👈 🏗 👈 🤝 📄 (👉 💼 ➡️ 🗜, ✋️ 👥 🔜 👀 🔃 👈 ⏪), ⚫️ 💪 **✔** 👈 📄 ☑.
|
||||||
|
|
||||||
|
⤴️, ⚙️ 📄, 👩💻 & 🤝 ❎ 🗳 **💭 ❔ 🗜** 🎂 **🕸 📻**. 👉 🏁 **🤝 🤝** 🍕.
|
||||||
|
|
||||||
|
⏮️ 👉, 👩💻 & 💽 ✔️ **🗜 🕸 🔗**, 👉 ⚫️❔ 🤝 🚚. & ⤴️ 👫 💪 ⚙️ 👈 🔗 ▶️ ☑ **🇺🇸🔍 📻**.
|
||||||
|
|
||||||
|
& 👈 ⚫️❔ **🇺🇸🔍** , ⚫️ ✅ **🇺🇸🔍** 🔘 **🔐 🤝 🔗** ↩️ 😁 (💽) 🕸 🔗.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 👈 🔐 📻 🔨 **🕸 🎚**, 🚫 🇺🇸🔍 🎚.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🇺🇸🔍 📨
|
||||||
|
|
||||||
|
🔜 👈 👩💻 & 💽 (🎯 🖥 & 🤝 ❎ 🗳) ✔️ **🗜 🕸 🔗**, 👫 💪 ▶️ **🇺🇸🔍 📻**.
|
||||||
|
|
||||||
|
, 👩💻 📨 **🇺🇸🔍 📨**. 👉 🇺🇸🔍 📨 🔘 🗜 🤝 🔗.
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https04.drawio.svg">
|
||||||
|
|
||||||
|
### 🗜 📨
|
||||||
|
|
||||||
|
🤝 ❎ 🗳 🔜 ⚙️ 🔐 ✔ **🗜 📨**, & 🔜 📶 **✅ (🗜) 🇺🇸🔍 📨** 🛠️ 🏃 🈸 (🖼 🛠️ ⏮️ Uvicorn 🏃♂ FastAPI 🈸).
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https05.drawio.svg">
|
||||||
|
|
||||||
|
### 🇺🇸🔍 📨
|
||||||
|
|
||||||
|
🈸 🔜 🛠️ 📨 & 📨 **✅ (💽) 🇺🇸🔍 📨** 🤝 ❎ 🗳.
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https06.drawio.svg">
|
||||||
|
|
||||||
|
### 🇺🇸🔍 📨
|
||||||
|
|
||||||
|
🤝 ❎ 🗳 🔜 ⤴️ **🗜 📨** ⚙️ ⚛ ✔ ⏭ (👈 ▶️ ⏮️ 📄 `someapp.example.com`), & 📨 ⚫️ 🔙 🖥.
|
||||||
|
|
||||||
|
⏭, 🖥 🔜 ✔ 👈 📨 ☑ & 🗜 ⏮️ ▶️️ 🔐 🔑, ♒️. ⚫️ 🔜 ⤴️ **🗜 📨** & 🛠️ ⚫️.
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https07.drawio.svg">
|
||||||
|
|
||||||
|
👩💻 (🖥) 🔜 💭 👈 📨 👟 ⚪️➡️ ☑ 💽 ↩️ ⚫️ ⚙️ ⚛ 👫 ✔ ⚙️ **🇺🇸🔍 📄** ⏭.
|
||||||
|
|
||||||
|
### 💗 🈸
|
||||||
|
|
||||||
|
🎏 💽 (⚖️ 💽), 📤 💪 **💗 🈸**, 🖼, 🎏 🛠️ 📋 ⚖️ 💽.
|
||||||
|
|
||||||
|
🕴 1️⃣ 🛠️ 💪 🚚 🎯 📢 & ⛴ (🤝 ❎ 🗳 👆 🖼) ✋️ 🎏 🈸/🛠️ 💪 🏃 🔛 💽(Ⓜ) 💁♂️, 📏 👫 🚫 🔄 ⚙️ 🎏 **🌀 📢 📢 & ⛴**.
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https08.drawio.svg">
|
||||||
|
|
||||||
|
👈 🌌, 🤝 ❎ 🗳 💪 🍵 🇺🇸🔍 & 📄 **💗 🆔**, 💗 🈸, & ⤴️ 📶 📨 ▶️️ 🈸 🔠 💼.
|
||||||
|
|
||||||
|
### 📄 🔕
|
||||||
|
|
||||||
|
☝ 🔮, 🔠 📄 🔜 **🕛** (🔃 3️⃣ 🗓️ ⏮️ 🏗 ⚫️).
|
||||||
|
|
||||||
|
& ⤴️, 📤 🔜 ➕1️⃣ 📋 (💼 ⚫️ ➕1️⃣ 📋, 💼 ⚫️ 💪 🎏 🤝 ❎ 🗳) 👈 🔜 💬 ➡️ 🗜, & ♻ 📄(Ⓜ).
|
||||||
|
|
||||||
|
<img src="/img/deployment/https/https.drawio.svg">
|
||||||
|
|
||||||
|
**🤝 📄** **🔗 ⏮️ 🆔 📛**, 🚫 ⏮️ 📢 📢.
|
||||||
|
|
||||||
|
, ♻ 📄, 🔕 📋 💪 **🎦** 🛃 (➡️ 🗜) 👈 ⚫️ 👐 **"👍" & 🎛 👈 🆔**.
|
||||||
|
|
||||||
|
👈, & 🏗 🎏 🈸 💪, 📤 📚 🌌 ⚫️ 💪 ⚫️. 🌟 🌌:
|
||||||
|
|
||||||
|
* **🔀 🏓 ⏺**.
|
||||||
|
* 👉, 🔕 📋 💪 🐕🦺 🔗 🏓 🐕🦺,, ⚓️ 🔛 🏓 🐕🦺 👆 ⚙️, 👉 5️⃣📆 ⚖️ 💪 🚫 🎛.
|
||||||
|
* **🏃 💽** (🌘 ⏮️ 📄 🛠️ 🛠️) 🔛 📢 📢 📢 🔗 ⏮️ 🆔.
|
||||||
|
* 👥 💬 🔛, 🕴 1️⃣ 🛠️ 💪 👂 🔛 🎯 📢 & ⛴.
|
||||||
|
* 👉 1️⃣ 🤔 ⚫️❔ ⚫️ 📶 ⚠ 🕐❔ 🎏 🤝 ❎ 🗳 ✊ 💅 📄 🔕 🛠️.
|
||||||
|
* ⏪, 👆 💪 ✔️ ⛔️ 🤝 ❎ 🗳 😖, ▶️ 🔕 📋 📎 📄, ⤴️ 🔗 👫 ⏮️ 🤝 ❎ 🗳, & ⤴️ ⏏ 🤝 ❎ 🗳. 👉 🚫 💯, 👆 📱(Ⓜ) 🔜 🚫 💪 ⏮️ 🕰 👈 🤝 ❎ 🗳 📆.
|
||||||
|
|
||||||
|
🌐 👉 🔕 🛠️, ⏪ 🍦 📱, 1️⃣ 👑 🤔 ⚫️❔ 👆 🔜 💚 ✔️ **🎏 ⚙️ 🍵 🇺🇸🔍** ⏮️ 🤝 ❎ 🗳 ↩️ ⚙️ 🤝 📄 ⏮️ 🈸 💽 🔗 (✅ Uvicorn).
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
✔️ **🇺🇸🔍** 📶 ⚠, & **🎯** 🏆 💼. 🌅 🎯 👆 👩💻 ✔️ 🚮 🤭 🇺🇸🔍 🔃 **🤔 👉 🔧** & ❔ 👫 👷.
|
||||||
|
|
||||||
|
✋️ 🕐 👆 💭 🔰 ℹ **🇺🇸🔍 👩💻** 👆 💪 💪 🌀 & 🔗 🎏 🧰 ℹ 👆 🛠️ 🌐 🙅 🌌.
|
||||||
|
|
||||||
|
⏭ 📃, 👤 🔜 🎦 👆 📚 🧱 🖼 ❔ ⚒ 🆙 **🇺🇸🔍** **FastAPI** 🈸. 👶
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
# 🛠️
|
||||||
|
|
||||||
|
🛠️ **FastAPI** 🈸 📶 ⏩.
|
||||||
|
|
||||||
|
## ⚫️❔ 🔨 🛠️ ⛓
|
||||||
|
|
||||||
|
**🛠️** 🈸 ⛓ 🎭 💪 📶 ⚒ ⚫️ **💪 👩💻**.
|
||||||
|
|
||||||
|
**🕸 🛠️**, ⚫️ 🛎 🔌 🚮 ⚫️ **🛰 🎰**, ⏮️ **💽 📋** 👈 🚚 👍 🎭, ⚖, ♒️, 👈 👆 **👩💻** 💪 **🔐** 🈸 ♻ & 🍵 🔁 ⚖️ ⚠.
|
||||||
|
|
||||||
|
👉 🔅 **🛠️** ▶️, 🌐❔ 👆 🕧 🔀 📟, 💔 ⚫️ & ♻ ⚫️, ⛔️ & 🔁 🛠️ 💽, ♒️.
|
||||||
|
|
||||||
|
## 🛠️ 🎛
|
||||||
|
|
||||||
|
📤 📚 🌌 ⚫️ ⚓️ 🔛 👆 🎯 ⚙️ 💼 & 🧰 👈 👆 ⚙️.
|
||||||
|
|
||||||
|
👆 💪 **🛠️ 💽** 👆 ⚙️ 🌀 🧰, 👆 💪 ⚙️ **☁ 🐕🦺** 👈 🔨 🍕 👷 👆, ⚖️ 🎏 💪 🎛.
|
||||||
|
|
||||||
|
👤 🔜 🎦 👆 👑 🔧 👆 🔜 🎲 ✔️ 🤯 🕐❔ 🛠️ **FastAPI** 🈸 (👐 🌅 ⚫️ ✔ 🙆 🎏 🆎 🕸 🈸).
|
||||||
|
|
||||||
|
👆 🔜 👀 🌖 ℹ ✔️ 🤯 & ⚒ ⚫️ ⏭ 📄. 👶
|
||||||
|
|
@ -0,0 +1,159 @@
|
||||||
|
# 🏃 💽 ❎ - Uvicorn
|
||||||
|
|
||||||
|
👑 👜 👆 💪 🏃 **FastAPI** 🈸 🛰 💽 🎰 🔫 💽 📋 💖 **Uvicorn**.
|
||||||
|
|
||||||
|
📤 3️⃣ 👑 🎛:
|
||||||
|
|
||||||
|
* <a href="https://www.uvicorn.dev/" class="external-link" target="_blank">Uvicorn</a>: ↕ 🎭 🔫 💽.
|
||||||
|
* <a href="https://hypercorn.readthedocs.io/" class="external-link" target="_blank">Hypercorn</a>: 🔫 💽 🔗 ⏮️ 🇺🇸🔍/2️⃣ & 🎻 👪 🎏 ⚒.
|
||||||
|
* <a href="https://github.com/django/daphne" class="external-link" target="_blank">👸</a>: 🔫 💽 🏗 ✳ 📻.
|
||||||
|
|
||||||
|
## 💽 🎰 & 💽 📋
|
||||||
|
|
||||||
|
📤 🤪 ℹ 🔃 📛 ✔️ 🤯. 👶
|
||||||
|
|
||||||
|
🔤 "**💽**" 🛎 ⚙️ 🔗 👯♂️ 🛰/☁ 💻 (⚛ ⚖️ 🕹 🎰) & 📋 👈 🏃♂ 🔛 👈 🎰 (✅ Uvicorn).
|
||||||
|
|
||||||
|
✔️ 👈 🤯 🕐❔ 👆 ✍ "💽" 🏢, ⚫️ 💪 🔗 1️⃣ 📚 2️⃣ 👜.
|
||||||
|
|
||||||
|
🕐❔ 🔗 🛰 🎰, ⚫️ ⚠ 🤙 ⚫️ **💽**, ✋️ **🎰**, **💾** (🕹 🎰), **🕸**. 👈 🌐 🔗 🆎 🛰 🎰, 🛎 🏃♂ 💾, 🌐❔ 👆 🏃 📋.
|
||||||
|
|
||||||
|
## ❎ 💽 📋
|
||||||
|
|
||||||
|
👆 💪 ❎ 🔫 🔗 💽 ⏮️:
|
||||||
|
|
||||||
|
//// tab | Uvicorn
|
||||||
|
|
||||||
|
* <a href="https://www.uvicorn.dev/" class="external-link" target="_blank">Uvicorn</a>, 🌩-⏩ 🔫 💽, 🏗 🔛 uvloop & httptool.
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install "uvicorn[standard]"
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
❎ `standard`, Uvicorn 🔜 ❎ & ⚙️ 👍 ➕ 🔗.
|
||||||
|
|
||||||
|
👈 ✅ `uvloop`, ↕-🎭 💧-♻ `asyncio`, 👈 🚚 🦏 🛠️ 🎭 📈.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | Hypercorn
|
||||||
|
|
||||||
|
* <a href="https://github.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>, 🔫 💽 🔗 ⏮️ 🇺🇸🔍/2️⃣.
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install hypercorn
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
...⚖️ 🙆 🎏 🔫 💽.
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
## 🏃 💽 📋
|
||||||
|
|
||||||
|
👆 💪 ⤴️ 🏃 👆 🈸 🎏 🌌 👆 ✔️ ⌛ 🔰, ✋️ 🍵 `--reload` 🎛, ✅:
|
||||||
|
|
||||||
|
//// tab | Uvicorn
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --host 0.0.0.0 --port 80
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://0.0.0.0:80 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | Hypercorn
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ hypercorn main:app --bind 0.0.0.0:80
|
||||||
|
|
||||||
|
Running on 0.0.0.0:8080 over http (CTRL + C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
💭 ❎ `--reload` 🎛 🚥 👆 ⚙️ ⚫️.
|
||||||
|
|
||||||
|
`--reload` 🎛 🍴 🌅 🌅 ℹ, 🌅 ⚠, ♒️.
|
||||||
|
|
||||||
|
⚫️ ℹ 📚 ⏮️ **🛠️**, ✋️ 👆 **🚫🔜 🚫** ⚙️ ⚫️ **🏭**.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## Hypercorn ⏮️ 🎻
|
||||||
|
|
||||||
|
💃 & **FastAPI** ⚓️ 🔛 <a href="https://anyio.readthedocs.io/en/stable/" class="external-link" target="_blank">AnyIO</a>, ❔ ⚒ 👫 🔗 ⏮️ 👯♂️ 🐍 🐩 🗃 <a href="https://docs.python.org/3/library/asyncio-task.html" class="external-link" target="_blank">✳</a> & <a href="https://trio.readthedocs.io/en/stable/" class="external-link" target="_blank">🎻</a>.
|
||||||
|
|
||||||
|
👐, Uvicorn ⏳ 🕴 🔗 ⏮️ ✳, & ⚫️ 🛎 ⚙️ <a href="https://github.com/MagicStack/uvloop" class="external-link" target="_blank">`uvloop`</a>, ↕-🎭 💧-♻ `asyncio`.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 💚 🔗 ⚙️ **🎻**, ⤴️ 👆 💪 ⚙️ **Hypercorn** ⚫️ 🐕🦺 ⚫️. 👶
|
||||||
|
|
||||||
|
### ❎ Hypercorn ⏮️ 🎻
|
||||||
|
|
||||||
|
🥇 👆 💪 ❎ Hypercorn ⏮️ 🎻 🐕🦺:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install "hypercorn[trio]"
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
### 🏃 ⏮️ 🎻
|
||||||
|
|
||||||
|
⤴️ 👆 💪 🚶♀️ 📋 ⏸ 🎛 `--worker-class` ⏮️ 💲 `trio`:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ hypercorn main:app --worker-class trio
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
& 👈 🔜 ▶️ Hypercorn ⏮️ 👆 📱 ⚙️ 🎻 👩💻.
|
||||||
|
|
||||||
|
🔜 👆 💪 ⚙️ 🎻 🔘 👆 📱. ⚖️ 👍, 👆 💪 ⚙️ AnyIO, 🚧 👆 📟 🔗 ⏮️ 👯♂️ 🎻 & ✳. 👶
|
||||||
|
|
||||||
|
## 🛠️ 🔧
|
||||||
|
|
||||||
|
👫 🖼 🏃 💽 📋 (📧.Ⓜ Uvicorn), ▶️ **👁 🛠️**, 👂 🔛 🌐 📢 (`0.0.0.0`) 🔛 🔁 ⛴ (✅ `80`).
|
||||||
|
|
||||||
|
👉 🔰 💭. ✋️ 👆 🔜 🎲 💚 ✊ 💅 🌖 👜, 💖:
|
||||||
|
|
||||||
|
* 💂♂ - 🇺🇸🔍
|
||||||
|
* 🏃♂ 🔛 🕴
|
||||||
|
* ⏏
|
||||||
|
* 🧬 (🔢 🛠️ 🏃)
|
||||||
|
* 💾
|
||||||
|
* ⏮️ 🔁 ⏭ ▶️
|
||||||
|
|
||||||
|
👤 🔜 💬 👆 🌅 🔃 🔠 👫 🔧, ❔ 💭 🔃 👫, & 🧱 🖼 ⏮️ 🎛 🍵 👫 ⏭ 📃. 👶
|
||||||
|
|
@ -0,0 +1,181 @@
|
||||||
|
# 💽 👨🏭 - 🐁 ⏮️ Uvicorn
|
||||||
|
|
||||||
|
➡️ ✅ 🔙 👈 🛠️ 🔧 ⚪️➡️ ⏭:
|
||||||
|
|
||||||
|
* 💂♂ - 🇺🇸🔍
|
||||||
|
* 🏃♂ 🔛 🕴
|
||||||
|
* ⏏
|
||||||
|
* **🧬 (🔢 🛠️ 🏃)**
|
||||||
|
* 💾
|
||||||
|
* ⏮️ 🔁 ⏭ ▶️
|
||||||
|
|
||||||
|
🆙 👉 ☝, ⏮️ 🌐 🔰 🩺, 👆 ✔️ 🎲 🏃♂ **💽 📋** 💖 Uvicorn, 🏃♂ **👁 🛠️**.
|
||||||
|
|
||||||
|
🕐❔ 🛠️ 🈸 👆 🔜 🎲 💚 ✔️ **🧬 🛠️** ✊ 📈 **💗 🐚** & 💪 🍵 🌅 📨.
|
||||||
|
|
||||||
|
👆 👀 ⏮️ 📃 🔃 [🛠️ 🔧](concepts.md){.internal-link target=_blank}, 📤 💗 🎛 👆 💪 ⚙️.
|
||||||
|
|
||||||
|
📥 👤 🔜 🎦 👆 ❔ ⚙️ <a href="https://gunicorn.org/" class="external-link" target="_blank">**🐁**</a> ⏮️ **Uvicorn 👨🏭 🛠️**.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 📦, 🖼 ⏮️ ☁ ⚖️ Kubernetes, 👤 🔜 💬 👆 🌅 🔃 👈 ⏭ 📃: [FastAPI 📦 - ☁](docker.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
🎯, 🕐❔ 🏃 🔛 **Kubernetes** 👆 🔜 🎲 **🚫** 💚 ⚙️ 🐁 & ↩️ 🏃 **👁 Uvicorn 🛠️ 📍 📦**, ✋️ 👤 🔜 💬 👆 🔃 ⚫️ ⏪ 👈 📃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🐁 ⏮️ Uvicorn 👨🏭
|
||||||
|
|
||||||
|
**🐁** ✴️ 🈸 💽 ⚙️ **🇨🇻 🐩**. 👈 ⛓ 👈 🐁 💪 🍦 🈸 💖 🏺 & ✳. 🐁 ⚫️ 🚫 🔗 ⏮️ **FastAPI**, FastAPI ⚙️ 🆕 **<a href="https://asgi.readthedocs.io/en/latest/" class="external-link" target="_blank">🔫 🐩</a>**.
|
||||||
|
|
||||||
|
✋️ 🐁 🐕🦺 👷 **🛠️ 👨💼** & 🤝 👩💻 💬 ⚫️ ❔ 🎯 **👨🏭 🛠️ 🎓** ⚙️. ⤴️ 🐁 🔜 ▶️ 1️⃣ ⚖️ 🌖 **👨🏭 🛠️** ⚙️ 👈 🎓.
|
||||||
|
|
||||||
|
& **Uvicorn** ✔️ **🐁-🔗 👨🏭 🎓**.
|
||||||
|
|
||||||
|
⚙️ 👈 🌀, 🐁 🔜 🚫 **🛠️ 👨💼**, 👂 🔛 **⛴** & **📢**. & ⚫️ 🔜 **📶** 📻 👨🏭 🛠️ 🏃 **Uvicorn 🎓**.
|
||||||
|
|
||||||
|
& ⤴️ 🐁-🔗 **Uvicorn 👨🏭** 🎓 🔜 🈚 🏭 📊 📨 🐁 🔫 🐩 FastAPI ⚙️ ⚫️.
|
||||||
|
|
||||||
|
## ❎ 🐁 & Uvicorn
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install "uvicorn[standard]" gunicorn
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
👈 🔜 ❎ 👯♂️ Uvicorn ⏮️ `standard` ➕ 📦 (🤚 ↕ 🎭) & 🐁.
|
||||||
|
|
||||||
|
## 🏃 🐁 ⏮️ Uvicorn 👨🏭
|
||||||
|
|
||||||
|
⤴️ 👆 💪 🏃 🐁 ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ gunicorn main:app --workers 4 --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:80
|
||||||
|
|
||||||
|
[19499] [INFO] Starting gunicorn 20.1.0
|
||||||
|
[19499] [INFO] Listening at: http://0.0.0.0:80 (19499)
|
||||||
|
[19499] [INFO] Using worker: uvicorn.workers.UvicornWorker
|
||||||
|
[19511] [INFO] Booting worker with pid: 19511
|
||||||
|
[19513] [INFO] Booting worker with pid: 19513
|
||||||
|
[19514] [INFO] Booting worker with pid: 19514
|
||||||
|
[19515] [INFO] Booting worker with pid: 19515
|
||||||
|
[19511] [INFO] Started server process [19511]
|
||||||
|
[19511] [INFO] Waiting for application startup.
|
||||||
|
[19511] [INFO] Application startup complete.
|
||||||
|
[19513] [INFO] Started server process [19513]
|
||||||
|
[19513] [INFO] Waiting for application startup.
|
||||||
|
[19513] [INFO] Application startup complete.
|
||||||
|
[19514] [INFO] Started server process [19514]
|
||||||
|
[19514] [INFO] Waiting for application startup.
|
||||||
|
[19514] [INFO] Application startup complete.
|
||||||
|
[19515] [INFO] Started server process [19515]
|
||||||
|
[19515] [INFO] Waiting for application startup.
|
||||||
|
[19515] [INFO] Application startup complete.
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
➡️ 👀 ⚫️❔ 🔠 👈 🎛 ⛓:
|
||||||
|
|
||||||
|
* `main:app`: 👉 🎏 ❕ ⚙️ Uvicorn, `main` ⛓ 🐍 🕹 📛 "`main`",, 📁 `main.py`. & `app` 📛 🔢 👈 **FastAPI** 🈸.
|
||||||
|
* 👆 💪 🌈 👈 `main:app` 🌓 🐍 `import` 📄 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from main import app
|
||||||
|
```
|
||||||
|
|
||||||
|
* , ❤ `main:app` 🔜 🌓 🐍 `import` 🍕 `from main import app`.
|
||||||
|
* `--workers`: 🔢 👨🏭 🛠️ ⚙️, 🔠 🔜 🏃 Uvicorn 👨🏭, 👉 💼, 4️⃣ 👨🏭.
|
||||||
|
* `--worker-class`: 🐁-🔗 👨🏭 🎓 ⚙️ 👨🏭 🛠️.
|
||||||
|
* 📥 👥 🚶♀️ 🎓 👈 🐁 💪 🗄 & ⚙️ ⏮️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
import uvicorn.workers.UvicornWorker
|
||||||
|
```
|
||||||
|
|
||||||
|
* `--bind`: 👉 💬 🐁 📢 & ⛴ 👂, ⚙️ ❤ (`:`) 🎏 📢 & ⛴.
|
||||||
|
* 🚥 👆 🏃♂ Uvicorn 🔗, ↩️ `--bind 0.0.0.0:80` (🐁 🎛) 👆 🔜 ⚙️ `--host 0.0.0.0` & `--port 80`.
|
||||||
|
|
||||||
|
🔢, 👆 💪 👀 👈 ⚫️ 🎦 **🕹** (🛠️ 🆔) 🔠 🛠️ (⚫️ 🔢).
|
||||||
|
|
||||||
|
👆 💪 👀 👈:
|
||||||
|
|
||||||
|
* 🐁 **🛠️ 👨💼** ▶️ ⏮️ 🕹 `19499` (👆 💼 ⚫️ 🔜 🎏 🔢).
|
||||||
|
* ⤴️ ⚫️ ▶️ `Listening at: http://0.0.0.0:80`.
|
||||||
|
* ⤴️ ⚫️ 🔍 👈 ⚫️ ✔️ ⚙️ 👨🏭 🎓 `uvicorn.workers.UvicornWorker`.
|
||||||
|
* & ⤴️ ⚫️ ▶️ **4️⃣ 👨🏭**, 🔠 ⏮️ 🚮 👍 🕹: `19511`, `19513`, `19514`, & `19515`.
|
||||||
|
|
||||||
|
🐁 🔜 ✊ 💅 🛠️ **☠️ 🛠️** & **🔁** 🆕 🕐 🚥 💚 🚧 🔢 👨🏭. 👈 ℹ 🍕 ⏮️ **⏏** 🔧 ⚪️➡️ 📇 🔛.
|
||||||
|
|
||||||
|
👐, 👆 🔜 🎲 💚 ✔️ 🕳 🏞 ⚒ 💭 **⏏ 🐁** 🚥 💪, & **🏃 ⚫️ 🔛 🕴**, ♒️.
|
||||||
|
|
||||||
|
## Uvicorn ⏮️ 👨🏭
|
||||||
|
|
||||||
|
Uvicorn ✔️ 🎛 ▶️ & 🏃 📚 **👨🏭 🛠️**.
|
||||||
|
|
||||||
|
👐, 🔜, Uvicorn 🛠️ 🚚 👨🏭 🛠️ 🌅 📉 🌘 🐁. , 🚥 👆 💚 ✔️ 🛠️ 👨💼 👉 🎚 (🐍 🎚), ⤴️ ⚫️ 💪 👍 🔄 ⏮️ 🐁 🛠️ 👨💼.
|
||||||
|
|
||||||
|
🙆 💼, 👆 🔜 🏃 ⚫️ 💖 👉:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --host 0.0.0.0 --port 8080 --workers 4
|
||||||
|
<font color="#A6E22E">INFO</font>: Uvicorn running on <b>http://0.0.0.0:8080</b> (Press CTRL+C to quit)
|
||||||
|
<font color="#A6E22E">INFO</font>: Started parent process [<font color="#A1EFE4"><b>27365</b></font>]
|
||||||
|
<font color="#A6E22E">INFO</font>: Started server process [<font color="#A1EFE4">27368</font>]
|
||||||
|
<font color="#A6E22E">INFO</font>: Waiting for application startup.
|
||||||
|
<font color="#A6E22E">INFO</font>: Application startup complete.
|
||||||
|
<font color="#A6E22E">INFO</font>: Started server process [<font color="#A1EFE4">27369</font>]
|
||||||
|
<font color="#A6E22E">INFO</font>: Waiting for application startup.
|
||||||
|
<font color="#A6E22E">INFO</font>: Application startup complete.
|
||||||
|
<font color="#A6E22E">INFO</font>: Started server process [<font color="#A1EFE4">27370</font>]
|
||||||
|
<font color="#A6E22E">INFO</font>: Waiting for application startup.
|
||||||
|
<font color="#A6E22E">INFO</font>: Application startup complete.
|
||||||
|
<font color="#A6E22E">INFO</font>: Started server process [<font color="#A1EFE4">27367</font>]
|
||||||
|
<font color="#A6E22E">INFO</font>: Waiting for application startup.
|
||||||
|
<font color="#A6E22E">INFO</font>: Application startup complete.
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
🕴 🆕 🎛 📥 `--workers` 💬 Uvicorn ▶️ 4️⃣ 👨🏭 🛠️.
|
||||||
|
|
||||||
|
👆 💪 👀 👈 ⚫️ 🎦 **🕹** 🔠 🛠️, `27365` 👪 🛠️ (👉 **🛠️ 👨💼**) & 1️⃣ 🔠 👨🏭 🛠️: `27368`, `27369`, `27370`, & `27367`.
|
||||||
|
|
||||||
|
## 🛠️ 🔧
|
||||||
|
|
||||||
|
📥 👆 👀 ❔ ⚙️ **🐁** (⚖️ Uvicorn) 🛠️ **Uvicorn 👨🏭 🛠️** **🔁** 🛠️ 🈸, ✊ 📈 **💗 🐚** 💽, & 💪 🍦 **🌅 📨**.
|
||||||
|
|
||||||
|
⚪️➡️ 📇 🛠️ 🔧 ⚪️➡️ 🔛, ⚙️ 👨🏭 🔜 ✴️ ℹ ⏮️ **🧬** 🍕, & 🐥 🍖 ⏮️ **⏏**, ✋️ 👆 💪 ✊ 💅 🎏:
|
||||||
|
|
||||||
|
* **💂♂ - 🇺🇸🔍**
|
||||||
|
* **🏃♂ 🔛 🕴**
|
||||||
|
* ***⏏***
|
||||||
|
* 🧬 (🔢 🛠️ 🏃)
|
||||||
|
* **💾**
|
||||||
|
* **⏮️ 🔁 ⏭ ▶️**
|
||||||
|
|
||||||
|
## 📦 & ☁
|
||||||
|
|
||||||
|
⏭ 📃 🔃 [FastAPI 📦 - ☁](docker.md){.internal-link target=_blank} 👤 🔜 💬 🎛 👆 💪 ⚙️ 🍵 🎏 **🛠️ 🔧**.
|
||||||
|
|
||||||
|
👤 🔜 🎦 👆 **🛂 ☁ 🖼** 👈 🔌 **🐁 ⏮️ Uvicorn 👨🏭** & 🔢 📳 👈 💪 ⚠ 🙅 💼.
|
||||||
|
|
||||||
|
📤 👤 🔜 🎦 👆 ❔ **🏗 👆 👍 🖼 ⚪️➡️ 🖌** 🏃 👁 Uvicorn 🛠️ (🍵 🐁). ⚫️ 🙅 🛠️ & 🎲 ⚫️❔ 👆 🔜 💚 🕐❔ ⚙️ 📎 📦 🧾 ⚙️ 💖 **Kubernetes**.
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
👆 💪 ⚙️ **🐁** (⚖️ Uvicorn) 🛠️ 👨💼 ⏮️ Uvicorn 👨🏭 ✊ 📈 **👁-🐚 💽**, 🏃 **💗 🛠️ 🔗**.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 👉 🧰 & 💭 🚥 👆 ⚒ 🆙 **👆 👍 🛠️ ⚙️** ⏪ ✊ 💅 🎏 🛠️ 🔧 👆.
|
||||||
|
|
||||||
|
✅ 👅 ⏭ 📃 💡 🔃 **FastAPI** ⏮️ 📦 (✅ ☁ & Kubernetes). 👆 🔜 👀 👈 👈 🧰 ✔️ 🙅 🌌 ❎ 🎏 **🛠️ 🔧** 👍. 👶
|
||||||
|
|
@ -0,0 +1,93 @@
|
||||||
|
# 🔃 FastAPI ⏬
|
||||||
|
|
||||||
|
**FastAPI** ⏪ ➖ ⚙️ 🏭 📚 🈸 & ⚙️. & 💯 💰 🚧 1️⃣0️⃣0️⃣ 💯. ✋️ 🚮 🛠️ 🚚 🔜.
|
||||||
|
|
||||||
|
🆕 ⚒ 🚮 🛎, 🐛 🔧 🛎, & 📟 🔁 📉.
|
||||||
|
|
||||||
|
👈 ⚫️❔ ⏮️ ⏬ `0.x.x`, 👉 🎨 👈 🔠 ⏬ 💪 ⚠ ✔️ 💔 🔀. 👉 ⏩ <a href="https://semver.org/" class="external-link" target="_blank">⚛ 🛠️</a> 🏛.
|
||||||
|
|
||||||
|
👆 💪 ✍ 🏭 🈸 ⏮️ **FastAPI** ▶️️ 🔜 (& 👆 ✔️ 🎲 🔨 ⚫️ 🕰), 👆 ✔️ ⚒ 💭 👈 👆 ⚙️ ⏬ 👈 👷 ☑ ⏮️ 🎂 👆 📟.
|
||||||
|
|
||||||
|
## 📌 👆 `fastapi` ⏬
|
||||||
|
|
||||||
|
🥇 👜 👆 🔜 "📌" ⏬ **FastAPI** 👆 ⚙️ 🎯 📰 ⏬ 👈 👆 💭 👷 ☑ 👆 🈸.
|
||||||
|
|
||||||
|
🖼, ➡️ 💬 👆 ⚙️ ⏬ `0.45.0` 👆 📱.
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ `requirements.txt` 📁 👆 💪 ✔ ⏬ ⏮️:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
fastapi==0.45.0
|
||||||
|
```
|
||||||
|
|
||||||
|
👈 🔜 ⛓ 👈 👆 🔜 ⚙️ ⚫️❔ ⏬ `0.45.0`.
|
||||||
|
|
||||||
|
⚖️ 👆 💪 📌 ⚫️ ⏮️:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
fastapi>=0.45.0,<0.46.0
|
||||||
|
```
|
||||||
|
|
||||||
|
👈 🔜 ⛓ 👈 👆 🔜 ⚙️ ⏬ `0.45.0` ⚖️ 🔛, ✋️ 🌘 🌘 `0.46.0`, 🖼, ⏬ `0.45.2` 🔜 🚫.
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 🙆 🎏 🧰 🛠️ 👆 👷♂, 💖 🎶, Pipenv, ⚖️ 🎏, 👫 🌐 ✔️ 🌌 👈 👆 💪 ⚙️ 🔬 🎯 ⏬ 👆 📦.
|
||||||
|
|
||||||
|
## 💪 ⏬
|
||||||
|
|
||||||
|
👆 💪 👀 💪 ⏬ (✅ ✅ ⚫️❔ ⏮️ 📰) [🚀 🗒](../release-notes.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
## 🔃 ⏬
|
||||||
|
|
||||||
|
📄 ⚛ 🛠️ 🏛, 🙆 ⏬ 🔛 `1.0.0` 💪 ⚠ 🚮 💔 🔀.
|
||||||
|
|
||||||
|
FastAPI ⏩ 🏛 👈 🙆 "🐛" ⏬ 🔀 🐛 🔧 & 🚫-💔 🔀.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
"🐛" 🏁 🔢, 🖼, `0.2.3`, 🐛 ⏬ `3`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
, 👆 🔜 💪 📌 ⏬ 💖:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
fastapi>=0.45.0,<0.46.0
|
||||||
|
```
|
||||||
|
|
||||||
|
💔 🔀 & 🆕 ⚒ 🚮 "🇺🇲" ⏬.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
"🇺🇲" 🔢 🖕, 🖼, `0.2.3`, 🇺🇲 ⏬ `2`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ♻ FastAPI ⏬
|
||||||
|
|
||||||
|
👆 🔜 🚮 💯 👆 📱.
|
||||||
|
|
||||||
|
⏮️ **FastAPI** ⚫️ 📶 ⏩ (👏 💃), ✅ 🩺: [🔬](../tutorial/testing.md){.internal-link target=_blank}
|
||||||
|
|
||||||
|
⏮️ 👆 ✔️ 💯, ⤴️ 👆 💪 ♻ **FastAPI** ⏬ 🌖 ⏮️ 1️⃣, & ⚒ 💭 👈 🌐 👆 📟 👷 ☑ 🏃 👆 💯.
|
||||||
|
|
||||||
|
🚥 🌐 👷, ⚖️ ⏮️ 👆 ⚒ 💪 🔀, & 🌐 👆 💯 🚶♀️, ⤴️ 👆 💪 📌 👆 `fastapi` 👈 🆕 ⏮️ ⏬.
|
||||||
|
|
||||||
|
## 🔃 💃
|
||||||
|
|
||||||
|
👆 🚫🔜 🚫 📌 ⏬ `starlette`.
|
||||||
|
|
||||||
|
🎏 ⏬ **FastAPI** 🔜 ⚙️ 🎯 🆕 ⏬ 💃.
|
||||||
|
|
||||||
|
, 👆 💪 ➡️ **FastAPI** ⚙️ ☑ 💃 ⏬.
|
||||||
|
|
||||||
|
## 🔃 Pydantic
|
||||||
|
|
||||||
|
Pydantic 🔌 💯 **FastAPI** ⏮️ 🚮 👍 💯, 🆕 ⏬ Pydantic (🔛 `1.0.0`) 🕧 🔗 ⏮️ FastAPI.
|
||||||
|
|
||||||
|
👆 💪 📌 Pydantic 🙆 ⏬ 🔛 `1.0.0` 👈 👷 👆 & 🔛 `2.0.0`.
|
||||||
|
|
||||||
|
🖼:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
pydantic>=1.2.0,<2.0.0
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,201 @@
|
||||||
|
# ⚒
|
||||||
|
|
||||||
|
## FastAPI ⚒
|
||||||
|
|
||||||
|
**FastAPI** 🤝 👆 📄:
|
||||||
|
|
||||||
|
### ⚓️ 🔛 📂 🐩
|
||||||
|
|
||||||
|
* <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank"><strong>🗄</strong></a> 🛠️ 🏗, ✅ 📄 <abbr title="also known as: endpoints, routes">➡</abbr> <abbr title="also known as HTTP methods, as POST, GET, PUT, DELETE">🛠️</abbr>, 🔢, 💪 📨, 💂♂, ♒️.
|
||||||
|
* 🏧 📊 🏷 🧾 ⏮️ <a href="https://json-schema.org/" class="external-link" target="_blank"><strong>🎻 🔗</strong></a> (🗄 ⚫️ 🧢 🔛 🎻 🔗).
|
||||||
|
* 🔧 🤭 👫 🐩, ⏮️ 😔 🔬. ↩️ 👎 🧽 🔛 🔝.
|
||||||
|
* 👉 ✔ ⚙️ 🏧 **👩💻 📟 ⚡** 📚 🇪🇸.
|
||||||
|
|
||||||
|
### 🏧 🩺
|
||||||
|
|
||||||
|
🎓 🛠️ 🧾 & 🔬 🕸 👩💻 🔢. 🛠️ ⚓️ 🔛 🗄, 📤 💗 🎛, 2️⃣ 🔌 🔢.
|
||||||
|
|
||||||
|
* <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank"><strong>🦁 🎚</strong></a>, ⏮️ 🎓 🔬, 🤙 & 💯 👆 🛠️ 🔗 ⚪️➡️ 🖥.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* 🎛 🛠️ 🧾 ⏮️ <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank"><strong>📄</strong></a>.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 🏛 🐍
|
||||||
|
|
||||||
|
⚫️ 🌐 ⚓️ 🔛 🐩 **🐍 3️⃣.6️⃣ 🆎** 📄 (👏 Pydantic). 🙅♂ 🆕 ❕ 💡. 🐩 🏛 🐍.
|
||||||
|
|
||||||
|
🚥 👆 💪 2️⃣ ⏲ ↗️ ❔ ⚙️ 🐍 🆎 (🚥 👆 🚫 ⚙️ FastAPI), ✅ 📏 🔰: [🐍 🆎](python-types.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
👆 ✍ 🐩 🐍 ⏮️ 🆎:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from datetime import date
|
||||||
|
|
||||||
|
from pydantic import BaseModel
|
||||||
|
|
||||||
|
# Declare a variable as a str
|
||||||
|
# and get editor support inside the function
|
||||||
|
def main(user_id: str):
|
||||||
|
return user_id
|
||||||
|
|
||||||
|
|
||||||
|
# A Pydantic model
|
||||||
|
class User(BaseModel):
|
||||||
|
id: int
|
||||||
|
name: str
|
||||||
|
joined: date
|
||||||
|
```
|
||||||
|
|
||||||
|
👈 💪 ⤴️ ⚙️ 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
my_user: User = User(id=3, name="John Doe", joined="2018-07-19")
|
||||||
|
|
||||||
|
second_user_data = {
|
||||||
|
"id": 4,
|
||||||
|
"name": "Mary",
|
||||||
|
"joined": "2018-11-30",
|
||||||
|
}
|
||||||
|
|
||||||
|
my_second_user: User = User(**second_user_data)
|
||||||
|
```
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
`**second_user_data` ⛓:
|
||||||
|
|
||||||
|
🚶♀️ 🔑 & 💲 `second_user_data` #️⃣ 🔗 🔑-💲 ❌, 🌓: `User(id=4, name="Mary", joined="2018-11-30")`
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 👨🎨 🐕🦺
|
||||||
|
|
||||||
|
🌐 🛠️ 🏗 ⏩ & 🏋️ ⚙️, 🌐 🚫 💯 🔛 💗 👨🎨 ⏭ ▶️ 🛠️, 🚚 🏆 🛠️ 💡.
|
||||||
|
|
||||||
|
🏁 🐍 👩💻 🔬 ⚫️ 🆑 <a href="https://www.jetbrains.com/research/python-developers-survey-2017/#tools-and-features" class="external-link" target="_blank">👈 🌅 ⚙️ ⚒ "✍"</a>.
|
||||||
|
|
||||||
|
🎂 **FastAPI** 🛠️ ⚓️ 😌 👈. ✍ 👷 🌐.
|
||||||
|
|
||||||
|
👆 🔜 🛎 💪 👟 🔙 🩺.
|
||||||
|
|
||||||
|
📥 ❔ 👆 👨🎨 💪 ℹ 👆:
|
||||||
|
|
||||||
|
* <a href="https://code.visualstudio.com/" class="external-link" target="_blank">🎙 🎙 📟</a>:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* <a href="https://www.jetbrains.com/pycharm/" class="external-link" target="_blank">🗒</a>:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
👆 🔜 🤚 🛠️ 📟 👆 5️⃣📆 🤔 💪 ⏭. 🖼, `price` 🔑 🔘 🎻 💪 (👈 💪 ✔️ 🐦) 👈 👟 ⚪️➡️ 📨.
|
||||||
|
|
||||||
|
🙅♂ 🌖 ⌨ ❌ 🔑 📛, 👟 🔙 & ➡ 🖖 🩺, ⚖️ 📜 🆙 & 🔽 🔎 🚥 👆 😒 ⚙️ `username` ⚖️ `user_name`.
|
||||||
|
|
||||||
|
### 📏
|
||||||
|
|
||||||
|
⚫️ ✔️ 🤔 **🔢** 🌐, ⏮️ 📦 📳 🌐. 🌐 🔢 💪 👌-🎧 ⚫️❔ 👆 💪 & 🔬 🛠️ 👆 💪.
|
||||||
|
|
||||||
|
✋️ 🔢, ⚫️ 🌐 **"👷"**.
|
||||||
|
|
||||||
|
### 🔬
|
||||||
|
|
||||||
|
* 🔬 🌅 (⚖️ 🌐 ❓) 🐍 **💽 🆎**, 🔌:
|
||||||
|
* 🎻 🎚 (`dict`).
|
||||||
|
* 🎻 🎻 (`list`) ⚖ 🏬 🆎.
|
||||||
|
* 🎻 (`str`) 🏑, 🔬 🕙 & 👟 📐.
|
||||||
|
* 🔢 (`int`, `float`) ⏮️ 🕙 & 👟 💲, ♒️.
|
||||||
|
|
||||||
|
* 🔬 🌅 😍 🆎, 💖:
|
||||||
|
* 📛.
|
||||||
|
* 📧.
|
||||||
|
* 🆔.
|
||||||
|
* ...& 🎏.
|
||||||
|
|
||||||
|
🌐 🔬 🍵 👍-🏛 & 🏋️ **Pydantic**.
|
||||||
|
|
||||||
|
### 💂♂ & 🤝
|
||||||
|
|
||||||
|
💂♂ & 🤝 🛠️. 🍵 🙆 ⚠ ⏮️ 💽 ⚖️ 📊 🏷.
|
||||||
|
|
||||||
|
🌐 💂♂ ⚖ 🔬 🗄, 🔌:
|
||||||
|
|
||||||
|
* 🇺🇸🔍 🔰.
|
||||||
|
* **Oauth2️⃣** (⏮️ **🥙 🤝**). ✅ 🔰 🔛 [Oauth2️⃣ ⏮️ 🥙](tutorial/security/oauth2-jwt.md){.internal-link target=_blank}.
|
||||||
|
* 🛠️ 🔑:
|
||||||
|
* 🎚.
|
||||||
|
* 🔢 🔢.
|
||||||
|
* 🍪, ♒️.
|
||||||
|
|
||||||
|
➕ 🌐 💂♂ ⚒ ⚪️➡️ 💃 (🔌 **🎉 🍪**).
|
||||||
|
|
||||||
|
🌐 🏗 ♻ 🧰 & 🦲 👈 ⏩ 🛠️ ⏮️ 👆 ⚙️, 📊 🏪, 🔗 & ☁ 💽, ♒️.
|
||||||
|
|
||||||
|
### 🔗 💉
|
||||||
|
|
||||||
|
FastAPI 🔌 📶 ⏩ ⚙️, ✋️ 📶 🏋️ <abbr title='also known as "components", "resources", "services", "providers"'><strong>🔗 💉</strong></abbr> ⚙️.
|
||||||
|
|
||||||
|
* 🔗 💪 ✔️ 🔗, 🏗 🔗 ⚖️ **"📊" 🔗**.
|
||||||
|
* 🌐 **🔁 🍵** 🛠️.
|
||||||
|
* 🌐 🔗 💪 🚚 💽 ⚪️➡️ 📨 & **↔ ➡ 🛠️** ⚛ & 🏧 🧾.
|
||||||
|
* **🏧 🔬** *➡ 🛠️* 🔢 🔬 🔗.
|
||||||
|
* 🐕🦺 🏗 👩💻 🤝 ⚙️, **💽 🔗**, ♒️.
|
||||||
|
* **🙅♂ ⚠** ⏮️ 💽, 🕸, ♒️. ✋️ ⏩ 🛠️ ⏮️ 🌐 👫.
|
||||||
|
|
||||||
|
### ♾ "🔌-🔌"
|
||||||
|
|
||||||
|
⚖️ 🎏 🌌, 🙅♂ 💪 👫, 🗄 & ⚙️ 📟 👆 💪.
|
||||||
|
|
||||||
|
🙆 🛠️ 🏗 🙅 ⚙️ (⏮️ 🔗) 👈 👆 💪 ✍ "🔌-" 👆 🈸 2️⃣ ⏸ 📟 ⚙️ 🎏 📊 & ❕ ⚙️ 👆 *➡ 🛠️*.
|
||||||
|
|
||||||
|
### 💯
|
||||||
|
|
||||||
|
* 1️⃣0️⃣0️⃣ 💯 <abbr title="The amount of code that is automatically tested">💯 💰</abbr>.
|
||||||
|
* 1️⃣0️⃣0️⃣ 💯 <abbr title="Python type annotations, with this your editor and external tools can give you better support">🆎 ✍</abbr> 📟 🧢.
|
||||||
|
* ⚙️ 🏭 🈸.
|
||||||
|
|
||||||
|
## 💃 ⚒
|
||||||
|
|
||||||
|
**FastAPI** 🍕 🔗 ⏮️ (& ⚓️ 🔛) <a href="https://www.starlette.dev/" class="external-link" target="_blank"><strong>💃</strong></a>. , 🙆 🌖 💃 📟 👆 ✔️, 🔜 👷.
|
||||||
|
|
||||||
|
`FastAPI` 🤙 🎧-🎓 `Starlette`. , 🚥 👆 ⏪ 💭 ⚖️ ⚙️ 💃, 🌅 🛠️ 🔜 👷 🎏 🌌.
|
||||||
|
|
||||||
|
⏮️ **FastAPI** 👆 🤚 🌐 **💃**'Ⓜ ⚒ (FastAPI 💃 🔛 💊):
|
||||||
|
|
||||||
|
* 🤙 🎆 🎭. ⚫️ <a href="https://github.com/encode/starlette#performance" class="external-link" target="_blank">1️⃣ ⏩ 🐍 🛠️ 💪, 🔛 🇷🇪 ⏮️ **✳** & **🚶**</a>.
|
||||||
|
* ** *️⃣ ** 🐕🦺.
|
||||||
|
* -🛠️ 🖥 📋.
|
||||||
|
* 🕴 & 🤫 🎉.
|
||||||
|
* 💯 👩💻 🏗 🔛 🇸🇲.
|
||||||
|
* **⚜**, 🗜, 🎻 📁, 🎏 📨.
|
||||||
|
* **🎉 & 🍪** 🐕🦺.
|
||||||
|
* 1️⃣0️⃣0️⃣ 💯 💯 💰.
|
||||||
|
* 1️⃣0️⃣0️⃣ 💯 🆎 ✍ ✍.
|
||||||
|
|
||||||
|
## Pydantic ⚒
|
||||||
|
|
||||||
|
**FastAPI** 🍕 🔗 ⏮️ (& ⚓️ 🔛) <a href="https://docs.pydantic.dev/" class="external-link" target="_blank"><strong>Pydantic</strong></a>. , 🙆 🌖 Pydantic 📟 👆 ✔️, 🔜 👷.
|
||||||
|
|
||||||
|
✅ 🔢 🗃 ⚓️ 🔛 Pydantic, <abbr title="Object-Relational Mapper">🐜</abbr>Ⓜ, <abbr title="Object-Document Mapper">🏭</abbr>Ⓜ 💽.
|
||||||
|
|
||||||
|
👉 ⛓ 👈 📚 💼 👆 💪 🚶♀️ 🎏 🎚 👆 🤚 ⚪️➡️ 📨 **🔗 💽**, 🌐 ✔ 🔁.
|
||||||
|
|
||||||
|
🎏 ✔ 🎏 🌌 🤭, 📚 💼 👆 💪 🚶♀️ 🎚 👆 🤚 ⚪️➡️ 💽 **🔗 👩💻**.
|
||||||
|
|
||||||
|
⏮️ **FastAPI** 👆 🤚 🌐 **Pydantic**'Ⓜ ⚒ (FastAPI ⚓️ 🔛 Pydantic 🌐 💽 🚚):
|
||||||
|
|
||||||
|
* **🙅♂ 🔠**:
|
||||||
|
* 🙅♂ 🆕 🔗 🔑 ◾-🇪🇸 💡.
|
||||||
|
* 🚥 👆 💭 🐍 🆎 👆 💭 ❔ ⚙️ Pydantic.
|
||||||
|
* 🤾 🎆 ⏮️ 👆 **<abbr title="Integrated Development Environment, similar to a code editor">💾</abbr>/<abbr title="A program that checks for code errors">🧶</abbr>/🧠**:
|
||||||
|
* ↩️ Pydantic 📊 📊 👐 🎓 👆 🔬; 🚘-🛠️, 🧽, ✍ & 👆 🤔 🔜 🌐 👷 ☑ ⏮️ 👆 ✔ 💽.
|
||||||
|
* ✔ **🏗 📊**:
|
||||||
|
* ⚙️ 🔗 Pydantic 🏷, 🐍 `typing`'Ⓜ `List` & `Dict`, ♒️.
|
||||||
|
* & 💳 ✔ 🏗 💽 🔗 🎯 & 💪 🔬, ✅ & 📄 🎻 🔗.
|
||||||
|
* 👆 💪 ✔️ 🙇 **🐦 🎻** 🎚 & ✔️ 👫 🌐 ✔ & ✍.
|
||||||
|
* **🏧**:
|
||||||
|
* Pydantic ✔ 🛃 📊 🆎 🔬 ⚖️ 👆 💪 ↔ 🔬 ⏮️ 👩🔬 🔛 🏷 🎀 ⏮️ 💳 👨🎨.
|
||||||
|
* 1️⃣0️⃣0️⃣ 💯 💯 💰.
|
||||||
|
|
@ -0,0 +1,269 @@
|
||||||
|
# ℹ FastAPI - 🤚 ℹ
|
||||||
|
|
||||||
|
👆 💖 **FastAPI**❓
|
||||||
|
|
||||||
|
🔜 👆 💖 ℹ FastAPI, 🎏 👩💻, & 📕 ❓
|
||||||
|
|
||||||
|
⚖️ 🔜 👆 💖 🤚 ℹ ⏮️ **FastAPI**❓
|
||||||
|
|
||||||
|
📤 📶 🙅 🌌 ℹ (📚 🔌 1️⃣ ⚖️ 2️⃣ 🖊).
|
||||||
|
|
||||||
|
& 📤 📚 🌌 🤚 ℹ 💁♂️.
|
||||||
|
|
||||||
|
## 👱📔 📰
|
||||||
|
|
||||||
|
👆 💪 👱📔 (🐌) [**FastAPI & 👨👧👦** 📰](newsletter.md){.internal-link target=_blank} 🚧 ℹ 🔃:
|
||||||
|
|
||||||
|
* 📰 🔃 FastAPI & 👨👧👦 👶
|
||||||
|
* 🦮 👶
|
||||||
|
* ⚒ 👶
|
||||||
|
* 💔 🔀 👶
|
||||||
|
* 💁♂ & 🎱 👶
|
||||||
|
|
||||||
|
## ⏩ FastAPI 🔛 👱📔
|
||||||
|
|
||||||
|
<a href="https://x.com/fastapi" class="external-link" target="_blank">⏩ 🐶 Fastapi 🔛 **👱📔**</a> 🤚 📰 📰 🔃 **FastAPI**. 👶
|
||||||
|
|
||||||
|
## ✴ **FastAPI** 📂
|
||||||
|
|
||||||
|
👆 💪 "✴" FastAPI 📂 (🖊 ✴ 🔼 🔝 ▶️️): <a href="https://github.com/fastapi/fastapi" class="external-link" target="_blank">https://github.com/fastapi/fastapi</a>. 👶 👶
|
||||||
|
|
||||||
|
❎ ✴, 🎏 👩💻 🔜 💪 🔎 ⚫️ 🌅 💪 & 👀 👈 ⚫️ ✔️ ⏪ ⚠ 🎏.
|
||||||
|
|
||||||
|
## ⌚ 📂 🗃 🚀
|
||||||
|
|
||||||
|
👆 💪 "⌚" FastAPI 📂 (🖊 "⌚" 🔼 🔝 ▶️️): <a href="https://github.com/fastapi/fastapi" class="external-link" target="_blank">https://github.com/fastapi/fastapi</a>. 👶
|
||||||
|
|
||||||
|
📤 👆 💪 🖊 "🚀 🕴".
|
||||||
|
|
||||||
|
🔨 ⚫️, 👆 🔜 📨 📨 (👆 📧) 🕐❔ 📤 🆕 🚀 (🆕 ⏬) **FastAPI** ⏮️ 🐛 🔧 & 🆕 ⚒.
|
||||||
|
|
||||||
|
## 🔗 ⏮️ 📕
|
||||||
|
|
||||||
|
👆 💪 🔗 ⏮️ <a href="https://tiangolo.com" class="external-link" target="_blank">👤 (🇹🇦 🇩🇬 / `tiangolo`)</a>, 📕.
|
||||||
|
|
||||||
|
👆 💪:
|
||||||
|
|
||||||
|
* <a href="https://github.com/tiangolo" class="external-link" target="_blank">⏩ 👤 🔛 **📂**</a>.
|
||||||
|
* 👀 🎏 📂 ℹ 🏗 👤 ✔️ ✍ 👈 💪 ℹ 👆.
|
||||||
|
* ⏩ 👤 👀 🕐❔ 👤 ✍ 🆕 📂 ℹ 🏗.
|
||||||
|
* <a href="https://x.com/tiangolo" class="external-link" target="_blank">⏩ 👤 🔛 **👱📔**</a> ⚖️ <a href="https://fosstodon.org/@tiangolo" class="external-link" target="_blank">☠</a>.
|
||||||
|
* 💬 👤 ❔ 👆 ⚙️ FastAPI (👤 💌 👂 👈).
|
||||||
|
* 👂 🕐❔ 👤 ⚒ 🎉 ⚖️ 🚀 🆕 🧰.
|
||||||
|
* 👆 💪 <a href="https://x.com/fastapi" class="external-link" target="_blank">⏩ 🐶 Fastapi 🔛 👱📔</a> (🎏 🏧).
|
||||||
|
* <a href="https://www.linkedin.com/in/tiangolo/" class="external-link" target="_blank">🔗 ⏮️ 👤 🔛 **👱📔**</a>.
|
||||||
|
* 👂 🕐❔ 👤 ⚒ 🎉 ⚖️ 🚀 🆕 🧰 (👐 👤 ⚙️ 👱📔 🌖 🛎 🤷 ♂).
|
||||||
|
* ✍ ⚫️❔ 👤 ✍ (⚖️ ⏩ 👤) 🔛 <a href="https://dev.to/tiangolo" class="external-link" target="_blank">**🇸🇲.**</a> ⚖️ <a href="https://medium.com/@tiangolo" class="external-link" target="_blank">**🔉**</a>.
|
||||||
|
* ✍ 🎏 💭, 📄, & ✍ 🔃 🧰 👤 ✔️ ✍.
|
||||||
|
* ⏩ 👤 ✍ 🕐❔ 👤 ✍ 🕳 🆕.
|
||||||
|
|
||||||
|
## 👱📔 🔃 **FastAPI**
|
||||||
|
|
||||||
|
<a href="https://x.com/compose/tweet?text=I'm loving @fastapi because... https://github.com/fastapi/fastapi" class="external-link" target="_blank">👱📔 🔃 **FastAPI**</a> & ➡️ 👤 & 🎏 💭 ⚫️❔ 👆 💖 ⚫️. 👶
|
||||||
|
|
||||||
|
👤 💌 👂 🔃 ❔ **FastAPI** 💆♂ ⚙️, ⚫️❔ 👆 ✔️ 💖 ⚫️, ❔ 🏗/🏢 👆 ⚙️ ⚫️, ♒️.
|
||||||
|
|
||||||
|
## 🗳 FastAPI
|
||||||
|
|
||||||
|
* <a href="https://www.slant.co/options/34241/~fastapi-review" class="external-link" target="_blank">🗳 **FastAPI** 📐</a>.
|
||||||
|
* <a href="https://alternativeto.net/software/fastapi/" class="external-link" target="_blank">🗳 **FastAPI** 📱</a>.
|
||||||
|
* <a href="https://stackshare.io/pypi-fastapi" class="external-link" target="_blank">💬 👆 ⚙️ **FastAPI** 🔛 ℹ</a>.
|
||||||
|
|
||||||
|
## ℹ 🎏 ⏮️ ❔ 📂
|
||||||
|
|
||||||
|
👆 💪 🔄 & ℹ 🎏 ⏮️ 👫 ❔:
|
||||||
|
|
||||||
|
* <a href="https://github.com/fastapi/fastapi/discussions/categories/questions?discussions_q=category%3AQuestions+is%3Aunanswered" class="external-link" target="_blank">📂 💬</a>
|
||||||
|
* <a href="https://github.com/fastapi/fastapi/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aquestion+-label%3Aanswered+" class="external-link" target="_blank">📂 ❔</a>
|
||||||
|
|
||||||
|
📚 💼 👆 5️⃣📆 ⏪ 💭 ❔ 📚 ❔. 👶
|
||||||
|
|
||||||
|
🚥 👆 🤝 📚 👫👫 ⏮️ 👫 ❔, 👆 🔜 ▶️️ 🛂 [FastAPI 🕴](fastapi-people.md#_2){.internal-link target=_blank}. 👶
|
||||||
|
|
||||||
|
💭, 🏆 ⚠ ☝: 🔄 😇. 👫👫 👟 ⏮️ 👫 😩 & 📚 💼 🚫 💭 🏆 🌌, ✋️ 🔄 🏆 👆 💪 😇. 👶
|
||||||
|
|
||||||
|
💭 **FastAPI** 👪 😇 & 👍. 🎏 🕰, 🚫 🚫 🎭 ⚖️ 😛 🎭 ⤵ 🎏. 👥 ✔️ ✊ 💅 🔠 🎏.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
📥 ❔ ℹ 🎏 ⏮️ ❔ (💬 ⚖️ ❔):
|
||||||
|
|
||||||
|
### 🤔 ❔
|
||||||
|
|
||||||
|
* ✅ 🚥 👆 💪 🤔 ⚫️❔ **🎯** & ⚙️ 💼 👨💼 💬.
|
||||||
|
|
||||||
|
* ⤴️ ✅ 🚥 ❔ (⭕ 👪 ❔) **🆑**.
|
||||||
|
|
||||||
|
* 📚 💼 ❔ 💭 🔃 👽 ⚗ ⚪️➡️ 👩💻, ✋️ 📤 💪 **👍** 1️⃣. 🚥 👆 💪 🤔 ⚠ & ⚙️ 💼 👍, 👆 💪 💪 🤔 👍 **🎛 ⚗**.
|
||||||
|
|
||||||
|
* 🚥 👆 💪 🚫 🤔 ❔, 💭 🌖 **ℹ**.
|
||||||
|
|
||||||
|
### 🔬 ⚠
|
||||||
|
|
||||||
|
🌅 💼 & 🏆 ❔ 📤 🕳 🔗 👨💼 **⏮️ 📟**.
|
||||||
|
|
||||||
|
📚 💼 👫 🔜 🕴 📁 🧬 📟, ✋️ 👈 🚫 🥃 **🔬 ⚠**.
|
||||||
|
|
||||||
|
* 👆 💪 💭 👫 🚚 <a href="https://stackoverflow.com/help/minimal-reproducible-example" class="external-link" target="_blank">⭐, 🔬, 🖼</a>, 👈 👆 💪 **📁-📋** & 🏃 🌐 👀 🎏 ❌ ⚖️ 🎭 👫 👀, ⚖️ 🤔 👫 ⚙️ 💼 👍.
|
||||||
|
|
||||||
|
* 🚥 👆 😟 💁♂️ 👍, 👆 💪 🔄 **✍ 🖼** 💖 👈 👆, 🧢 🔛 📛 ⚠. ✔️ 🤯 👈 👉 💪 ✊ 📚 🕰 & ⚫️ 💪 👻 💭 👫 ✍ ⚠ 🥇.
|
||||||
|
|
||||||
|
### 🤔 ⚗
|
||||||
|
|
||||||
|
* ⏮️ 💆♂ 💪 🤔 ❔, 👆 💪 🤝 👫 💪 **❔**.
|
||||||
|
|
||||||
|
* 📚 💼, ⚫️ 👍 🤔 👫 **📈 ⚠ ⚖️ ⚙️ 💼**, ↩️ 📤 5️⃣📆 👍 🌌 ❎ ⚫️ 🌘 ⚫️❔ 👫 🔄.
|
||||||
|
|
||||||
|
### 💭 🔐
|
||||||
|
|
||||||
|
🚥 👫 📨, 📤 ↕ 🤞 👆 🔜 ✔️ ❎ 👫 ⚠, ㊗, **👆 💂**❗ 🦸
|
||||||
|
|
||||||
|
* 🔜, 🚥 👈 ❎ 👫 ⚠, 👆 💪 💭 👫:
|
||||||
|
|
||||||
|
* 📂 💬: ™ 🏤 **❔**.
|
||||||
|
* 📂 ❔: **🔐** ❔**.
|
||||||
|
|
||||||
|
## ⌚ 📂 🗃
|
||||||
|
|
||||||
|
👆 💪 "⌚" FastAPI 📂 (🖊 "⌚" 🔼 🔝 ▶️️): <a href="https://github.com/fastapi/fastapi" class="external-link" target="_blank">https://github.com/fastapi/fastapi</a>. 👶
|
||||||
|
|
||||||
|
🚥 👆 🖊 "👀" ↩️ "🚀 🕴" 👆 🔜 📨 📨 🕐❔ 👱 ✍ 🆕 ❔ ⚖️ ❔. 👆 💪 ✔ 👈 👆 🕴 💚 🚨 🔃 🆕 ❔, ⚖️ 💬, ⚖️ 🎸, ♒️.
|
||||||
|
|
||||||
|
⤴️ 👆 💪 🔄 & ℹ 👫 ❎ 👈 ❔.
|
||||||
|
|
||||||
|
## 💭 ❔
|
||||||
|
|
||||||
|
👆 💪 <a href="https://github.com/fastapi/fastapi/discussions/new?category=questions" class="external-link" target="_blank">✍ 🆕 ❔</a> 📂 🗃, 🖼:
|
||||||
|
|
||||||
|
* 💭 **❔** ⚖️ 💭 🔃 **⚠**.
|
||||||
|
* 🤔 🆕 **⚒**.
|
||||||
|
|
||||||
|
**🗒**: 🚥 👆 ⚫️, ⤴️ 👤 🔜 💭 👆 ℹ 🎏. 👶
|
||||||
|
|
||||||
|
## 📄 🚲 📨
|
||||||
|
|
||||||
|
👆 💪 ℹ 👤 📄 🚲 📨 ⚪️➡️ 🎏.
|
||||||
|
|
||||||
|
🔄, 🙏 🔄 👆 🏆 😇. 👶
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
📥 ⚫️❔ ✔️ 🤯 & ❔ 📄 🚲 📨:
|
||||||
|
|
||||||
|
### 🤔 ⚠
|
||||||
|
|
||||||
|
* 🥇, ⚒ 💭 👆 **🤔 ⚠** 👈 🚲 📨 🔄 ❎. ⚫️ 💪 ✔️ 📏 💬 📂 💬 ⚖️ ❔.
|
||||||
|
|
||||||
|
* 📤 👍 🤞 👈 🚲 📨 🚫 🤙 💪 ↩️ ⚠ 💪 ❎ **🎏 🌌**. ⤴️ 👆 💪 🤔 ⚖️ 💭 🔃 👈.
|
||||||
|
|
||||||
|
### 🚫 😟 🔃 👗
|
||||||
|
|
||||||
|
* 🚫 😟 💁♂️ 🌅 🔃 👜 💖 💕 📧 👗, 👤 🔜 🥬 & 🔗 🛃 💕 ❎.
|
||||||
|
|
||||||
|
* 🚫 😟 🔃 👗 🚫, 📤 ⏪ 🏧 🧰 ✅ 👈.
|
||||||
|
|
||||||
|
& 🚥 📤 🙆 🎏 👗 ⚖️ ⚖ 💪, 👤 🔜 💭 🔗 👈, ⚖️ 👤 🔜 🚮 💕 🔛 🔝 ⏮️ 💪 🔀.
|
||||||
|
|
||||||
|
### ✅ 📟
|
||||||
|
|
||||||
|
* ✅ & ✍ 📟, 👀 🚥 ⚫️ ⚒ 🔑, **🏃 ⚫️ 🌐** & 👀 🚥 ⚫️ 🤙 ❎ ⚠.
|
||||||
|
|
||||||
|
* ⤴️ **🏤** 💬 👈 👆 👈, 👈 ❔ 👤 🔜 💭 👆 🤙 ✅ ⚫️.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
👐, 👤 💪 🚫 🎯 💙 🎸 👈 ✔️ 📚 ✔.
|
||||||
|
|
||||||
|
📚 🕰 ⚫️ ✔️ 🔨 👈 📤 🎸 ⏮️ 3️⃣, 5️⃣ ⚖️ 🌅 ✔, 🎲 ↩️ 📛 😌, ✋️ 🕐❔ 👤 ✅ 🎸, 👫 🤙 💔, ✔️ 🐛, ⚖️ 🚫 ❎ ⚠ 👫 🛄 ❎. 👶
|
||||||
|
|
||||||
|
, ⚫️ 🤙 ⚠ 👈 👆 🤙 ✍ & 🏃 📟, & ➡️ 👤 💭 🏤 👈 👆. 👶
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
* 🚥 🇵🇷 💪 📉 🌌, 👆 💪 💭 👈, ✋️ 📤 🙅♂ 💪 💁♂️ 😟, 📤 5️⃣📆 📚 🤔 ☝ 🎑 (& 👤 🔜 ✔️ 👇 👍 👍 👶), ⚫️ 👻 🚥 👆 💪 🎯 🔛 ⚛ 👜.
|
||||||
|
|
||||||
|
### 💯
|
||||||
|
|
||||||
|
* ℹ 👤 ✅ 👈 🇵🇷 ✔️ **💯**.
|
||||||
|
|
||||||
|
* ✅ 👈 💯 **❌** ⏭ 🇵🇷. 👶
|
||||||
|
|
||||||
|
* ⤴️ ✅ 👈 💯 **🚶♀️** ⏮️ 🇵🇷. 👶
|
||||||
|
|
||||||
|
* 📚 🎸 🚫 ✔️ 💯, 👆 💪 **🎗** 👫 🚮 💯, ⚖️ 👆 💪 **🤔** 💯 👆. 👈 1️⃣ 👜 👈 🍴 🌅 🕰 & 👆 💪 ℹ 📚 ⏮️ 👈.
|
||||||
|
|
||||||
|
* ⤴️ 🏤 ⚫️❔ 👆 🔄, 👈 🌌 👤 🔜 💭 👈 👆 ✅ ⚫️. 👶
|
||||||
|
|
||||||
|
## ✍ 🚲 📨
|
||||||
|
|
||||||
|
👆 💪 [📉](contributing.md){.internal-link target=_blank} ℹ 📟 ⏮️ 🚲 📨, 🖼:
|
||||||
|
|
||||||
|
* 🔧 🤭 👆 🔎 🔛 🧾.
|
||||||
|
* 💰 📄, 📹, ⚖️ 📻 👆 ✍ ⚖️ 🔎 🔃 FastAPI <a href="https://github.com/fastapi/fastapi/edit/master/docs/en/data/external_links.yml" class="external-link" target="_blank">✍ 👉 📁</a>.
|
||||||
|
* ⚒ 💭 👆 🚮 👆 🔗 ▶️ 🔗 📄.
|
||||||
|
* ℹ [💬 🧾](contributing.md#_9){.internal-link target=_blank} 👆 🇪🇸.
|
||||||
|
* 👆 💪 ℹ 📄 ✍ ✍ 🎏.
|
||||||
|
* 🛠️ 🆕 🧾 📄.
|
||||||
|
* 🔧 ♻ ❔/🐛.
|
||||||
|
* ⚒ 💭 🚮 💯.
|
||||||
|
* 🚮 🆕 ⚒.
|
||||||
|
* ⚒ 💭 🚮 💯.
|
||||||
|
* ⚒ 💭 🚮 🧾 🚥 ⚫️ 🔗.
|
||||||
|
|
||||||
|
## ℹ 🚧 FastAPI
|
||||||
|
|
||||||
|
ℹ 👤 🚧 **FastAPI**❗ 👶
|
||||||
|
|
||||||
|
📤 📚 👷, & 🏆 ⚫️, **👆** 💪 ⚫️.
|
||||||
|
|
||||||
|
👑 📋 👈 👆 💪 ▶️️ 🔜:
|
||||||
|
|
||||||
|
* [ℹ 🎏 ⏮️ ❔ 📂](#i){.internal-link target=_blank} (👀 📄 🔛).
|
||||||
|
* [📄 🚲 📨](#i){.internal-link target=_blank} (👀 📄 🔛).
|
||||||
|
|
||||||
|
👈 2️⃣ 📋 ⚫️❔ **🍴 🕰 🏆**. 👈 👑 👷 🏆 FastAPI.
|
||||||
|
|
||||||
|
🚥 👆 💪 ℹ 👤 ⏮️ 👈, **👆 🤝 👤 🚧 FastAPI** & ⚒ 💭 ⚫️ 🚧 **🛠️ ⏩ & 👻**. 👶
|
||||||
|
|
||||||
|
## 🛑 💬
|
||||||
|
|
||||||
|
🛑 👶 <a href="https://discord.gg/VQjSZaeJmf" class="external-link" target="_blank">😧 💬 💽</a> 👶 & 🤙 👅 ⏮️ 🎏 FastAPI 👪.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
❔, 💭 👫 <a href="https://github.com/fastapi/fastapi/discussions/new?category=questions" class="external-link" target="_blank">📂 💬</a>, 📤 🌅 👍 🤞 👆 🔜 📨 ℹ [FastAPI 🕴](fastapi-people.md#_2){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
⚙️ 💬 🕴 🎏 🏢 💬.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🚫 ⚙️ 💬 ❔
|
||||||
|
|
||||||
|
✔️ 🤯 👈 💬 ✔ 🌅 "🆓 💬", ⚫️ ⏩ 💭 ❔ 👈 💁♂️ 🏢 & 🌅 ⚠ ❔,, 👆 💪 🚫 📨 ❔.
|
||||||
|
|
||||||
|
📂, 📄 🔜 🦮 👆 ✍ ▶️️ ❔ 👈 👆 💪 🌖 💪 🤚 👍 ❔, ⚖️ ❎ ⚠ 👆 ⏭ 💬. & 📂 👤 💪 ⚒ 💭 👤 🕧 ❔ 🌐, 🚥 ⚫️ ✊ 🕰. 👤 💪 🚫 🤙 👈 ⏮️ 💬 ⚙️. 👶
|
||||||
|
|
||||||
|
💬 💬 ⚙️ 🚫 💪 📇 📂, ❔ & ❔ 5️⃣📆 🤚 💸 💬. & 🕴 🕐 📂 💯 ▶️️ [FastAPI 🕴](fastapi-people.md#_2){.internal-link target=_blank}, 👆 🔜 🌅 🎲 📨 🌅 🙋 📂.
|
||||||
|
|
||||||
|
🔛 🎏 🚄, 📤 💯 👩💻 💬 ⚙️, 📤 ↕ 🤞 👆 🔜 🔎 👱 💬 📤, 🌖 🌐 🕰. 👶
|
||||||
|
|
||||||
|
## 💰 📕
|
||||||
|
|
||||||
|
👆 💪 💰 🐕🦺 📕 (👤) 🔘 <a href="https://github.com/sponsors/tiangolo" class="external-link" target="_blank">📂 💰</a>.
|
||||||
|
|
||||||
|
📤 👆 💪 🛍 👤 ☕ 👶 👶 💬 👏. 👶
|
||||||
|
|
||||||
|
& 👆 💪 ▶️️ 🥇1st ⚖️ 🌟 💰 FastAPI. 👶 👶
|
||||||
|
|
||||||
|
## 💰 🧰 👈 🏋️ FastAPI
|
||||||
|
|
||||||
|
👆 ✔️ 👀 🧾, FastAPI 🧍 🔛 ⌚ 🐘, 💃 & Pydantic.
|
||||||
|
|
||||||
|
👆 💪 💰:
|
||||||
|
|
||||||
|
* <a href="https://github.com/sponsors/samuelcolvin" class="external-link" target="_blank">✡ 🍏 (Pydantic)</a>
|
||||||
|
* <a href="https://github.com/sponsors/encode" class="external-link" target="_blank">🗜 (💃, Uvicorn)</a>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👏 ❗ 👶
|
||||||
|
|
@ -0,0 +1,79 @@
|
||||||
|
# 📖, 🔧 & 🔮
|
||||||
|
|
||||||
|
🕰 🏁, <a href="https://github.com/fastapi/fastapi/issues/3#issuecomment-454956920" class="external-link" target="_blank"> **FastAPI** 👩💻 💭</a>:
|
||||||
|
|
||||||
|
> ⚫️❔ 📖 👉 🏗 ❓ ⚫️ 😑 ✔️ 👟 ⚪️➡️ 🕳 👌 👩❤👨 🗓️ [...]
|
||||||
|
|
||||||
|
📥 🐥 🍖 👈 📖.
|
||||||
|
|
||||||
|
## 🎛
|
||||||
|
|
||||||
|
👤 ✔️ 🏗 🔗 ⏮️ 🏗 📄 📚 1️⃣2️⃣🗓️ (🎰 🏫, 📎 ⚙️, 🔁 👨🏭, ☁ 💽, ♒️), ↘️ 📚 🏉 👩💻.
|
||||||
|
|
||||||
|
🍕 👈, 👤 💪 🔬, 💯 & ⚙️ 📚 🎛.
|
||||||
|
|
||||||
|
📖 **FastAPI** 👑 🍕 📖 🚮 ⏪.
|
||||||
|
|
||||||
|
🙆♀ 📄 [🎛](alternatives.md){.internal-link target=_blank}:
|
||||||
|
|
||||||
|
<blockquote markdown="1">
|
||||||
|
|
||||||
|
**FastAPI** 🚫🔜 🔀 🚥 🚫 ⏮️ 👷 🎏.
|
||||||
|
|
||||||
|
📤 ✔️ 📚 🧰 ✍ ⏭ 👈 ✔️ ℹ 😮 🚮 🏗.
|
||||||
|
|
||||||
|
👤 ✔️ ❎ 🏗 🆕 🛠️ 📚 1️⃣2️⃣🗓️. 🥇 👤 🔄 ❎ 🌐 ⚒ 📔 **FastAPI** ⚙️ 📚 🎏 🛠️, 🔌-🔌, & 🧰.
|
||||||
|
|
||||||
|
✋️ ☝, 📤 🙅♂ 🎏 🎛 🌘 🏗 🕳 👈 🚚 🌐 👫 ⚒, ✊ 🏆 💭 ⚪️➡️ ⏮️ 🧰, & 🌀 👫 🏆 🌌 💪, ⚙️ 🇪🇸 ⚒ 👈 ➖🚫 💪 ⏭ (🐍 3️⃣.6️⃣ ➕ 🆎 🔑).
|
||||||
|
|
||||||
|
</blockquote>
|
||||||
|
|
||||||
|
## 🔬
|
||||||
|
|
||||||
|
⚙️ 🌐 ⏮️ 🎛 👤 ✔️ 🤞 💡 ⚪️➡️ 🌐 👫, ✊ 💭, & 🌀 👫 🏆 🌌 👤 💪 🔎 👤 & 🏉 👩💻 👤 ✔️ 👷 ⏮️.
|
||||||
|
|
||||||
|
🖼, ⚫️ 🆑 👈 🎲 ⚫️ 🔜 ⚓️ 🔛 🐩 🐍 🆎 🔑.
|
||||||
|
|
||||||
|
, 🏆 🎯 ⚙️ ⏪ ♻ 🐩.
|
||||||
|
|
||||||
|
, ⏭ ▶️ 📟 **FastAPI**, 👤 💸 📚 🗓️ 🎓 🔌 🗄, 🎻 🔗, Oauth2️⃣, ♒️. 🎯 👫 💛, 🔀, & 🔺.
|
||||||
|
|
||||||
|
## 🔧
|
||||||
|
|
||||||
|
⤴️ 👤 💸 🕰 🔧 👩💻 "🛠️" 👤 💚 ✔️ 👩💻 (👩💻 ⚙️ FastAPI).
|
||||||
|
|
||||||
|
👤 💯 📚 💭 🏆 🌟 🐍 👨🎨: 🗒, 🆚 📟, 🎠 🧢 👨🎨.
|
||||||
|
|
||||||
|
🏁 <a href="https://www.jetbrains.com/research/python-developers-survey-2018/#development-tools" class="external-link" target="_blank">🐍 👩💻 🔬</a>, 👈 📔 🔃 8️⃣0️⃣ 💯 👩💻.
|
||||||
|
|
||||||
|
⚫️ ⛓ 👈 **FastAPI** 🎯 💯 ⏮️ 👨🎨 ⚙️ 8️⃣0️⃣ 💯 🐍 👩💻. & 🏆 🎏 👨🎨 😑 👷 ➡, 🌐 🚮 💰 🔜 👷 🌖 🌐 👨🎨.
|
||||||
|
|
||||||
|
👈 🌌 👤 💪 🔎 🏆 🌌 📉 📟 ❎ 🌅 💪, ✔️ 🛠️ 🌐, 🆎 & ❌ ✅, ♒️.
|
||||||
|
|
||||||
|
🌐 🌌 👈 🚚 🏆 🛠️ 💡 🌐 👩💻.
|
||||||
|
|
||||||
|
## 📄
|
||||||
|
|
||||||
|
⏮️ 🔬 📚 🎛, 👤 💭 👈 👤 🔜 ⚙️ <a href="https://docs.pydantic.dev/" class="external-link" target="_blank">**Pydantic**</a> 🚮 📈.
|
||||||
|
|
||||||
|
⤴️ 👤 📉 ⚫️, ⚒ ⚫️ 🍕 🛠️ ⏮️ 🎻 🔗, 🐕🦺 🎏 🌌 🔬 ⚛ 📄, & 📉 👨🎨 🐕🦺 (🆎 ✅, ✍) ⚓️ 🔛 💯 📚 👨🎨.
|
||||||
|
|
||||||
|
⏮️ 🛠️, 👤 📉 <a href="https://www.starlette.dev/" class="external-link" target="_blank">**💃**</a>, 🎏 🔑 📄.
|
||||||
|
|
||||||
|
## 🛠️
|
||||||
|
|
||||||
|
🕰 👤 ▶️ 🏗 **FastAPI** ⚫️, 🏆 🍖 ⏪ 🥉, 🔧 🔬, 📄 & 🧰 🔜, & 💡 🔃 🐩 & 🔧 🆑 & 🍋.
|
||||||
|
|
||||||
|
## 🔮
|
||||||
|
|
||||||
|
👉 ☝, ⚫️ ⏪ 🆑 👈 **FastAPI** ⏮️ 🚮 💭 ➖ ⚠ 📚 👫👫.
|
||||||
|
|
||||||
|
⚫️ 💆♂ 👐 🤭 ⏮️ 🎛 ♣ 📚 ⚙️ 💼 👍.
|
||||||
|
|
||||||
|
📚 👩💻 & 🏉 ⏪ 🪀 🔛 **FastAPI** 👫 🏗 (🔌 👤 & 👇 🏉).
|
||||||
|
|
||||||
|
✋️, 📤 📚 📈 & ⚒ 👟.
|
||||||
|
|
||||||
|
**FastAPI** ✔️ 👑 🔮 ⤴️.
|
||||||
|
|
||||||
|
& [👆 ℹ](help-fastapi.md){.internal-link target=_blank} 📉 👍.
|
||||||
|
|
@ -0,0 +1,56 @@
|
||||||
|
# 🎲 🗄
|
||||||
|
|
||||||
|
🚥 👆 💪, 👆 💪 ⚙️ ⚒ & 🌐 🔢 🔗 🗄 ✔ ⚓️ 🔛 🌐, & ❎ ⚫️ 🍕.
|
||||||
|
|
||||||
|
## 🔃 💂♂, 🔗, & 🩺
|
||||||
|
|
||||||
|
🕵♂ 👆 🧾 👩💻 🔢 🏭 *🚫🔜 🚫* 🌌 🛡 👆 🛠️.
|
||||||
|
|
||||||
|
👈 🚫 🚮 🙆 ➕ 💂♂ 👆 🛠️, *➡ 🛠️* 🔜 💪 🌐❔ 👫.
|
||||||
|
|
||||||
|
🚥 📤 💂♂ ⚠ 👆 📟, ⚫️ 🔜 🔀.
|
||||||
|
|
||||||
|
🕵♂ 🧾 ⚒ ⚫️ 🌅 ⚠ 🤔 ❔ 🔗 ⏮️ 👆 🛠️, & 💪 ⚒ ⚫️ 🌅 ⚠ 👆 ℹ ⚫️ 🏭. ⚫️ 💪 🤔 🎯 📨 <a href="https://en.wikipedia.org/wiki/Security_through_obscurity" class="external-link" target="_blank">💂♂ 🔘 🌌</a>.
|
||||||
|
|
||||||
|
🚥 👆 💚 🔐 👆 🛠️, 📤 📚 👍 👜 👆 💪, 🖼:
|
||||||
|
|
||||||
|
* ⚒ 💭 👆 ✔️ 👍 🔬 Pydantic 🏷 👆 📨 💪 & 📨.
|
||||||
|
* 🔗 🙆 ✔ ✔ & 🔑 ⚙️ 🔗.
|
||||||
|
* 🙅 🏪 🔢 🔐, 🕴 🔐#️⃣.
|
||||||
|
* 🛠️ & ⚙️ 👍-💭 🔐 🧰, 💖 🇸🇲 & 🥙 🤝, ♒️.
|
||||||
|
* 🚮 🌅 🧽 ✔ 🎛 ⏮️ Oauth2️⃣ ↔ 🌐❔ 💪.
|
||||||
|
* ...♒️.
|
||||||
|
|
||||||
|
👐, 👆 5️⃣📆 ✔️ 📶 🎯 ⚙️ 💼 🌐❔ 👆 🤙 💪 ❎ 🛠️ 🩺 🌐 (✅ 🏭) ⚖️ ⚓️ 🔛 📳 ⚪️➡️ 🌐 🔢.
|
||||||
|
|
||||||
|
## 🎲 🗄 ⚪️➡️ ⚒ & 🇨🇻 {
|
||||||
|
|
||||||
|
👆 💪 💪 ⚙️ 🎏 Pydantic ⚒ 🔗 👆 🏗 🗄 & 🩺 ⚜.
|
||||||
|
|
||||||
|
🖼:
|
||||||
|
|
||||||
|
{* ../../docs_src/conditional_openapi/tutorial001.py hl[6,11] *}
|
||||||
|
|
||||||
|
📥 👥 📣 ⚒ `openapi_url` ⏮️ 🎏 🔢 `"/openapi.json"`.
|
||||||
|
|
||||||
|
& ⤴️ 👥 ⚙️ ⚫️ 🕐❔ 🏗 `FastAPI` 📱.
|
||||||
|
|
||||||
|
⤴️ 👆 💪 ❎ 🗄 (✅ 🎚 🩺) ⚒ 🌐 🔢 `OPENAPI_URL` 🛁 🎻, 💖:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ OPENAPI_URL= uvicorn main:app
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
⤴️ 🚥 👆 🚶 📛 `/openapi.json`, `/docs`, ⚖️ `/redoc` 👆 🔜 🤚 `404 Not Found` ❌ 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"detail": "Not Found"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,109 @@
|
||||||
|
# 🛃 📨 & APIRoute 🎓
|
||||||
|
|
||||||
|
💼, 👆 5️⃣📆 💚 🔐 ⚛ ⚙️ `Request` & `APIRoute` 🎓.
|
||||||
|
|
||||||
|
🎯, 👉 5️⃣📆 👍 🎛 ⚛ 🛠️.
|
||||||
|
|
||||||
|
🖼, 🚥 👆 💚 ✍ ⚖️ 🔬 📨 💪 ⏭ ⚫️ 🛠️ 👆 🈸.
|
||||||
|
|
||||||
|
/// danger
|
||||||
|
|
||||||
|
👉 "🏧" ⚒.
|
||||||
|
|
||||||
|
🚥 👆 ▶️ ⏮️ **FastAPI** 👆 💪 💚 🚶 👉 📄.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⚙️ 💼
|
||||||
|
|
||||||
|
⚙️ 💼 🔌:
|
||||||
|
|
||||||
|
* 🏭 🚫-🎻 📨 💪 🎻 (✅ <a href="https://msgpack.org/index.html" class="external-link" target="_blank">`msgpack`</a>).
|
||||||
|
* 🗜 🗜-🗜 📨 💪.
|
||||||
|
* 🔁 🚨 🌐 📨 💪.
|
||||||
|
|
||||||
|
## 🚚 🛃 📨 💪 🔢
|
||||||
|
|
||||||
|
➡️ 👀 ❔ ⚒ ⚙️ 🛃 `Request` 🏿 🗜 🗜 📨.
|
||||||
|
|
||||||
|
& `APIRoute` 🏿 ⚙️ 👈 🛃 📨 🎓.
|
||||||
|
|
||||||
|
### ✍ 🛃 `GzipRequest` 🎓
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👉 🧸 🖼 🎦 ❔ ⚫️ 👷, 🚥 👆 💪 🗜 🐕🦺, 👆 💪 ⚙️ 🚚 [`GzipMiddleware`](../advanced/middleware.md#gzipmiddleware){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🥇, 👥 ✍ `GzipRequest` 🎓, ❔ 🔜 📁 `Request.body()` 👩🔬 🗜 💪 🔍 ☑ 🎚.
|
||||||
|
|
||||||
|
🚥 📤 🙅♂ `gzip` 🎚, ⚫️ 🔜 🚫 🔄 🗜 💪.
|
||||||
|
|
||||||
|
👈 🌌, 🎏 🛣 🎓 💪 🍵 🗜 🗜 ⚖️ 🗜 📨.
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_request_and_route/tutorial001.py hl[8:15] *}
|
||||||
|
|
||||||
|
### ✍ 🛃 `GzipRoute` 🎓
|
||||||
|
|
||||||
|
⏭, 👥 ✍ 🛃 🏿 `fastapi.routing.APIRoute` 👈 🔜 ⚒ ⚙️ `GzipRequest`.
|
||||||
|
|
||||||
|
👉 🕰, ⚫️ 🔜 📁 👩🔬 `APIRoute.get_route_handler()`.
|
||||||
|
|
||||||
|
👉 👩🔬 📨 🔢. & 👈 🔢 ⚫️❔ 🔜 📨 📨 & 📨 📨.
|
||||||
|
|
||||||
|
📥 👥 ⚙️ ⚫️ ✍ `GzipRequest` ⚪️➡️ ⏮️ 📨.
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_request_and_route/tutorial001.py hl[18:26] *}
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
`Request` ✔️ `request.scope` 🔢, 👈 🐍 `dict` ⚗ 🗃 🔗 📨.
|
||||||
|
|
||||||
|
`Request` ✔️ `request.receive`, 👈 🔢 "📨" 💪 📨.
|
||||||
|
|
||||||
|
`scope` `dict` & `receive` 🔢 👯♂️ 🍕 🔫 🔧.
|
||||||
|
|
||||||
|
& 👈 2️⃣ 👜, `scope` & `receive`, ⚫️❔ 💪 ✍ 🆕 `Request` 👐.
|
||||||
|
|
||||||
|
💡 🌅 🔃 `Request` ✅ <a href="https://www.starlette.dev/requests/" class="external-link" target="_blank">💃 🩺 🔃 📨</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🕴 👜 🔢 📨 `GzipRequest.get_route_handler` 🔨 🎏 🗜 `Request` `GzipRequest`.
|
||||||
|
|
||||||
|
🔨 👉, 👆 `GzipRequest` 🔜 ✊ 💅 🗜 📊 (🚥 💪) ⏭ 🚶♀️ ⚫️ 👆 *➡ 🛠️*.
|
||||||
|
|
||||||
|
⏮️ 👈, 🌐 🏭 ⚛ 🎏.
|
||||||
|
|
||||||
|
✋️ ↩️ 👆 🔀 `GzipRequest.body`, 📨 💪 🔜 🔁 🗜 🕐❔ ⚫️ 📐 **FastAPI** 🕐❔ 💪.
|
||||||
|
|
||||||
|
## 🔐 📨 💪 ⚠ 🐕🦺
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
❎ 👉 🎏 ⚠, ⚫️ 🎲 📚 ⏩ ⚙️ `body` 🛃 🐕🦺 `RequestValidationError` ([🚚 ❌](../tutorial/handling-errors.md#requestvalidationerror){.internal-link target=_blank}).
|
||||||
|
|
||||||
|
✋️ 👉 🖼 ☑ & ⚫️ 🎦 ❔ 🔗 ⏮️ 🔗 🦲.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👥 💪 ⚙️ 👉 🎏 🎯 🔐 📨 💪 ⚠ 🐕🦺.
|
||||||
|
|
||||||
|
🌐 👥 💪 🍵 📨 🔘 `try`/`except` 🍫:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_request_and_route/tutorial002.py hl[13,15] *}
|
||||||
|
|
||||||
|
🚥 ⚠ 📉, `Request` 👐 🔜 ↔, 👥 💪 ✍ & ⚒ ⚙️ 📨 💪 🕐❔ 🚚 ❌:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_request_and_route/tutorial002.py hl[16:18] *}
|
||||||
|
|
||||||
|
## 🛃 `APIRoute` 🎓 📻
|
||||||
|
|
||||||
|
👆 💪 ⚒ `route_class` 🔢 `APIRouter`:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_request_and_route/tutorial003.py hl[26] *}
|
||||||
|
|
||||||
|
👉 🖼, *➡ 🛠️* 🔽 `router` 🔜 ⚙️ 🛃 `TimedRoute` 🎓, & 🔜 ✔️ ➕ `X-Response-Time` 🎚 📨 ⏮️ 🕰 ⚫️ ✊ 🏗 📨:
|
||||||
|
|
||||||
|
{* ../../docs_src/custom_request_and_route/tutorial003.py hl[13:20] *}
|
||||||
|
|
@ -0,0 +1,83 @@
|
||||||
|
# ↔ 🗄
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
👉 👍 🏧 ⚒. 👆 🎲 💪 🚶 ⚫️.
|
||||||
|
|
||||||
|
🚥 👆 📄 🔰 - 👩💻 🦮, 👆 💪 🎲 🚶 👉 📄.
|
||||||
|
|
||||||
|
🚥 👆 ⏪ 💭 👈 👆 💪 🔀 🏗 🗄 🔗, 😣 👂.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
📤 💼 🌐❔ 👆 💪 💪 🔀 🏗 🗄 🔗.
|
||||||
|
|
||||||
|
👉 📄 👆 🔜 👀 ❔.
|
||||||
|
|
||||||
|
## 😐 🛠️
|
||||||
|
|
||||||
|
😐 (🔢) 🛠️, ⏩.
|
||||||
|
|
||||||
|
`FastAPI` 🈸 (👐) ✔️ `.openapi()` 👩🔬 👈 📈 📨 🗄 🔗.
|
||||||
|
|
||||||
|
🍕 🈸 🎚 🏗, *➡ 🛠️* `/openapi.json` (⚖️ ⚫️❔ 👆 ⚒ 👆 `openapi_url`) ®.
|
||||||
|
|
||||||
|
⚫️ 📨 🎻 📨 ⏮️ 🏁 🈸 `.openapi()` 👩🔬.
|
||||||
|
|
||||||
|
🔢, ⚫️❔ 👩🔬 `.openapi()` 🔨 ✅ 🏠 `.openapi_schema` 👀 🚥 ⚫️ ✔️ 🎚 & 📨 👫.
|
||||||
|
|
||||||
|
🚥 ⚫️ 🚫, ⚫️ 🏗 👫 ⚙️ 🚙 🔢 `fastapi.openapi.utils.get_openapi`.
|
||||||
|
|
||||||
|
& 👈 🔢 `get_openapi()` 📨 🔢:
|
||||||
|
|
||||||
|
* `title`: 🗄 📛, 🎦 🩺.
|
||||||
|
* `version`: ⏬ 👆 🛠️, ✅ `2.5.0`.
|
||||||
|
* `openapi_version`: ⏬ 🗄 🔧 ⚙️. 🔢, ⏪: `3.0.2`.
|
||||||
|
* `description`: 📛 👆 🛠️.
|
||||||
|
* `routes`: 📇 🛣, 👫 🔠 ® *➡ 🛠️*. 👫 ✊ ⚪️➡️ `app.routes`.
|
||||||
|
|
||||||
|
## 🔑 🔢
|
||||||
|
|
||||||
|
⚙️ ℹ 🔛, 👆 💪 ⚙️ 🎏 🚙 🔢 🏗 🗄 🔗 & 🔐 🔠 🍕 👈 👆 💪.
|
||||||
|
|
||||||
|
🖼, ➡️ 🚮 <a href="https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo" class="external-link" target="_blank">📄 🗄 ↔ 🔌 🛃 🔱</a>.
|
||||||
|
|
||||||
|
### 😐 **FastAPI**
|
||||||
|
|
||||||
|
🥇, ✍ 🌐 👆 **FastAPI** 🈸 🛎:
|
||||||
|
|
||||||
|
{* ../../docs_src/extending_openapi/tutorial001.py hl[1,4,7:9] *}
|
||||||
|
|
||||||
|
### 🏗 🗄 🔗
|
||||||
|
|
||||||
|
⤴️, ⚙️ 🎏 🚙 🔢 🏗 🗄 🔗, 🔘 `custom_openapi()` 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/extending_openapi/tutorial001.py hl[2,15:20] *}
|
||||||
|
|
||||||
|
### 🔀 🗄 🔗
|
||||||
|
|
||||||
|
🔜 👆 💪 🚮 📄 ↔, ❎ 🛃 `x-logo` `info` "🎚" 🗄 🔗:
|
||||||
|
|
||||||
|
{* ../../docs_src/extending_openapi/tutorial001.py hl[21:23] *}
|
||||||
|
|
||||||
|
### 💾 🗄 🔗
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🏠 `.openapi_schema` "💾", 🏪 👆 🏗 🔗.
|
||||||
|
|
||||||
|
👈 🌌, 👆 🈸 🏆 🚫 ✔️ 🏗 🔗 🔠 🕰 👩💻 📂 👆 🛠️ 🩺.
|
||||||
|
|
||||||
|
⚫️ 🔜 🏗 🕴 🕐, & ⤴️ 🎏 💾 🔗 🔜 ⚙️ ⏭ 📨.
|
||||||
|
|
||||||
|
{* ../../docs_src/extending_openapi/tutorial001.py hl[13:14,24:25] *}
|
||||||
|
|
||||||
|
### 🔐 👩🔬
|
||||||
|
|
||||||
|
🔜 👆 💪 ❎ `.openapi()` 👩🔬 ⏮️ 👆 🆕 🔢.
|
||||||
|
|
||||||
|
{* ../../docs_src/extending_openapi/tutorial001.py hl[28] *}
|
||||||
|
|
||||||
|
### ✅ ⚫️
|
||||||
|
|
||||||
|
🕐 👆 🚶 <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a> 👆 🔜 👀 👈 👆 ⚙️ 👆 🛃 🔱 (👉 🖼, **FastAPI**'Ⓜ 🔱):
|
||||||
|
|
||||||
|
<img src="/img/tutorial/extending-openapi/image01.png">
|
||||||
|
|
@ -0,0 +1,60 @@
|
||||||
|
# 🕹
|
||||||
|
|
||||||
|
**FastAPI** ⚓️ 🔛 **🔫** 🐩, ⚫️ 📶 ⏩ 🛠️ 🙆 **🕹** 🗃 🔗 ⏮️ 🔫.
|
||||||
|
|
||||||
|
👆 💪 🌀 😐 FastAPI *➡ 🛠️* ⏮️ 🕹 🔛 🎏 🈸.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
**🕹** ❎ 📶 🎯 ⚙️ 💼.
|
||||||
|
|
||||||
|
⚫️ ✔️ **📈** & **⚠** 🕐❔ 🔬 ⚠ **🕸 🔗**.
|
||||||
|
|
||||||
|
⚒ 💭 👆 🔬 🚥 **💰** 👆 ⚙️ 💼 ⚖ **👐**. 👶
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🕹 🗃
|
||||||
|
|
||||||
|
📥 **🕹** 🗃 👈 ✔️ **🔫** 🐕🦺. 👆 💪 ⚙️ 👫 ⏮️ **FastAPI**:
|
||||||
|
|
||||||
|
* <a href="https://strawberry.rocks/" class="external-link" target="_blank">🍓</a> 👶
|
||||||
|
* ⏮️ <a href="https://strawberry.rocks/docs/integrations/fastapi" class="external-link" target="_blank">🩺 FastAPI</a>
|
||||||
|
* <a href="https://ariadnegraphql.org/" class="external-link" target="_blank">👸</a>
|
||||||
|
* ⏮️ <a href="https://ariadnegraphql.org/docs/fastapi-integration" class="external-link" target="_blank">🩺 FastAPI</a>
|
||||||
|
* <a href="https://tartiflette.io/" class="external-link" target="_blank">🍟</a>
|
||||||
|
* ⏮️ <a href="https://tartiflette.github.io/tartiflette-asgi/" class="external-link" target="_blank">🍟 🔫</a> 🚚 🔫 🛠️
|
||||||
|
* <a href="https://graphene-python.org/" class="external-link" target="_blank">⚗</a>
|
||||||
|
* ⏮️ <a href="https://github.com/ciscorn/starlette-graphene3" class="external-link" target="_blank">💃-Graphene3️⃣</a>
|
||||||
|
|
||||||
|
## 🕹 ⏮️ 🍓
|
||||||
|
|
||||||
|
🚥 👆 💪 ⚖️ 💚 👷 ⏮️ **🕹**, <a href="https://strawberry.rocks/" class="external-link" target="_blank">**🍓**</a> **👍** 🗃 ⚫️ ✔️ 🔧 🔐 **FastAPI** 🔧, ⚫️ 🌐 ⚓️ 🔛 **🆎 ✍**.
|
||||||
|
|
||||||
|
⚓️ 🔛 👆 ⚙️ 💼, 👆 5️⃣📆 💖 ⚙️ 🎏 🗃, ✋️ 🚥 👆 💭 👤, 👤 🔜 🎲 🤔 👆 🔄 **🍓**.
|
||||||
|
|
||||||
|
📥 🤪 🎮 ❔ 👆 💪 🛠️ 🍓 ⏮️ FastAPI:
|
||||||
|
|
||||||
|
{* ../../docs_src/graphql/tutorial001.py hl[3,22,25:26] *}
|
||||||
|
|
||||||
|
👆 💪 💡 🌅 🔃 🍓 <a href="https://strawberry.rocks/" class="external-link" target="_blank">🍓 🧾</a>.
|
||||||
|
|
||||||
|
& 🩺 🔃 <a href="https://strawberry.rocks/docs/integrations/fastapi" class="external-link" target="_blank">🍓 ⏮️ FastAPI</a>.
|
||||||
|
|
||||||
|
## 🗝 `GraphQLApp` ⚪️➡️ 💃
|
||||||
|
|
||||||
|
⏮️ ⏬ 💃 🔌 `GraphQLApp` 🎓 🛠️ ⏮️ <a href="https://graphene-python.org/" class="external-link" target="_blank">⚗</a>.
|
||||||
|
|
||||||
|
⚫️ 😢 ⚪️➡️ 💃, ✋️ 🚥 👆 ✔️ 📟 👈 ⚙️ ⚫️, 👆 💪 💪 **↔** <a href="https://github.com/ciscorn/starlette-graphene3" class="external-link" target="_blank">💃-Graphene3️⃣</a>, 👈 📔 🎏 ⚙️ 💼 & ✔️ **🌖 🌓 🔢**.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 💪 🕹, 👤 🔜 👍 👆 ✅ 👅 <a href="https://strawberry.rocks/" class="external-link" target="_blank">🍓</a>, ⚫️ ⚓️ 🔛 🆎 ✍ ↩️ 🛃 🎓 & 🆎.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 💡 🌅
|
||||||
|
|
||||||
|
👆 💪 💡 🌅 🔃 **🕹** <a href="https://graphql.org/" class="external-link" target="_blank">🛂 🕹 🧾</a>.
|
||||||
|
|
||||||
|
👆 💪 ✍ 🌅 🔃 🔠 👈 🗃 🔬 🔛 👫 🔗.
|
||||||
|
|
@ -0,0 +1,474 @@
|
||||||
|
# FastAPI
|
||||||
|
|
||||||
|
<style>
|
||||||
|
.md-content .md-typeset h1 { display: none; }
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://fastapi.tiangolo.com"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI"></a>
|
||||||
|
</p>
|
||||||
|
<p align="center">
|
||||||
|
<em>FastAPI 🛠️, ↕ 🎭, ⏩ 💡, ⏩ 📟, 🔜 🏭</em>
|
||||||
|
</p>
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://github.com/fastapi/fastapi/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster" target="_blank">
|
||||||
|
<img src="https://github.com/fastapi/fastapi/actions/workflows/test.yml/badge.svg?event=push&branch=master" alt="Test">
|
||||||
|
</a>
|
||||||
|
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/fastapi" target="_blank">
|
||||||
|
<img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/fastapi.svg" alt="Coverage">
|
||||||
|
</a>
|
||||||
|
<a href="https://pypi.org/project/fastapi" target="_blank">
|
||||||
|
<img src="https://img.shields.io/pypi/v/fastapi?color=%2334D058&label=pypi%20package" alt="Package version">
|
||||||
|
</a>
|
||||||
|
<a href="https://pypi.org/project/fastapi" target="_blank">
|
||||||
|
<img src="https://img.shields.io/pypi/pyversions/fastapi.svg?color=%2334D058" alt="Supported Python versions">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**🧾**: <a href="https://fastapi.tiangolo.com" target="_blank">https://fastapi.tiangolo.com</a>
|
||||||
|
|
||||||
|
**ℹ 📟**: <a href="https://github.com/fastapi/fastapi" target="_blank">https://github.com/fastapi/fastapi</a>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
FastAPI 🏛, ⏩ (↕-🎭), 🕸 🛠️ 🏗 🛠️ ⏮️ 🐍 3️⃣.8️⃣ ➕ ⚓️ 🔛 🐩 🐍 🆎 🔑.
|
||||||
|
|
||||||
|
🔑 ⚒:
|
||||||
|
|
||||||
|
* **⏩**: 📶 ↕ 🎭, 🔛 🇷🇪 ⏮️ **✳** & **🚶** (👏 💃 & Pydantic). [1️⃣ ⏩ 🐍 🛠️ 💪](#_15).
|
||||||
|
* **⏩ 📟**: 📈 🚅 🛠️ ⚒ 🔃 2️⃣0️⃣0️⃣ 💯 3️⃣0️⃣0️⃣ 💯. *
|
||||||
|
* **👩❤👨 🐛**: 📉 🔃 4️⃣0️⃣ 💯 🗿 (👩💻) 📉 ❌. *
|
||||||
|
* **🏋️**: 👑 👨🎨 🐕🦺. <abbr title="also known as auto-complete, autocompletion, IntelliSense">🛠️</abbr> 🌐. 🌘 🕰 🛠️.
|
||||||
|
* **⏩**: 🔧 ⏩ ⚙️ & 💡. 🌘 🕰 👂 🩺.
|
||||||
|
* **📏**: 📉 📟 ❎. 💗 ⚒ ⚪️➡️ 🔠 🔢 📄. 👩❤👨 🐛.
|
||||||
|
* **🏋️**: 🤚 🏭-🔜 📟. ⏮️ 🏧 🎓 🧾.
|
||||||
|
* **🐩-⚓️**: ⚓️ 🔛 (& 🍕 🔗 ⏮️) 📂 🐩 🔗: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">🗄</a> (⏪ 💭 🦁) & <a href="https://json-schema.org/" class="external-link" target="_blank">🎻 🔗</a>.
|
||||||
|
|
||||||
|
<small>* ⚖ ⚓️ 🔛 💯 🔛 🔗 🛠️ 🏉, 🏗 🏭 🈸.</small>
|
||||||
|
|
||||||
|
## 💰
|
||||||
|
|
||||||
|
<!-- sponsors -->
|
||||||
|
|
||||||
|
{% if sponsors %}
|
||||||
|
{% for sponsor in sponsors.gold -%}
|
||||||
|
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
||||||
|
{% endfor -%}
|
||||||
|
{%- for sponsor in sponsors.silver -%}
|
||||||
|
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
||||||
|
{% endfor %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<!-- /sponsors -->
|
||||||
|
|
||||||
|
<a href="https://fastapi.tiangolo.com/fastapi-people/#sponsors" class="external-link" target="_blank">🎏 💰</a>
|
||||||
|
|
||||||
|
## 🤔
|
||||||
|
|
||||||
|
"_[...] 👤 ⚙️ **FastAPI** 📚 👫 📆. [...] 👤 🤙 📆 ⚙️ ⚫️ 🌐 👇 🏉 **⚗ 🐕🦺 🤸♂**. 👫 💆♂ 🛠️ 🔘 🐚 **🖥** 🏬 & **📠** 🏬._"
|
||||||
|
|
||||||
|
<div style="text-align: right; margin-right: 10%;">🧿 🇵🇰 - <strong>🤸♂</strong> <a href="https://github.com/fastapi/fastapi/pull/26" target="_blank"><small>(🇦🇪)</small></a></div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
"_👥 🛠️ **FastAPI** 🗃 🤖 **🎂** 💽 👈 💪 🔢 🚚 **🔮**. [👨📛]_"
|
||||||
|
|
||||||
|
<div style="text-align: right; margin-right: 10%;">🇮🇹 🇸🇻, 👨📛 👨📛, & 🇱🇰 🕉 🕉 - <strong>🙃</strong> <a href="https://eng.uber.com/ludwig-v0-2/" target="_blank"><small>(🇦🇪)</small></a></div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
"_**📺** 🙏 📣 📂-ℹ 🚀 👆 **⚔ 🧾** 🎶 🛠️: **📨**❗ [🏗 ⏮️ **FastAPI**]_"
|
||||||
|
|
||||||
|
<div style="text-align: right; margin-right: 10%;">✡ 🍏, 👖 🇪🇸, 🌲 🍏 - <strong>📺</strong> <a href="https://netflixtechblog.com/introducing-dispatch-da4b8a2a8072" target="_blank"><small>(🇦🇪)</small></a></div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
"_👤 🤭 🌕 😄 🔃 **FastAPI**. ⚫️ 🎊 ❗_"
|
||||||
|
|
||||||
|
<div style="text-align: right; margin-right: 10%;">✡ 🇭🇰 - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">🐍 🔢</a> 📻 🦠</strong> <a href="https://x.com/brianokken/status/1112220079972728832" target="_blank"><small>(🇦🇪)</small></a></div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
"_🤙, ⚫️❔ 👆 ✔️ 🏗 👀 💎 💠 & 🇵🇱. 📚 🌌, ⚫️ ⚫️❔ 👤 💚 **🤗** - ⚫️ 🤙 😍 👀 👱 🏗 👈._"
|
||||||
|
|
||||||
|
<div style="text-align: right; margin-right: 10%;">✡ 🗄 - <strong><a href="https://github.com/hugapi/hug" target="_blank">🤗</a> 👼</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(🇦🇪)</small></a></div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
"_🚥 👆 👀 💡 1️⃣ **🏛 🛠️** 🏗 🎂 🔗, ✅ 👅 **FastAPI** [...] ⚫️ ⏩, ⏩ ⚙️ & ⏩ 💡 [...]_"
|
||||||
|
|
||||||
|
"_👥 ✔️ 🎛 🤭 **FastAPI** 👆 **🔗** [...] 👤 💭 👆 🔜 💖 ⚫️ [...]_"
|
||||||
|
|
||||||
|
<div style="text-align: right; margin-right: 10%;">🇱🇨 🇸🇲 - ✡ Honnibal - <strong><a href="https://explosion.ai" target="_blank">💥 👲</a> 🕴 - <a href="https://spacy.io" target="_blank">🌈</a> 👼</strong> <a href="https://x.com/_inesmontani/status/1144173225322143744" target="_blank"><small>(🇦🇪)</small></a> - <a href="https://x.com/honnibal/status/1144031421859655680" target="_blank"><small>(🇦🇪)</small></a></div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
"_🚥 🙆 👀 🏗 🏭 🐍 🛠️, 👤 🔜 🏆 👍 **FastAPI**. ⚫️ **💎 🏗**, **🙅 ⚙️** & **🏆 🛠️**, ⚫️ ✔️ ▶️️ **🔑 🦲** 👆 🛠️ 🥇 🛠️ 🎛 & 🚘 📚 🏧 & 🐕🦺 ✅ 👆 🕹 🔫 👨💻._"
|
||||||
|
|
||||||
|
<div style="text-align: right; margin-right: 10%;">🇹🇦 🍰 - <strong>📻</strong> <a href="https://www.linkedin.com/posts/deonpillsbury_cisco-cx-python-activity-6963242628536487936-trAp/" target="_blank"><small>(🇦🇪)</small></a></div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## **🏎**, FastAPI 🇳🇨
|
||||||
|
|
||||||
|
<a href="https://typer.tiangolo.com" target="_blank"><img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" style="width: 20%;"></a>
|
||||||
|
|
||||||
|
🚥 👆 🏗 <abbr title="Command Line Interface">✳</abbr> 📱 ⚙️ 📶 ↩️ 🕸 🛠️, ✅ 👅 <a href="https://typer.tiangolo.com/" class="external-link" target="_blank">**🏎**</a>.
|
||||||
|
|
||||||
|
**🏎** FastAPI 🐥 👪. & ⚫️ 🎯 **FastAPI 🇳🇨**. 👶 👶 👶
|
||||||
|
|
||||||
|
## 📄
|
||||||
|
|
||||||
|
🐍 3️⃣.7️⃣ ➕
|
||||||
|
|
||||||
|
FastAPI 🧍 🔛 ⌚ 🐘:
|
||||||
|
|
||||||
|
* <a href="https://www.starlette.dev/" class="external-link" target="_blank">💃</a> 🕸 🍕.
|
||||||
|
* <a href="https://docs.pydantic.dev/" class="external-link" target="_blank">Pydantic</a> 📊 🍕.
|
||||||
|
|
||||||
|
## 👷♂
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install "fastapi[standard]"
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
👆 🔜 💪 🔫 💽, 🏭 ✅ <a href="https://www.uvicorn.dev" class="external-link" target="_blank">Uvicorn</a> ⚖️ <a href="https://github.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>.
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ pip install "uvicorn[standard]"
|
||||||
|
|
||||||
|
---> 100%
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## 🖼
|
||||||
|
|
||||||
|
### ✍ ⚫️
|
||||||
|
|
||||||
|
* ✍ 📁 `main.py` ⏮️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from typing import Union
|
||||||
|
|
||||||
|
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: Union[str, None] = None):
|
||||||
|
return {"item_id": item_id, "q": q}
|
||||||
|
```
|
||||||
|
|
||||||
|
<details markdown="1">
|
||||||
|
<summary>⚖️ ⚙️ <code>async def</code>...</summary>
|
||||||
|
|
||||||
|
🚥 👆 📟 ⚙️ `async` / `await`, ⚙️ `async def`:
|
||||||
|
|
||||||
|
```Python hl_lines="9 14"
|
||||||
|
from typing import Union
|
||||||
|
|
||||||
|
from fastapi import FastAPI
|
||||||
|
|
||||||
|
app = FastAPI()
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/")
|
||||||
|
async def read_root():
|
||||||
|
return {"Hello": "World"}
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/items/{item_id}")
|
||||||
|
async def read_item(item_id: int, q: Union[str, None] = None):
|
||||||
|
return {"item_id": item_id, "q": q}
|
||||||
|
```
|
||||||
|
|
||||||
|
**🗒**:
|
||||||
|
|
||||||
|
🚥 👆 🚫 💭, ✅ _"🏃 ❓" _ 📄 🔃 <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank">`async` & `await` 🩺</a>.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### 🏃 ⚫️
|
||||||
|
|
||||||
|
🏃 💽 ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn main:app --reload
|
||||||
|
|
||||||
|
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
INFO: Started reloader process [28720]
|
||||||
|
INFO: Started server process [28722]
|
||||||
|
INFO: Waiting for application startup.
|
||||||
|
INFO: Application startup complete.
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<details markdown="1">
|
||||||
|
<summary>🔃 📋 <code>uvicorn main:app --reload</code>...</summary>
|
||||||
|
|
||||||
|
📋 `uvicorn main:app` 🔗:
|
||||||
|
|
||||||
|
* `main`: 📁 `main.py` (🐍 "🕹").
|
||||||
|
* `app`: 🎚 ✍ 🔘 `main.py` ⏮️ ⏸ `app = FastAPI()`.
|
||||||
|
* `--reload`: ⚒ 💽 ⏏ ⏮️ 📟 🔀. 🕴 👉 🛠️.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### ✅ ⚫️
|
||||||
|
|
||||||
|
📂 👆 🖥 <a href="http://127.0.0.1:8000/items/5?q=somequery" class="external-link" target="_blank">http://127.0.0.1:8000/items/5?q=somequery</a>.
|
||||||
|
|
||||||
|
👆 🔜 👀 🎻 📨:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{"item_id": 5, "q": "somequery"}
|
||||||
|
```
|
||||||
|
|
||||||
|
👆 ⏪ ✍ 🛠️ 👈:
|
||||||
|
|
||||||
|
* 📨 🇺🇸🔍 📨 _➡_ `/` & `/items/{item_id}`.
|
||||||
|
* 👯♂️ _➡_ ✊ `GET` <em>🛠️</em> (💭 🇺🇸🔍 _👩🔬_).
|
||||||
|
* _➡_ `/items/{item_id}` ✔️ _➡ 🔢_ `item_id` 👈 🔜 `int`.
|
||||||
|
* _➡_ `/items/{item_id}` ✔️ 📦 `str` _🔢 = `q`.
|
||||||
|
|
||||||
|
### 🎓 🛠️ 🩺
|
||||||
|
|
||||||
|
🔜 🚶 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
|
||||||
|
|
||||||
|
👆 🔜 👀 🏧 🎓 🛠️ 🧾 (🚚 <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">🦁 🎚</a>):
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 🎛 🛠️ 🩺
|
||||||
|
|
||||||
|
& 🔜, 🚶 <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>.
|
||||||
|
|
||||||
|
👆 🔜 👀 🎛 🏧 🧾 (🚚 <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">📄</a>):
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 🖼 ♻
|
||||||
|
|
||||||
|
🔜 🔀 📁 `main.py` 📨 💪 ⚪️➡️ `PUT` 📨.
|
||||||
|
|
||||||
|
📣 💪 ⚙️ 🐩 🐍 🆎, 👏 Pydantic.
|
||||||
|
|
||||||
|
```Python hl_lines="4 9-12 25-27"
|
||||||
|
from typing import Union
|
||||||
|
|
||||||
|
from fastapi import FastAPI
|
||||||
|
from pydantic import BaseModel
|
||||||
|
|
||||||
|
app = FastAPI()
|
||||||
|
|
||||||
|
|
||||||
|
class Item(BaseModel):
|
||||||
|
name: str
|
||||||
|
price: float
|
||||||
|
is_offer: Union[bool, None] = None
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/")
|
||||||
|
def read_root():
|
||||||
|
return {"Hello": "World"}
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/items/{item_id}")
|
||||||
|
def read_item(item_id: int, q: Union[str, None] = None):
|
||||||
|
return {"item_id": item_id, "q": q}
|
||||||
|
|
||||||
|
|
||||||
|
@app.put("/items/{item_id}")
|
||||||
|
def update_item(item_id: int, item: Item):
|
||||||
|
return {"item_name": item.name, "item_id": item_id}
|
||||||
|
```
|
||||||
|
|
||||||
|
💽 🔜 🔃 🔁 (↩️ 👆 🚮 `--reload` `uvicorn` 📋 🔛).
|
||||||
|
|
||||||
|
### 🎓 🛠️ 🩺 ♻
|
||||||
|
|
||||||
|
🔜 🚶 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
|
||||||
|
|
||||||
|
* 🎓 🛠️ 🧾 🔜 🔁 ℹ, 🔌 🆕 💪:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* 🖊 🔛 🔼 "🔄 ⚫️ 👅", ⚫️ ✔ 👆 🥧 🔢 & 🔗 🔗 ⏮️ 🛠️:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* ⤴️ 🖊 🔛 "🛠️" 🔼, 👩💻 🔢 🔜 🔗 ⏮️ 👆 🛠️, 📨 🔢, 🤚 🏁 & 🎦 👫 🔛 🖥:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 🎛 🛠️ 🩺 ♻
|
||||||
|
|
||||||
|
& 🔜, 🚶 <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>.
|
||||||
|
|
||||||
|
* 🎛 🧾 🔜 🎨 🆕 🔢 🔢 & 💪:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 🌃
|
||||||
|
|
||||||
|
📄, 👆 📣 **🕐** 🆎 🔢, 💪, ♒️. 🔢 🔢.
|
||||||
|
|
||||||
|
👆 👈 ⏮️ 🐩 🏛 🐍 🆎.
|
||||||
|
|
||||||
|
👆 🚫 ✔️ 💡 🆕 ❕, 👩🔬 ⚖️ 🎓 🎯 🗃, ♒️.
|
||||||
|
|
||||||
|
🐩 **🐍 3️⃣.7️⃣ ➕**.
|
||||||
|
|
||||||
|
🖼, `int`:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
item_id: int
|
||||||
|
```
|
||||||
|
|
||||||
|
⚖️ 🌖 🏗 `Item` 🏷:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
item: Item
|
||||||
|
```
|
||||||
|
|
||||||
|
...& ⏮️ 👈 👁 📄 👆 🤚:
|
||||||
|
|
||||||
|
* 👨🎨 🐕🦺, 🔌:
|
||||||
|
* 🛠️.
|
||||||
|
* 🆎 ✅.
|
||||||
|
* 🔬 💽:
|
||||||
|
* 🏧 & 🆑 ❌ 🕐❔ 📊 ❌.
|
||||||
|
* 🔬 🙇 🐦 🎻 🎚.
|
||||||
|
* <abbr title="also known as: serialization, parsing, marshalling">🛠️</abbr> 🔢 💽: 👟 ⚪️➡️ 🕸 🐍 💽 & 🆎. 👂 ⚪️➡️:
|
||||||
|
* 🎻.
|
||||||
|
* ➡ 🔢.
|
||||||
|
* 🔢 🔢.
|
||||||
|
* 🍪.
|
||||||
|
* 🎚.
|
||||||
|
* 📨.
|
||||||
|
* 📁.
|
||||||
|
* <abbr title="also known as: serialization, parsing, marshalling">🛠️</abbr> 🔢 📊: 🗜 ⚪️➡️ 🐍 💽 & 🆎 🕸 💽 (🎻):
|
||||||
|
* 🗜 🐍 🆎 (`str`, `int`, `float`, `bool`, `list`, ♒️).
|
||||||
|
* `datetime` 🎚.
|
||||||
|
* `UUID` 🎚.
|
||||||
|
* 💽 🏷.
|
||||||
|
* ...& 📚 🌖.
|
||||||
|
* 🏧 🎓 🛠️ 🧾, 🔌 2️⃣ 🎛 👩💻 🔢:
|
||||||
|
* 🦁 🎚.
|
||||||
|
* 📄.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👟 🔙 ⏮️ 📟 🖼, **FastAPI** 🔜:
|
||||||
|
|
||||||
|
* ✔ 👈 📤 `item_id` ➡ `GET` & `PUT` 📨.
|
||||||
|
* ✔ 👈 `item_id` 🆎 `int` `GET` & `PUT` 📨.
|
||||||
|
* 🚥 ⚫️ 🚫, 👩💻 🔜 👀 ⚠, 🆑 ❌.
|
||||||
|
* ✅ 🚥 📤 📦 🔢 🔢 📛 `q` ( `http://127.0.0.1:8000/items/foo?q=somequery`) `GET` 📨.
|
||||||
|
* `q` 🔢 📣 ⏮️ `= None`, ⚫️ 📦.
|
||||||
|
* 🍵 `None` ⚫️ 🔜 🚚 (💪 💼 ⏮️ `PUT`).
|
||||||
|
* `PUT` 📨 `/items/{item_id}`, ✍ 💪 🎻:
|
||||||
|
* ✅ 👈 ⚫️ ✔️ ✔ 🔢 `name` 👈 🔜 `str`.
|
||||||
|
* ✅ 👈 ⚫️ ✔️ ✔ 🔢 `price` 👈 ✔️ `float`.
|
||||||
|
* ✅ 👈 ⚫️ ✔️ 📦 🔢 `is_offer`, 👈 🔜 `bool`, 🚥 🎁.
|
||||||
|
* 🌐 👉 🔜 👷 🙇 🐦 🎻 🎚.
|
||||||
|
* 🗜 ⚪️➡️ & 🎻 🔁.
|
||||||
|
* 📄 🌐 ⏮️ 🗄, 👈 💪 ⚙️:
|
||||||
|
* 🎓 🧾 ⚙️.
|
||||||
|
* 🏧 👩💻 📟 ⚡ ⚙️, 📚 🇪🇸.
|
||||||
|
* 🚚 2️⃣ 🎓 🧾 🕸 🔢 🔗.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👥 🖌 🧽, ✋️ 👆 ⏪ 🤚 💭 ❔ ⚫️ 🌐 👷.
|
||||||
|
|
||||||
|
🔄 🔀 ⏸ ⏮️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
return {"item_name": item.name, "item_id": item_id}
|
||||||
|
```
|
||||||
|
|
||||||
|
...⚪️➡️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
... "item_name": item.name ...
|
||||||
|
```
|
||||||
|
|
||||||
|
...:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
... "item_price": item.price ...
|
||||||
|
```
|
||||||
|
|
||||||
|
...& 👀 ❔ 👆 👨🎨 🔜 🚘-🏁 🔢 & 💭 👫 🆎:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
🌅 🏁 🖼 🔌 🌅 ⚒, 👀 <a href="https://fastapi.tiangolo.com/tutorial/">🔰 - 👩💻 🦮</a>.
|
||||||
|
|
||||||
|
**🚘 🚨**: 🔰 - 👩💻 🦮 🔌:
|
||||||
|
|
||||||
|
* 📄 **🔢** ⚪️➡️ 🎏 🎏 🥉: **🎚**, **🍪**, **📨 🏑** & **📁**.
|
||||||
|
* ❔ ⚒ **🔬 ⚛** `maximum_length` ⚖️ `regex`.
|
||||||
|
* 📶 🏋️ & ⏩ ⚙️ **<abbr title="also known as components, resources, providers, services, injectables">🔗 💉</abbr>** ⚙️.
|
||||||
|
* 💂♂ & 🤝, ✅ 🐕🦺 **Oauth2️⃣** ⏮️ **🥙 🤝** & **🇺🇸🔍 🔰** 🔐.
|
||||||
|
* 🌅 🏧 (✋️ 😨 ⏩) ⚒ 📣 **🙇 🐦 🎻 🏷** (👏 Pydantic).
|
||||||
|
* **🕹** 🛠️ ⏮️ <a href="https://strawberry.rocks" class="external-link" target="_blank">🍓</a> & 🎏 🗃.
|
||||||
|
* 📚 ➕ ⚒ (👏 💃):
|
||||||
|
* ** *️⃣ **
|
||||||
|
* 📶 ⏩ 💯 ⚓️ 🔛 🇸🇲 & `pytest`
|
||||||
|
* **⚜**
|
||||||
|
* **🍪 🎉**
|
||||||
|
* ...& 🌖.
|
||||||
|
|
||||||
|
## 🎭
|
||||||
|
|
||||||
|
🔬 🇸🇲 📇 🎦 **FastAPI** 🈸 🏃♂ 🔽 Uvicorn <a href="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7" class="external-link" target="_blank">1️⃣ ⏩ 🐍 🛠️ 💪</a>, 🕴 🔛 💃 & Uvicorn 👫 (⚙️ 🔘 FastAPI). (*)
|
||||||
|
|
||||||
|
🤔 🌖 🔃 ⚫️, 👀 📄 <a href="https://fastapi.tiangolo.com/benchmarks/" class="internal-link" target="_blank">📇</a>.
|
||||||
|
|
||||||
|
## 📦 🔗
|
||||||
|
|
||||||
|
⚙️ Pydantic:
|
||||||
|
|
||||||
|
* <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email-validator</code></a> - 📧 🔬.
|
||||||
|
|
||||||
|
⚙️ 💃:
|
||||||
|
|
||||||
|
* <a href="https://www.python-httpx.org" target="_blank"><code>httpx</code></a> - ✔ 🚥 👆 💚 ⚙️ `TestClient`.
|
||||||
|
* <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - ✔ 🚥 👆 💚 ⚙️ 🔢 📄 📳.
|
||||||
|
* <a href="https://github.com/Kludex/python-multipart" target="_blank"><code>python-multipart</code></a> - ✔ 🚥 👆 💚 🐕🦺 📨 <abbr title="converting the string that comes from an HTTP request into Python data">"✍"</abbr>, ⏮️ `request.form()`.
|
||||||
|
* <a href="https://pythonhosted.org/itsdangerous/" target="_blank"><code>itsdangerous</code></a> - ✔ `SessionMiddleware` 🐕🦺.
|
||||||
|
* <a href="https://pyyaml.org/wiki/PyYAMLDocumentation" target="_blank"><code>pyyaml</code></a> - ✔ 💃 `SchemaGenerator` 🐕🦺 (👆 🎲 🚫 💪 ⚫️ ⏮️ FastAPI).
|
||||||
|
|
||||||
|
⚙️ FastAPI / 💃:
|
||||||
|
|
||||||
|
* <a href="https://www.uvicorn.dev" target="_blank"><code>uvicorn</code></a> - 💽 👈 📐 & 🍦 👆 🈸.
|
||||||
|
* <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - ✔ 🚥 👆 💚 ⚙️ `ORJSONResponse`.
|
||||||
|
* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - ✔ 🚥 👆 💚 ⚙️ `UJSONResponse`.
|
||||||
|
|
||||||
|
👆 💪 ❎ 🌐 👫 ⏮️ `pip install "fastapi[all]"`.
|
||||||
|
|
||||||
|
## 🛂
|
||||||
|
|
||||||
|
👉 🏗 ® 🔽 ⚖ 🇩🇪 🛂.
|
||||||
|
|
@ -0,0 +1,84 @@
|
||||||
|
# 🏗 ⚡ - 📄
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🏗 🚂 🤚 ▶️, ⚫️ 🔌 📚 ▶️ ⚒ 🆙, 💂♂, 💽 & 🛠️ 🔗 ⏪ ⌛ 👆.
|
||||||
|
|
||||||
|
🏗 🚂 🔜 🕧 ✔️ 📶 🙃 🖥 👈 👆 🔜 ℹ & 🛠️ 👆 👍 💪, ✋️ ⚫️ 💪 👍 ▶️ ☝ 👆 🏗.
|
||||||
|
|
||||||
|
## 🌕 📚 FastAPI ✳
|
||||||
|
|
||||||
|
📂: <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql" class="external-link" target="_blank">https://github.com/tiangolo/full-stack-fastapi-postgresql</a>
|
||||||
|
|
||||||
|
### 🌕 📚 FastAPI ✳ - ⚒
|
||||||
|
|
||||||
|
* 🌕 **☁** 🛠️ (☁ 🧢).
|
||||||
|
* ☁ 🐝 📳 🛠️.
|
||||||
|
* **☁ ✍** 🛠️ & 🛠️ 🇧🇿 🛠️.
|
||||||
|
* **🏭 🔜** 🐍 🕸 💽 ⚙️ Uvicorn & 🐁.
|
||||||
|
* 🐍 <a href="https://github.com/fastapi/fastapi" class="external-link" target="_blank">**FastAPI**</a> 👩💻:
|
||||||
|
* **⏩**: 📶 ↕ 🎭, 🔛 🇷🇪 ⏮️ **✳** & **🚶** (👏 💃 & Pydantic).
|
||||||
|
* **🏋️**: 👑 👨🎨 🐕🦺. <abbr title="also known as auto-complete, autocompletion, IntelliSense">🛠️</abbr> 🌐. 🌘 🕰 🛠️.
|
||||||
|
* **⏩**: 🔧 ⏩ ⚙️ & 💡. 🌘 🕰 👂 🩺.
|
||||||
|
* **📏**: 📉 📟 ❎. 💗 ⚒ ⚪️➡️ 🔠 🔢 📄.
|
||||||
|
* **🏋️**: 🤚 🏭-🔜 📟. ⏮️ 🏧 🎓 🧾.
|
||||||
|
* **🐩-⚓️**: ⚓️ 🔛 (& 🍕 🔗 ⏮️) 📂 🐩 🔗: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">🗄</a> & <a href="https://json-schema.org/" class="external-link" target="_blank">🎻 🔗</a>.
|
||||||
|
* <a href="https://fastapi.tiangolo.com/features/" class="external-link" target="_blank">**📚 🎏 ⚒**</a> 🔌 🏧 🔬, 🛠️, 🎓 🧾, 🤝 ⏮️ Oauth2️⃣ 🥙 🤝, ♒️.
|
||||||
|
* **🔐 🔐** 🔁 🔢.
|
||||||
|
* **🥙 🤝** 🤝.
|
||||||
|
* **🇸🇲** 🏷 (🔬 🏺 ↔, 👫 💪 ⚙️ ⏮️ 🥒 👨🏭 🔗).
|
||||||
|
* 🔰 ▶️ 🏷 👩💻 (🔀 & ❎ 👆 💪).
|
||||||
|
* **⚗** 🛠️.
|
||||||
|
* **⚜** (✖️ 🇨🇳 ℹ 🤝).
|
||||||
|
* **🥒** 👨🏭 👈 💪 🗄 & ⚙️ 🏷 & 📟 ⚪️➡️ 🎂 👩💻 🍕.
|
||||||
|
* 🎂 👩💻 💯 ⚓️ 🔛 **✳**, 🛠️ ⏮️ ☁, 👆 💪 💯 🌕 🛠️ 🔗, 🔬 🔛 💽. ⚫️ 🏃 ☁, ⚫️ 💪 🏗 🆕 💽 🏪 ⚪️➡️ 🖌 🔠 🕰 (👆 💪 ⚙️ ✳, ✳, ✳, ⚖️ ⚫️❔ 👆 💚, & 💯 👈 🛠️ 👷).
|
||||||
|
* ⏩ 🐍 🛠️ ⏮️ **📂 💾** 🛰 ⚖️-☁ 🛠️ ⏮️ ↔ 💖 ⚛ ⚗ ⚖️ 🎙 🎙 📟 📂.
|
||||||
|
* **🎦** 🕸:
|
||||||
|
* 🏗 ⏮️ 🎦 ✳.
|
||||||
|
* **🥙 🤝** 🚚.
|
||||||
|
* 💳 🎑.
|
||||||
|
* ⏮️ 💳, 👑 🕹 🎑.
|
||||||
|
* 👑 🕹 ⏮️ 👩💻 🏗 & 📕.
|
||||||
|
* 👤 👩💻 📕.
|
||||||
|
* **🇷🇪**.
|
||||||
|
* **🎦-📻**.
|
||||||
|
* **Vuetify** 🌹 🧽 🔧 🦲.
|
||||||
|
* **📕**.
|
||||||
|
* ☁ 💽 ⚓️ 🔛 **👌** (📶 🤾 🎆 ⏮️ 🎦-📻).
|
||||||
|
* ☁ 👁-▶️ 🏗, 👆 🚫 💪 🖊 ⚖️ 💕 ✍ 📟.
|
||||||
|
* 🕸 💯 🏃 🏗 🕰 (💪 🔕 💁♂️).
|
||||||
|
* ⚒ 🔧 💪, ⚫️ 👷 👅 📦, ✋️ 👆 💪 🏤-🏗 ⏮️ 🎦 ✳ ⚖️ ✍ ⚫️ 👆 💪, & 🏤-⚙️ ⚫️❔ 👆 💚.
|
||||||
|
* ** *️⃣ ** ✳ 💽, 👆 💪 🔀 ⚫️ ⚙️ 📁 & ✳ 💪.
|
||||||
|
* **🥀** 🥒 👨🏭 ⚖.
|
||||||
|
* 📐 ⚖ 🖖 🕸 & 👩💻 ⏮️ **Traefik**, 👆 💪 ✔️ 👯♂️ 🔽 🎏 🆔, 👽 ➡, ✋️ 🍦 🎏 📦.
|
||||||
|
* Traefik 🛠️, ✅ ➡️ 🗜 **🇺🇸🔍** 📄 🏧 ⚡.
|
||||||
|
* ✳ **🆑** (🔁 🛠️), 🔌 🕸 & 👩💻 🔬.
|
||||||
|
|
||||||
|
## 🌕 📚 FastAPI 🗄
|
||||||
|
|
||||||
|
📂: <a href="https://github.com/tiangolo/full-stack-fastapi-couchbase" class="external-link" target="_blank">https://github.com/tiangolo/full-stack-fastapi-couchbase</a>
|
||||||
|
|
||||||
|
👶 👶 **⚠** 👶 👶
|
||||||
|
|
||||||
|
🚥 👆 ▶️ 🆕 🏗 ⚪️➡️ 🖌, ✅ 🎛 📥.
|
||||||
|
|
||||||
|
🖼, 🏗 🚂 <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql" class="external-link" target="_blank">🌕 📚 FastAPI ✳</a> 💪 👍 🎛, ⚫️ 🎯 🚧 & ⚙️. & ⚫️ 🔌 🌐 🆕 ⚒ & 📈.
|
||||||
|
|
||||||
|
👆 🆓 ⚙️ 🗄-⚓️ 🚂 🚥 👆 💚, ⚫️ 🔜 🎲 👷 👌, & 🚥 👆 ⏪ ✔️ 🏗 🏗 ⏮️ ⚫️ 👈 👌 👍 (& 👆 🎲 ⏪ ℹ ⚫️ ♣ 👆 💪).
|
||||||
|
|
||||||
|
👆 💪 ✍ 🌅 🔃 ⚫️ 🩺 🏦.
|
||||||
|
|
||||||
|
## 🌕 📚 FastAPI ✳
|
||||||
|
|
||||||
|
...💪 👟 ⏪, ⚓️ 🔛 👇 🕰 🚚 & 🎏 ⚖. 👶 👶
|
||||||
|
|
||||||
|
## 🎰 🏫 🏷 ⏮️ 🌈 & FastAPI
|
||||||
|
|
||||||
|
📂: <a href="https://github.com/microsoft/cookiecutter-spacy-fastapi" class="external-link" target="_blank">https://github.com/microsoft/cookiecutter-spacy-fastapi</a>
|
||||||
|
|
||||||
|
### 🎰 🏫 🏷 ⏮️ 🌈 & FastAPI - ⚒
|
||||||
|
|
||||||
|
* **🌈** 🕜 🏷 🛠️.
|
||||||
|
* **☁ 🧠 🔎** 📨 📁 🏗.
|
||||||
|
* **🏭 🔜** 🐍 🕸 💽 ⚙️ Uvicorn & 🐁.
|
||||||
|
* **☁ 👩💻** Kubernetes (🦲) 🆑/💿 🛠️ 🏗.
|
||||||
|
* **🤸♂** 💪 ⚒ 1️⃣ 🌈 🏗 🇪🇸 ⏮️ 🏗 🖥.
|
||||||
|
* **💪 🏧** 🎏 🏷 🛠️ (Pytorch, 🇸🇲), 🚫 🌈.
|
||||||
|
|
@ -0,0 +1,542 @@
|
||||||
|
# 🐍 🆎 🎶
|
||||||
|
|
||||||
|
🐍 ✔️ 🐕🦺 📦 "🆎 🔑".
|
||||||
|
|
||||||
|
👫 **"🆎 🔑"** 🎁 ❕ 👈 ✔ 📣 <abbr title="for example: str, int, float, bool">🆎</abbr> 🔢.
|
||||||
|
|
||||||
|
📣 🆎 👆 🔢, 👨🎨 & 🧰 💪 🤝 👆 👍 🐕🦺.
|
||||||
|
|
||||||
|
👉 **⏩ 🔰 / ↗️** 🔃 🐍 🆎 🔑. ⚫️ 📔 🕴 💯 💪 ⚙️ 👫 ⏮️ **FastAPI**... ❔ 🤙 📶 🐥.
|
||||||
|
|
||||||
|
**FastAPI** 🌐 ⚓️ 🔛 👫 🆎 🔑, 👫 🤝 ⚫️ 📚 📈 & 💰.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 🙅 ⚙️ **FastAPI**, 👆 🔜 💰 ⚪️➡️ 🏫 🍖 🔃 👫.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
🚥 👆 🐍 🕴, & 👆 ⏪ 💭 🌐 🔃 🆎 🔑, 🚶 ⏭ 📃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🎯
|
||||||
|
|
||||||
|
➡️ ▶️ ⏮️ 🙅 🖼:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!../../docs_src/python_types/tutorial001.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
🤙 👉 📋 🔢:
|
||||||
|
|
||||||
|
```
|
||||||
|
John Doe
|
||||||
|
```
|
||||||
|
|
||||||
|
🔢 🔨 📄:
|
||||||
|
|
||||||
|
* ✊ `first_name` & `last_name`.
|
||||||
|
* 🗜 🥇 🔤 🔠 1️⃣ ↖ 💼 ⏮️ `title()`.
|
||||||
|
* <abbr title="Puts them together, as one. With the contents of one after the other.">🔢</abbr> 👫 ⏮️ 🚀 🖕.
|
||||||
|
|
||||||
|
```Python hl_lines="2"
|
||||||
|
{!../../docs_src/python_types/tutorial001.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
### ✍ ⚫️
|
||||||
|
|
||||||
|
⚫️ 📶 🙅 📋.
|
||||||
|
|
||||||
|
✋️ 🔜 🌈 👈 👆 ✍ ⚫️ ⚪️➡️ 🖌.
|
||||||
|
|
||||||
|
☝ 👆 🔜 ✔️ ▶️ 🔑 🔢, 👆 ✔️ 🔢 🔜...
|
||||||
|
|
||||||
|
✋️ ⤴️ 👆 ✔️ 🤙 "👈 👩🔬 👈 🗜 🥇 🔤 ↖ 💼".
|
||||||
|
|
||||||
|
⚫️ `upper`❓ ⚫️ `uppercase`❓ `first_uppercase`❓ `capitalize`❓
|
||||||
|
|
||||||
|
⤴️, 👆 🔄 ⏮️ 🗝 👩💻 👨👧👦, 👨🎨 ✍.
|
||||||
|
|
||||||
|
👆 🆎 🥇 🔢 🔢, `first_name`, ⤴️ ❣ (`.`) & ⤴️ 🎯 `Ctrl+Space` ⏲ 🛠️.
|
||||||
|
|
||||||
|
✋️, 😞, 👆 🤚 🕳 ⚠:
|
||||||
|
|
||||||
|
<img src="/img/python-types/image01.png">
|
||||||
|
|
||||||
|
### 🚮 🆎
|
||||||
|
|
||||||
|
➡️ 🔀 👁 ⏸ ⚪️➡️ ⏮️ ⏬.
|
||||||
|
|
||||||
|
👥 🔜 🔀 ⚫️❔ 👉 🧬, 🔢 🔢, ⚪️➡️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
first_name, last_name
|
||||||
|
```
|
||||||
|
|
||||||
|
:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
first_name: str, last_name: str
|
||||||
|
```
|
||||||
|
|
||||||
|
👈 ⚫️.
|
||||||
|
|
||||||
|
👈 "🆎 🔑":
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!../../docs_src/python_types/tutorial002.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
👈 🚫 🎏 📣 🔢 💲 💖 🔜 ⏮️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
first_name="john", last_name="doe"
|
||||||
|
```
|
||||||
|
|
||||||
|
⚫️ 🎏 👜.
|
||||||
|
|
||||||
|
👥 ⚙️ ❤ (`:`), 🚫 🌓 (`=`).
|
||||||
|
|
||||||
|
& ❎ 🆎 🔑 🛎 🚫 🔀 ⚫️❔ 🔨 ⚪️➡️ ⚫️❔ 🔜 🔨 🍵 👫.
|
||||||
|
|
||||||
|
✋️ 🔜, 🌈 👆 🔄 🖕 🏗 👈 🔢, ✋️ ⏮️ 🆎 🔑.
|
||||||
|
|
||||||
|
🎏 ☝, 👆 🔄 ⏲ 📋 ⏮️ `Ctrl+Space` & 👆 👀:
|
||||||
|
|
||||||
|
<img src="/img/python-types/image02.png">
|
||||||
|
|
||||||
|
⏮️ 👈, 👆 💪 📜, 👀 🎛, ⏭ 👆 🔎 1️⃣ 👈 "💍 🔔":
|
||||||
|
|
||||||
|
<img src="/img/python-types/image03.png">
|
||||||
|
|
||||||
|
## 🌅 🎯
|
||||||
|
|
||||||
|
✅ 👉 🔢, ⚫️ ⏪ ✔️ 🆎 🔑:
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!../../docs_src/python_types/tutorial003.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
↩️ 👨🎨 💭 🆎 🔢, 👆 🚫 🕴 🤚 🛠️, 👆 🤚 ❌ ✅:
|
||||||
|
|
||||||
|
<img src="/img/python-types/image04.png">
|
||||||
|
|
||||||
|
🔜 👆 💭 👈 👆 ✔️ 🔧 ⚫️, 🗜 `age` 🎻 ⏮️ `str(age)`:
|
||||||
|
|
||||||
|
```Python hl_lines="2"
|
||||||
|
{!../../docs_src/python_types/tutorial004.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📣 🆎
|
||||||
|
|
||||||
|
👆 👀 👑 🥉 📣 🆎 🔑. 🔢 🔢.
|
||||||
|
|
||||||
|
👉 👑 🥉 👆 🔜 ⚙️ 👫 ⏮️ **FastAPI**.
|
||||||
|
|
||||||
|
### 🙅 🆎
|
||||||
|
|
||||||
|
👆 💪 📣 🌐 🐩 🐍 🆎, 🚫 🕴 `str`.
|
||||||
|
|
||||||
|
👆 💪 ⚙️, 🖼:
|
||||||
|
|
||||||
|
* `int`
|
||||||
|
* `float`
|
||||||
|
* `bool`
|
||||||
|
* `bytes`
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!../../docs_src/python_types/tutorial005.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 💊 🆎 ⏮️ 🆎 🔢
|
||||||
|
|
||||||
|
📤 📊 📊 👈 💪 🔌 🎏 💲, 💖 `dict`, `list`, `set` & `tuple`. & 🔗 💲 💪 ✔️ 👫 👍 🆎 💁♂️.
|
||||||
|
|
||||||
|
👉 🆎 👈 ✔️ 🔗 🆎 🤙 "**💊**" 🆎. & ⚫️ 💪 📣 👫, ⏮️ 👫 🔗 🆎.
|
||||||
|
|
||||||
|
📣 👈 🆎 & 🔗 🆎, 👆 💪 ⚙️ 🐩 🐍 🕹 `typing`. ⚫️ 🔀 🎯 🐕🦺 👫 🆎 🔑.
|
||||||
|
|
||||||
|
#### 🆕 ⏬ 🐍
|
||||||
|
|
||||||
|
❕ ⚙️ `typing` **🔗** ⏮️ 🌐 ⏬, ⚪️➡️ 🐍 3️⃣.6️⃣ ⏪ 🕐, ✅ 🐍 3️⃣.9️⃣, 🐍 3️⃣.1️⃣0️⃣, ♒️.
|
||||||
|
|
||||||
|
🐍 🏧, **🆕 ⏬** 👟 ⏮️ 📉 🐕🦺 👉 🆎 ✍ & 📚 💼 👆 🏆 🚫 💪 🗄 & ⚙️ `typing` 🕹 📣 🆎 ✍.
|
||||||
|
|
||||||
|
🚥 👆 💪 ⚒ 🌖 ⏮️ ⏬ 🐍 👆 🏗, 👆 🔜 💪 ✊ 📈 👈 ➕ 🦁. 👀 🖼 🔛.
|
||||||
|
|
||||||
|
#### 📇
|
||||||
|
|
||||||
|
🖼, ➡️ 🔬 🔢 `list` `str`.
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.6️⃣ & 🔛
|
||||||
|
|
||||||
|
⚪️➡️ `typing`, 🗄 `List` (⏮️ 🔠 `L`):
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!> ../../docs_src/python_types/tutorial006.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
📣 🔢, ⏮️ 🎏 ❤ (`:`) ❕.
|
||||||
|
|
||||||
|
🆎, 🚮 `List` 👈 👆 🗄 ⚪️➡️ `typing`.
|
||||||
|
|
||||||
|
📇 🆎 👈 🔌 🔗 🆎, 👆 🚮 👫 ⬜ 🗜:
|
||||||
|
|
||||||
|
```Python hl_lines="4"
|
||||||
|
{!> ../../docs_src/python_types/tutorial006.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.9️⃣ & 🔛
|
||||||
|
|
||||||
|
📣 🔢, ⏮️ 🎏 ❤ (`:`) ❕.
|
||||||
|
|
||||||
|
🆎, 🚮 `list`.
|
||||||
|
|
||||||
|
📇 🆎 👈 🔌 🔗 🆎, 👆 🚮 👫 ⬜ 🗜:
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!> ../../docs_src/python_types/tutorial006_py39.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
👈 🔗 🆎 ⬜ 🗜 🤙 "🆎 🔢".
|
||||||
|
|
||||||
|
👉 💼, `str` 🆎 🔢 🚶♀️ `List` (⚖️ `list` 🐍 3️⃣.9️⃣ & 🔛).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👈 ⛓: "🔢 `items` `list`, & 🔠 🏬 👉 📇 `str`".
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 🐍 3️⃣.9️⃣ ⚖️ 🔛, 👆 🚫 ✔️ 🗄 `List` ⚪️➡️ `typing`, 👆 💪 ⚙️ 🎏 🥔 `list` 🆎 ↩️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🔨 👈, 👆 👨🎨 💪 🚚 🐕🦺 ⏪ 🏭 🏬 ⚪️➡️ 📇:
|
||||||
|
|
||||||
|
<img src="/img/python-types/image05.png">
|
||||||
|
|
||||||
|
🍵 🆎, 👈 🌖 💪 🏆.
|
||||||
|
|
||||||
|
👀 👈 🔢 `item` 1️⃣ 🔣 📇 `items`.
|
||||||
|
|
||||||
|
& , 👨🎨 💭 ⚫️ `str`, & 🚚 🐕🦺 👈.
|
||||||
|
|
||||||
|
#### 🔢 & ⚒
|
||||||
|
|
||||||
|
👆 🔜 🎏 📣 `tuple`Ⓜ & `set`Ⓜ:
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.6️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python hl_lines="1 4"
|
||||||
|
{!> ../../docs_src/python_types/tutorial007.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.9️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!> ../../docs_src/python_types/tutorial007_py39.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
👉 ⛓:
|
||||||
|
|
||||||
|
* 🔢 `items_t` `tuple` ⏮️ 3️⃣ 🏬, `int`, ➕1️⃣ `int`, & `str`.
|
||||||
|
* 🔢 `items_s` `set`, & 🔠 🚮 🏬 🆎 `bytes`.
|
||||||
|
|
||||||
|
#### #️⃣
|
||||||
|
|
||||||
|
🔬 `dict`, 👆 🚶♀️ 2️⃣ 🆎 🔢, 🎏 ❕.
|
||||||
|
|
||||||
|
🥇 🆎 🔢 🔑 `dict`.
|
||||||
|
|
||||||
|
🥈 🆎 🔢 💲 `dict`:
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.6️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python hl_lines="1 4"
|
||||||
|
{!> ../../docs_src/python_types/tutorial008.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.9️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!> ../../docs_src/python_types/tutorial008_py39.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
👉 ⛓:
|
||||||
|
|
||||||
|
* 🔢 `prices` `dict`:
|
||||||
|
* 🔑 👉 `dict` 🆎 `str` (➡️ 💬, 📛 🔠 🏬).
|
||||||
|
* 💲 👉 `dict` 🆎 `float` (➡️ 💬, 🔖 🔠 🏬).
|
||||||
|
|
||||||
|
#### 🇪🇺
|
||||||
|
|
||||||
|
👆 💪 📣 👈 🔢 💪 🙆 **📚 🆎**, 🖼, `int` ⚖️ `str`.
|
||||||
|
|
||||||
|
🐍 3️⃣.6️⃣ & 🔛 (✅ 🐍 3️⃣.1️⃣0️⃣) 👆 💪 ⚙️ `Union` 🆎 ⚪️➡️ `typing` & 🚮 🔘 ⬜ 🗜 💪 🆎 🚫.
|
||||||
|
|
||||||
|
🐍 3️⃣.1️⃣0️⃣ 📤 **🎛 ❕** 🌐❔ 👆 💪 🚮 💪 🆎 👽 <abbr title='also called "bitwise or operator", but that meaning is not relevant here'>⏸ ⏸ (`|`)</abbr>.
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.6️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python hl_lines="1 4"
|
||||||
|
{!> ../../docs_src/python_types/tutorial008b.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.1️⃣0️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!> ../../docs_src/python_types/tutorial008b_py310.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
👯♂️ 💼 👉 ⛓ 👈 `item` 💪 `int` ⚖️ `str`.
|
||||||
|
|
||||||
|
#### 🎲 `None`
|
||||||
|
|
||||||
|
👆 💪 📣 👈 💲 💪 ✔️ 🆎, 💖 `str`, ✋️ 👈 ⚫️ 💪 `None`.
|
||||||
|
|
||||||
|
🐍 3️⃣.6️⃣ & 🔛 (✅ 🐍 3️⃣.1️⃣0️⃣) 👆 💪 📣 ⚫️ 🏭 & ⚙️ `Optional` ⚪️➡️ `typing` 🕹.
|
||||||
|
|
||||||
|
```Python hl_lines="1 4"
|
||||||
|
{!../../docs_src/python_types/tutorial009.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
⚙️ `Optional[str]` ↩️ `str` 🔜 ➡️ 👨🎨 ℹ 👆 🔍 ❌ 🌐❔ 👆 💪 🤔 👈 💲 🕧 `str`, 🕐❔ ⚫️ 💪 🤙 `None` 💁♂️.
|
||||||
|
|
||||||
|
`Optional[Something]` 🤙 ⌨ `Union[Something, None]`, 👫 🌓.
|
||||||
|
|
||||||
|
👉 ⛓ 👈 🐍 3️⃣.1️⃣0️⃣, 👆 💪 ⚙️ `Something | None`:
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.6️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python hl_lines="1 4"
|
||||||
|
{!> ../../docs_src/python_types/tutorial009.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.6️⃣ & 🔛 - 🎛
|
||||||
|
|
||||||
|
```Python hl_lines="1 4"
|
||||||
|
{!> ../../docs_src/python_types/tutorial009b.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.1️⃣0️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
{!> ../../docs_src/python_types/tutorial009_py310.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
#### ⚙️ `Union` ⚖️ `Optional`
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 🐍 ⏬ 🔛 3️⃣.1️⃣0️⃣, 📥 💁♂ ⚪️➡️ 👇 📶 **🤔** ☝ 🎑:
|
||||||
|
|
||||||
|
* 👶 ❎ ⚙️ `Optional[SomeType]`
|
||||||
|
* ↩️ 👶 **⚙️ `Union[SomeType, None]`** 👶.
|
||||||
|
|
||||||
|
👯♂️ 🌓 & 🔘 👫 🎏, ✋️ 👤 🔜 👍 `Union` ↩️ `Optional` ↩️ 🔤 "**📦**" 🔜 😑 🔑 👈 💲 📦, & ⚫️ 🤙 ⛓ "⚫️ 💪 `None`", 🚥 ⚫️ 🚫 📦 & ✔.
|
||||||
|
|
||||||
|
👤 💭 `Union[SomeType, None]` 🌖 🔑 🔃 ⚫️❔ ⚫️ ⛓.
|
||||||
|
|
||||||
|
⚫️ 🔃 🔤 & 📛. ✋️ 👈 🔤 💪 📉 ❔ 👆 & 👆 🤽♂ 💭 🔃 📟.
|
||||||
|
|
||||||
|
🖼, ➡️ ✊ 👉 🔢:
|
||||||
|
|
||||||
|
```Python hl_lines="1 4"
|
||||||
|
{!../../docs_src/python_types/tutorial009c.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
🔢 `name` 🔬 `Optional[str]`, ✋️ ⚫️ **🚫 📦**, 👆 🚫🔜 🤙 🔢 🍵 🔢:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
say_hi() # Oh, no, this throws an error! 😱
|
||||||
|
```
|
||||||
|
|
||||||
|
`name` 🔢 **✔** (🚫 *📦*) ↩️ ⚫️ 🚫 ✔️ 🔢 💲. , `name` 🚫 `None` 💲:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
say_hi(name=None) # This works, None is valid 🎉
|
||||||
|
```
|
||||||
|
|
||||||
|
👍 📰, 🕐 👆 🔛 🐍 3️⃣.1️⃣0️⃣ 👆 🏆 🚫 ✔️ 😟 🔃 👈, 👆 🔜 💪 🎯 ⚙️ `|` 🔬 🇪🇺 🆎:
|
||||||
|
|
||||||
|
```Python hl_lines="1 4"
|
||||||
|
{!../../docs_src/python_types/tutorial009c_py310.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
& ⤴️ 👆 🏆 🚫 ✔️ 😟 🔃 📛 💖 `Optional` & `Union`. 👶
|
||||||
|
|
||||||
|
#### 💊 🆎
|
||||||
|
|
||||||
|
👉 🆎 👈 ✊ 🆎 🔢 ⬜ 🗜 🤙 **💊 🆎** ⚖️ **💊**, 🖼:
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.6️⃣ & 🔛
|
||||||
|
|
||||||
|
* `List`
|
||||||
|
* `Tuple`
|
||||||
|
* `Set`
|
||||||
|
* `Dict`
|
||||||
|
* `Union`
|
||||||
|
* `Optional`
|
||||||
|
* ...& 🎏.
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.9️⃣ & 🔛
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🎏 💽 🆎 💊 (⏮️ ⬜ 🗜 & 🆎 🔘):
|
||||||
|
|
||||||
|
* `list`
|
||||||
|
* `tuple`
|
||||||
|
* `set`
|
||||||
|
* `dict`
|
||||||
|
|
||||||
|
& 🎏 ⏮️ 🐍 3️⃣.6️⃣, ⚪️➡️ `typing` 🕹:
|
||||||
|
|
||||||
|
* `Union`
|
||||||
|
* `Optional`
|
||||||
|
* ...& 🎏.
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.1️⃣0️⃣ & 🔛
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🎏 💽 🆎 💊 (⏮️ ⬜ 🗜 & 🆎 🔘):
|
||||||
|
|
||||||
|
* `list`
|
||||||
|
* `tuple`
|
||||||
|
* `set`
|
||||||
|
* `dict`
|
||||||
|
|
||||||
|
& 🎏 ⏮️ 🐍 3️⃣.6️⃣, ⚪️➡️ `typing` 🕹:
|
||||||
|
|
||||||
|
* `Union`
|
||||||
|
* `Optional` (🎏 ⏮️ 🐍 3️⃣.6️⃣)
|
||||||
|
* ...& 🎏.
|
||||||
|
|
||||||
|
🐍 3️⃣.1️⃣0️⃣, 🎛 ⚙️ 💊 `Union` & `Optional`, 👆 💪 ⚙️ <abbr title='also called "bitwise or operator", but that meaning is not relevant here'>⏸ ⏸ (`|`)</abbr> 📣 🇪🇺 🆎.
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
### 🎓 🆎
|
||||||
|
|
||||||
|
👆 💪 📣 🎓 🆎 🔢.
|
||||||
|
|
||||||
|
➡️ 💬 👆 ✔️ 🎓 `Person`, ⏮️ 📛:
|
||||||
|
|
||||||
|
```Python hl_lines="1-3"
|
||||||
|
{!../../docs_src/python_types/tutorial010.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
⤴️ 👆 💪 📣 🔢 🆎 `Person`:
|
||||||
|
|
||||||
|
```Python hl_lines="6"
|
||||||
|
{!../../docs_src/python_types/tutorial010.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
& ⤴️, 🔄, 👆 🤚 🌐 👨🎨 🐕🦺:
|
||||||
|
|
||||||
|
<img src="/img/python-types/image06.png">
|
||||||
|
|
||||||
|
## Pydantic 🏷
|
||||||
|
|
||||||
|
<a href="https://docs.pydantic.dev/" class="external-link" target="_blank">Pydantic</a> 🐍 🗃 🎭 📊 🔬.
|
||||||
|
|
||||||
|
👆 📣 "💠" 💽 🎓 ⏮️ 🔢.
|
||||||
|
|
||||||
|
& 🔠 🔢 ✔️ 🆎.
|
||||||
|
|
||||||
|
⤴️ 👆 ✍ 👐 👈 🎓 ⏮️ 💲 & ⚫️ 🔜 ✔ 💲, 🗜 👫 ☑ 🆎 (🚥 👈 💼) & 🤝 👆 🎚 ⏮️ 🌐 💽.
|
||||||
|
|
||||||
|
& 👆 🤚 🌐 👨🎨 🐕🦺 ⏮️ 👈 📉 🎚.
|
||||||
|
|
||||||
|
🖼 ⚪️➡️ 🛂 Pydantic 🩺:
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.6️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!> ../../docs_src/python_types/tutorial011.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.9️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!> ../../docs_src/python_types/tutorial011_py39.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
//// tab | 🐍 3️⃣.1️⃣0️⃣ & 🔛
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{!> ../../docs_src/python_types/tutorial011_py310.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
////
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
💡 🌖 🔃 <a href="https://docs.pydantic.dev/" class="external-link" target="_blank">Pydantic, ✅ 🚮 🩺</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
**FastAPI** 🌐 ⚓️ 🔛 Pydantic.
|
||||||
|
|
||||||
|
👆 🔜 👀 📚 🌅 🌐 👉 💡 [🔰 - 👩💻 🦮](tutorial/index.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
Pydantic ✔️ 🎁 🎭 🕐❔ 👆 ⚙️ `Optional` ⚖️ `Union[Something, None]` 🍵 🔢 💲, 👆 💪 ✍ 🌅 🔃 ⚫️ Pydantic 🩺 🔃 <a href="https://docs.pydantic.dev/latest/concepts/models/#required-optional-fields" class="external-link" target="_blank">✔ 📦 🏑</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🆎 🔑 **FastAPI**
|
||||||
|
|
||||||
|
**FastAPI** ✊ 📈 👫 🆎 🔑 📚 👜.
|
||||||
|
|
||||||
|
⏮️ **FastAPI** 👆 📣 🔢 ⏮️ 🆎 🔑 & 👆 🤚:
|
||||||
|
|
||||||
|
* **👨🎨 🐕🦺**.
|
||||||
|
* **🆎 ✅**.
|
||||||
|
|
||||||
|
...and **FastAPI** uses the same declarations :
|
||||||
|
|
||||||
|
* **🔬 📄**: ⚪️➡️ 📨 ➡ 🔢, 🔢 🔢, 🎚, 💪, 🔗, ♒️.
|
||||||
|
* **🗜 💽**: ⚪️➡️ 📨 🚚 🆎.
|
||||||
|
* **✔ 💽**: 👟 ⚪️➡️ 🔠 📨:
|
||||||
|
* 🏭 **🏧 ❌** 📨 👩💻 🕐❔ 📊 ❌.
|
||||||
|
* **📄** 🛠️ ⚙️ 🗄:
|
||||||
|
* ❔ ⤴️ ⚙️ 🏧 🎓 🧾 👩💻 🔢.
|
||||||
|
|
||||||
|
👉 5️⃣📆 🌐 🔊 📝. 🚫 😟. 👆 🔜 👀 🌐 👉 🎯 [🔰 - 👩💻 🦮](tutorial/index.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
⚠ 👜 👈 ⚙️ 🐩 🐍 🆎, 👁 🥉 (↩️ ❎ 🌖 🎓, 👨🎨, ♒️), **FastAPI** 🔜 📚 👷 👆.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🚥 👆 ⏪ 🚶 🔘 🌐 🔰 & 👟 🔙 👀 🌅 🔃 🆎, 👍 ℹ <a href="https://mypy.readthedocs.io/en/latest/cheat_sheet_py3.html" class="external-link" target="_blank"> "🎮 🎼" ⚪️➡️ `mypy`</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,84 @@
|
||||||
|
# 🖥 📋
|
||||||
|
|
||||||
|
👆 💪 🔬 🖥 📋 🏃 *⏮️* 🛬 📨.
|
||||||
|
|
||||||
|
👉 ⚠ 🛠️ 👈 💪 🔨 ⏮️ 📨, ✋️ 👈 👩💻 🚫 🤙 ✔️ ⌛ 🛠️ 🏁 ⏭ 📨 📨.
|
||||||
|
|
||||||
|
👉 🔌, 🖼:
|
||||||
|
|
||||||
|
* 📧 📨 📨 ⏮️ 🎭 🎯:
|
||||||
|
* 🔗 📧 💽 & 📨 📧 😑 "🐌" (📚 🥈), 👆 💪 📨 📨 ▶️️ ↖️ & 📨 📧 📨 🖥.
|
||||||
|
* 🏭 💽:
|
||||||
|
* 🖼, ➡️ 💬 👆 📨 📁 👈 🔜 🚶 🔘 🐌 🛠️, 👆 💪 📨 📨 "🚫" (🇺🇸🔍 2️⃣0️⃣2️⃣) & 🛠️ ⚫️ 🖥.
|
||||||
|
|
||||||
|
## ⚙️ `BackgroundTasks`
|
||||||
|
|
||||||
|
🥇, 🗄 `BackgroundTasks` & 🔬 🔢 👆 *➡ 🛠️ 🔢* ⏮️ 🆎 📄 `BackgroundTasks`:
|
||||||
|
|
||||||
|
{* ../../docs_src/background_tasks/tutorial001.py hl[1,13] *}
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ✍ 🎚 🆎 `BackgroundTasks` 👆 & 🚶♀️ ⚫️ 👈 🔢.
|
||||||
|
|
||||||
|
## ✍ 📋 🔢
|
||||||
|
|
||||||
|
✍ 🔢 🏃 🖥 📋.
|
||||||
|
|
||||||
|
⚫️ 🐩 🔢 👈 💪 📨 🔢.
|
||||||
|
|
||||||
|
⚫️ 💪 `async def` ⚖️ 😐 `def` 🔢, **FastAPI** 🔜 💭 ❔ 🍵 ⚫️ ☑.
|
||||||
|
|
||||||
|
👉 💼, 📋 🔢 🔜 ✍ 📁 (⚖ 📨 📧).
|
||||||
|
|
||||||
|
& ✍ 🛠️ 🚫 ⚙️ `async` & `await`, 👥 🔬 🔢 ⏮️ 😐 `def`:
|
||||||
|
|
||||||
|
{* ../../docs_src/background_tasks/tutorial001.py hl[6:9] *}
|
||||||
|
|
||||||
|
## 🚮 🖥 📋
|
||||||
|
|
||||||
|
🔘 👆 *➡ 🛠️ 🔢*, 🚶♀️ 👆 📋 🔢 *🖥 📋* 🎚 ⏮️ 👩🔬 `.add_task()`:
|
||||||
|
|
||||||
|
{* ../../docs_src/background_tasks/tutorial001.py hl[14] *}
|
||||||
|
|
||||||
|
`.add_task()` 📨 ❌:
|
||||||
|
|
||||||
|
* 📋 🔢 🏃 🖥 (`write_notification`).
|
||||||
|
* 🙆 🔁 ❌ 👈 🔜 🚶♀️ 📋 🔢 ✔ (`email`).
|
||||||
|
* 🙆 🇨🇻 ❌ 👈 🔜 🚶♀️ 📋 🔢 (`message="some notification"`).
|
||||||
|
|
||||||
|
## 🔗 💉
|
||||||
|
|
||||||
|
⚙️ `BackgroundTasks` 👷 ⏮️ 🔗 💉 ⚙️, 👆 💪 📣 🔢 🆎 `BackgroundTasks` 💗 🎚: *➡ 🛠️ 🔢*, 🔗 (☑), 🎧-🔗, ♒️.
|
||||||
|
|
||||||
|
**FastAPI** 💭 ⚫️❔ 🔠 💼 & ❔ 🏤-⚙️ 🎏 🎚, 👈 🌐 🖥 📋 🔗 👯♂️ & 🏃 🖥 ⏮️:
|
||||||
|
|
||||||
|
{* ../../docs_src/background_tasks/tutorial002.py hl[13,15,22,25] *}
|
||||||
|
|
||||||
|
👉 🖼, 📧 🔜 ✍ `log.txt` 📁 *⏮️* 📨 📨.
|
||||||
|
|
||||||
|
🚥 📤 🔢 📨, ⚫️ 🔜 ✍ 🕹 🖥 📋.
|
||||||
|
|
||||||
|
& ⤴️ ➕1️⃣ 🖥 📋 🏗 *➡ 🛠️ 🔢* 🔜 ✍ 📧 ⚙️ `email` ➡ 🔢.
|
||||||
|
|
||||||
|
## 📡 ℹ
|
||||||
|
|
||||||
|
🎓 `BackgroundTasks` 👟 🔗 ⚪️➡️ <a href="https://www.starlette.dev/background/" class="external-link" target="_blank">`starlette.background`</a>.
|
||||||
|
|
||||||
|
⚫️ 🗄/🔌 🔗 🔘 FastAPI 👈 👆 💪 🗄 ⚫️ ⚪️➡️ `fastapi` & ❎ 😫 🗄 🎛 `BackgroundTask` (🍵 `s` 🔚) ⚪️➡️ `starlette.background`.
|
||||||
|
|
||||||
|
🕴 ⚙️ `BackgroundTasks` (& 🚫 `BackgroundTask`), ⚫️ ⤴️ 💪 ⚙️ ⚫️ *➡ 🛠️ 🔢* 🔢 & ✔️ **FastAPI** 🍵 🎂 👆, 💖 🕐❔ ⚙️ `Request` 🎚 🔗.
|
||||||
|
|
||||||
|
⚫️ 💪 ⚙️ `BackgroundTask` 😞 FastAPI, ✋️ 👆 ✔️ ✍ 🎚 👆 📟 & 📨 💃 `Response` 🔌 ⚫️.
|
||||||
|
|
||||||
|
👆 💪 👀 🌖 ℹ <a href="https://www.starlette.dev/background/" class="external-link" target="_blank">💃 🛂 🩺 🖥 📋</a>.
|
||||||
|
|
||||||
|
## ⚠
|
||||||
|
|
||||||
|
🚥 👆 💪 🎭 🏋️ 🖥 📊 & 👆 🚫 🎯 💪 ⚫️ 🏃 🎏 🛠️ (🖼, 👆 🚫 💪 💰 💾, 🔢, ♒️), 👆 💪 💰 ⚪️➡️ ⚙️ 🎏 🦏 🧰 💖 <a href="https://docs.celeryq.dev" class="external-link" target="_blank">🥒</a>.
|
||||||
|
|
||||||
|
👫 😑 🚚 🌖 🏗 📳, 📧/👨🏭 📤 👨💼, 💖 ✳ ⚖️ ✳, ✋️ 👫 ✔ 👆 🏃 🖥 📋 💗 🛠️, & ✴️, 💗 💽.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 💪 🔐 🔢 & 🎚 ⚪️➡️ 🎏 **FastAPI** 📱, ⚖️ 👆 💪 🎭 🤪 🖥 📋 (💖 📨 📧 📨), 👆 💪 🎯 ⚙️ `BackgroundTasks`.
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
🗄 & ⚙️ `BackgroundTasks` ⏮️ 🔢 *➡ 🛠️ 🔢* & 🔗 🚮 🖥 📋.
|
||||||
|
|
@ -0,0 +1,530 @@
|
||||||
|
# 🦏 🈸 - 💗 📁
|
||||||
|
|
||||||
|
🚥 👆 🏗 🈸 ⚖️ 🕸 🛠️, ⚫️ 🛎 💼 👈 👆 💪 🚮 🌐 🔛 👁 📁.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 🏪 🧰 📊 👆 🈸 ⏪ 🚧 🌐 💪.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🚥 👆 👟 ⚪️➡️ 🏺, 👉 🔜 🌓 🏺 📗.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🖼 📁 📊
|
||||||
|
|
||||||
|
➡️ 💬 👆 ✔️ 📁 📊 💖 👉:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── app
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── main.py
|
||||||
|
│ ├── dependencies.py
|
||||||
|
│ └── routers
|
||||||
|
│ │ ├── __init__.py
|
||||||
|
│ │ ├── items.py
|
||||||
|
│ │ └── users.py
|
||||||
|
│ └── internal
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ └── admin.py
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
📤 📚 `__init__.py` 📁: 1️⃣ 🔠 📁 ⚖️ 📁.
|
||||||
|
|
||||||
|
👉 ⚫️❔ ✔ 🏭 📟 ⚪️➡️ 1️⃣ 📁 🔘 ➕1️⃣.
|
||||||
|
|
||||||
|
🖼, `app/main.py` 👆 💪 ✔️ ⏸ 💖:
|
||||||
|
|
||||||
|
```
|
||||||
|
from app.routers import items
|
||||||
|
```
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
* `app` 📁 🔌 🌐. & ⚫️ ✔️ 🛁 📁 `app/__init__.py`, ⚫️ "🐍 📦" (🗃 "🐍 🕹"): `app`.
|
||||||
|
* ⚫️ 🔌 `app/main.py` 📁. ⚫️ 🔘 🐍 📦 (📁 ⏮️ 📁 `__init__.py`), ⚫️ "🕹" 👈 📦: `app.main`.
|
||||||
|
* 📤 `app/dependencies.py` 📁, 💖 `app/main.py`, ⚫️ "🕹": `app.dependencies`.
|
||||||
|
* 📤 📁 `app/routers/` ⏮️ ➕1️⃣ 📁 `__init__.py`, ⚫️ "🐍 📦": `app.routers`.
|
||||||
|
* 📁 `app/routers/items.py` 🔘 📦, `app/routers/`,, ⚫️ 🔁: `app.routers.items`.
|
||||||
|
* 🎏 ⏮️ `app/routers/users.py`, ⚫️ ➕1️⃣ 🔁: `app.routers.users`.
|
||||||
|
* 📤 📁 `app/internal/` ⏮️ ➕1️⃣ 📁 `__init__.py`, ⚫️ ➕1️⃣ "🐍 📦": `app.internal`.
|
||||||
|
* & 📁 `app/internal/admin.py` ➕1️⃣ 🔁: `app.internal.admin`.
|
||||||
|
|
||||||
|
<img src="/img/tutorial/bigger-applications/package.drawio.svg">
|
||||||
|
|
||||||
|
🎏 📁 📊 ⏮️ 🏤:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── 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
|
||||||
|
```
|
||||||
|
|
||||||
|
## `APIRouter`
|
||||||
|
|
||||||
|
➡️ 💬 📁 💡 🚚 👩💻 🔁 `/app/routers/users.py`.
|
||||||
|
|
||||||
|
👆 💚 ✔️ *➡ 🛠️* 🔗 👆 👩💻 👽 ⚪️➡️ 🎂 📟, 🚧 ⚫️ 🏗.
|
||||||
|
|
||||||
|
✋️ ⚫️ 🍕 🎏 **FastAPI** 🈸/🕸 🛠️ (⚫️ 🍕 🎏 "🐍 📦").
|
||||||
|
|
||||||
|
👆 💪 ✍ *➡ 🛠️* 👈 🕹 ⚙️ `APIRouter`.
|
||||||
|
|
||||||
|
### 🗄 `APIRouter`
|
||||||
|
|
||||||
|
👆 🗄 ⚫️ & ✍ "👐" 🎏 🌌 👆 🔜 ⏮️ 🎓 `FastAPI`:
|
||||||
|
|
||||||
|
```Python hl_lines="1 3" title="app/routers/users.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/users.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
### *➡ 🛠️* ⏮️ `APIRouter`
|
||||||
|
|
||||||
|
& ⤴️ 👆 ⚙️ ⚫️ 📣 👆 *➡ 🛠️*.
|
||||||
|
|
||||||
|
⚙️ ⚫️ 🎏 🌌 👆 🔜 ⚙️ `FastAPI` 🎓:
|
||||||
|
|
||||||
|
```Python hl_lines="6 11 16" title="app/routers/users.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/users.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
👆 💪 💭 `APIRouter` "🐩 `FastAPI`" 🎓.
|
||||||
|
|
||||||
|
🌐 🎏 🎛 🐕🦺.
|
||||||
|
|
||||||
|
🌐 🎏 `parameters`, `responses`, `dependencies`, `tags`, ♒️.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👉 🖼, 🔢 🤙 `router`, ✋️ 👆 💪 📛 ⚫️ 👐 👆 💚.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
👥 🔜 🔌 👉 `APIRouter` 👑 `FastAPI` 📱, ✋️ 🥇, ➡️ ✅ 🔗 & ➕1️⃣ `APIRouter`.
|
||||||
|
|
||||||
|
## 🔗
|
||||||
|
|
||||||
|
👥 👀 👈 👥 🔜 💪 🔗 ⚙️ 📚 🥉 🈸.
|
||||||
|
|
||||||
|
👥 🚮 👫 👫 👍 `dependencies` 🕹 (`app/dependencies.py`).
|
||||||
|
|
||||||
|
👥 🔜 🔜 ⚙️ 🙅 🔗 ✍ 🛃 `X-Token` 🎚:
|
||||||
|
|
||||||
|
```Python hl_lines="1 4-6" title="app/dependencies.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/dependencies.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👥 ⚙️ 💭 🎚 📉 👉 🖼.
|
||||||
|
|
||||||
|
✋️ 🎰 💼 👆 🔜 🤚 👍 🏁 ⚙️ 🛠️ [💂♂ 🚙](security/index.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ➕1️⃣ 🕹 ⏮️ `APIRouter`
|
||||||
|
|
||||||
|
➡️ 💬 👆 ✔️ 🔗 💡 🚚 "🏬" ⚪️➡️ 👆 🈸 🕹 `app/routers/items.py`.
|
||||||
|
|
||||||
|
👆 ✔️ *➡ 🛠️* :
|
||||||
|
|
||||||
|
* `/items/`
|
||||||
|
* `/items/{item_id}`
|
||||||
|
|
||||||
|
⚫️ 🌐 🎏 📊 ⏮️ `app/routers/users.py`.
|
||||||
|
|
||||||
|
✋️ 👥 💚 🙃 & 📉 📟 🍖.
|
||||||
|
|
||||||
|
👥 💭 🌐 *➡ 🛠️* 👉 🕹 ✔️ 🎏:
|
||||||
|
|
||||||
|
* ➡ `prefix`: `/items`.
|
||||||
|
* `tags`: (1️⃣ 🔖: `items`).
|
||||||
|
* ➕ `responses`.
|
||||||
|
* `dependencies`: 👫 🌐 💪 👈 `X-Token` 🔗 👥 ✍.
|
||||||
|
|
||||||
|
, ↩️ ❎ 🌐 👈 🔠 *➡ 🛠️*, 👥 💪 🚮 ⚫️ `APIRouter`.
|
||||||
|
|
||||||
|
```Python hl_lines="5-10 16 21" title="app/routers/items.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/items.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
➡ 🔠 *➡ 🛠️* ✔️ ▶️ ⏮️ `/`, 💖:
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
@router.get("/{item_id}")
|
||||||
|
async def read_item(item_id: str):
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
...🔡 🔜 🚫 🔌 🏁 `/`.
|
||||||
|
|
||||||
|
, 🔡 👉 💼 `/items`.
|
||||||
|
|
||||||
|
👥 💪 🚮 📇 `tags` & ➕ `responses` 👈 🔜 ✔ 🌐 *➡ 🛠️* 🔌 👉 📻.
|
||||||
|
|
||||||
|
& 👥 💪 🚮 📇 `dependencies` 👈 🔜 🚮 🌐 *➡ 🛠️* 📻 & 🔜 🛠️/❎ 🔠 📨 ⚒ 👫.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🗒 👈, 🌅 💖 [🔗 *➡ 🛠️ 👨🎨*](dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, 🙅♂ 💲 🔜 🚶♀️ 👆 *➡ 🛠️ 🔢*.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🔚 🏁 👈 🏬 ➡ 🔜:
|
||||||
|
|
||||||
|
* `/items/`
|
||||||
|
* `/items/{item_id}`
|
||||||
|
|
||||||
|
...👥 🎯.
|
||||||
|
|
||||||
|
* 👫 🔜 ™ ⏮️ 📇 🔖 👈 🔌 👁 🎻 `"items"`.
|
||||||
|
* 👫 "🔖" ✴️ ⚠ 🏧 🎓 🧾 ⚙️ (⚙️ 🗄).
|
||||||
|
* 🌐 👫 🔜 🔌 🔁 `responses`.
|
||||||
|
* 🌐 👫 *➡ 🛠️* 🔜 ✔️ 📇 `dependencies` 🔬/🛠️ ⏭ 👫.
|
||||||
|
* 🚥 👆 📣 🔗 🎯 *➡ 🛠️*, **👫 🔜 🛠️ 💁♂️**.
|
||||||
|
* 📻 🔗 🛠️ 🥇, ⤴️ [`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` 💪 ⚙️, 🖼, 🚚 🤝 🎂 👪 *➡ 🛠️*. 🚥 🔗 🚫 🚮 📦 🔠 1️⃣ 👫.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check
|
||||||
|
|
||||||
|
`prefix`, `tags`, `responses`, & `dependencies` 🔢 (📚 🎏 💼) ⚒ ⚪️➡️ **FastAPI** ℹ 👆 ❎ 📟 ❎.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🗄 🔗
|
||||||
|
|
||||||
|
👉 📟 👨❤👨 🕹 `app.routers.items`, 📁 `app/routers/items.py`.
|
||||||
|
|
||||||
|
& 👥 💪 🤚 🔗 🔢 ⚪️➡️ 🕹 `app.dependencies`, 📁 `app/dependencies.py`.
|
||||||
|
|
||||||
|
👥 ⚙️ ⚖ 🗄 ⏮️ `..` 🔗:
|
||||||
|
|
||||||
|
```Python hl_lines="3" title="app/routers/items.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/items.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### ❔ ⚖ 🗄 👷
|
||||||
|
|
||||||
|
/// 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`.
|
||||||
|
|
||||||
|
💭 ❔ 👆 📱/📁 📊 👀 💖:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/bigger-applications/package.drawio.svg">
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
2️⃣ ❣ `..`, 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from ..dependencies import get_token_header
|
||||||
|
```
|
||||||
|
|
||||||
|
⛓:
|
||||||
|
|
||||||
|
* ▶️ 🎏 📦 👈 👉 🕹 (📁 `app/routers/items.py`) 🖖 (📁 `app/routers/`)...
|
||||||
|
* 🚶 👪 📦 (📁 `app/`)...
|
||||||
|
* & 📤, 🔎 🕹 `dependencies` (📁 `app/dependencies.py`)...
|
||||||
|
* & ⚪️➡️ ⚫️, 🗄 🔢 `get_token_header`.
|
||||||
|
|
||||||
|
👈 👷 ☑ ❗ 👶
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🎏 🌌, 🚥 👥 ✔️ ⚙️ 3️⃣ ❣ `...`, 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from ...dependencies import get_token_header
|
||||||
|
```
|
||||||
|
|
||||||
|
that 🔜 ⛓:
|
||||||
|
|
||||||
|
* ▶️ 🎏 📦 👈 👉 🕹 (📁 `app/routers/items.py`) 🖖 (📁 `app/routers/`)...
|
||||||
|
* 🚶 👪 📦 (📁 `app/`)...
|
||||||
|
* ⤴️ 🚶 👪 👈 📦 (📤 🙅♂ 👪 📦, `app` 🔝 🎚 👶)...
|
||||||
|
* & 📤, 🔎 🕹 `dependencies` (📁 `app/dependencies.py`)...
|
||||||
|
* & ⚪️➡️ ⚫️, 🗄 🔢 `get_token_header`.
|
||||||
|
|
||||||
|
👈 🔜 🔗 📦 🔛 `app/`, ⏮️ 🚮 👍 📁 `__init__.py`, ♒️. ✋️ 👥 🚫 ✔️ 👈. , 👈 🔜 🚮 ❌ 👆 🖼. 👶
|
||||||
|
|
||||||
|
✋️ 🔜 👆 💭 ❔ ⚫️ 👷, 👆 💪 ⚙️ ⚖ 🗄 👆 👍 📱 🙅♂ 🤔 ❔ 🏗 👫. 👶
|
||||||
|
|
||||||
|
### 🚮 🛃 `tags`, `responses`, & `dependencies`
|
||||||
|
|
||||||
|
👥 🚫 ❎ 🔡 `/items` 🚫 `tags=["items"]` 🔠 *➡ 🛠️* ↩️ 👥 🚮 👫 `APIRouter`.
|
||||||
|
|
||||||
|
✋️ 👥 💪 🚮 _🌅_ `tags` 👈 🔜 ✔ 🎯 *➡ 🛠️*, & ➕ `responses` 🎯 👈 *➡ 🛠️*:
|
||||||
|
|
||||||
|
```Python hl_lines="30-31" title="app/routers/items.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/routers/items.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👉 🏁 ➡ 🛠️ 🔜 ✔️ 🌀 🔖: `["items", "custom"]`.
|
||||||
|
|
||||||
|
& ⚫️ 🔜 ✔️ 👯♂️ 📨 🧾, 1️⃣ `404` & 1️⃣ `403`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 👑 `FastAPI`
|
||||||
|
|
||||||
|
🔜, ➡️ 👀 🕹 `app/main.py`.
|
||||||
|
|
||||||
|
📥 🌐❔ 👆 🗄 & ⚙️ 🎓 `FastAPI`.
|
||||||
|
|
||||||
|
👉 🔜 👑 📁 👆 🈸 👈 👔 🌐 👯♂️.
|
||||||
|
|
||||||
|
& 🏆 👆 ⚛ 🔜 🔜 🖖 🚮 👍 🎯 🕹, 👑 📁 🔜 🙅.
|
||||||
|
|
||||||
|
### 🗄 `FastAPI`
|
||||||
|
|
||||||
|
👆 🗄 & ✍ `FastAPI` 🎓 🛎.
|
||||||
|
|
||||||
|
& 👥 💪 📣 [🌐 🔗](dependencies/global-dependencies.md){.internal-link target=_blank} 👈 🔜 🌀 ⏮️ 🔗 🔠 `APIRouter`:
|
||||||
|
|
||||||
|
```Python hl_lines="1 3 7" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🗄 `APIRouter`
|
||||||
|
|
||||||
|
🔜 👥 🗄 🎏 🔁 👈 ✔️ `APIRouter`Ⓜ:
|
||||||
|
|
||||||
|
```Python hl_lines="5" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
📁 `app/routers/users.py` & `app/routers/items.py` 🔁 👈 🍕 🎏 🐍 📦 `app`, 👥 💪 ⚙️ 👁 ❣ `.` 🗄 👫 ⚙️ "⚖ 🗄".
|
||||||
|
|
||||||
|
### ❔ 🏭 👷
|
||||||
|
|
||||||
|
📄:
|
||||||
|
|
||||||
|
```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`). 👉 🎏 1️⃣ 👥 ✍ 📁 `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
|
||||||
|
```
|
||||||
|
|
||||||
|
💡 🌅 🔃 🐍 📦 & 🕹, ✍ <a href="https://docs.python.org/3/tutorial/modules.html" class="external-link" target="_blank">🛂 🐍 🧾 🔃 🕹</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ❎ 📛 💥
|
||||||
|
|
||||||
|
👥 🏭 🔁 `items` 🔗, ↩️ 🏭 🚮 🔢 `router`.
|
||||||
|
|
||||||
|
👉 ↩️ 👥 ✔️ ➕1️⃣ 🔢 📛 `router` 🔁 `users`.
|
||||||
|
|
||||||
|
🚥 👥 ✔️ 🗄 1️⃣ ⏮️ 🎏, 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from .routers.items import router
|
||||||
|
from .routers.users import router
|
||||||
|
```
|
||||||
|
|
||||||
|
`router` ⚪️➡️ `users` 🔜 📁 1️⃣ ⚪️➡️ `items` & 👥 🚫🔜 💪 ⚙️ 👫 🎏 🕰.
|
||||||
|
|
||||||
|
, 💪 ⚙️ 👯♂️ 👫 🎏 📁, 👥 🗄 🔁 🔗:
|
||||||
|
|
||||||
|
```Python hl_lines="5" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🔌 `APIRouter`Ⓜ `users` & `items`
|
||||||
|
|
||||||
|
🔜, ➡️ 🔌 `router`Ⓜ ⚪️➡️ 🔁 `users` & `items`:
|
||||||
|
|
||||||
|
```Python hl_lines="10-11" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
`users.router` 🔌 `APIRouter` 🔘 📁 `app/routers/users.py`.
|
||||||
|
|
||||||
|
& `items.router` 🔌 `APIRouter` 🔘 📁 `app/routers/items.py`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
⏮️ `app.include_router()` 👥 💪 🚮 🔠 `APIRouter` 👑 `FastAPI` 🈸.
|
||||||
|
|
||||||
|
⚫️ 🔜 🔌 🌐 🛣 ⚪️➡️ 👈 📻 🍕 ⚫️.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
⚫️ 🔜 🤙 🔘 ✍ *➡ 🛠️* 🔠 *➡ 🛠️* 👈 📣 `APIRouter`.
|
||||||
|
|
||||||
|
, ⛅ 🎑, ⚫️ 🔜 🤙 👷 🚥 🌐 🎏 👁 📱.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// check
|
||||||
|
|
||||||
|
👆 🚫 ✔️ 😟 🔃 🎭 🕐❔ ✅ 📻.
|
||||||
|
|
||||||
|
👉 🔜 ✊ ⏲ & 🔜 🕴 🔨 🕴.
|
||||||
|
|
||||||
|
⚫️ 🏆 🚫 📉 🎭. 👶
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### 🔌 `APIRouter` ⏮️ 🛃 `prefix`, `tags`, `responses`, & `dependencies`
|
||||||
|
|
||||||
|
🔜, ➡️ 🌈 👆 🏢 🤝 👆 `app/internal/admin.py` 📁.
|
||||||
|
|
||||||
|
⚫️ 🔌 `APIRouter` ⏮️ 📡 *➡ 🛠️* 👈 👆 🏢 💰 🖖 📚 🏗.
|
||||||
|
|
||||||
|
👉 🖼 ⚫️ 🔜 💎 🙅. ✋️ ➡️ 💬 👈 ↩️ ⚫️ 💰 ⏮️ 🎏 🏗 🏢, 👥 🚫🔜 🔀 ⚫️ & 🚮 `prefix`, `dependencies`, `tags`, ♒️. 🔗 `APIRouter`:
|
||||||
|
|
||||||
|
```Python hl_lines="3" title="app/internal/admin.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/internal/admin.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
✋️ 👥 💚 ⚒ 🛃 `prefix` 🕐❔ ✅ `APIRouter` 👈 🌐 🚮 *➡ 🛠️* ▶️ ⏮️ `/admin`, 👥 💚 🔐 ⚫️ ⏮️ `dependencies` 👥 ⏪ ✔️ 👉 🏗, & 👥 💚 🔌 `tags` & `responses`.
|
||||||
|
|
||||||
|
👥 💪 📣 🌐 👈 🍵 ✔️ 🔀 ⏮️ `APIRouter` 🚶♀️ 👈 🔢 `app.include_router()`:
|
||||||
|
|
||||||
|
```Python hl_lines="14-17" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
👈 🌌, ⏮️ `APIRouter` 🔜 🚧 ⚗, 👥 💪 💰 👈 🎏 `app/internal/admin.py` 📁 ⏮️ 🎏 🏗 🏢.
|
||||||
|
|
||||||
|
🏁 👈 👆 📱, 🔠 *➡ 🛠️* ⚪️➡️ `admin` 🕹 🔜 ✔️:
|
||||||
|
|
||||||
|
* 🔡 `/admin`.
|
||||||
|
* 🔖 `admin`.
|
||||||
|
* 🔗 `get_token_header`.
|
||||||
|
* 📨 `418`. 👶
|
||||||
|
|
||||||
|
✋️ 👈 🔜 🕴 📉 👈 `APIRouter` 👆 📱, 🚫 🙆 🎏 📟 👈 ⚙️ ⚫️.
|
||||||
|
|
||||||
|
, 🖼, 🎏 🏗 💪 ⚙️ 🎏 `APIRouter` ⏮️ 🎏 🤝 👩🔬.
|
||||||
|
|
||||||
|
### 🔌 *➡ 🛠️*
|
||||||
|
|
||||||
|
👥 💪 🚮 *➡ 🛠️* 🔗 `FastAPI` 📱.
|
||||||
|
|
||||||
|
📥 👥 ⚫️... 🎦 👈 👥 💪 🤷:
|
||||||
|
|
||||||
|
```Python hl_lines="21-23" title="app/main.py"
|
||||||
|
{!../../docs_src/bigger_applications/app/main.py!}
|
||||||
|
```
|
||||||
|
|
||||||
|
& ⚫️ 🔜 👷 ☑, 👯♂️ ⏮️ 🌐 🎏 *➡ 🛠️* 🚮 ⏮️ `app.include_router()`.
|
||||||
|
|
||||||
|
/// info | 📶 📡 ℹ
|
||||||
|
|
||||||
|
**🗒**: 👉 📶 📡 ℹ 👈 👆 🎲 💪 **🚶**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`APIRouter`Ⓜ 🚫 "🗻", 👫 🚫 👽 ⚪️➡️ 🎂 🈸.
|
||||||
|
|
||||||
|
👉 ↩️ 👥 💚 🔌 👫 *➡ 🛠️* 🗄 🔗 & 👩💻 🔢.
|
||||||
|
|
||||||
|
👥 🚫🔜 ❎ 👫 & "🗻" 👫 ➡ 🎂, *➡ 🛠️* "🖖" (🏤-✍), 🚫 🔌 🔗.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ✅ 🏧 🛠️ 🩺
|
||||||
|
|
||||||
|
🔜, 🏃 `uvicorn`, ⚙️ 🕹 `app.main` & 🔢 `app`:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ uvicorn app.main:app --reload
|
||||||
|
|
||||||
|
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
& 📂 🩺 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
|
||||||
|
|
||||||
|
👆 🔜 👀 🏧 🛠️ 🩺, ✅ ➡ ⚪️➡️ 🌐 🔁, ⚙️ ☑ ➡ (& 🔡) & ☑ 🔖:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/bigger-applications/image01.png">
|
||||||
|
|
||||||
|
## 🔌 🎏 📻 💗 🕰 ⏮️ 🎏 `prefix`
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `.include_router()` 💗 🕰 ⏮️ *🎏* 📻 ⚙️ 🎏 🔡.
|
||||||
|
|
||||||
|
👉 💪 ⚠, 🖼, 🎦 🎏 🛠️ 🔽 🎏 🔡, ✅ `/api/v1` & `/api/latest`.
|
||||||
|
|
||||||
|
👉 🏧 ⚙️ 👈 👆 5️⃣📆 🚫 🤙 💪, ✋️ ⚫️ 📤 💼 👆.
|
||||||
|
|
||||||
|
## 🔌 `APIRouter` ➕1️⃣
|
||||||
|
|
||||||
|
🎏 🌌 👆 💪 🔌 `APIRouter` `FastAPI` 🈸, 👆 💪 🔌 `APIRouter` ➕1️⃣ `APIRouter` ⚙️:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
router.include_router(other_router)
|
||||||
|
```
|
||||||
|
|
||||||
|
⚒ 💭 👆 ⚫️ ⏭ 🔌 `router` `FastAPI` 📱, 👈 *➡ 🛠️* ⚪️➡️ `other_router` 🔌.
|
||||||
|
|
@ -0,0 +1,60 @@
|
||||||
|
# 💪 - 🏑
|
||||||
|
|
||||||
|
🎏 🌌 👆 💪 📣 🌖 🔬 & 🗃 *➡ 🛠️ 🔢* 🔢 ⏮️ `Query`, `Path` & `Body`, 👆 💪 📣 🔬 & 🗃 🔘 Pydantic 🏷 ⚙️ Pydantic `Field`.
|
||||||
|
|
||||||
|
## 🗄 `Field`
|
||||||
|
|
||||||
|
🥇, 👆 ✔️ 🗄 ⚫️:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_fields/tutorial001.py hl[4] *}
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
👀 👈 `Field` 🗄 🔗 ⚪️➡️ `pydantic`, 🚫 ⚪️➡️ `fastapi` 🌐 🎂 (`Query`, `Path`, `Body`, ♒️).
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 📣 🏷 🔢
|
||||||
|
|
||||||
|
👆 💪 ⤴️ ⚙️ `Field` ⏮️ 🏷 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_fields/tutorial001.py hl[11:14] *}
|
||||||
|
|
||||||
|
`Field` 👷 🎏 🌌 `Query`, `Path` & `Body`, ⚫️ ✔️ 🌐 🎏 🔢, ♒️.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
🤙, `Query`, `Path` & 🎏 👆 🔜 👀 ⏭ ✍ 🎚 🏿 ⚠ `Param` 🎓, ❔ ⚫️ 🏿 Pydantic `FieldInfo` 🎓.
|
||||||
|
|
||||||
|
& Pydantic `Field` 📨 👐 `FieldInfo` 👍.
|
||||||
|
|
||||||
|
`Body` 📨 🎚 🏿 `FieldInfo` 🔗. & 📤 🎏 👆 🔜 👀 ⏪ 👈 🏿 `Body` 🎓.
|
||||||
|
|
||||||
|
💭 👈 🕐❔ 👆 🗄 `Query`, `Path`, & 🎏 ⚪️➡️ `fastapi`, 👈 🤙 🔢 👈 📨 🎁 🎓.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👀 ❔ 🔠 🏷 🔢 ⏮️ 🆎, 🔢 💲 & `Field` ✔️ 🎏 📊 *➡ 🛠️ 🔢* 🔢, ⏮️ `Field` ↩️ `Path`, `Query` & `Body`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🚮 ➕ ℹ
|
||||||
|
|
||||||
|
👆 💪 📣 ➕ ℹ `Field`, `Query`, `Body`, ♒️. & ⚫️ 🔜 🔌 🏗 🎻 🔗.
|
||||||
|
|
||||||
|
👆 🔜 💡 🌅 🔃 ❎ ➕ ℹ ⏪ 🩺, 🕐❔ 🏫 📣 🖼.
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
➕ 🔑 🚶♀️ `Field` 🔜 🎁 📉 🗄 🔗 👆 🈸.
|
||||||
|
👫 🔑 5️⃣📆 🚫 🎯 🍕 🗄 🔧, 🗄 🧰, 🖼 [🗄 💳](https://validator.swagger.io/), 5️⃣📆 🚫 👷 ⏮️ 👆 🏗 🔗.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
👆 💪 ⚙️ Pydantic `Field` 📣 ➕ 🔬 & 🗃 🏷 🔢.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ ➕ 🇨🇻 ❌ 🚶♀️ 🌖 🎻 🔗 🗃.
|
||||||
|
|
@ -0,0 +1,171 @@
|
||||||
|
# 💪 - 💗 🔢
|
||||||
|
|
||||||
|
🔜 👈 👥 ✔️ 👀 ❔ ⚙️ `Path` & `Query`, ➡️ 👀 🌅 🏧 ⚙️ 📨 💪 📄.
|
||||||
|
|
||||||
|
## 🌀 `Path`, `Query` & 💪 🔢
|
||||||
|
|
||||||
|
🥇, ↗️, 👆 💪 🌀 `Path`, `Query` & 📨 💪 🔢 📄 ➡ & **FastAPI** 🔜 💭 ⚫️❔.
|
||||||
|
|
||||||
|
& 👆 💪 📣 💪 🔢 📦, ⚒ 🔢 `None`:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_multiple_params/tutorial001.py hl[19:21] *}
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
👀 👈, 👉 💼, `item` 👈 🔜 ✊ ⚪️➡️ 💪 📦. ⚫️ ✔️ `None` 🔢 💲.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 💗 💪 🔢
|
||||||
|
|
||||||
|
⏮️ 🖼, *➡ 🛠️* 🔜 ⌛ 🎻 💪 ⏮️ 🔢 `Item`, 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"name": "Foo",
|
||||||
|
"description": "The pretender",
|
||||||
|
"price": 42.0,
|
||||||
|
"tax": 3.2
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
✋️ 👆 💪 📣 💗 💪 🔢, ✅ `item` & `user`:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_multiple_params/tutorial002.py hl[22] *}
|
||||||
|
|
||||||
|
👉 💼, **FastAPI** 🔜 👀 👈 📤 🌅 🌘 1️⃣ 💪 🔢 🔢 (2️⃣ 🔢 👈 Pydantic 🏷).
|
||||||
|
|
||||||
|
, ⚫️ 🔜 ⤴️ ⚙️ 🔢 📛 🔑 (🏑 📛) 💪, & ⌛ 💪 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"item": {
|
||||||
|
"name": "Foo",
|
||||||
|
"description": "The pretender",
|
||||||
|
"price": 42.0,
|
||||||
|
"tax": 3.2
|
||||||
|
},
|
||||||
|
"user": {
|
||||||
|
"username": "dave",
|
||||||
|
"full_name": "Dave Grohl"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
👀 👈 ✋️ `item` 📣 🎏 🌌 ⏭, ⚫️ 🔜 ⌛ 🔘 💪 ⏮️ 🔑 `item`.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
**FastAPI** 🔜 🏧 🛠️ ⚪️➡️ 📨, 👈 🔢 `item` 📨 ⚫️ 🎯 🎚 & 🎏 `user`.
|
||||||
|
|
||||||
|
⚫️ 🔜 🎭 🔬 ⚗ 💽, & 🔜 📄 ⚫️ 💖 👈 🗄 🔗 & 🏧 🩺.
|
||||||
|
|
||||||
|
## ⭐ 💲 💪
|
||||||
|
|
||||||
|
🎏 🌌 📤 `Query` & `Path` 🔬 ➕ 💽 🔢 & ➡ 🔢, **FastAPI** 🚚 🌓 `Body`.
|
||||||
|
|
||||||
|
🖼, ↔ ⏮️ 🏷, 👆 💪 💭 👈 👆 💚 ✔️ ➕1️⃣ 🔑 `importance` 🎏 💪, 🥈 `item` & `user`.
|
||||||
|
|
||||||
|
🚥 👆 📣 ⚫️, ↩️ ⚫️ ⭐ 💲, **FastAPI** 🔜 🤔 👈 ⚫️ 🔢 🔢.
|
||||||
|
|
||||||
|
✋️ 👆 💪 💡 **FastAPI** 😥 ⚫️ ➕1️⃣ 💪 🔑 ⚙️ `Body`:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_multiple_params/tutorial003.py hl[22] *}
|
||||||
|
|
||||||
|
👉 💼, **FastAPI** 🔜 ⌛ 💪 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"item": {
|
||||||
|
"name": "Foo",
|
||||||
|
"description": "The pretender",
|
||||||
|
"price": 42.0,
|
||||||
|
"tax": 3.2
|
||||||
|
},
|
||||||
|
"user": {
|
||||||
|
"username": "dave",
|
||||||
|
"full_name": "Dave Grohl"
|
||||||
|
},
|
||||||
|
"importance": 5
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
🔄, ⚫️ 🔜 🗜 📊 🆎, ✔, 📄, ♒️.
|
||||||
|
|
||||||
|
## 💗 💪 = & 🔢
|
||||||
|
|
||||||
|
↗️, 👆 💪 📣 🌖 🔢 🔢 🕐❔ 👆 💪, 🌖 🙆 💪 🔢.
|
||||||
|
|
||||||
|
, 🔢, ⭐ 💲 🔬 🔢 🔢, 👆 🚫 ✔️ 🎯 🚮 `Query`, 👆 💪:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
q: Union[str, None] = None
|
||||||
|
```
|
||||||
|
|
||||||
|
⚖️ 🐍 3️⃣.1️⃣0️⃣ & 🔛:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
q: str | None = None
|
||||||
|
```
|
||||||
|
|
||||||
|
🖼:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_multiple_params/tutorial004.py hl[27] *}
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
`Body` ✔️ 🌐 🎏 ➕ 🔬 & 🗃 🔢 `Query`,`Path` & 🎏 👆 🔜 👀 ⏪.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⏯ 👁 💪 🔢
|
||||||
|
|
||||||
|
➡️ 💬 👆 🕴 ✔️ 👁 `item` 💪 🔢 ⚪️➡️ Pydantic 🏷 `Item`.
|
||||||
|
|
||||||
|
🔢, **FastAPI** 🔜 ⤴️ ⌛ 🚮 💪 🔗.
|
||||||
|
|
||||||
|
✋️ 🚥 👆 💚 ⚫️ ⌛ 🎻 ⏮️ 🔑 `item` & 🔘 ⚫️ 🏷 🎚, ⚫️ 🔨 🕐❔ 👆 📣 ➕ 💪 🔢, 👆 💪 ⚙️ 🎁 `Body` 🔢 `embed`:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
item: Item = Body(embed=True)
|
||||||
|
```
|
||||||
|
|
||||||
|
:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_multiple_params/tutorial005.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
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
👆 💪 🚮 💗 💪 🔢 👆 *➡ 🛠️ 🔢*, ✋️ 📨 💪 🕴 ✔️ 👁 💪.
|
||||||
|
|
||||||
|
✋️ **FastAPI** 🔜 🍵 ⚫️, 🤝 👆 ☑ 📊 👆 🔢, & ✔ & 📄 ☑ 🔗 *➡ 🛠️*.
|
||||||
|
|
||||||
|
👆 💪 📣 ⭐ 💲 📨 🍕 💪.
|
||||||
|
|
||||||
|
& 👆 💪 💡 **FastAPI** ⏯ 💪 🔑 🕐❔ 📤 🕴 👁 🔢 📣.
|
||||||
|
|
@ -0,0 +1,247 @@
|
||||||
|
# 💪 - 🔁 🏷
|
||||||
|
|
||||||
|
⏮️ **FastAPI**, 👆 💪 🔬, ✔, 📄, & ⚙️ 🎲 🙇 🐦 🏷 (👏 Pydantic).
|
||||||
|
|
||||||
|
## 📇 🏑
|
||||||
|
|
||||||
|
👆 💪 🔬 🔢 🏾. 🖼, 🐍 `list`:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial001.py hl[14] *}
|
||||||
|
|
||||||
|
👉 🔜 ⚒ `tags` 📇, 👐 ⚫️ 🚫 📣 🆎 🔣 📇.
|
||||||
|
|
||||||
|
## 📇 🏑 ⏮️ 🆎 🔢
|
||||||
|
|
||||||
|
✋️ 🐍 ✔️ 🎯 🌌 📣 📇 ⏮️ 🔗 🆎, ⚖️ "🆎 🔢":
|
||||||
|
|
||||||
|
### 🗄 ⌨ `List`
|
||||||
|
|
||||||
|
🐍 3️⃣.9️⃣ & 🔛 👆 💪 ⚙️ 🐩 `list` 📣 👫 🆎 ✍ 👥 🔜 👀 🔛. 👶
|
||||||
|
|
||||||
|
✋️ 🐍 ⏬ ⏭ 3️⃣.9️⃣ (3️⃣.6️⃣ & 🔛), 👆 🥇 💪 🗄 `List` ⚪️➡️ 🐩 🐍 `typing` 🕹:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial002.py hl[1] *}
|
||||||
|
|
||||||
|
### 📣 `list` ⏮️ 🆎 🔢
|
||||||
|
|
||||||
|
📣 🆎 👈 ✔️ 🆎 🔢 (🔗 🆎), 💖 `list`, `dict`, `tuple`:
|
||||||
|
|
||||||
|
* 🚥 👆 🐍 ⏬ 🔅 🌘 3️⃣.9️⃣, 🗄 👫 🌓 ⏬ ⚪️➡️ `typing` 🕹
|
||||||
|
* 🚶♀️ 🔗 🆎(Ⓜ) "🆎 🔢" ⚙️ ⬜ 🗜: `[` & `]`
|
||||||
|
|
||||||
|
🐍 3️⃣.9️⃣ ⚫️ 🔜:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
my_list: list[str]
|
||||||
|
```
|
||||||
|
|
||||||
|
⏬ 🐍 ⏭ 3️⃣.9️⃣, ⚫️ 🔜:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
my_list: List[str]
|
||||||
|
```
|
||||||
|
|
||||||
|
👈 🌐 🐩 🐍 ❕ 🆎 📄.
|
||||||
|
|
||||||
|
⚙️ 👈 🎏 🐩 ❕ 🏷 🔢 ⏮️ 🔗 🆎.
|
||||||
|
|
||||||
|
, 👆 🖼, 👥 💪 ⚒ `tags` 🎯 "📇 🎻":
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial002.py hl[14] *}
|
||||||
|
|
||||||
|
## ⚒ 🆎
|
||||||
|
|
||||||
|
✋️ ⤴️ 👥 💭 🔃 ⚫️, & 🤔 👈 🔖 🚫🔜 🚫 🔁, 👫 🔜 🎲 😍 🎻.
|
||||||
|
|
||||||
|
& 🐍 ✔️ 🎁 💽 🆎 ⚒ 😍 🏬, `set`.
|
||||||
|
|
||||||
|
⤴️ 👥 💪 📣 `tags` ⚒ 🎻:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial003.py hl[1,14] *}
|
||||||
|
|
||||||
|
⏮️ 👉, 🚥 👆 📨 📨 ⏮️ ❎ 📊, ⚫️ 🔜 🗜 ⚒ 😍 🏬.
|
||||||
|
|
||||||
|
& 🕐❔ 👆 🔢 👈 📊, 🚥 ℹ ✔️ ❎, ⚫️ 🔜 🔢 ⚒ 😍 🏬.
|
||||||
|
|
||||||
|
& ⚫️ 🔜 ✍ / 📄 ➡️ 💁♂️.
|
||||||
|
|
||||||
|
## 🐦 🏷
|
||||||
|
|
||||||
|
🔠 🔢 Pydantic 🏷 ✔️ 🆎.
|
||||||
|
|
||||||
|
✋️ 👈 🆎 💪 ⚫️ ➕1️⃣ Pydantic 🏷.
|
||||||
|
|
||||||
|
, 👆 💪 📣 🙇 🐦 🎻 "🎚" ⏮️ 🎯 🔢 📛, 🆎 & 🔬.
|
||||||
|
|
||||||
|
🌐 👈, 🎲 🐦.
|
||||||
|
|
||||||
|
### 🔬 📊
|
||||||
|
|
||||||
|
🖼, 👥 💪 🔬 `Image` 🏷:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial004.py hl[9:11] *}
|
||||||
|
|
||||||
|
### ⚙️ 📊 🆎
|
||||||
|
|
||||||
|
& ⤴️ 👥 💪 ⚙️ ⚫️ 🆎 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial004.py hl[20] *}
|
||||||
|
|
||||||
|
👉 🔜 ⛓ 👈 **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** 👆 🤚:
|
||||||
|
|
||||||
|
* 👨🎨 🐕🦺 (🛠️, ♒️), 🐦 🏷
|
||||||
|
* 💽 🛠️
|
||||||
|
* 💽 🔬
|
||||||
|
* 🏧 🧾
|
||||||
|
|
||||||
|
## 🎁 🆎 & 🔬
|
||||||
|
|
||||||
|
↖️ ⚪️➡️ 😐 ⭐ 🆎 💖 `str`, `int`, `float`, ♒️. 👆 💪 ⚙️ 🌅 🏗 ⭐ 🆎 👈 😖 ⚪️➡️ `str`.
|
||||||
|
|
||||||
|
👀 🌐 🎛 👆 ✔️, 🛒 🩺 <a href="https://docs.pydantic.dev/latest/concepts/types/" class="external-link" target="_blank">Pydantic 😍 🆎</a>. 👆 🔜 👀 🖼 ⏭ 📃.
|
||||||
|
|
||||||
|
🖼, `Image` 🏷 👥 ✔️ `url` 🏑, 👥 💪 📣 ⚫️ ↩️ `str`, Pydantic `HttpUrl`:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial005.py hl[4,10] *}
|
||||||
|
|
||||||
|
🎻 🔜 ✅ ☑ 📛, & 📄 🎻 🔗 / 🗄 ✅.
|
||||||
|
|
||||||
|
## 🔢 ⏮️ 📇 📊
|
||||||
|
|
||||||
|
👆 💪 ⚙️ Pydantic 🏷 🏾 `list`, `set`, ♒️:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial006.py hl[20] *}
|
||||||
|
|
||||||
|
👉 🔜 ⌛ (🗜, ✔, 📄, ♒️) 🎻 💪 💖:
|
||||||
|
|
||||||
|
```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` 🔑 🔜 ✔️ 📇 🖼 🎚.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🙇 🐦 🏷
|
||||||
|
|
||||||
|
👆 💪 🔬 🎲 🙇 🐦 🏷:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial007.py hl[9,14,20,23,27] *}
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
👀 ❔ `Offer` ✔️ 📇 `Item`Ⓜ, ❔ 🔄 ✔️ 📦 📇 `Image`Ⓜ
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 💪 😁 📇
|
||||||
|
|
||||||
|
🚥 🔝 🎚 💲 🎻 💪 👆 ⌛ 🎻 `array` (🐍 `list`), 👆 💪 📣 🆎 🔢 🔢, 🎏 Pydantic 🏷:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
images: List[Image]
|
||||||
|
```
|
||||||
|
|
||||||
|
⚖️ 🐍 3️⃣.9️⃣ & 🔛:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
images: list[Image]
|
||||||
|
```
|
||||||
|
|
||||||
|
:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial008.py hl[15] *}
|
||||||
|
|
||||||
|
## 👨🎨 🐕🦺 🌐
|
||||||
|
|
||||||
|
& 👆 🤚 👨🎨 🐕🦺 🌐.
|
||||||
|
|
||||||
|
🏬 🔘 📇:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/body-nested-models/image01.png">
|
||||||
|
|
||||||
|
👆 🚫 🚫 🤚 👉 😇 👨🎨 🐕🦺 🚥 👆 👷 🔗 ⏮️ `dict` ↩️ Pydantic 🏷.
|
||||||
|
|
||||||
|
✋️ 👆 🚫 ✔️ 😟 🔃 👫 👯♂️, 📨 #️⃣ 🗜 🔁 & 👆 🔢 🗜 🔁 🎻 💁♂️.
|
||||||
|
|
||||||
|
## 💪 ❌ `dict`Ⓜ
|
||||||
|
|
||||||
|
👆 💪 📣 💪 `dict` ⏮️ 🔑 🆎 & 💲 🎏 🆎.
|
||||||
|
|
||||||
|
🍵 ✔️ 💭 ⏪ ⚫️❔ ☑ 🏑/🔢 📛 (🔜 💼 ⏮️ Pydantic 🏷).
|
||||||
|
|
||||||
|
👉 🔜 ⚠ 🚥 👆 💚 📨 🔑 👈 👆 🚫 ⏪ 💭.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🎏 ⚠ 💼 🕐❔ 👆 💚 ✔️ 🔑 🎏 🆎, ✅ `int`.
|
||||||
|
|
||||||
|
👈 ⚫️❔ 👥 🔜 👀 📥.
|
||||||
|
|
||||||
|
👉 💼, 👆 🔜 🚫 🙆 `dict` 📏 ⚫️ ✔️ `int` 🔑 ⏮️ `float` 💲:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_nested_models/tutorial009.py hl[9] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
✔️ 🤯 👈 🎻 🕴 🐕🦺 `str` 🔑.
|
||||||
|
|
||||||
|
✋️ Pydantic ✔️ 🏧 💽 🛠️.
|
||||||
|
|
||||||
|
👉 ⛓ 👈, ✋️ 👆 🛠️ 👩💻 💪 🕴 📨 🎻 🔑, 📏 👈 🎻 🔌 😁 🔢, Pydantic 🔜 🗜 👫 & ✔ 👫.
|
||||||
|
|
||||||
|
& `dict` 👆 📨 `weights` 🔜 🤙 ✔️ `int` 🔑 & `float` 💲.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
⏮️ **FastAPI** 👆 ✔️ 🔆 💪 🚚 Pydantic 🏷, ⏪ 🚧 👆 📟 🙅, 📏 & 😍.
|
||||||
|
|
||||||
|
✋️ ⏮️ 🌐 💰:
|
||||||
|
|
||||||
|
* 👨🎨 🐕🦺 (🛠️ 🌐 ❗)
|
||||||
|
* 💽 🛠️ (.Ⓜ.. ✍ / 🛠️)
|
||||||
|
* 💽 🔬
|
||||||
|
* 🔗 🧾
|
||||||
|
* 🏧 🩺
|
||||||
|
|
@ -0,0 +1,100 @@
|
||||||
|
# 💪 - ℹ
|
||||||
|
|
||||||
|
## ℹ ❎ ⏮️ `PUT`
|
||||||
|
|
||||||
|
ℹ 🏬 👆 💪 ⚙️ <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT" class="external-link" target="_blank">🇺🇸🔍 `PUT`</a> 🛠️.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `jsonable_encoder` 🗜 🔢 💽 📊 👈 💪 🏪 🎻 (✅ ⏮️ ☁ 💽). 🖼, 🏭 `datetime` `str`.
|
||||||
|
|
||||||
|
{* ../../docs_src/body_updates/tutorial001.py hl[30:35] *}
|
||||||
|
|
||||||
|
`PUT` ⚙️ 📨 💽 👈 🔜 ❎ ♻ 💽.
|
||||||
|
|
||||||
|
### ⚠ 🔃 ❎
|
||||||
|
|
||||||
|
👈 ⛓ 👈 🚥 👆 💚 ℹ 🏬 `bar` ⚙️ `PUT` ⏮️ 💪 ⚗:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
{
|
||||||
|
"name": "Barz",
|
||||||
|
"price": 3,
|
||||||
|
"description": None,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
↩️ ⚫️ 🚫 🔌 ⏪ 🏪 🔢 `"tax": 20.2`, 🔢 🏷 🔜 ✊ 🔢 💲 `"tax": 10.5`.
|
||||||
|
|
||||||
|
& 📊 🔜 🖊 ⏮️ 👈 "🆕" `tax` `10.5`.
|
||||||
|
|
||||||
|
## 🍕 ℹ ⏮️ `PATCH`
|
||||||
|
|
||||||
|
👆 💪 ⚙️ <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH" class="external-link" target="_blank">🇺🇸🔍 `PATCH`</a> 🛠️ *🍕* ℹ 💽.
|
||||||
|
|
||||||
|
👉 ⛓ 👈 👆 💪 📨 🕴 💽 👈 👆 💚 ℹ, 🍂 🎂 🐣.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
`PATCH` 🌘 🛎 ⚙️ & 💭 🌘 `PUT`.
|
||||||
|
|
||||||
|
& 📚 🏉 ⚙️ 🕴 `PUT`, 🍕 ℹ.
|
||||||
|
|
||||||
|
👆 **🆓** ⚙️ 👫 👐 👆 💚, **FastAPI** 🚫 🚫 🙆 🚫.
|
||||||
|
|
||||||
|
✋️ 👉 🦮 🎦 👆, 🌖 ⚖️ 🌘, ❔ 👫 🎯 ⚙️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
### ⚙️ Pydantic `exclude_unset` 🔢
|
||||||
|
|
||||||
|
🚥 👆 💚 📨 🍕 ℹ, ⚫️ 📶 ⚠ ⚙️ 🔢 `exclude_unset` Pydantic 🏷 `.dict()`.
|
||||||
|
|
||||||
|
💖 `item.dict(exclude_unset=True)`.
|
||||||
|
|
||||||
|
👈 🔜 🏗 `dict` ⏮️ 🕴 💽 👈 ⚒ 🕐❔ 🏗 `item` 🏷, 🚫 🔢 💲.
|
||||||
|
|
||||||
|
⤴️ 👆 💪 ⚙️ 👉 🏗 `dict` ⏮️ 🕴 💽 👈 ⚒ (📨 📨), 🚫 🔢 💲:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_updates/tutorial002.py hl[34] *}
|
||||||
|
|
||||||
|
### ⚙️ Pydantic `update` 🔢
|
||||||
|
|
||||||
|
🔜, 👆 💪 ✍ 📁 ♻ 🏷 ⚙️ `.copy()`, & 🚶♀️ `update` 🔢 ⏮️ `dict` ⚗ 💽 ℹ.
|
||||||
|
|
||||||
|
💖 `stored_item_model.copy(update=update_data)`:
|
||||||
|
|
||||||
|
{* ../../docs_src/body_updates/tutorial002.py hl[35] *}
|
||||||
|
|
||||||
|
### 🍕 ℹ 🌃
|
||||||
|
|
||||||
|
📄, ✔ 🍕 ℹ 👆 🔜:
|
||||||
|
|
||||||
|
* (⚗) ⚙️ `PATCH` ↩️ `PUT`.
|
||||||
|
* 🗃 🏪 💽.
|
||||||
|
* 🚮 👈 💽 Pydantic 🏷.
|
||||||
|
* 🏗 `dict` 🍵 🔢 💲 ⚪️➡️ 🔢 🏷 (⚙️ `exclude_unset`).
|
||||||
|
* 👉 🌌 👆 💪 ℹ 🕴 💲 🤙 ⚒ 👩💻, ↩️ 🔐 💲 ⏪ 🏪 ⏮️ 🔢 💲 👆 🏷.
|
||||||
|
* ✍ 📁 🏪 🏷, 🛠️ ⚫️ 🔢 ⏮️ 📨 🍕 ℹ (⚙️ `update` 🔢).
|
||||||
|
* 🗜 📁 🏷 🕳 👈 💪 🏪 👆 💽 (🖼, ⚙️ `jsonable_encoder`).
|
||||||
|
* 👉 ⭐ ⚙️ 🏷 `.dict()` 👩🔬 🔄, ✋️ ⚫️ ⚒ 💭 (& 🗜) 💲 💽 🆎 👈 💪 🗜 🎻, 🖼, `datetime` `str`.
|
||||||
|
* 🖊 💽 👆 💽.
|
||||||
|
* 📨 ℹ 🏷.
|
||||||
|
|
||||||
|
{* ../../docs_src/body_updates/tutorial002.py hl[30:37] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👆 💪 🤙 ⚙️ 👉 🎏 ⚒ ⏮️ 🇺🇸🔍 `PUT` 🛠️.
|
||||||
|
|
||||||
|
✋️ 🖼 📥 ⚙️ `PATCH` ↩️ ⚫️ ✍ 👫 ⚙️ 💼.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
👀 👈 🔢 🏷 ✔.
|
||||||
|
|
||||||
|
, 🚥 👆 💚 📨 🍕 ℹ 👈 💪 🚫 🌐 🔢, 👆 💪 ✔️ 🏷 ⏮️ 🌐 🔢 ™ 📦 (⏮️ 🔢 💲 ⚖️ `None`).
|
||||||
|
|
||||||
|
🔬 ⚪️➡️ 🏷 ⏮️ 🌐 📦 💲 **ℹ** & 🏷 ⏮️ ✔ 💲 **🏗**, 👆 💪 ⚙️ 💭 🔬 [➕ 🏷](extra-models.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,162 @@
|
||||||
|
# 📨 💪
|
||||||
|
|
||||||
|
🕐❔ 👆 💪 📨 📊 ⚪️➡️ 👩💻 (➡️ 💬, 🖥) 👆 🛠️, 👆 📨 ⚫️ **📨 💪**.
|
||||||
|
|
||||||
|
**📨** 💪 📊 📨 👩💻 👆 🛠️. **📨** 💪 💽 👆 🛠️ 📨 👩💻.
|
||||||
|
|
||||||
|
👆 🛠️ 🌖 🕧 ✔️ 📨 **📨** 💪. ✋️ 👩💻 🚫 🎯 💪 📨 **📨** 💪 🌐 🕰.
|
||||||
|
|
||||||
|
📣 **📨** 💪, 👆 ⚙️ <a href="https://docs.pydantic.dev/" class="external-link" target="_blank">Pydantic</a> 🏷 ⏮️ 🌐 👫 🏋️ & 💰.
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
📨 💽, 👆 🔜 ⚙️ 1️⃣: `POST` (🌅 ⚠), `PUT`, `DELETE` ⚖️ `PATCH`.
|
||||||
|
|
||||||
|
📨 💪 ⏮️ `GET` 📨 ✔️ ⚠ 🎭 🔧, 👐, ⚫️ 🐕🦺 FastAPI, 🕴 📶 🏗/😕 ⚙️ 💼.
|
||||||
|
|
||||||
|
⚫️ 🚫, 🎓 🩺 ⏮️ 🦁 🎚 🏆 🚫 🎦 🧾 💪 🕐❔ ⚙️ `GET`, & 🗳 🖕 💪 🚫 🐕🦺 ⚫️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🗄 Pydantic `BaseModel`
|
||||||
|
|
||||||
|
🥇, 👆 💪 🗄 `BaseModel` ⚪️➡️ `pydantic`:
|
||||||
|
|
||||||
|
{* ../../docs_src/body/tutorial001.py hl[4] *}
|
||||||
|
|
||||||
|
## ✍ 👆 💽 🏷
|
||||||
|
|
||||||
|
⤴️ 👆 📣 👆 💽 🏷 🎓 👈 😖 ⚪️➡️ `BaseModel`.
|
||||||
|
|
||||||
|
⚙️ 🐩 🐍 🆎 🌐 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/body/tutorial001.py hl[7:11] *}
|
||||||
|
|
||||||
|
🎏 🕐❔ 📣 🔢 🔢, 🕐❔ 🏷 🔢 ✔️ 🔢 💲, ⚫️ 🚫 ✔. ⏪, ⚫️ ✔. ⚙️ `None` ⚒ ⚫️ 📦.
|
||||||
|
|
||||||
|
🖼, 👉 🏷 🔛 📣 🎻 "`object`" (⚖️ 🐍 `dict`) 💖:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"name": "Foo",
|
||||||
|
"description": "An optional description",
|
||||||
|
"price": 45.2,
|
||||||
|
"tax": 3.5
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
... `description` & `tax` 📦 (⏮️ 🔢 💲 `None`), 👉 🎻 "`object`" 🔜 ☑:
|
||||||
|
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"name": "Foo",
|
||||||
|
"price": 45.2
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📣 ⚫️ 🔢
|
||||||
|
|
||||||
|
🚮 ⚫️ 👆 *➡ 🛠️*, 📣 ⚫️ 🎏 🌌 👆 📣 ➡ & 🔢 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/body/tutorial001.py hl[18] *}
|
||||||
|
|
||||||
|
...& 📣 🚮 🆎 🏷 👆 ✍, `Item`.
|
||||||
|
|
||||||
|
## 🏁
|
||||||
|
|
||||||
|
⏮️ 👈 🐍 🆎 📄, **FastAPI** 🔜:
|
||||||
|
|
||||||
|
* ✍ 💪 📨 🎻.
|
||||||
|
* 🗜 🔗 🆎 (🚥 💪).
|
||||||
|
* ✔ 💽.
|
||||||
|
* 🚥 💽 ❌, ⚫️ 🔜 📨 👌 & 🆑 ❌, ☠️ ⚫️❔ 🌐❔ & ⚫️❔ ❌ 📊.
|
||||||
|
* 🤝 👆 📨 📊 🔢 `item`.
|
||||||
|
* 👆 📣 ⚫️ 🔢 🆎 `Item`, 👆 🔜 ✔️ 🌐 👨🎨 🐕🦺 (🛠️, ♒️) 🌐 🔢 & 👫 🆎.
|
||||||
|
* 🏗 <a href="https://json-schema.org" class="external-link" target="_blank">🎻 🔗</a> 🔑 👆 🏷, 👆 💪 ⚙️ 👫 🙆 🙆 👆 💖 🚥 ⚫️ ⚒ 🔑 👆 🏗.
|
||||||
|
* 👈 🔗 🔜 🍕 🏗 🗄 🔗, & ⚙️ 🏧 🧾 <abbr title="User Interfaces">⚜</abbr>.
|
||||||
|
|
||||||
|
## 🏧 🩺
|
||||||
|
|
||||||
|
🎻 🔗 👆 🏷 🔜 🍕 👆 🗄 🏗 🔗, & 🔜 🎦 🎓 🛠️ 🩺:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/body/image01.png">
|
||||||
|
|
||||||
|
& 🔜 ⚙️ 🛠️ 🩺 🔘 🔠 *➡ 🛠️* 👈 💪 👫:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/body/image02.png">
|
||||||
|
|
||||||
|
## 👨🎨 🐕🦺
|
||||||
|
|
||||||
|
👆 👨🎨, 🔘 👆 🔢 👆 🔜 🤚 🆎 🔑 & 🛠️ 🌐 (👉 🚫🔜 🔨 🚥 👆 📨 `dict` ↩️ Pydantic 🏷):
|
||||||
|
|
||||||
|
<img src="/img/tutorial/body/image03.png">
|
||||||
|
|
||||||
|
👆 🤚 ❌ ✅ ❌ 🆎 🛠️:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/body/image04.png">
|
||||||
|
|
||||||
|
👉 🚫 🤞, 🎂 🛠️ 🏗 🤭 👈 🔧.
|
||||||
|
|
||||||
|
& ⚫️ 🙇 💯 🔧 🌓, ⏭ 🙆 🛠️, 🚚 ⚫️ 🔜 👷 ⏮️ 🌐 👨🎨.
|
||||||
|
|
||||||
|
📤 🔀 Pydantic ⚫️ 🐕🦺 👉.
|
||||||
|
|
||||||
|
⏮️ 🖼 ✊ ⏮️ <a href="https://code.visualstudio.com" class="external-link" target="_blank">🎙 🎙 📟</a>.
|
||||||
|
|
||||||
|
✋️ 👆 🔜 🤚 🎏 👨🎨 🐕🦺 ⏮️ <a href="https://www.jetbrains.com/pycharm/" class="external-link" target="_blank">🗒</a> & 🌅 🎏 🐍 👨🎨:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/body/image05.png">
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ <a href="https://www.jetbrains.com/pycharm/" class="external-link" target="_blank">🗒</a> 👆 👨🎨, 👆 💪 ⚙️ <a href="https://github.com/koxudaxi/pydantic-pycharm-plugin/" class="external-link" target="_blank">Pydantic 🗒 📁</a>.
|
||||||
|
|
||||||
|
⚫️ 📉 👨🎨 🐕🦺 Pydantic 🏷, ⏮️:
|
||||||
|
|
||||||
|
* 🚘-🛠️
|
||||||
|
* 🆎 ✅
|
||||||
|
* 🛠️
|
||||||
|
* 🔎
|
||||||
|
* 🔬
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## ⚙️ 🏷
|
||||||
|
|
||||||
|
🔘 🔢, 👆 💪 🔐 🌐 🔢 🏷 🎚 🔗:
|
||||||
|
|
||||||
|
{* ../../docs_src/body/tutorial002.py hl[21] *}
|
||||||
|
|
||||||
|
## 📨 💪 ➕ ➡ 🔢
|
||||||
|
|
||||||
|
👆 💪 📣 ➡ 🔢 & 📨 💪 🎏 🕰.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 🤔 👈 🔢 🔢 👈 🏏 ➡ 🔢 🔜 **✊ ⚪️➡️ ➡**, & 👈 🔢 🔢 👈 📣 Pydantic 🏷 🔜 **✊ ⚪️➡️ 📨 💪**.
|
||||||
|
|
||||||
|
{* ../../docs_src/body/tutorial003.py hl[17:18] *}
|
||||||
|
|
||||||
|
## 📨 💪 ➕ ➡ ➕ 🔢 🔢
|
||||||
|
|
||||||
|
👆 💪 📣 **💪**, **➡** & **🔢** 🔢, 🌐 🎏 🕰.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 🤔 🔠 👫 & ✊ 📊 ⚪️➡️ ☑ 🥉.
|
||||||
|
|
||||||
|
{* ../../docs_src/body/tutorial004.py hl[18] *}
|
||||||
|
|
||||||
|
🔢 🔢 🔜 🤔 ⏩:
|
||||||
|
|
||||||
|
* 🚥 🔢 📣 **➡**, ⚫️ 🔜 ⚙️ ➡ 🔢.
|
||||||
|
* 🚥 🔢 **⭐ 🆎** (💖 `int`, `float`, `str`, `bool`, ♒️) ⚫️ 🔜 🔬 **🔢** 🔢.
|
||||||
|
* 🚥 🔢 📣 🆎 **Pydantic 🏷**, ⚫️ 🔜 🔬 📨 **💪**.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
FastAPI 🔜 💭 👈 💲 `q` 🚫 ✔ ↩️ 🔢 💲 `= None`.
|
||||||
|
|
||||||
|
`Union` `Union[str, None]` 🚫 ⚙️ FastAPI, ✋️ 🔜 ✔ 👆 👨🎨 🤝 👆 👍 🐕🦺 & 🔍 ❌.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🍵 Pydantic
|
||||||
|
|
||||||
|
🚥 👆 🚫 💚 ⚙️ Pydantic 🏷, 👆 💪 ⚙️ **💪** 🔢. 👀 🩺 [💪 - 💗 🔢: ⭐ 💲 💪](body-multiple-params.md#_2){.internal-link target=_blank}.
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
# 🍪 🔢
|
||||||
|
|
||||||
|
👆 💪 🔬 🍪 🔢 🎏 🌌 👆 🔬 `Query` & `Path` 🔢.
|
||||||
|
|
||||||
|
## 🗄 `Cookie`
|
||||||
|
|
||||||
|
🥇 🗄 `Cookie`:
|
||||||
|
|
||||||
|
{* ../../docs_src/cookie_params/tutorial001.py hl[3] *}
|
||||||
|
|
||||||
|
## 📣 `Cookie` 🔢
|
||||||
|
|
||||||
|
⤴️ 📣 🍪 🔢 ⚙️ 🎏 📊 ⏮️ `Path` & `Query`.
|
||||||
|
|
||||||
|
🥇 💲 🔢 💲, 👆 💪 🚶♀️ 🌐 ➕ 🔬 ⚖️ ✍ 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/cookie_params/tutorial001.py hl[9] *}
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
`Cookie` "👭" 🎓 `Path` & `Query`. ⚫️ 😖 ⚪️➡️ 🎏 ⚠ `Param` 🎓.
|
||||||
|
|
||||||
|
✋️ 💭 👈 🕐❔ 👆 🗄 `Query`, `Path`, `Cookie` & 🎏 ⚪️➡️ `fastapi`, 👈 🤙 🔢 👈 📨 🎁 🎓.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
📣 🍪, 👆 💪 ⚙️ `Cookie`, ↩️ ⏪ 🔢 🔜 🔬 🔢 🔢.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
📣 🍪 ⏮️ `Cookie`, ⚙️ 🎏 ⚠ ⚓ `Query` & `Path`.
|
||||||
|
|
@ -0,0 +1,85 @@
|
||||||
|
# ⚜ (✖️-🇨🇳 ℹ 🤝)
|
||||||
|
|
||||||
|
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS" class="external-link" target="_blank">⚜ ⚖️ "✖️-🇨🇳 ℹ 🤝"</a> 🔗 ⚠ 🕐❔ 🕸 🏃♂ 🖥 ✔️ 🕸 📟 👈 🔗 ⏮️ 👩💻, & 👩💻 🎏 "🇨🇳" 🌘 🕸.
|
||||||
|
|
||||||
|
## 🇨🇳
|
||||||
|
|
||||||
|
🇨🇳 🌀 🛠️ (`http`, `https`), 🆔 (`myapp.com`, `localhost`, `localhost.tiangolo.com`), & ⛴ (`80`, `443`, `8080`).
|
||||||
|
|
||||||
|
, 🌐 👫 🎏 🇨🇳:
|
||||||
|
|
||||||
|
* `http://localhost`
|
||||||
|
* `https://localhost`
|
||||||
|
* `http://localhost:8080`
|
||||||
|
|
||||||
|
🚥 👫 🌐 `localhost`, 👫 ⚙️ 🎏 🛠️ ⚖️ ⛴,, 👫 🎏 "🇨🇳".
|
||||||
|
|
||||||
|
## 🔁
|
||||||
|
|
||||||
|
, ➡️ 💬 👆 ✔️ 🕸 🏃 👆 🖥 `http://localhost:8080`, & 🚮 🕸 🔄 🔗 ⏮️ 👩💻 🏃 `http://localhost` (↩️ 👥 🚫 ✔ ⛴, 🖥 🔜 🤔 🔢 ⛴ `80`).
|
||||||
|
|
||||||
|
⤴️, 🖥 🔜 📨 🇺🇸🔍 `OPTIONS` 📨 👩💻, & 🚥 👩💻 📨 ☑ 🎚 ✔ 📻 ⚪️➡️ 👉 🎏 🇨🇳 (`http://localhost:8080`) ⤴️ 🖥 🔜 ➡️ 🕸 🕸 📨 🚮 📨 👩💻.
|
||||||
|
|
||||||
|
🏆 👉, 👩💻 🔜 ✔️ 📇 "✔ 🇨🇳".
|
||||||
|
|
||||||
|
👉 💼, ⚫️ 🔜 ✔️ 🔌 `http://localhost:8080` 🕸 👷 ☑.
|
||||||
|
|
||||||
|
## 🃏
|
||||||
|
|
||||||
|
⚫️ 💪 📣 📇 `"*"` ("🃏") 💬 👈 🌐 ✔.
|
||||||
|
|
||||||
|
✋️ 👈 🔜 🕴 ✔ 🎯 🆎 📻, 🚫 🌐 👈 🔌 🎓: 🍪, ✔ 🎚 💖 📚 ⚙️ ⏮️ 📨 🤝, ♒️.
|
||||||
|
|
||||||
|
, 🌐 👷 ☑, ⚫️ 👻 ✔ 🎯 ✔ 🇨🇳.
|
||||||
|
|
||||||
|
## ⚙️ `CORSMiddleware`
|
||||||
|
|
||||||
|
👆 💪 🔗 ⚫️ 👆 **FastAPI** 🈸 ⚙️ `CORSMiddleware`.
|
||||||
|
|
||||||
|
* 🗄 `CORSMiddleware`.
|
||||||
|
* ✍ 📇 ✔ 🇨🇳 (🎻).
|
||||||
|
* 🚮 ⚫️ "🛠️" 👆 **FastAPI** 🈸.
|
||||||
|
|
||||||
|
👆 💪 ✔ 🚥 👆 👩💻 ✔:
|
||||||
|
|
||||||
|
* 🎓 (✔ 🎚, 🍪, ♒️).
|
||||||
|
* 🎯 🇺🇸🔍 👩🔬 (`POST`, `PUT`) ⚖️ 🌐 👫 ⏮️ 🃏 `"*"`.
|
||||||
|
* 🎯 🇺🇸🔍 🎚 ⚖️ 🌐 👫 ⏮️ 🃏 `"*"`.
|
||||||
|
|
||||||
|
{* ../../docs_src/cors/tutorial001.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` - 📇 🇺🇸🔍 👩🔬 👈 🔜 ✔ ✖️-🇨🇳 📨. 🔢 `['GET']`. 👆 💪 ⚙️ `['*']` ✔ 🌐 🐩 👩🔬.
|
||||||
|
* `allow_headers` - 📇 🇺🇸🔍 📨 🎚 👈 🔜 🐕🦺 ✖️-🇨🇳 📨. 🔢 `[]`. 👆 💪 ⚙️ `['*']` ✔ 🌐 🎚. `Accept`, `Accept-Language`, `Content-Language` & `Content-Type` 🎚 🕧 ✔ <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#simple_requests" class="external-link" rel="noopener" target="_blank">🙅 ⚜ 📨</a>.
|
||||||
|
* `allow_credentials` - 🎦 👈 🍪 🔜 🐕🦺 ✖️-🇨🇳 📨. 🔢 `False`. , `allow_origins` 🚫🔜 ⚒ `['*']` 🎓 ✔, 🇨🇳 🔜 ✔.
|
||||||
|
* `expose_headers` - 🎦 🙆 📨 🎚 👈 🔜 ⚒ ♿ 🖥. 🔢 `[]`.
|
||||||
|
* `max_age` - ⚒ 🔆 🕰 🥈 🖥 💾 ⚜ 📨. 🔢 `600`.
|
||||||
|
|
||||||
|
🛠️ 📨 2️⃣ 🎯 🆎 🇺🇸🔍 📨...
|
||||||
|
|
||||||
|
### ⚜ 🛫 📨
|
||||||
|
|
||||||
|
👉 🙆 `OPTIONS` 📨 ⏮️ `Origin` & `Access-Control-Request-Method` 🎚.
|
||||||
|
|
||||||
|
👉 💼 🛠️ 🔜 🆘 📨 📨 & 📨 ⏮️ ☑ ⚜ 🎚, & 👯♂️ `200` ⚖️ `400` 📨 🎓 🎯.
|
||||||
|
|
||||||
|
### 🙅 📨
|
||||||
|
|
||||||
|
🙆 📨 ⏮️ `Origin` 🎚. 👉 💼 🛠️ 🔜 🚶♀️ 📨 🔘 😐, ✋️ 🔜 🔌 ☑ ⚜ 🎚 🔛 📨.
|
||||||
|
|
||||||
|
## 🌅 ℹ
|
||||||
|
|
||||||
|
🌖 ℹ 🔃 <abbr title="Cross-Origin Resource Sharing">⚜</abbr>, ✅ <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS" class="external-link" target="_blank">🦎 ⚜ 🧾</a>.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `from starlette.middleware.cors import CORSMiddleware`.
|
||||||
|
|
||||||
|
**FastAPI** 🚚 📚 🛠️ `fastapi.middleware` 🏪 👆, 👩💻. ✋️ 🌅 💪 🛠️ 👟 🔗 ⚪️➡️ 💃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,113 @@
|
||||||
|
# 🛠️
|
||||||
|
|
||||||
|
👆 💪 🔗 🕹 👆 👨🎨, 🖼 ⏮️ 🎙 🎙 📟 ⚖️ 🗒.
|
||||||
|
|
||||||
|
## 🤙 `uvicorn`
|
||||||
|
|
||||||
|
👆 FastAPI 🈸, 🗄 & 🏃 `uvicorn` 🔗:
|
||||||
|
|
||||||
|
{* ../../docs_src/debugging/tutorial001.py hl[1,15] *}
|
||||||
|
|
||||||
|
### 🔃 `__name__ == "__main__"`
|
||||||
|
|
||||||
|
👑 🎯 `__name__ == "__main__"` ✔️ 📟 👈 🛠️ 🕐❔ 👆 📁 🤙 ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ python myapp.py
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
✋️ 🚫 🤙 🕐❔ ➕1️⃣ 📁 🗄 ⚫️, 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
from myapp import app
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 🌅 ℹ
|
||||||
|
|
||||||
|
➡️ 💬 👆 📁 🌟 `myapp.py`.
|
||||||
|
|
||||||
|
🚥 👆 🏃 ⚫️ ⏮️:
|
||||||
|
|
||||||
|
<div class="termy">
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ python myapp.py
|
||||||
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
⤴️ 🔗 🔢 `__name__` 👆 📁, ✍ 🔁 🐍, 🔜 ✔️ 💲 🎻 `"__main__"`.
|
||||||
|
|
||||||
|
, 📄:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
uvicorn.run(app, host="0.0.0.0", port=8000)
|
||||||
|
```
|
||||||
|
|
||||||
|
🔜 🏃.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👉 🏆 🚫 🔨 🚥 👆 🗄 👈 🕹 (📁).
|
||||||
|
|
||||||
|
, 🚥 👆 ✔️ ➕1️⃣ 📁 `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
|
||||||
|
|
||||||
|
🌅 ℹ, ✅ <a href="https://docs.python.org/3/library/__main__.html" class="external-link" target="_blank">🛂 🐍 🩺</a>.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🏃 👆 📟 ⏮️ 👆 🕹
|
||||||
|
|
||||||
|
↩️ 👆 🏃 Uvicorn 💽 🔗 ⚪️➡️ 👆 📟, 👆 💪 🤙 👆 🐍 📋 (👆 FastAPI 🈸) 🔗 ⚪️➡️ 🕹.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🖼, 🎙 🎙 📟, 👆 💪:
|
||||||
|
|
||||||
|
* 🚶 "ℹ" 🎛.
|
||||||
|
* "🚮 📳...".
|
||||||
|
* 🖊 "🐍"
|
||||||
|
* 🏃 🕹 ⏮️ 🎛 "`Python: Current File (Integrated Terminal)`".
|
||||||
|
|
||||||
|
⚫️ 🔜 ⤴️ ▶️ 💽 ⏮️ 👆 **FastAPI** 📟, ⛔️ 👆 0️⃣, ♒️.
|
||||||
|
|
||||||
|
📥 ❔ ⚫️ 💪 👀:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/debugging/image01.png">
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ 🗒, 👆 💪:
|
||||||
|
|
||||||
|
* 📂 "🏃" 🍣.
|
||||||
|
* 🖊 🎛 "ℹ...".
|
||||||
|
* ⤴️ 🔑 🍣 🎦 🆙.
|
||||||
|
* 🖊 📁 ℹ (👉 💼, `main.py`).
|
||||||
|
|
||||||
|
⚫️ 🔜 ⤴️ ▶️ 💽 ⏮️ 👆 **FastAPI** 📟, ⛔️ 👆 0️⃣, ♒️.
|
||||||
|
|
||||||
|
📥 ❔ ⚫️ 💪 👀:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/debugging/image02.png">
|
||||||
|
|
@ -0,0 +1,180 @@
|
||||||
|
# 🎓 🔗
|
||||||
|
|
||||||
|
⏭ 🤿 ⏬ 🔘 **🔗 💉** ⚙️, ➡️ ♻ ⏮️ 🖼.
|
||||||
|
|
||||||
|
## `dict` ⚪️➡️ ⏮️ 🖼
|
||||||
|
|
||||||
|
⏮️ 🖼, 👥 🛬 `dict` ⚪️➡️ 👆 🔗 ("☑"):
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial001.py hl[9] *}
|
||||||
|
|
||||||
|
✋️ ⤴️ 👥 🤚 `dict` 🔢 `commons` *➡ 🛠️ 🔢*.
|
||||||
|
|
||||||
|
& 👥 💭 👈 👨🎨 💪 🚫 🚚 📚 🐕🦺 (💖 🛠️) `dict`Ⓜ, ↩️ 👫 💪 🚫 💭 👫 🔑 & 💲 🆎.
|
||||||
|
|
||||||
|
👥 💪 👍...
|
||||||
|
|
||||||
|
## ⚫️❔ ⚒ 🔗
|
||||||
|
|
||||||
|
🆙 🔜 👆 ✔️ 👀 🔗 📣 🔢.
|
||||||
|
|
||||||
|
✋️ 👈 🚫 🕴 🌌 📣 🔗 (👐 ⚫️ 🔜 🎲 🌖 ⚠).
|
||||||
|
|
||||||
|
🔑 ⚖ 👈 🔗 🔜 "🇧🇲".
|
||||||
|
|
||||||
|
"**🇧🇲**" 🐍 🕳 👈 🐍 💪 "🤙" 💖 🔢.
|
||||||
|
|
||||||
|
, 🚥 👆 ✔️ 🎚 `something` (👈 💪 _🚫_ 🔢) & 👆 💪 "🤙" ⚫️ (🛠️ ⚫️) 💖:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
something()
|
||||||
|
```
|
||||||
|
|
||||||
|
⚖️
|
||||||
|
|
||||||
|
```Python
|
||||||
|
something(some_argument, some_keyword_argument="foo")
|
||||||
|
```
|
||||||
|
|
||||||
|
⤴️ ⚫️ "🇧🇲".
|
||||||
|
|
||||||
|
## 🎓 🔗
|
||||||
|
|
||||||
|
👆 5️⃣📆 👀 👈 ✍ 👐 🐍 🎓, 👆 ⚙️ 👈 🎏 ❕.
|
||||||
|
|
||||||
|
🖼:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
class Cat:
|
||||||
|
def __init__(self, name: str):
|
||||||
|
self.name = name
|
||||||
|
|
||||||
|
|
||||||
|
fluffy = Cat(name="Mr Fluffy")
|
||||||
|
```
|
||||||
|
|
||||||
|
👉 💼, `fluffy` 👐 🎓 `Cat`.
|
||||||
|
|
||||||
|
& ✍ `fluffy`, 👆 "🤙" `Cat`.
|
||||||
|
|
||||||
|
, 🐍 🎓 **🇧🇲**.
|
||||||
|
|
||||||
|
⤴️, **FastAPI**, 👆 💪 ⚙️ 🐍 🎓 🔗.
|
||||||
|
|
||||||
|
⚫️❔ FastAPI 🤙 ✅ 👈 ⚫️ "🇧🇲" (🔢, 🎓 ⚖️ 🕳 🙆) & 🔢 🔬.
|
||||||
|
|
||||||
|
🚥 👆 🚶♀️ "🇧🇲" 🔗 **FastAPI**, ⚫️ 🔜 🔬 🔢 👈 "🇧🇲", & 🛠️ 👫 🎏 🌌 🔢 *➡ 🛠️ 🔢*. ✅ 🎧-🔗.
|
||||||
|
|
||||||
|
👈 ✔ 🇧🇲 ⏮️ 🙅♂ 🔢 🌐. 🎏 ⚫️ 🔜 *➡ 🛠️ 🔢* ⏮️ 🙅♂ 🔢.
|
||||||
|
|
||||||
|
⤴️, 👥 💪 🔀 🔗 "☑" `common_parameters` ⚪️➡️ 🔛 🎓 `CommonQueryParams`:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial002.py hl[11:15] *}
|
||||||
|
|
||||||
|
💸 🙋 `__init__` 👩🔬 ⚙️ ✍ 👐 🎓:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial002.py hl[12] *}
|
||||||
|
|
||||||
|
...⚫️ ✔️ 🎏 🔢 👆 ⏮️ `common_parameters`:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial001.py hl[9] *}
|
||||||
|
|
||||||
|
📚 🔢 ⚫️❔ **FastAPI** 🔜 ⚙️ "❎" 🔗.
|
||||||
|
|
||||||
|
👯♂️ 💼, ⚫️ 🔜 ✔️:
|
||||||
|
|
||||||
|
* 📦 `q` 🔢 🔢 👈 `str`.
|
||||||
|
* `skip` 🔢 🔢 👈 `int`, ⏮️ 🔢 `0`.
|
||||||
|
* `limit` 🔢 🔢 👈 `int`, ⏮️ 🔢 `100`.
|
||||||
|
|
||||||
|
👯♂️ 💼 💽 🔜 🗜, ✔, 📄 🔛 🗄 🔗, ♒️.
|
||||||
|
|
||||||
|
## ⚙️ ⚫️
|
||||||
|
|
||||||
|
🔜 👆 💪 📣 👆 🔗 ⚙️ 👉 🎓.
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial002.py hl[19] *}
|
||||||
|
|
||||||
|
**FastAPI** 🤙 `CommonQueryParams` 🎓. 👉 ✍ "👐" 👈 🎓 & 👐 🔜 🚶♀️ 🔢 `commons` 👆 🔢.
|
||||||
|
|
||||||
|
## 🆎 ✍ 🆚 `Depends`
|
||||||
|
|
||||||
|
👀 ❔ 👥 ✍ `CommonQueryParams` 🕐 🔛 📟:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
commons: CommonQueryParams = Depends(CommonQueryParams)
|
||||||
|
```
|
||||||
|
|
||||||
|
🏁 `CommonQueryParams`,:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
... = Depends(CommonQueryParams)
|
||||||
|
```
|
||||||
|
|
||||||
|
...⚫️❔ **FastAPI** 🔜 🤙 ⚙️ 💭 ⚫️❔ 🔗.
|
||||||
|
|
||||||
|
⚪️➡️ ⚫️ 👈 FastAPI 🔜 ⚗ 📣 🔢 & 👈 ⚫️❔ FastAPI 🔜 🤙 🤙.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
👉 💼, 🥇 `CommonQueryParams`,:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
commons: CommonQueryParams ...
|
||||||
|
```
|
||||||
|
|
||||||
|
...🚫 ✔️ 🙆 🎁 🔑 **FastAPI**. FastAPI 🏆 🚫 ⚙️ ⚫️ 💽 🛠️, 🔬, ♒️. (⚫️ ⚙️ `= Depends(CommonQueryParams)` 👈).
|
||||||
|
|
||||||
|
👆 💪 🤙 ✍:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
commons = Depends(CommonQueryParams)
|
||||||
|
```
|
||||||
|
|
||||||
|
...:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial003.py hl[19] *}
|
||||||
|
|
||||||
|
✋️ 📣 🆎 💡 👈 🌌 👆 👨🎨 🔜 💭 ⚫️❔ 🔜 🚶♀️ 🔢 `commons`, & ⤴️ ⚫️ 💪 ℹ 👆 ⏮️ 📟 🛠️, 🆎 ✅, ♒️:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/dependencies/image02.png">
|
||||||
|
|
||||||
|
## ⌨
|
||||||
|
|
||||||
|
✋️ 👆 👀 👈 👥 ✔️ 📟 🔁 📥, ✍ `CommonQueryParams` 🕐:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
commons: CommonQueryParams = Depends(CommonQueryParams)
|
||||||
|
```
|
||||||
|
|
||||||
|
**FastAPI** 🚚 ⌨ 👫 💼, 🌐❔ 🔗 *🎯* 🎓 👈 **FastAPI** 🔜 "🤙" ✍ 👐 🎓 ⚫️.
|
||||||
|
|
||||||
|
📚 🎯 💼, 👆 💪 📄:
|
||||||
|
|
||||||
|
↩️ ✍:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
commons: CommonQueryParams = Depends(CommonQueryParams)
|
||||||
|
```
|
||||||
|
|
||||||
|
...👆 ✍:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
commons: CommonQueryParams = Depends()
|
||||||
|
```
|
||||||
|
|
||||||
|
👆 📣 🔗 🆎 🔢, & 👆 ⚙️ `Depends()` 🚮 "🔢" 💲 (👈 ⏮️ `=`) 👈 🔢 🔢, 🍵 🙆 🔢 `Depends()`, ↩️ ✔️ ✍ 🌕 🎓 *🔄* 🔘 `Depends(CommonQueryParams)`.
|
||||||
|
|
||||||
|
🎏 🖼 🔜 ⤴️ 👀 💖:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial004.py hl[19] *}
|
||||||
|
|
||||||
|
...& **FastAPI** 🔜 💭 ⚫️❔.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🚥 👈 😑 🌅 😨 🌘 👍, 🤷♂ ⚫️, 👆 🚫 *💪* ⚫️.
|
||||||
|
|
||||||
|
⚫️ ⌨. ↩️ **FastAPI** 💅 🔃 🤝 👆 📉 📟 🔁.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,69 @@
|
||||||
|
# 🔗 ➡ 🛠️ 👨🎨
|
||||||
|
|
||||||
|
💼 👆 🚫 🤙 💪 📨 💲 🔗 🔘 👆 *➡ 🛠️ 🔢*.
|
||||||
|
|
||||||
|
⚖️ 🔗 🚫 📨 💲.
|
||||||
|
|
||||||
|
✋️ 👆 💪 ⚫️ 🛠️/❎.
|
||||||
|
|
||||||
|
📚 💼, ↩️ 📣 *➡ 🛠️ 🔢* 🔢 ⏮️ `Depends`, 👆 💪 🚮 `list` `dependencies` *➡ 🛠️ 👨🎨*.
|
||||||
|
|
||||||
|
## 🚮 `dependencies` *➡ 🛠️ 👨🎨*
|
||||||
|
|
||||||
|
*➡ 🛠️ 👨🎨* 📨 📦 ❌ `dependencies`.
|
||||||
|
|
||||||
|
⚫️ 🔜 `list` `Depends()`:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial006.py hl[17] *}
|
||||||
|
|
||||||
|
👉 🔗 🔜 🛠️/❎ 🎏 🌌 😐 🔗. ✋️ 👫 💲 (🚥 👫 📨 🙆) 🏆 🚫 🚶♀️ 👆 *➡ 🛠️ 🔢*.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👨🎨 ✅ ♻ 🔢 🔢, & 🎦 👫 ❌.
|
||||||
|
|
||||||
|
⚙️ 👉 `dependencies` *➡ 🛠️ 👨🎨* 👆 💪 ⚒ 💭 👫 🛠️ ⏪ ❎ 👨🎨/🏭 ❌.
|
||||||
|
|
||||||
|
⚫️ 💪 ℹ ❎ 😨 🆕 👩💻 👈 👀 ♻ 🔢 👆 📟 & 💪 💭 ⚫️ 🙃.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
👉 🖼 👥 ⚙️ 💭 🛃 🎚 `X-Key` & `X-Token`.
|
||||||
|
|
||||||
|
✋️ 🎰 💼, 🕐❔ 🛠️ 💂♂, 👆 🔜 🤚 🌖 💰 ⚪️➡️ ⚙️ 🛠️ [💂♂ 🚙 (⏭ 📃)](../security/index.md){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🔗 ❌ & 📨 💲
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 🎏 🔗 *🔢* 👆 ⚙️ 🛎.
|
||||||
|
|
||||||
|
### 🔗 📄
|
||||||
|
|
||||||
|
👫 💪 📣 📨 📄 (💖 🎚) ⚖️ 🎏 🎧-🔗:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial006.py hl[6,11] *}
|
||||||
|
|
||||||
|
### 🤚 ⚠
|
||||||
|
|
||||||
|
👫 🔗 💪 `raise` ⚠, 🎏 😐 🔗:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial006.py hl[8,13] *}
|
||||||
|
|
||||||
|
### 📨 💲
|
||||||
|
|
||||||
|
& 👫 💪 📨 💲 ⚖️ 🚫, 💲 🏆 🚫 ⚙️.
|
||||||
|
|
||||||
|
, 👆 💪 🏤-⚙️ 😐 🔗 (👈 📨 💲) 👆 ⏪ ⚙️ 👱 🙆, & ✋️ 💲 🏆 🚫 ⚙️, 🔗 🔜 🛠️:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial006.py hl[9,14] *}
|
||||||
|
|
||||||
|
## 🔗 👪 *➡ 🛠️*
|
||||||
|
|
||||||
|
⏪, 🕐❔ 👂 🔃 ❔ 📊 🦏 🈸 ([🦏 🈸 - 💗 📁](../../tutorial/bigger-applications.md){.internal-link target=_blank}), 🎲 ⏮️ 💗 📁, 👆 🔜 💡 ❔ 📣 👁 `dependencies` 🔢 👪 *➡ 🛠️*.
|
||||||
|
|
||||||
|
## 🌐 🔗
|
||||||
|
|
||||||
|
⏭ 👥 🔜 👀 ❔ 🚮 🔗 🎂 `FastAPI` 🈸, 👈 👫 ✔ 🔠 *➡ 🛠️*.
|
||||||
|
|
@ -0,0 +1,232 @@
|
||||||
|
# 🔗 ⏮️ 🌾
|
||||||
|
|
||||||
|
FastAPI 🐕🦺 🔗 👈 <abbr title='sometimes also called "exit", "cleanup", "teardown", "close", "context managers", ...'>➕ 🔁 ⏮️ 🏁</abbr>.
|
||||||
|
|
||||||
|
👉, ⚙️ `yield` ↩️ `return`, & ✍ ➕ 🔁 ⏮️.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
⚒ 💭 ⚙️ `yield` 1️⃣ 👁 🕰.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
🙆 🔢 👈 ☑ ⚙️ ⏮️:
|
||||||
|
|
||||||
|
* <a href="https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager" class="external-link" target="_blank">`@contextlib.contextmanager`</a> ⚖️
|
||||||
|
* <a href="https://docs.python.org/3/library/contextlib.html#contextlib.asynccontextmanager" class="external-link" target="_blank">`@contextlib.asynccontextmanager`</a>
|
||||||
|
|
||||||
|
🔜 ☑ ⚙️ **FastAPI** 🔗.
|
||||||
|
|
||||||
|
👐, FastAPI ⚙️ 📚 2️⃣ 👨🎨 🔘.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 💽 🔗 ⏮️ `yield`
|
||||||
|
|
||||||
|
🖼, 👆 💪 ⚙️ 👉 ✍ 💽 🎉 & 🔐 ⚫️ ⏮️ 🏁.
|
||||||
|
|
||||||
|
🕴 📟 ⏭ & 🔌 `yield` 📄 🛠️ ⏭ 📨 📨:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial007.py hl[2:4] *}
|
||||||
|
|
||||||
|
🌾 💲 ⚫️❔ 💉 🔘 *➡ 🛠️* & 🎏 🔗:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial007.py hl[4] *}
|
||||||
|
|
||||||
|
📟 📄 `yield` 📄 🛠️ ⏮️ 📨 ✔️ 🚚:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial007.py hl[5:6] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `async` ⚖️ 😐 🔢.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ▶️️ 👜 ⏮️ 🔠, 🎏 ⏮️ 😐 🔗.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🔗 ⏮️ `yield` & `try`
|
||||||
|
|
||||||
|
🚥 👆 ⚙️ `try` 🍫 🔗 ⏮️ `yield`, 👆 🔜 📨 🙆 ⚠ 👈 🚮 🕐❔ ⚙️ 🔗.
|
||||||
|
|
||||||
|
🖼, 🚥 📟 ☝ 🖕, ➕1️⃣ 🔗 ⚖️ *➡ 🛠️*, ⚒ 💽 💵 "💾" ⚖️ ✍ 🙆 🎏 ❌, 👆 🔜 📨 ⚠ 👆 🔗.
|
||||||
|
|
||||||
|
, 👆 💪 👀 👈 🎯 ⚠ 🔘 🔗 ⏮️ `except SomeException`.
|
||||||
|
|
||||||
|
🎏 🌌, 👆 💪 ⚙️ `finally` ⚒ 💭 🚪 📶 🛠️, 🙅♂ 🤔 🚥 📤 ⚠ ⚖️ 🚫.
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial007.py hl[3,5] *}
|
||||||
|
|
||||||
|
## 🎧-🔗 ⏮️ `yield`
|
||||||
|
|
||||||
|
👆 💪 ✔️ 🎧-🔗 & "🌲" 🎧-🔗 🙆 📐 & 💠, & 🙆 ⚖️ 🌐 👫 💪 ⚙️ `yield`.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ⚒ 💭 👈 "🚪 📟" 🔠 🔗 ⏮️ `yield` 🏃 ☑ ✔.
|
||||||
|
|
||||||
|
🖼, `dependency_c` 💪 ✔️ 🔗 🔛 `dependency_b`, & `dependency_b` 🔛 `dependency_a`:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial008.py hl[4,12,20] *}
|
||||||
|
|
||||||
|
& 🌐 👫 💪 ⚙️ `yield`.
|
||||||
|
|
||||||
|
👉 💼 `dependency_c`, 🛠️ 🚮 🚪 📟, 💪 💲 ⚪️➡️ `dependency_b` (📥 📛 `dep_b`) 💪.
|
||||||
|
|
||||||
|
& , 🔄, `dependency_b` 💪 💲 ⚪️➡️ `dependency_a` (📥 📛 `dep_a`) 💪 🚮 🚪 📟.
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial008.py hl[16:17,24:25] *}
|
||||||
|
|
||||||
|
🎏 🌌, 👆 💪 ✔️ 🔗 ⏮️ `yield` & `return` 🌀.
|
||||||
|
|
||||||
|
& 👆 💪 ✔️ 👁 🔗 👈 🚚 📚 🎏 🔗 ⏮️ `yield`, ♒️.
|
||||||
|
|
||||||
|
👆 💪 ✔️ 🙆 🌀 🔗 👈 👆 💚.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ⚒ 💭 🌐 🏃 ☑ ✔.
|
||||||
|
|
||||||
|
/// note | 📡 ℹ
|
||||||
|
|
||||||
|
👉 👷 👏 🐍 <a href="https://docs.python.org/3/library/contextlib.html" class="external-link" target="_blank">🔑 👨💼</a>.
|
||||||
|
|
||||||
|
**FastAPI** ⚙️ 👫 🔘 🏆 👉.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🔗 ⏮️ `yield` & `HTTPException`
|
||||||
|
|
||||||
|
👆 👀 👈 👆 💪 ⚙️ 🔗 ⏮️ `yield` & ✔️ `try` 🍫 👈 ✊ ⚠.
|
||||||
|
|
||||||
|
⚫️ 5️⃣📆 😋 🤚 `HTTPException` ⚖️ 🎏 🚪 📟, ⏮️ `yield`. ✋️ **⚫️ 🏆 🚫 👷**.
|
||||||
|
|
||||||
|
🚪 📟 🔗 ⏮️ `yield` 🛠️ *⏮️* 📨 📨, [⚠ 🐕🦺](../handling-errors.md#_4){.internal-link target=_blank} 🔜 ✔️ ⏪ 🏃. 📤 🕳 😽 ⚠ 🚮 👆 🔗 🚪 📟 (⏮️ `yield`).
|
||||||
|
|
||||||
|
, 🚥 👆 🤚 `HTTPException` ⏮️ `yield`, 🔢 (⚖️ 🙆 🛃) ⚠ 🐕🦺 👈 ✊ `HTTPException`Ⓜ & 📨 🇺🇸🔍 4️⃣0️⃣0️⃣ 📨 🏆 🚫 📤 ✊ 👈 ⚠ 🚫🔜.
|
||||||
|
|
||||||
|
👉 ⚫️❔ ✔ 🕳 ⚒ 🔗 (✅ 💽 🎉), 🖼, ⚙️ 🖥 📋.
|
||||||
|
|
||||||
|
🖥 📋 🏃 *⏮️* 📨 ✔️ 📨. 📤 🙅♂ 🌌 🤚 `HTTPException` ↩️ 📤 🚫 🌌 🔀 📨 👈 *⏪ 📨*.
|
||||||
|
|
||||||
|
✋️ 🚥 🖥 📋 ✍ 💽 ❌, 🌘 👆 💪 💾 ⚖️ 😬 🔐 🎉 🔗 ⏮️ `yield`, & 🎲 🕹 ❌ ⚖️ 📄 ⚫️ 🛰 🕵 ⚙️.
|
||||||
|
|
||||||
|
🚥 👆 ✔️ 📟 👈 👆 💭 💪 🤚 ⚠, 🏆 😐/"🙃" 👜 & 🚮 `try` 🍫 👈 📄 📟.
|
||||||
|
|
||||||
|
🚥 👆 ✔️ 🛃 ⚠ 👈 👆 🔜 💖 🍵 *⏭* 🛬 📨 & 🎲 ❎ 📨, 🎲 🙋♀ `HTTPException`, ✍ [🛃 ⚠ 🐕🦺](../handling-errors.md#_4){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👆 💪 🤚 ⚠ 🔌 `HTTPException` *⏭* `yield`. ✋️ 🚫 ⏮️.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🔁 🛠️ 🌅 ⚖️ 🌘 💖 👉 📊. 🕰 💧 ⚪️➡️ 🔝 🔝. & 🔠 🏓 1️⃣ 🍕 🔗 ⚖️ 🛠️ 📟.
|
||||||
|
|
||||||
|
```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,tasks: Can raise exception for dependency, handled after response is sent
|
||||||
|
Note over client,operation: Can raise HTTPException and can change the response
|
||||||
|
client ->> dep: Start request
|
||||||
|
Note over dep: Run code up to yield
|
||||||
|
opt raise
|
||||||
|
dep -->> handler: Raise HTTPException
|
||||||
|
handler -->> client: HTTP error response
|
||||||
|
dep -->> dep: Raise other exception
|
||||||
|
end
|
||||||
|
dep ->> operation: Run dependency, e.g. DB session
|
||||||
|
opt raise
|
||||||
|
operation -->> dep: Raise HTTPException
|
||||||
|
dep -->> handler: Auto forward exception
|
||||||
|
handler -->> client: HTTP error response
|
||||||
|
operation -->> dep: Raise other exception
|
||||||
|
dep -->> handler: Auto forward exception
|
||||||
|
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 -->> dep: Raise other exception
|
||||||
|
end
|
||||||
|
Note over dep: After yield
|
||||||
|
opt Handle other exception
|
||||||
|
dep -->> dep: Handle exception, can't change response. E.g. close DB session.
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
🕴 **1️⃣ 📨** 🔜 📨 👩💻. ⚫️ 💪 1️⃣ ❌ 📨 ⚖️ ⚫️ 🔜 📨 ⚪️➡️ *➡ 🛠️*.
|
||||||
|
|
||||||
|
⏮️ 1️⃣ 📚 📨 📨, 🙅♂ 🎏 📨 💪 📨.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
👉 📊 🎦 `HTTPException`, ✋️ 👆 💪 🤚 🙆 🎏 ⚠ ❔ 👆 ✍ [🛃 ⚠ 🐕🦺](../handling-errors.md#_4){.internal-link target=_blank}.
|
||||||
|
|
||||||
|
🚥 👆 🤚 🙆 ⚠, ⚫️ 🔜 🚶♀️ 🔗 ⏮️ 🌾, 🔌 `HTTPException`, & ⤴️ **🔄** ⚠ 🐕🦺. 🚥 📤 🙅♂ ⚠ 🐕🦺 👈 ⚠, ⚫️ 🔜 ⤴️ 🍵 🔢 🔗 `ServerErrorMiddleware`, 🛬 5️⃣0️⃣0️⃣ 🇺🇸🔍 👔 📟, ➡️ 👩💻 💭 👈 📤 ❌ 💽.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🔑 👨💼
|
||||||
|
|
||||||
|
### ⚫️❔ "🔑 👨💼"
|
||||||
|
|
||||||
|
"🔑 👨💼" 🙆 👈 🐍 🎚 👈 👆 💪 ⚙️ `with` 📄.
|
||||||
|
|
||||||
|
🖼, <a href="https://docs.python.org/3/tutorial/inputoutput.html#reading-and-writing-files" class="external-link" target="_blank">👆 💪 ⚙️ `with` ✍ 📁</a>:
|
||||||
|
|
||||||
|
```Python
|
||||||
|
with open("./somefile.txt") as f:
|
||||||
|
contents = f.read()
|
||||||
|
print(contents)
|
||||||
|
```
|
||||||
|
|
||||||
|
🔘, `open("./somefile.txt")` ✍ 🎚 👈 🤙 "🔑 👨💼".
|
||||||
|
|
||||||
|
🕐❔ `with` 🍫 🏁, ⚫️ ⚒ 💭 🔐 📁, 🚥 📤 ⚠.
|
||||||
|
|
||||||
|
🕐❔ 👆 ✍ 🔗 ⏮️ `yield`, **FastAPI** 🔜 🔘 🗜 ⚫️ 🔑 👨💼, & 🌀 ⚫️ ⏮️ 🎏 🔗 🧰.
|
||||||
|
|
||||||
|
### ⚙️ 🔑 👨💼 🔗 ⏮️ `yield`
|
||||||
|
|
||||||
|
/// warning
|
||||||
|
|
||||||
|
👉, 🌅 ⚖️ 🌘, "🏧" 💭.
|
||||||
|
|
||||||
|
🚥 👆 ▶️ ⏮️ **FastAPI** 👆 💪 💚 🚶 ⚫️ 🔜.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
🐍, 👆 💪 ✍ 🔑 👨💼 <a href="https://docs.python.org/3/reference/datamodel.html#context-managers" class="external-link" target="_blank">🏗 🎓 ⏮️ 2️⃣ 👩🔬: `__enter__()` & `__exit__()`</a>.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ 👫 🔘 **FastAPI** 🔗 ⏮️ `yield` ⚙️
|
||||||
|
`with` ⚖️ `async with` 📄 🔘 🔗 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial010.py hl[1:9,13] *}
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
➕1️⃣ 🌌 ✍ 🔑 👨💼 ⏮️:
|
||||||
|
|
||||||
|
* <a href="https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager" class="external-link" target="_blank">`@contextlib.contextmanager`</a> ⚖️
|
||||||
|
* <a href="https://docs.python.org/3/library/contextlib.html#contextlib.asynccontextmanager" class="external-link" target="_blank">`@contextlib.asynccontextmanager`</a>
|
||||||
|
|
||||||
|
⚙️ 👫 🎀 🔢 ⏮️ 👁 `yield`.
|
||||||
|
|
||||||
|
👈 ⚫️❔ **FastAPI** ⚙️ 🔘 🔗 ⏮️ `yield`.
|
||||||
|
|
||||||
|
✋️ 👆 🚫 ✔️ ⚙️ 👨🎨 FastAPI 🔗 (& 👆 🚫🔜 🚫).
|
||||||
|
|
||||||
|
FastAPI 🔜 ⚫️ 👆 🔘.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
# 🌐 🔗
|
||||||
|
|
||||||
|
🆎 🈸 👆 💪 💚 🚮 🔗 🎂 🈸.
|
||||||
|
|
||||||
|
🎏 🌌 👆 💪 [🚮 `dependencies` *➡ 🛠️ 👨🎨*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, 👆 💪 🚮 👫 `FastAPI` 🈸.
|
||||||
|
|
||||||
|
👈 💼, 👫 🔜 ✔ 🌐 *➡ 🛠️* 🈸:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial012.py hl[15] *}
|
||||||
|
|
||||||
|
& 🌐 💭 📄 🔃 [❎ `dependencies` *➡ 🛠️ 👨🎨*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank} ✔, ✋️ 👉 💼, 🌐 *➡ 🛠️* 📱.
|
||||||
|
|
||||||
|
## 🔗 👪 *➡ 🛠️*
|
||||||
|
|
||||||
|
⏪, 🕐❔ 👂 🔃 ❔ 📊 🦏 🈸 ([🦏 🈸 - 💗 📁](../../tutorial/bigger-applications.md){.internal-link target=_blank}), 🎲 ⏮️ 💗 📁, 👆 🔜 💡 ❔ 📣 👁 `dependencies` 🔢 👪 *➡ 🛠️*.
|
||||||
|
|
@ -0,0 +1,212 @@
|
||||||
|
# 🔗
|
||||||
|
|
||||||
|
**FastAPI** ✔️ 📶 🏋️ ✋️ 🏋️ **<abbr title="also known as components, resources, providers, services, injectables">🔗 💉</abbr>** ⚙️.
|
||||||
|
|
||||||
|
⚫️ 🏗 📶 🙅 ⚙️, & ⚒ ⚫️ 📶 ⏩ 🙆 👩💻 🛠️ 🎏 🦲 ⏮️ **FastAPI**.
|
||||||
|
|
||||||
|
## ⚫️❔ "🔗 💉"
|
||||||
|
|
||||||
|
**"🔗 💉"** ⛓, 📋, 👈 📤 🌌 👆 📟 (👉 💼, 👆 *➡ 🛠️ 🔢*) 📣 👜 👈 ⚫️ 🚚 👷 & ⚙️: "🔗".
|
||||||
|
|
||||||
|
& ⤴️, 👈 ⚙️ (👉 💼 **FastAPI**) 🔜 ✊ 💅 🔨 ⚫️❔ 💪 🚚 👆 📟 ⏮️ 📚 💪 🔗 ("💉" 🔗).
|
||||||
|
|
||||||
|
👉 📶 ⚠ 🕐❔ 👆 💪:
|
||||||
|
|
||||||
|
* ✔️ 💰 ⚛ (🎏 📟 ⚛ 🔄 & 🔄).
|
||||||
|
* 💰 💽 🔗.
|
||||||
|
* 🛠️ 💂♂, 🤝, 🔑 📄, ♒️.
|
||||||
|
* & 📚 🎏 👜...
|
||||||
|
|
||||||
|
🌐 👫, ⏪ 📉 📟 🔁.
|
||||||
|
|
||||||
|
## 🥇 🔁
|
||||||
|
|
||||||
|
➡️ 👀 📶 🙅 🖼. ⚫️ 🔜 🙅 👈 ⚫️ 🚫 📶 ⚠, 🔜.
|
||||||
|
|
||||||
|
✋️ 👉 🌌 👥 💪 🎯 🔛 ❔ **🔗 💉** ⚙️ 👷.
|
||||||
|
|
||||||
|
### ✍ 🔗, ⚖️ "☑"
|
||||||
|
|
||||||
|
➡️ 🥇 🎯 🔛 🔗.
|
||||||
|
|
||||||
|
⚫️ 🔢 👈 💪 ✊ 🌐 🎏 🔢 👈 *➡ 🛠️ 🔢* 💪 ✊:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial001.py hl[8:11] *}
|
||||||
|
|
||||||
|
👈 ⚫️.
|
||||||
|
|
||||||
|
**2️⃣ ⏸**.
|
||||||
|
|
||||||
|
& ⚫️ ✔️ 🎏 💠 & 📊 👈 🌐 👆 *➡ 🛠️ 🔢* ✔️.
|
||||||
|
|
||||||
|
👆 💪 💭 ⚫️ *➡ 🛠️ 🔢* 🍵 "👨🎨" (🍵 `@app.get("/some-path")`).
|
||||||
|
|
||||||
|
& ⚫️ 💪 📨 🕳 👆 💚.
|
||||||
|
|
||||||
|
👉 💼, 👉 🔗 ⌛:
|
||||||
|
|
||||||
|
* 📦 🔢 🔢 `q` 👈 `str`.
|
||||||
|
* 📦 🔢 🔢 `skip` 👈 `int`, & 🔢 `0`.
|
||||||
|
* 📦 🔢 🔢 `limit` 👈 `int`, & 🔢 `100`.
|
||||||
|
|
||||||
|
& ⤴️ ⚫️ 📨 `dict` ⚗ 📚 💲.
|
||||||
|
|
||||||
|
### 🗄 `Depends`
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial001.py hl[3] *}
|
||||||
|
|
||||||
|
### 📣 🔗, "⚓️"
|
||||||
|
|
||||||
|
🎏 🌌 👆 ⚙️ `Body`, `Query`, ♒️. ⏮️ 👆 *➡ 🛠️ 🔢* 🔢, ⚙️ `Depends` ⏮️ 🆕 🔢:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial001.py hl[15,20] *}
|
||||||
|
|
||||||
|
👐 👆 ⚙️ `Depends` 🔢 👆 🔢 🎏 🌌 👆 ⚙️ `Body`, `Query`, ♒️, `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** 💭 ❔ 🎂.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## `async` ⚖️ 🚫 `async`
|
||||||
|
|
||||||
|
🔗 🔜 🤙 **FastAPI** (🎏 👆 *➡ 🛠️ 🔢*), 🎏 🚫 ✔ ⏪ 🔬 👆 🔢.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `async def` ⚖️ 😐 `def`.
|
||||||
|
|
||||||
|
& 👆 💪 📣 🔗 ⏮️ `async def` 🔘 😐 `def` *➡ 🛠️ 🔢*, ⚖️ `def` 🔗 🔘 `async def` *➡ 🛠️ 🔢*, ♒️.
|
||||||
|
|
||||||
|
⚫️ 🚫 🤔. **FastAPI** 🔜 💭 ⚫️❔.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
🚥 👆 🚫 💭, ✅ [🔁: *"🏃 ❓" *](../../async.md){.internal-link target=_blank} 📄 🔃 `async` & `await` 🩺.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
||||||
|
## 🛠️ ⏮️ 🗄
|
||||||
|
|
||||||
|
🌐 📨 📄, 🔬 & 📄 👆 🔗 (& 🎧-🔗) 🔜 🛠️ 🎏 🗄 🔗.
|
||||||
|
|
||||||
|
, 🎓 🩺 🔜 ✔️ 🌐 ℹ ⚪️➡️ 👫 🔗 💁♂️:
|
||||||
|
|
||||||
|
<img src="/img/tutorial/dependencies/image01.png">
|
||||||
|
|
||||||
|
## 🙅 ⚙️
|
||||||
|
|
||||||
|
🚥 👆 👀 ⚫️, *➡ 🛠️ 🔢* 📣 ⚙️ 🕐❔ *➡* & *🛠️* 🏏, & ⤴️ **FastAPI** ✊ 💅 🤙 🔢 ⏮️ ☑ 🔢, ❎ 📊 ⚪️➡️ 📨.
|
||||||
|
|
||||||
|
🤙, 🌐 (⚖️ 🏆) 🕸 🛠️ 👷 👉 🎏 🌌.
|
||||||
|
|
||||||
|
👆 🙅 🤙 👈 🔢 🔗. 👫 🤙 👆 🛠️ (👉 💼, **FastAPI**).
|
||||||
|
|
||||||
|
⏮️ 🔗 💉 ⚙️, 👆 💪 💬 **FastAPI** 👈 👆 *➡ 🛠️ 🔢* "🪀" 🔛 🕳 🙆 👈 🔜 🛠️ ⏭ 👆 *➡ 🛠️ 🔢*, & **FastAPI** 🔜 ✊ 💅 🛠️ ⚫️ & "💉" 🏁.
|
||||||
|
|
||||||
|
🎏 ⚠ ⚖ 👉 🎏 💭 "🔗 💉":
|
||||||
|
|
||||||
|
* ℹ
|
||||||
|
* 🐕🦺
|
||||||
|
* 🐕🦺
|
||||||
|
* 💉
|
||||||
|
* 🦲
|
||||||
|
|
||||||
|
## **FastAPI** 🔌-🔌
|
||||||
|
|
||||||
|
🛠️ & "🔌-"Ⓜ 💪 🏗 ⚙️ **🔗 💉** ⚙️. ✋️ 👐, 📤 🤙 **🙅♂ 💪 ✍ "🔌-🔌"**, ⚙️ 🔗 ⚫️ 💪 📣 ♾ 🔢 🛠️ & 🔗 👈 ▶️️ 💪 👆 *➡ 🛠️ 🔢*.
|
||||||
|
|
||||||
|
& 🔗 💪 ✍ 📶 🙅 & 🏋️ 🌌 👈 ✔ 👆 🗄 🐍 📦 👆 💪, & 🛠️ 👫 ⏮️ 👆 🛠️ 🔢 👩❤👨 ⏸ 📟, *🌖*.
|
||||||
|
|
||||||
|
👆 🔜 👀 🖼 👉 ⏭ 📃, 🔃 🔗 & ☁ 💽, 💂♂, ♒️.
|
||||||
|
|
||||||
|
## **FastAPI** 🔗
|
||||||
|
|
||||||
|
🦁 🔗 💉 ⚙️ ⚒ **FastAPI** 🔗 ⏮️:
|
||||||
|
|
||||||
|
* 🌐 🔗 💽
|
||||||
|
* ☁ 💽
|
||||||
|
* 🔢 📦
|
||||||
|
* 🔢 🔗
|
||||||
|
* 🤝 & ✔ ⚙️
|
||||||
|
* 🛠️ ⚙️ ⚖ ⚙️
|
||||||
|
* 📨 💽 💉 ⚙️
|
||||||
|
* ♒️.
|
||||||
|
|
||||||
|
## 🙅 & 🏋️
|
||||||
|
|
||||||
|
👐 🔗 🔗 💉 ⚙️ 📶 🙅 🔬 & ⚙️, ⚫️ 📶 🏋️.
|
||||||
|
|
||||||
|
👆 💪 🔬 🔗 👈 🔄 💪 🔬 🔗 👫.
|
||||||
|
|
||||||
|
🔚, 🔗 🌲 🔗 🏗, & **🔗 💉** ⚙️ ✊ 💅 🔬 🌐 👉 🔗 👆 (& 👫 🎧-🔗) & 🚚 (💉) 🏁 🔠 🔁.
|
||||||
|
|
||||||
|
🖼, ➡️ 💬 👆 ✔️ 4️⃣ 🛠️ 🔗 (*➡ 🛠️*):
|
||||||
|
|
||||||
|
* `/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
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🛠️ ⏮️ **🗄**
|
||||||
|
|
||||||
|
🌐 👫 🔗, ⏪ 📣 👫 📄, 🚮 🔢, 🔬, ♒️. 👆 *➡ 🛠️*.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ✊ 💅 🚮 ⚫️ 🌐 🗄 🔗, 👈 ⚫️ 🎦 🎓 🧾 ⚙️.
|
||||||
|
|
@ -0,0 +1,86 @@
|
||||||
|
# 🎧-🔗
|
||||||
|
|
||||||
|
👆 💪 ✍ 🔗 👈 ✔️ **🎧-🔗**.
|
||||||
|
|
||||||
|
👫 💪 **⏬** 👆 💪 👫.
|
||||||
|
|
||||||
|
**FastAPI** 🔜 ✊ 💅 🔬 👫.
|
||||||
|
|
||||||
|
## 🥇 🔗 "☑"
|
||||||
|
|
||||||
|
👆 💪 ✍ 🥇 🔗 ("☑") 💖:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial005.py hl[8:9] *}
|
||||||
|
|
||||||
|
⚫️ 📣 📦 🔢 🔢 `q` `str`, & ⤴️ ⚫️ 📨 ⚫️.
|
||||||
|
|
||||||
|
👉 🙅 (🚫 📶 ⚠), ✋️ 🔜 ℹ 👥 🎯 🔛 ❔ 🎧-🔗 👷.
|
||||||
|
|
||||||
|
## 🥈 🔗, "☑" & "⚓️"
|
||||||
|
|
||||||
|
⤴️ 👆 💪 ✍ ➕1️⃣ 🔗 🔢 ("☑") 👈 🎏 🕰 📣 🔗 🚮 👍 (⚫️ "⚓️" 💁♂️):
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial005.py hl[13] *}
|
||||||
|
|
||||||
|
➡️ 🎯 🔛 🔢 📣:
|
||||||
|
|
||||||
|
* ✋️ 👉 🔢 🔗 ("☑") ⚫️, ⚫️ 📣 ➕1️⃣ 🔗 (⚫️ "🪀" 🔛 🕳 🙆).
|
||||||
|
* ⚫️ 🪀 🔛 `query_extractor`, & 🛠️ 💲 📨 ⚫️ 🔢 `q`.
|
||||||
|
* ⚫️ 📣 📦 `last_query` 🍪, `str`.
|
||||||
|
* 🚥 👩💻 🚫 🚚 🙆 🔢 `q`, 👥 ⚙️ 🏁 🔢 ⚙️, ❔ 👥 🖊 🍪 ⏭.
|
||||||
|
|
||||||
|
## ⚙️ 🔗
|
||||||
|
|
||||||
|
⤴️ 👥 💪 ⚙️ 🔗 ⏮️:
|
||||||
|
|
||||||
|
{* ../../docs_src/dependencies/tutorial005.py hl[22] *}
|
||||||
|
|
||||||
|
/// info
|
||||||
|
|
||||||
|
👀 👈 👥 🕴 📣 1️⃣ 🔗 *➡ 🛠️ 🔢*, `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
|
||||||
|
```
|
||||||
|
|
||||||
|
## ⚙️ 🎏 🔗 💗 🕰
|
||||||
|
|
||||||
|
🚥 1️⃣ 👆 🔗 📣 💗 🕰 🎏 *➡ 🛠️*, 🖼, 💗 🔗 ✔️ ⚠ 🎧-🔗, **FastAPI** 🔜 💭 🤙 👈 🎧-🔗 🕴 🕐 📍 📨.
|
||||||
|
|
||||||
|
& ⚫️ 🔜 🖊 📨 💲 <abbr title="A utility/system to store computed/generated values, to re-use them instead of computing them again.">"💾"</abbr> & 🚶♀️ ⚫️ 🌐 "⚓️" 👈 💪 ⚫️ 👈 🎯 📨, ↩️ 🤙 🔗 💗 🕰 🎏 📨.
|
||||||
|
|
||||||
|
🏧 😐 🌐❔ 👆 💭 👆 💪 🔗 🤙 🔠 🔁 (🎲 💗 🕰) 🎏 📨 ↩️ ⚙️ "💾" 💲, 👆 💪 ⚒ 🔢 `use_cache=False` 🕐❔ ⚙️ `Depends`:
|
||||||
|
|
||||||
|
```Python hl_lines="1"
|
||||||
|
async def needy_dependency(fresh_value: str = Depends(get_value, use_cache=False)):
|
||||||
|
return {"fresh_value": fresh_value}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌃
|
||||||
|
|
||||||
|
↖️ ⚪️➡️ 🌐 🎀 🔤 ⚙️ 📥, **🔗 💉** ⚙️ 🙅.
|
||||||
|
|
||||||
|
🔢 👈 👀 🎏 *➡ 🛠️ 🔢*.
|
||||||
|
|
||||||
|
✋️, ⚫️ 📶 🏋️, & ✔ 👆 📣 🎲 🙇 🐦 🔗 "📊" (🌲).
|
||||||
|
|
||||||
|
/// tip
|
||||||
|
|
||||||
|
🌐 👉 💪 🚫 😑 ⚠ ⏮️ 👫 🙅 🖼.
|
||||||
|
|
||||||
|
✋️ 👆 🔜 👀 ❔ ⚠ ⚫️ 📃 🔃 **💂♂**.
|
||||||
|
|
||||||
|
& 👆 🔜 👀 💸 📟 ⚫️ 🔜 🖊 👆.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
# 🎻 🔗 🔢
|
||||||
|
|
||||||
|
📤 💼 🌐❔ 👆 5️⃣📆 💪 🗜 💽 🆎 (💖 Pydantic 🏷) 🕳 🔗 ⏮️ 🎻 (💖 `dict`, `list`, ♒️).
|
||||||
|
|
||||||
|
🖼, 🚥 👆 💪 🏪 ⚫️ 💽.
|
||||||
|
|
||||||
|
👈, **FastAPI** 🚚 `jsonable_encoder()` 🔢.
|
||||||
|
|
||||||
|
## ⚙️ `jsonable_encoder`
|
||||||
|
|
||||||
|
➡️ 🌈 👈 👆 ✔️ 💽 `fake_db` 👈 🕴 📨 🎻 🔗 💽.
|
||||||
|
|
||||||
|
🖼, ⚫️ 🚫 📨 `datetime` 🎚, 👈 🚫 🔗 ⏮️ 🎻.
|
||||||
|
|
||||||
|
, `datetime` 🎚 🔜 ✔️ 🗜 `str` ⚗ 💽 <a href="https://en.wikipedia.org/wiki/ISO_8601" class="external-link" target="_blank">💾 📁</a>.
|
||||||
|
|
||||||
|
🎏 🌌, 👉 💽 🚫🔜 📨 Pydantic 🏷 (🎚 ⏮️ 🔢), 🕴 `dict`.
|
||||||
|
|
||||||
|
👆 💪 ⚙️ `jsonable_encoder` 👈.
|
||||||
|
|
||||||
|
⚫️ 📨 🎚, 💖 Pydantic 🏷, & 📨 🎻 🔗 ⏬:
|
||||||
|
|
||||||
|
{* ../../docs_src/encoder/tutorial001.py hl[5,22] *}
|
||||||
|
|
||||||
|
👉 🖼, ⚫️ 🔜 🗜 Pydantic 🏷 `dict`, & `datetime` `str`.
|
||||||
|
|
||||||
|
🏁 🤙 ⚫️ 🕳 👈 💪 🗜 ⏮️ 🐍 🐩 <a href="https://docs.python.org/3/library/json.html#json.dumps" class="external-link" target="_blank">`json.dumps()`</a>.
|
||||||
|
|
||||||
|
⚫️ 🚫 📨 ⭕ `str` ⚗ 💽 🎻 📁 (🎻). ⚫️ 📨 🐍 🐩 💽 📊 (✅ `dict`) ⏮️ 💲 & 🎧-💲 👈 🌐 🔗 ⏮️ 🎻.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
|
||||||
|
`jsonable_encoder` 🤙 ⚙️ **FastAPI** 🔘 🗜 💽. ✋️ ⚫️ ⚠ 📚 🎏 😐.
|
||||||
|
|
||||||
|
///
|
||||||
|
|
@ -0,0 +1,62 @@
|
||||||
|
# ➕ 💽 🆎
|
||||||
|
|
||||||
|
🆙 🔜, 👆 ✔️ ⚙️ ⚠ 📊 🆎, 💖:
|
||||||
|
|
||||||
|
* `int`
|
||||||
|
* `float`
|
||||||
|
* `str`
|
||||||
|
* `bool`
|
||||||
|
|
||||||
|
✋️ 👆 💪 ⚙️ 🌅 🏗 📊 🆎.
|
||||||
|
|
||||||
|
& 👆 🔜 ✔️ 🎏 ⚒ 👀 🆙 🔜:
|
||||||
|
|
||||||
|
* 👑 👨🎨 🐕🦺.
|
||||||
|
* 💽 🛠️ ⚪️➡️ 📨 📨.
|
||||||
|
* 💽 🛠️ 📨 💽.
|
||||||
|
* 💽 🔬.
|
||||||
|
* 🏧 ✍ & 🧾.
|
||||||
|
|
||||||
|
## 🎏 💽 🆎
|
||||||
|
|
||||||
|
📥 🌖 📊 🆎 👆 💪 ⚙️:
|
||||||
|
|
||||||
|
* `UUID`:
|
||||||
|
* 🐩 "⭐ 😍 🆔", ⚠ 🆔 📚 💽 & ⚙️.
|
||||||
|
* 📨 & 📨 🔜 🎨 `str`.
|
||||||
|
* `datetime.datetime`:
|
||||||
|
* 🐍 `datetime.datetime`.
|
||||||
|
* 📨 & 📨 🔜 🎨 `str` 💾 8️⃣6️⃣0️⃣1️⃣ 📁, 💖: `2008-09-15T15:53:00+05:00`.
|
||||||
|
* `datetime.date`:
|
||||||
|
* 🐍 `datetime.date`.
|
||||||
|
* 📨 & 📨 🔜 🎨 `str` 💾 8️⃣6️⃣0️⃣1️⃣ 📁, 💖: `2008-09-15`.
|
||||||
|
* `datetime.time`:
|
||||||
|
* 🐍 `datetime.time`.
|
||||||
|
* 📨 & 📨 🔜 🎨 `str` 💾 8️⃣6️⃣0️⃣1️⃣ 📁, 💖: `14:23:55.003`.
|
||||||
|
* `datetime.timedelta`:
|
||||||
|
* 🐍 `datetime.timedelta`.
|
||||||
|
* 📨 & 📨 🔜 🎨 `float` 🌐 🥈.
|
||||||
|
* Pydantic ✔ 🎦 ⚫️ "💾 8️⃣6️⃣0️⃣1️⃣ 🕰 ➕ 🔢", <a href="https://docs.pydantic.dev/latest/concepts/serialization/#json_encoders" class="external-link" target="_blank">👀 🩺 🌅 ℹ</a>.
|
||||||
|
* `frozenset`:
|
||||||
|
* 📨 & 📨, 😥 🎏 `set`:
|
||||||
|
* 📨, 📇 🔜 ✍, ❎ ❎ & 🏭 ⚫️ `set`.
|
||||||
|
* 📨, `set` 🔜 🗜 `list`.
|
||||||
|
* 🏗 🔗 🔜 ✔ 👈 `set` 💲 😍 (⚙️ 🎻 🔗 `uniqueItems`).
|
||||||
|
* `bytes`:
|
||||||
|
* 🐩 🐍 `bytes`.
|
||||||
|
* 📨 & 📨 🔜 😥 `str`.
|
||||||
|
* 🏗 🔗 🔜 ✔ 👈 ⚫️ `str` ⏮️ `binary` "📁".
|
||||||
|
* `Decimal`:
|
||||||
|
* 🐩 🐍 `Decimal`.
|
||||||
|
* 📨 & 📨, 🍵 🎏 `float`.
|
||||||
|
* 👆 💪 ✅ 🌐 ☑ Pydantic 📊 🆎 📥: <a href="https://docs.pydantic.dev/latest/concepts/types/" class="external-link" target="_blank">Pydantic 📊 🆎</a>.
|
||||||
|
|
||||||
|
## 🖼
|
||||||
|
|
||||||
|
📥 🖼 *➡ 🛠️* ⏮️ 🔢 ⚙️ 🔛 🆎.
|
||||||
|
|
||||||
|
{* ../../docs_src/extra_data_types/tutorial001.py hl[1,3,12:16] *}
|
||||||
|
|
||||||
|
🗒 👈 🔢 🔘 🔢 ✔️ 👫 🐠 💽 🆎, & 👆 💪, 🖼, 🎭 😐 📅 🎭, 💖:
|
||||||
|
|
||||||
|
{* ../../docs_src/extra_data_types/tutorial001.py hl[18:19] *}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue