🔖 Release version 0.103.0

* ♻️ Refactor model for OpenAPI Examples to use a reusable TypedDict

* ✨ Add support for openapi_examples in parameters

* 📝 Add new docs examples for new parameter openapi_examples

* 📝 Update docs for Schema Extra to include OpenAPI examples

* ✅ Add tests for new source examples, for openapi_examples

* ✅ Add tests for openapi_examples corner cases and all parameters

* 💡 Tweak and ignore type annotation checks for custom TypedDict

.github/DISCUSSION_TEMPLATE/questions.yml

@@ -0,0 +1,158 @@
+labels: [question]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your interest in FastAPI! 🚀
+
+        Please follow these instructions, fill every question, and do every step. 🙏
+
+        I'm asking this because answering questions and solving problems in GitHub is what consumes most of the time.
+
+        I end up not being able to add new features, fix bugs, review pull requests, etc. as fast as I wish because I have to spend too much time handling questions.
+
+        All that, on top of all the incredible help provided by a bunch of community members, the [FastAPI Experts](https://fastapi.tiangolo.com/fastapi-people/#experts), that give a lot of their time to come here and help others.
+
+        That's a lot of work they are doing, but if more FastAPI users came to help others like them just a little bit more, it would be much less effort for them (and you and me 😅).
+
+        By asking questions in a structured way (following this) it will be much easier to help you.
+
+        And there's a high chance that you will find the solution along the way and you won't even have to submit it and wait for an answer. 😎
+
+        As there are too many questions, I'll have to discard and close the incomplete ones. That will allow me (and others) to focus on helping people like you that follow the whole process and help us help you. 🤓
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: First Check
+      description: Please confirm and check all the following options.
+      options:
+        - label: I added a very descriptive title here.
+          required: true
+        - label: I used the GitHub search to find a similar question and didn't find it.
+          required: true
+        - label: I searched the FastAPI documentation, with the integrated search.
+          required: true
+        - label: I already searched in Google "How to X in FastAPI" and didn't find any information.
+          required: true
+        - label: I already read and followed all the tutorial in the docs and didn't find an answer.
+          required: true
+        - label: I already checked if it is not related to FastAPI but to [Pydantic](https://github.com/pydantic/pydantic).
+          required: true
+        - label: I already checked if it is not related to FastAPI but to [Swagger UI](https://github.com/swagger-api/swagger-ui).
+          required: true
+        - label: I already checked if it is not related to FastAPI but to [ReDoc](https://github.com/Redocly/redoc).
+          required: true
+  - type: checkboxes
+    id: help
+    attributes:
+      label: Commit to Help
+      description: |
+        After submitting this, I commit to one of:
+
+          * Read open questions until I find 2 where I can help someone and add a comment to help there.
+          * I already hit the "watch" button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
+          * Review one Pull Request by downloading the code and following [all the review process](https://fastapi.tiangolo.com/help-fastapi/#review-pull-requests).
+
+      options:
+        - label: I commit to help with one of those options 👆
+          required: true
+  - type: textarea
+    id: example
+    attributes:
+      label: Example Code
+      description: |
+        Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
+
+        If I (or someone) can copy it, run it, and see it right away, there's a much higher chance I (or someone) will be able to help you.
+
+      placeholder: |
+        from fastapi import FastAPI
+
+        app = FastAPI()
+
+
+        @app.get("/")
+        def read_root():
+            return {"Hello": "World"}
+      render: python
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        What is the problem, question, or error?
+
+        Write a short description telling me what you are doing, what you expect to happen, and what is currently happening.
+      placeholder: |
+        * Open the browser and call the endpoint `/`.
+        * It returns a JSON with `{"Hello": "World"}`.
+        * But I expected it to return `{"Hello": "Sara"}`.
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you on?
+      multiple: true
+      options:
+        - Linux
+        - Windows
+        - macOS
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: os-details
+    attributes:
+      label: Operating System Details
+      description: You can add more details about your operating system here, in particular if you chose "Other".
+  - type: input
+    id: fastapi-version
+    attributes:
+      label: FastAPI Version
+      description: |
+        What FastAPI version are you using?
+
+        You can find the FastAPI version with:
+
+        ```bash
+        python -c "import fastapi; print(fastapi.__version__)"
+        ```
+    validations:
+      required: true
+  - type: input
+    id: pydantic-version
+    attributes:
+      label: Pydantic Version
+      description: |
+        What Pydantic version are you using?
+
+        You can find the Pydantic version with:
+
+        ```bash
+        python -c "import pydantic; print(pydantic.version.VERSION)"
+        ```
+    validations:
+      required: true
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: |
+        What Python version are you using?
+
+        You can find the Python version with:
+
+        ```bash
+        python --version
+        ```
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any additional context information or screenshots you think are useful.

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [tiangolo]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,62 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: "[BUG]"
-labels: bug
-assignees: ''
-
----
-
-### Describe the bug
-
-Write here a clear and concise description of what the bug is.
-
-### To Reproduce
-
-Steps to reproduce the behavior with a minimum self-contained file.
-
-Replace each part with your own scenario:
-
-1. Create a file with:
-
-```Python
-from fastapi import FastAPI
-
-app = FastAPI()
-
-
-@app.get("/")
-def read_root():
-    return {"Hello": "World"}
-```
-
-3. Open the browser and call the endpoint `/`.
-4. It returns a JSON with `{"Hello": "World"}`.
-5. But I expected it to return `{"Hello": "Sara"}`.
-
-### Expected behavior
-
-Add a clear and concise description of what you expected to happen.
-
-### Screenshots
-
-If applicable, add screenshots to help explain your problem.
-
-### Environment
-
-- OS: [e.g. Linux / Windows / macOS]
-- FastAPI Version [e.g. 0.3.0], get it with:
-
-```bash
-python -c "import fastapi; print(fastapi.__version__)"
-```
-
-- Python version, get it with:
-
-```bash
-python --version
-```
-
-### Additional context
-
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,16 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Security Contact
+    about: Please report security vulnerabilities to security@tiangolo.com
+  - name: Question or Problem
+    about: Ask a question or ask about a problem in GitHub Discussions.
+    url: https://github.com/tiangolo/fastapi/discussions/categories/questions
+  - name: Feature Request
+    about: To suggest an idea or ask about a feature, please start with a question saying what you would like to achieve. There might be a way to do it already.
+    url: https://github.com/tiangolo/fastapi/discussions/categories/questions
+  - name: Show and tell
+    about: Show what you built with FastAPI or to be used with FastAPI.
+    url: https://github.com/tiangolo/fastapi/discussions/categories/show-and-tell
+  - name: Translations
+    about: Coordinate translations in GitHub Discussions.
+    url: https://github.com/tiangolo/fastapi/discussions/categories/translations

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,26 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: "[FEATURE]"
-labels: enhancement
-assignees: ''
-
----
-
-### Is your feature request related to a problem
-
-Is your feature request related to a problem?
-
-Add a clear and concise description of what the problem is. Ex. I want to be able to [...] but I can't because [...]
-
-### The solution you would like
-
-Add a clear and concise description of what you want to happen.
-
-### Describe alternatives you've considered
-
-Add a clear and concise description of any alternative solutions or features you've considered.
-
-### Additional context
-
-Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/privileged.yml

@@ -0,0 +1,22 @@
+name: Privileged
+description: You are @tiangolo or he asked you directly to create an issue here. If not, check the other options. 👇
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your interest in FastAPI! 🚀
+
+        If you are not @tiangolo or he didn't ask you directly to create an issue here, please start the conversation in a [Question in GitHub Discussions](https://github.com/tiangolo/fastapi/discussions/categories/questions) instead.
+  - type: checkboxes
+    id: privileged
+    attributes:
+      label: Privileged issue
+      description: Confirm that you are allowed to create an issue here.
+      options:
+        - label: I'm @tiangolo or he asked me directly to create an issue here.
+          required: true
+  - type: textarea
+    id: content
+    attributes:
+      label: Issue Content
+      description: Add the content of the issue here.

.github/ISSUE_TEMPLATE/question.md

@@ -1,24 +0,0 @@
----
-name: Question
-about: Ask a question
-title: "[QUESTION]"
-labels: question
-assignees: ''
-
----
-
-### First check
-
-* [ ] I used the GitHub search to find a similar issue and didn't find it.
-* [ ] I searched the FastAPI documentation, with the integrated search.
-* [ ] I already searched in Google "How to X in FastAPI" and didn't find any information.
-
-### Description
-
-How can I [...]?
-
-Is it possible to [...]?
-
-### Additional context
-
-Add any other context or screenshots about the feature request here.

.github/actions/comment-docs-preview-in-pr/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.7
+
+RUN pip install httpx "pydantic==1.5.1" pygithub
+
+COPY ./app /app
+
+CMD ["python", "/app/main.py"]

.github/actions/comment-docs-preview-in-pr/action.yml

@@ -0,0 +1,13 @@
+name: Comment Docs Preview in PR
+description: Comment with the docs URL preview in the PR
+author: Sebastián Ramírez <tiangolo@gmail.com>
+inputs:
+  token:
+    description: Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}
+    required: true
+  deploy_url:
+    description: The deployment URL to comment in the PR
+    required: true
+runs:
+  using: docker
+  image: Dockerfile

.github/actions/comment-docs-preview-in-pr/app/main.py

@@ -0,0 +1,68 @@
+import logging
+import sys
+from pathlib import Path
+from typing import Union
+
+import httpx
+from github import Github
+from github.PullRequest import PullRequest
+from pydantic import BaseModel, BaseSettings, SecretStr, ValidationError
+
+github_api = "https://api.github.com"
+
+
+class Settings(BaseSettings):
+    github_repository: str
+    github_event_path: Path
+    github_event_name: Union[str, None] = None
+    input_token: SecretStr
+    input_deploy_url: str
+
+
+class PartialGithubEventHeadCommit(BaseModel):
+    id: str
+
+
+class PartialGithubEventWorkflowRun(BaseModel):
+    head_commit: PartialGithubEventHeadCommit
+
+
+class PartialGithubEvent(BaseModel):
+    workflow_run: PartialGithubEventWorkflowRun
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    settings = Settings()
+    logging.info(f"Using config: {settings.json()}")
+    g = Github(settings.input_token.get_secret_value())
+    repo = g.get_repo(settings.github_repository)
+    try:
+        event = PartialGithubEvent.parse_file(settings.github_event_path)
+    except ValidationError as e:
+        logging.error(f"Error parsing event file: {e.errors()}")
+        sys.exit(0)
+    use_pr: Union[PullRequest, None] = None
+    for pr in repo.get_pulls():
+        if pr.head.sha == event.workflow_run.head_commit.id:
+            use_pr = pr
+            break
+    if not use_pr:
+        logging.error(f"No PR found for hash: {event.workflow_run.head_commit.id}")
+        sys.exit(0)
+    github_headers = {
+        "Authorization": f"token {settings.input_token.get_secret_value()}"
+    }
+    url = f"{github_api}/repos/{settings.github_repository}/issues/{use_pr.number}/comments"
+    logging.info(f"Using comments URL: {url}")
+    response = httpx.post(
+        url,
+        headers=github_headers,
+        json={
+            "body": f"📝 Docs preview for commit {use_pr.head.sha} at: {settings.input_deploy_url}"
+        },
+    )
+    if not (200 <= response.status_code <= 300):
+        logging.error(f"Error posting comment: {response.text}")
+        sys.exit(1)
+    logging.info("Finished")

.github/actions/notify-translations/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.7
+
+RUN pip install httpx PyGithub "pydantic==1.5.1" "pyyaml>=5.3.1,<6.0.0"
+
+COPY ./app /app
+
+CMD ["python", "/app/main.py"]

.github/actions/notify-translations/action.yml

@@ -0,0 +1,10 @@
+name: "Notify Translations"
+description: "Notify in the issue for a translation when there's a new PR available"
+author: "Sebastián Ramírez <tiangolo@gmail.com>"
+inputs:
+  token:
+    description: 'Token, to read the GitHub API. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
+    required: true
+runs:
+  using: 'docker'
+  image: 'Dockerfile'

.github/actions/notify-translations/app/main.py

@@ -0,0 +1,417 @@
+import logging
+import random
+import sys
+import time
+from pathlib import Path
+from typing import Any, Dict, List, Union, cast
+
+import httpx
+from github import Github
+from pydantic import BaseModel, BaseSettings, SecretStr
+
+awaiting_label = "awaiting review"
+lang_all_label = "lang-all"
+approved_label = "approved-2"
+translations_path = Path(__file__).parent / "translations.yml"
+
+github_graphql_url = "https://api.github.com/graphql"
+questions_translations_category_id = "DIC_kwDOCZduT84CT5P9"
+
+all_discussions_query = """
+query Q($category_id: ID) {
+  repository(name: "fastapi", owner: "tiangolo") {
+    discussions(categoryId: $category_id, first: 100) {
+      nodes {
+        title
+        id
+        number
+        labels(first: 10) {
+          edges {
+            node {
+              id
+              name
+            }
+          }
+        }
+      }
+    }
+  }
+}
+"""
+
+translation_discussion_query = """
+query Q($after: String, $discussion_number: Int!) {
+  repository(name: "fastapi", owner: "tiangolo") {
+    discussion(number: $discussion_number) {
+      comments(first: 100, after: $after) {
+        edges {
+          cursor
+          node {
+            id
+            url
+            body
+          }
+        }
+      }
+    }
+  }
+}
+"""
+
+add_comment_mutation = """
+mutation Q($discussion_id: ID!, $body: String!) {
+  addDiscussionComment(input: {discussionId: $discussion_id, body: $body}) {
+    comment {
+      id
+      url
+      body
+    }
+  }
+}
+"""
+
+update_comment_mutation = """
+mutation Q($comment_id: ID!, $body: String!) {
+  updateDiscussionComment(input: {commentId: $comment_id, body: $body}) {
+    comment {
+      id
+      url
+      body
+    }
+  }
+}
+"""
+
+
+class Comment(BaseModel):
+    id: str
+    url: str
+    body: str
+
+
+class UpdateDiscussionComment(BaseModel):
+    comment: Comment
+
+
+class UpdateCommentData(BaseModel):
+    updateDiscussionComment: UpdateDiscussionComment
+
+
+class UpdateCommentResponse(BaseModel):
+    data: UpdateCommentData
+
+
+class AddDiscussionComment(BaseModel):
+    comment: Comment
+
+
+class AddCommentData(BaseModel):
+    addDiscussionComment: AddDiscussionComment
+
+
+class AddCommentResponse(BaseModel):
+    data: AddCommentData
+
+
+class CommentsEdge(BaseModel):
+    node: Comment
+    cursor: str
+
+
+class Comments(BaseModel):
+    edges: List[CommentsEdge]
+
+
+class CommentsDiscussion(BaseModel):
+    comments: Comments
+
+
+class CommentsRepository(BaseModel):
+    discussion: CommentsDiscussion
+
+
+class CommentsData(BaseModel):
+    repository: CommentsRepository
+
+
+class CommentsResponse(BaseModel):
+    data: CommentsData
+
+
+class AllDiscussionsLabelNode(BaseModel):
+    id: str
+    name: str
+
+
+class AllDiscussionsLabelsEdge(BaseModel):
+    node: AllDiscussionsLabelNode
+
+
+class AllDiscussionsDiscussionLabels(BaseModel):
+    edges: List[AllDiscussionsLabelsEdge]
+
+
+class AllDiscussionsDiscussionNode(BaseModel):
+    title: str
+    id: str
+    number: int
+    labels: AllDiscussionsDiscussionLabels
+
+
+class AllDiscussionsDiscussions(BaseModel):
+    nodes: List[AllDiscussionsDiscussionNode]
+
+
+class AllDiscussionsRepository(BaseModel):
+    discussions: AllDiscussionsDiscussions
+
+
+class AllDiscussionsData(BaseModel):
+    repository: AllDiscussionsRepository
+
+
+class AllDiscussionsResponse(BaseModel):
+    data: AllDiscussionsData
+
+
+class Settings(BaseSettings):
+    github_repository: str
+    input_token: SecretStr
+    github_event_path: Path
+    github_event_name: Union[str, None] = None
+    httpx_timeout: int = 30
+    input_debug: Union[bool, None] = False
+
+
+class PartialGitHubEventIssue(BaseModel):
+    number: int
+
+
+class PartialGitHubEvent(BaseModel):
+    pull_request: PartialGitHubEventIssue
+
+
+def get_graphql_response(
+    *,
+    settings: Settings,
+    query: str,
+    after: Union[str, None] = None,
+    category_id: Union[str, None] = None,
+    discussion_number: Union[int, None] = None,
+    discussion_id: Union[str, None] = None,
+    comment_id: Union[str, None] = None,
+    body: Union[str, None] = None,
+) -> Dict[str, Any]:
+    headers = {"Authorization": f"token {settings.input_token.get_secret_value()}"}
+    # some fields are only used by one query, but GraphQL allows unused variables, so
+    # keep them here for simplicity
+    variables = {
+        "after": after,
+        "category_id": category_id,
+        "discussion_number": discussion_number,
+        "discussion_id": discussion_id,
+        "comment_id": comment_id,
+        "body": body,
+    }
+    response = httpx.post(
+        github_graphql_url,
+        headers=headers,
+        timeout=settings.httpx_timeout,
+        json={"query": query, "variables": variables, "operationName": "Q"},
+    )
+    if response.status_code != 200:
+        logging.error(
+            f"Response was not 200, after: {after}, category_id: {category_id}"
+        )
+        logging.error(response.text)
+        raise RuntimeError(response.text)
+    data = response.json()
+    if "errors" in data:
+        logging.error(f"Errors in response, after: {after}, category_id: {category_id}")
+        logging.error(response.text)
+        raise RuntimeError(response.text)
+    return cast(Dict[str, Any], data)
+
+
+def get_graphql_translation_discussions(*, settings: Settings):
+    data = get_graphql_response(
+        settings=settings,
+        query=all_discussions_query,
+        category_id=questions_translations_category_id,
+    )
+    graphql_response = AllDiscussionsResponse.parse_obj(data)
+    return graphql_response.data.repository.discussions.nodes
+
+
+def get_graphql_translation_discussion_comments_edges(
+    *, settings: Settings, discussion_number: int, after: Union[str, None] = None
+):
+    data = get_graphql_response(
+        settings=settings,
+        query=translation_discussion_query,
+        discussion_number=discussion_number,
+        after=after,
+    )
+    graphql_response = CommentsResponse.parse_obj(data)
+    return graphql_response.data.repository.discussion.comments.edges
+
+
+def get_graphql_translation_discussion_comments(
+    *, settings: Settings, discussion_number: int
+):
+    comment_nodes: List[Comment] = []
+    discussion_edges = get_graphql_translation_discussion_comments_edges(
+        settings=settings, discussion_number=discussion_number
+    )
+
+    while discussion_edges:
+        for discussion_edge in discussion_edges:
+            comment_nodes.append(discussion_edge.node)
+        last_edge = discussion_edges[-1]
+        discussion_edges = get_graphql_translation_discussion_comments_edges(
+            settings=settings,
+            discussion_number=discussion_number,
+            after=last_edge.cursor,
+        )
+    return comment_nodes
+
+
+def create_comment(*, settings: Settings, discussion_id: str, body: str):
+    data = get_graphql_response(
+        settings=settings,
+        query=add_comment_mutation,
+        discussion_id=discussion_id,
+        body=body,
+    )
+    response = AddCommentResponse.parse_obj(data)
+    return response.data.addDiscussionComment.comment
+
+
+def update_comment(*, settings: Settings, comment_id: str, body: str):
+    data = get_graphql_response(
+        settings=settings,
+        query=update_comment_mutation,
+        comment_id=comment_id,
+        body=body,
+    )
+    response = UpdateCommentResponse.parse_obj(data)
+    return response.data.updateDiscussionComment.comment
+
+
+if __name__ == "__main__":
+    settings = Settings()
+    if settings.input_debug:
+        logging.basicConfig(level=logging.DEBUG)
+    else:
+        logging.basicConfig(level=logging.INFO)
+    logging.debug(f"Using config: {settings.json()}")
+    g = Github(settings.input_token.get_secret_value())
+    repo = g.get_repo(settings.github_repository)
+    if not settings.github_event_path.is_file():
+        raise RuntimeError(
+            f"No github event file available at: {settings.github_event_path}"
+        )
+    contents = settings.github_event_path.read_text()
+    github_event = PartialGitHubEvent.parse_raw(contents)
+
+    # Avoid race conditions with multiple labels
+    sleep_time = random.random() * 10  # random number between 0 and 10 seconds
+    logging.info(
+        f"Sleeping for {sleep_time} seconds to avoid "
+        "race conditions and multiple comments"
+    )
+    time.sleep(sleep_time)
+
+    # Get PR
+    logging.debug(f"Processing PR: #{github_event.pull_request.number}")
+    pr = repo.get_pull(github_event.pull_request.number)
+    label_strs = {label.name for label in pr.get_labels()}
+    langs = []
+    for label in label_strs:
+        if label.startswith("lang-") and not label == lang_all_label:
+            langs.append(label[5:])
+    logging.info(f"PR #{pr.number} has labels: {label_strs}")
+    if not langs or lang_all_label not in label_strs:
+        logging.info(f"PR #{pr.number} doesn't seem to be a translation PR, skipping")
+        sys.exit(0)
+
+    # Generate translation map, lang ID to discussion
+    discussions = get_graphql_translation_discussions(settings=settings)
+    lang_to_discussion_map: Dict[str, AllDiscussionsDiscussionNode] = {}
+    for discussion in discussions:
+        for edge in discussion.labels.edges:
+            label = edge.node.name
+            if label.startswith("lang-") and not label == lang_all_label:
+                lang = label[5:]
+                lang_to_discussion_map[lang] = discussion
+    logging.debug(f"Using translations map: {lang_to_discussion_map}")
+
+    # Messages to create or check
+    new_translation_message = f"Good news everyone! 😉 There's a new translation PR to be reviewed: #{pr.number} by @{pr.user.login}. 🎉 This requires 2 approvals from native speakers to be merged. 🤓"
+    done_translation_message = f"~There's a new translation PR to be reviewed: #{pr.number} by @{pr.user.login}~ Good job! This is done. 🍰☕"
+
+    # Normally only one language, but still
+    for lang in langs:
+        if lang not in lang_to_discussion_map:
+            log_message = f"Could not find discussion for language: {lang}"
+            logging.error(log_message)
+            raise RuntimeError(log_message)
+        discussion = lang_to_discussion_map[lang]
+        logging.info(
+            f"Found a translation discussion for language: {lang} in discussion: #{discussion.number}"
+        )
+
+        already_notified_comment: Union[Comment, None] = None
+        already_done_comment: Union[Comment, None] = None
+
+        logging.info(
+            f"Checking current comments in discussion: #{discussion.number} to see if already notified about this PR: #{pr.number}"
+        )
+        comments = get_graphql_translation_discussion_comments(
+            settings=settings, discussion_number=discussion.number
+        )
+        for comment in comments:
+            if new_translation_message in comment.body:
+                already_notified_comment = comment
+            elif done_translation_message in comment.body:
+                already_done_comment = comment
+        logging.info(
+            f"Already notified comment: {already_notified_comment}, already done comment: {already_done_comment}"
+        )
+
+        if pr.state == "open" and awaiting_label in label_strs:
+            logging.info(
+                f"This PR seems to be a language translation and awaiting reviews: #{pr.number}"
+            )
+            if already_notified_comment:
+                logging.info(
+                    f"This PR #{pr.number} was already notified in comment: {already_notified_comment.url}"
+                )
+            else:
+                logging.info(
+                    f"Writing notification comment about PR #{pr.number} in Discussion: #{discussion.number}"
+                )
+                comment = create_comment(
+                    settings=settings,
+                    discussion_id=discussion.id,
+                    body=new_translation_message,
+                )
+                logging.info(f"Notified in comment: {comment.url}")
+        elif pr.state == "closed" or approved_label in label_strs:
+            logging.info(f"Already approved or closed PR #{pr.number}")
+            if already_done_comment:
+                logging.info(
+                    f"This PR #{pr.number} was already marked as done in comment: {already_done_comment.url}"
+                )
+            elif already_notified_comment:
+                updated_comment = update_comment(
+                    settings=settings,
+                    comment_id=already_notified_comment.id,
+                    body=done_translation_message,
+                )
+                logging.info(f"Marked as done in comment: {updated_comment.url}")
+        else:
+            logging.info(
+                f"There doesn't seem to be anything to be done about PR #{pr.number}"
+            )
+    logging.info("Finished")

.github/actions/people/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.9
+
+RUN pip install httpx PyGithub "pydantic==2.0.2" pydantic-settings "pyyaml>=5.3.1,<6.0.0"
+
+COPY ./app /app
+
+CMD ["python", "/app/main.py"]

.github/actions/people/action.yml

@@ -0,0 +1,10 @@
+name: "Generate FastAPI People"
+description: "Generate the data for the FastAPI People page"
+author: "Sebastián Ramírez <tiangolo@gmail.com>"
+inputs:
+  token:
+    description: 'User token, to read the GitHub API. Can be passed in using {{ secrets.FASTAPI_PEOPLE }}'
+    required: true
+runs:
+  using: 'docker'
+  image: 'Dockerfile'

.github/actions/people/app/main.py

@@ -0,0 +1,727 @@
+import logging
+import subprocess
+import sys
+from collections import Counter, defaultdict
+from datetime import datetime, timedelta, timezone
+from pathlib import Path
+from typing import Any, Container, DefaultDict, Dict, List, Set, Union
+
+import httpx
+import yaml
+from github import Github
+from pydantic import BaseModel, SecretStr
+from pydantic_settings import BaseSettings
+
+github_graphql_url = "https://api.github.com/graphql"
+questions_category_id = "MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMyMDAxNDM0"
+
+discussions_query = """
+query Q($after: String, $category_id: ID) {
+  repository(name: "fastapi", owner: "tiangolo") {
+    discussions(first: 100, after: $after, categoryId: $category_id) {
+      edges {
+        cursor
+        node {
+          number
+          author {
+            login
+            avatarUrl
+            url
+          }
+          title
+          createdAt
+          comments(first: 100) {
+            nodes {
+              createdAt
+              author {
+                login
+                avatarUrl
+                url
+              }
+              isAnswer
+              replies(first: 10) {
+                nodes {
+                  createdAt
+                  author {
+                    login
+                    avatarUrl
+                    url
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+"""
+
+issues_query = """
+query Q($after: String) {
+  repository(name: "fastapi", owner: "tiangolo") {
+    issues(first: 100, after: $after) {
+      edges {
+        cursor
+        node {
+          number
+          author {
+            login
+            avatarUrl
+            url
+          }
+          title
+          createdAt
+          state
+          comments(first: 100) {
+            nodes {
+              createdAt
+              author {
+                login
+                avatarUrl
+                url
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+"""
+
+prs_query = """
+query Q($after: String) {
+  repository(name: "fastapi", owner: "tiangolo") {
+    pullRequests(first: 100, after: $after) {
+      edges {
+        cursor
+        node {
+          number
+          labels(first: 100) {
+            nodes {
+              name
+            }
+          }
+          author {
+            login
+            avatarUrl
+            url
+          }
+          title
+          createdAt
+          state
+          comments(first: 100) {
+            nodes {
+              createdAt
+              author {
+                login
+                avatarUrl
+                url
+              }
+            }
+          }
+          reviews(first:100) {
+            nodes {
+              author {
+                login
+                avatarUrl
+                url
+              }
+              state
+            }
+          }
+        }
+      }
+    }
+  }
+}
+"""
+
+sponsors_query = """
+query Q($after: String) {
+  user(login: "tiangolo") {
+    sponsorshipsAsMaintainer(first: 100, after: $after) {
+      edges {
+        cursor
+        node {
+          sponsorEntity {
+            ... on Organization {
+              login
+              avatarUrl
+              url
+            }
+            ... on User {
+              login
+              avatarUrl
+              url
+            }
+          }
+          tier {
+            name
+            monthlyPriceInDollars
+          }
+        }
+      }
+    }
+  }
+}
+"""
+
+
+class Author(BaseModel):
+    login: str
+    avatarUrl: str
+    url: str
+
+
+# Issues and Discussions
+
+
+class CommentsNode(BaseModel):
+    createdAt: datetime
+    author: Union[Author, None] = None
+
+
+class Replies(BaseModel):
+    nodes: List[CommentsNode]
+
+
+class DiscussionsCommentsNode(CommentsNode):
+    replies: Replies
+
+
+class Comments(BaseModel):
+    nodes: List[CommentsNode]
+
+
+class DiscussionsComments(BaseModel):
+    nodes: List[DiscussionsCommentsNode]
+
+
+class IssuesNode(BaseModel):
+    number: int
+    author: Union[Author, None] = None
+    title: str
+    createdAt: datetime
+    state: str
+    comments: Comments
+
+
+class DiscussionsNode(BaseModel):
+    number: int
+    author: Union[Author, None] = None
+    title: str
+    createdAt: datetime
+    comments: DiscussionsComments
+
+
+class IssuesEdge(BaseModel):
+    cursor: str
+    node: IssuesNode
+
+
+class DiscussionsEdge(BaseModel):
+    cursor: str
+    node: DiscussionsNode
+
+
+class Issues(BaseModel):
+    edges: List[IssuesEdge]
+
+
+class Discussions(BaseModel):
+    edges: List[DiscussionsEdge]
+
+
+class IssuesRepository(BaseModel):
+    issues: Issues
+
+
+class DiscussionsRepository(BaseModel):
+    discussions: Discussions
+
+
+class IssuesResponseData(BaseModel):
+    repository: IssuesRepository
+
+
+class DiscussionsResponseData(BaseModel):
+    repository: DiscussionsRepository
+
+
+class IssuesResponse(BaseModel):
+    data: IssuesResponseData
+
+
+class DiscussionsResponse(BaseModel):
+    data: DiscussionsResponseData
+
+
+# PRs
+
+
+class LabelNode(BaseModel):
+    name: str
+
+
+class Labels(BaseModel):
+    nodes: List[LabelNode]
+
+
+class ReviewNode(BaseModel):
+    author: Union[Author, None] = None
+    state: str
+
+
+class Reviews(BaseModel):
+    nodes: List[ReviewNode]
+
+
+class PullRequestNode(BaseModel):
+    number: int
+    labels: Labels
+    author: Union[Author, None] = None
+    title: str
+    createdAt: datetime
+    state: str
+    comments: Comments
+    reviews: Reviews
+
+
+class PullRequestEdge(BaseModel):
+    cursor: str
+    node: PullRequestNode
+
+
+class PullRequests(BaseModel):
+    edges: List[PullRequestEdge]
+
+
+class PRsRepository(BaseModel):
+    pullRequests: PullRequests
+
+
+class PRsResponseData(BaseModel):
+    repository: PRsRepository
+
+
+class PRsResponse(BaseModel):
+    data: PRsResponseData
+
+
+# Sponsors
+
+
+class SponsorEntity(BaseModel):
+    login: str
+    avatarUrl: str
+    url: str
+
+
+class Tier(BaseModel):
+    name: str
+    monthlyPriceInDollars: float
+
+
+class SponsorshipAsMaintainerNode(BaseModel):
+    sponsorEntity: SponsorEntity
+    tier: Tier
+
+
+class SponsorshipAsMaintainerEdge(BaseModel):
+    cursor: str
+    node: SponsorshipAsMaintainerNode
+
+
+class SponsorshipAsMaintainer(BaseModel):
+    edges: List[SponsorshipAsMaintainerEdge]
+
+
+class SponsorsUser(BaseModel):
+    sponsorshipsAsMaintainer: SponsorshipAsMaintainer
+
+
+class SponsorsResponseData(BaseModel):
+    user: SponsorsUser
+
+
+class SponsorsResponse(BaseModel):
+    data: SponsorsResponseData
+
+
+class Settings(BaseSettings):
+    input_token: SecretStr
+    github_repository: str
+    httpx_timeout: int = 30
+
+
+def get_graphql_response(
+    *,
+    settings: Settings,
+    query: str,
+    after: Union[str, None] = None,
+    category_id: Union[str, None] = None,
+) -> Dict[str, Any]:
+    headers = {"Authorization": f"token {settings.input_token.get_secret_value()}"}
+    # category_id is only used by one query, but GraphQL allows unused variables, so
+    # keep it here for simplicity
+    variables = {"after": after, "category_id": category_id}
+    response = httpx.post(
+        github_graphql_url,
+        headers=headers,
+        timeout=settings.httpx_timeout,
+        json={"query": query, "variables": variables, "operationName": "Q"},
+    )
+    if response.status_code != 200:
+        logging.error(
+            f"Response was not 200, after: {after}, category_id: {category_id}"
+        )
+        logging.error(response.text)
+        raise RuntimeError(response.text)
+    data = response.json()
+    if "errors" in data:
+        logging.error(f"Errors in response, after: {after}, category_id: {category_id}")
+        logging.error(data["errors"])
+        logging.error(response.text)
+        raise RuntimeError(response.text)
+    return data
+
+
+def get_graphql_issue_edges(*, settings: Settings, after: Union[str, None] = None):
+    data = get_graphql_response(settings=settings, query=issues_query, after=after)
+    graphql_response = IssuesResponse.model_validate(data)
+    return graphql_response.data.repository.issues.edges
+
+
+def get_graphql_question_discussion_edges(
+    *,
+    settings: Settings,
+    after: Union[str, None] = None,
+):
+    data = get_graphql_response(
+        settings=settings,
+        query=discussions_query,
+        after=after,
+        category_id=questions_category_id,
+    )
+    graphql_response = DiscussionsResponse.model_validate(data)
+    return graphql_response.data.repository.discussions.edges
+
+
+def get_graphql_pr_edges(*, settings: Settings, after: Union[str, None] = None):
+    data = get_graphql_response(settings=settings, query=prs_query, after=after)
+    graphql_response = PRsResponse.model_validate(data)
+    return graphql_response.data.repository.pullRequests.edges
+
+
+def get_graphql_sponsor_edges(*, settings: Settings, after: Union[str, None] = None):
+    data = get_graphql_response(settings=settings, query=sponsors_query, after=after)
+    graphql_response = SponsorsResponse.model_validate(data)
+    return graphql_response.data.user.sponsorshipsAsMaintainer.edges
+
+
+def get_issues_experts(settings: Settings):
+    issue_nodes: List[IssuesNode] = []
+    issue_edges = get_graphql_issue_edges(settings=settings)
+
+    while issue_edges:
+        for edge in issue_edges:
+            issue_nodes.append(edge.node)
+        last_edge = issue_edges[-1]
+        issue_edges = get_graphql_issue_edges(settings=settings, after=last_edge.cursor)
+
+    commentors = Counter()
+    last_month_commentors = Counter()
+    authors: Dict[str, Author] = {}
+
+    now = datetime.now(tz=timezone.utc)
+    one_month_ago = now - timedelta(days=30)
+
+    for issue in issue_nodes:
+        issue_author_name = None
+        if issue.author:
+            authors[issue.author.login] = issue.author
+            issue_author_name = issue.author.login
+        issue_commentors = set()
+        for comment in issue.comments.nodes:
+            if comment.author:
+                authors[comment.author.login] = comment.author
+                if comment.author.login != issue_author_name:
+                    issue_commentors.add(comment.author.login)
+        for author_name in issue_commentors:
+            commentors[author_name] += 1
+            if issue.createdAt > one_month_ago:
+                last_month_commentors[author_name] += 1
+
+    return commentors, last_month_commentors, authors
+
+
+def get_discussions_experts(settings: Settings):
+    discussion_nodes: List[DiscussionsNode] = []
+    discussion_edges = get_graphql_question_discussion_edges(settings=settings)
+
+    while discussion_edges:
+        for discussion_edge in discussion_edges:
+            discussion_nodes.append(discussion_edge.node)
+        last_edge = discussion_edges[-1]
+        discussion_edges = get_graphql_question_discussion_edges(
+            settings=settings, after=last_edge.cursor
+        )
+
+    commentors = Counter()
+    last_month_commentors = Counter()
+    authors: Dict[str, Author] = {}
+
+    now = datetime.now(tz=timezone.utc)
+    one_month_ago = now - timedelta(days=30)
+
+    for discussion in discussion_nodes:
+        discussion_author_name = None
+        if discussion.author:
+            authors[discussion.author.login] = discussion.author
+            discussion_author_name = discussion.author.login
+        discussion_commentors = set()
+        for comment in discussion.comments.nodes:
+            if comment.author:
+                authors[comment.author.login] = comment.author
+                if comment.author.login != discussion_author_name:
+                    discussion_commentors.add(comment.author.login)
+            for reply in comment.replies.nodes:
+                if reply.author:
+                    authors[reply.author.login] = reply.author
+                    if reply.author.login != discussion_author_name:
+                        discussion_commentors.add(reply.author.login)
+        for author_name in discussion_commentors:
+            commentors[author_name] += 1
+            if discussion.createdAt > one_month_ago:
+                last_month_commentors[author_name] += 1
+    return commentors, last_month_commentors, authors
+
+
+def get_experts(settings: Settings):
+    # Migrated to only use GitHub Discussions
+    # (
+    #     issues_commentors,
+    #     issues_last_month_commentors,
+    #     issues_authors,
+    # ) = get_issues_experts(settings=settings)
+    (
+        discussions_commentors,
+        discussions_last_month_commentors,
+        discussions_authors,
+    ) = get_discussions_experts(settings=settings)
+    # commentors = issues_commentors + discussions_commentors
+    commentors = discussions_commentors
+    # last_month_commentors = (
+    #     issues_last_month_commentors + discussions_last_month_commentors
+    # )
+    last_month_commentors = discussions_last_month_commentors
+    # authors = {**issues_authors, **discussions_authors}
+    authors = {**discussions_authors}
+    return commentors, last_month_commentors, authors
+
+
+def get_contributors(settings: Settings):
+    pr_nodes: List[PullRequestNode] = []
+    pr_edges = get_graphql_pr_edges(settings=settings)
+
+    while pr_edges:
+        for edge in pr_edges:
+            pr_nodes.append(edge.node)
+        last_edge = pr_edges[-1]
+        pr_edges = get_graphql_pr_edges(settings=settings, after=last_edge.cursor)
+
+    contributors = Counter()
+    commentors = Counter()
+    reviewers = Counter()
+    authors: Dict[str, Author] = {}
+
+    for pr in pr_nodes:
+        author_name = None
+        if pr.author:
+            authors[pr.author.login] = pr.author
+            author_name = pr.author.login
+        pr_commentors: Set[str] = set()
+        pr_reviewers: Set[str] = set()
+        for comment in pr.comments.nodes:
+            if comment.author:
+                authors[comment.author.login] = comment.author
+                if comment.author.login == author_name:
+                    continue
+                pr_commentors.add(comment.author.login)
+        for author_name in pr_commentors:
+            commentors[author_name] += 1
+        for review in pr.reviews.nodes:
+            if review.author:
+                authors[review.author.login] = review.author
+                pr_reviewers.add(review.author.login)
+        for reviewer in pr_reviewers:
+            reviewers[reviewer] += 1
+        if pr.state == "MERGED" and pr.author:
+            contributors[pr.author.login] += 1
+    return contributors, commentors, reviewers, authors
+
+
+def get_individual_sponsors(settings: Settings):
+    nodes: List[SponsorshipAsMaintainerNode] = []
+    edges = get_graphql_sponsor_edges(settings=settings)
+
+    while edges:
+        for edge in edges:
+            nodes.append(edge.node)
+        last_edge = edges[-1]
+        edges = get_graphql_sponsor_edges(settings=settings, after=last_edge.cursor)
+
+    tiers: DefaultDict[float, Dict[str, SponsorEntity]] = defaultdict(dict)
+    for node in nodes:
+        tiers[node.tier.monthlyPriceInDollars][
+            node.sponsorEntity.login
+        ] = node.sponsorEntity
+    return tiers
+
+
+def get_top_users(
+    *,
+    counter: Counter,
+    min_count: int,
+    authors: Dict[str, Author],
+    skip_users: Container[str],
+):
+    users = []
+    for commentor, count in counter.most_common(50):
+        if commentor in skip_users:
+            continue
+        if count >= min_count:
+            author = authors[commentor]
+            users.append(
+                {
+                    "login": commentor,
+                    "count": count,
+                    "avatarUrl": author.avatarUrl,
+                    "url": author.url,
+                }
+            )
+    return users
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    settings = Settings()
+    logging.info(f"Using config: {settings.model_dump_json()}")
+    g = Github(settings.input_token.get_secret_value())
+    repo = g.get_repo(settings.github_repository)
+    question_commentors, question_last_month_commentors, question_authors = get_experts(
+        settings=settings
+    )
+    contributors, pr_commentors, reviewers, pr_authors = get_contributors(
+        settings=settings
+    )
+    authors = {**question_authors, **pr_authors}
+    maintainers_logins = {"tiangolo"}
+    bot_names = {"codecov", "github-actions", "pre-commit-ci", "dependabot"}
+    maintainers = []
+    for login in maintainers_logins:
+        user = authors[login]
+        maintainers.append(
+            {
+                "login": login,
+                "answers": question_commentors[login],
+                "prs": contributors[login],
+                "avatarUrl": user.avatarUrl,
+                "url": user.url,
+            }
+        )
+
+    min_count_expert = 10
+    min_count_last_month = 3
+    min_count_contributor = 4
+    min_count_reviewer = 4
+    skip_users = maintainers_logins | bot_names
+    experts = get_top_users(
+        counter=question_commentors,
+        min_count=min_count_expert,
+        authors=authors,
+        skip_users=skip_users,
+    )
+    last_month_active = get_top_users(
+        counter=question_last_month_commentors,
+        min_count=min_count_last_month,
+        authors=authors,
+        skip_users=skip_users,
+    )
+    top_contributors = get_top_users(
+        counter=contributors,
+        min_count=min_count_contributor,
+        authors=authors,
+        skip_users=skip_users,
+    )
+    top_reviewers = get_top_users(
+        counter=reviewers,
+        min_count=min_count_reviewer,
+        authors=authors,
+        skip_users=skip_users,
+    )
+
+    tiers = get_individual_sponsors(settings=settings)
+    keys = list(tiers.keys())
+    keys.sort(reverse=True)
+    sponsors = []
+    for key in keys:
+        sponsor_group = []
+        for login, sponsor in tiers[key].items():
+            sponsor_group.append(
+                {"login": login, "avatarUrl": sponsor.avatarUrl, "url": sponsor.url}
+            )
+        sponsors.append(sponsor_group)
+
+    people = {
+        "maintainers": maintainers,
+        "experts": experts,
+        "last_month_active": last_month_active,
+        "top_contributors": top_contributors,
+        "top_reviewers": top_reviewers,
+    }
+    github_sponsors = {
+        "sponsors": sponsors,
+    }
+    people_path = Path("./docs/en/data/people.yml")
+    github_sponsors_path = Path("./docs/en/data/github_sponsors.yml")
+    people_old_content = people_path.read_text(encoding="utf-8")
+    github_sponsors_old_content = github_sponsors_path.read_text(encoding="utf-8")
+    new_people_content = yaml.dump(
+        people, sort_keys=False, width=200, allow_unicode=True
+    )
+    new_github_sponsors_content = yaml.dump(
+        github_sponsors, sort_keys=False, width=200, allow_unicode=True
+    )
+    if (
+        people_old_content == new_people_content
+        and github_sponsors_old_content == new_github_sponsors_content
+    ):
+        logging.info("The FastAPI People data hasn't changed, finishing.")
+        sys.exit(0)
+    people_path.write_text(new_people_content, encoding="utf-8")
+    github_sponsors_path.write_text(new_github_sponsors_content, encoding="utf-8")
+    logging.info("Setting up GitHub Actions git user")
+    subprocess.run(["git", "config", "user.name", "github-actions"], check=True)
+    subprocess.run(
+        ["git", "config", "user.email", "github-actions@github.com"], check=True
+    )
+    branch_name = "fastapi-people"
+    logging.info(f"Creating a new branch {branch_name}")
+    subprocess.run(["git", "checkout", "-b", branch_name], check=True)
+    logging.info("Adding updated file")
+    subprocess.run(
+        ["git", "add", str(people_path), str(github_sponsors_path)], check=True
+    )
+    logging.info("Committing updated file")
+    message = "👥 Update FastAPI People"
+    result = subprocess.run(["git", "commit", "-m", message], check=True)
+    logging.info("Pushing branch")
+    subprocess.run(["git", "push", "origin", branch_name], check=True)
+    logging.info("Creating PR")
+    pr = repo.create_pull(title=message, body=message, base="master", head=branch_name)
+    logging.info(f"Created PR: {pr.number}")
+    logging.info("Finished")

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: ⬆
+  # Python
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: ⬆

.github/workflows/build-docs.yml

@@ -0,0 +1,114 @@
+name: Build Docs
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    # Required permissions
+    permissions:
+      pull-requests: read
+    # Set job outputs to values from filter step
+    outputs:
+      docs: ${{ steps.filter.outputs.docs }}
+    steps:
+    - uses: actions/checkout@v3
+    # For pull requests it's not necessary to checkout the code but for master it is
+    - uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        filters: |
+          docs:
+            - README.md
+            - docs/**
+            - docs_src/**
+            - requirements-docs.txt
+  langs:
+    needs:
+      - changes
+    runs-on: ubuntu-latest
+    outputs:
+      langs: ${{ steps.show-langs.outputs.langs }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - uses: actions/cache@v3
+        id: cache
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v06
+      - name: Install docs extras
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: pip install -r requirements-docs.txt
+      # Install MkDocs Material Insiders here just to put it in the cache for the rest of the steps
+      - name: Install Material for MkDocs Insiders
+        if: ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false ) && steps.cache.outputs.cache-hit != 'true'
+        run: pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
+      - name: Export Language Codes
+        id: show-langs
+        run: |
+          echo "langs=$(python ./scripts/docs.py langs-json)" >> $GITHUB_OUTPUT
+
+  build-docs:
+    needs:
+      - changes
+      - langs
+    if: ${{ needs.changes.outputs.docs == 'true' }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        lang: ${{ fromJson(needs.langs.outputs.langs) }}
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - uses: actions/cache@v3
+        id: cache
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v06
+      - name: Install docs extras
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: pip install -r requirements-docs.txt
+      - name: Install Material for MkDocs Insiders
+        if: ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false ) && steps.cache.outputs.cache-hit != 'true'
+        run: pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
+      - name: Update Languages
+        run: python ./scripts/docs.py update-languages
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-cards-${{ matrix.lang }}-${{ github.ref }}
+          path: docs/${{ matrix.lang }}/.cache
+      - name: Build Docs
+        run: python ./scripts/docs.py build-lang ${{ matrix.lang }}
+      - uses: actions/upload-artifact@v3
+        with:
+          name: docs-site
+          path: ./site/**
+
+  # https://github.com/marketplace/actions/alls-green#why
+  docs-all-green:  # This job does nothing and is only used for the branch protection
+    if: always()
+    needs:
+      - build-docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}
+          allowed-skips: build-docs

.github/workflows/deploy-docs.yml

@@ -0,0 +1,48 @@
+name: Deploy Docs
+on:
+  workflow_run:
+    workflows:
+      - Build Docs
+    types:
+      - completed
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+      - name: Clean site
+        run: |
+          rm -rf ./site
+          mkdir ./site
+      - name: Download Artifact Docs
+        id: download
+        uses: dawidd6/action-download-artifact@v2.27.0
+        with:
+          if_no_artifact_found: ignore
+          github_token: ${{ secrets.FASTAPI_PREVIEW_DOCS_DOWNLOAD_ARTIFACTS }}
+          workflow: build-docs.yml
+          run_id: ${{ github.event.workflow_run.id }}
+          name: docs-site
+          path: ./site/
+      - name: Deploy to Cloudflare Pages
+        if: steps.download.outputs.found_artifact == 'true'
+        id: deploy
+        uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: fastapitiangolo
+          directory: './site'
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ ( github.event.workflow_run.head_repository.full_name == github.repository && github.event.workflow_run.head_branch == 'master' && 'main' ) || ( github.event.workflow_run.head_sha ) }}
+      - name: Comment Deploy
+        if: steps.deploy.outputs.url != ''
+        uses: ./.github/actions/comment-docs-preview-in-pr
+        with:
+          token: ${{ secrets.FASTAPI_PREVIEW_DOCS_COMMENT_DEPLOY }}
+          deploy_url: "${{ steps.deploy.outputs.url }}"

.github/workflows/issue-manager.yml

@@ -0,0 +1,35 @@
+name: Issue Manager
+
+on:
+  schedule:
+    - cron: "10 3 * * *"
+  issue_comment:
+    types:
+      - created
+  issues:
+    types:
+      - labeled
+  pull_request_target:
+    types:
+      - labeled
+  workflow_dispatch:
+
+jobs:
+  issue-manager:
+    if: github.repository_owner == 'tiangolo'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: tiangolo/issue-manager@0.4.0
+        with:
+          token: ${{ secrets.FASTAPI_ISSUE_MANAGER }}
+          config: >
+            {
+              "answered": {
+                "delay": 864000,
+                "message": "Assuming the original need was handled, this will be automatically closed now. But feel free to add more comments or create new issues or PRs."
+              }
+            }

.github/workflows/label-approved.yml

@@ -0,0 +1,18 @@
+name: Label Approved
+
+on:
+  schedule:
+    - cron: "0 12 * * *"
+
+jobs:
+  label-approved:
+    if: github.repository_owner == 'tiangolo'
+    runs-on: ubuntu-latest
+    steps:
+    - name: Dump GitHub context
+      env:
+        GITHUB_CONTEXT: ${{ toJson(github) }}
+      run: echo "$GITHUB_CONTEXT"
+    - uses: docker://tiangolo/label-approved:0.0.2
+      with:
+        token: ${{ secrets.FASTAPI_LABEL_APPROVED }}

.github/workflows/latest-changes.yml

@@ -0,0 +1,42 @@
+name: Latest Changes
+
+on:
+  pull_request_target:
+    branches:
+      - master
+    types:
+      - closed
+  workflow_dispatch:
+    inputs:
+      number:
+        description: PR number
+        required: true
+      debug_enabled:
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: 'false'
+
+jobs:
+  latest-changes:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+        with:
+          # To allow latest-changes to commit to the main branch
+          token: ${{ secrets.FASTAPI_LATEST_CHANGES }}
+      # Allow debugging with tmate
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
+        with:
+          limit-access-to-actor: true
+      - uses: docker://tiangolo/latest-changes:0.0.3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          latest_changes_file: docs/en/docs/release-notes.md
+          latest_changes_header: '## Latest Changes\n\n'
+          debug_logs: true

.github/workflows/main.yml

@@ -1,19 +0,0 @@
-on:
-  schedule:
-  - cron: "0 0 * * *"
-
-jobs:
-  issue-manager:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: tiangolo/issue-manager@master
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        config: >
-            {
-              "answered": {
-                "users": ["tiangolo", "dmontagu"],
-                "delay": 864000,
-                "message": "Assuming the original issue was solved, it will be automatically closed now. But feel free to add more comments or create new issues."
-              }
-            }

.github/workflows/notify-translations.yml

@@ -0,0 +1,35 @@
+name: Notify Translations
+
+on:
+  pull_request_target:
+    types:
+      - labeled
+      - closed
+  workflow_dispatch:
+    inputs:
+      number:
+        description: PR number
+        required: true
+      debug_enabled:
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: 'false'
+
+jobs:
+  notify-translations:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+      # Allow debugging with tmate
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
+        with:
+          limit-access-to-actor: true
+      - uses: ./.github/actions/notify-translations
+        with:
+          token: ${{ secrets.FASTAPI_NOTIFY_TRANSLATIONS }}

.github/workflows/people.yml

@@ -0,0 +1,34 @@
+name: FastAPI People
+
+on:
+  schedule:
+    - cron: "0 14 1 * *"
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: 'false'
+
+jobs:
+  fastapi-people:
+    if: github.repository_owner == 'tiangolo'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+      # Ref: https://github.com/actions/runner/issues/2033
+      - name: Fix git safe.directory in container
+        run: mkdir -p /home/runner/work/_temp/_github_home && printf "[safe]\n\tdirectory = /github/workspace" > /home/runner/work/_temp/_github_home/.gitconfig
+      # Allow debugging with tmate
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
+        with:
+          limit-access-to-actor: true
+      - uses: ./.github/actions/people
+        with:
+          token: ${{ secrets.FASTAPI_PEOPLE }}

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.7"
+          # Issue ref: https://github.com/actions/setup-python/issues/436
+          # cache: "pip"
+          cache-dependency-path: pyproject.toml
+      - uses: actions/cache@v3
+        id: cache
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-publish
+      - name: Install build dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: pip install build
+      - name: Build distribution
+        run: python -m build
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@v1.8.6
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"

.github/workflows/smokeshow.yml

@@ -0,0 +1,40 @@
+name: Smokeshow
+
+on:
+  workflow_run:
+    workflows: [Test]
+    types: [completed]
+
+permissions:
+  statuses: write
+
+jobs:
+  smokeshow:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - run: pip install smokeshow
+
+      - uses: dawidd6/action-download-artifact@v2.27.0
+        with:
+          github_token: ${{ secrets.FASTAPI_SMOKESHOW_DOWNLOAD_ARTIFACTS }}
+          workflow: test.yml
+          commit: ${{ github.event.workflow_run.head_sha }}
+
+      - run: smokeshow upload coverage-html
+        env:
+          SMOKESHOW_GITHUB_STATUS_DESCRIPTION: Coverage {coverage-percentage}
+          SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 100
+          SMOKESHOW_GITHUB_CONTEXT: coverage
+          SMOKESHOW_GITHUB_TOKEN: ${{ secrets.FASTAPI_SMOKESHOW_UPLOAD }}
+          SMOKESHOW_GITHUB_PR_HEAD_SHA: ${{ github.event.workflow_run.head_sha }}
+          SMOKESHOW_AUTH_KEY: ${{ secrets.SMOKESHOW_AUTH_KEY }}

.github/workflows/test.yml

@@ -0,0 +1,132 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          # Issue ref: https://github.com/actions/setup-python/issues/436
+          # cache: "pip"
+          # cache-dependency-path: pyproject.toml
+      - uses: actions/cache@v3
+        id: cache
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-python-${{ env.pythonLocation }}-pydantic-v2-${{ hashFiles('pyproject.toml', 'requirements-tests.txt') }}-test-v05
+      - name: Install Dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: pip install -r requirements-tests.txt
+      - name: Install Pydantic v2
+        run: pip install "pydantic>=2.0.2,<3.0.0"
+      - name: Lint
+        run: bash scripts/lint.sh
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        pydantic-version: ["pydantic-v1", "pydantic-v2"]
+      fail-fast: false
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          # Issue ref: https://github.com/actions/setup-python/issues/436
+          # cache: "pip"
+          # cache-dependency-path: pyproject.toml
+      - uses: actions/cache@v3
+        id: cache
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ matrix.pydantic-version }}-${{ hashFiles('pyproject.toml', 'requirements-tests.txt') }}-test-v05
+      - name: Install Dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: pip install -r requirements-tests.txt
+      - name: Install Pydantic v1
+        if: matrix.pydantic-version == 'pydantic-v1'
+        run: pip install "pydantic>=1.10.0,<2.0.0"
+      - name: Install Pydantic v2
+        if: matrix.pydantic-version == 'pydantic-v2'
+        run: pip install "pydantic>=2.0.2,<3.0.0"
+      - run: mkdir coverage
+      - name: Test
+        run: bash scripts/test.sh
+        env:
+          COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}
+          CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
+      - name: Store coverage files
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage
+          path: coverage
+
+  coverage-combine:
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+          # Issue ref: https://github.com/actions/setup-python/issues/436
+          # cache: "pip"
+          # cache-dependency-path: pyproject.toml
+      - name: Get coverage files
+        uses: actions/download-artifact@v3
+        with:
+          name: coverage
+          path: coverage
+      - run: pip install coverage[toml]
+      - run: ls -la coverage
+      - run: coverage combine coverage
+      - run: coverage report
+      - run: coverage html --show-contexts --title "Coverage for ${{ github.sha }}"
+      - name: Store coverage HTML
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-html
+          path: htmlcov
+
+  # https://github.com/marketplace/actions/alls-green#why
+  check:  # This job does nothing and is only used for the branch protection
+    if: always()
+    needs:
+      - coverage-combine
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.gitignore

@@ -14,3 +14,17 @@ test.db
 log.txt
 Pipfile.lock
 env3.*
+env
+docs_build
+site_build
+venv
+docs.zip
+archive.zip
+
+# vim temporary files
+*~
+.*.sw?
+.cache
+
+# macOS
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_language_version:
+    python: python3.10
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-toml
+    -   id: check-yaml
+        args:
+        -   --unsafe
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.7.0
+    hooks:
+    -   id: pyupgrade
+        args:
+        - --py3-plus
+        - --keep-runtime-typing
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.275
+    hooks:
+    -   id: ruff
+        args:
+        - --fix
+-   repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+    -   id: black
+ci:
+    autofix_commit_msg: 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
+    autoupdate_commit_msg: ⬆ [pre-commit.ci] pre-commit autoupdate

.travis.yml

@@ -1,32 +0,0 @@
-dist: xenial
-
-language: python
-
-cache: pip
-
-python:
-    - "3.6"
-    - "3.7"
-    - "3.8"
-    - "nightly"
-
-matrix:
-    allow_failures:
-        - python: "nightly"
-
-install:
-    - pip install flit
-    - flit install --symlink
-
-script:
-    - bash scripts/test.sh
-
-after_script:
-    - bash <(curl -s https://codecov.io/bash)
-
-deploy:
-    provider: script
-    script: bash scripts/deploy.sh
-    on:
-        tags: true
-        python: "3.6"

README.md

@@ -5,17 +5,17 @@
     <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
 </p>
 <p align="center">
-<a href="https://travis-ci.com/tiangolo/fastapi" target="_blank">
-    <img src="https://travis-ci.com/tiangolo/fastapi.svg?branch=master" alt="Build Status">
+<a href="https://github.com/tiangolo/fastapi/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster" target="_blank">
+    <img src="https://github.com/tiangolo/fastapi/workflows/Test/badge.svg?event=push&branch=master" alt="Test">
 </a>
-<a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank">
-    <img src="https://codecov.io/gh/tiangolo/fastapi/branch/master/graph/badge.svg" alt="Coverage">
+<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/tiangolo/fastapi" target="_blank">
+    <img src="https://coverage-badge.samuelcolvin.workers.dev/tiangolo/fastapi.svg" alt="Coverage">
 </a>
 <a href="https://pypi.org/project/fastapi" target="_blank">
-    <img src="https://badge.fury.io/py/fastapi.svg" alt="Package version">
+    <img src="https://img.shields.io/pypi/v/fastapi?color=%2334D058&label=pypi%20package" alt="Package version">
 </a>
-<a href="https://gitter.im/tiangolo/fastapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge" target="_blank">
-    <img src="https://badges.gitter.im/tiangolo/fastapi.svg" alt="Join the chat at https://gitter.im/tiangolo/fastapi">
+<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>
 
@@ -27,59 +27,99 @@
 
 ---
 
-FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
+FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.7+ based on standard Python type hints.
 
 The key features are:
 
 * **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance).
-
-* **Fast to code**: Increase the speed to develop features by about 200% to 300% *.
+* **Fast to code**: Increase the speed to develop features by about 200% to 300%. *
 * **Fewer bugs**: Reduce about 40% of human (developer) induced errors. *
 * **Intuitive**: Great editor support. <abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> everywhere. Less time debugging.
 * **Easy**: Designed to be easy to use and learn. Less time reading docs.
 * **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.
 * **Robust**: Get production-ready code. With automatic interactive documentation.
-* **Standards-based**: Based on (and fully compatible with) the open standards for APIs: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (previously known as Swagger) and <a href="http://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>.
+* **Standards-based**: Based on (and fully compatible with) the open standards for APIs: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (previously known as Swagger) and <a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>.
 
 <small>* estimation based on tests on an internal development team, building production applications.</small>
 
+## Sponsors
+
+<!-- sponsors -->
+
+<a href="https://cryptapi.io/" target="_blank" title="CryptAPI: Your easy to use, secure and privacy oriented payment gateway."><img src="https://fastapi.tiangolo.com/img/sponsors/cryptapi.svg"></a>
+<a href="https://platform.sh/try-it-now/?utm_source=fastapi-signup&utm_medium=banner&utm_campaign=FastAPI-signup-June-2023" target="_blank" title="Build, run and scale your apps on a modern, reliable, and secure PaaS."><img src="https://fastapi.tiangolo.com/img/sponsors/platform-sh.png"></a>
+<a href="https://www.buildwithfern.com/?utm_source=tiangolo&utm_medium=website&utm_campaign=main-badge" target="_blank" title="Fern | SDKs and API docs"><img src="https://fastapi.tiangolo.com/img/sponsors/fern.svg"></a>
+<a href="https://www.porter.run" target="_blank" title="Deploy FastAPI on AWS with a few clicks"><img src="https://fastapi.tiangolo.com/img/sponsors/porter.png"></a>
+<a href="https://www.deta.sh/?ref=fastapi" target="_blank" title="The launchpad for all your (team's) ideas"><img src="https://fastapi.tiangolo.com/img/sponsors/deta.svg"></a>
+<a href="https://training.talkpython.fm/fastapi-courses" target="_blank" title="FastAPI video courses on demand from people you trust"><img src="https://fastapi.tiangolo.com/img/sponsors/talkpython.png"></a>
+<a href="https://testdriven.io/courses/tdd-fastapi/" target="_blank" title="Learn to build high-quality web apps with best practices"><img src="https://fastapi.tiangolo.com/img/sponsors/testdriven.svg"></a>
+<a href="https://github.com/deepset-ai/haystack/" target="_blank" title="Build powerful search from composable, open source building blocks"><img src="https://fastapi.tiangolo.com/img/sponsors/haystack-fastapi.svg"></a>
+<a href="https://careers.powens.com/" target="_blank" title="Powens is hiring!"><img src="https://fastapi.tiangolo.com/img/sponsors/powens.png"></a>
+<a href="https://www.svix.com/" target="_blank" title="Svix - Webhooks as a service"><img src="https://fastapi.tiangolo.com/img/sponsors/svix.svg"></a>
+<a href="https://databento.com/" target="_blank" title="Pay as you go for market data"><img src="https://fastapi.tiangolo.com/img/sponsors/databento.svg"></a>
+<a href="https://speakeasyapi.dev?utm_source=fastapi+repo&utm_medium=github+sponsorship" target="_blank" title="SDKs for your API | Speakeasy"><img src="https://fastapi.tiangolo.com/img/sponsors/speakeasy.png"></a>
+
+<!-- /sponsors -->
+
+<a href="https://fastapi.tiangolo.com/fastapi-people/#sponsors" class="external-link" target="_blank">Other sponsors</a>
+
 ## Opinions
 
-"*[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products.*"
+"_[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products._"
 
 <div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/tiangolo/fastapi/pull/26" target="_blank"><small>(ref)</small></a></div>
 
 ---
 
-"*I’m over the moon excited about **FastAPI**. It’s so fun!*"
-
-<div style="text-align: right; margin-right: 10%;">Brian Okken - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">Python Bytes</a> podcast host</strong> <a href="https://twitter.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div>
-
----
-
-"*Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that.*"
-
-<div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="http://www.hug.rest/" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div>
-
----
-
-"*If you're looking to learn one **modern framework** for building REST APIs, check out **FastAPI** [...] It's fast, easy to use and easy to learn [...]*"
-
-"*We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]*"
-
-<div style="text-align: right; margin-right: 10%;">Ines Montani - Matthew Honnibal - <strong><a href="https://explosion.ai" target="_blank">Explosion AI</a> founders - <a href="https://spacy.io" target="_blank">spaCy</a> creators</strong> <a href="https://twitter.com/_inesmontani/status/1144173225322143744" target="_blank"><small>(ref)</small></a> - <a href="https://twitter.com/honnibal/status/1144031421859655680" target="_blank"><small>(ref)</small></a></div>
-
----
-
-"*We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]*"
+"_We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]_"
 
 <div style="text-align: right; margin-right: 10%;">Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - <strong>Uber</strong> <a href="https://eng.uber.com/ludwig-v0-2/" target="_blank"><small>(ref)</small></a></div>
 
 ---
 
+"_**Netflix** is pleased to announce the open-source release of our **crisis management** orchestration framework: **Dispatch**! [built with **FastAPI**]_"
+
+<div style="text-align: right; margin-right: 10%;">Kevin Glisson, Marc Vilanova, Forest Monsen - <strong>Netflix</strong> <a href="https://netflixtechblog.com/introducing-dispatch-da4b8a2a8072" target="_blank"><small>(ref)</small></a></div>
+
+---
+
+"_I’m over the moon excited about **FastAPI**. It’s so fun!_"
+
+<div style="text-align: right; margin-right: 10%;">Brian Okken - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">Python Bytes</a> podcast host</strong> <a href="https://twitter.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div>
+
+---
+
+"_Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that._"
+
+<div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="https://www.hug.rest/" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div>
+
+---
+
+"_If you're looking to learn one **modern framework** for building REST APIs, check out **FastAPI** [...] It's fast, easy to use and easy to learn [...]_"
+
+"_We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]_"
+
+<div style="text-align: right; margin-right: 10%;">Ines Montani - Matthew Honnibal - <strong><a href="https://explosion.ai" target="_blank">Explosion AI</a> founders - <a href="https://spacy.io" target="_blank">spaCy</a> creators</strong> <a href="https://twitter.com/_inesmontani/status/1144173225322143744" target="_blank"><small>(ref)</small></a> - <a href="https://twitter.com/honnibal/status/1144031421859655680" target="_blank"><small>(ref)</small></a></div>
+
+---
+
+"_If anyone is looking to build a production Python API, I would highly recommend **FastAPI**. It is **beautifully designed**, **simple to use** and **highly scalable**, it has become a **key component** in our API first development strategy and is driving many automations and services such as our Virtual TAC Engineer._"
+
+<div style="text-align: right; margin-right: 10%;">Deon Pillsbury - <strong>Cisco</strong> <a href="https://www.linkedin.com/posts/deonpillsbury_cisco-cx-python-activity-6963242628536487936-trAp/" target="_blank"><small>(ref)</small></a></div>
+
+---
+
+## **Typer**, the FastAPI of CLIs
+
+<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>
+
+If you are building a <abbr title="Command Line Interface">CLI</abbr> app to be used in the terminal instead of a web API, check out <a href="https://typer.tiangolo.com/" class="external-link" target="_blank">**Typer**</a>.
+
+**Typer** is FastAPI's little sibling. And it's intended to be the **FastAPI of CLIs**. ⌨️ 🚀
+
 ## Requirements
 
-Python 3.6+
+Python 3.7+
 
 FastAPI stands on the shoulders of giants:
 
@@ -88,16 +128,28 @@ FastAPI stands on the shoulders of giants:
 
 ## Installation
 
-```bash
-pip install fastapi
+<div class="termy">
+
+```console
+$ pip install fastapi
+
+---> 100%
 ```
 
-You will also need an ASGI server, for production such as <a href="http://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a> or <a href="https://gitlab.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>.
+</div>
 
-```bash
-pip install uvicorn
+You will also need an ASGI server, for production such as <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a> or <a href="https://github.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>.
+
+<div class="termy">
+
+```console
+$ pip install "uvicorn[standard]"
+
+---> 100%
 ```
 
+</div>
+
 ## Example
 
 ### Create it
@@ -105,6 +157,8 @@ pip install uvicorn
 * Create a file `main.py` with:
 
 ```Python
+from typing import Union
+
 from fastapi import FastAPI
 
 app = FastAPI()
@@ -116,7 +170,7 @@ def read_root():
 
 
 @app.get("/items/{item_id}")
-def read_item(item_id: int, q: str = None):
+def read_item(item_id: int, q: Union[str, None] = None):
     return {"item_id": item_id, "q": q}
 ```
 
@@ -125,7 +179,9 @@ def read_item(item_id: int, q: str = None):
 
 If your code uses `async` / `await`, use `async def`:
 
-```Python hl_lines="7 12"
+```Python hl_lines="9  14"
+from typing import Union
+
 from fastapi import FastAPI
 
 app = FastAPI()
@@ -137,7 +193,7 @@ async def read_root():
 
 
 @app.get("/items/{item_id}")
-async def read_item(item_id: int, q: str = None):
+async def read_item(item_id: int, q: Union[str, None] = None):
     return {"item_id": item_id, "q": q}
 ```
 
@@ -151,10 +207,20 @@ If you don't know, check the _"In a hurry?"_ section about <a href="https://fast
 
 Run the server with:
 
-```bash
-uvicorn main:app --reload
+<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>About the command <code>uvicorn main:app --reload</code>...</summary>
 
@@ -205,7 +271,9 @@ Now modify the file `main.py` to receive a body from a `PUT` request.
 
 Declare the body using standard Python types, thanks to Pydantic.
 
-```Python hl_lines="2  7 8 9 10  23 24 25"
+```Python hl_lines="4  9-12  25-27"
+from typing import Union
+
 from fastapi import FastAPI
 from pydantic import BaseModel
 
@@ -215,7 +283,7 @@ app = FastAPI()
 class Item(BaseModel):
     name: str
     price: float
-    is_offer: bool = None
+    is_offer: Union[bool, None] = None
 
 
 @app.get("/")
@@ -224,7 +292,7 @@ def read_root():
 
 
 @app.get("/items/{item_id}")
-def read_item(item_id: int, q: str = None):
+def read_item(item_id: int, q: Union[str, None] = None):
     return {"item_id": item_id, "q": q}
 
 
@@ -261,13 +329,13 @@ And now, go to <a href="http://127.0.0.1:8000/redoc" class="external-link" targe
 
 ### Recap
 
-In summary, you declare **once** the types of parameters, body, etc. as function parameters. 
+In summary, you declare **once** the types of parameters, body, etc. as function parameters.
 
 You do that with standard modern Python types.
 
 You don't have to learn a new syntax, the methods or classes of a specific library, etc.
 
-Just standard **Python 3.6+**.
+Just standard **Python 3.7+**.
 
 For example, for an `int`:
 
@@ -318,7 +386,7 @@ Coming back to the previous code example, **FastAPI** will:
     * As the `q` parameter is declared with `= None`, it is optional.
     * Without the `None` it would be required (as is the body in the case with `PUT`).
 * For `PUT` requests to `/items/{item_id}`, Read the body as JSON:
-    * Check that it has a required attribute `name` that should be a `str`. 
+    * Check that it has a required attribute `name` that should be a `str`.
     * Check that it has a required attribute `price` that has to be a `float`.
     * Check that it has an optional attribute `is_offer`, that should be a `bool`, if present.
     * All this would also work for deeply nested JSON objects.
@@ -363,10 +431,10 @@ For a more complete example including more features, see the <a href="https://fa
 * A very powerful and easy to use **<abbr title="also known as components, resources, providers, services, injectables">Dependency Injection</abbr>** system.
 * Security and authentication, including support for **OAuth2** with **JWT tokens** and **HTTP Basic** auth.
 * More advanced (but equally easy) techniques for declaring **deeply nested JSON models** (thanks to Pydantic).
+* **GraphQL** integration with <a href="https://strawberry.rocks" class="external-link" target="_blank">Strawberry</a> and other libraries.
 * Many extra features (thanks to Starlette) as:
     * **WebSockets**
-    * **GraphQL**
-    * extremely easy tests based on `requests` and `pytest`
+    * extremely easy tests based on HTTPX and `pytest`
     * **CORS**
     * **Cookie Sessions**
     * ...and more.
@@ -381,25 +449,25 @@ To understand more about it, see the section <a href="https://fastapi.tiangolo.c
 
 Used by Pydantic:
 
-* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - for faster JSON <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>.
 * <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email_validator</code></a> - for email validation.
+* <a href="https://docs.pydantic.dev/latest/usage/pydantic_settings/" target="_blank"><code>pydantic-settings</code></a> - for settings management.
+* <a href="https://docs.pydantic.dev/latest/usage/types/extra_types/extra_types/" target="_blank"><code>pydantic-extra-types</code></a> - for extra types to be used with Pydantic.
 
 Used by Starlette:
 
-* <a href="http://docs.python-requests.org" target="_blank"><code>requests</code></a> - Required if you want to use the `TestClient`.
-* <a href="https://github.com/Tinche/aiofiles" target="_blank"><code>aiofiles</code></a> - Required if you want to use `FileResponse` or `StaticFiles`.
-* <a href="http://jinja.pocoo.org" target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration.
+* <a href="https://www.python-httpx.org" target="_blank"><code>httpx</code></a> - Required if you want to use the `TestClient`.
+* <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration.
 * <a href="https://andrew-d.github.io/python-multipart/" target="_blank"><code>python-multipart</code></a> - Required if you want to support form <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>, with `request.form()`.
 * <a href="https://pythonhosted.org/itsdangerous/" target="_blank"><code>itsdangerous</code></a> - Required for `SessionMiddleware` support.
 * <a href="https://pyyaml.org/wiki/PyYAMLDocumentation" target="_blank"><code>pyyaml</code></a> - Required for Starlette's `SchemaGenerator` support (you probably don't need it with FastAPI).
-* <a href="https://graphene-python.org/" target="_blank"><code>graphene</code></a> - Required for `GraphQLApp` support.
 * <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
 
 Used by FastAPI / Starlette:
 
-* <a href="http://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
+* <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
+* <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`.
 
-You can install all of these with `pip install fastapi[all]`.
+You can install all of these with `pip install "fastapi[all]"`.
 
 ## License
 

SECURITY.md

@@ -0,0 +1,31 @@
+# Security Policy
+
+Security is very important for FastAPI and its community. 🔒
+
+Learn more about it below. 👇
+
+## Versions
+
+The latest version of FastAPI is supported.
+
+You are encouraged to [write tests](https://fastapi.tiangolo.com/tutorial/testing/) for your application and update your FastAPI version frequently after ensuring that your tests are passing. This way you will benefit from the latest features, bug fixes, and **security fixes**.
+
+You can learn more about [FastAPI versions and how to pin and upgrade them](https://fastapi.tiangolo.com/deployment/versions/) for your project in the docs.
+
+## Reporting a Vulnerability
+
+If you think you found a vulnerability, and even if you are not sure about it, please report it right away by sending an email to: security@tiangolo.com. Please try to be as explicit as possible, describing all the steps and example code to reproduce the security issue.
+
+I (the author, [@tiangolo](https://twitter.com/tiangolo)) will review it thoroughly and get back to you.
+
+## Public Discussions
+
+Please restrain from publicly discussing a potential security vulnerability. 🙊
+
+It's better to discuss privately and try to find a solution first, to limit the potential impact as much as possible.
+
+---
+
+Thanks for your help!
+
+The FastAPI community and I thank you for that. 🙇

docs/advanced/additional-responses.md

@@ -1,238 +0,0 @@
-!!! warning
-    This is a rather advanced topic.
-
-    If you are starting with **FastAPI**, you might not need this.
-
-You can declare additional responses, with additional status codes, media types, descriptions, etc.
-
-Those additional responses will be included in the OpenAPI schema, so they will also appear in the API docs.
-
-But for those additional responses you have to make sure you return a `Response` like `JSONResponse` directly, with your status code and content.
-
-## Additional Response with `model`
-
-You can pass to your *path operation decorators* a parameter `responses`.
-
-It receives a `dict`, the keys are status codes for each response, like `200`, and the values are other `dict`s with the information for each of them.
-
-Each of those response `dict`s can have a key `model`, containing a Pydantic model, just like `response_model`.
-
-**FastAPI** will take that model, generate its JSON Schema and include it in the correct place in OpenAPI.
-
-For example, to declare another response with a status code `404` and a Pydantic model `Message`, you can write:
-
-```Python hl_lines="18 23"
-{!./src/additional_responses/tutorial001.py!}
-```
-
-!!! note
-    Have in mind that you have to return the `JSONResponse` directly.
-
-!!! info
-    The `model` key is not part of OpenAPI.
-
-    **FastAPI** will take the Pydantic model from there, generate the `JSON Schema`, and put it in the correct place.
-
-    The correct place is:
-    
-    * In the key `content`, that has as value another JSON object (`dict`) that contains:
-        * A key with the media type, e.g. `application/json`, that contains as value another JSON object, that contains:
-            * A key `schema`, that has as the value the JSON Schema from the model, here's the correct place.
-                * **FastAPI** adds a reference here to the global JSON Schemas in another place in your OpenAPI instead of including it directly. This way, other applications and clients can use those JSON Schemas directly, provide better code generation tools, etc.
-
-The generated responses in the OpenAPI for this *path operation* will be:
-
-```JSON hl_lines="3 4 5 6 7 8 9 10 11 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"
-                    }
-                }
-            }
-        }
-    }
-}
-```
-
-The schemas are referenced to another place inside the OpenAPI schema:
-
-```JSON hl_lines="4 5 6 7 8 9 10 11 12 13 14 15 16"
-{
-    "components": {
-        "schemas": {
-            "Message": {
-                "title": "Message",
-                "required": [
-                    "message"
-                ],
-                "type": "object",
-                "properties": {
-                    "message": {
-                        "title": "Message",
-                        "type": "string"
-                    }
-                }
-            },
-            "Item": {
-                "title": "Item",
-                "required": [
-                    "id",
-                    "value"
-                ],
-                "type": "object",
-                "properties": {
-                    "id": {
-                        "title": "Id",
-                        "type": "string"
-                    },
-                    "value": {
-                        "title": "Value",
-                        "type": "string"
-                    }
-                }
-            },
-            "ValidationError": {
-                "title": "ValidationError",
-                "required": [
-                    "loc",
-                    "msg",
-                    "type"
-                ],
-                "type": "object",
-                "properties": {
-                    "loc": {
-                        "title": "Location",
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        }
-                    },
-                    "msg": {
-                        "title": "Message",
-                        "type": "string"
-                    },
-                    "type": {
-                        "title": "Error Type",
-                        "type": "string"
-                    }
-                }
-            },
-            "HTTPValidationError": {
-                "title": "HTTPValidationError",
-                "type": "object",
-                "properties": {
-                    "detail": {
-                        "title": "Detail",
-                        "type": "array",
-                        "items": {
-                            "$ref": "#/components/schemas/ValidationError"
-                        }
-                    }
-                }
-            }
-        }
-    }
-}
-```
-
-## Additional media types for the main response
-
-You can use this same `responses` parameter to add different media types for the same main response.
-
-For example, you can add an additional media type of `image/png`, declaring that your *path operation* can return a JSON object (with media type `application/json`) or a PNG image:
-
-```Python hl_lines="17 18 19 20 21 22 23 24 28"
-{!./src/additional_responses/tutorial002.py!}
-```
-
-!!! note
-    Notice that you have to return the image using a `FileResponse` directly.
-
-!!! info
-    Unless you specify a different media type explicitly in your `responses` parameter, FastAPI will assume the response has the same media type as the main response class (default `application/json`).
-
-    But if you have specified a custom response class with `None` as its media type, FastAPI will use `application/json` for any additional response that has an associated model.
-
-## Combining information
-
-You can also combine response information from multiple places, including the `response_model`, `status_code`, and `responses` parameters.
-
-You can declare a `response_model`, using the default status code `200` (or a custom one if you need), and then declare additional information for that same response in `responses`, directly in the OpenAPI schema.
-
-**FastAPI** will keep the additional information from `responses`, and combine it with the JSON Schema from your model.
-
-For example, you can declare a response with a status code `404` that uses a Pydantic model and has a custom `description`.
-
-And a response with a status code `200` that uses your `response_model`, but includes a custom `example`:
-
-```Python hl_lines="20 21 22 23 24 25 26 27 28 29 30 31"
-{!./src/additional_responses/tutorial003.py!}
-```
-
-It will all be combined and included in your OpenAPI, and shown in the API docs:
-
-<img src="/img/tutorial/additional-responses/image01.png">
-
-## Combine predefined responses and custom ones
-
-You might want to have some predefined responses that apply to many *path operations*, but you want to combine them with custom responses needed by each *path operation*.
-
-For those cases, you can use the Python technique of "unpacking" a `dict` with `**dict_to_unpack`:
-
-```Python
-old_dict = {
-    "old key": "old value",
-    "second old key": "second old value",
-}
-new_dict = {**old_dict, "new key": "new value"}
-```
-
-Here, `new_dict` will contain all the key-value pairs from `old_dict` plus the new key-value pair:
-
-```Python
-{
-    "old key": "old value",
-    "second old key": "second old value",
-    "new key": "new value",
-}
-```
-
-You can use that technique to re-use some predefined responses in your *path operations* and combine them with additional custom ones.
-
-For example:
-
-```Python hl_lines="11 12 13 14 15 24"
-{!./src/additional_responses/tutorial004.py!}
-```
-
-## More information about OpenAPI responses
-
-To see what exactly you can include in the responses, you can check these sections in the OpenAPI specification:
-
-* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responsesObject" class="external-link" target="_blank">OpenAPI Responses Object</a>, it includes the `Response Object`.
-* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject" class="external-link" target="_blank">OpenAPI Response Object</a>, you can include anything from this directly in each response inside your `responses` parameter. Including `description`, `headers`, `content` (inside of this is that you declare different media types and JSON Schemas), and `links`.

docs/advanced/additional-status-codes.md

@@ -1,30 +0,0 @@
-By default, **FastAPI** will return the responses using Starlette's `JSONResponse`, putting the content you return from your *path operation* inside of that `JSONResponse`.
-
-It will use the default status code or the one you set in your *path operation*.
-
-## Additional status codes
-
-If you want to return additional status codes apart from the main one, you can do that by returning a `Response` directly, like a `JSONResponse`, and set the additional status code directly.
-
-For example, let's say that you want to have a *path operation* that allows to update items, and returns HTTP status codes of 200 "OK" when successful.
-
-But you also want it to accept new items. And when the items didn't exist before, it creates them, and returns an HTTP status code of 201 "Created".
-
-To achieve that, import `JSONResponse`, and return your content there directly, setting the `status_code` that you want:
-
-```Python hl_lines="2 20"
-{!./src/additional_status_codes/tutorial001.py!}
-```
-
-!!! warning
-    When you return a `Response` directly, like in the example above, it will be returned directly.
-
-    It won't be serialized with a model, etc.
-    
-    Make sure it has the data you want it to have, and that the values are valid JSON (if you are using `JSONResponse`).
-
-## OpenAPI and API docs
-
-If you return additional status codes and responses directly, they won't be included in the OpenAPI schema (the API docs), because FastAPI doesn't have a way to know before hand what you are going to return.
-
-But you can document that in your code, using: [Additional Responses](additional-responses.md){.internal-link target=_blank}.

docs/advanced/advanced-dependencies.md

@@ -1,73 +0,0 @@
-!!! warning
-    This is, more or less, an "advanced" chapter.
-    
-    If you are just starting with **FastAPI** you might want to skip this chapter and come back to it later.
-
-## Parameterized dependencies
-
-All the dependencies we have seen are a fixed function or class.
-
-But there could be cases where you want to be able to set parameters on the dependency, without having to declare many different functions or classes.
-
-Let's imagine that we want to have a dependency that checks if the query parameter `q` contains some fixed content.
-
-But we want to be able to parameterize that fixed content.
-
-## A "callable" instance
-
-In Python there's a way to make an instance of a class a "callable".
-
-Not the class itself (which is already a callable), but an instance of that class.
-
-To do that, we declare a method `__call__`:
-
-```Python hl_lines="10"
-{!./src/dependencies/tutorial011.py!}
-```
-
-In this case, this `__call__` is what **FastAPI** will use to check for additional parameters and sub-dependencies, and this is what will be called to pass a value to the parameter in your *path operation function* later.
-
-## Parameterize the instance
-
-And now, we can use `__init__` to declare the parameters of the instance that we can use to "parameterize" the dependency:
-
-```Python hl_lines="7"
-{!./src/dependencies/tutorial011.py!}
-```
-
-In this case, **FastAPI** won't ever touch or care about `__init__`, we will use it directly in our code.
-
-## Create an instance
-
-We could create an instance of this class with:
-
-```Python hl_lines="16"
-{!./src/dependencies/tutorial011.py!}
-```
-
-And that way we are able to "parameterize" our dependency, that now has `"bar"` inside of it, as the attribute `checker.fixed_content`.
-
-## Use the instance as a dependency
-
-Then, we could use this `checker` in a `Depends(checker)`, instead of `Depends(FixedContentQueryChecker)`, because the dependency is the instance, `checker`, not the class itself.
-
-And when solving the dependency, **FastAPI** will call this `checker` like:
-
-```Python
-checker(q="somequery")
-```
-
-...and pass whatever that returns as the value of the dependency in our *path operation function* as the parameter `fixed_content_included`:
-
-```Python hl_lines="20"
-{!./src/dependencies/tutorial011.py!}
-```
-
-!!! tip
-    All this might seem contrived. And it might not be very clear how is it useful yet.
-
-    These examples are intentionally simple, but show how it all works.
-
-    In the chapters about security, there are utility functions that are implemented in this same way.
-
-    If you understood all this, you already know how those utility tools for security work underneath.

docs/advanced/async-sql-databases.md

@@ -1,160 +0,0 @@
-You can also use <a href="https://github.com/encode/databases" class="external-link" target="_blank">`encode/databases`</a> with **FastAPI** to connect to databases using `async` and `await`.
-
-It is compatible with:
-
-* PostgreSQL
-* MySQL
-* SQLite
-
-In this example, we'll use **SQLite**, because it uses a single file and Python has integrated support. So, you can copy this example and run it as is.
-
-Later, for your production application, you might want to use a database server like **PostgreSQL**.
-
-!!! tip
-    You could adopt ideas from the section about SQLAlchemy ORM ([SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank}), like using utility functions to perform operations in the database, independent of your **FastAPI** code.
-
-    This section doesn't apply those ideas, to be equivalent to the counterpart in <a href="https://www.starlette.io/database/" class="external-link" target="_blank">Starlette</a>.
-
-## Import and set up `SQLAlchemy`
-
-* Import `SQLAlchemy`.
-* Create a `metadata` object.
-* Create a table `notes` using the `metadata` object.
-
-```Python hl_lines="4 14 16 17 18 19 20 21 22"
-{!./src/async_sql_databases/tutorial001.py!}
-```
-
-!!! tip
-    Notice that all this code is pure SQLAlchemy Core.
-
-    `databases` is not doing anything here yet.
-
-## Import and set up `databases`
-
-* Import `databases`.
-* Create a `DATABASE_URL`.
-* Create a `database` object.
-
-```Python hl_lines="3 9 12"
-{!./src/async_sql_databases/tutorial001.py!}
-```
-
-!!! tip
-    If you were connecting to a different database (e.g. PostgreSQL), you would need to change the `DATABASE_URL`.
-
-## Create the tables
-
-In this case, we are creating the tables in the same Python file, but in production, you would probably want to create them with Alembic, integrated with migrations, etc.
-
-Here, this section would run directly, right before starting your **FastAPI** application.
-
-* Create an `engine`.
-* Create all the tables from the `metadata` object.
-
-```Python hl_lines="25 26 27 28"
-{!./src/async_sql_databases/tutorial001.py!}
-```
-
-## Create models
-
-Create Pydantic models for:
-
-* Notes to be created (`NoteIn`).
-* Notes to be returned (`Note`).
-
-```Python hl_lines="31 32 33 36 37 38 39"
-{!./src/async_sql_databases/tutorial001.py!}
-```
-
-By creating these Pydantic models, the input data will be validated, serialized (converted), and annotated (documented).
-
-So, you will be able to see it all in the interactive API docs.
-
-## Connect and disconnect
-
-* Create your `FastAPI` application.
-* Create event handlers to connect and disconnect from the database.
-
-```Python hl_lines="42 45 46 47 50 51 52"
-{!./src/async_sql_databases/tutorial001.py!}
-```
-
-## Read notes
-
-Create the *path operation function* to read notes:
-
-```Python hl_lines="55 56 57 58"
-{!./src/async_sql_databases/tutorial001.py!}
-```
-
-!!! Note
-    Notice that as we communicate with the database using `await`, the *path operation function* is declared with `async`.
-
-### Notice the `response_model=List[Note]`
-
-It uses `typing.List`.
-
-That documents (and validates, serializes, filters) the output data, as a `list` of `Note`s.
-
-## Create notes
-
-Create the *path operation function* to create notes:
-
-```Python hl_lines="61 62 63 64 65"
-{!./src/async_sql_databases/tutorial001.py!}
-```
-
-!!! Note
-    Notice that as we communicate with the database using `await`, the *path operation function* is declared with `async`.
-
-### About `{**note.dict(), "id": last_record_id}`
-
-`note` is a Pydantic `Note` object.
-
-`note.dict()` returns a `dict` with its data, something like:
-
-```Python
-{
-    "text": "Some note",
-    "completed": False,
-}
-```
-
-but it doesn't have the `id` field.
-
-So we create a new `dict`, that contains the key-value pairs from `note.dict()` with:
-
-```Python
-{**note.dict()}
-```
-
-`**note.dict()` "unpacks" the key value pairs directly, so, `{**note.dict()}` would be, more or less, a copy of `note.dict()`.
-
-And then, we extend that copy `dict`, adding another key-value pair: `"id": last_record_id`:
-
-```Python
-{**note.dict(), "id": last_record_id}
-```
-
-So, the final result returned would be something like:
-
-```Python
-{
-    "id": 1,
-    "text": "Some note",
-    "completed": False,
-}
-```
-
-## Check it
-
-You can copy this code as is, and see the docs at <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
-
-There you can see all your API documented and interact with it:
-
-<img src="/img/tutorial/async-sql-databases/image01.png">
-
-## More info
-
-You can read more about <a href="https://github.com/encode/databases" class="external-link" target="_blank">`encode/databases` at its GitHub page</a>.

docs/advanced/custom-request-and-route.md

@@ -1,104 +0,0 @@
-In some cases, you may want to override the logic used by the `Request` and `APIRoute` classes.
-
-In particular, this may be a good alternative to logic in a middleware.
-
-For example, if you want to read or manipulate the request body before it is processed by your application.
-
-!!! danger
-    This is an "advanced" feature.
-
-    If you are just starting with **FastAPI** you might want to skip this section.
-
-## Use cases
-
-Some use cases include:
-
-* Converting non-JSON request bodies to JSON (e.g. <a href="https://msgpack.org/index.html" class="external-link" target="_blank">`msgpack`</a>).
-* Decompressing gzip-compressed request bodies.
-* Automatically logging all request bodies.
-
-## Handling custom request body encodings
-
-Let's see how to make use of a custom `Request` subclass to decompress gzip requests.
-
-And an `APIRoute` subclass to use that custom request class.
-
-### Create a custom `GzipRequest` class
-
-First, we create a `GzipRequest` class, which will overwrite the `Request.body()` method to decompress the body in the presence of an appropriate header.
-
-If there's no `gzip` in the header, it will not try to decompress the body.
-
-That way, the same route class can handle gzip compressed or uncompressed requests.
-
-```Python hl_lines="10 11 12 13 14 15 16 17"
-{!./src/custom_request_and_route/tutorial001.py!}
-```
-
-### Create a custom `GzipRoute` class
-
-Next, we create a custom subclass of `fastapi.routing.APIRoute` that will make use of the `GzipRequest`.
-
-This time, it will overwrite the method `APIRoute.get_route_handler()`.
-
-This method returns a function. And that function is what will receive a request and return a response.
-
-Here we use it to create a `GzipRequest` from the original request.
-
-```Python hl_lines="20 21 22 23 24 25 26 27 28"
-{!./src/custom_request_and_route/tutorial001.py!}
-```
-
-!!! note "Technical Details"
-    A `Request` has a `request.scope` attribute, that's just a Python `dict` containing the metadata related to the request.
-
-    A `Request` also has a `request.receive`, that's a function to "receive" the body of the request.
-
-    The `scope` `dict` and `receive` function are both part of the ASGI specification.
-
-    And those two things, `scope` and `receive`, are what is needed to create a new `Request` instance.
-
-    To learn more about the `Request` check <a href="https://www.starlette.io/requests/" class="external-link" target="_blank">Starlette's docs about Requests</a>.
-
-The only thing the function returned by `GzipRequest.get_route_handler` does differently is convert the `Request` to a `GzipRequest`.
-
-Doing this, our `GzipRequest` will take care of decompressing the data (if necessary) before passing it to our *path operations*.
-
-After that, all of the processing logic is the same.
-
-But because of our changes in `GzipRequest.body`, the request body will be automatically decompressed when it is loaded by **FastAPI** when needed.
-
-## Accessing the request body in an exception handler
-
-!!! tip
-    To solve this same problem, it's probably a lot easier to use the `body` in a custom handler for `RequestValidationError` ([Handling Errors](../tutorial/handling-errors.md#use-the-requestvalidationerror-body){.internal-link target=_blank}).
-
-    But this example is still valid and it shows how to interact with the internal components.
-
-We can also use this same approach to access the request body in an exception handler.
-
-All we need to do is handle the request inside a `try`/`except` block:
-
-```Python hl_lines="15 17"
-{!./src/custom_request_and_route/tutorial002.py!}
-```
-
-If an exception occurs, the`Request` instance will still be in scope, so we can read and make use of the request body when handling the error:
-
-```Python hl_lines="18 19 20"
-{!./src/custom_request_and_route/tutorial002.py!}
-```
-
-## Custom `APIRoute` class in a router
-
-You can also set the `route_class` parameter of an `APIRouter`:
-
-```Python hl_lines="28"
-{!./src/custom_request_and_route/tutorial003.py!}
-```
-
-In this example, the *path operations* under the `router` will use the custom `TimedRoute` class, and will have an extra `X-Response-Time` header in the response with the time it took to generate the response:
-
-```Python hl_lines="15 16 17 18 19 20 21 22"
-{!./src/custom_request_and_route/tutorial003.py!}
-```

docs/advanced/custom-response.md

@@ -1,102 +0,0 @@
-!!! warning
-    This is a rather advanced topic.
-
-    If you are starting with **FastAPI**, you might not need this.
-
-By default, **FastAPI** will return the responses using Starlette's `JSONResponse`.
-
-You can override it by returning a `Response` directly as seen in [Return a Response directly](response-directly.md){.internal-link target=_blank}.
-
-But if you return a `Response` directly, the data won't be automatically converted, and the documentation won't be automatically generated (for example, including the specific "media type", in the HTTP header `Content-Type`).
-
-But you can also declare the `Response` that you want to be used, in the *path operation decorator*.
-
-The contents that you return from your *path operation function* will be put inside of that `Response`.
-
-And if that `Response` has a JSON media type (`application/json`), like is the case with the `JSONResponse` and `UJSONResponse`, the data you return will be automatically converted (and filtered) with any Pydantic `response_model` that you declared in the *path operation decorator*.
-
-!!! note
-    If you use a response class with no media type, FastAPI will expect your response to have no content, so it will not document the response format in its generated OpenAPI docs.
-
-## Use `UJSONResponse`
-
-For example, if you are squeezing performance, you can install and use `ujson` and set the response to be Starlette's `UJSONResponse`.
-
-Import the `Response` class (sub-class) you want to use and declare it in the *path operation decorator*.
-
-```Python hl_lines="2 7"
-{!./src/custom_response/tutorial001.py!}
-```
-
-!!! note
-    Notice that you import it directly from `starlette.responses`, not from `fastapi`.
-
-!!! info
-    The parameter `response_class` will also be used to define the "media type" of the response.
-
-    In this case, the HTTP header `Content-Type` will be set to `application/json`.
-
-    And it will be documented as such in OpenAPI.
-
-## HTML Response
-
-To return a response with HTML directly from **FastAPI**, use `HTMLResponse`.
-
-* Import `HTMLResponse`.
-* Pass `HTMLResponse` as the parameter `content_type` of your *path operation*.
-
-```Python hl_lines="2 7"
-{!./src/custom_response/tutorial002.py!}
-```
-
-!!! note
-    Notice that you import it directly from `starlette.responses`, not from `fastapi`.
-
-!!! info
-    The parameter `response_class` will also be used to define the "media type" of the response.
-
-    In this case, the HTTP header `Content-Type` will be set to `text/html`.
-
-    And it will be documented as such in OpenAPI.
-
-### Return a Starlette `Response`
-
-As seen in [Return a Response directly](response-directly.md){.internal-link target=_blank}, you can also override the response directly in your *path operation*, by returning it.
-
-The same example from above, returning an `HTMLResponse`, could look like:
-
-```Python hl_lines="2 7 19"
-{!./src/custom_response/tutorial003.py!}
-```
-
-!!! warning
-    A `Response` returned directly by your *path operation function* won't be documented in OpenAPI (for example, the `Content-Type` won't be documented) and won't be visible in the automatic interactive docs.
-
-!!! info
-    Of course, the actual `Content-Type` header, status code, etc, will come from the `Response` object your returned.
-
-### Document in OpenAPI and override `Response`
-
-If you want to override the response from inside of the function but at the same time document the "media type" in OpenAPI, you can use the `response_class` parameter AND return a `Response` object.
-
-The `response_class` will then be used only to document the OpenAPI *path operation*, but your `Response` will be used as is.
-
-#### Return an `HTMLResponse` directly
-
-For example, it could be something like:
-
-```Python hl_lines="7 23 21"
-{!./src/custom_response/tutorial004.py!}
-```
-
-In this example, the function `generate_html_response()` already generates a Starlette `Response` instead of the HTML in a `str`.
-
-By returning the result of calling `generate_html_response()`, you are already returning a `Response` that will override the default **FastAPI** behavior.
-
-But as you passed the `HTMLResponse` in the `response_class`, **FastAPI** will know how to document it in OpenAPI and the interactive docs as HTML with `text/html`:
-
-<img src="/img/tutorial/custom-response/image01.png">
-
-## Additional documentation
-
-You can also declare the media type and many other details in OpenAPI using `responses`: [Additional Responses in OpenAPI](additional-responses.md){.internal-link target=_blank}.

docs/advanced/events.md

@@ -1,43 +0,0 @@
-
-You can define event handlers (functions) that need to be executed before the application starts up, or when the application is shutting down.
-
-These functions can be declared with `async def` or normal `def`.
-
-## `startup` event
-
-To add a function that should be run before the application starts, declare it with the event `"startup"`:
-
-```Python hl_lines="8"
-{!./src/events/tutorial001.py!}
-```
-
-In this case, the `startup` event handler function will initialize the items "database" (just a `dict`) with some values.
-
-You can add more than one event handler function.
-
-And your application won't start receiving requests until all the `startup` event handlers have completed.
-
-## `shutdown` event
-
-To add a function that should be run when the application is shutting down, declare it with the event `"shutdown"`:
-
-```Python hl_lines="6"
-{!./src/events/tutorial002.py!}
-```
-
-Here, the `shutdown` event handler function will write a text line `"Application shutdown"` to a file `log.txt`.
-
-!!! info
-    In the `open()` function, the `mode="a"` means "append", so, the line will be added after whatever is on that file, without overwriting the previous contents.
-
-!!! tip
-    Notice that in this case we are using a standard Python `open()` function that interacts with a file.
-
-    So, it involves I/O (input/output), that requires "waiting" for things to be written to disk.
-
-    But `open()` doesn't use `async` and `await`.
-
-    So, we declare the event handler function with standard `def` instead of `async def`.
-
-!!! info
-    You can read more about these event handlers in <a href="https://www.starlette.io/events/" class="external-link" target="_blank">Starlette's  Events' docs</a>.

docs/advanced/extending-openapi.md

@@ -1,242 +0,0 @@
-!!! warning
-    This is a rather advanced feature. You probably can skip it.
-
-    If you are just following the tutorial - user guide, you can probably skip this section.
-
-    If you already know that you need to modify the generated OpenAPI schema, continue reading.
-
-There are some cases where you might need to modify the generated OpenAPI schema.
-
-In this section you will see how.
-
-## The normal process
-
-The normal (default) process, is as follows.
-
-A `FastAPI` application (instance) has an `.openapi()` method that is expected to return the OpenAPI schema.
-
-As part of the application object creation, a *path operation* for `/openapi.json` (or for whatever you set your `openapi_url`) is registered.
-
-It just returns a JSON response with the result of the application's `.openapi()` method.
-
-By default, what the method `.openapi()` does is check the property `.openapi_schema` to see if it has contents and return them.
-
-If it doesn't, it generates them using the utility function at `fastapi.openapi.utils.get_openapi`.
-
-And that function `get_openapi()` receives as parameters:
-
-* `title`: The OpenAPI title, shown in the docs.
-* `version`: The version of your API, e.g. `2.5.0`.
-* `openapi_version`: The version of the OpenAPI specification used. By default, the latest: `3.0.2`.
-* `description`: The description of your API.
-* `routes`: A list of routes, these are each of the registered *path operations*. They are taken from `app.routes`.
-* `openapi_prefix`: The URL prefix to be used in your OpenAPI.
-
-## Overriding the defaults
-
-Using the information above, you can use the same utility function to generate the OpenAPI schema and override each part that you need.
-
-For example, let's add <a href="https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo" class="external-link" target="_blank">ReDoc's OpenAPI extension to include a custom logo</a>.
-
-### Normal **FastAPI**
-
-First, write all your **FastAPI** application as normally:
-
-```Python hl_lines="1 4 7 8 9"
-{!./src/extending_openapi/tutorial001.py!}
-```
-
-### Generate the OpenAPI schema
-
-Then, use the same utility function to generate the OpenAPI schema, inside a `custom_openapi()` function:
-
-```Python hl_lines="2 15 16 17 18 19 20"
-{!./src/extending_openapi/tutorial001.py!}
-```
-
-### Modify the OpenAPI schema
-
-Now you can add the ReDoc extension, adding a custom `x-logo` to the `info` "object" in the OpenAPI schema:
-
-```Python hl_lines="21 22 23"
-{!./src/extending_openapi/tutorial001.py!}
-```
-
-### Cache the OpenAPI schema
-
-You can use the property `.openapi_schema` as a "cache", to store your generated schema.
-
-That way, your application won't have to generate the schema every time a user opens your API docs.
-
-It will be generated only once, and then the same cached schema will be used for the next requests.
-
-```Python hl_lines="13 14 24 25"
-{!./src/extending_openapi/tutorial001.py!}
-```
-
-### Override the method
-
-Now you can replace the `.openapi()` method with your new function.
-
-```Python hl_lines="28"
-{!./src/extending_openapi/tutorial001.py!}
-```
-
-### Check it
-
-Once you go to <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a> you will see that you are using your custom logo (in this example, **FastAPI**'s logo):
-
-<img src="/img/tutorial/extending-openapi/image01.png">
-
-## Self-hosting JavaScript and CSS for docs
-
-The API docs use **Swagger UI** and **ReDoc**, and each of those need some JavaScript and CSS files.
-
-By default, those files are served from a <abbr title="Content Delivery Network: A service, normally composed of several servers, that provides static files, like JavaScript and CSS. It's commonly used to serve those files from the server closer to the client, improving performance.">CDN</abbr>.
-
-But it's possible to customize it, you can set a specific CDN, or serve the files yourself.
-
-That's useful, for example, if you need your app to keep working even while offline, without open Internet access, or in a local network.
-
-Here you'll see how to serve those files yourself, in the same FastAPI app, and configure the docs to use them.
-
-### Project file structure
-
-Let's say your project file structure looks like this:
-
-```
-.
-├── app
-│   ├── __init__.py
-│   ├── main.py
-```
-
-Now create a directory to store those static files.
-
-Your new file structure could look like this:
-
-```
-.
-├── app
-│   ├── __init__.py
-│   ├── main.py
-└── static/
-```
-
-### Download the files
-
-Download the static files needed for the docs and put them on that `static/` directory.
-
-You can probably right-click each link and select an option similar to `Save link as...`.
-
-**Swagger UI** uses the files:
-
-* <a href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@3/swagger-ui-bundle.js" class="external-link" target="_blank">`swagger-ui-bundle.js`</a>
-* <a href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@3/swagger-ui.css" class="external-link" target="_blank">`swagger-ui.css`</a>
-
-And **ReDoc** uses the file:
-
-* <a href="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js" class="external-link" target="_blank">`redoc.standalone.js`</a>
-
-After that, your file structure could look like:
-
-```
-.
-├── app
-│   ├── __init__.py
-│   ├── main.py
-└── static
-    ├── redoc.standalone.js
-    ├── swagger-ui-bundle.js
-    └── swagger-ui.css
-```
-
-### Install `aiofiles`
-
-Now you need to install `aiofiles`:
-
-```bash
-pip install aiofiles
-```
-
-### Serve the static files
-
-* Import `StaticFiles` from Starlette.
-* "Mount" a `StaticFiles()` instance in a specific path.
-
-```Python hl_lines="7 11"
-{!./src/extending_openapi/tutorial002.py!}
-```
-
-### Test the static files
-
-Start your application and go to <a href="http://127.0.0.1:8000/static/redoc.standalone.js" class="external-link" target="_blank">http://127.0.0.1:8000/static/redoc.standalone.js</a>.
-
-You should see a very long JavaScript file for **ReDoc**.
-
-It could start with something like:
-
-```JavaScript
-/*!
- * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
- * -------------------------------------------------------------
- *   Version: "2.0.0-rc.18"
- *   Repo: https://github.com/Redocly/redoc
- */
-!function(e,t){"object"==typeof exports&&"object"==typeof m
-
-...
-```
-
-That confirms that you are being able to serve static files from your app, and that you placed the static files for the docs in the correct place.
-
-Now we can configure the app to use those static files for the docs.
-
-### Disable the automatic docs
-
-The first step is to disable the automatic docs, as those use the CDN by default.
-
-To disable them, set their URLs to `None` when creating your `FastAPI` app:
-
-```Python hl_lines="9"
-{!./src/extending_openapi/tutorial002.py!}
-```
-
-### Include the custom docs
-
-Now you can create the *path operations* for the custom docs.
-
-You can re-use FastAPI's internal functions to create the HTML pages for the docs, and pass them the needed arguments:
-
-* `openapi_url`: the URL where the HTML page for the docs can get the OpenAPI schema for your API. You can use here the attribute `app.openapi_url`.
-* `title`: the title of your API.
-* `oauth2_redirect_url`: you can use `app.swagger_ui_oauth2_redirect_url` here to use the default.
-* `swagger_js_url`: the URL where the HTML for your Swagger UI docs can get the **JavaScript** file. This is the one that your own app is now serving.
-* `swagger_css_url`: the URL where the HTML for your Swagger UI docs can get the **CSS** file. This is the one that your own app is now serving.
-
-And similarly for ReDoc...
-
-```Python hl_lines="2 3 4 5 6   14 15 16 17 18 19 20 21 22    25 26 27   30 31 32 33 34 35 36"
-{!./src/extending_openapi/tutorial002.py!}
-```
-
-!!! tip
-    The *path operation* for `swagger_ui_redirect` is a helper for when you use OAuth2.
-
-    If you integrate your API with an OAuth2 provider, you will be able to authenticate and come back to the API docs with the acquired credentials. And interact with it using the real OAuth2 authentication.
-
-    Swagger UI will handle it behind the scenes for you, but it needs this "redirect" helper.
-
-### Create a *path operation* to test it
-
-Now, to be able to test that everything works, create a *path operation*:
-
-```Python hl_lines="39 40 41"
-{!./src/extending_openapi/tutorial002.py!}
-```
-
-### Test it
-
-Now, you should be able to disconnect your WiFi, go to your docs at <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>, and reload the page.
-
-And even without Internet, you would be able to see the docs for your API and interact with it.

docs/advanced/graphql.md

@@ -1,43 +0,0 @@
-
-**FastAPI** has optional support for GraphQL (provided by Starlette directly), using the `graphene` library.
-
-You can combine normal FastAPI *path operations* with GraphQL on the same application.
-
-## Import and use `graphene`
-
-GraphQL is implemented with Graphene, you can check <a href="https://docs.graphene-python.org/en/latest/quickstart/" class="external-link" target="_blank">Graphene's docs</a> for more details.
-
-Import `graphene` and define your GraphQL data:
-
-```Python hl_lines="1 6 7 8 9 10"
-{!./src/graphql/tutorial001.py!}
-```
-
-## Add Starlette's `GraphQLApp`
-
-Then import and add Starlette's `GraphQLApp`:
-
-```Python hl_lines="3 14"
-{!./src/graphql/tutorial001.py!}
-```
-
-!!! info
-    Here we are using `.add_route`, that is the way to add a route in Starlette (inherited by FastAPI) without declaring the specific operation (as would be with `.get()`, `.post()`, etc).
-
-## Check it
-
-Run it with Uvicorn and open your browser at <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000</a>.
-
-You will see GraphiQL web user interface:
-
-<img src="/img/tutorial/graphql/image01.png">
-
-## More details
-
-For more details, including:
-
-* Accessing request information
-* Adding background tasks
-* Using normal or async functions
-
-check the official <a href="https://www.starlette.io/graphql/" class="external-link" target="_blank">Starlette GraphQL docs</a>.

docs/advanced/index.md

@@ -1,16 +0,0 @@
-## Additional Features
-
-The main [Tutorial - User Guide](../tutorial/){.internal-link target=_blank} should be enough to give you a tour through all the main features of **FastAPI**.
-
-In the next sections you will see other options, configurations, and additional features.
-
-!!! tip
-    The next sections are **not necessarily "advanced"**.
-
-    And it's possible that for your use case, the solution is in one of them.
-
-## Read the Tutorial first
-
-You could still use most of the features in **FastAPI** with the knowledge from the main [Tutorial - User Guide](../tutorial/){.internal-link target=_blank}.
-
-And the next sections assume you already read it, and assume that you know those main ideas.

docs/advanced/nosql-databases.md

@@ -1,154 +0,0 @@
-**FastAPI** can also be integrated with any <abbr title="Distributed database (Big Data), also 'Not Only SQL'">NoSQL</abbr>.
-
-Here we'll see an example using **<a href="https://www.couchbase.com/" class="external-link" target="_blank">Couchbase</a>**, a <abbr title="Document here refers to a JSON object (a dict), with keys and values, and those values can also be other JSON objects, arrays (lists), numbers, strings, booleans, etc.">document</abbr> based NoSQL database.
-
-You can adapt it to any other NoSQL database like:
-
-* **MongoDB**
-* **Cassandra**
-* **CouchDB**
-* **ArangoDB**
-* **ElasticSearch**, etc.
-
-!!! tip
-    There is an official project generator with **FastAPI** and **Couchbase**, all based on **Docker**, including a frontend and more tools: <a href="https://github.com/tiangolo/full-stack-fastapi-couchbase" class="external-link" target="_blank">https://github.com/tiangolo/full-stack-fastapi-couchbase</a>
-
-## Import Couchbase components
-
-For now, don't pay attention to the rest, only the imports:
-
-```Python hl_lines="6 7 8"
-{!./src/nosql_databases/tutorial001.py!}
-```
-
-## Define a constant to use as a "document type"
-
-We will use it later as a fixed field `type` in our documents.
-
-This is not required by Couchbase, but is a good practice that will help you afterwards.
-
-```Python hl_lines="10"
-{!./src/nosql_databases/tutorial001.py!}
-```
-
-## Add a function to get a `Bucket`
-
-In **Couchbase**, a bucket is a set of documents, that can be of different types.
-
-They are generally all related to the same application.
-
-The analogy in the relational database world would be a "database" (a specific database, not the database server).
-
-The analogy in **MongoDB** would be a "collection".
-
-In the code, a `Bucket` represents the main entrypoint of communication with the database.
-
-This utility function will:
-
-* Connect to a **Couchbase** cluster (that might be a single machine).
-    * Set defaults for timeouts.
-* Authenticate in the cluster.
-* Get a `Bucket` instance.
-    * Set defaults for timeouts.
-* Return it.
-
-```Python hl_lines="13 14 15 16 17 18 19 20 21 22"
-{!./src/nosql_databases/tutorial001.py!}
-```
-
-## Create Pydantic models
-
-As **Couchbase** "documents" are actually just "JSON objects", we can model them with Pydantic.
-
-### `User` model
-
-First, let's create a `User` model:
-
-```Python hl_lines="25 26 27 28 29"
-{!./src/nosql_databases/tutorial001.py!}
-```
-
-We will use this model in our *path operation function*, so, we don't include in it the `hashed_password`.
-
-### `UserInDB` model
-
-Now, let's create a `UserInDB` model.
-
-This will have the data that is actually stored in the database.
-
-We don't create it as a subclass of Pydantic's `BaseModel` but as a subclass of our own `User`, because it will have all the attributes in `User` plus a couple more:
-
-```Python hl_lines="32 33 34"
-{!./src/nosql_databases/tutorial001.py!}
-```
-
-!!! note
-    Notice that we have a `hashed_password` and a `type` field that will be stored in the database.
-
-    But it is not part of the general `User` model (the one we will return in the *path operation*).
-
-## Get the user
-
-Now create a function that will:
-
-* Take a username.
-* Generate a document ID from it.
-* Get the document with that ID.
-* Put the contents of the document in a `UserInDB` model.
-
-By creating a function that is only dedicated to getting your user from a `username` (or any other parameter) independent of your *path operation function*, you can more easily re-use it in multiple parts and also add <abbr title="Automated test, written in code, that checks if another piece of code is working correctly.">unit tests</abbr> for it:
-
-```Python hl_lines="37 38 39 40 41 42 43"
-{!./src/nosql_databases/tutorial001.py!}
-```
-
-### f-strings
-
-If you are not familiar with the `f"userprofile::{username}"`, it is a Python "<a href="https://docs.python.org/3/glossary.html#term-f-string" class="external-link" target="_blank">f-string</a>".
-
-Any variable that is put inside of `{}` in an f-string will be expanded / injected in the string.
-
-### `dict` unpacking
-
-If you are not familiar with the `UserInDB(**result.value)`, <a href="https://docs.python.org/3/glossary.html#term-argument" class="external-link" target="_blank">it is using `dict` "unpacking"</a>.
-
-It will take the `dict` at `result.value`, and take each of its keys and values and pass them as key-values to `UserInDB` as keyword arguments.
-
-So, if the `dict` contains:
-
-```Python
-{
-    "username": "johndoe",
-    "hashed_password": "some_hash",
-}
-```
-
-It will be passed to `UserInDB` as:
-
-```Python
-UserInDB(username="johndoe", hashed_password="some_hash")
-```
-
-## Create your **FastAPI** code
-
-### Create the `FastAPI` app
-
-```Python hl_lines="47"
-{!./src/nosql_databases/tutorial001.py!}
-```
-
-### Create the *path operation function*
-
-As our code is calling Couchbase and we are not using the <a href="https://docs.couchbase.com/python-sdk/2.5/async-programming.html#asyncio-python-3-5" class="external-link" target="_blank">experimental Python <code>await</code> support</a>, we should declare our function with normal `def` instead of `async def`.
-
-Also, Couchbase recommends not using a single `Bucket` object in multiple "<abbr title="A sequence of code being executed by the program, while at the same time, or at intervals, there can be others being executed too.">thread</abbr>s", so, we can get just get the bucket directly and pass it to our utility functions:
-
-```Python hl_lines="50 51 52 53 54"
-{!./src/nosql_databases/tutorial001.py!}
-```
-
-## Recap
-
-You can integrate any third party NoSQL database, just using their standard packages.
-
-The same applies to any other external tool, system or API.

docs/advanced/openapi-callbacks.md

@@ -1,186 +0,0 @@
-You could create an API with a *path operation* that could trigger a request to an *external API* created by someone else (probably the same developer that would be *using* your API).
-
-The process that happens when your API app calls the *external API* is named a "callback". Because the software that the external developer wrote sends a request to your API and then your API *calls back*, sending a request to an *external API* (that was probably created by the same developer).
-
-In this case, you could want to document how that external API *should* look like. What *path operation* it should have, what body it should expect, what response it should return, etc.
-
-## An app with callbacks
-
-Let's see all this with an example.
-
-Imagine you develop an app that allows creating invoices.
-
-These invoices will have an `id`, `title` (optional), `customer`, and `total`.
-
-The user of your API (an external developer) will create an invoice in your API with a POST request.
-
-Then your API will (let's imagine):
-
-* Send the invoice to some customer of the external developer.
-* Collect the money.
-* Send a notification back to the API user (the external developer).
-    * This will be done by sending a POST request (from *your API*) to some *external API* provided by that external developer (this is the "callback").
-
-## The normal **FastAPI** app
-
-Let's first see how the normal API app would look like before adding the callback.
-
-It will have a *path operation* that will receive an `Invoice` body, and a query parameter `callback_url` that will contain the URL for the callback.
-
-This part is pretty normal, most of the code is probably already familiar to you:
-
-```Python hl_lines="8 9 10 11 12  34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53"
-{!./src/openapi_callbacks/tutorial001.py!}
-```
-
-!!! tip
-    The `callback_url` query parameter uses a Pydantic <a href="https://pydantic-docs.helpmanual.io/usage/types/#urls" class="external-link" target="_blank">URL</a> type.
-
-The only new thing is the `callbacks=messages_callback_router.routes` as an argument to the *path operation decorator*. We'll see what that is next.
-
-## Documenting the callback
-
-The actual callback code will depend heavily on your own API app.
-
-And it will probably vary a lot from one app to the next.
-
-It could be just one or two lines of code, like:
-
-```Python
-callback_url = "https://example.com/api/v1/invoices/events/"
-requests.post(callback_url, json={"description": "Invoice paid", "paid": True})
-```
-
-But possibly the most important part of the callback is making sure that your API user (the external developer) implements the *external API* correctly, according to the data that *your API* is going to send in the request body of the callback, etc.
-
-So, what we will do next is add the code to document how that *external API* should look like to receive the callback from *your API*.
-
-That documentation will show up in the Swagger UI at `/docs` in your API, and it will let external developers know how to build the *external API*.
-
-This example doesn't implement the callback itself (that could be just a line of code), only the documentation part.
-
-!!! tip
-    The actual callback is just an HTTP request.
-
-    When implementing the callback yourself, you could use something like <a href="https://www.encode.io/httpx/" class="external-link" target="_blank">HTTPX</a> or <a href="https://requests.readthedocs.io/" class="external-link" target="_blank">Requests</a>.
-
-## Write the callback documentation code
-
-This code won't be executed in your app, we only need it to *document* how that *external API* should look like.
-
-But, you already know how to easily create automatic documentation for an API with **FastAPI**.
-
-So we are going to use that same knowledge to document how the *external API* should look like... by creating the *path operation(s)* that the external API should implement (the ones your API will call).
-
-!!! tip
-    When writing the code to document a callback, it might be useful to imagine that you are that *external developer*. And that you are currently implementing the *external API*, not *your API*.
-
-    Temporarily adopting this point of view (of the *external developer*) can help you feel like it's more obvious where to put the parameters, the Pydantic model for the body, for the response, etc. for that *external API*.
-
-### Create a callback `APIRouter`
-
-First create a new `APIRouter` that will contain one or more callbacks.
-
-This router will never be added to an actual `FastAPI` app (i.e. it will never be passed to `app.include_router(...)`).
-
-Because of that, you need to declare what will be the `default_response_class`, and set it to `JSONResponse`.
-
-!!! Note "Technical Details"
-    The `response_class` is normally set by the `FastAPI` app during the call to `app.include_router(some_router)`.
-
-    But as we are never calling `app.include_router(some_router)`, we need to set the `default_response_class` during creation of the `APIRouter`.
-
-```Python hl_lines="3 24"
-{!./src/openapi_callbacks/tutorial001.py!}
-```
-
-### Create the callback *path operation*
-
-To create the callback *path operation* use the same `APIRouter` you created above.
-
-It should look just like a normal FastAPI *path operation*:
-
-* It should probably have a declaration of the body it should receive, e.g. `body: InvoiceEvent`.
-* And it could also have a declaration of the response it should return, e.g. `response_model=InvoiceEventReceived`.
-
-```Python hl_lines="15 16 17  20 21  27 28 29 30 31"
-{!./src/openapi_callbacks/tutorial001.py!}
-```
-
-There are 2 main differences from a normal *path operation*:
-
-* It doesn't need to have any actual code, because your app will never call this code. It's only used to document the *external API*. So, the function could just have `pass`.
-* The *path* can contain an <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#key-expression" class="external-link" target="_blank">OpenAPI 3 expression</a> (see more below) where it can use variables with parameters and parts of the original request sent to *your API*.
-
-### The callback path expression
-
-The callback *path* can have an <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#key-expression" class="external-link" target="_blank">OpenAPI 3 expression</a> that can contain parts of the original request sent to *your API*.
-
-In this case, it's the `str`:
-
-```Python
-"{$callback_url}/invoices/{$request.body.id}"
-```
-
-So, if your API user (the external developer) sends a request to *your API* to:
-
-```
-https://yourapi.com/invoices/?callback_url=https://www.external.org/events
-```
-
-with a JSON body of:
-
-```JSON
-{
-    "id": "2expen51ve",
-    "customer": "Mr. Richie Rich",
-    "total": "9999"
-}
-```
-
-Then *your API* will process the invoice, and at some point later, send a callback request to the `callback_url` (the *external API*):
-
-```
-https://www.external.org/events/invoices/2expen51ve
-```
-
-with a JSON body containing something like:
-
-```JSON
-{
-    "description": "Payment celebration",
-    "paid": true
-}
-```
-
-and it would expect a response from that *external API* with a JSON body like:
-
-```JSON
-{
-    "ok": true
-}
-```
-
-!!! tip
-    Notice how the callback URL used contains the URL received as a query parameter in `callback_url` (`https://www.external.org/events`) and also the invoice `id` from inside of the JSON body (`2expen51ve`).
-
-### Add the callback router
-
-At this point you have the *callback path operation(s)* needed (the one(s) that the *external developer*  should implement in the *external API*) in the callback router you created above.
-
-Now use the parameter `callbacks` in *your API's path operation decorator* to pass the attribute `.routes` (that's actually just a `list` of routes/*path operations*) from that callback router:
-
-```Python hl_lines="34"
-{!./src/openapi_callbacks/tutorial001.py!}
-```
-
-!!! tip
-    Notice that you are not passing the router itself (`invoices_callback_router`) to `callback=`, but the attribute `.routes`, as in `invoices_callback_router.routes`.
-
-### Check the docs
-
-Now you can start your app with Uvicorn and go to <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
-
-You will see your docs including a "Callback" section for your *path operation* that shows how the *external API* should look like:
-
-<img src="/img/tutorial/openapi-callbacks/image01.png">

docs/advanced/path-operation-advanced-configuration.md

@@ -1,50 +0,0 @@
-## OpenAPI operationId
-
-!!! warning
-    If you are not an "expert" in OpenAPI, you probably don't need this.
-
-You can set the OpenAPI `operationId` to be used in your *path operation* with the parameter `operation_id`.
-
-You would have to make sure that it is unique for each operation.
-
-```Python hl_lines="6"
-{!./src/path_operation_advanced_configuration/tutorial001.py!}
-```
-
-### Using the *path operation function* name as the operationId
-
-If you want to use your APIs' function names as `operationId`s, you can iterate over all of them and override each *path operation's* `operation_id` using their `APIRoute.name`.
-
-You should do it after adding all your *path operations*.
-
-```Python hl_lines="2 12 13 14 15 16 17 18 19 20 21 24"
-{!./src/path_operation_advanced_configuration/tutorial002.py!}
-```
-
-!!! tip
-    If you manually call `app.openapi()`, you should update the `operationId`s before that.
-
-!!! warning
-    If you do this, you have to make sure each one of your *path operation functions* has a unique name.
-
-    Even if they are in different modules (Python files).
-
-## Exclude from OpenAPI
-
-To exclude a *path operation* from the generated OpenAPI schema (and thus, from the automatic documentation systems), use the parameter `include_in_schema` and set it to `False`;
-
-```Python hl_lines="6"
-{!./src/path_operation_advanced_configuration/tutorial003.py!}
-```
-
-## Advanced description from docstring
-
-You can limit the lines used from the docstring of a *path operation function* for OpenAPI.
-
-Adding an `\f` (an escaped "form feed" character) causes **FastAPI** to truncate the output used for OpenAPI at this point.
-
-It won't show up in the documentation, but other tools (such as Sphinx) will be able to use the rest.
-
-```Python hl_lines="19 20 21 22 23 24 25 26 27 28 29"
-{!./src/path_operation_advanced_configuration/tutorial004.py!}
-```

docs/advanced/response-change-status-code.md

@@ -1,31 +0,0 @@
-You probably read before that you can set a default [Response Status Code](../tutorial/response-status-code.md){.internal-link target=_blank}.
-
-But in some cases you need to return a different status code than the default.
-
-## Use case
-
-For example, imagine that you want to return an HTTP status code of "OK" `200` by default.
-
-But if the data didn't exist, you want to create it, and return an HTTP status code of "CREATED" `201`.
-
-But you still want to be able to filter and convert the data you return with a `response_model`.
-
-For those cases, you can use a `Response` parameter.
-
-## Use a `Response` parameter
-
-You can declare a parameter of type `Response` in your *path operation function* (as you can do for cookies and headers).
-
-And then you can set the `status_code` in that *temporal* response object.
-
-```Python hl_lines="2 11 14"
-{!./src/response_change_status_code/tutorial001.py!}
-```
-
-And then you can return any object you need, as you normally would (a `dict`, a database model, etc).
-
-And if you declared a `response_model`, it will still be used to filter and convert the object you returned.
-
-**FastAPI** will use that *temporal* response to extract the status code (also cookies and headers), and will put them in the final response that contains the value you returned, filtered by any `response_model`.
-
-You can also declare the `Response` parameter in dependencies, and set the status code in them. But have in mind that the last one to be set will win.

docs/advanced/response-cookies.md

@@ -1,40 +0,0 @@
-## Use a `Response` parameter
-
-You can declare a parameter of type `Response` in your *path operation function*.
-
-And then you can set headers in that *temporal* response object.
-
-```Python hl_lines="2 8 9"
-{!./src/response_cookies/tutorial002.py!}
-```
-
-And then you can return any object you need, as you normally would (a `dict`, a database model, etc).
-
-And if you declared a `response_model`, it will still be used to filter and convert the object you returned.
-
-**FastAPI** will use that *temporal* response to extract the cookies (also headers and status code), and will put them in the final response that contains the value you returned, filtered by any `response_model`.
-
-You can also declare the `Response` parameter in dependencies, and set cookies (and headers) in them.
-
-## Return a `Response` directly
-
-You can also create cookies when returning a `Response` directly in your code.
-
-To do that, you can create a response as described in [Return a Response Directly](response-directly.md){.internal-link target=_blank}.
-
-Then set Cookies in it, and then return it:
-
-```Python hl_lines="10 11 12"
-{!./src/response_cookies/tutorial001.py!}
-```
-
-!!! tip
-    Have in mind that if you return a response directly instead of using the `Response` parameter, FastAPI will return it directly.
-
-    So, you will have to make sure your data is of the correct type. E.g. it is compatible with JSON, if you are returning a `JSONResponse`.
-
-    And also that you are not sending any data that should have been filtered by a `response_model`.
-
-### More info
-
-To see all the available parameters and options, check the <a href="https://www.starlette.io/responses/#set-cookie" class="external-link" target="_blank">documentation in Starlette</a>.

docs/advanced/response-directly.md

@@ -1,61 +0,0 @@
-When you create a **FastAPI** *path operation* you can normally return any data from it: a `dict`, a `list`, a Pydantic model, a database model, etc.
-
-By default, **FastAPI** would automatically convert that return value to JSON using the `jsonable_encoder` explained in [JSON Compatible Encoder](../tutorial/encoder.md){.internal-link target=_blank}.
-
-Then, behind the scenes, it would put that JSON-compatible data (e.g. a `dict`) inside of a Starlette `JSONResponse` that would be used to send the response to the client.
-
-But you can return a `JSONResponse` directly from your *path operations*.
-
-It might be useful, for example, to return custom headers or cookies.
-
-## Starlette `Response`
-
-In fact, you can return any <a href="https://www.starlette.io/responses/" class="external-link" target="_blank">Starlette `Response`</a> or any sub-class of it.
-
-!!! tip
-    `JSONResponse` itself is a sub-class of `Response`.
-
-And when you return a Starlette `Response`, **FastAPI** will pass it directly.
-
-It won't do any data conversion with Pydantic models, it won't convert the contents to any type, etc.
-
-This gives you a lot of flexibility. You can return any data type, override any data declaration or validation, etc.
-
-## Using the `jsonable_encoder` in a `Response`
-
-Because **FastAPI** doesn't do any change to a `Response` you return, you have to make sure it's contents are ready for it.
-
-For example, you cannot put a Pydantic model in a `JSONResponse` without first converting it to a `dict` with all the data types (like `datetime`, `UUID`, etc) converted to JSON-compatible types.
-
-For those cases, you can use the `jsonable_encoder` to convert your data before passing it to a response:
-
-```Python hl_lines="4 6 20 21"
-{!./src/response_directly/tutorial001.py!}
-```
-
-!!! note
-    Notice that you import it directly from `starlette.responses`, not from `fastapi`.
-
-## Returning a custom `Response`
-
-The example above shows all the parts you need, but it's not very useful yet, as you could have just returned the `item` directly, and **FastAPI** would put it in a `JSONResponse` for you, converting it to a `dict`, etc. All that by default.
-
-Now, let's see how you could use that to return a custom response.
-
-Let's say you want to return a response that is not available in the default <a href="https://www.starlette.io/responses/" class="external-link" target="_blank">Starlette `Response`s</a>.
-
-Let's say that you want to return <a href="https://en.wikipedia.org/wiki/XML" class="external-link" target="_blank">XML</a>.
-
-You could put your XML content in a string, put it in a Starlette Response, and return it:
-
-```Python hl_lines="2 20"
-{!./src/response_directly/tutorial002.py!}
-```
-
-## Notes
-
-When you return a `Response` directly its data is not validated, converted (serialized), nor documented automatically.
-
-But you can still document it as described in [Additional Responses in OpenAPI](additional-responses.md){.internal-link target=_blank}.
-
-You can see in later sections how to use/declare these custom `Response`s while still having automatic data conversion, documentation, etc.

docs/advanced/response-headers.md

@@ -1,33 +0,0 @@
-## Use a `Response` parameter
-
-You can declare a parameter of type `Response` in your *path operation function* (as you can do for cookies).
-
-And then you can set headers in that *temporal* response object.
-
-```Python hl_lines="2 8 9"
-{!./src/response_headers/tutorial002.py!}
-```
-
-And then you can return any object you need, as you normally would (a `dict`, a database model, etc).
-
-And if you declared a `response_model`, it will still be used to filter and convert the object you returned.
-
-**FastAPI** will use that *temporal* response to extract the headers (also cookies and status code), and will put them in the final response that contains the value you returned, filtered by any `response_model`.
-
-You can also declare the `Response` parameter in dependencies, and set headers (and cookies) in them.
-
-## Return a `Response` directly
-
-You can also add headers when you return a `Response` directly.
-
-Create a response as described in [Return a Response Directly](response-directly.md){.internal-link target=_blank} and pass the headers as an additional parameter:
-
-```Python hl_lines="10 11 12"
-{!./src/response_headers/tutorial001.py!}
-```
-
-## Custom Headers
-
-Have in mind that custom proprietary headers can be added <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers" class="external-link" target="_blank">using the 'X-' prefix</a>.
-
-But if you have custom headers that you want a client in a browser to be able to see, you need to add them to your CORS configurations (read more in [CORS (Cross-Origin Resource Sharing)](../tutorial/cors.md){.internal-link target=_blank}), using the parameter `expose_headers` documented in <a href="https://www.starlette.io/middleware/#corsmiddleware" class="external-link" target="_blank">Starlette's CORS docs</a>.

docs/advanced/security/http-basic-auth.md

@@ -1,105 +0,0 @@
-For the simplest cases, you can use HTTP Basic Auth.
-
-In HTTP Basic Auth, the application expects a header that contains a username and a password.
-
-If it doesn't receive it, it returns an HTTP 401 "Unauthorized" error.
-
-And returns a header `WWW-Authenticate` with a value of `Basic`, and an optional `realm` parameter.
-
-That tells the browser to show the integrated prompt for a username and password.
-
-Then, when you type that username and password, the browser sends them in the header automatically.
-
-## Simple HTTP Basic Auth
-
-* Import `HTTPBasic` and `HTTPBasicCredentials`.
-* Create a "`security` scheme" using `HTTPBasic`.
-* Use that `security` with a dependency in your *path operation*.
-* It returns an object of type `HTTPBasicCredentials`:
-    * It contains the `username` and `password` sent.
-
-```Python hl_lines="2 6 10"
-{!./src/security/tutorial006.py!}
-```
-
-When you try to open the URL for the first time (or click the "Execute" button in the docs) the browser will ask you for your username and password:
-
-<img src="/img/tutorial/security/image12.png">
-
-## Check the username
-
-Here's a more complete example.
-
-Use a dependency to check if the username and password are correct.
-
-For this, use the Python standard module <a href="https://docs.python.org/3/library/secrets.html" class="external-link" target="_blank">`secrets`</a> to check the username and password:
-
-```Python hl_lines="1  13 14 15"
-{!./src/security/tutorial007.py!}
-```
-
-This will ensure that `credentials.username` is `"stanleyjobson"`, and that `credentials.password` is `"swordfish"`. This would be similar to:
-
-```Python
-if not (credentials.username == "stanleyjobson") or not (credentials.password == "swordfish"):
-    # Return some error
-    ...
-```
-
-But by using the `secrets.compare_digest()` it will be secure against a type of attacks called "timing attacks".
-
-### Timing Attacks
-
-But what's a "timing attack"?
-
-Let's imagine an attacker is trying to guess the username and password.
-
-And that attacker sends a request with a username `johndoe` and a password `love123`.
-
-Then the Python code in your application would be equivalent to something like:
-
-```Python
-if "johndoe" == "stanleyjobson" and "love123" == "swordfish":
-    ...
-```
-
-But right at the moment Python compares the first `j` in `johndoe` to the first `s` in `stanleyjobson`, it will return `False`, because it already knows that those two strings are not the same, thinking that "there's no need to waste more computation comparing the rest of the letters". And your application will say "incorrect user or password".
-
-But then the attacker tries with username `stanleyjobsox` and password `love123`.
-
-And your application code does something like:
-
-```Python
-if "stanleyjobsox" == "stanleyjobson" and "love123" == "swordfish":
-    ...
-```
-
-Python will have to compare the whole `stanleyjobso` in both `stanleyjobsox` and `stanleyjobson` before realizing that both strings are not the same. So it will take some extra microseconds to reply back "incorrect user or password".
-
-#### The time to answer helps the attacker
-
-At that point, by noticing that the server took some microseconds longer to send the "incorrect user or password" response, the attacker will know that she/he got _something_ right, some of the initial letters were right.
-
-And then she/he can try again knowing that it's probably something more similar to `stanleyjobsox` than to `johndoe`.
-
-#### A "professional" attack
-
-Of course, the attacker would not try all this by hand, she/he would write a program to do it, possibly with thousands or millions of tests per second. And would get just one extra correct letter at a time.
-
-But doing that, in some minutes or hours the attacker would have guessed the correct username and password, with the "help" of our application, just using the time taken to answer.
-
-#### Fix it with `secrets.compare_digest()`
-
-But in our code we are actually using `secrets.compare_digest()`.
-
-In short, it will take the same time to compare `stanleyjobsox` to `stanleyjobson` than it takes to compare `johndoe` to `stanleyjobson`. And the same for the password.
-
-That way, using `secrets.compare_digest()` in your application code, it will be safe against this whole range of security attacks.
-
-### Return the error
-
-After detecting that the credentials are incorrect, return an `HTTPException` with a status code 401 (the same returned when no credentials are provided) and add the header `WWW-Authenticate` to make the browser show the login prompt again:
-
-```Python hl_lines="16 17 18 19 20"
-{!./src/security/tutorial007.py!}
-```

docs/advanced/security/index.md

@@ -1,14 +0,0 @@
-## Additional Features
-
-There are some extra features to handle security apart from the ones covered in the [Tutorial - User Guide: Security](../../tutorial/security/){.internal-link target=_blank}.
-
-!!! tip
-    The next sections are **not necessarily "advanced"**.
-
-    And it's possible that for your use case, the solution is in one of them.
-
-## Read the Tutorial first
-
-The next sections assume you already read the main [Tutorial - User Guide: Security](../../tutorial/security/){.internal-link target=_blank}.
-
-They are all based on the same concepts, but allow some extra functionalities.

docs/advanced/security/oauth2-scopes.md

@@ -1,267 +0,0 @@
-You can use OAuth2 scopes directly with **FastAPI**, they are integrated to work seamlessly.
-
-This would allow you to have a more fine-grained permission system, following the OAuth2 standard, integrated into your OpenAPI application (and the API docs).
-
-OAuth2 with scopes is the mechanism used by many big authentication providers, like Facebook, Google, GitHub, Microsoft, Twitter, etc. They use it to provide specific permissions to users and applications.
-
-Every time you "log in with" Facebook, Google, GitHub, Microsoft, Twitter, that application is using OAuth2 with scopes.
-
-In this section you will see how to manage authentication and authorization with the same OAuth2 with scopes in your **FastAPI** application.
-
-!!! warning
-    This is a more or less advanced section. If you are just starting, you can skip it.
-
-    You don't necessarily need OAuth2 scopes, and you can handle authentication and authorization however you want.
-
-    But OAuth2 with scopes can be nicely integrated into your API (with OpenAPI) and your API docs.
-    
-    Nevertheless, you still enforce those scopes, or any other security/authorization requirement, however you need, in your code.
-
-    In many cases, OAuth2 with scopes can be an overkill.
-    
-    But if you know you need it, or you are curious, keep reading.
-
-## OAuth2 scopes and OpenAPI
-
-The OAuth2 specification defines "scopes" as a list of strings separated by spaces.
-
-The content of each of these strings can have any format, but should not contain spaces.
-
-These scopes represent "permissions".
-
-In OpenAPI (e.g. the API docs), you can define "security schemes".
-
-When one of these security schemes uses OAuth2, you can also declare and use scopes.
-
-Each "scope" is just a string (without spaces).
-
-They are normally used to declare specific security permissions, for example:
-
-* `users:read` or `users:write` are common examples.
-* `instagram_basic` is used by Facebook / Instagram.
-* `https://www.googleapis.com/auth/drive` is used by Google.
-
-!!! info
-    In OAuth2 a "scope" is just a string that declares a specific permission required.
-
-    It doesn't matter if it has other characters like `:` or if it is a URL.
-    
-    Those details are implementation specific.
-
-    For OAuth2 they are just strings.
-
-## Global view
-
-First, let's quickly see the parts that change from the examples in the main **Tutorial - User Guide** for [OAuth2 with Password (and hashing), Bearer with JWT tokens](../../tutorial/security/oauth2-jwt.md){.internal-link target=_blank}. Now using OAuth2 scopes:
-
-```Python hl_lines="2 5 9 13 48 66 107 109 110 111 112 113 114 115 116 117 123 124 125 126 130 131 132 133 134 135 136 141 155"
-{!./src/security/tutorial005.py!}
-```
-
-Now let's review those changes step by step.
-
-## OAuth2 Security scheme
-
-The first change is that now we are declaring the OAuth2 security scheme with two available scopes, `me` and `items`.
-
-The `scopes` parameter receives a `dict` with each scope as a key and the description as the value:
-
-```Python hl_lines="64 65 66 67"
-{!./src/security/tutorial005.py!}
-```
-
-Because we are now declaring those scopes, they will show up in the API docs when you log-in/authorize.
-
-And you will be able to select which scopes you want to give access to: `me` and `items`.
-
-This is the same mechanism used when you give permissions while logging in with Facebook, Google, GitHub, etc:
-
-<img src="/img/tutorial/security/image11.png">
-
-## JWT token with scopes
-
-Now, modify the token *path operation* to return the scopes requested.
-
-We are still using the same `OAuth2PasswordRequestForm`. It includes a property `scopes` with a `list` of `str`, with each scope it received in the request.
-
-And we return the scopes as part of the JWT token.
-
-!!! danger
-    For simplicity, here we are just adding the scopes received directly to the token.
-
-    But in your application, for security, you should make sure you only add the scopes that the user is actually able to have, or the ones you have predefined.
-
-```Python hl_lines="156"
-{!./src/security/tutorial005.py!}
-```
-
-## Declare scopes in *path operations* and dependencies
-
-Now we declare that the *path operation* for `/users/me/items/` requires the scope `items`.
-
-For this, we import and use `Security` from `fastapi`.
-
-You can use `Security` to declare dependencies (just like `Depends`), but `Security` also receives a parameter `scopes` with a list of scopes (strings).
-
-In this case, we pass a dependency function `get_current_active_user` to `Security` (the same way we would do with `Depends`).
-
-But we also pass a `list` of scopes, in this case with just one scope: `items` (it could have more).
-
-And the dependency function `get_current_active_user` can also declare sub-dependencies, not only with `Depends` but also with `Security`. Declaring its own sub-dependency function (`get_current_user`), and more scope requirements.
-
-In this case, it requires the scope `me` (it could require more than one scope).
-
-!!! note
-    You don't necessarily need to add different scopes in different places.
-    
-    We are doing it here to demonstrate how **FastAPI** handles scopes declared at different levels.
-
-```Python hl_lines="5 141 168"
-{!./src/security/tutorial005.py!}
-```
-
-!!! info "Technical Details"
-    `Security` is actually a subclass of `Depends`, and it has just one extra parameter that we'll see later.
-
-    But by using `Security` instead of `Depends`, **FastAPI** will know that it can declare security scopes, use them internally, and document the API with OpenAPI.
-
-    But when you import `Query`, `Path`, `Depends`, `Security` and others from `fastapi`, those are actually functions that return special classes.
-
-## Use `SecurityScopes`
-
-Now update the dependency `get_current_user`.
-
-This is the one used by the dependencies above.
-
-Here's were we are using the same OAuth2 scheme we created before, declaring it as a dependency: `oauth2_scheme`.
-
-Because this dependency function doesn't have any scope requirements itself, we can use `Depends` with `oauth2_scheme`, we don't have to use `Security` when we don't need to specify security scopes.
-
-We also declare a special parameter of type `SecurityScopes`, imported from `fastapi.security`.
-
-This `SecurityScopes` class is similar to `Request` (`Request` was used to get the request object directly).
-
-```Python hl_lines="9 107"
-{!./src/security/tutorial005.py!}
-```
-
-## Use the `scopes`
-
-The parameter `security_scopes` will be of type `SecurityScopes`.
-
-It will have a property `scopes` with a list containing all the scopes required by itself and all the dependencies that use this as a sub-dependency. That means, all the "dependants"... this might sound confusing, it is explained again later below.
-
-The `security_scopes` object (of class `SecurityScopes`) also provides a `scope_str` attribute with a single string, containing those scopes separated by spaces (we are going to use it).
-
-We create an `HTTPException` that we can re-use (`raise`) later at several points.
-
-In this exception, we include the scopes required (if any) as a string separated by spaces (using `scope_str`). We put that string containing the scopes in in the `WWW-Authenticate` header (this is part of the spec).
-
-```Python hl_lines="107 109 110 111 112 113 114 115 116 117"
-{!./src/security/tutorial005.py!}
-```
-
-## Verify the `username` and data shape
-
-We verify that we get a `username`, and extract the scopes.
-
-And then we validate that data with the Pydantic model (catching the `ValidationError` exception), and if we get an error reading the JWT token or validating the data with Pydantic, we raise the `HTTPException` we created before.
-
-For that, we update the Pydantic model `TokenData` with a new property `scopes`.
-
-By validating the data with Pydantic we can make sure that we have, for example, exactly a `list` of `str` with the scopes and a `str` with the `username`.
-
-Instead of, for example, a `dict`, or something else, as it could break the application at some point later, making it a security risk.
-
-We also verify that we have a user with that username, and if not, we raise that same exception we created before.
-
-```Python hl_lines="48 118 119 120 121 122 123 124 125 126 127 128 129"
-{!./src/security/tutorial005.py!}
-```
-
-## Verify the `scopes`
-
-We now verify that all the scopes required, by this dependency and all the dependants (including *path operations*), are included in the scopes provided in the token received, otherwise raise an `HTTPException`.
-
-For this, we use `security_scopes.scopes`, that contains a `list` with all these scopes as `str`.
-
-```Python hl_lines="130 131 132 133 134 135 136"
-{!./src/security/tutorial005.py!}
-```
-
-## Dependency tree and scopes
-
-Let's review again this dependency tree and the scopes.
-
-As the `get_current_active_user` dependency has as a sub-dependency on `get_current_user`, the scope `"me"` declared at `get_current_active_user` will be included in the list of required scopes in the `security_scopes.scopes` passed to `get_current_user`.
-
-The *path operation* itself also declares a scope, `"items"`, so this will also be in the list of `security_scopes.scopes` passed to `get_current_user`.
-
-Here's how the hierarchy of dependencies and scopes looks like:
-
-* The *path operation* `read_own_items` has:
-    * Required scopes `["items"]` with the dependency:
-    * `get_current_active_user`:
-        *  The dependency function `get_current_active_user` has:
-            * Required scopes `["me"]` with the dependency:
-            * `get_current_user`:
-                * The dependency function `get_current_user` has:
-                    * No scopes required by itself.
-                    * A dependency using `oauth2_scheme`.
-                    * A `security_scopes` parameter of type `SecurityScopes`:
-                        * This `security_scopes` parameter has a property `scopes` with a `list` containing all these scopes declared above, so:
-                            * `security_scopes.scopes` will contain `["me", "items"]` for the *path operation* `read_own_items`.
-                            * `security_scopes.scopes` will contain `["me"]` for the *path operation* `read_users_me`, because it is declared in the dependency `get_current_active_user`.
-                            * `security_scopes.scopes` will contain `[]` (nothing) for the *path operation* `read_system_status`, because it didn't declare any `Security` with `scopes`, and its dependency, `get_current_user`, doesn't declare any `scope` either.
-
-!!! tip
-    The important and "magic" thing here is that `get_current_user` will have a different list of `scopes` to check for each *path operation*.
-
-    All depending on the `scopes` declared in each *path operation* and each dependency in the dependency tree for that specific *path operation*.
-
-## More details about `SecurityScopes`
-
-You can use `SecurityScopes` at any point, and in multiple places, it doesn't have to be at the "root" dependency.
-
-It will always have the security scopes declared in the current `Security` dependencies and all the dependants for **that specific** *path operation* and **that specific** dependency tree.
-
-Because the `SecurityScopes` will have all the scopes declared by dependants, you can use it to verify that a token has the required scopes in a central dependency function, and then declare different scope requirements in different *path operations*.
-
-They will be checked independently for each *path operation*.
-
-## Check it
-
-If you open the API docs, you can authenticate and specify which scopes you want to authorize.
-
-<img src="/img/tutorial/security/image11.png">
-
-If you don't select any scope, you will be "authenticated", but when you try to access `/users/me/` or `/users/me/items/` you will get an error saying that you don't have enough permissions. You will still be able to access `/status/`.
-
-And if you select the scope `me` but not the scope `items`, you will be able to access `/users/me/` but not `/users/me/items/`.
-
-That's what would happen to a third party application that tried to access one of these *path operations* with a token provided by a user, depending on how many permissions the user gave the application.
-
-## About third party integrations
-
-In this example we are using the OAuth2 "password" flow.
-
-This is appropriate when we are logging in to our own application, probably with our own frontend.
-
-Because we can trust it to receive the `username` and `password`, as we control it.
-
-But if you are building an OAuth2 application that others would connect to (i.e., if you are building an authentication provider equivalent to Facebook, Google, GitHub, etc.) you should use one of the other flows.
-
-The most common is the implicit flow.
-
-The most secure is the code flow, but is more complex to implement as it requires more steps. As it is more complex, many providers end up suggesting the implicit flow.
-
-!!! note
-    It's common that each authentication provider names their flows in a different way, to make it part of their brand.
-
-    But in the end, they are implementing the same OAuth2 standard.
-
-**FastAPI** includes utilities for all these OAuth2 authentication flows in `fastapi.security.oauth2`.
-
-## `Security` in decorator `dependencies`
-
-The same way you can define a `list` of `Depends` in the decorator's `dependencies` parameter (as explained in [Dependencies in path operation decorators](../../tutorial/dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank}), you could also use `Security` with `scopes` there.

docs/advanced/sql-databases-peewee.md

@@ -1,521 +0,0 @@
-!!! warning
-    If you are just starting, the tutorial [SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank} that uses SQLAlchemy should be enough.
-
-    Feel free to skip this.
-
-If you are starting a project from scratch, you are probably better off with SQLAlchemy ORM ([SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank}), or any other async ORM.
-
-If you already have a code base that uses <a href="http://docs.peewee-orm.com/en/latest/" class="external-link" target="_blank">Peewee ORM</a>, you can check here how to use it with **FastAPI**.
-
-!!! warning "Python 3.7+ required"
-    You will need Python 3.7 or above to safely use Peewee with FastAPI.
-
-## Peewee for async
-
-Peewee was not designed for async frameworks, or with them in mind.
-
-Peewee has some heavy assumptions about its defaults and about how it should be used.
-
-If you are developing an application with an older non-async framework, and can work with all its defaults, **it can be a great tool**.
-
-But if you need to change some of the defaults, support more than one predefined database, work with an async framework (like FastAPI), etc, you will need to add quite some complex extra code to override those defaults.
-
-Nevertheless, it's possible to do it, and here you'll see exactly what code you have to add to be able to use Peewee with FastAPI.
-
-!!! note "Technical Details"
-    You can read more about Peewee's stand about async in Python <a href="http://docs.peewee-orm.com/en/latest/peewee/database.html#async-with-gevent" class="external-link" target="_blank">in the docs</a>, <a href="https://github.com/coleifer/peewee/issues/263#issuecomment-517347032" class="external-link" target="_blank">an issue</a>, <a href="https://github.com/coleifer/peewee/pull/2072#issuecomment-563215132" class="external-link" target="_blank">a PR</a>.
-
-## The same app
-
-We are going to create the same application as in the SQLAlchemy tutorial ([SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank}).
-
-Most of the code is actually the same.
-
-So, we are going to focus only on the differences.
-
-## File structure
-
-Let's say you have a directory named `my_super_project` that contains a sub-directory called `sql_app` with a structure like this:
-
-```
-.
-└── sql_app
-    ├── __init__.py
-    ├── crud.py
-    ├── database.py
-    ├── main.py
-    └── schemas.py
-```
-
-This is almost the same structure as we had for the SQLAlchemy tutorial.
-
-Now let's see what each file/module does.
-
-## Create the Peewee parts
-
-Let's refer to the file `sql_app/database.py`.
-
-### The standard Peewee code
-
-Let's first check all the normal Peewee code, create a Peewee database:
-
-```Python hl_lines="3  5  22"
-{!./src/sql_databases_peewee/sql_app/database.py!}
-```
-
-!!! tip
-    Have in mind that if you wanted to use a different database, like PostgreSQL, you couldn't just change the string. You would need to use a different Peewee database class.
-
-#### Note
-
-The argument:
-
-```Python
-check_same_thread=False
-```
-
-is equivalent to the one in the SQLAlchemy tutorial:
-
-```Python
-connect_args={"check_same_thread": False}
-```
-
-...it is needed only for `SQLite`.
-
-!!! info "Technical Details"
-
-    Exactly the same technical details as in [SQL (Relational) Databases](../tutorial/sql-databases.md#note){.internal-link target=_blank} apply.
-
-### Make Peewee async-compatible `PeeweeConnectionState`
-
-The main issue with Peewee and FastAPI is that Peewee relies heavily on <a href="https://docs.python.org/3/library/threading.html#thread-local-data" class="external-link" target="_blank">Python's `threading.local`</a>, and it doesn't have a direct way to override it or let you handle connections/sessions directly (as is done in the SQLAlchemy tutorial).
-
-And `threading.local` is not compatible with the new async features of modern Python.
-
-!!! note "Technical Details"
-    `threading.local` is used to have a "magic" variable that has a different value for each thread.
-
-    This was useful in older frameworks designed to have one single thread per request, no more, no less.
-
-    Using this, each request would have its own database connection/session, which is the actual final goal.
-
-    But FastAPI, using the new async features, could handle more than one request on the same thread. And at the same time, for a single request, it could run multiple things in different threads (in a threadpool), depending on if you use `async def` or normal `def`. This is what gives all the performance improvements to FastAPI.
-
-But Python 3.7 and above provide a more advanced alternative to `threading.local`, that can also be used in the places where `threading.local` would be used, but is compatible with the new async features.
-
-We are going to use that. It's called <a href="https://docs.python.org/3/library/contextvars.html" class="external-link" target="_blank">`contextvars`</a>.
-
-We are going to override the internal parts of Peewee that use `threading.local` and replace them with `contextvars`, with the corresponding updates.
-
-This might seem a bit complex (and it actually is), you don't really need to completely understand how it works to use it.
-
-We will create a `PeeweeConnectionState`:
-
-```Python hl_lines="10 11 12 13 14 15 16 17 18 19"
-{!./src/sql_databases_peewee/sql_app/database.py!}
-```
-
-This class inherits from a special internal class used by Peewee.
-
-It has all the logic to make Peewee use `contextvars` instead of `threading.local`.
-
-`contextvars` works a bit differently than `threading.local`. But the rest of Peewee's internal code assumes that this class works with `threading.local`.
-
-So, we need to do some extra tricks to make it work as if it was just using `threading.local`. The `__init__`, `__setattr__`, and `__getattr__` implement all the required tricks for this to be used by Peewee without knowing that it is now compatible with FastAPI.
-
-!!! tip
-    This will just make Peewee behave correctly when used with FastAPI. Not randomly opening or closing connections that are being used, creating errors, etc.
-
-    But it doesn't give Peewee async super-powers. You should still use normal `def` functions and not `async def`.
-
-### Use the custom `PeeweeConnectionState` class
-
-Now, overwrite the `._state` internal attribute in the Peewee database `db` object using the new `PeeweeConnectionState`:
-
-```Python hl_lines="24"
-{!./src/sql_databases_peewee/sql_app/database.py!}
-```
-
-!!! tip
-    Make sure you overwrite `db._state` *after* creating `db`.
-
-!!! tip
-    You would do the same for any other Peewee database, including `PostgresqlDatabase`, `MySQLDatabase`, etc.
-
-## Create the database models
-
-Let's now see the file `sql_app/models.py`.
-
-### Create Peewee models for our data
-
-Now create the Peewee models (classes) for `User` and `Item`.
-
-This is the same you would do if you followed the Peewee tutorial and updated the models to have the same data as in the SQLAlchemy tutorial.
-
-!!! tip
-    Peewee also uses the term "**model**" to refer to these classes and instances that interact with the database.
-
-    But Pydantic also uses the term "**model**" to refer to something different, the data validation, conversion, and documentation classes and instances.
-
-Import `db` from `database` (the file `database.py` from above) and use it here.
-
-```Python hl_lines="3  6 7 8 9 10 11 12  15 16 17 18 19 20 21"
-{!./src/sql_databases_peewee/sql_app/models.py!}
-```
-
-!!! tip
-    Peewee creates several magic attributes.
-
-    It will automatically add an `id` attribute as an integer to be the primary key.
-
-    It will chose the name of the tables based on the class names.
-
-    For the `Item`, it will create an attribute `owner_id` with the integer ID of the `User`. But we don't declare it anywhere.
-
-## Create the Pydantic models
-
-Now let's check the file `sql_app/schemas.py`.
-
-!!! tip
-    To avoid confusion between the Peewee *models* and the Pydantic *models*, we will have the file `models.py` with the Peewee models, and the file `schemas.py` with the Pydantic models.
-
-    These Pydantic models define more or less a "schema" (a valid data shape).
-    
-    So this will help us avoiding confusion while using both.
-
-### Create the Pydantic *models* / schemas
-
-Create all the same Pydantic models as in the SQLAlchemy tutorial:
-
-```Python hl_lines="16 17 18  21 22  25 26 27 28 29 30  34 35  38 39  42 43 44 45 46 47 48"
-{!./src/sql_databases_peewee/sql_app/schemas.py!}
-```
-
-!!! tip
-    Here we are creating the models with an `id`.
-
-    We didn't explicitly specify an `id` attribute in the Peewee models, but Peewee adds one automatically.
-
-    We are also adding the magic `owner_id` attribute to `Item`.
-
-### Create a `PeeweeGetterDict` for the Pydantic *models* / schemas
-
-When you access a relationship in a Peewee object, like in `some_user.items`, Peewee doesn't provide a `list` of `Item`.
-
-It provides a special custom object of class `ModelSelect`.
-
-It's possible to create a `list` of its items with `list(some_user.items)`.
-
-But the object itself is not a `list`. And it's also not an actual Python <a href="https://docs.python.org/3/glossary.html#term-generator" class="external-link" target="_blank">generator</a>. Because of this, Pydantic doesn't know by default how to convert it to a `list` of Pydantic *models* / schemas.
-
-But recent versions of Pydantic allow providing a custom class that inherits from `pydantic.utils.GetterDict`, to provide the functionality used when using the `orm_mode = True` to retrieve the values for ORM model attributes.
-
-We are going to create a custom `PeeweeGetterDict` class and use it in all the same Pydantic *models* / schemas that use `orm_mode`:
-
-```Python hl_lines="3 8 9 10 11 12 13  31  49"
-{!./src/sql_databases_peewee/sql_app/schemas.py!}
-```
-
-Here we are checking if the attribute that is being accessed (e.g. `.items` in `some_user.items`) is an instance of `peewee.ModelSelect`.
-
-And if that's the case, just return a `list` with it.
-
-And then we use it in the Pydantic *models* / schemas that use `orm_mode = True`, with the configuration variable `getter_dict = PeeweeGetterDict`.
-
-!!! tip
-    We only need to create one `PeeweeGetterDict` class, and we can use it in all the Pydantic *models* / schemas.
-
-## CRUD utils
-
-Now let's see the file `sql_app/crud.py`.
-
-### Create all the CRUD utils
-
-Create all the same CRUD utils as in the SQLAlchemy tutorial, all the code is very similar:
-
-```Python hl_lines="1  4 5  8 9  12 13  16 17 18 19 20  23 24  27 28 29 30"
-{!./src/sql_databases_peewee/sql_app/crud.py!}
-```
-
-There are some differences with the code for the SQLAlchemy tutorial.
-
-We don't pass a `db` attribute around. Instead we use the models directly. This is because the `db` object is a global object, that includes all the connection logic. That's why we had to do all the `contextvars` updates above.
-
-Aso, when returning several objects, like in `get_users`, we directly call `list`, like in:
-
-```Python
-list(models.User.select())
-```
-
-This is for the same reason that we had to create a custom `PeeweeGetterDict`. But by returning something that is already a `list` instead of the `peewee.ModelSelect` the `response_model` in the *path operation* with `List[models.User]` (that we'll see later) will work correctly.
-
-## Main **FastAPI** app
-
-And now in the file `sql_app/main.py` let's integrate and use all the other parts we created before.
-
-### Create the database tables
-
-In a very simplistic way create the database tables:
-
-```Python hl_lines="9 10 11"
-{!./src/sql_databases_peewee/sql_app/main.py!}
-```
-
-### Create a dependency
-
-Create a dependency that will connect the database right at the beginning of a request and disconnect it at the end:
-
-```Python hl_lines="23 24 25 26 27 28 29"
-{!./src/sql_databases_peewee/sql_app/main.py!}
-```
-
-Here we have an empty `yield` because we are actually not using the database object directly.
-
-It is connecting to the database and storing the connection data in an internal variable that is independent for each request (using the `contextvars` tricks from above).
-
-Because the database connection is potentially I/O blocking, this dependency is created with a normal `def` function.
-
-And then, in each *path operation function* that needs to access the database we add it as a dependency.
-
-But we are not using the value given by this dependency (it actually doesn't give any value, as it has an empty `yield`). So, we don't add it to the *path operation function* but to the *path operation decorator* in the `dependencies` parameter:
-
-```Python hl_lines="32  40  47  59  65  72"
-{!./src/sql_databases_peewee/sql_app/main.py!}
-```
-
-### Context variable sub-dependency
-
-For all the `contextvars` parts to work, we need to make sure we have an independent value in the `ContextVar` for each request that uses the database, and that value will be used as the database state (connection, transactions, etc) for the whole request.
-
-For that, we need to create another `async` dependency `reset_db_state()` that is used as a sub-dependency in `get_db()`. It will set the value for the context variable (with just a default `dict`) that will be used as the database state for the whole request. And then the dependency `get_db()` will store in it the database state (connection, transactions, etc).
-
-```Python hl_lines="18 19 20"
-{!./src/sql_databases_peewee/sql_app/main.py!}
-```
-
-For the **next request**, as we will reset that context variable again in the `async` dependency `reset_db_state()` and then create a new connection in the `get_db()` dependency, that new request will have its own database state (connection, transactions, etc).
-
-!!! tip
-    As FastAPI is an async framework, one request could start being processed, and before finishing, another request could be received and start processing as well, and it all could be processed in the same thread.
-
-    But context variables are aware of these async features, so, a Peewee database state set in the `async` dependency `reset_db_state()` will keep its own data throughout the entire request.
-
-    And at the same time, the other concurrent request will have its own database state that will be independent for the whole request.
-
-#### Peewee Proxy
-
-If you are using a <a href="http://docs.peewee-orm.com/en/latest/peewee/database.html#dynamically-defining-a-database" class="external-link" target="_blank">Peewee Proxy</a>, the actual database is at `db.obj`.
-
-So, you would reset it with:
-
-```Python hl_lines="3 4"
-async def reset_db_state():
-    database.db.obj._state._state.set(db_state_default.copy())
-    database.db.obj._state.reset()
-```
-
-### Create your **FastAPI** *path operations*
-
-Now, finally, here's the standard **FastAPI** *path operations* code.
-
-```Python hl_lines="32 33 34 35 36 37  40 41 42 43  46 47 48 49 50 51 52 53  56 57 58 59 60 61 62  65 66 67 68  71 72 73 74 75 76 77 78 79"
-{!./src/sql_databases_peewee/sql_app/main.py!}
-```
-
-### About `def` vs `async def`
-
-The same as with SQLAlchemy, we are not doing something like:
-
-```Python
-user = await models.User.select().first()
-```
-
-...but instead we are using:
-
-```Python
-user = models.User.select().first()
-```
-
-So, again, we should declare the *path operation functions* and the dependency without `async def`, just with a normal `def`, as:
-
-```Python hl_lines="2"
-# Something goes here
-def read_users(skip: int = 0, limit: int = 100):
-    # Something goes here
-```
-
-## Testing Peewee with async
-
-This example includes an extra *path operation* that simulates a long processing request with `time.sleep(sleep_time)`.
-
-It will have the database connection open at the beginning and will just wait some seconds before replying back. And each new request will wait one second less.
-
-This will easily let you test that your app with Peewee and FastAPI is behaving correctly with all the stuff about threads.
-
-If you want to check how Peewee would break your app if used without modification, go the the `sql_app/database.py` file and comment the line:
-
-```Python
-# db._state = PeeweeConnectionState()
-```
-
-And in the file `sql_app/main.py` file, comment the body of the `async` dependency `reset_db_state()` and replace it with a `pass`:
-
-```Python
-async def reset_db_state():
-#     database.db._state._state.set(db_state_default.copy())
-#     database.db._state.reset()
-    pass
-```
-
-Then run your app with Uvicorn:
-
-```bash
-uvicorn sql_app.main:app --reload
-```
-
-Open your browser at <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>  and create a couple of users.
-
-Then open 10 tabs at <a href="http://127.0.0.1:8000/docs#/default/read_slow_users_slowusers__get" class="external-link" target="_blank">http://127.0.0.1:8000/docs#/default/read_slow_users_slowusers__get</a> at the same time.
-
-Go to the *path operation* "Get `/slowusers/`" in all of the tabs. Use the "Try it out" button and execute the request in each tab, one right after the other.
-
-The tabs will wait for a bit and then some of them will show `Internal Server Error`.
-
-### What happens
-
-The first tab will make your app create a connection to the database and wait for some seconds before replying back and closing the database connection.
-
-Then, for the request in the next tab, your app will wait for one second less, and so on.
-
-This means that it will end up finishing some of the last tabs' requests earlier than some of the previous ones.
-
-Then one the last requests that wait less seconds will try to open a database connection, but as one of those previous requests for the other tabs will probably be handled in the same thread as the first one, it will have the same database connection that is already open, and Peewee will throw an error and you will see it in the terminal, and the response will have an `Internal Server Error`.
-
-This will probably happen for more than one of those tabs.
-
-If you had multiple clients talking to your app exactly at the same time, this is what could happen.
-
-And as your app starts to handle more and more clients at the same time, the waiting time in a single request needs to be shorter and shorter to trigger the error.
-
-### Fix Peewee with FastAPI
-
-Now go back to the file `sql_app/database.py`, and uncomment the line:
-
-```Python
-db._state = PeeweeConnectionState()
-```
-
-And in the file `sql_app/main.py` file, uncomment the body of the `async` dependency `reset_db_state()`:
-
-```Python
-async def reset_db_state():
-    database.db._state._state.set(db_state_default.copy())
-    database.db._state.reset()
-```
-
-Terminate your running app and start it again.
-
-Repeat the same process with the 10 tabs. This time all of them will wait and you will get all the results without errors.
-
-...You fixed it!
-
-## Review all the files
-
- Remember you should have a directory named `my_super_project` (or however you want) that contains a sub-directory called `sql_app`.
-
-`sql_app` should have the following files:
-
-* `sql_app/__init__.py`: is an empty file.
-
-* `sql_app/database.py`:
-
-```Python hl_lines=""
-{!./src/sql_databases_peewee/sql_app/database.py!}
-```
-
-* `sql_app/models.py`:
-
-```Python hl_lines=""
-{!./src/sql_databases_peewee/sql_app/models.py!}
-```
-
-* `sql_app/schemas.py`:
-
-```Python hl_lines=""
-{!./src/sql_databases_peewee/sql_app/schemas.py!}
-```
-
-* `sql_app/crud.py`:
-
-```Python hl_lines=""
-{!./src/sql_databases_peewee/sql_app/crud.py!}
-```
-
-* `sql_app/main.py`:
-
-```Python hl_lines=""
-{!./src/sql_databases_peewee/sql_app/main.py!}
-```
-
-## Technical Details
-
-!!! warning
-    These are very technical details that you probably don't need.
-
-### The problem
-
-Peewee uses <a href="https://docs.python.org/3/library/threading.html#thread-local-data" class="external-link" target="_blank">`threading.local`</a> by default to store it's database "state" data (connection, transactions, etc).
-
-`threading.local` creates a value exclusive to the current thread, but an async framework would run all the code (e.g. for each request) in the same thread, and possibly not in order.
-
-On top of that, an async framework could run some sync code in a threadpool (using `asyncio.run_in_executor`), but belonging to the same request.
-
-This means that, with Peewee's current implementation, multiple tasks could be using the same `threading.local` variable and end up sharing the same connection and data (that they shouldn't), and at the same time, if they execute sync I/O-blocking code in a threadpool (as with normal `def` functions in FastAPI, in *path operations*  and dependencies), that code won't have access to the database state variables, even while it's part of the same request and it should be able to get access to the same database state.
-
-### Context variables
-
-Python 3.7 has <a href="https://docs.python.org/3/library/contextvars.html" class="external-link" target="_blank">`contextvars`</a> that can create a local variable very similar to `threading.local`, but also supporting these async features.
-
-There are several things to have in mind.
-
-The `ContextVar` has to be created at the top of the module, like:
-
-```Python
-some_var = ContextVar("some_var", default="default value")
-```
-
-To set a value used in the current "context" (e.g. for the current request) use:
-
-```Python
-some_var.set("new value")
-```
-
-To get a value anywhere inside of the context (e.g. in any part handling the current request) use:
-
-```Python
-some_var.get()
-```
-
-### Set context variables in the `async` dependency `reset_db_state()`
-
-If some part of the async code sets the value with `some_var.set("updated in function")` (e.g. like the `async` dependency), the rest of the code in it and the code that goes after (including code inside of `async` functions called with `await`) will see that new value.
-
-So, in our case, if we set the Peewee state variable (with a default `dict`) in the `async` dependency, all the rest of the internal code in our app will see this value and will be able to reuse it for the whole request.
-
-And the context variable would be set again for the next request, even if they are concurrent.
-
-### Set database state in the dependency `get_db()`
-
-As `get_db()` is a normal `def` function, **FastAPI** will make it run in a threadpool, with a *copy* of the "context", holding the same value for the context variable (the `dict` with the reset database state). Then it can add database state to that `dict`, like the connection, etc.
-
-But if the value of the context variable (the default `dict`) was set in that normal `def` function, it would create a new value that would stay only in that thread of the threadpool, and the rest of the code (like the *path operation functions*) wouldn't have access to it. In `get_db()` we can only set values in the `dict`, but not the entire `dict` itself.
-
-So, we need to have the `async` dependency `reset_db_state()` to set the `dict` in the context variable. That way, all the code has access to the same `dict` for the database state for a single request.
-
-### Connect and disconnect in the dependency `get_db()`
-
-Then the next question would be, why not just connect and disconnect the database in the `async` dependency itself, instead of in `get_db()`?
-
-The `async` dependency has to be `async` for the context variable to be preserved for the rest of the request, but creating and closing the database connection is potentially blocking, so it could degrade performance if it was there.
-
-So we also need the normal `def` dependency `get_db()`.

docs/advanced/sub-applications-proxy.md

@@ -1,92 +0,0 @@
-There are at least two situations where you could need to create your **FastAPI** application using some specific paths.
-
-But then you need to set them up to be served with a path prefix.
-
-It could happen if you have a:
-
-* **Proxy** server.
-* You are "**mounting**" a FastAPI application inside another FastAPI application (or inside another ASGI application, like Starlette).
-
-## Proxy
-
-Having a proxy in this case means that you could declare a path at `/app`, but then, you could need to add a layer on top (the Proxy) that would put your **FastAPI** application under a path like `/api/v1`.
-
-In this case, the original path `/app` will actually be served at `/api/v1/app`.
-
-Even though your application "thinks" it is serving at `/app`.
-
-And the Proxy could be re-writing the path "on the fly" to keep your application convinced that it is serving at `/app`.
-
-Up to here, everything would work as normally.
-
-But then, when you open the integrated docs, they would expect to get the OpenAPI schema at `/openapi.json`, instead of `/api/v1/openapi.json`.
-
-So, the frontend (that runs in the browser) would try to reach `/openapi.json` and wouldn't be able to get the OpenAPI schema.
-
-So, it's needed that the frontend looks for the OpenAPI schema at `/api/v1/openapi.json`.
-
-And it's also needed that the returned JSON OpenAPI schema has the defined path at `/api/v1/app` (behind the proxy) instead of `/app`.
-
----
-
-For these cases, you can declare an `openapi_prefix` parameter in your `FastAPI` application.
-
-See the section below, about "mounting", for an example.
-
-## Mounting a **FastAPI** application
-
-"Mounting" means adding a complete "independent" application in a specific path, that then takes care of handling all the sub-paths.
-
-You could want to do this if you have several "independent" applications that you want to separate, having their own independent OpenAPI schema and user interfaces.
-
-### Top-level application
-
-First, create the main, top-level, **FastAPI** application, and its *path operations*:
-
-```Python hl_lines="3 6 7 8"
-{!./src/sub_applications/tutorial001.py!}
-```
-
-### Sub-application
-
-Then, create your sub-application, and its *path operations*.
-
-This sub-application is just another standard FastAPI application, but this is the one that will be "mounted".
-
-When creating the sub-application, use the parameter `openapi_prefix`. In this case, with a prefix of `/subapi`:
-
-```Python hl_lines="11 14 15 16"
-{!./src/sub_applications/tutorial001.py!}
-```
-
-### Mount the sub-application
-
-In your top-level application, `app`, mount the sub-application, `subapi`.
-
-Here you need to make sure you use the same path that you used for the `openapi_prefix`, in this case, `/subapi`:
-
-```Python hl_lines="11 19"
-{!./src/sub_applications/tutorial001.py!}
-```
-
-## Check the automatic API docs
-
-Now, run `uvicorn`, if your file is at `main.py`, it would be:
-
-```bash
-uvicorn main:app --reload
-```
-
-And open the docs at <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
-
-You will see the automatic API docs for the main app, including only its own paths:
-
-<img src="/img/tutorial/sub-applications/image01.png">
-
-And then, open the docs for the sub-application, at <a href="http://127.0.0.1:8000/subapi/docs" class="external-link" target="_blank">http://127.0.0.1:8000/subapi/docs</a>.
-
-You will see the automatic API docs for the sub-application, including only its own sub-paths, with their correct prefix:
-
-<img src="/img/tutorial/sub-applications/image02.png">
-
-If you try interacting with any of the two user interfaces, they will work, because the browser will be able to talk to the correct path (or sub-path).

docs/advanced/templates.md

@@ -1,67 +0,0 @@
-You can use any template engine you want with **FastAPI**.
-
-A common election is Jinja2, the same one used by Flask and other tools.
-
-Starlette has utilities to configure it easily that you can use directly in your **FastAPI** application.
-
-## Install dependencies
-
-Install `jinja2`:
-
-```bash
-pip install jinja2
-```
-
-If you need to also serve static files (as in this example), install `aiofiles`:
-
-```bash
-pip install aiofiles
-```
-
-## Using `Jinja2Templates`
-
-* Import `Jinja2Templates` form Starlette.
-* Create a `templates` object that you can re-use later.
-* Declare a `Request` parameter in the *path operation* that will return a template.
-* Use the `templates` you created to render and return a `TemplateResponse`, passing the `request` as one of the key-value pairs in the Jinja2 "context".
-
-```Python hl_lines="4 11 15 16"
-{!./src/templates/tutorial001.py!}
-```
-
-!!! note
-    Notice that you have to pass the `request` as part of the key-value pairs in the context for Jinja2. So, you also have to declare it in your *path operation*.
-
-## Writing templates
-
-Then you can write a template at `templates/item.html` with:
-
-```jinja hl_lines="7"
-{!./src/templates/templates/item.html!}
-```
-
-It will show the `id` taken from the "context" `dict` you passed:
-
-```Python
-{"request": request, "id": id}
-```
-
-## Templates and static files
-
-And you can also use `url_for()` inside of the template, and use it, for example, with the `StaticFiles` you mounted.
-
-```jinja hl_lines="4"
-{!./src/templates/templates/item.html!}
-```
-
-In this example, it would link to a CSS file at `static/styles.css` with:
-
-```CSS hl_lines="4"
-{!./src/templates/static/styles.css!}
-```
-
-And because you are using `StaticFiles`, that CSS file would be served automatically by your **FastAPI** application at the URL `/static/styles.css`.
-
-## More details
-
-For more details, including how to test templates, check <a href="https://www.starlette.io/templates/" class="external-link" target="_blank">Starlette's docs on templates</a>.

docs/advanced/testing-dependencies.md

@@ -1,59 +0,0 @@
-## Overriding dependencies during testing
-
-There are some scenarios where you might want to override a dependency during testing.
-
-You don't want the original dependency to run (nor any of the sub-dependencies it might have).
-
-Instead, you want to provide a different dependency that will be used only during tests (possibly only some specific tests), and will provide a value that can be used where the value of the original dependency was used.
-
-### Use cases: external service
-
-An example could be that you have an external authentication provider that you need to call.
-
-You send it a token and it returns an authenticated user.
-
-This provider might be charging you per request, and calling it might take some extra time than if you had a fixed mock user for tests.
-
-You probably want to test the external provider once, but not necessarily call it for every test that runs.
-
-In this case, you can override the dependency that calls that provider, and use a custom dependency that returns a mock user, only for your tests.
-
-### Use case: testing database
-
-Other example could be that you are using a specific database only for testing.
-
-Your normal dependency would return a database session.
-
-But then, after each test, you could want to rollback all the operations or remove data.
-
-Or you could want to alter the data before the tests run, etc.
-
-In this case, you could use a dependency override to return your *custom* database session instead of the one that would be used normally.
-
-### Use the `app.dependency_overrides` attribute
-
-For these cases, your **FastAPI** application has an attribute `app.dependency_overrides`, it is a simple `dict`.
-
-To override a dependency for testing, you put as a key the original dependency (a function), and as the value, your dependency override (another function).
-
-And then **FastAPI** will call that override instead of the original dependency.
-
-```Python hl_lines="24 25 28"
-{!./src/dependency_testing/tutorial001.py!}
-```
-
-!!! tip
-    You can set a dependency override for a dependency used anywhere in your **FastAPI** application.
-
-    The original dependency could be used in a *path operation function*, a *path operation decorator* (when you don't use the return value), a `.include_router()` call, etc.
-
-    FastAPI will still be able to override it.
-
-Then you can reset your overrides (remove them) by setting `app.dependency_overrides` to be an empty `dict`:
-
-```Python
-app.dependency_overrides = {}
-```
-
-!!! tip
-    If you want to override a dependency only during some tests, you can set the override at the beginning of the test (inside the test function) and reset it at the end (at the end of the test function).

docs/advanced/testing-events.md

@@ -1,7 +0,0 @@
-## Testing Events, `startup` and `shutdown`
-
-When you need your event handlers (`startup` and `shutdown`) to run in your tests, you can use the `TestClient` with a `with` statement:
-
-```Python hl_lines="9 10 11 12 20 21 22 23 24"
-{!./src/app_testing/tutorial003.py!}
-```

docs/advanced/testing-websockets.md

@@ -1,9 +0,0 @@
-## Testing WebSockets
-
-You can use the same `TestClient` to test WebSockets.
-
-For this, you use the `TestClient` in a `with` statement, connecting to the WebSocket:
-
-```Python hl_lines="27 28 29 30 31"
-{!./src/app_testing/tutorial002.py!}
-```

docs/advanced/using-request-directly.md

@@ -1,55 +0,0 @@
-Up to now, you have been declaring the parts of the request that you need with their types.
-
-Taking data from:
-
-* The path as parameters.
-* Headers.
-* Cookies.
-* etc.
-
-And by doing so, **FastAPI** is validating that data, converting it and generating documentation for your API automatically.
-
-But there are situations where you might need to access the `Request` object directly.
-
-## Details about the `Request` object
-
-As **FastAPI** is actually **Starlette** underneath, with a layer of several tools on top, you can use Starlette's <a href="https://www.starlette.io/requests/" class="external-link" target="_blank">`Request`</a> object directly when you need to.
-
-It would also mean that if you get data from the `Request` object directly (for example, read the body) it won't be validated, converted or annotated (with OpenAPI, for the automatic documentation) by FastAPI.
-
-Although any other parameter declared normally (for example, the body with a Pydantic model) would still be validated, converted, annotated, etc.
-
-But there are specific cases where it's useful to get the `Request` object.
-
-## Use the `Request` object directly
-
-Let's imagine you want to get the client's IP address/host inside of your *path operation function*.
-
-For that you need to access the request directly.
-
-### Import the `Request`
-
-First, import the `Request` class from Starlette:
-
-```Python hl_lines="2"
-{!./src/using_request_directly/tutorial001.py!}
-```
-
-### Declare the `Request` parameter
-
-Then declare a *path operation function* parameter with the type being the `Request` class:
-
-```Python hl_lines="8"
-{!./src/using_request_directly/tutorial001.py!}
-```
-
-!!! tip
-    Note that in this case, we are declaring a path parameter besides the request parameter.
-
-    So, the path parameter will be extracted, validated, converted to the specified type and annotated with OpenAPI.
-
-    The same way, you can declare any other parameter as normally, and additionally, get the `Request` too.
-
-## `Request` documentation
-
-You can read more details about the <a href="https://www.starlette.io/requests/" class="external-link" target="_blank">`Request` object in the official Starlette documentation site</a>.

docs/advanced/websockets.md

@@ -1,109 +0,0 @@
-
-You can use <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API" class="external-link" target="_blank">WebSockets</a> with **FastAPI**.
-
-## WebSockets client
-
-### In production
-
-In your production system, you probably have a frontend created with a modern framework like React, Vue.js or Angular.
-
-And to communicate using WebSockets with your backend you would probably use your frontend's utilities.
-
-Or you might have a native mobile application that communicates with your WebSocket backend directly, in native code.
-
-Or you might have any other way to communicate with the WebSocket endpoint.
-
----
-
-But for this example, we'll use a very simple HTML document with some JavaScript, all inside a long string.
-
-This, of course, is not optimal and you wouldn't use it for production.
-
-In production you would have one of the options above.
-
-But it's the simplest way to focus on the server-side of WebSockets and have a working example:
-
-```Python hl_lines="2 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 42 43 44"
-{!./src/websockets/tutorial001.py!}
-```
-
-## Create a `websocket`
-
-In your **FastAPI** application, create a `websocket`:
-
-```Python hl_lines="3 47 48"
-{!./src/websockets/tutorial001.py!}
-```
-
-!!! tip
-    In this example we are importing `WebSocket` from `starlette.websockets` to use it in the type declaration in the WebSocket route function.
-
-## Await for messages and send messages
-
-In your WebSocket route you can `await` for messages and send messages.
-
-```Python hl_lines="49 50 51 52 53"
-{!./src/websockets/tutorial001.py!}
-```
-
-You can receive and send binary, text, and JSON data.
-
-## Using `Depends` and others
-
-In WebSocket endpoints you can import from `fastapi` and use:
-
-* `Depends`
-* `Security`
-* `Cookie`
-* `Header`
-* `Path`
-* `Query`
-
-They work the same way as for other FastAPI endpoints/*path operations*:
-
-```Python hl_lines="55 56 57 58 59 60 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78"
-{!./src/websockets/tutorial002.py!}
-```
-
-!!! info
-    In a WebSocket it doesn't really make sense to raise an `HTTPException`. So it's better to close the WebSocket connection directly.
-
-    You can use a closing code from the <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1" class="external-link" target="_blank">valid codes defined in the specification</a>.
-
-    In the future, there will be a `WebSocketException` that you will be able to `raise` from anywhere, and add exception handlers for it. It depends on the <a href="https://github.com/encode/starlette/pull/527" class="external-link" target="_blank">PR #527</a> in Starlette.
-
-## More info
-
-To learn more about the options, check Starlette's documentation for:
-
-* <a href="https://www.starlette.io/applications/" class="external-link" target="_blank">Applications (`websocket_route`)</a>.
-* <a href="https://www.starlette.io/websockets/" class="external-link" target="_blank">The `WebSocket` class</a>.
-* <a href="https://www.starlette.io/endpoints/#websocketendpoint" class="external-link" target="_blank">Class-based WebSocket handling</a>.
-
-## Test it
-
-If your file is named `main.py`, run your application with:
-
-```bash
-uvicorn main:app --reload
-```
-
-Open your browser at <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000</a>.
-
-You will see a simple page like:
-
-<img src="/img/tutorial/websockets/image01.png">
-
-You can type messages in the input box, and send them:
-
-<img src="/img/tutorial/websockets/image02.png">
-
-And your **FastAPI** application with WebSockets will respond back:
-
-<img src="/img/tutorial/websockets/image03.png">
-
-You can send (and receive) many messages:
-
-<img src="/img/tutorial/websockets/image04.png">
-
-And all of them will use the same WebSocket connection.

docs/alternatives.md

@@ -1,415 +0,0 @@
-What inspired **FastAPI**, how it compares to other alternatives and what it learned from them.
-
-## Intro
-
-**FastAPI** wouldn't exist if not for the previous work of others.
-
-There have been many tools created before that have helped inspire its creation.
-
-I have been avoiding the creation of a new framework for several years. First I tried to solve all the features covered by **FastAPI** using many different frameworks, plug-ins, and tools.
-
-But at some point, there was no other option than creating something that provided all these features, taking the best ideas from previous tools, and combining them in the best way possible, using language features that weren't even available before (Python 3.6+ type hints).
-
-## Previous tools
-
-### <a href="https://www.djangoproject.com/" class="external-link" target="_blank">Django</a>
-
-It's the most popular Python framework and is widely trusted. It is used to build systems like Instagram.
-
-It's relatively tightly coupled with relational databases (like MySQL or PostgreSQL), so, having a NoSQL database (like Couchbase, MongoDB, Cassandra, etc) as the main store engine is not very easy.
-
-It was created to generate the HTML in the backend, not to create APIs used by a modern frontend (like React, Vue.js and Angular) or by other systems (like <abbr title="Internet of Things">IoT</abbr> devices) communicating with it.
-
-### <a href="https://www.django-rest-framework.org/" class="external-link" target="_blank">Django REST Framework</a>
-
-Django REST framework was created to be a flexible toolkit for building Web APIs using Django underneath, to improve its API capabilities.
-
-It is used by many companies including Mozilla, Red Hat and Eventbrite.
-
-It was one of the first examples of **automatic API documentation**, and this was specifically one of the first ideas that inspired "the search for" **FastAPI**.
-
-!!! note
-    Django REST Framework was created by Tom Christie. The same creator of Starlette and Uvicorn, on which **FastAPI** is based.
-
-
-!!! check "Inspired **FastAPI** to"
-    Have an automatic API documentation web user interface.
-
-### <a href="http://flask.pocoo.org/" class="external-link" target="_blank">Flask</a>
-
-Flask is a "microframework", it doesn't include database integrations nor many of the things that come by default in Django.
-
-This simplicity and flexibility allow doing things like using NoSQL databases as the main data storage system.
-
-As it is very simple, it's relatively intuitive to learn, although the documentation gets somewhat technical at some points.
-
-It is also commonly used for other applications that don't necessarily need a database, user management, or any of the many features that come pre-built in Django. Although many of these features can be added with plug-ins.
-
-This decoupling of parts, and being a "microframework" that could be extended to cover exactly what is needed was a key feature that I wanted to keep.
-
-Given the simplicity of Flask, it seemed like a good match for building APIs. The next thing to find was a "Django REST Framework" for Flask.
-
-!!! check "Inspired **FastAPI** to"
-    Be a micro-framework. Making it easy to mix and match the tools and parts needed.
-
-    Have a simple and easy to use routing system.
-
-
-### <a href="http://docs.python-requests.org" class="external-link" target="_blank">Requests</a>
-
-**FastAPI** is not actually an alternative to **Requests**. Their scope is very different.
-
-It would actually be common to use Requests *inside* of a FastAPI application.
-
-But still, FastAPI got quite some inspiration from Requests.
-
-**Requests** is a library to *interact* with APIs (as a client), while **FastAPI** is a library to *build* APIs (as a server).
-
-They are, more or less, at opposite ends, complementing each other.
-
-Requests has a very simple and intuitive design, it's very easy to use, with sensible defaults. But at the same time, it's very powerful and customizable.
-
-That's why, as said in the official website:
-
-> Requests is one of the most downloaded Python packages of all time
-
-The way you use it is very simple. For example, to do a `GET` request, you would write:
-
-```Python
-response = requests.get("http://example.com/some/url")
-```
-
-The FastAPI counterpart API *path operation* could look like:
-
-```Python hl_lines="1"
-@app.get("/some/url")
-def read_url():
-    return {"message": "Hello World"}
-```
-
-See the similarities in `requests.get(...)` and `@app.get(...)`.
-
-!!! check "Inspired **FastAPI** to"
-    * Have a simple and intuitive API.
-    * Use HTTP method names (operations) directly, in a straightforward and intuitive way.
-    * Have sensible defaults, but powerful customizations.
-
-
-### <a href="https://swagger.io/" class="external-link" target="_blank">Swagger</a> / <a href="https://github.com/OAI/OpenAPI-Specification/" class="external-link" target="_blank">OpenAPI</a>
-
-The main feature I wanted from Django REST Framework was the automatic API documentation.
-
-Then I found that there was a standard to document APIs, using JSON (or YAML, an extension of JSON) called Swagger.
-
-And there was a web user interface for Swagger APIs already created. So, being able to generate Swagger documentation for an API would allow using this web user interface automatically.
-
-At some point, Swagger was given to the Linux Foundation, to be renamed OpenAPI.
-
-That's why when talking about version 2.0 it's common to say "Swagger", and for version 3+ "OpenAPI".
-
-!!! check "Inspired **FastAPI** to"
-    Adopt and use an open standard for API specifications, instead of a custom schema.
-
-    And integrate standards-based user interface tools:
-
-    * <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>
-    * <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a>
-
-    These two were chosen for being fairly popular and stable, but doing a quick search, you could find dozens of additional alternative user interfaces for OpenAPI (that you can use with **FastAPI**).
-
-### Flask REST frameworks
-
-There are several Flask REST frameworks, but after investing the time and work into investigating them, I found that many are discontinued or abandoned, with several standing issues that made them unfit.
-
-### <a href="https://marshmallow.readthedocs.io/en/3.0/" class="external-link" target="_blank">Marshmallow</a>
-
-One of the main features needed by API systems is data "<abbr title="also called marshalling, conversion">serialization</abbr>" which is taking data from the code (Python) and converting it into something that can be sent through the network. For example, converting an object containing data from a database into a JSON object. Converting `datetime` objects into strings, etc.
-
-Another big feature needed by APIs is data validation, making sure that the data is valid, given certain parameters. For example, that some field is an `int`, and not some random string. This is especially useful for incoming data.
-
-Without a data validation system, you would have to do all the checks by hand, in code.
-
-These features are what Marshmallow was built to provide. It is a great library, and I have used it a lot before.
-
-But it was created before there existed Python type hints. So, to define every <abbr title="the definition of how data should be formed">schema</abbr> you need to use specific utils and classes provided by Marshmallow.
-
-!!! check "Inspired **FastAPI** to"
-    Use code to define "schemas" that provide data types and validation, automatically.
-
-### <a href="https://webargs.readthedocs.io/en/latest/" class="external-link" target="_blank">Webargs</a>
-
-Another big feature required by APIs is <abbr title="reading and converting to Python data">parsing</abbr> data from incoming requests.
-
-Webargs is a tool that was made to provide that on top of several frameworks, including Flask.
-
-It uses Marshmallow underneath to do the data validation. And it was created by the same developers.
-
-It's a great tool and I have used it a lot too, before having **FastAPI**.
-
-!!! info
-    Webargs was created by the same Marshmallow developers.
-
-!!! check "Inspired **FastAPI** to"
-    Have automatic validation of incoming request data.
-
-### <a href="https://apispec.readthedocs.io/en/stable/" class="external-link" target="_blank">APISpec</a>
-
-Marshmallow and Webargs provide validation, parsing and serialization as plug-ins.
-
-But documentation is still missing. Then APISpec was created.
-
-It is a plug-in for many frameworks (and there's a plug-in for Starlette too).
-
-The way it works is that you write the definition of the schema using YAML format inside the docstring of each function handling a route.
-
-And it generates OpenAPI schemas.
-
-That's how it works in Flask, Starlette, Responder, etc.
-
-But then, we have again the problem of having a micro-syntax, inside of a Python string (a big YAML).
-
-The editor can't help much with that. And if we modify parameters or Marshmallow schemas and forget to also modify that YAML docstring, the generated schema would be obsolete.
-
-!!! info
-    APISpec was created by the same Marshmallow developers.
-
-
-!!! check "Inspired **FastAPI** to"
-    Support the open standard for APIs, OpenAPI.
-
-### <a href="https://flask-apispec.readthedocs.io/en/latest/" class="external-link" target="_blank">Flask-apispec</a>
-
-It's a Flask plug-in, that ties together Webargs, Marshmallow and APISpec.
-
-It uses the information from Webargs and Marshmallow to automatically generate OpenAPI schemas, using APISpec.
-
-It's a great tool, very under-rated. It should be way more popular than many Flask plug-ins out there. It might be due to its documentation being too concise and abstract.
-
-This solved having to write YAML (another syntax) inside of Python docstrings.
-
-This combination of Flask, Flask-apispec with Marshmallow and Webargs was my favorite backend stack until building **FastAPI**.
-
-Using it led to the creation of several Flask full-stack generators. These are the main stack I (and several external teams) have been using up to now:
-
-* <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>
-
-And these same full-stack generators were the base of the [**FastAPI** Project Generators](project-generation.md){.internal-link target=_blank}.
-
-!!! info
-    Flask-apispec was created by the same Marshmallow developers.
-
-!!! check "Inspired **FastAPI** to"
-    Generate the OpenAPI schema automatically, from the same code that defines serialization and validation.
-
-### <a href="https://nestjs.com/" class="external-link" target="_blank">NestJS</a> (and <a href="https://angular.io/" class="external-link" target="_blank">Angular</a>)
-
-This isn't even Python, NestJS is a JavaScript (TypeScript) NodeJS framework inspired by Angular.
-
-It achieves something somewhat similar to what can be done with Flask-apispec.
-
-It has an integrated dependency injection system, inspired by Angular two. It requires pre-registering the "injectables" (like all the other dependency injection systems I know), so, it adds to the verbosity and code repetition.
-
-As the parameters are described with TypeScript types (similar to Python type hints), editor support is quite good.
-
-But as TypeScript data is not preserved after compilation to JavaScript, it cannot rely on the types to define validation, serialization and documentation at the same time. Due to this and some design decisions, to get validation, serialization and automatic schema generation, it's needed to add decorators in many places. So, it becomes quite verbose.
-
-It can't handle nested models very well. So, if the JSON body in the request is a JSON object that has inner fields that in turn are nested JSON objects, it cannot be properly documented and validated.
-
-!!! check "Inspired **FastAPI** to"
-    Use Python types to have great editor support.
-
-    Have a powerful dependency injection system. Find a way to minimize code repetition.
-
-### <a href="https://sanic.readthedocs.io/en/latest/" class="external-link" target="_blank">Sanic</a>
-
-It was one of the first extremely fast Python frameworks based on `asyncio`. It was made to be very similar to Flask.
-
-!!! note "Technical Details"
-    It used <a href="https://github.com/MagicStack/uvloop" class="external-link" target="_blank">`uvloop`</a> instead of the default Python `asyncio` loop. That's what made it so fast.
-
-    It clearly inspired Uvicorn and Starlette, that are currently faster than Sanic in open benchmarks.
-
-!!! check "Inspired **FastAPI** to"
-    Find a way to have a crazy performance.
-    
-    That's why **FastAPI** is based on Starlette, as it is the fastest framework available (tested by third-party benchmarks).
-
-### <a href="https://falconframework.org/" class="external-link" target="_blank">Falcon</a>
-
-Falcon is another high performance Python framework, it is designed to be minimal, and work as the foundation of other frameworks like Hug.
-
-It uses the previous standard for Python web frameworks (WSGI) which is synchronous, so it can't handle WebSockets and other use cases. Nevertheless, it also has a very good performance.
-
-It is designed to have functions that receive two parameters, one "request" and one "response". Then you "read" parts from the request, and "write" parts to the response. Because of this design, it is not possible to declare request parameters and bodies with standard Python type hints as function parameters.
-
-So, data validation, serialization, and documentation, have to be done in code, not automatically. Or they have to be implemented as a framework on top of Falcon, like Hug. This same distinction happens in other frameworks that are inspired by Falcon's design, of having one request object and one response object as parameters.
-
-!!! check "Inspired **FastAPI** to"
-    Find ways to get great performance.
-
-    Along with Hug (as Hug is based on Falcon) inspired **FastAPI** to declare a `response` parameter in functions.
-
-    Although in FastAPI it's optional, and is used mainly to set headers, cookies, and alternative status codes.
-
-### <a href="https://moltenframework.com/" class="external-link" target="_blank">Molten</a>
-
-I discovered Molten in the first stages of building **FastAPI**. And it has quite similar ideas:
-
-* Based on Python type hints.
-* Validation and documentation from these types.
-* Dependency Injection system.
-
-It doesn't use a data validation, serialization and documentation third-party library like Pydantic, it has its own. So, these data type definitions would not be reusable as easily.
-
-It requires a little bit more verbose configurations. And as it is based on WSGI (instead of ASGI), it is not designed to take advantage of the high-performance provided by tools like Uvicorn, Starlette and Sanic.
-
-The dependency injection system requires pre-registration of the dependencies and the dependencies are solved based on the declared types. So, it's not possible to declare more than one "component" that provides a certain type.
-
-Routes are declared in a single place, using functions declared in other places (instead of using decorators that can be placed right on top of the function that handles the endpoint). This is closer to how Django does it than to how Flask (and Starlette) does it. It separates in the code things that are relatively tightly coupled.
-
-!!! check "Inspired **FastAPI** to"
-    Define extra validations for data types using the "default" value of model attributes. This improves editor support, and it was not available in Pydantic before.
-
-    This actually inspired updating parts of Pydantic, to support the same validation declaration style (all this functionality is now already available in Pydantic).
-
-### <a href="http://www.hug.rest/" class="external-link" target="_blank">Hug</a>
-
-Hug was one of the first frameworks to implement the declaration of API parameter types using Python type hints. This was a great idea that inspired other tools to do the same.
-
-It used custom types in its declarations instead of standard Python types, but it was still a huge step forward.
-
-It also was one of the first frameworks to generate a custom schema declaring the whole API in JSON.
-
-It was not based on a standard like OpenAPI and JSON Schema. So it wouldn't be straightforward to integrate it with other tools, like Swagger UI. But again, it was a very innovative idea.
-
-It has an interesting, uncommon feature: using the same framework, it's possible to create APIs and also CLIs.
-
-As it is based on the previous standard for synchronous Python web frameworks (WSGI), it can't handle Websockets and other things, although it still has high performance too.
-
-!!! info
-    Hug was created by Timothy Crosley, the same creator of <a href="https://github.com/timothycrosley/isort" class="external-link" target="_blank">`isort`</a>, a great tool to automatically sort imports in Python files.
-
-!!! check "Ideas inspired in **FastAPI**"
-    Hug inspired parts of APIStar, and was one of the tools I found most promising, alongside APIStar.
-
-    Hug helped inspiring **FastAPI** to use Python type hints to declare parameters, and to generate a schema defining the API automatically.
-
-    Hug inspired **FastAPI** to declare a `response` parameter in functions to set headers and cookies.
-
-### <a href="https://github.com/encode/apistar" class="external-link" target="_blank">APIStar</a> (<= 0.5)
-
-Right before deciding to build **FastAPI** I found **APIStar** server. It had almost everything I was looking for and had a great design.
-
-It was one of the first implementations of a framework using Python type hints to declare parameters and requests that I ever saw (before NestJS and Molten). I found it more or less at the same time as Hug. But APIStar used the OpenAPI standard.
-
-It had automatic data validation, data serialization and OpenAPI schema generation based on the same type hints in several places.
-
-Body schema definitions didn't use the same Python type hints like Pydantic, it was a bit more similar to Marshmallow, so, editor support wouldn't be as good, but still, APIStar was the best available option.
-
-It had the best performance benchmarks at the time (only surpassed by Starlette).
-
-At first, it didn't have an automatic API documentation web UI, but I knew I could add Swagger UI to it.
-
-It had a dependency injection system. It required pre-registration of components, as other tools discussed above. But still, it was a great feature.
-
-I was never able to use it in a full project, as it didn't have security integration, so, I couldn't replace all the features I was having with the full-stack generators based on Flask-apispec. I had in my backlog of projects to create a pull request adding that functionality.
-
-But then, the project's focus shifted.
-
-It was no longer an API web framework, as the creator needed to focus on Starlette.
-
-Now APIStar is a set of tools to validate OpenAPI specifications, not a web framework.
-
-!!! info
-    APIStar was created by Tom Christie. The same guy that created:
-
-    * Django REST Framework
-    * Starlette (in which **FastAPI** is based)
-    * Uvicorn (used by Starlette and **FastAPI**)
-
-!!! check "Inspired **FastAPI** to"
-    Exist.
-
-    The idea of declaring multiple things (data validation, serialization and documentation) with the same Python types, that at the same time provided great editor support, was something I considered a brilliant idea.
-    
-    And after searching for a long time for a similar framework and testing many different alternatives, APIStar was the best option available.
-
-    Then APIStar stopped to exist as a server and Starlette was created, and was a new better foundation for such a system. That was the final inspiration to build **FastAPI**.
-
-    I consider **FastAPI** a "spiritual successor" to APIStar, while improving and increasing the features, typing system, and other parts, based on the learnings from all these previous tools.
-
-## Used by **FastAPI**
-
-### <a href="https://pydantic-docs.helpmanual.io/" class="external-link" target="_blank">Pydantic</a>
-
-Pydantic is a library to define data validation, serialization and documentation (using JSON Schema) based on Python type hints.
-
-That makes it extremely intuitive.
-
-It is comparable to Marshmallow. Although it's faster than Marshmallow in benchmarks. And as it is based on the same Python type hints, the editor support is great.
-
-!!! check "**FastAPI** uses it to"
-    Handle all the data validation, data serialization and automatic model documentation (based on JSON Schema).
-
-    **FastAPI** then takes that JSON Schema data and puts it in OpenAPI, apart from all the other things it does.
-
-### <a href="https://www.starlette.io/" class="external-link" target="_blank">Starlette</a>
-
-Starlette is a lightweight <abbr title="The new standard for building asynchronous Python web">ASGI</abbr> framework/toolkit, which is ideal for building high-performance asyncio services.
-
-It is very simple and intuitive. It's designed to be easily extensible, and have modular components.
-
-It has:
-
-* Seriously impressive performance.
-* WebSocket support.
-* GraphQL support.
-* In-process background tasks.
-* Startup and shutdown events.
-* Test client built on requests.
-* CORS, GZip, Static Files, Streaming responses.
-* Session and Cookie support.
-* 100% test coverage.
-* 100% type annotated codebase.
-* Zero hard dependencies.
-
-Starlette is currently the fastest Python framework tested. Only surpassed by Uvicorn, which is not a framework, but a server.
-
-Starlette provides all the basic web microframework functionality.
-
-But it doesn't provide automatic data validation, serialization or documentation.
-
-That's one of the main things that **FastAPI** adds on top, all based on Python type hints (using Pydantic). That, plus the dependency injection system, security utilities, OpenAPI schema generation, etc.
-
-!!! note "Technical Details"
-    ASGI is a new "standard" being developed by Django core team members. It is still not a "Python standard" (a PEP), although they are in the process of doing that.
-
-    Nevertheless, it is already being used as a "standard" by several tools. This greatly improves interoperability, as you could switch Uvicorn for any other ASGI server (like Daphne or Hypercorn), or you could add ASGI compatible tools, like `python-socketio`.
-
-!!! check "**FastAPI** uses it to"
-    Handle all the core web parts. Adding features on top.
-
-    The class `FastAPI` itself inherits directly from the class `Starlette`.
-    
-    So, anything that you can do with Starlette, you can do it directly with **FastAPI**, as it is basically Starlette on steroids.
-
-### <a href="https://www.uvicorn.org/" class="external-link" target="_blank">Uvicorn</a>
-
-Uvicorn is a lightning-fast ASGI server, built on uvloop and httptools.
-
-It is not a web framework, but a server. For example, it doesn't provide tools for routing by paths. That's something that a framework like Starlette (or **FastAPI**) would provide on top.
-
-It is the recommended server for Starlette and **FastAPI**.
-
-!!! check "**FastAPI** recommends it as"
-    The main web server to run **FastAPI** applications.
-
-    You can combine it with Gunicorn, to have an asynchronous multi-process server.
-
-    Check more details in the [Deployment](deployment.md){.internal-link target=_blank} section.
-
-## Benchmarks and speed
-
-To understand, compare, and see the difference between Uvicorn, Starlette and FastAPI, check the section about [Benchmarks](benchmarks.md){.internal-link target=_blank}.

docs/async.md

@@ -1,390 +0,0 @@
-Details about the `async def` syntax for *path operation functions* and some background about asynchronous code, concurrency, and parallelism.
-
-## In a hurry?
-
-<abbr title="too long; didn't read"><strong>TL;DR:</strong></abbr>
-
-If you are using third party libraries that tell you to call them with `await`, like:
-
-```Python
-results = await some_library()
-```
-
-Then, declare your *path operation functions* with `async def` like:
-
-```Python hl_lines="2"
-@app.get('/')
-async def read_results():
-    results = await some_library()
-    return results
-```
-
-!!! note
-    You can only use `await` inside of functions created with `async def`.
-
----
-
-If you are using a third party library that communicates with something (a database, an API, the file system, etc) and doesn't have support for using `await`, (this is currently the case for most database libraries), then declare your *path operation functions* as normally, with just `def`, like:
-
-```Python hl_lines="2"
-@app.get('/')
-def results():
-    results = some_library()
-    return results
-```
-
----
-
-If your application (somehow) doesn't have to communicate with anything else and wait for it to respond, use `async def`.
-
----
-
-If you just don't know, use normal `def`.
-
----
-
-**Note**: you can mix `def` and `async def` in your *path operation functions* as much as you need and define each one using the best option for you. FastAPI will do the right thing with them.
-
-Anyway, in any of the cases above, FastAPI will still work asynchronously and be extremely fast.
-
-But by following the steps above, it will be able to do some performance optimizations.
-
-## Technical Details
-
-Modern versions of Python have support for **"asynchronous code"** using something called **"coroutines"**, with **`async` and `await`** syntax.
-
-Let's see that phrase by parts in the sections below, below:
-
-* **Asynchronous Code**
-* **`async` and `await`**
-* **Coroutines**
-
-## Asynchronous Code
-
-Asynchronous code just means that the language has a way to tell the computer / program that at some point in the code, he will have to wait for *something else* to finish somewhere else. Let's say that *something else* is called "slow-file". 
-
-So, during that time, the computer can go and do some other work, while "slow-file" finishes. 
-
-Then the computer / program will come back every time it has a chance because it's waiting again, or whenever he finished all the work he had at that point. And it will see if any of the tasks he was waiting for has already finished doing whatever it had to do.
-
-And then it takes the first task to finish (let's say, our "slow-file") and continues whatever it had to do with it.
-
-That "wait for something else" normally refers to <abbr title="Input and Output">I/O</abbr> operations that are relatively "slow" (compared to the speed of the processor and the RAM memory), like waiting for:
-
-* the data from the client to be sent through the network
-* the data sent by your program to be received by the client through the network
-* the contents of a file in the disk to be read by the system and given to your program
-* the contents your program gave to the system to be written to disk
-* a remote API operation
-* a database operation to finish
-* a database query to return the results
-* etc.
-
-As the execution time is consumed mostly by waiting for <abbr title="Input and Output">I/O</abbr> operations, so they call them "I/O bound".
-
-It's called "asynchronous" because the computer / program doesn't have to be "synchronized" with the slow task, waiting for the exact moment that the task finishes, while doing nothing, to be able to take the task result and continue the work.
-
-Instead of that, by being an "asynchronous" system, once finished, the task can wait in line a little bit (some microseconds) for the computer / program to finish whatever it went to do, and then come back to take the results and continue working with them.
-
-For "synchronous" (contrary to "asynchronous") they commonly also use the term "sequential", because the computer / program follows all the steps in sequence before switching to a different task, even if those steps involve waiting.
-
-### Concurrency and Burgers
-
-This idea of **asynchronous** code described above is also sometimes called **"concurrency"**. It is different from **"parallelism"**.
-
-**Concurrency** and **parallelism** both relate to "different things happening more or less at the same time". 
-
-But the details between *concurrency* and *parallelism* are quite different.
-
-To see the difference, imagine the following story about burgers:
-
-### Concurrent Burgers
-
-You go with your crush to get fast food, you stand in line while the cashier takes the orders from the people in front of you.
-
-Then it's your turn, you place your order of 2 very fancy burgers for your crush and you.
-
-You pay.
-
-The cashier says something to the guy in the kitchen so he knows he has to prepare your burgers (even though he is currently preparing the ones for the previous clients).
-
-The cashier gives you the number of your turn.
-
-While you are waiting, you go with your crush and pick a table, you sit and talk with your crush for a long time (as your burgers are very fancy and take some time to prepare).
-
-As you are seating on the table with your crush, while you wait for the burgers, you can spend that time admiring how awesome, cute and smart your crush is.
-
-While waiting and talking to your crush, from time to time, you check the number displayed on the counter to see if it's your turn already.
-
-Then at some point, it finally is your turn. You go to the counter, get your burgers and come back to the table.
-
-You and your crush eat the burgers and have a nice time.
-
----
-
-Imagine you are the computer / program in that story.
-
-While you are at the line, you are just idle, waiting for your turn, not doing anything very "productive". But the line is fast because the cashier is only taking the orders, so that's fine.
-
-Then, when it's your turn, you do actual "productive" work, you process the menu, decide what you want, get your crush's choice, pay, check that you give the correct bill or card, check that you are charged correctly, check that the order has the correct items, etc.
-
-But then, even though you still don't have your burgers, your work with the cashier is "on pause", because you have to wait for your burgers to be ready.
-
-But as you go away from the counter and seat on the table with a number for your turn, you can switch your attention to your crush, and "work" on that. Then you are again doing something very "productive", as is flirting with your crush.
-
-Then the cashier says "I'm finished with doing the burgers" by putting your number on the counter display, but you don't jump like crazy immediately when the displayed number changes to your turn number. You know no one will steal your burgers because you have the number of your turn, and they have theirs. 
-
-So you wait for your crush to finish the story (finish the current work / task being processed), smile gently and say that you are going for the burgers.
-
-Then you go to the counter, to the initial task that is now finished, pick the burgers, say thanks and take them to the table. That finishes that step / task of interaction with the counter. That in turn, creates a new task, of "eating burgers", but the previous one of "getting burgers" is finished.
-
-### Parallel Burgers
-
-You go with your crush to get parallel fast food.
-
-You stand in line while several (let's say 8) cashiers take the orders from the people in front of you.
-
-Everyone before you is waiting for their burgers to be ready before leaving the counter because each of the 8 cashiers goes himself and prepares the burger right away before getting the next order.
-
-Then it's finally your turn, you place your order of 2 very fancy burgers for your crush and you.
-
-You pay.
-
-The cashier goes to the kitchen.
-
-You wait, standing in front of the counter, so that no one else takes your burgers before you, as there are no numbers for turns.
-
-As you and your crush are busy not letting anyone get in front of you and take your burgers whenever they arrive, you cannot pay attention to your crush.
-
-This is "synchronous" work, you are "synchronized" with the cashier/cook. You have to wait and be there at the exact moment that the cashier/cook finishes the burgers and gives them to you, or otherwise, someone else might take them.
-
-Then your cashier/cook finally comes back with your burgers, after a long time waiting there in front of the counter.
-
-You take your burgers and go to the table with your crush.
-
-You just eat them, and you are done.
-
-There was not much talk or flirting as most of the time was spent waiting in front of the counter.
-
----
-
-In this scenario of the parallel burgers, you are a computer / program with two processors (you and your crush), both waiting and dedicating their attention to be "waiting on the counter" for a long time.
-
-The fast food store has 8 processors (cashiers/cooks). While the concurrent burgers store might have had only 2 (one cashier and one cook).
-
-But still, the final experience is not the best.
-
----
-
-This would be the parallel equivalent story for burgers.
-
-For a more "real life" example of this, imagine a bank.
-
-Up to recently, most of the banks had multiple cashiers and a big line.
-
-All of the cashiers doing all the work with one client after the other.
-
-And you have to wait in the line for a long time or you lose your turn.
-
-You probably wouldn't want to take your crush with you to do errands at the bank.
-
-### Burger Conclusion
-
-In this scenario of "fast food burgers with your crush", as there is a lot of waiting, it makes a lot more sense to have a concurrent system.
-
-This is the case for most of the web applications.
-
-Many, many users, but your server is waiting for their not-so-good connection to send their requests.
-
-And then waiting again for the responses to come back.
-
-This "waiting" is measured in microseconds, but still, summing it all, it's a lot of waiting in the end.
-
-That's why it makes a lot of sense to use asynchronous code for web APIs.
-
-Most of the existing popular Python frameworks (including Flask and Django) were created before the new asynchronous features in Python existed. So, the ways they can be deployed support parallel execution and an older form of asynchronous execution that is not as powerful as the new capabilities.
-
-Even though the main specification for asynchronous web Python (ASGI) was developed at Django, to add support for WebSockets.
-
-That kind of asynchronicity is what made NodeJS popular (even though NodeJS is not parallel) and that's the strength of Go as a programing language.
-
-And that's the same level of performance</a> you get with **FastAPI**.
-
-And as you can have parallelism and asynchronicity at the same time, you get higher performance than most of the tested NodeJS frameworks and on par with Go, which is a compiled language closer to C <a href="https://www.techempower.com/benchmarks/#section=data-r17&hw=ph&test=query&l=zijmkf-1" class="external-link" target="_blank">(all thanks to Starlette)</a>.
-
-### Is concurrency better than parallelism?
-
-Nope! That's not the moral of the story.
-
-Concurrency is different than parallelism. And it is better on **specific** scenarios that involve a lot of waiting. Because of that, it generally is a lot better than parallelism for web application development. But not for everything.
-
-So, to balance that out, imagine the following short story:
-
-> You have to clean a big, dirty house.
-
-*Yep, that's the whole story*.
-
----
-
-There's no waiting anywhere, just a lot of work to be done, on multiple places of the house.
-
-You could have turns as in the burgers example, first the living room, then the kitchen, but as you are not waiting for anything, just cleaning and cleaning, the turns wouldn't affect anything.
-
-It would take the same amount of time to finish with or without turns (concurrency) and you would have done the same amount of work.
-
-But in this case, if you could bring the 8 ex-cashier/cooks/now-cleaners, and each one of them (plus you) could take a zone of the house to clean it, you could do all the work in **parallel**, with the extra help, and finish much sooner.
-
-In this scenario, each one of the cleaners (including you) would be a processor, doing their part of the job. 
-
-And as most of the execution time is taken by actual work (instead of waiting), and the work in a computer is done by a <abbr title="Central Processing Unit">CPU</abbr>, they call these problems "CPU bound".
-
----
-
-Common examples of CPU bound operations are things that require complex math processing.
-
-For example:
-
-* **Audio** or **image processing**
-* **Computer vision**: an image is composed of millions of pixels, each pixel has 3 values / colors, processing that normally requires computing something on those pixels, all at the same time)
-* **Machine Learning**: it normally requires lots of "matrix" and "vector" multiplications. Think of a huge spreadsheet with numbers and multiplying all of them together at the same time.
-* **Deep Learning**: this is a sub-field of Machine Learning, so, the same applies. It's just that there is not a single spreadsheet of numbers to multiply, but a huge set of them, and in many cases, you use a special processor to build and / or use those models.
-
-### Concurrency + Parallelism: Web + Machine Learning
-
-With **FastAPI** you can take the advantage of concurrency that is very common for web development (the same main attractive of NodeJS).
-
-But you can also exploit the benefits of parallelism and multiprocessing (having multiple processes running in parallel) for **CPU bound** workloads like those in Machine Learning systems.
-
-That, plus the simple fact that Python is the main language for **Data Science**, Machine Learning and especially Deep Learning, make FastAPI a very good match for Data Science / Machine Learning web APIs and applications (among many others).
-
-To see how to achieve this parallelism in production see the section about [Deployment](deployment.md){.internal-link target=_blank}.
-
-## `async` and `await`
-
-Modern versions of python have a very intuitive way to define asynchronous code. This makes it look just like normal "sequential" code and do the "awaiting" for you at the right moments.
-
-When there is an operation that will require waiting before giving the results and has support for these new Python features, you can code it like:
-
-```Python
-burgers = await get_burgers(2)
-```
-
-The key here is the `await`. It tells Python that it has to wait for `get_burgers(2)` to finish doing its thing before storing the results in `burgers`. With that, Python will know that it can go and do something else in the meanwhile (like receiving another request).
-
-For `await` to work, it has to be inside a function that supports this asynchronicity. To do that, you just declare it with `async def`:
-
-```Python hl_lines="1"
-async def get_burgers(number: int):
-    # Do some asynchronous stuff to create the burgers
-    return burgers
-```
-
-...instead of `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
-```
-
-With `async def`, Python knows that, inside that function, it has to be aware of `await` expressions, and that it can "pause" the execution of that function and go do something else before coming back.
-
-When you want to call an `async def` function, you have to "await" it. So, this won't work:
-
-```Python
-# This won't work, because get_burgers was defined with: async def
-burgers = get_burgers(2)
-```
-
----
-
-So, if you are using a library that tells you that you can call it with `await`, you need to create the *path operation functions* that uses it with `async def`, like in:
-
-```Python hl_lines="2 3"
-@app.get('/burgers')
-async def read_burgers():
-    burgers = await get_burgers(2)
-    return burgers
-```
-
-### More technical details
-
-You might have noticed that `await` can only be used inside of functions defined with `async def`.
-
-But at the same time, functions defined with `async def` have to be "awaited". So, functions with `async def` can only be called inside of functions defined with `async def` too.
-
-So, about the egg and the chicken, how do you call the first `async` function?
-
-If you are working with **FastAPI** you don't have to worry about that, because that "first" function will be your *path operation function*, and FastAPI will know how to do the right thing.
-
-But if you want to use `async` / `await` without FastAPI, <a href="https://docs.python.org/3/library/asyncio-task.html#coroutine" class="external-link" target="_blank">check the official Python docs</a>.
-
-### Other forms of asynchronous code
-
-This style of using `async` and `await` is relatively new in the language.
-
-But it makes working with asynchronous code a lot easier.
-
-This same syntax (or almost identical) was also included recently in modern versions of JavaScript (in Browser and NodeJS).
-
-But before that, handling asynchronous code was quite more complex and difficult.
-
-In previous versions of Python, you could have used threads or <a href="http://www.gevent.org/" class="external-link" target="_blank">Gevent</a>. But the code is way more complex to understand, debug, and think about.
-
-In previous versions of NodeJS / Browser JavaScript, you would have used "callbacks". Which lead to <a href="http://callbackhell.com/" class="external-link" target="_blank">callback hell</a>.
-
-## Coroutines
-
-**Coroutine** is just the very fancy term for the thing returned by an `async def` function. Python knows that it is something like a function that it can start and that it will end at some point, but that it might be paused internally too, whenever there is an `await` inside of it.
-
-But all this functionality of using asynchronous code with `async` and `await` is many times summarized as using "coroutines". It is comparable to the main key feature of Go, the "Goroutines".
-
-## Conclusion
-
-Let's see the same phrase from above:
-
-> Modern versions of Python have support for **"asynchronous code"** using something called **"coroutines"**, with **`async` and `await`** syntax.
-
-That should make more sense now.
-
-All that is what powers FastAPI (through Starlette) and what makes it have such an impressive performance.
-
-## Very Technical Details
-
-!!! warning
-    You can probably skip this.
-    
-    These are very technical details of how **FastAPI** works underneath.
-    
-    If you have quite some technical knowledge (co-routines, threads, blocking, etc) and are curious about how FastAPI handles `async def` vs normal `def`, go ahead.
-
-### Path operation functions
-
-When you declare a *path operation function* with normal `def` instead of `async def`, it is run in an external threadpool that is then awaited, instead of being called directly (as it would block the server).
-
-If you are coming from another async framework that does not work in the way described above and you are used to define trivial compute-only *path operation functions* with plain `def` for a tiny performance gain (about 100 nanoseconds), please note that in **FastAPI** the effect would be quite opposite. In these cases, it's better to use `async def` unless your *path operation functions* use code that performs blocking <abbr title="Input/Output: disk reading or writing, network communications.">IO</abbr>.
-
-Still, in both situations, chances are that **FastAPI** will [still be faster](/#performance){.internal-link target=_blank} than (or at least comparable to) your previous framework.
-
-### Dependencies
-
-The same applies for dependencies. If a dependency is a standard `def` function instead of `async def`, it is run in the external threadpool.
-
-### Sub-dependencies
-
-You can have multiple dependencies and sub-dependencies requiring each other (as parameters of the function definitions), some of them might be created with `async def` and some with normal `def`. It would still work, and the ones created with normal `def` would be called on an external thread instead of being "awaited".
-
-### Other utility functions
-
-Any other utility function that you call directly can be created with normal `def` or `async def` and FastAPI won't affect the way you call it.
-
-This is in contrast to the functions that FastAPI calls for you: *path operation functions* and dependencies.
-
-If your utility function is a normal function with `def`, it will be called directly (as you write it in your code), not in a threadpool, if the function is created with `async def` then you should await for that function when you call it in your code.
-
----
-
-Again, these are very technical details that would probably be useful if you came searching for them.
-
-Otherwise, you should be good with the guidelines from the section above: <a href="#in-a-hurry">In a hurry?</a>.

docs/benchmarks.md

@@ -1,32 +0,0 @@
-Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as <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">one of the fastest Python frameworks available</a>, only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)
-
-But when checking benchmarks and comparisons you should have the following in mind.
-
-## Benchmarks and speed
-
-When you check the benchmarks, it is common to see several tools of different types compared as equivalent.
-
-Specifically, to see Uvicorn, Starlette and FastAPI compared together (among many other tools).
-
-The simplest the problem solved by the tool, the better performance it will get. And most of the benchmarks don't test the additional features provided by the tool.
-
-The hierarchy is like:
-
-* **Uvicorn**: an ASGI server
-    * **Starlette**: (uses Uvicorn) a web microframework
-        * **FastAPI**: (uses Starlette) an API microframework with several additional features for building APIs, with data validation, etc.
-
-* **Uvicorn**:
-    * Will have the best performance, as it doesn't have much extra code apart from the server itself.
-    * You wouldn't write an application in Uvicorn directly. That would mean that your code would have to include more or less, at least, all the code provided by Starlette (or **FastAPI**). And if you did that, your final application would have the same overhead as having used a framework and minimizing your app code and bugs.
-    * If you are comparing Uvicorn, compare it against Daphne, Hypercorn, uWSGI, etc. Application servers.
-* **Starlette**:
-    * Will have the next best performance, after Uvicorn. In fact, Starlette uses Uvicorn to run. So, it probably can only get "slower" than Uvicorn by having to execute more code.
-    * But it provides you the tools to build simple web applications, with routing based on paths, etc.
-    * If you are comparing Starlette, compare it against Sanic, Flask, Django, etc. Web frameworks (or microframeworks).
-* **FastAPI**:
-    * The same way that Starlette uses Uvicorn and cannot be faster than it, **FastAPI** uses Starlette, so it cannot be faster than it.
-    * FastAPI provides more features on top of Starlette. Features that you almost always need when building APIs, like data validation and serialization. And by using it, you get automatic documentation for free (the automatic documentation doesn't even add overhead to running applications, it is generated on startup).
-    * If you didn't use FastAPI and used Starlette directly (or another tool, like Sanic, Flask, Responder, etc) you would have to implement all the data validation and serialization yourself. So, your final application would still have the same overhead as if it was built using FastAPI. And in many cases, this data validation and serialization is the biggest amount of code written in applications.
-    * So, by using FastAPI you are saving development time, bugs, lines of code, and you would probably get the same performance (or better) you would if you didn't use it (as you would have to implement it all in your code).
-    * If you are comparing FastAPI, compare it against a web application framework (or set of tools) that provides data validation, serialization and documentation, like Flask-apispec, NestJS, Molten, etc. Frameworks with integrated automatic data validation, serialization and documentation.

docs/contributing.md

@@ -1,175 +0,0 @@
-First, you might want to see the basic ways to [help FastAPI and get help](help-fastapi.md){.internal-link target=_blank}.
-
-## Developing
-
-If you already cloned the repository and you know that you need to deep dive in the code, here are some guidelines to set up your environment.
-
-### Virtual environment with `venv`
-
-You can create a virtual environment in a directory using Python's `venv` module:
-
-```console
-$ python -m venv env
-```
-
-That will create a directory `./env/` with the Python binaries and then you will be able to install packages for that isolated environment.
-
-### Activate the environment
-
-Activate the new environment with:
-
-```console
-$ source ./env/bin/activate
-```
-
-Or in Windows' PowerShell:
-
-```console
-$ .\env\Scripts\Activate.ps1
-```
-
-Or if you use Bash for Windows (e.g. <a href="https://gitforwindows.org/" class="external-link" target="_blank">Git Bash</a>):
-
-```console
-$ source ./env/Scripts/activate
-```
-
-To check it worked, use:
-
-```console
-$ which pip
-
-some/directory/fastapi/env/bin/pip
-```
-
-If it shows the `pip` binary at `env/bin/pip` then it worked. 🎉
-
-Or in Windows PowerShell:
-
-```console
-$ Get-Command pip
-
-some/directory/fastapi/env/bin/pip
-```
-!!! tip
-    Every time you install a new package with `pip` under that environment, activate the environment again.
-
-    This makes sure that if you use a terminal program installed by that package (like `flit`), you use the one from your local environment and not any other that could be installed globally.
-
-### Flit
-
-**FastAPI** uses <a href="https://flit.readthedocs.io/en/latest/index.html" class="external-link" target="_blank">Flit</a> to build, package and publish the project.
-
-After activating the environment  as described above, install `flit`:
-
-```console
-$ pip install flit
-```
-
-Now re-activate the environment to make sure you are using the `flit` you just installed (and not a global one).
-
-And now use `flit` to install the development dependencies:
-
-```console
-$ flit install --deps develop --symlink
-```
-
-It will install all the dependencies and your local FastAPI in your local environment.
-
-#### Using your local FastAPI
-
-If you create a Python file that imports and uses FastAPI, and run it with the Python from your local environment, it will use your local FastAPI source code.
-
-And if you update that local FastAPI source code, as it is installed with `--symlink`, when you run that Python file again, it will use the fresh version of FastAPI you just edited.
-
-That way, you don't have to "install" your local version to be able to test every change.
-
-### Format
-
-There is a script that you can run that will format and clean all your code:
-
-```console
-$ bash scripts/format.sh
-```
-
-It will also auto-sort all your imports.
-
-For it to sort them correctly, you need to have FastAPI installed locally in your environment, with the command in the section above:
-
-```console
-$ flit install --symlink
-```
-
-### Format imports
-
-There is another script that formats all the imports and makes sure you don't have unused imports:
-
-```console
-$ bash scripts/format-imports.sh
-```
-
-As it runs one command after the other and modifies and reverts many files, it takes a bit longer to run, so it might be easier to use `scripts/format.sh` frequently and `scripts/format-imports.sh` only before committing.
-
-## Docs
-
-The documentation uses <a href="https://www.mkdocs.org/" class="external-link" target="_blank">MkDocs</a>.
-
-All the documentation is in Markdown format in the directory `./docs`.
-
-Many of the tutorials have blocks of code.
-
-In most of the cases, these blocks of code are actual complete applications that can be run as is.
-
-In fact, those blocks of code are not written inside the Markdown, they are Python files in the `./docs/src/` directory.
-
-And those Python files are included/injected in the documentation when generating the site.
-
-### Docs for tests
-
-Most of the tests actually run against the example source files in the documentation.
-
-This helps making sure that:
-
-* The documentation is up to date.
-* The documentation examples can be run as is.
-* Most of the features are covered by the documentation, ensured by test coverage.
-
-During local development, there is a script that builds the site and checks for any changes, live-reloading:
-
-```console
-$ bash scripts/docs-live.sh
-```
-
-It will serve the documentation on `http://0.0.0.0:8008`.
-
-That way, you can edit the documentation/source files and see the changes live.
-
-### Apps and docs at the same time
-
-If you run the examples with, e.g.:
-
-```console
-$ uvicorn tutorial001:app --reload
-```
-
-as Uvicorn by default will use the port `8000`, the documentation on port `8008` won't clash.
-
-## Tests
-
-There is a script that you can run locally to test all the code and generate coverage reports in HTML:
-
-```console
-$ bash scripts/test-cov-html.sh
-```
-
-This command generates a directory `./htmlcov/`, if you open the file `./htmlcov/index.html` in your browser, you can explore interactively the regions of code that are covered by the tests, and notice if there is any region missing.
-
-### Tests in your editor
-
-If you want to use the integrated tests in your editor add `./docs/src` to your `PYTHONPATH` variable.
-
-For example, in VS Code you can create a file `.env` with:
-
-```env
-PYTHONPATH=./docs/src
-```

docs/css/custom.css

@@ -1,13 +0,0 @@
-a.external-link::after {
-    /* \00A0 is a non-breaking space
-        to make the mark be on the same line as the link
-    */
-    content: "\00A0[↪]";
-}
-
-a.internal-link::after {
-    /* \00A0 is a non-breaking space
-        to make the mark be on the same line as the link
-    */
-    content: "\00A0↪";
-}

docs/de/docs/features.md

@@ -0,0 +1,203 @@
+# Merkmale
+
+## FastAPI Merkmale
+
+**FastAPI** ermöglicht Ihnen folgendes:
+
+### Basiert auf offenen Standards
+
+* <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank"><strong>OpenAPI</strong></a> für API-Erstellung, zusammen mit Deklarationen von <abbr title="auch genannt: Endpunkte, Routen">Pfad</abbr> <abbr title="gemeint sind: HTTP-Methoden, wie POST, GET, PUT, DELETE">Operationen</abbr>, Parameter, Nachrichtenrumpf-Anfragen (englisch: body request), Sicherheit, etc.
+* Automatische Dokumentation der Datenentitäten mit dem <a href="https://json-schema.org/" class="external-link" target="_blank"><strong>JSON Schema</strong></a> (OpenAPI basiert selber auf dem JSON Schema).
+* Entworfen auf Grundlage dieser Standards nach einer sorgfältigen Studie, statt einer nachträglichen Schicht über diesen Standards.
+* Dies ermöglicht automatische **Quellcode-Generierung auf Benutzerebene** in vielen Sprachen.
+
+### Automatische Dokumentation
+
+Mit einer interaktiven API-Dokumentation und explorativen webbasierten Benutzerschnittstellen. Da FastAPI auf OpenAPI basiert, gibt es hierzu mehrere Optionen, wobei zwei standardmäßig vorhanden sind.
+
+* <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank"><strong>Swagger UI</strong></a>, bietet interaktive Exploration: testen und rufen Sie ihre API direkt vom Webbrowser auf.
+
+![Swagger UI Interaktion](https://fastapi.tiangolo.com/img/index/index-03-swagger-02.png)
+
+* Alternative API-Dokumentation mit <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank"><strong>ReDoc</strong></a>.
+
+![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png)
+
+### Nur modernes Python
+
+Alles basiert auf **Python 3.6 Typ**-Deklarationen (dank Pydantic). Es muss keine neue Syntax gelernt werden, nur standardisiertes modernes Python.
+
+
+
+Wenn Sie eine kurze, zweiminütige, Auffrischung in der Benutzung von Python Typ-Deklarationen benötigen (auch wenn Sie FastAPI nicht nutzen), schauen Sie sich diese kurze Einführung an (Englisch): Python Types{.internal-link target=_blank}.
+
+Sie schreiben Standard-Python mit Typ-Deklarationen:
+
+```Python
+from typing import List, Dict
+from datetime import date
+
+from pydantic import BaseModel
+
+# Deklariere eine Variable als str
+# und bekomme Editor-Unterstütung innerhalb der Funktion
+def main(user_id: str):
+    return user_id
+
+
+# Ein Pydantic model
+class User(BaseModel):
+    id: int
+    name: str
+    joined: date
+```
+
+Dies kann nun wiefolgt benutzt werden:
+
+```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` bedeutet:
+
+    Übergebe die Schlüssel und die zugehörigen Werte des `second_user_data` Datenwörterbuches direkt als Schlüssel-Wert Argumente, äquivalent zu: `User(id=4, name="Mary", joined="2018-11-30")`
+
+### Editor Unterstützung
+
+FastAPI wurde so entworfen, dass es einfach und intuitiv zu benutzen ist; alle Entscheidungen wurden auf mehreren Editoren getestet (sogar vor der eigentlichen Implementierung), um so eine best mögliche Entwicklererfahrung zu gewährleisten.
+
+In der letzen Python Entwickler Umfrage stellte sich heraus, dass <a href="https://www.jetbrains.com/research/python-developers-survey-2017/#tools-and-features" class="external-link" target="_blank">die meist genutzte Funktion die "Autovervollständigung" ist</a>.
+
+Die gesamte Struktur von **FastAPI** soll dem gerecht werden. Autovervollständigung funktioniert überall.
+
+Sie müssen selten in die Dokumentation schauen.
+
+So kann ihr Editor Sie unterstützen:
+
+* in <a href="https://code.visualstudio.com/" class="external-link" target="_blank">Visual Studio Code</a>:
+
+![editor support](https://fastapi.tiangolo.com/img/vscode-completion.png)
+
+* in <a href="https://www.jetbrains.com/pycharm/" class="external-link" target="_blank">PyCharm</a>:
+
+![editor support](https://fastapi.tiangolo.com/img/pycharm-completion.png)
+
+Sie bekommen Autovervollständigung an Stellen, an denen Sie dies vorher nicht für möglich gehalten hätten. Zum Beispiel der `price` Schlüssel aus einem JSON Datensatz (dieser könnte auch verschachtelt sein) aus einer Anfrage.
+
+Hierdurch werden Sie nie wieder einen falschen Schlüsselnamen benutzen und sparen sich lästiges Suchen in der Dokumentation, um beispielsweise herauszufinden ob Sie `username` oder `user_name` als Schlüssel verwenden.
+
+### Kompakt
+
+FastAPI nutzt für alles sensible **Standard-Einstellungen**, welche optional überall konfiguriert werden können. Alle Parameter können ganz genau an Ihre Bedürfnisse angepasst werden, sodass sie genau die API definieren können, die sie brauchen.
+
+Aber standardmäßig, **"funktioniert einfach"** alles.
+
+### Validierung
+
+* Validierung für die meisten (oder alle?) Python **Datentypen**, hierzu gehören:
+    * JSON Objekte (`dict`).
+    * JSON Listen (`list`), die den Typ ihrer Elemente definieren.
+    * Zeichenketten (`str`), mit definierter minimaler und maximaler Länge.
+    * Zahlen (`int`, `float`) mit minimaler und maximaler Größe, usw.
+
+* Validierung für ungewöhnliche Typen, wie:
+    * URL.
+    * Email.
+    * UUID.
+    * ... und andere.
+
+Die gesamte Validierung übernimmt das etablierte und robuste **Pydantic**.
+
+### Sicherheit und Authentifizierung
+
+Integrierte Sicherheit und Authentifizierung. Ohne Kompromisse bei Datenbanken oder Datenmodellen.
+
+Unterstützt werden alle von OpenAPI definierten Sicherheitsschemata, hierzu gehören:
+
+* HTTP Basis Authentifizierung.
+* **OAuth2** (auch mit **JWT Zugriffstokens**). Schauen Sie sich hierzu dieses Tutorial an: [OAuth2 mit JWT](tutorial/security/oauth2-jwt.md){.internal-link target=_blank}.
+* API Schlüssel in:
+    * Kopfzeile (HTTP Header).
+    * Anfrageparametern.
+    * Cookies, etc.
+
+Zusätzlich gibt es alle Sicherheitsfunktionen von Starlette (auch **session cookies**).
+
+Alles wurde als wiederverwendbare Werkzeuge und Komponenten geschaffen, die einfach in ihre Systeme, Datenablagen, relationale und nicht-relationale Datenbanken, ..., integriert werden können.
+
+### Einbringen von Abhängigkeiten (meist: Dependency Injection)
+
+FastAPI enthält ein extrem einfaches, aber extrem mächtiges <abbr title='oft verwendet im Zusammenhang von: Komponenten, Resourcen, Diensten, Dienstanbieter'><strong>Dependency Injection</strong></abbr> System.
+
+* Selbst Abhängigkeiten können Abhängigkeiten haben, woraus eine Hierachie oder ein **"Graph" von Abhängigkeiten** entsteht.
+* **Automatische Umsetzung** durch FastAPI.
+* Alle abhängigen Komponenten könnten Daten von Anfragen, **Erweiterungen der Pfadoperations-**Einschränkungen und der automatisierten Dokumentation benötigen.
+* **Automatische Validierung** selbst für *Pfadoperationen*-Parameter, die in den Abhängigkeiten definiert wurden.
+* Unterstützt komplexe Benutzerauthentifizierungssysteme, **Datenbankverbindungen**, usw.
+* **Keine Kompromisse** bei Datenbanken, Eingabemasken, usw. Sondern einfache Integration von allen.
+
+### Unbegrenzte Erweiterungen
+
+Oder mit anderen Worten, sie werden nicht benötigt. Importieren und nutzen Sie Quellcode nach Bedarf.
+
+Jede Integration wurde so entworfen, dass sie einfach zu nutzen ist (mit Abhängigkeiten), sodass Sie eine Erweiterung für Ihre Anwendung mit nur zwei Zeilen an Quellcode implementieren können. Hierbei nutzen Sie die selbe Struktur und Syntax, wie bei Pfadoperationen.
+
+### Getestet
+
+* 100% <abbr title="Die Anzahl an Code, die automatisch getestet wird">Testabdeckung</abbr>.
+* 100% <abbr title="Python Typ Annotationen, mit dennen Ihr Editor und andere exteren Werkezuge Sie besser unterstützen können">Typen annotiert</abbr>.
+* Verwendet in Produktionsanwendungen.
+
+## Starlette's Merkmale
+
+**FastAPI** ist vollkommen kompatibel (und basiert auf) <a href="https://www.starlette.io/" class="external-link" target="_blank"><strong>Starlette</strong></a>. Das bedeutet, auch ihr eigener Starlette Quellcode funktioniert.
+
+`FastAPI` ist eigentlich eine Unterklasse von `Starlette`. Wenn Sie also bereits Starlette kennen oder benutzen, können Sie das meiste Ihres Wissens direkt anwenden.
+
+Mit **FastAPI** bekommen Sie viele von **Starlette**'s Funktionen (da FastAPI nur Starlette auf Steroiden ist):
+
+* Stark beeindruckende Performanz. Es ist <a href="https://github.com/encode/starlette#performance" class="external-link" target="_blank">eines der schnellsten Python Frameworks, auf Augenhöhe mit **NodeJS** und **Go**</a>.
+* **WebSocket**-Unterstützung.
+* Hintergrundaufgaben im selben Prozess.
+* Ereignisse für das Starten und Herunterfahren.
+* Testclient basierend auf HTTPX.
+* **CORS**, GZip, statische Dateien, Antwortfluss.
+* **Sitzungs und Cookie** Unterstützung.
+* 100% Testabdeckung.
+* 100% Typen annotiert.
+
+## Pydantic's Merkmale
+
+**FastAPI** ist vollkommen kompatibel (und basiert auf) <a href="https://pydantic-docs.helpmanual.io" class="external-link" target="_blank"><strong>Pydantic</strong></a>. Das bedeutet, auch jeder zusätzliche Pydantic Quellcode funktioniert.
+
+Verfügbar sind ebenso externe auf Pydantic basierende Bibliotheken, wie <abbr title="Object-Relational Mapper (Abbildung von Objekten auf relationale Strukturen)">ORM</abbr>s, <abbr title="Object-Document Mapper (Abbildung von Objekten auf nicht-relationale Strukturen)">ODM</abbr>s für Datenbanken.
+
+Daher können Sie in vielen Fällen das Objekt einer Anfrage **direkt zur Datenbank** schicken, weil alles automatisch validiert wird.
+
+Das selbe gilt auch für die andere Richtung: Sie können jedes Objekt aus der Datenbank  **direkt zum Klienten** schicken.
+
+Mit **FastAPI** bekommen Sie alle Funktionen von **Pydantic** (da FastAPI für die gesamte Datenverarbeitung Pydantic nutzt):
+
+* **Kein Kopfzerbrechen**:
+    * Sie müssen keine neue Schemadefinitionssprache lernen.
+    * Wenn Sie mit Python's Typisierung arbeiten können, können Sie auch mit Pydantic arbeiten.
+* Gutes Zusammenspiel mit Ihrer/Ihrem **<abbr title="Integrierten Entwicklungsumgebung, ähnlich zu (Quellcode-)Editor">IDE</abbr>/<abbr title="Ein Programm, was Fehler im Quellcode sucht">linter</abbr>/Gehirn**:
+    * Weil Datenstrukturen von Pydantic einfach nur Instanzen ihrer definierten Klassen sind, sollten Autovervollständigung, Linting, mypy und ihre Intuition einwandfrei funktionieren.
+* **Schnell**:
+    * In <a href="https://pydantic-docs.helpmanual.io/benchmarks/" class="external-link" target="_blank">Vergleichen</a> ist Pydantic schneller als jede andere getestete Bibliothek.
+* Validierung von **komplexen Strukturen**:
+    * Benutzung von hierachischen Pydantic Schemata, Python `typing`’s `List` und `Dict`, etc.
+    * Validierungen erlauben eine klare und einfache Datenschemadefinition, überprüft und dokumentiert als JSON Schema.
+    * Sie können stark **verschachtelte JSON** Objekte haben und diese sind trotzdem validiert und annotiert.
+* **Erweiterbar**:
+    * Pydantic erlaubt die Definition von eigenen Datentypen oder sie können die Validierung mit einer `validator` dekorierten Methode erweitern.
+* 100% Testabdeckung.

docs/de/mkdocs.yml

@@ -0,0 +1 @@
+INHERIT: ../en/mkdocs.yml

docs/deployment.md

@@ -1,262 +0,0 @@
-You can use <a href="https://www.docker.com/" class="external-link" target="_blank">**Docker**</a> for deployment. It has several advantages like security, replicability, development simplicity, etc.
-
-In this section you'll see instructions and links to guides to know how to:
-
-* Make your **FastAPI** application a Docker image/container with maximum performance. In about **5 min**.
-* (Optionally) understand what you, as a developer, need to know about HTTPS.
-* Set up a Docker Swarm mode cluster with automatic HTTPS, even on a simple $5 USD/month server. In about **20 min**.
-* Generate and deploy a full **FastAPI** application, using your Docker Swarm cluster, with HTTPS, etc. In about **10 min**.
-
----
-
-You can also easily use **FastAPI** in a standard server directly too (without Docker).
-
-## Docker
-
-If you are using Docker, you can use the official Docker image:
-
-### <a href="https://github.com/tiangolo/uvicorn-gunicorn-fastapi-docker" class="external-link" target="_blank">tiangolo/uvicorn-gunicorn-fastapi</a>
-
-This image has an "auto-tuning" mechanism included, so that you can just add your code and get very high performance automatically. And without making sacrifices.
-
-But you can still change and update all the configurations with environment variables or configuration files.
-
-!!! tip
-    To see all the configurations and options, go to the Docker image page: <a href="https://github.com/tiangolo/uvicorn-gunicorn-fastapi-docker" class="external-link" target="_blank">tiangolo/uvicorn-gunicorn-fastapi</a>.
-
-### Create a `Dockerfile`
-
-* Go to your project directory.
-* Create a `Dockerfile` with:
-
-```Dockerfile
-FROM tiangolo/uvicorn-gunicorn-fastapi:python3.7
-
-COPY ./app /app
-```
-
-#### Bigger Applications
-
-If you followed the section about creating [Bigger Applications with Multiple Files](tutorial/bigger-applications.md){.internal-link target=_blank}, your `Dockerfile` might instead look like:
-
-```Dockerfile
-FROM tiangolo/uvicorn-gunicorn-fastapi:python3.7
-
-COPY ./app /app/app
-```
-
-#### Raspberry Pi and other architectures
-
-If you are running Docker in a Raspberry Pi (that has an ARM processor) or any other architecture, you can create a `Dockerfile` from scratch, based on a Python base image (that is multi-architecture) and use Uvicorn alone.
-
-In this case, your `Dockerfile` could look like:
-
-```Dockerfile
-FROM python:3.7
-
-RUN pip install fastapi uvicorn
-
-EXPOSE 80
-
-COPY ./app /app
-
-CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
-```
-
-### Create the **FastAPI** Code
-
-* Create an `app` directory and enter in it.
-* Create a `main.py` file with:
-
-```Python
-from fastapi import FastAPI
-
-app = FastAPI()
-
-
-@app.get("/")
-def read_root():
-    return {"Hello": "World"}
-
-
-@app.get("/items/{item_id}")
-def read_item(item_id: int, q: str = None):
-    return {"item_id": item_id, "q": q}
-```
-
-* You should now have a directory structure like:
-
-```
-.
-├── app
-│   └── main.py
-└── Dockerfile
-```
-
-### Build the Docker image
-
-* Go to the project directory (in where your `Dockerfile` is, containing your `app` directory).
-* Build your FastAPI image:
-
-```bash
-docker build -t myimage .
-```
-
-### Start the Docker container
-
-* Run a container based on your image:
-
-```bash
-docker run -d --name mycontainer -p 80:80 myimage
-```
-
-Now you have an optimized FastAPI server in a Docker container. Auto-tuned for your current server (and number of CPU cores).
-
-### Check it
-
-You should be able to check it in your Docker container's URL, for example: <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> or <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> (or equivalent, using your Docker host).
-
-You will see something like:
-
-```JSON
-{"item_id": 5, "q": "somequery"}
-```
-
-### Interactive API docs
-
-Now you can go to <a href="http://192.168.99.100/docs" class="external-link" target="_blank">http://192.168.99.100/docs</a> or <a href="http://127.0.0.1/docs" class="external-link" target="_blank">http://127.0.0.1/docs</a> (or equivalent, using your Docker host).
-
-You will see the automatic interactive API documentation (provided by <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>):
-
-![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)
-
-### Alternative API docs
-
-And you can also go to <a href="http://192.168.99.100/redoc" class="external-link" target="_blank">http://192.168.99.100/redoc</a> or <a href="http://127.0.0.1/redoc" class="external-link" target="_blank">http://127.0.0.1/redoc</a> (or equivalent, using your Docker host).
-
-You will see the alternative automatic documentation (provided by <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a>):
-
-![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png)
-
-## HTTPS
-
-### About HTTPS
-
-It is easy to assume that HTTPS is something that is just "enabled" or not.
-
-But it is way more complex than that.
-
-!!! tip
-    If you are in a hurry or don't care, continue with the next section for step by step instructions to set everything up.
-
-To learn the basics of HTTPS, from a consumer perspective, check <a href="https://howhttps.works/" class="external-link" target="_blank">https://howhttps.works/</a>.
-
-Now, from a developer's perspective, here are several things to have in mind while thinking about HTTPS:
-
-* For HTTPS, the server needs to have "certificates" generated by a third party.
-    * Those certificates are actually acquired from the third-party, not "generated".
-* Certificates have a lifetime.
-    * They expire.
-    * And then they need to be renewed, acquired again from the third party.
-* The encryption of the connection happens at the TCP level.
-    * That's one layer below HTTP.
-    * So, the certificate and encryption handling is done before HTTP.
-* TCP doesn't know about "domains". Only about IP addresses.
-    * The information about the specific domain requested goes in the HTTP data.
-* The HTTPS certificates "certify" a certain domain, but the protocol and encryption happen at the TCP level, before knowing which domain is being dealt with.
-* By default, that would mean that you can only have one HTTPS certificate per IP address.
-    * No matter how big your server is or how small each application you have on it might be.
-    * There is a solution to this, however.
-* There's an extension to the TLS protocol (the one handling the encryption at the TCP level, before HTTP) called <a href="https://en.wikipedia.org/wiki/Server_Name_Indication" class="external-link" target="_blank"><abbr title="Server Name Indication">SNI</abbr></a>.
-    * This SNI extension allows one single server (with a single IP address) to have several HTTPS certificates and serve multiple HTTPS domains/applications.
-    * For this to work, a single component (program) running on the server, listening on the public IP address, must have all the HTTPS certificates in the server.
-* After obtaining a secure connection, the communication protocol is still HTTP.
-    * The contents are encrypted, even though they are being sent with the HTTP protocol.
-
-It is a common practice to have one program/HTTP server running on the server (the machine, host, etc.) and managing all the HTTPS parts : sending the decrypted HTTP requests to the actual HTTP application running in the same server (the **FastAPI** application, in this case), take the HTTP response from the application, encrypt it using the appropriate certificate and sending it back to the client using HTTPS. This server is often called a <a href="https://en.wikipedia.org/wiki/TLS_termination_proxy" class="external-link" target="_blank">TLS Termination Proxy</a>.
-
-### Let's Encrypt
-
-Before Let's Encrypt, these HTTPS certificates were sold by trusted third-parties.
-
-The process to acquire one of these certificates used to be cumbersome, require quite some paperwork and the certificates were quite expensive.
-
-But then <a href="https://letsencrypt.org/" class="external-link" target="_blank">Let's Encrypt</a> was created.
-
-It is a project from the Linux Foundation. It provides HTTPS certificates for free. In an automated way. These certificates use all the standard cryptographic security, and are short lived (about 3 months), so the security is actually better because of their reduced lifespan.
-
-The domains are securely verified and the certificates are generated automatically. This also allows automating the renewal of these certificates.
-
-The idea is to automate the acquisition and renewal of these certificates, so that you can have secure HTTPS, for free, forever.
-
-### Traefik
-
-<a href="https://traefik.io/" class="external-link" target="_blank">Traefik</a> is a high performance reverse proxy / load balancer. It can do the "TLS Termination Proxy" job (apart from other features).
-
-It has integration with Let's Encrypt. So, it can handle all the HTTPS parts, including certificate acquisition and renewal.
-
-It also has integrations with Docker. So, you can declare your domains in each application configurations and have it read those configurations, generate the HTTPS certificates and serve HTTPS to your application automatically, without requiring any change in its configuration.
-
----
-
-With this information and tools, continue with the next section to combine everything.
-
-## Docker Swarm mode cluster with Traefik and HTTPS
-
-You can have a Docker Swarm mode cluster set up in minutes (about 20 min) with a main Traefik handling HTTPS (including certificate acquisition and renewal).
-
-By using Docker Swarm mode, you can start with a "cluster" of a single machine (it can even be a $5 USD / month server) and then you can grow as much as you need adding more servers.
-
-To set up a Docker Swarm Mode cluster with Traefik and HTTPS handling, follow this guide:
-
-### <a href="https://medium.com/@tiangolo/docker-swarm-mode-and-traefik-for-a-https-cluster-20328dba6232" class="external-link" target="_blank">Docker Swarm Mode and Traefik for an HTTPS cluster</a>
-
-### Deploy a FastAPI application
-
-The easiest way to set everything up, would be using the [**FastAPI** Project Generators](project-generation.md){.internal-link target=_blank}.
-
-It is designed to be integrated with this Docker Swarm cluster with Traefik and HTTPS described above.
-
-You can generate a project in about 2 min.
-
-The generated project has instructions to deploy it, doing it takes another 2 min.
-
-## Alternatively, deploy **FastAPI** without Docker
-
-You can deploy **FastAPI** directly without Docker too.
-
-You just need to install an ASGI compatible server like:
-
-* <a href="https://www.uvicorn.org/" class="external-link" target="_blank">Uvicorn</a>, a lightning-fast ASGI server, built on uvloop and httptools.
-
-```bash
-pip install uvicorn
-```
-
-* <a href="https://gitlab.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>, an ASGI server also compatible with HTTP/2.
-
-```bash
-pip install hypercorn
-```
-
-...or any other ASGI server.
-
-And run your application the same way you have done in the tutorials, but without the `--reload` option, e.g.:
-
-```bash
-uvicorn main:app --host 0.0.0.0 --port 80
-```
-
-or with Hypercorn:
-
-```bash
-hypercorn main:app --bind 0.0.0.0:80
-```
-
-You might want to set up some tooling to make sure it is restarted automatically if it stops.
-
-You might also want to install <a href="https://gunicorn.org/" class="external-link" target="_blank">Gunicorn</a> and <a href="https://www.uvicorn.org/#running-with-gunicorn" class="external-link" target="_blank">use it as a manager for Uvicorn</a>, or use Hypercorn with multiple workers.
-
-Making sure to fine-tune the number of workers, etc.
-
-But if you are doing all that, you might just use the Docker image that does it automatically.

docs/em/docs/advanced/additional-responses.md

@@ -0,0 +1,240 @@
+# 🌖 📨 🗄
+
+!!! warning
+    👉 👍 🏧 ❔.
+
+    🚥 👆 ▶️ ⏮️ **FastAPI**, 👆 💪 🚫 💪 👉.
+
+👆 💪 📣 🌖 📨, ⏮️ 🌖 👔 📟, 🔉 🆎, 📛, ♒️.
+
+👈 🌖 📨 🔜 🔌 🗄 🔗, 👫 🔜 😑 🛠️ 🩺.
+
+✋️ 👈 🌖 📨 👆 ✔️ ⚒ 💭 👆 📨 `Response` 💖 `JSONResponse` 🔗, ⏮️ 👆 👔 📟 & 🎚.
+
+## 🌖 📨 ⏮️ `model`
+
+👆 💪 🚶‍♀️ 👆 *➡ 🛠️ 👨‍🎨* 🔢 `responses`.
+
+⚫️ 📨 `dict`, 🔑 👔 📟 🔠 📨, 💖 `200`, & 💲 🎏 `dict`Ⓜ ⏮️ ℹ 🔠 👫.
+
+🔠 👈 📨 `dict`Ⓜ 💪 ✔️ 🔑 `model`, ⚗ Pydantic 🏷, 💖 `response_model`.
+
+**FastAPI** 🔜 ✊ 👈 🏷, 🏗 🚮 🎻 🔗 & 🔌 ⚫️ ☑ 🥉 🗄.
+
+🖼, 📣 ➕1️⃣ 📨 ⏮️ 👔 📟 `404` & Pydantic 🏷 `Message`, 👆 💪 ✍:
+
+```Python hl_lines="18  22"
+{!../../../docs_src/additional_responses/tutorial001.py!}
+```
+
+!!! 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`) ⚖️ 🇩🇴 🖼:
+
+```Python hl_lines="19-24  28"
+{!../../../docs_src/additional_responses/tutorial002.py!}
+```
+
+!!! 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`:
+
+```Python hl_lines="20-31"
+{!../../../docs_src/additional_responses/tutorial003.py!}
+```
+
+⚫️ 🔜 🌐 🌀 & 🔌 👆 🗄, & 🎦 🛠️ 🩺:
+
+<img src="/img/tutorial/additional-responses/image01.png">
+
+## 🌀 🔢 📨 &amp; 🛃 🕐
+
+👆 💪 💚 ✔️ 🔁 📨 👈 ✔ 📚 *➡ 🛠️*, ✋️ 👆 💚 🌀 👫 ⏮️ 🛃 📨 💚 🔠 *➡ 🛠️*.
+
+📚 💼, 👆 💪 ⚙️ 🐍 ⚒ "🏗" `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",
+}
+```
+
+👆 💪 ⚙️ 👈 ⚒ 🏤-⚙️ 🔢 📨 👆 *➡ 🛠️* &amp; 🌀 👫 ⏮️ 🌖 🛃 🕐.
+
+🖼:
+
+```Python hl_lines="13-17  26"
+{!../../../docs_src/additional_responses/tutorial004.py!}
+```
+
+## 🌖 ℹ 🔃 🗄 📨
+
+👀 ⚫️❔ ⚫️❔ 👆 💪 🔌 📨, 👆 💪 ✅ 👉 📄 🗄 🔧:
+
+* <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` (🔘 👉 👈 👆 📣 🎏 🔉 🆎 &amp; 🎻 🔗), &amp; `links`.

docs/em/docs/advanced/additional-status-codes.md

@@ -0,0 +1,37 @@
+# 🌖 👔 📟
+
+🔢, **FastAPI** 🔜 📨 📨 ⚙️ `JSONResponse`, 🚮 🎚 👆 📨 ⚪️➡️ 👆 *➡ 🛠️* 🔘 👈 `JSONResponse`.
+
+⚫️ 🔜 ⚙️ 🔢 👔 📟 ⚖️ 1️⃣ 👆 ⚒ 👆 *➡ 🛠️*.
+
+## 🌖 👔 📟
+
+🚥 👆 💚 📨 🌖 👔 📟 ↖️ ⚪️➡️ 👑 1️⃣, 👆 💪 👈 🛬 `Response` 🔗, 💖 `JSONResponse`, & ⚒ 🌖 👔 📟 🔗.
+
+🖼, ➡️ 💬 👈 👆 💚 ✔️ *➡ 🛠️* 👈 ✔ ℹ 🏬, & 📨 🇺🇸🔍 👔 📟 2️⃣0️⃣0️⃣ "👌" 🕐❔ 🏆.
+
+✋️ 👆 💚 ⚫️ 🚫 🆕 🏬. & 🕐❔ 🏬 🚫 🔀 ⏭, ⚫️ ✍ 👫, & 📨 🇺🇸🔍 👔 📟 2️⃣0️⃣1️⃣ "✍".
+
+🏆 👈, 🗄 `JSONResponse`, & 📨 👆 🎚 📤 🔗, ⚒ `status_code` 👈 👆 💚:
+
+```Python hl_lines="4  25"
+{!../../../docs_src/additional_status_codes/tutorial001.py!}
+```
+
+!!! warning
+    🕐❔ 👆 📨 `Response` 🔗, 💖 🖼 🔛, ⚫️ 🔜 📨 🔗.
+
+    ⚫️ 🏆 🚫 🎻 ⏮️ 🏷, ♒️.
+
+    ⚒ 💭 ⚫️ ✔️ 📊 👆 💚 ⚫️ ✔️, & 👈 💲 ☑ 🎻 (🚥 👆 ⚙️ `JSONResponse`).
+
+!!! note "📡 ℹ"
+    👆 💪 ⚙️ `from starlette.responses import JSONResponse`.
+
+    **FastAPI** 🚚 🎏 `starlette.responses` `fastapi.responses` 🏪 👆, 👩‍💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃. 🎏 ⏮️ `status`.
+
+## 🗄 & 🛠️ 🩺
+
+🚥 👆 📨 🌖 👔 📟 & 📨 🔗, 👫 🏆 🚫 🔌 🗄 🔗 (🛠️ 🩺), ↩️ FastAPI 🚫 ✔️ 🌌 💭 ⏪ ⚫️❔ 👆 🚶 📨.
+
+✋️ 👆 💪 📄 👈 👆 📟, ⚙️: [🌖 📨](additional-responses.md){.internal-link target=_blank}.

docs/em/docs/advanced/advanced-dependencies.md

@@ -0,0 +1,70 @@
+# 🏧 🔗
+
+## 🔗 🔗
+
+🌐 🔗 👥 ✔️ 👀 🔧 🔢 ⚖️ 🎓.
+
+✋️ 📤 💪 💼 🌐❔ 👆 💚 💪 ⚒ 🔢 🔛 🔗, 🍵 ✔️ 📣 📚 🎏 🔢 ⚖️ 🎓.
+
+➡️ 🌈 👈 👥 💚 ✔️ 🔗 👈 ✅ 🚥 🔢 🔢 `q` 🔌 🔧 🎚.
+
+✋️ 👥 💚 💪 🔗 👈 🔧 🎚.
+
+##  "🇧🇲" 👐
+
+🐍 📤 🌌 ⚒ 👐 🎓 "🇧🇲".
+
+🚫 🎓 ⚫️ (❔ ⏪ 🇧🇲), ✋️ 👐 👈 🎓.
+
+👈, 👥 📣 👩‍🔬 `__call__`:
+
+```Python hl_lines="10"
+{!../../../docs_src/dependencies/tutorial011.py!}
+```
+
+👉 💼, 👉 `__call__` ⚫️❔ **FastAPI** 🔜 ⚙️ ✅ 🌖 🔢 & 🎧-🔗, & 👉 ⚫️❔ 🔜 🤙 🚶‍♀️ 💲 🔢 👆 *➡ 🛠️ 🔢* ⏪.
+
+## 🔗 👐
+
+& 🔜, 👥 💪 ⚙️ `__init__` 📣 🔢 👐 👈 👥 💪 ⚙️ "🔗" 🔗:
+
+```Python hl_lines="7"
+{!../../../docs_src/dependencies/tutorial011.py!}
+```
+
+👉 💼, **FastAPI** 🏆 🚫 ⏱ 👆 ⚖️ 💅 🔃 `__init__`, 👥 🔜 ⚙️ ⚫️ 🔗 👆 📟.
+
+## ✍ 👐
+
+👥 💪 ✍ 👐 👉 🎓 ⏮️:
+
+```Python hl_lines="16"
+{!../../../docs_src/dependencies/tutorial011.py!}
+```
+
+& 👈 🌌 👥 💪 "🔗" 👆 🔗, 👈 🔜 ✔️ `"bar"` 🔘 ⚫️, 🔢 `checker.fixed_content`.
+
+## ⚙️ 👐 🔗
+
+⤴️, 👥 💪 ⚙️ 👉 `checker` `Depends(checker)`, ↩️ `Depends(FixedContentQueryChecker)`, ↩️ 🔗 👐, `checker`, 🚫 🎓 ⚫️.
+
+& 🕐❔ ❎ 🔗, **FastAPI** 🔜 🤙 👉 `checker` 💖:
+
+```Python
+checker(q="somequery")
+```
+
+...& 🚶‍♀️ ⚫️❔ 👈 📨 💲 🔗 👆 *➡ 🛠️ 🔢* 🔢 `fixed_content_included`:
+
+```Python hl_lines="20"
+{!../../../docs_src/dependencies/tutorial011.py!}
+```
+
+!!! tip
+    🌐 👉 💪 😑 🎭. & ⚫️ 💪 🚫 📶 🆑 ❔ ⚫️ ⚠.
+
+    👫 🖼 😫 🙅, ✋️ 🎦 ❔ ⚫️ 🌐 👷.
+
+    📃 🔃 💂‍♂, 📤 🚙 🔢 👈 🛠️ 👉 🎏 🌌.
+
+    🚥 👆 🤔 🌐 👉, 👆 ⏪ 💭 ❔ 👈 🚙 🧰 💂‍♂ 👷 🔘.

docs/em/docs/advanced/async-sql-databases.md

@@ -0,0 +1,162 @@
+# 🔁 🗄 (🔗) 💽
+
+👆 💪 ⚙️ <a href="https://github.com/encode/databases" class="external-link" target="_blank">`encode/databases`</a> ⏮️ **FastAPI** 🔗 💽 ⚙️ `async` &amp; `await`.
+
+⚫️ 🔗 ⏮️:
+
+* ✳
+* ✳
+* 🗄
+
+👉 🖼, 👥 🔜 ⚙️ **🗄**, ↩️ ⚫️ ⚙️ 👁 📁 &amp; 🐍 ✔️ 🛠️ 🐕‍🦺. , 👆 💪 📁 👉 🖼 &amp; 🏃 ⚫️.
+
+⏪, 👆 🏭 🈸, 👆 💪 💚 ⚙️ 💽 💽 💖 **✳**.
+
+!!! tip
+    👆 💪 🛠️ 💭 ⚪️➡️ 📄 🔃 🇸🇲 🐜 ([🗄 (🔗) 💽](../tutorial/sql-databases.md){.internal-link target=_blank}), 💖 ⚙️ 🚙 🔢 🎭 🛠️ 💽, 🔬 👆 **FastAPI** 📟.
+
+    👉 📄 🚫 ✔ 📚 💭, 🌓 😑 <a href="https://www.starlette.io/database/" class="external-link" target="_blank">💃</a>.
+
+## 🗄 &amp; ⚒ 🆙 `SQLAlchemy`
+
+* 🗄 `SQLAlchemy`.
+* ✍ `metadata` 🎚.
+* ✍ 🏓 `notes` ⚙️ `metadata` 🎚.
+
+```Python hl_lines="4  14  16-22"
+{!../../../docs_src/async_sql_databases/tutorial001.py!}
+```
+
+!!! tip
+    👀 👈 🌐 👉 📟 😁 🇸🇲 🐚.
+
+    `databases` 🚫 🔨 🕳 📥.
+
+## 🗄 &amp; ⚒ 🆙 `databases`
+
+* 🗄 `databases`.
+* ✍ `DATABASE_URL`.
+* ✍ `database` 🎚.
+
+```Python hl_lines="3  9  12"
+{!../../../docs_src/async_sql_databases/tutorial001.py!}
+```
+
+!!! tip
+    🚥 👆 🔗 🎏 💽 (✅ ✳), 👆 🔜 💪 🔀 `DATABASE_URL`.
+
+## ✍ 🏓
+
+👉 💼, 👥 🏗 🏓 🎏 🐍 📁, ✋️ 🏭, 👆 🔜 🎲 💚 ✍ 👫 ⏮️ ⚗, 🛠️ ⏮️ 🛠️, ♒️.
+
+📥, 👉 📄 🔜 🏃 🔗, ▶️️ ⏭ ▶️ 👆 **FastAPI** 🈸.
+
+* ✍ `engine`.
+* ✍ 🌐 🏓 ⚪️➡️ `metadata` 🎚.
+
+```Python hl_lines="25-28"
+{!../../../docs_src/async_sql_databases/tutorial001.py!}
+```
+
+## ✍ 🏷
+
+✍ Pydantic 🏷:
+
+* 🗒 ✍ (`NoteIn`).
+* 🗒 📨 (`Note`).
+
+```Python hl_lines="31-33  36-39"
+{!../../../docs_src/async_sql_databases/tutorial001.py!}
+```
+
+🏗 👫 Pydantic 🏷, 🔢 💽 🔜 ✔, 🎻 (🗜), &amp; ✍ (📄).
+
+, 👆 🔜 💪 👀 ⚫️ 🌐 🎓 🛠️ 🩺.
+
+## 🔗 &amp; 🔌
+
+* ✍ 👆 `FastAPI` 🈸.
+* ✍ 🎉 🐕‍🦺 🔗 &amp; 🔌 ⚪️➡️ 💽.
+
+```Python hl_lines="42  45-47  50-52"
+{!../../../docs_src/async_sql_databases/tutorial001.py!}
+```
+
+## ✍ 🗒
+
+✍ *➡ 🛠️ 🔢* ✍ 🗒:
+
+```Python hl_lines="55-58"
+{!../../../docs_src/async_sql_databases/tutorial001.py!}
+```
+
+!!! Note
+    👀 👈 👥 🔗 ⏮️ 💽 ⚙️ `await`, *➡ 🛠️ 🔢* 📣 ⏮️ `async`.
+
+### 👀 `response_model=List[Note]`
+
+⚫️ ⚙️ `typing.List`.
+
+👈 📄 (&amp; ✔, 🎻, ⛽) 🔢 💽, `list` `Note`Ⓜ.
+
+## ✍ 🗒
+
+✍ *➡ 🛠️ 🔢* ✍ 🗒:
+
+```Python hl_lines="61-65"
+{!../../../docs_src/async_sql_databases/tutorial001.py!}
+```
+
+!!! Note
+    👀 👈 👥 🔗 ⏮️ 💽 ⚙️ `await`, *➡ 🛠️ 🔢* 📣 ⏮️ `async`.
+
+### 🔃 `{**note.dict(), "id": last_record_id}`
+
+`note` Pydantic `Note` 🎚.
+
+`note.dict()` 📨 `dict` ⏮️ 🚮 💽, 🕳 💖:
+
+```Python
+{
+    "text": "Some note",
+    "completed": False,
+}
+```
+
+✋️ ⚫️ 🚫 ✔️ `id` 🏑.
+
+👥 ✍ 🆕 `dict`, 👈 🔌 🔑-💲 👫 ⚪️➡️ `note.dict()` ⏮️:
+
+```Python
+{**note.dict()}
+```
+
+`**note.dict()` "unpacks" the key value pairs directly, so, `{**note.dict()}` would be, more or less, a copy of `note.dict()`.
+
+&amp; ⤴️, 👥 ↔ 👈 📁 `dict`, ❎ ➕1️⃣ 🔑-💲 👫: `"id": last_record_id`:
+
+```Python
+{**note.dict(), "id": last_record_id}
+```
+
+, 🏁 🏁 📨 🔜 🕳 💖:
+
+```Python
+{
+    "id": 1,
+    "text": "Some note",
+    "completed": False,
+}
+```
+
+## ✅ ⚫️
+
+👆 💪 📁 👉 📟, &amp; 👀 🩺 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
+
+📤 👆 💪 👀 🌐 👆 🛠️ 📄 &amp; 🔗 ⏮️ ⚫️:
+
+<img src="/img/tutorial/async-sql-databases/image01.png">
+
+## 🌅 ℹ
+
+👆 💪 ✍ 🌅 🔃 <a href="https://github.com/encode/databases" class="external-link" target="_blank">`encode/databases` 🚮 📂 📃</a>.

docs/em/docs/advanced/async-tests.md

@@ -0,0 +1,92 @@
+# 🔁 💯
+
+👆 ✔️ ⏪ 👀 ❔ 💯 👆 **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>, &amp; ↩️, 👥 💪 ⚙️ ⚫️ 🔗 💯 🛠️.
+
+## 🖼
+
+🙅 🖼, ➡️ 🤔 📁 📊 🎏 1️⃣ 🔬 [🦏 🈸](../tutorial/bigger-applications.md){.internal-link target=_blank} &amp; [🔬](../tutorial/testing.md){.internal-link target=_blank}:
+
+```
+.
+├── app
+│   ├── __init__.py
+│   ├── main.py
+│   └── test_main.py
+```
+
+📁 `main.py` 🔜 ✔️:
+
+```Python
+{!../../../docs_src/async_tests/main.py!}
+```
+
+📁 `test_main.py` 🔜 ✔️ 💯 `main.py`, ⚫️ 💪 👀 💖 👉 🔜:
+
+```Python
+{!../../../docs_src/async_tests/test_main.py!}
+```
+
+## 🏃 ⚫️
+
+👆 💪 🏃 👆 💯 🐌 📨:
+
+<div class="termy">
+
+```console
+$ pytest
+
+---> 100%
+```
+
+</div>
+
+## ℹ
+
+📑 `@pytest.mark.anyio` 💬 ✳ 👈 👉 💯 🔢 🔜 🤙 🔁:
+
+```Python hl_lines="7"
+{!../../../docs_src/async_tests/test_main.py!}
+```
+
+!!! tip
+    🗒 👈 💯 🔢 🔜 `async def` ↩️ `def` ⏭ 🕐❔ ⚙️ `TestClient`.
+
+⤴️ 👥 💪 ✍ `AsyncClient` ⏮️ 📱, &amp; 📨 🔁 📨 ⚫️, ⚙️ `await`.
+
+```Python hl_lines="9-10"
+{!../../../docs_src/async_tests/test_main.py!}
+```
+
+👉 🌓:
+
+```Python
+response = client.get('/')
+```
+
+...👈 👥 ⚙️ ⚒ 👆 📨 ⏮️ `TestClient`.
+
+!!! tip
+    🗒 👈 👥 ⚙️ 🔁/⌛ ⏮️ 🆕 `AsyncClient` - 📨 🔁.
+
+## 🎏 🔁 🔢 🤙
+
+🔬 🔢 🔜 🔁, 👆 💪 🔜 🤙 (&amp; `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")` ⏲.

docs/em/docs/advanced/behind-a-proxy.md

@@ -0,0 +1,346 @@
+# ⛅ 🗳
+
+⚠, 👆 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` 👉 ⚙️ 💼.
+
+     &amp; `--root-path` 📋 ⏸ 🎛 🚚 👈 `root_path`.
+
+### ✅ ⏮️ `root_path`
+
+👆 💪 🤚 ⏮️ `root_path` ⚙️ 👆 🈸 🔠 📨, ⚫️ 🍕 `scope` 📖 (👈 🍕 🔫 🔌).
+
+📥 👥 ✅ ⚫️ 📧 🎦 🎯.
+
+```Python hl_lines="8"
+{!../../../docs_src/behind_a_proxy/tutorial001.py!}
+```
+
+⤴️, 🚥 👆 ▶️ 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 📱:
+
+```Python hl_lines="3"
+{!../../../docs_src/behind_a_proxy/tutorial002.py!}
+```
+
+🚶‍♀️ `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`, &amp; ⤴️ ⚫️ 🔜 🗳 🎯 🚮 ➕ `/api/v1` 🔡 🔛 🔝.
+
+## 🔃 🗳 ⏮️ 🎞 ➡ 🔡
+
+✔️ 🤯 👈 🗳 ⏮️ 🎞 ➡ 🔡 🕴 1️⃣ 🌌 🔗 ⚫️.
+
+🎲 📚 💼 🔢 🔜 👈 🗳 🚫 ✔️ 🏚 ➡ 🔡.
+
+💼 💖 👈 (🍵 🎞 ➡ 🔡), 🗳 🔜 👂 🔛 🕳 💖 `https://myawesomeapp.com`, &amp; ⤴️ 🚥 🖥 🚶 `https://myawesomeapp.com/api/v1/app` &amp; 👆 💽 (✅ 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>, ⚫️ 👁 💱, 👆 💪 ⚗ 🗜 📁 &amp; 🏃 ⚫️ 🔗 ⚪️➡️ 📶.
+
+⤴️ ✍ 📁 `traefik.toml` ⏮️:
+
+```TOML hl_lines="3"
+[entryPoints]
+  [entryPoints.http]
+    address = ":9999"
+
+[providers]
+  [providers.file]
+    filename = "routes.toml"
+```
+
+👉 💬 Traefik 👂 🔛 ⛴ 9️⃣9️⃣9️⃣9️⃣ &amp; ⚙️ ➕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`.
+
+&amp; ⤴️ ⚫️ 🔜 ❎ 🚮 📨 👆 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>
+
+&amp; 🔜 ▶️ 👆 📱 ⏮️ 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`.
+
+&amp; 🔜 📂 📛 ⏮️ ⛴ 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️⃣.
+
+&amp; ⏬ 🍵 ➡ 🔡 (`http://127.0.0.1:8000/app`), 🚚 Uvicorn 🔗, 🔜 🎯 _🗳_ (Traefik) 🔐 ⚫️.
+
+👈 🎦 ❔ 🗳 (Traefik) ⚙️ ➡ 🔡 &amp; ❔ 💽 (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`, 🖼 🚥 👆 💚 *🎏* 🩺 🎚 🔗 ⏮️ 🏗 &amp; 🏭 🌐.
+
+🚥 👆 🚶‍♀️ 🛃 📇 `servers` &amp; 📤 `root_path` (↩️ 👆 🛠️ 👨‍❤‍👨 ⛅ 🗳), **FastAPI** 🔜 📩 "💽" ⏮️ 👉 `root_path` ▶️ 📇.
+
+🖼:
+
+```Python hl_lines="4-7"
+{!../../../docs_src/behind_a_proxy/tutorial003.py!}
+```
+
+🔜 🏗 🗄 🔗 💖:
+
+```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`:
+
+```Python hl_lines="9"
+{!../../../docs_src/behind_a_proxy/tutorial004.py!}
+```
+
+&amp; ⤴️ ⚫️ 🏆 🚫 🔌 ⚫️ 🗄 🔗.
+
+## 🗜 🎧-🈸
+
+🚥 👆 💪 🗻 🎧-🈸 (🔬 [🎧 🈸 - 🗻](./sub-applications.md){.internal-link target=_blank}) ⏪ ⚙️ 🗳 ⏮️ `root_path`, 👆 💪 ⚫️ 🛎, 👆 🔜 ⌛.
+
+FastAPI 🔜 🔘 ⚙️ `root_path` 🎆, ⚫️ 🔜 👷. 👶

docs/em/docs/advanced/custom-response.md

@@ -0,0 +1,300 @@
+# 🛃 📨 - 🕸, 🎏, 📁, 🎏
+
+🔢, **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`
+
+🖼, 🚥 👆 ✊ 🎭, 👆 💪 ❎ &amp; ⚙️ <a href="https://github.com/ijl/orjson" class="external-link" target="_blank">`orjson`</a> &amp; ⚒ 📨 `ORJSONResponse`.
+
+🗄 `Response` 🎓 (🎧-🎓) 👆 💚 ⚙️ &amp; 📣 ⚫️ *➡ 🛠️ 👨‍🎨*.
+
+⭕ 📨, 📨 `Response` 🔗 🌅 ⏩ 🌘 🛬 📖.
+
+👉 ↩️ 🔢, FastAPI 🔜 ✔ 🔠 🏬 🔘 &amp; ⚒ 💭 ⚫️ 🎻 ⏮️ 🎻, ⚙️ 🎏 [🎻 🔗 🔢](../tutorial/encoder.md){.internal-link target=_blank} 🔬 🔰. 👉 ⚫️❔ ✔ 👆 📨 **❌ 🎚**, 🖼 💽 🏷.
+
+✋️ 🚥 👆 🎯 👈 🎚 👈 👆 🛬 **🎻 ⏮️ 🎻**, 👆 💪 🚶‍♀️ ⚫️ 🔗 📨 🎓 &amp; ❎ ➕ 🌥 👈 FastAPI 🔜 ✔️ 🚶‍♀️ 👆 📨 🎚 🔘 `jsonable_encoder` ⏭ 🚶‍♀️ ⚫️ 📨 🎓.
+
+```Python hl_lines="2  7"
+{!../../../docs_src/custom_response/tutorial001b.py!}
+```
+
+!!! info
+    🔢 `response_class` 🔜 ⚙️ 🔬 "📻 🆎" 📨.
+
+    👉 💼, 🇺🇸🔍 🎚 `Content-Type` 🔜 ⚒ `application/json`.
+
+     &amp; ⚫️ 🔜 📄 ✅ 🗄.
+
+!!! tip
+     `ORJSONResponse` ⏳ 🕴 💪 FastAPI, 🚫 💃.
+
+## 🕸 📨
+
+📨 📨 ⏮️ 🕸 🔗 ⚪️➡️ **FastAPI**, ⚙️ `HTMLResponse`.
+
+* 🗄 `HTMLResponse`.
+* 🚶‍♀️ `HTMLResponse` 🔢 `response_class` 👆 *➡ 🛠️ 👨‍🎨*.
+
+```Python hl_lines="2  7"
+{!../../../docs_src/custom_response/tutorial002.py!}
+```
+
+!!! info
+    🔢 `response_class` 🔜 ⚙️ 🔬 "📻 🆎" 📨.
+
+    👉 💼, 🇺🇸🔍 🎚 `Content-Type` 🔜 ⚒ `text/html`.
+
+     &amp; ⚫️ 🔜 📄 ✅ 🗄.
+
+### 📨 `Response`
+
+👀 [📨 📨 🔗](response-directly.md){.internal-link target=_blank}, 👆 💪 🔐 📨 🔗 👆 *➡ 🛠️*, 🛬 ⚫️.
+
+🎏 🖼 ⚪️➡️ 🔛, 🛬 `HTMLResponse`, 💪 👀 💖:
+
+```Python hl_lines="2  7  19"
+{!../../../docs_src/custom_response/tutorial003.py!}
+```
+
+!!! warning
+     `Response` 📨 🔗 👆 *➡ 🛠️ 🔢* 🏆 🚫 📄 🗄 (🖼, `Content-Type` 🏆 🚫 📄) &amp; 🏆 🚫 ⭐ 🏧 🎓 🩺.
+
+!!! info
+    ↗️, ☑ `Content-Type` 🎚, 👔 📟, ♒️, 🔜 👟 ⚪️➡️ `Response` 🎚 👆 📨.
+
+### 📄 🗄 &amp; 🔐 `Response`
+
+🚥 👆 💚 🔐 📨 ⚪️➡️ 🔘 🔢 ✋️ 🎏 🕰 📄 "📻 🆎" 🗄, 👆 💪 ⚙️ `response_class` 🔢 &amp; 📨 `Response` 🎚.
+
+`response_class` 🔜 ⤴️ ⚙️ 🕴 📄 🗄 *➡ 🛠️*, ✋️ 👆 `Response` 🔜 ⚙️.
+
+#### 📨 `HTMLResponse` 🔗
+
+🖼, ⚫️ 💪 🕳 💖:
+
+```Python hl_lines="7  21  23"
+{!../../../docs_src/custom_response/tutorial004.py!}
+```
+
+👉 🖼, 🔢 `generate_html_response()` ⏪ 🏗 &amp; 📨 `Response` ↩️ 🛬 🕸 `str`.
+
+🛬 🏁 🤙 `generate_html_response()`, 👆 ⏪ 🛬 `Response` 👈 🔜 🔐 🔢 **FastAPI** 🎭.
+
+✋️ 👆 🚶‍♀️ `HTMLResponse` `response_class` 💁‍♂️, **FastAPI** 🔜 💭 ❔ 📄 ⚫️ 🗄 &amp; 🎓 🩺 🕸 ⏮️ `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 (🤙 💃) 🔜 🔁 🔌 🎚-📐 🎚. ⚫️ 🔜 🔌 🎚-🆎 🎚, ⚓️ 🔛 = &amp; 🔁 = ✍ 🆎.
+
+```Python hl_lines="1  18"
+{!../../../docs_src/response_directly/tutorial002.py!}
+```
+
+### `HTMLResponse`
+
+✊ ✍ ⚖️ 🔢 &amp; 📨 🕸 📨, 👆 ✍ 🔛.
+
+### `PlainTextResponse`
+
+✊ ✍ ⚖️ 🔢 &amp; 📨 ✅ ✍ 📨.
+
+```Python hl_lines="2  7  9"
+{!../../../docs_src/custom_response/tutorial005.py!}
+```
+
+### `JSONResponse`
+
+✊ 💽 &amp; 📨 `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` 🌘 💛 🌘 🐍 🏗-🛠️ ❔ ⚫️ 🍵 📐-💼.
+
+```Python hl_lines="2  7"
+{!../../../docs_src/custom_response/tutorial001.py!}
+```
+
+!!! tip
+    ⚫️ 💪 👈 `ORJSONResponse` 💪 ⏩ 🎛.
+
+### `RedirectResponse`
+
+📨 🇺🇸🔍 ❎. ⚙️ 3️⃣0️⃣7️⃣ 👔 📟 (🍕 ❎) 🔢.
+
+👆 💪 📨 `RedirectResponse` 🔗:
+
+```Python hl_lines="2  9"
+{!../../../docs_src/custom_response/tutorial006.py!}
+```
+
+---
+
+⚖️ 👆 💪 ⚙️ ⚫️ `response_class` 🔢:
+
+
+```Python hl_lines="2  7  9"
+{!../../../docs_src/custom_response/tutorial006b.py!}
+```
+
+🚥 👆 👈, ⤴️ 👆 💪 📨 📛 🔗 ⚪️➡️ 👆 *➡ 🛠️* 🔢.
+
+👉 💼, `status_code` ⚙️ 🔜 🔢 1️⃣ `RedirectResponse`, ❔ `307`.
+
+---
+
+👆 💪 ⚙️ `status_code` 🔢 🌀 ⏮️ `response_class` 🔢:
+
+```Python hl_lines="2  7  9"
+{!../../../docs_src/custom_response/tutorial006c.py!}
+```
+
+### `StreamingResponse`
+
+✊ 🔁 🚂 ⚖️ 😐 🚂/🎻 &amp; 🎏 📨 💪.
+
+```Python hl_lines="2  14"
+{!../../../docs_src/custom_response/tutorial007.py!}
+```
+
+#### ⚙️ `StreamingResponse` ⏮️ 📁-💖 🎚
+
+🚥 👆 ✔️ 📁-💖 🎚 (✅ 🎚 📨 `open()`), 👆 💪 ✍ 🚂 🔢 🔁 🤭 👈 📁-💖 🎚.
+
+👈 🌌, 👆 🚫 ✔️ ✍ ⚫️ 🌐 🥇 💾, &amp; 👆 💪 🚶‍♀️ 👈 🚂 🔢 `StreamingResponse`, &amp; 📨 ⚫️.
+
+👉 🔌 📚 🗃 🔗 ⏮️ ☁ 💾, 📹 🏭, &amp; 🎏.
+
+```{ .python .annotate hl_lines="2  10-12  14" }
+{!../../../docs_src/custom_response/tutorial008.py!}
+```
+
+1️⃣. 👉 🚂 🔢. ⚫️ "🚂 🔢" ↩️ ⚫️ 🔌 `yield` 📄 🔘.
+2️⃣. ⚙️ `with` 🍫, 👥 ⚒ 💭 👈 📁-💖 🎚 📪 ⏮️ 🚂 🔢 🔨. , ⏮️ ⚫️ 🏁 📨 📨.
+3️⃣. 👉 `yield from` 💬 🔢 🔁 🤭 👈 👜 🌟 `file_like`. &amp; ⤴️, 🔠 🍕 🔁, 🌾 👈 🍕 👟 ⚪️➡️ 👉 🚂 🔢.
+
+    , ⚫️ 🚂 🔢 👈 📨 "🏭" 👷 🕳 🙆 🔘.
+
+    🔨 ⚫️ 👉 🌌, 👥 💪 🚮 ⚫️ `with` 🍫, &amp; 👈 🌌, 🚚 👈 ⚫️ 📪 ⏮️ 🏁.
+
+!!! tip
+    👀 👈 📥 👥 ⚙️ 🐩 `open()` 👈 🚫 🐕‍🦺 `async` &amp; `await`, 👥 📣 ➡ 🛠️ ⏮️ 😐 `def`.
+
+### `FileResponse`
+
+🔁 🎏 📁 📨.
+
+✊ 🎏 ⚒ ❌ 🔗 🌘 🎏 📨 🆎:
+
+* `path` - 📁 📁 🎏.
+* `headers` - 🙆 🛃 🎚 🔌, 📖.
+* `media_type` - 🎻 🤝 📻 🆎. 🚥 🔢, 📁 ⚖️ ➡ 🔜 ⚙️ 🔑 📻 🆎.
+* `filename` - 🚥 ⚒, 👉 🔜 🔌 📨 `Content-Disposition`.
+
+📁 📨 🔜 🔌 ☑ `Content-Length`, `Last-Modified` &amp; `ETag` 🎚.
+
+```Python hl_lines="2  10"
+{!../../../docs_src/custom_response/tutorial009.py!}
+```
+
+👆 💪 ⚙️ `response_class` 🔢:
+
+```Python hl_lines="2  8  10"
+{!../../../docs_src/custom_response/tutorial009b.py!}
+```
+
+👉 💼, 👆 💪 📨 📁 ➡ 🔗 ⚪️➡️ 👆 *➡ 🛠️* 🔢.
+
+## 🛃 📨 🎓
+
+👆 💪 ✍ 👆 👍 🛃 📨 🎓, 😖 ⚪️➡️ `Response` &amp; ⚙️ ⚫️.
+
+🖼, ➡️ 💬 👈 👆 💚 ⚙️ <a href="https://github.com/ijl/orjson" class="external-link" target="_blank">`orjson`</a>, ✋️ ⏮️ 🛃 ⚒ 🚫 ⚙️ 🔌 `ORJSONResponse` 🎓.
+
+➡️ 💬 👆 💚 ⚫️ 📨 🔂 &amp; 📁 🎻, 👆 💚 ⚙️ Orjson 🎛 `orjson.OPT_INDENT_2`.
+
+👆 💪 ✍ `CustomORJSONResponse`. 👑 👜 👆 ✔️ ✍ `Response.render(content)` 👩‍🔬 👈 📨 🎚 `bytes`:
+
+```Python hl_lines="9-14  17"
+{!../../../docs_src/custom_response/tutorial009c.py!}
+```
+
+🔜 ↩️ 🛬:
+
+```json
+{"message": "Hello World"}
+```
+
+...👉 📨 🔜 📨:
+
+```json
+{
+  "message": "Hello World"
+}
+```
+
+↗️, 👆 🔜 🎲 🔎 🌅 👍 🌌 ✊ 📈 👉 🌘 ❕ 🎻. 👶
+
+## 🔢 📨 🎓
+
+🕐❔ 🏗 **FastAPI** 🎓 👐 ⚖️ `APIRouter` 👆 💪 ✔ ❔ 📨 🎓 ⚙️ 🔢.
+
+🔢 👈 🔬 👉 `default_response_class`.
+
+🖼 🔛, **FastAPI** 🔜 ⚙️ `ORJSONResponse` 🔢, 🌐 *➡ 🛠️*, ↩️ `JSONResponse`.
+
+```Python hl_lines="2  4"
+{!../../../docs_src/custom_response/tutorial010.py!}
+```
+
+!!! tip
+    👆 💪 🔐 `response_class` *➡ 🛠️* ⏭.
+
+## 🌖 🧾
+
+👆 💪 📣 📻 🆎 &amp; 📚 🎏 ℹ 🗄 ⚙️ `responses`: [🌖 📨 🗄](additional-responses.md){.internal-link target=_blank}.

docs/em/docs/advanced/dataclasses.md

@@ -0,0 +1,98 @@
+# ⚙️ 🎻
+
+FastAPI 🏗 🔛 🔝 **Pydantic**, & 👤 ✔️ 🌏 👆 ❔ ⚙️ Pydantic 🏷 📣 📨 & 📨.
+
+✋️ FastAPI 🐕‍🦺 ⚙️ <a href="https://docs.python.org/3/library/dataclasses.html" class="external-link" target="_blank">`dataclasses`</a> 🎏 🌌:
+
+```Python hl_lines="1  7-12  19-20"
+{!../../../docs_src/dataclasses/tutorial001.py!}
+```
+
+👉 🐕‍🦺 👏 **Pydantic**, ⚫️ ✔️ <a href="https://pydantic-docs.helpmanual.io/usage/dataclasses/#use-of-stdlib-dataclasses-with-basemodel" class="external-link" target="_blank">🔗 🐕‍🦺 `dataclasses`</a>.
+
+, ⏮️ 📟 🔛 👈 🚫 ⚙️ Pydantic 🎯, FastAPI ⚙️ Pydantic 🗜 📚 🐩 🎻 Pydantic 👍 🍛 🎻.
+
+&amp; ↗️, ⚫️ 🐕‍🦺 🎏:
+
+* 💽 🔬
+* 💽 🛠️
+* 💽 🧾, ♒️.
+
+👉 👷 🎏 🌌 ⏮️ Pydantic 🏷. &amp; ⚫️ 🤙 🏆 🎏 🌌 🔘, ⚙️ Pydantic.
+
+!!! info
+    ✔️ 🤯 👈 🎻 💪 🚫 🌐 Pydantic 🏷 💪.
+
+    , 👆 5️⃣📆 💪 ⚙️ Pydantic 🏷.
+
+    ✋️ 🚥 👆 ✔️ 📚 🎻 🤥 🤭, 👉 👌 🎱 ⚙️ 👫 🏋️ 🕸 🛠️ ⚙️ FastAPI. 👶
+
+## 🎻 `response_model`
+
+👆 💪 ⚙️ `dataclasses` `response_model` 🔢:
+
+```Python hl_lines="1  7-13  19"
+{!../../../docs_src/dataclasses/tutorial002.py!}
+```
+
+🎻 🔜 🔁 🗜 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` &amp; `async def` 💪.
+
+    🚥 👆 💪 ↗️ 🔃 🕐❔ ⚙️ ❔, ✅ 👅 📄 _"🏃 ❓" _ 🩺 🔃 <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank" class="internal-link">`async` &amp; `await`</a>.
+
+9️⃣. 👉 *➡ 🛠️ 🔢* 🚫 🛬 🎻 (👐 ⚫️ 💪), ✋️ 📇 📖 ⏮️ 🔗 💽.
+
+    FastAPI 🔜 ⚙️ `response_model` 🔢 (👈 🔌 🎻) 🗜 📨.
+
+👆 💪 🌀 `dataclasses` ⏮️ 🎏 🆎 ✍ 📚 🎏 🌀 📨 🏗 📊 📊.
+
+✅-📟 ✍ 💁‍♂ 🔛 👀 🌅 🎯 ℹ.
+
+## 💡 🌅
+
+👆 💪 🌀 `dataclasses` ⏮️ 🎏 Pydantic 🏷, 😖 ⚪️➡️ 👫, 🔌 👫 👆 👍 🏷, ♒️.
+
+💡 🌅, ✅ <a href="https://pydantic-docs.helpmanual.io/usage/dataclasses/" class="external-link" target="_blank">Pydantic 🩺 🔃 🎻</a>.
+
+## ⏬
+
+👉 💪 ↩️ FastAPI ⏬ `0.67.0`. 👶

docs/em/docs/advanced/events.md

@@ -0,0 +1,160 @@
+# 🔆 🎉
+
+👆 💪 🔬 ⚛ (📟) 👈 🔜 🛠️ ⏭ 🈸 **▶️ 🆙**. 👉 ⛓ 👈 👉 📟 🔜 🛠️ **🕐**, **⏭** 🈸 **▶️ 📨 📨**.
+
+🎏 🌌, 👆 💪 🔬 ⚛ (📟) 👈 🔜 🛠️ 🕐❔ 🈸 **🤫 🔽**. 👉 💼, 👉 📟 🔜 🛠️ **🕐**, **⏮️** ✔️ 🍵 🎲 **📚 📨**.
+
+↩️ 👉 📟 🛠️ ⏭ 🈸 **▶️** ✊ 📨, & ▶️️ ⏮️ ⚫️ **🏁** 🚚 📨, ⚫️ 📔 🎂 🈸 **🔆** (🔤 "🔆" 🔜 ⚠ 🥈 👶).
+
+👉 💪 📶 ⚠ ⚒ 🆙 **ℹ** 👈 👆 💪 ⚙️ 🎂 📱, & 👈 **💰** 👪 📨, &/⚖️ 👈 👆 💪 **🧹 🆙** ⏮️. 🖼, 💽 🔗 🎱, ⚖️ 🚚 🔗 🎰 🏫 🏷.
+
+## ⚙️ 💼
+
+➡️ ▶️ ⏮️ 🖼 **⚙️ 💼** & ⤴️ 👀 ❔ ❎ ⚫️ ⏮️ 👉.
+
+➡️ 🌈 👈 👆 ✔️ **🎰 🏫 🏷** 👈 👆 💚 ⚙️ 🍵 📨. 👶
+
+🎏 🏷 🔗 👪 📨,, ⚫️ 🚫 1️⃣ 🏷 📍 📨, ⚖️ 1️⃣ 📍 👩‍💻 ⚖️ 🕳 🎏.
+
+➡️ 🌈 👈 🚚 🏷 💪 **✊ 🕰**, ↩️ ⚫️ ✔️ ✍ 📚 **💽 ⚪️➡️ 💾**. 👆 🚫 💚 ⚫️ 🔠 📨.
+
+👆 💪 📐 ⚫️ 🔝 🎚 🕹/📁, ✋️ 👈 🔜 ⛓ 👈 ⚫️ 🔜 **📐 🏷** 🚥 👆 🏃‍♂ 🙅 🏧 💯, ⤴️ 👈 💯 🔜 **🐌** ↩️ ⚫️ 🔜 ✔️ ⌛ 🏷 📐 ⏭ 💆‍♂ 💪 🏃 🔬 🍕 📟.
+
+👈 ⚫️❔ 👥 🔜 ❎, ➡️ 📐 🏷 ⏭ 📨 🍵, ✋️ 🕴 ▶️️ ⏭ 🈸 ▶️ 📨 📨, 🚫 ⏪ 📟 ➖ 📐.
+
+## 🔆
+
+👆 💪 🔬 👉 *🕴* & *🤫* ⚛ ⚙️ `lifespan` 🔢 `FastAPI` 📱, & "🔑 👨‍💼" (👤 🔜 🎦 👆 ⚫️❔ 👈 🥈).
+
+➡️ ▶️ ⏮️ 🖼 & ⤴️ 👀 ⚫️ ℹ.
+
+👥 ✍ 🔁 🔢 `lifespan()` ⏮️ `yield` 💖 👉:
+
+```Python hl_lines="16  19"
+{!../../../docs_src/events/tutorial003.py!}
+```
+
+📥 👥 ⚖ 😥 *🕴* 🛠️ 🚚 🏷 🚮 (❌) 🏷 🔢 📖 ⏮️ 🎰 🏫 🏷 ⏭ `yield`. 👉 📟 🔜 🛠️ **⏭** 🈸 **▶️ ✊ 📨**, ⏮️ *🕴*.
+
+& ⤴️, ▶️️ ⏮️ `yield`, 👥 🚚 🏷. 👉 📟 🔜 🛠️ **⏮️** 🈸 **🏁 🚚 📨**, ▶️️ ⏭ *🤫*. 👉 💪, 🖼, 🚀 ℹ 💖 💾 ⚖️ 💻.
+
+!!! tip
+     `shutdown` 🔜 🔨 🕐❔ 👆 **⛔️** 🈸.
+
+    🎲 👆 💪 ▶️ 🆕 ⏬, ⚖️ 👆 🤚 🎡 🏃 ⚫️. 🤷
+
+### 🔆 🔢
+
+🥇 👜 👀, 👈 👥 ⚖ 🔁 🔢 ⏮️ `yield`. 👉 📶 🎏 🔗 ⏮️ `yield`.
+
+```Python hl_lines="14-19"
+{!../../../docs_src/events/tutorial003.py!}
+```
+
+🥇 🍕 🔢, ⏭ `yield`, 🔜 🛠️ **⏭** 🈸 ▶️.
+
+& 🍕 ⏮️ `yield` 🔜 🛠️ **⏮️** 🈸 ✔️ 🏁.
+
+### 🔁 🔑 👨‍💼
+
+🚥 👆 ✅, 🔢 🎀 ⏮️ `@asynccontextmanager`.
+
+👈 🗜 🔢 🔘 🕳 🤙 "**🔁 🔑 👨‍💼**".
+
+```Python hl_lines="1  13"
+{!../../../docs_src/events/tutorial003.py!}
+```
+
+**🔑 👨‍💼** 🐍 🕳 👈 👆 💪 ⚙️ `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` 🔁 🔑 👨‍💼 ⚫️.
+
+```Python hl_lines="22"
+{!../../../docs_src/events/tutorial003.py!}
+```
+
+## 🎛 🎉 (😢)
+
+!!! warning
+    👍 🌌 🍵 *🕴* & *🤫* ⚙️ `lifespan` 🔢 `FastAPI` 📱 🔬 🔛.
+
+    👆 💪 🎲 🚶 👉 🍕.
+
+📤 🎛 🌌 🔬 👉 ⚛ 🛠️ ⏮️ *🕴* & ⏮️ *🤫*.
+
+👆 💪 🔬 🎉 🐕‍🦺 (🔢) 👈 💪 🛠️ ⏭ 🈸 ▶️ 🆙, ⚖️ 🕐❔ 🈸 🤫 🔽.
+
+👫 🔢 💪 📣 ⏮️ `async def` ⚖️ 😐 `def`.
+
+### `startup` 🎉
+
+🚮 🔢 👈 🔜 🏃 ⏭ 🈸 ▶️, 📣 ⚫️ ⏮️ 🎉 `"startup"`:
+
+```Python hl_lines="8"
+{!../../../docs_src/events/tutorial001.py!}
+```
+
+👉 💼, `startup` 🎉 🐕‍🦺 🔢 🔜 🔢 🏬 "💽" ( `dict`) ⏮️ 💲.
+
+👆 💪 🚮 🌅 🌘 1️⃣ 🎉 🐕‍🦺 🔢.
+
+& 👆 🈸 🏆 🚫 ▶️ 📨 📨 ⏭ 🌐 `startup` 🎉 🐕‍🦺 ✔️ 🏁.
+
+### `shutdown` 🎉
+
+🚮 🔢 👈 🔜 🏃 🕐❔ 🈸 🤫 🔽, 📣 ⚫️ ⏮️ 🎉 `"shutdown"`:
+
+```Python hl_lines="6"
+{!../../../docs_src/events/tutorial002.py!}
+```
+
+📥, `shutdown` 🎉 🐕‍🦺 🔢 🔜 ✍ ✍ ⏸ `"Application shutdown"` 📁 `log.txt`.
+
+!!! info
+     `open()` 🔢, `mode="a"` ⛓ "🎻",, ⏸ 🔜 🚮 ⏮️ ⚫️❔ 🔛 👈 📁, 🍵 📁 ⏮️ 🎚.
+
+!!! tip
+    👀 👈 👉 💼 👥 ⚙️ 🐩 🐍 `open()` 🔢 👈 🔗 ⏮️ 📁.
+
+    , ⚫️ 🔌 👤/🅾 (🔢/🔢), 👈 🚚 "⌛" 👜 ✍ 💾.
+
+    ✋️ `open()` 🚫 ⚙️ `async` & `await`.
+
+    , 👥 📣 🎉 🐕‍🦺 🔢 ⏮️ 🐩 `def` ↩️ `async def`.
+
+!!! info
+    👆 💪 ✍ 🌅 🔃 👫 🎉 🐕‍🦺 <a href="https://www.starlette.io/events/" class="external-link" target="_blank">💃 🎉' 🩺</a>.
+
+### `startup` &amp; `shutdown` 👯‍♂️
+
+📤 ↕ 🤞 👈 ⚛ 👆 *🕴* &amp; *🤫* 🔗, 👆 💪 💚 ▶️ 🕳 &amp; ⤴️ 🏁 ⚫️, 📎 ℹ &amp; ⤴️ 🚀 ⚫️, ♒️.
+
+🔨 👈 👽 🔢 👈 🚫 💰 ⚛ ⚖️ 🔢 👯‍♂️ 🌅 ⚠ 👆 🔜 💪 🏪 💲 🌐 🔢 ⚖️ 🎏 🎱.
+
+↩️ 👈, ⚫️ 🔜 👍 ↩️ ⚙️ `lifespan` 🔬 🔛.
+
+## 📡 ℹ
+
+📡 ℹ 😟 🤓. 👶
+
+🔘, 🔫 📡 🔧, 👉 🍕 <a href="https://asgi.readthedocs.io/en/latest/specs/lifespan.html" class="external-link" target="_blank">🔆 🛠️</a>, &amp; ⚫️ 🔬 🎉 🤙 `startup` &amp; `shutdown`.
+
+## 🎧 🈸
+
+👶 ✔️ 🤯 👈 👫 🔆 🎉 (🕴 &amp; 🤫) 🔜 🕴 🛠️ 👑 🈸, 🚫 [🎧 🈸 - 🗻](./sub-applications.md){.internal-link target=_blank}.

docs/em/docs/advanced/generate-clients.md

@@ -0,0 +1,267 @@
+# 🏗 👩‍💻
+
+**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/ferdikoomen/openapi-typescript-codegen" class="external-link" target="_blank">🗄-📕-🇦🇪</a>.
+
+## 🏗 📕 🕸 👩‍💻
+
+➡️ ▶️ ⏮️ 🙅 FastAPI 🈸:
+
+=== "🐍 3️⃣.6️⃣ &amp; 🔛"
+
+    ```Python hl_lines="9-11  14-15  18  19  23"
+    {!> ../../../docs_src/generate_clients/tutorial001.py!}
+    ```
+
+=== "🐍 3️⃣.9️⃣ &amp; 🔛"
+
+    ```Python hl_lines="7-9  12-13  16-17  21"
+    {!> ../../../docs_src/generate_clients/tutorial001_py39.py!}
+    ```
+
+👀 👈 *➡ 🛠️* 🔬 🏷 👫 ⚙️ 📨 🚀 &amp; 📨 🚀, ⚙️ 🏷 `Item` &amp; `ResponseMessage`.
+
+### 🛠️ 🩺
+
+🚥 👆 🚶 🛠️ 🩺, 👆 🔜 👀 👈 ⚫️ ✔️ **🔗** 📊 📨 📨 &amp; 📨 📨:
+
+<img src="/img/tutorial/generate-clients/image01.png">
+
+👆 💪 👀 👈 🔗 ↩️ 👫 📣 ⏮️ 🏷 📱.
+
+👈 ℹ 💪 📱 **🗄 🔗**, &amp; ⤴️ 🎦 🛠️ 🩺 (🦁 🎚).
+
+&amp; 👈 🎏 ℹ ⚪️➡️ 🏷 👈 🔌 🗄 ⚫️❔ 💪 ⚙️ **🏗 👩‍💻 📟**.
+
+### 🏗 📕 👩‍💻
+
+🔜 👈 👥 ✔️ 📱 ⏮️ 🏷, 👥 💪 🏗 👩‍💻 📟 🕸.
+
+#### ❎ `openapi-typescript-codegen`
+
+👆 💪 ❎ `openapi-typescript-codegen` 👆 🕸 📟 ⏮️:
+
+<div class="termy">
+
+```console
+$ npm install openapi-typescript-codegen --save-dev
+
+---> 100%
+```
+
+</div>
+
+#### 🏗 👩‍💻 📟
+
+🏗 👩‍💻 📟 👆 💪 ⚙️ 📋 ⏸ 🈸 `openapi` 👈 🔜 🔜 ❎.
+
+↩️ ⚫️ ❎ 🇧🇿 🏗, 👆 🎲 🚫🔜 💪 🤙 👈 📋 🔗, ✋️ 👆 🔜 🚮 ⚫️ 🔛 👆 `package.json` 📁.
+
+⚫️ 💪 👀 💖 👉:
+
+```JSON  hl_lines="7"
+{
+  "name": "frontend-app",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "generate-client": "openapi --input http://localhost:8000/openapi.json --output ./src/client --client axios"
+  },
+  "author": "",
+  "license": "",
+  "devDependencies": {
+    "openapi-typescript-codegen": "^0.20.1",
+    "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 --input http://localhost:8000/openapi.json --output ./src/client --client axios
+```
+
+</div>
+
+👈 📋 🔜 🏗 📟 `./src/client` &amp; 🔜 ⚙️ `axios` (🕸 🇺🇸🔍 🗃) 🔘.
+
+### 🔄 👅 👩‍💻 📟
+
+🔜 👆 💪 🗄 &amp; ⚙️ 👩‍💻 📟, ⚫️ 💪 👀 💖 👉, 👀 👈 👆 🤚 ✍ 👩‍🔬:
+
+<img src="/img/tutorial/generate-clients/image02.png">
+
+👆 🔜 🤚 ✍ 🚀 📨:
+
+<img src="/img/tutorial/generate-clients/image03.png">
+
+!!! tip
+    👀 ✍ `name` &amp; `price`, 👈 🔬 FastAPI 🈸, `Item` 🏷.
+
+👆 🔜 ✔️ ⏸ ❌ 📊 👈 👆 📨:
+
+<img src="/img/tutorial/generate-clients/image04.png">
+
+📨 🎚 🔜 ✔️ ✍:
+
+<img src="/img/tutorial/generate-clients/image05.png">
+
+## FastAPI 📱 ⏮️ 🔖
+
+📚 💼 👆 FastAPI 📱 🔜 🦏, &amp; 👆 🔜 🎲 ⚙️ 🔖 🎏 🎏 👪 *➡ 🛠️*.
+
+🖼, 👆 💪 ✔️ 📄 **🏬** &amp; ➕1️⃣ 📄 **👩‍💻**, &amp; 👫 💪 👽 🔖:
+
+
+=== "🐍 3️⃣.6️⃣ &amp; 🔛"
+
+    ```Python hl_lines="23  28  36"
+    {!> ../../../docs_src/generate_clients/tutorial002.py!}
+    ```
+
+=== "🐍 3️⃣.9️⃣ &amp; 🔛"
+
+    ```Python hl_lines="21  26  34"
+    {!> ../../../docs_src/generate_clients/tutorial002_py39.py!}
+    ```
+
+### 🏗 📕 👩‍💻 ⏮️ 🔖
+
+🚥 👆 🏗 👩‍💻 FastAPI 📱 ⚙️ 🔖, ⚫️ 🔜 🛎 🎏 👩‍💻 📟 ⚓️ 🔛 🔖.
+
+👉 🌌 👆 🔜 💪 ✔️ 👜 ✔ &amp; 👪 ☑ 👩‍💻 📟:
+
+<img src="/img/tutorial/generate-clients/image06.png">
+
+👉 💼 👆 ✔️:
+
+* `ItemsService`
+* `UsersService`
+
+### 👩‍💻 👩‍🔬 📛
+
+▶️️ 🔜 🏗 👩‍🔬 📛 💖 `createItemItemsPost` 🚫 👀 📶 🧹:
+
+```TypeScript
+ItemsService.createItemItemsPost({name: "Plumbus", price: 5})
+```
+
+...👈 ↩️ 👩‍💻 🚂 ⚙️ 🗄 🔗 **🛠️ 🆔** 🔠 *➡ 🛠️*.
+
+🗄 🚚 👈 🔠 🛠️ 🆔 😍 🤭 🌐 *➡ 🛠️*, FastAPI ⚙️ **🔢 📛**, **➡**, &amp; **🇺🇸🔍 👩‍🔬/🛠️** 🏗 👈 🛠️ 🆔, ↩️ 👈 🌌 ⚫️ 💪 ⚒ 💭 👈 🛠️ 🆔 😍.
+
+✋️ 👤 🔜 🎦 👆 ❔ 📉 👈 ⏭. 👶
+
+## 🛃 🛠️ 🆔 &amp; 👍 👩‍🔬 📛
+
+👆 💪 **🔀** 🌌 👫 🛠️ 🆔 **🏗** ⚒ 👫 🙅 &amp; ✔️ **🙅 👩‍🔬 📛** 👩‍💻.
+
+👉 💼 👆 🔜 ✔️ 🚚 👈 🔠 🛠️ 🆔 **😍** 🎏 🌌.
+
+🖼, 👆 💪 ⚒ 💭 👈 🔠 *➡ 🛠️* ✔️ 🔖, &amp; ⤴️ 🏗 🛠️ 🆔 ⚓️ 🔛 **🔖** &amp; *➡ 🛠️* **📛** (🔢 📛).
+
+### 🛃 🏗 😍 🆔 🔢
+
+FastAPI ⚙️ **😍 🆔** 🔠 *➡ 🛠️*, ⚫️ ⚙️ **🛠️ 🆔** &amp; 📛 🙆 💪 🛃 🏷, 📨 ⚖️ 📨.
+
+👆 💪 🛃 👈 🔢. ⚫️ ✊ `APIRoute` &amp; 🔢 🎻.
+
+🖼, 📥 ⚫️ ⚙️ 🥇 🔖 (👆 🔜 🎲 ✔️ 🕴 1️⃣ 🔖) &amp; *➡ 🛠️* 📛 (🔢 📛).
+
+👆 💪 ⤴️ 🚶‍♀️ 👈 🛃 🔢 **FastAPI** `generate_unique_id_function` 🔢:
+
+=== "🐍 3️⃣.6️⃣ &amp; 🔛"
+
+    ```Python hl_lines="8-9  12"
+    {!> ../../../docs_src/generate_clients/tutorial003.py!}
+    ```
+
+=== "🐍 3️⃣.9️⃣ &amp; 🔛"
+
+    ```Python hl_lines="6-7  10"
+    {!> ../../../docs_src/generate_clients/tutorial003_py39.py!}
+    ```
+
+### 🏗 📕 👩‍💻 ⏮️ 🛃 🛠️ 🆔
+
+🔜 🚥 👆 🏗 👩‍💻 🔄, 👆 🔜 👀 👈 ⚫️ ✔️ 📉 👩‍🔬 📛:
+
+<img src="/img/tutorial/generate-clients/image07.png">
+
+👆 👀, 👩‍🔬 📛 🔜 ✔️ 🔖 &amp; ⤴️ 🔢 📛, 🔜 👫 🚫 🔌 ℹ ⚪️➡️ 📛 ➡ &amp; 🇺🇸🔍 🛠️.
+
+### 🗜 🗄 🔧 👩‍💻 🚂
+
+🏗 📟 ✔️ **❎ ℹ**.
+
+👥 ⏪ 💭 👈 👉 👩‍🔬 🔗 **🏬** ↩️ 👈 🔤 `ItemsService` (✊ ⚪️➡️ 🔖), ✋️ 👥 ✔️ 📛 🔡 👩‍🔬 📛 💁‍♂️. 👶
+
+👥 🔜 🎲 💚 🚧 ⚫️ 🗄 🏢, 👈 🔜 🚚 👈 🛠️ 🆔 **😍**.
+
+✋️ 🏗 👩‍💻 👥 💪 **🔀** 🗄 🛠️ 🆔 ▶️️ ⏭ 🏭 👩‍💻, ⚒ 👈 👩‍🔬 📛 👌 &amp; **🧹**.
+
+👥 💪 ⏬ 🗄 🎻 📁 `openapi.json` &amp; ⤴️ 👥 💪 **❎ 👈 🔡 🔖** ⏮️ ✍ 💖 👉:
+
+```Python
+{!../../../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 --input ./openapi.json --output ./src/client --client axios"
+  },
+  "author": "",
+  "license": "",
+  "devDependencies": {
+    "openapi-typescript-codegen": "^0.20.1",
+    "typescript": "^4.6.2"
+  }
+}
+```
+
+⏮️ 🏭 🆕 👩‍💻, 👆 🔜 🔜 ✔️ **🧹 👩‍🔬 📛**, ⏮️ 🌐 **✍**, **⏸ ❌**, ♒️:
+
+<img src="/img/tutorial/generate-clients/image08.png">
+
+## 💰
+
+🕐❔ ⚙️ 🔁 🏗 👩‍💻 👆 🔜 **✍** :
+
+* 👩‍🔬.
+* 📨 🚀 💪, 🔢 🔢, ♒️.
+* 📨 🚀.
+
+👆 🔜 ✔️ **⏸ ❌** 🌐.
+
+&amp; 🕐❔ 👆 ℹ 👩‍💻 📟, &amp; **♻** 🕸, ⚫️ 🔜 ✔️ 🙆 🆕 *➡ 🛠️* 💪 👩‍🔬, 🗝 🕐 ❎, &amp; 🙆 🎏 🔀 🔜 🎨 🔛 🏗 📟. 👶
+
+👉 ⛓ 👈 🚥 🕳 🔀 ⚫️ 🔜 **🎨** 🔛 👩‍💻 📟 🔁. &amp; 🚥 👆 **🏗** 👩‍💻 ⚫️ 🔜 ❌ 👅 🚥 👆 ✔️ 🙆 **🔖** 📊 ⚙️.
+
+, 👆 🔜 **🔍 📚 ❌** 📶 ⏪ 🛠️ 🛵 ↩️ ✔️ ⌛ ❌ 🎦 🆙 👆 🏁 👩‍💻 🏭 &amp; ⤴️ 🔄 ℹ 🌐❔ ⚠. 👶

docs/em/docs/advanced/index.md

@@ -0,0 +1,24 @@
+# 🏧 👩‍💻 🦮
+
+## 🌖 ⚒
+
+👑 [🔰 - 👩‍💻 🦮](../tutorial/){.internal-link target=_blank} 🔜 🥃 🤝 👆 🎫 🔘 🌐 👑 ⚒ **FastAPI**.
+
+⏭ 📄 👆 🔜 👀 🎏 🎛, 📳, & 🌖 ⚒.
+
+!!! tip
+    ⏭ 📄 **🚫 🎯 "🏧"**.
+
+     & ⚫️ 💪 👈 👆 ⚙️ 💼, ⚗ 1️⃣ 👫.
+
+## ✍ 🔰 🥇
+
+👆 💪 ⚙️ 🏆 ⚒ **FastAPI** ⏮️ 💡 ⚪️➡️ 👑 [🔰 - 👩‍💻 🦮](../tutorial/){.internal-link target=_blank}.
+
+& ⏭ 📄 🤔 👆 ⏪ ✍ ⚫️, & 🤔 👈 👆 💭 👈 👑 💭.
+
+## 🏎.🅾 ↗️
+
+🚥 👆 🔜 💖 ✊ 🏧-🔰 ↗️ 🔗 👉 📄 🩺, 👆 💪 💚 ✅: <a href="https://testdriven.io/courses/tdd-fastapi/" class="external-link" target="_blank">💯-💾 🛠️ ⏮️ FastAPI &amp; ☁</a> **🏎.🅾**.
+
+👫 ⏳ 🩸 1️⃣0️⃣ 💯 🌐 💰 🛠️ **FastAPI**. 👶 👶

docs/em/docs/advanced/middleware.md

@@ -0,0 +1,99 @@
+# 🏧 🛠️
+
+👑 🔰 👆 ✍ ❔ 🚮 [🛃 🛠️](../tutorial/middleware.md){.internal-link target=_blank} 👆 🈸.
+
+& ⤴️ 👆 ✍ ❔ 🍵 [⚜ ⏮️ `CORSMiddleware`](../tutorial/cors.md){.internal-link target=_blank}.
+
+👉 📄 👥 🔜 👀 ❔ ⚙️ 🎏 🛠️.
+
+## ❎ 🔫 🛠️
+
+**FastAPI** ⚓️ 🔛 💃 &amp; 🛠️ <abbr title="Asynchronous Server Gateway Interface">🔫</abbr> 🔧, 👆 💪 ⚙️ 🙆 🔫 🛠️.
+
+🛠️ 🚫 ✔️ ⚒ FastAPI ⚖️ 💃 👷, 📏 ⚫️ ⏩ 🔫 🔌.
+
+🏢, 🔫 🛠️ 🎓 👈 ⌛ 📨 🔫 📱 🥇 ❌.
+
+, 🧾 🥉-🥳 🔫 🛠️ 👫 🔜 🎲 💬 👆 🕳 💖:
+
+```Python
+from unicorn import UnicornMiddleware
+
+app = SomeASGIApp()
+
+new_app = UnicornMiddleware(app, some_config="rainbow")
+```
+
+✋️ FastAPI (🤙 💃) 🚚 🙅 🌌 ⚫️ 👈 ⚒ 💭 👈 🔗 🛠️ 🍵 💽 ❌ &amp; 🛃 ⚠ 🐕‍🦺 👷 ☑.
+
+👈, 👆 ⚙️ `app.add_middleware()` (🖼 ⚜).
+
+```Python
+from fastapi import FastAPI
+from unicorn import UnicornMiddleware
+
+app = FastAPI()
+
+app.add_middleware(UnicornMiddleware, some_config="rainbow")
+```
+
+`app.add_middleware()` 📨 🛠️ 🎓 🥇 ❌ &amp; 🙆 🌖 ❌ 🚶‍♀️ 🛠️.
+
+## 🛠️ 🛠️
+
+**FastAPI** 🔌 📚 🛠️ ⚠ ⚙️ 💼, 👥 🔜 👀 ⏭ ❔ ⚙️ 👫.
+
+!!! note "📡 ℹ"
+    ⏭ 🖼, 👆 💪 ⚙️ `from starlette.middleware.something import SomethingMiddleware`.
+
+    **FastAPI** 🚚 📚 🛠️ `fastapi.middleware` 🏪 👆, 👩‍💻. ✋️ 🌅 💪 🛠️ 👟 🔗 ⚪️➡️ 💃.
+
+## `HTTPSRedirectMiddleware`
+
+🛠️ 👈 🌐 📨 📨 🔜 👯‍♂️ `https` ⚖️ `wss`.
+
+🙆 📨 📨 `http` ⚖️ `ws` 🔜 ❎ 🔐 ⚖ ↩️.
+
+```Python hl_lines="2  6"
+{!../../../docs_src/advanced_middleware/tutorial001.py!}
+```
+
+## `TrustedHostMiddleware`
+
+🛠️ 👈 🌐 📨 📨 ✔️ ☑ ⚒ `Host` 🎚, ✔ 💂‍♂ 🛡 🇺🇸🔍 🦠 🎚 👊.
+
+```Python hl_lines="2  6-8"
+{!../../../docs_src/advanced_middleware/tutorial002.py!}
+```
+
+📄 ❌ 🐕‍🦺:
+
+* `allowed_hosts` - 📇 🆔 📛 👈 🔜 ✔ 📛. 🃏 🆔 ✅ `*.example.com` 🐕‍🦺 🎀 📁. ✔ 🙆 📛 👯‍♂️ ⚙️ `allowed_hosts=["*"]` ⚖️ 🚫 🛠️.
+
+🚥 📨 📨 🔨 🚫 ✔ ☑ ⤴️ `400` 📨 🔜 📨.
+
+## `GZipMiddleware`
+
+🍵 🗜 📨 🙆 📨 👈 🔌 `"gzip"` `Accept-Encoding` 🎚.
+
+🛠️ 🔜 🍵 👯‍♂️ 🐩 &amp; 🎥 📨.
+
+```Python hl_lines="2  6"
+{!../../../docs_src/advanced_middleware/tutorial003.py!}
+```
+
+📄 ❌ 🐕‍🦺:
+
+* `minimum_size` - 🚫 🗜 📨 👈 🤪 🌘 👉 💯 📐 🔢. 🔢 `500`.
+
+## 🎏 🛠️
+
+📤 📚 🎏 🔫 🛠️.
+
+🖼:
+
+* <a href="https://docs.sentry.io/platforms/python/asgi/" class="external-link" target="_blank">🔫</a>
+* <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.io/middleware/" class="external-link" target="_blank">💃 🛠️ 🩺</a> &amp; <a href="https://github.com/florimondmanca/awesome-asgi" class="external-link" target="_blank">🔫 👌 📇</a>.

docs/em/docs/advanced/nosql-databases.md

@@ -0,0 +1,156 @@
+# ☁ (📎 / 🦏 💽) 💽
+
+**FastAPI** 💪 🛠️ ⏮️ 🙆 <abbr title="Distributed database (Big Data), also 'Not Only SQL'">☁</abbr>.
+
+📥 👥 🔜 👀 🖼 ⚙️ **<a href="https://www.couchbase.com/" class="external-link" target="_blank">🗄</a>**, <abbr title="Document here refers to a JSON object (a dict), with keys and values, and those values can also be other JSON objects, arrays (lists), numbers, strings, booleans, etc.">📄</abbr> 🧢 ☁ 💽.
+
+👆 💪 🛠️ ⚫️ 🙆 🎏 ☁ 💽 💖:
+
+* **✳**
+* **👸**
+* **✳**
+* **🇸🇲**
+* **✳**, ♒️.
+
+!!! tip
+    📤 🛂 🏗 🚂 ⏮️ **FastAPI** &amp; **🗄**, 🌐 ⚓️ 🔛 **☁**, 🔌 🕸 &amp; 🌖 🧰: <a href="https://github.com/tiangolo/full-stack-fastapi-couchbase" class="external-link" target="_blank">https://github.com/tiangolo/full-stack-fastapi-couchbase</a>
+
+## 🗄 🗄 🦲
+
+🔜, 🚫 💸 🙋 🎂, 🕴 🗄:
+
+```Python hl_lines="3-5"
+{!../../../docs_src/nosql_databases/tutorial001.py!}
+```
+
+## 🔬 📉 ⚙️ "📄 🆎"
+
+👥 🔜 ⚙️ ⚫️ ⏪ 🔧 🏑 `type` 👆 📄.
+
+👉 🚫 ✔ 🗄, ✋️ 👍 💡 👈 🔜 ℹ 👆 ⏮️.
+
+```Python hl_lines="9"
+{!../../../docs_src/nosql_databases/tutorial001.py!}
+```
+
+## 🚮 🔢 🤚 `Bucket`
+
+**🗄**, 🥡 ⚒ 📄, 👈 💪 🎏 🆎.
+
+👫 🛎 🌐 🔗 🎏 🈸.
+
+🔑 🔗 💽 🌏 🔜 "💽" (🎯 💽, 🚫 💽 💽).
+
+🔑 **✳** 🔜 "🗃".
+
+📟, `Bucket` 🎨 👑 🇨🇻 📻 ⏮️ 💽.
+
+👉 🚙 🔢 🔜:
+
+* 🔗 **🗄** 🌑 (👈 💪 👁 🎰).
+    * ⚒ 🔢 ⏲.
+* 🔓 🌑.
+* 🤚 `Bucket` 👐.
+    * ⚒ 🔢 ⏲.
+* 📨 ⚫️.
+
+```Python hl_lines="12-21"
+{!../../../docs_src/nosql_databases/tutorial001.py!}
+```
+
+## ✍ Pydantic 🏷
+
+**🗄** "📄" 🤙 "🎻 🎚", 👥 💪 🏷 👫 ⏮️ Pydantic.
+
+### `User` 🏷
+
+🥇, ➡️ ✍ `User` 🏷:
+
+```Python hl_lines="24-28"
+{!../../../docs_src/nosql_databases/tutorial001.py!}
+```
+
+👥 🔜 ⚙️ 👉 🏷 👆 *➡ 🛠️ 🔢*,, 👥 🚫 🔌 ⚫️ `hashed_password`.
+
+### `UserInDB` 🏷
+
+🔜, ➡️ ✍ `UserInDB` 🏷.
+
+👉 🔜 ✔️ 💽 👈 🤙 🏪 💽.
+
+👥 🚫 ✍ ⚫️ 🏿 Pydantic `BaseModel` ✋️ 🏿 👆 👍 `User`, ↩️ ⚫️ 🔜 ✔️ 🌐 🔢 `User` ➕ 👩‍❤‍👨 🌅:
+
+```Python hl_lines="31-33"
+{!../../../docs_src/nosql_databases/tutorial001.py!}
+```
+
+!!! note
+    👀 👈 👥 ✔️ `hashed_password` &amp; `type` 🏑 👈 🔜 🏪 💽.
+
+    ✋️ ⚫️ 🚫 🍕 🏢 `User` 🏷 (1️⃣ 👥 🔜 📨 *➡ 🛠️*).
+
+## 🤚 👩‍💻
+
+🔜 ✍ 🔢 👈 🔜:
+
+* ✊ 🆔.
+* 🏗 📄 🆔 ⚪️➡️ ⚫️.
+* 🤚 📄 ⏮️ 👈 🆔.
+* 🚮 🎚 📄 `UserInDB` 🏷.
+
+🏗 🔢 👈 🕴 💡 🤚 👆 👩‍💻 ⚪️➡️ `username` (⚖️ 🙆 🎏 🔢) 🔬 👆 *➡ 🛠️ 🔢*, 👆 💪 🌖 💪 🏤-⚙️ ⚫️ 💗 🍕 &amp; 🚮 <abbr title="Automated test, written in code, that checks if another piece of code is working correctly.">⚒ 💯</abbr> ⚫️:
+
+```Python hl_lines="36-42"
+{!../../../docs_src/nosql_databases/tutorial001.py!}
+```
+
+### Ⓜ-🎻
+
+🚥 👆 🚫 😰 ⏮️ `f"userprofile::{username}"`, ⚫️ 🐍 "<a href="https://docs.python.org/3/glossary.html#term-f-string" class="external-link" target="_blank">Ⓜ-🎻</a>".
+
+🙆 🔢 👈 🚮 🔘 `{}` Ⓜ-🎻 🔜 ↔ / 💉 🎻.
+
+### `dict` 🏗
+
+🚥 👆 🚫 😰 ⏮️ `UserInDB(**result.value)`, <a href="https://docs.python.org/3/glossary.html#term-argument" class="external-link" target="_blank">⚫️ ⚙️ `dict` "🏗"</a>.
+
+⚫️ 🔜 ✊ `dict` `result.value`, &amp; ✊ 🔠 🚮 🔑 &amp; 💲 &amp; 🚶‍♀️ 👫 🔑-💲 `UserInDB` 🇨🇻 ❌.
+
+, 🚥 `dict` 🔌:
+
+```Python
+{
+    "username": "johndoe",
+    "hashed_password": "some_hash",
+}
+```
+
+⚫️ 🔜 🚶‍♀️ `UserInDB` :
+
+```Python
+UserInDB(username="johndoe", hashed_password="some_hash")
+```
+
+## ✍ 👆 **FastAPI** 📟
+
+### ✍ `FastAPI` 📱
+
+```Python hl_lines="46"
+{!../../../docs_src/nosql_databases/tutorial001.py!}
+```
+
+### ✍ *➡ 🛠️ 🔢*
+
+👆 📟 🤙 🗄 &amp; 👥 🚫 ⚙️ <a href="https://docs.couchbase.com/python-sdk/2.5/async-programming.html#asyncio-python-3-5" class="external-link" target="_blank">🥼 🐍 <code>await</code> 🐕‍🦺</a>, 👥 🔜 📣 👆 🔢 ⏮️ 😐 `def` ↩️ `async def`.
+
+, 🗄 👍 🚫 ⚙️ 👁 `Bucket` 🎚 💗 "<abbr title="A sequence of code being executed by the program, while at the same time, or at intervals, there can be others being executed too.">🧵</abbr>Ⓜ",, 👥 💪 🤚 🥡 🔗 &amp; 🚶‍♀️ ⚫️ 👆 🚙 🔢:
+
+```Python hl_lines="49-53"
+{!../../../docs_src/nosql_databases/tutorial001.py!}
+```
+
+## 🌃
+
+👆 💪 🛠️ 🙆 🥉 🥳 ☁ 💽, ⚙️ 👫 🐩 📦.
+
+🎏 ✔ 🙆 🎏 🔢 🧰, ⚙️ ⚖️ 🛠️.

docs/em/docs/advanced/openapi-callbacks.md

@@ -0,0 +1,179 @@
+# 🗄 ⏲
+
+👆 💪 ✍ 🛠️ ⏮️ *➡ 🛠️* 👈 💪 ⏲ 📨 *🔢 🛠️* ✍ 👱 🙆 (🎲 🎏 👩‍💻 👈 🔜 *⚙️* 👆 🛠️).
+
+🛠️ 👈 🔨 🕐❔ 👆 🛠️ 📱 🤙 *🔢 🛠️* 📛 "⏲". ↩️ 🖥 👈 🔢 👩‍💻 ✍ 📨 📨 👆 🛠️ & ⤴️ 👆 🛠️ *🤙 🔙*, 📨 📨 *🔢 🛠️* (👈 🎲 ✍ 🎏 👩‍💻).
+
+👉 💼, 👆 💪 💚 📄 ❔ 👈 🔢 🛠️ *🔜* 👀 💖. ⚫️❔ *➡ 🛠️* ⚫️ 🔜 ✔️, ⚫️❔ 💪 ⚫️ 🔜 ⌛, ⚫️❔ 📨 ⚫️ 🔜 📨, ♒️.
+
+## 📱 ⏮️ ⏲
+
+➡️ 👀 🌐 👉 ⏮️ 🖼.
+
+🌈 👆 🛠️ 📱 👈 ✔ 🏗 🧾.
+
+👉 🧾 🔜 ✔️ `id`, `title` (📦), `customer`, & `total`.
+
+👩‍💻 👆 🛠️ (🔢 👩‍💻) 🔜 ✍ 🧾 👆 🛠️ ⏮️ 🏤 📨.
+
+⤴️ 👆 🛠️ 🔜 (➡️ 🌈):
+
+* 📨 🧾 🕴 🔢 👩‍💻.
+* 📈 💸.
+* 📨 📨 🔙 🛠️ 👩‍💻 (🔢 👩‍💻).
+    * 👉 🔜 🔨 📨 🏤 📨 (⚪️➡️ *👆 🛠️*) *🔢 🛠️* 🚚 👈 🔢 👩‍💻 (👉 "⏲").
+
+## 😐 **FastAPI** 📱
+
+➡️ 🥇 👀 ❔ 😐 🛠️ 📱 🔜 👀 💖 ⏭ ❎ ⏲.
+
+⚫️ 🔜 ✔️ *➡ 🛠️* 👈 🔜 📨 `Invoice` 💪, & 🔢 🔢 `callback_url` 👈 🔜 🔌 📛 ⏲.
+
+👉 🍕 📶 😐, 🌅 📟 🎲 ⏪ 😰 👆:
+
+```Python hl_lines="9-13  36-53"
+{!../../../docs_src/openapi_callbacks/tutorial001.py!}
+```
+
+!!! tip
+     `callback_url` 🔢 🔢 ⚙️ Pydantic <a href="https://pydantic-docs.helpmanual.io/usage/types/#urls" class="external-link" target="_blank">📛</a> 🆎.
+
+🕴 🆕 👜 `callbacks=messages_callback_router.routes` ❌ *➡ 🛠️ 👨‍🎨*. 👥 🔜 👀 ⚫️❔ 👈 ⏭.
+
+## 🔬 ⏲
+
+☑ ⏲ 📟 🔜 🪀 🙇 🔛 👆 👍 🛠️ 📱.
+
+&amp; ⚫️ 🔜 🎲 🪀 📚 ⚪️➡️ 1️⃣ 📱 ⏭.
+
+⚫️ 💪 1️⃣ ⚖️ 2️⃣ ⏸ 📟, 💖:
+
+```Python
+callback_url = "https://example.com/api/v1/invoices/events/"
+httpx.post(callback_url, json={"description": "Invoice paid", "paid": True})
+```
+
+✋️ 🎲 🏆 ⚠ 🍕 ⏲ ⚒ 💭 👈 👆 🛠️ 👩‍💻 (🔢 👩‍💻) 🛠️ *🔢 🛠️* ☑, 🛄 💽 👈 *👆 🛠️* 🔜 📨 📨 💪 ⏲, ♒️.
+
+, ⚫️❔ 👥 🔜 ⏭ 🚮 📟 📄 ❔ 👈 *🔢 🛠️* 🔜 👀 💖 📨 ⏲ ⚪️➡️ *👆 🛠️*.
+
+👈 🧾 🔜 🎦 🆙 🦁 🎚 `/docs` 👆 🛠️, &amp; ⚫️ 🔜 ➡️ 🔢 👩‍💻 💭 ❔ 🏗 *🔢 🛠️*.
+
+👉 🖼 🚫 🛠️ ⏲ ⚫️ (👈 💪 ⏸ 📟), 🕴 🧾 🍕.
+
+!!! 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
+    🕐❔ ✍ 📟 📄 ⏲, ⚫️ 💪 ⚠ 🌈 👈 👆 👈 *🔢 👩‍💻*. &amp; 👈 👆 ⏳ 🛠️ *🔢 🛠️*, 🚫 *👆 🛠️*.
+
+    🍕 🛠️ 👉 ☝ 🎑 ( *🔢 👩‍💻*) 💪 ℹ 👆 💭 💖 ⚫️ 🌅 ⭐ 🌐❔ 🚮 🔢, Pydantic 🏷 💪, 📨, ♒️. 👈 *🔢 🛠️*.
+
+### ✍ ⏲ `APIRouter`
+
+🥇 ✍ 🆕 `APIRouter` 👈 🔜 🔌 1️⃣ ⚖️ 🌅 ⏲.
+
+```Python hl_lines="3  25"
+{!../../../docs_src/openapi_callbacks/tutorial001.py!}
+```
+
+### ✍ ⏲ *➡ 🛠️*
+
+✍ ⏲ *➡ 🛠️* ⚙️ 🎏 `APIRouter` 👆 ✍ 🔛.
+
+⚫️ 🔜 👀 💖 😐 FastAPI *➡ 🛠️*:
+
+* ⚫️ 🔜 🎲 ✔️ 📄 💪 ⚫️ 🔜 📨, ✅ `body: InvoiceEvent`.
+*  &amp; ⚫️ 💪 ✔️ 📄 📨 ⚫️ 🔜 📨, ✅ `response_model=InvoiceEventReceived`.
+
+```Python hl_lines="16-18  21-22  28-32"
+{!../../../docs_src/openapi_callbacks/tutorial001.py!}
+```
+
+📤 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> (👀 🌖 🔛) 🌐❔ ⚫️ 💪 ⚙️ 🔢 ⏮️ 🔢 &amp; 🍕 ⏮️ 📨 📨 *👆 🛠️*.
+
+### ⏲ ➡ 🧬
+
+⏲ *➡* 💪 ✔️ <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"
+}
+```
+
+⤴️ *👆 🛠️* 🔜 🛠️ 🧾, &amp; ☝ ⏪, 📨 ⏲ 📨 `callback_url` ( *🔢 🛠️*):
+
+```
+https://www.external.org/events/invoices/2expen51ve
+```
+
+⏮️ 🎻 💪 ⚗ 🕳 💖:
+
+```JSON
+{
+    "description": "Payment celebration",
+    "paid": true
+}
+```
+
+&amp; ⚫️ 🔜 ⌛ 📨 ⚪️➡️ 👈 *🔢 🛠️* ⏮️ 🎻 💪 💖:
+
+```JSON
+{
+    "ok": true
+}
+```
+
+!!! tip
+    👀 ❔ ⏲ 📛 ⚙️ 🔌 📛 📨 🔢 🔢 `callback_url` (`https://www.external.org/events`) &amp; 🧾 `id` ⚪️➡️ 🔘 🎻 💪 (`2expen51ve`).
+
+### 🚮 ⏲ 📻
+
+👉 ☝ 👆 ✔️ *⏲ ➡ 🛠️(Ⓜ)* 💪 (1️⃣(Ⓜ) 👈 *🔢 👩‍💻* 🔜 🛠️ *🔢 🛠️*) ⏲ 📻 👆 ✍ 🔛.
+
+🔜 ⚙️ 🔢 `callbacks` *👆 🛠️ ➡ 🛠️ 👨‍🎨* 🚶‍♀️ 🔢 `.routes` (👈 🤙 `list` 🛣/*➡ 🛠️*) ⚪️➡️ 👈 ⏲ 📻:
+
+```Python hl_lines="35"
+{!../../../docs_src/openapi_callbacks/tutorial001.py!}
+```
+
+!!! tip
+    👀 👈 👆 🚫 🚶‍♀️ 📻 ⚫️ (`invoices_callback_router`) `callback=`, ✋️ 🔢 `.routes`, `invoices_callback_router.routes`.
+
+### ✅ 🩺
+
+🔜 👆 💪 ▶️ 👆 📱 ⏮️ Uvicorn &amp; 🚶 <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">

docs/em/docs/advanced/path-operation-advanced-configuration.md

@@ -0,0 +1,170 @@
+# ➡ 🛠️ 🏧 📳
+
+## 🗄 {
+
+!!! warning
+    🚥 👆 🚫 "🕴" 🗄, 👆 🎲 🚫 💪 👉.
+
+👆 💪 ⚒ 🗄 `operationId` ⚙️ 👆 *➡ 🛠️* ⏮️ 🔢 `operation_id`.
+
+👆 🔜 ✔️ ⚒ 💭 👈 ⚫️ 😍 🔠 🛠️.
+
+```Python hl_lines="6"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial001.py!}
+```
+
+### ⚙️ *➡ 🛠️ 🔢* 📛 {
+
+🚥 👆 💚 ⚙️ 👆 🔗' 🔢 📛 `operationId`Ⓜ, 👆 💪 🔁 🤭 🌐 👫 & 🔐 🔠 *➡ 🛠️* `operation_id` ⚙️ 👫 `APIRoute.name`.
+
+👆 🔜 ⚫️ ⏮️ ❎ 🌐 👆 *➡ 🛠️*.
+
+```Python hl_lines="2  12-21  24"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
+```
+
+!!! tip
+    🚥 👆 ❎ 🤙 `app.openapi()`, 👆 🔜 ℹ `operationId`Ⓜ ⏭ 👈.
+
+!!! warning
+    🚥 👆 👉, 👆 ✔️ ⚒ 💭 🔠 1️⃣ 👆 *➡ 🛠️ 🔢* ✔️ 😍 📛.
+
+    🚥 👫 🎏 🕹 (🐍 📁).
+
+## 🚫 ⚪️➡️ 🗄
+
+🚫 *➡ 🛠️* ⚪️➡️ 🏗 🗄 🔗 (& ➡️, ⚪️➡️ 🏧 🧾 ⚙️), ⚙️ 🔢 `include_in_schema` & ⚒ ⚫️ `False`:
+
+```Python hl_lines="6"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial003.py!}
+```
+
+## 🏧 📛 ⚪️➡️ #️⃣
+
+👆 💪 📉 ⏸ ⚙️ ⚪️➡️ #️⃣ *➡ 🛠️ 🔢* 🗄.
+
+❎ `\f` (😖 "📨 🍼" 🦹) 🤕 **FastAPI** 🔁 🔢 ⚙️ 🗄 👉 ☝.
+
+⚫️ 🏆 🚫 🎦 🆙 🧾, ✋️ 🎏 🧰 (✅ 🐉) 🔜 💪 ⚙️ 🎂.
+
+```Python hl_lines="19-29"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial004.py!}
+```
+
+## 🌖 📨
+
+👆 🎲 ✔️ 👀 ❔ 📣 `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>.
+
+⚫️ ✔️ 🌐 ℹ 🔃 *➡ 🛠️* &amp; ⚙️ 🏗 🏧 🧾.
+
+⚫️ 🔌 `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):
+
+```Python hl_lines="6"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial005.py!}
+```
+
+🚥 👆 📂 🏧 🛠️ 🩺, 👆 ↔ 🔜 🎦 🆙 🔝 🎯 *➡ 🛠️*.
+
+<img src="/img/tutorial/path-operation-advanced-configuration/image01.png">
+
+&amp; 🚥 👆 👀 📉 🗄 ( `/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` 🔜 🙇 🔗 ⏮️ 🔁 🏗 🗄 🔗 *➡ 🛠️*.
+
+, 👆 💪 🚮 🌖 💽 🔁 🏗 🔗.
+
+🖼, 👆 💪 💭 ✍ &amp; ✔ 📨 ⏮️ 👆 👍 📟, 🍵 ⚙️ 🏧 ⚒ FastAPI ⏮️ Pydantic, ✋️ 👆 💪 💚 🔬 📨 🗄 🔗.
+
+👆 💪 👈 ⏮️ `openapi_extra`:
+
+```Python hl_lines="20-37  39-40"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial006.py!}
+```
+
+👉 🖼, 👥 🚫 📣 🙆 Pydantic 🏷. 👐, 📨 💪 🚫 <abbr title="converted from some plain format, like bytes, into Python objects">🎻</abbr> 🎻, ⚫️ ✍ 🔗 `bytes`, &amp; 🔢 `magic_data_reader()` 🔜 🈚 🎻 ⚫️ 🌌.
+
+👐, 👥 💪 📣 📈 🔗 📨 💪.
+
+### 🛃 🗄 🎚 🆎
+
+⚙️ 👉 🎏 🎱, 👆 💪 ⚙️ Pydantic 🏷 🔬 🎻 🔗 👈 ⤴️ 🔌 🛃 🗄 🔗 📄 *➡ 🛠️*.
+
+&amp; 👆 💪 👉 🚥 💽 🆎 📨 🚫 🎻.
+
+🖼, 👉 🈸 👥 🚫 ⚙️ FastAPI 🛠️ 🛠️ ⚗ 🎻 🔗 ⚪️➡️ Pydantic 🏷 🚫 🏧 🔬 🎻. 👐, 👥 📣 📨 🎚 🆎 📁, 🚫 🎻:
+
+```Python hl_lines="17-22  24"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial007.py!}
+```
+
+👐, 👐 👥 🚫 ⚙️ 🔢 🛠️ 🛠️, 👥 ⚙️ Pydantic 🏷 ❎ 🏗 🎻 🔗 💽 👈 👥 💚 📨 📁.
+
+⤴️ 👥 ⚙️ 📨 🔗, &amp; ⚗ 💪 `bytes`. 👉 ⛓ 👈 FastAPI 🏆 🚫 🔄 🎻 📨 🚀 🎻.
+
+&amp; ⤴️ 👆 📟, 👥 🎻 👈 📁 🎚 🔗, &amp; ⤴️ 👥 🔄 ⚙️ 🎏 Pydantic 🏷 ✔ 📁 🎚:
+
+```Python hl_lines="26-33"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial007.py!}
+```
+
+!!! tip
+    📥 👥 🏤-⚙️ 🎏 Pydantic 🏷.
+
+    ✋️ 🎏 🌌, 👥 💪 ✔️ ✔ ⚫️ 🎏 🌌.

docs/em/docs/advanced/response-change-status-code.md

@@ -0,0 +1,33 @@
+# 📨 - 🔀 👔 📟
+
+👆 🎲 ✍ ⏭ 👈 👆 💪 ⚒ 🔢 [📨 👔 📟](../tutorial/response-status-code.md){.internal-link target=_blank}.
+
+✋️ 💼 👆 💪 📨 🎏 👔 📟 🌘 🔢.
+
+## ⚙️ 💼
+
+🖼, 🌈 👈 👆 💚 📨 🇺🇸🔍 👔 📟 "👌" `200` 🔢.
+
+✋️ 🚥 💽 🚫 🔀, 👆 💚 ✍ ⚫️, & 📨 🇺🇸🔍 👔 📟 "✍" `201`.
+
+✋️ 👆 💚 💪 ⛽ & 🗜 💽 👆 📨 ⏮️ `response_model`.
+
+📚 💼, 👆 💪 ⚙️ `Response` 🔢.
+
+## ⚙️ `Response` 🔢
+
+👆 💪 📣 🔢 🆎 `Response` 👆 *➡ 🛠️ 🔢* (👆 💪 🍪 & 🎚).
+
+& ⤴️ 👆 💪 ⚒ `status_code` 👈 *🔀* 📨 🎚.
+
+```Python hl_lines="1  9  12"
+{!../../../docs_src/response_change_status_code/tutorial001.py!}
+```
+
+& ⤴️ 👆 💪 📨 🙆 🎚 👆 💪, 👆 🛎 🔜 ( `dict`, 💽 🏷, ♒️).
+
+& 🚥 👆 📣 `response_model`, ⚫️ 🔜 ⚙️ ⛽ & 🗜 🎚 👆 📨.
+
+**FastAPI** 🔜 ⚙️ 👈 *🔀* 📨 ⚗ 👔 📟 (🍪 & 🎚), & 🔜 🚮 👫 🏁 📨 👈 🔌 💲 👆 📨, ⛽ 🙆 `response_model`.
+
+👆 💪 📣 `Response` 🔢 🔗, & ⚒ 👔 📟 👫. ✋️ ✔️ 🤯 👈 🏁 1️⃣ ⚒ 🔜 🏆.

docs/em/docs/advanced/response-cookies.md

@@ -0,0 +1,49 @@
+# 📨 🍪
+
+## ⚙️ `Response` 🔢
+
+👆 💪 📣 🔢 🆎 `Response` 👆 *➡ 🛠️ 🔢*.
+
+& ⤴️ 👆 💪 ⚒ 🍪 👈 *🔀* 📨 🎚.
+
+```Python hl_lines="1  8-9"
+{!../../../docs_src/response_cookies/tutorial002.py!}
+```
+
+& ⤴️ 👆 💪 📨 🙆 🎚 👆 💪, 👆 🛎 🔜 ( `dict`, 💽 🏷, ♒️).
+
+& 🚥 👆 📣 `response_model`, ⚫️ 🔜 ⚙️ ⛽ & 🗜 🎚 👆 📨.
+
+**FastAPI** 🔜 ⚙️ 👈 *🔀* 📨 ⚗ 🍪 (🎚 & 👔 📟), & 🔜 🚮 👫 🏁 📨 👈 🔌 💲 👆 📨, ⛽ 🙆 `response_model`.
+
+👆 💪 📣 `Response` 🔢 🔗, & ⚒ 🍪 (& 🎚) 👫.
+
+## 📨 `Response` 🔗
+
+👆 💪 ✍ 🍪 🕐❔ 🛬 `Response` 🔗 👆 📟.
+
+👈, 👆 💪 ✍ 📨 🔬 [📨 📨 🔗](response-directly.md){.internal-link target=_blank}.
+
+⤴️ ⚒ 🍪 ⚫️, & ⤴️ 📨 ⚫️:
+
+```Python hl_lines="10-12"
+{!../../../docs_src/response_cookies/tutorial001.py!}
+```
+
+!!! 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`.
+
+👀 🌐 💪 🔢 &amp; 🎛, ✅ <a href="https://www.starlette.io/responses/#set-cookie" class="external-link" target="_blank">🧾 💃</a>.

docs/em/docs/advanced/response-directly.md

@@ -0,0 +1,63 @@
+# 📨 📨 🔗
+
+🕐❔ 👆 ✍ **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` 🗜 👆 📊 ⏭ 🚶‍♀️ ⚫️ 📨:
+
+```Python hl_lines="6-7  21-22"
+{!../../../docs_src/response_directly/tutorial001.py!}
+```
+
+!!! 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`, &amp; 📨 ⚫️:
+
+```Python hl_lines="1  18"
+{!../../../docs_src/response_directly/tutorial002.py!}
+```
+
+## 🗒
+
+🕐❔ 👆 📨 `Response` 🔗 🚮 📊 🚫 ✔, 🗜 (🎻), 🚫 📄 🔁.
+
+✋️ 👆 💪 📄 ⚫️ 🔬 [🌖 📨 🗄](additional-responses.md){.internal-link target=_blank}.
+
+👆 💪 👀 ⏪ 📄 ❔ ⚙️/📣 👉 🛃 `Response`Ⓜ ⏪ ✔️ 🏧 💽 🛠️, 🧾, ♒️.

docs/em/docs/advanced/response-headers.md

@@ -0,0 +1,42 @@
+# 📨 🎚
+
+## ⚙️ `Response` 🔢
+
+👆 💪 📣 🔢 🆎 `Response` 👆 *➡ 🛠️ 🔢* (👆 💪 🍪).
+
+& ⤴️ 👆 💪 ⚒ 🎚 👈 *🔀* 📨 🎚.
+
+```Python hl_lines="1  7-8"
+{!../../../docs_src/response_headers/tutorial002.py!}
+```
+
+& ⤴️ 👆 💪 📨 🙆 🎚 👆 💪, 👆 🛎 🔜 ( `dict`, 💽 🏷, ♒️).
+
+& 🚥 👆 📣 `response_model`, ⚫️ 🔜 ⚙️ ⛽ & 🗜 🎚 👆 📨.
+
+**FastAPI** 🔜 ⚙️ 👈 *🔀* 📨 ⚗ 🎚 (🍪 & 👔 📟), & 🔜 🚮 👫 🏁 📨 👈 🔌 💲 👆 📨, ⛽ 🙆 `response_model`.
+
+👆 💪 📣 `Response` 🔢 🔗, & ⚒ 🎚 (& 🍪) 👫.
+
+## 📨 `Response` 🔗
+
+👆 💪 🚮 🎚 🕐❔ 👆 📨 `Response` 🔗.
+
+✍ 📨 🔬 [📨 📨 🔗](response-directly.md){.internal-link target=_blank} & 🚶‍♀️ 🎚 🌖 🔢:
+
+```Python hl_lines="10-12"
+{!../../../docs_src/response_headers/tutorial001.py!}
+```
+
+!!! 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.io/middleware/#corsmiddleware" class="external-link" target="_blank">💃 ⚜ 🩺</a>.

docs/em/docs/advanced/security/http-basic-auth.md

@@ -0,0 +1,113 @@
+# 🇺🇸🔍 🔰 🔐
+
+🙅 💼, 👆 💪 ⚙️ 🇺🇸🔍 🔰 🔐.
+
+🇺🇸🔍 🔰 🔐, 🈸 ⌛ 🎚 👈 🔌 🆔 & 🔐.
+
+🚥 ⚫️ 🚫 📨 ⚫️, ⚫️ 📨 🇺🇸🔍 4️⃣0️⃣1️⃣ "⛔" ❌.
+
+& 📨 🎚 `WWW-Authenticate` ⏮️ 💲 `Basic`, & 📦 `realm` 🔢.
+
+👈 💬 🖥 🎦 🛠️ 📋 🆔 & 🔐.
+
+⤴️, 🕐❔ 👆 🆎 👈 🆔 & 🔐, 🖥 📨 👫 🎚 🔁.
+
+## 🙅 🇺🇸🔍 🔰 🔐
+
+* 🗄 `HTTPBasic` & `HTTPBasicCredentials`.
+* ✍ "`security` ⚖" ⚙️ `HTTPBasic`.
+* ⚙️ 👈 `security` ⏮️ 🔗 👆 *➡ 🛠️*.
+* ⚫️ 📨 🎚 🆎 `HTTPBasicCredentials`:
+    * ⚫️ 🔌 `username` & `password` 📨.
+
+```Python hl_lines="2  6  10"
+{!../../../docs_src/security/tutorial006.py!}
+```
+
+🕐❔ 👆 🔄 📂 📛 🥇 🕰 (⚖️ 🖊 "🛠️" 🔼 🩺) 🖥 🔜 💭 👆 👆 🆔 & 🔐:
+
+<img src="/img/tutorial/security/image12.png">
+
+## ✅ 🆔
+
+📥 🌅 🏁 🖼.
+
+⚙️ 🔗 ✅ 🚥 🆔 &amp; 🔐 ☑.
+
+👉, ⚙️ 🐍 🐩 🕹 <a href="https://docs.python.org/3/library/secrets.html" class="external-link" target="_blank">`secrets`</a> ✅ 🆔 &amp; 🔐.
+
+`secrets.compare_digest()` 💪 ✊ `bytes` ⚖️ `str` 👈 🕴 🔌 🔠 🦹 (🕐 🇪🇸), 👉 ⛓ ⚫️ 🚫🔜 👷 ⏮️ 🦹 💖 `á`, `Sebastián`.
+
+🍵 👈, 👥 🥇 🗜 `username` &amp; `password` `bytes` 🔢 👫 ⏮️ 🔠-8️⃣.
+
+⤴️ 👥 💪 ⚙️ `secrets.compare_digest()` 🚚 👈 `credentials.username` `"stanleyjobson"`, &amp; 👈 `credentials.password` `"swordfish"`.
+
+```Python hl_lines="1  11-21"
+{!../../../docs_src/security/tutorial007.py!}
+```
+
+👉 🔜 🎏:
+
+```Python
+if not (credentials.username == "stanleyjobson") or not (credentials.password == "swordfish"):
+    # Return some error
+    ...
+```
+
+✋️ ⚙️ `secrets.compare_digest()` ⚫️ 🔜 🔐 🛡 🆎 👊 🤙 "🕰 👊".
+
+### ⏲ 👊
+
+✋️ ⚫️❔ "⏲ 👊"❓
+
+➡️ 🌈 👊 🔄 💭 🆔 &amp; 🔐.
+
+&amp; 👫 📨 📨 ⏮️ 🆔 `johndoe` &amp; 🔐 `love123`.
+
+⤴️ 🐍 📟 👆 🈸 🔜 🌓 🕳 💖:
+
+```Python
+if "johndoe" == "stanleyjobson" and "love123" == "swordfish":
+    ...
+```
+
+✋️ ▶️️ 🙍 🐍 🔬 🥇 `j` `johndoe` 🥇 `s` `stanleyjobson`, ⚫️ 🔜 📨 `False`, ↩️ ⚫️ ⏪ 💭 👈 📚 2️⃣ 🎻 🚫 🎏, 💭 👈 "📤 🙅‍♂ 💪 🗑 🌅 📊 ⚖ 🎂 🔤". &amp; 👆 🈸 🔜 💬 "❌ 👩‍💻 ⚖️ 🔐".
+
+✋️ ⤴️ 👊 🔄 ⏮️ 🆔 `stanleyjobsox` &amp; 🔐 `love123`.
+
+&amp; 👆 🈸 📟 🔨 🕳 💖:
+
+```Python
+if "stanleyjobsox" == "stanleyjobson" and "love123" == "swordfish":
+    ...
+```
+
+🐍 🔜 ✔️ 🔬 🎂 `stanleyjobso` 👯‍♂️ `stanleyjobsox` &amp; `stanleyjobson` ⏭ 🤔 👈 👯‍♂️ 🎻 🚫 🎏. ⚫️ 🔜 ✊ ➕ ⏲ 📨 🔙 "❌ 👩‍💻 ⚖️ 🔐".
+
+#### 🕰 ❔ ℹ 👊
+
+👈 ☝, 👀 👈 💽 ✊ ⏲ 📏 📨 "❌ 👩‍💻 ⚖️ 🔐" 📨, 👊 🔜 💭 👈 👫 🤚 _🕳_ ▶️️, ▶️ 🔤 ▶️️.
+
+&amp; ⤴️ 👫 💪 🔄 🔄 🤔 👈 ⚫️ 🎲 🕳 🌖 🎏 `stanleyjobsox` 🌘 `johndoe`.
+
+####  "🕴" 👊
+
+↗️, 👊 🔜 🚫 🔄 🌐 👉 ✋, 👫 🔜 ✍ 📋 ⚫️, 🎲 ⏮️ 💯 ⚖️ 💯 💯 📍 🥈. &amp; 🔜 🤚 1️⃣ ➕ ☑ 🔤 🕰.
+
+✋️ 🔨 👈, ⏲ ⚖️ 📆 👊 🔜 ✔️ 💭 ☑ 🆔 &amp; 🔐, ⏮️ "ℹ" 👆 🈸, ⚙️ 🕰 ✊ ❔.
+
+#### 🔧 ⚫️ ⏮️ `secrets.compare_digest()`
+
+✋️ 👆 📟 👥 🤙 ⚙️ `secrets.compare_digest()`.
+
+📏, ⚫️ 🔜 ✊ 🎏 🕰 🔬 `stanleyjobsox` `stanleyjobson` 🌘 ⚫️ ✊ 🔬 `johndoe` `stanleyjobson`. &amp; 🎏 🔐.
+
+👈 🌌, ⚙️ `secrets.compare_digest()` 👆 🈸 📟, ⚫️ 🔜 🔒 🛡 👉 🎂 ↔ 💂‍♂ 👊.
+
+### 📨 ❌
+
+⏮️ 🔍 👈 🎓 ❌, 📨 `HTTPException` ⏮️ 👔 📟 4️⃣0️⃣1️⃣ (🎏 📨 🕐❔ 🙅‍♂ 🎓 🚚) &amp; 🚮 🎚 `WWW-Authenticate` ⚒ 🖥 🎦 💳 📋 🔄:
+
+```Python hl_lines="23-27"
+{!../../../docs_src/security/tutorial007.py!}
+```

docs/em/docs/advanced/security/index.md

@@ -0,0 +1,16 @@
+# 🏧 💂‍♂
+
+## 🌖 ⚒
+
+📤 ➕ ⚒ 🍵 💂‍♂ ↖️ ⚪️➡️ 🕐 📔 [🔰 - 👩‍💻 🦮: 💂‍♂](../../tutorial/security/){.internal-link target=_blank}.
+
+!!! tip
+    ⏭ 📄 **🚫 🎯 "🏧"**.
+
+     & ⚫️ 💪 👈 👆 ⚙️ 💼, ⚗ 1️⃣ 👫.
+
+## ✍ 🔰 🥇
+
+⏭ 📄 🤔 👆 ⏪ ✍ 👑 [🔰 - 👩‍💻 🦮: 💂‍♂](../../tutorial/security/){.internal-link target=_blank}.
+
+👫 🌐 ⚓️ 🔛 🎏 🔧, ✋️ ✔ ➕ 🛠️.

docs/em/docs/advanced/security/oauth2-scopes.md

@@ -0,0 +1,269 @@
+# 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️⃣ ↔:
+
+```Python hl_lines="2  4  8  12  46  64  105  107-115  121-124  128-134  139  153"
+{!../../../docs_src/security/tutorial005.py!}
+```
+
+🔜 ➡️ 📄 👈 🔀 🔁 🔁.
+
+## Oauth2️⃣ 💂‍♂ ⚖
+
+🥇 🔀 👈 🔜 👥 📣 Oauth2️⃣ 💂‍♂ ⚖ ⏮️ 2️⃣ 💪 ↔, `me` & `items`.
+
+`scopes` 🔢 📨 `dict` ⏮️ 🔠 ↔ 🔑 & 📛 💲:
+
+```Python hl_lines="62-65"
+{!../../../docs_src/security/tutorial005.py!}
+```
+
+↩️ 👥 🔜 📣 📚 ↔, 👫 🔜 🎦 🆙 🛠️ 🩺 🕐❔ 👆 🕹-/✔.
+
+& 👆 🔜 💪 🖊 ❔ ↔ 👆 💚 🤝 🔐: `me` & `items`.
+
+👉 🎏 🛠️ ⚙️ 🕐❔ 👆 🤝 ✔ ⏪ 🚨 ⏮️ 👱📔, 🇺🇸🔍, 📂, ♒️:
+
+<img src="/img/tutorial/security/image11.png">
+
+## 🥙 🤝 ⏮️ ↔
+
+🔜, 🔀 🤝 *➡ 🛠️* 📨 ↔ 📨.
+
+👥 ⚙️ 🎏 `OAuth2PasswordRequestForm`. ⚫️ 🔌 🏠 `scopes` ⏮️ `list` `str`, ⏮️ 🔠 ↔ ⚫️ 📨 📨.
+
+&amp; 👥 📨 ↔ 🍕 🥙 🤝.
+
+!!! danger
+    🦁, 📥 👥 ❎ ↔ 📨 🔗 🤝.
+
+    ✋️ 👆 🈸, 💂‍♂, 👆 🔜 ⚒ 💭 👆 🕴 🚮 ↔ 👈 👩‍💻 🤙 💪 ✔️, ⚖️ 🕐 👆 ✔️ 🔁.
+
+```Python hl_lines="153"
+{!../../../docs_src/security/tutorial005.py!}
+```
+
+## 📣 ↔ *➡ 🛠️* &amp; 🔗
+
+🔜 👥 📣 👈 *➡ 🛠️* `/users/me/items/` 🚚 ↔ `items`.
+
+👉, 👥 🗄 &amp; ⚙️ `Security` ⚪️➡️ `fastapi`.
+
+👆 💪 ⚙️ `Security` 📣 🔗 (💖 `Depends`), ✋️ `Security` 📨 🔢 `scopes` ⏮️ 📇 ↔ (🎻).
+
+👉 💼, 👥 🚶‍♀️ 🔗 🔢 `get_current_active_user` `Security` (🎏 🌌 👥 🔜 ⏮️ `Depends`).
+
+✋️ 👥 🚶‍♀️ `list` ↔, 👉 💼 ⏮️ 1️⃣ ↔: `items` (⚫️ 💪 ✔️ 🌅).
+
+&amp; 🔗 🔢 `get_current_active_user` 💪 📣 🎧-🔗, 🚫 🕴 ⏮️ `Depends` ✋️ ⏮️ `Security`. 📣 🚮 👍 🎧-🔗 🔢 (`get_current_user`), &amp; 🌖 ↔ 📄.
+
+👉 💼, ⚫️ 🚚 ↔ `me` (⚫️ 💪 🚚 🌅 🌘 1️⃣ ↔).
+
+!!! note
+    👆 🚫 🎯 💪 🚮 🎏 ↔ 🎏 🥉.
+
+    👥 🔨 ⚫️ 📥 🎦 ❔ **FastAPI** 🍵 ↔ 📣 🎏 🎚.
+
+```Python hl_lines="4  139  166"
+{!../../../docs_src/security/tutorial005.py!}
+```
+
+!!! info "📡 ℹ"
+    `Security` 🤙 🏿 `Depends`, &amp; ⚫️ ✔️ 1️⃣ ➕ 🔢 👈 👥 🔜 👀 ⏪.
+
+    ✋️ ⚙️ `Security` ↩️ `Depends`, **FastAPI** 🔜 💭 👈 ⚫️ 💪 📣 💂‍♂ ↔, ⚙️ 👫 🔘, &amp; 📄 🛠️ ⏮️ 🗄.
+
+    ✋️ 🕐❔ 👆 🗄 `Query`, `Path`, `Depends`, `Security` &amp; 🎏 ⚪️➡️ `fastapi`, 👈 🤙 🔢 👈 📨 🎁 🎓.
+
+## ⚙️ `SecurityScopes`
+
+🔜 ℹ 🔗 `get_current_user`.
+
+👉 1️⃣ ⚙️ 🔗 🔛.
+
+📥 👥 ⚙️ 🎏 Oauth2️⃣ ⚖ 👥 ✍ ⏭, 📣 ⚫️ 🔗: `oauth2_scheme`.
+
+↩️ 👉 🔗 🔢 🚫 ✔️ 🙆 ↔ 📄 ⚫️, 👥 💪 ⚙️ `Depends` ⏮️ `oauth2_scheme`, 👥 🚫 ✔️ ⚙️ `Security` 🕐❔ 👥 🚫 💪 ✔ 💂‍♂ ↔.
+
+👥 📣 🎁 🔢 🆎 `SecurityScopes`, 🗄 ⚪️➡️ `fastapi.security`.
+
+👉 `SecurityScopes` 🎓 🎏 `Request` (`Request` ⚙️ 🤚 📨 🎚 🔗).
+
+```Python hl_lines="8  105"
+{!../../../docs_src/security/tutorial005.py!}
+```
+
+## ⚙️ `scopes`
+
+🔢 `security_scopes` 🔜 🆎 `SecurityScopes`.
+
+⚫️ 🔜 ✔️ 🏠 `scopes` ⏮️ 📇 ⚗ 🌐 ↔ ✔ ⚫️ &amp; 🌐 🔗 👈 ⚙️ 👉 🎧-🔗. 👈 ⛓, 🌐 "⚓️"... 👉 💪 🔊 😨, ⚫️ 🔬 🔄 ⏪ 🔛.
+
+`security_scopes` 🎚 (🎓 `SecurityScopes`) 🚚 `scope_str` 🔢 ⏮️ 👁 🎻, 🔌 👈 ↔ 👽 🚀 (👥 🔜 ⚙️ ⚫️).
+
+👥 ✍ `HTTPException` 👈 👥 💪 🏤-⚙️ (`raise`) ⏪ 📚 ☝.
+
+👉 ⚠, 👥 🔌 ↔ 🚚 (🚥 🙆) 🎻 👽 🚀 (⚙️ `scope_str`). 👥 🚮 👈 🎻 ⚗ ↔ `WWW-Authenticate` 🎚 (👉 🍕 🔌).
+
+```Python hl_lines="105  107-115"
+{!../../../docs_src/security/tutorial005.py!}
+```
+
+## ✔ `username` &amp; 💽 💠
+
+👥 ✔ 👈 👥 🤚 `username`, &amp; ⚗ ↔.
+
+&amp; ⤴️ 👥 ✔ 👈 📊 ⏮️ Pydantic 🏷 (✊ `ValidationError` ⚠), &amp; 🚥 👥 🤚 ❌ 👂 🥙 🤝 ⚖️ ⚖ 📊 ⏮️ Pydantic, 👥 🤚 `HTTPException` 👥 ✍ ⏭.
+
+👈, 👥 ℹ Pydantic 🏷 `TokenData` ⏮️ 🆕 🏠 `scopes`.
+
+⚖ 📊 ⏮️ Pydantic 👥 💪 ⚒ 💭 👈 👥 ✔️, 🖼, ⚫️❔ `list` `str` ⏮️ ↔ &amp; `str` ⏮️ `username`.
+
+↩️, 🖼, `dict`, ⚖️ 🕳 🙆, ⚫️ 💪 💔 🈸 ☝ ⏪, ⚒ ⚫️ 💂‍♂ ⚠.
+
+👥 ✔ 👈 👥 ✔️ 👩‍💻 ⏮️ 👈 🆔, &amp; 🚥 🚫, 👥 🤚 👈 🎏 ⚠ 👥 ✍ ⏭.
+
+```Python hl_lines="46  116-127"
+{!../../../docs_src/security/tutorial005.py!}
+```
+
+## ✔ `scopes`
+
+👥 🔜 ✔ 👈 🌐 ↔ ✔, 👉 🔗 &amp; 🌐 ⚓️ (🔌 *➡ 🛠️*), 🔌 ↔ 🚚 🤝 📨, ⏪ 🤚 `HTTPException`.
+
+👉, 👥 ⚙️ `security_scopes.scopes`, 👈 🔌 `list` ⏮️ 🌐 👫 ↔ `str`.
+
+```Python hl_lines="128-134"
+{!../../../docs_src/security/tutorial005.py!}
+```
+
+## 🔗 🌲 &amp; ↔
+
+➡️ 📄 🔄 👉 🔗 🌲 &amp; ↔.
+
+`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`.
+
+📥 ❔ 🔗 🔗 &amp; ↔ 👀 💖:
+
+*  *➡ 🛠️* `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`, &amp; 🚮 🔗, `get_current_user`, 🚫 📣 🙆 `scope` 👯‍♂️.
+
+!!! tip
+    ⚠ &amp; "🎱" 👜 📥 👈 `get_current_user` 🔜 ✔️ 🎏 📇 `scopes` ✅ 🔠 *➡ 🛠️*.
+
+    🌐 ⚓️ 🔛 `scopes` 📣 🔠 *➡ 🛠️* &amp; 🔠 🔗 🔗 🌲 👈 🎯 *➡ 🛠️*.
+
+## 🌖 ℹ 🔃 `SecurityScopes`
+
+👆 💪 ⚙️ `SecurityScopes` 🙆 ☝, &amp; 💗 🥉, ⚫️ 🚫 ✔️ "🌱" 🔗.
+
+⚫️ 🔜 🕧 ✔️ 💂‍♂ ↔ 📣 ⏮️ `Security` 🔗 &amp; 🌐 ⚓️ **👈 🎯** *➡ 🛠️* &amp; **👈 🎯** 🔗 🌲.
+
+↩️ `SecurityScopes` 🔜 ✔️ 🌐 ↔ 📣 ⚓️, 👆 💪 ⚙️ ⚫️ ✔ 👈 🤝 ✔️ 🚚 ↔ 🇨🇫 🔗 🔢, &amp; ⤴️ 📣 🎏 ↔ 📄 🎏 *➡ 🛠️*.
+
+👫 🔜 ✅ ➡ 🔠 *➡ 🛠️*.
+
+## ✅ ⚫️
+
+🚥 👆 📂 🛠️ 🩺, 👆 💪 🔓 &amp; ✔ ❔ ↔ 👆 💚 ✔.
+
+<img src="/img/tutorial/security/image11.png">
+
+🚥 👆 🚫 🖊 🙆 ↔, 👆 🔜 "🔓", ✋️ 🕐❔ 👆 🔄 🔐 `/users/me/` ⚖️ `/users/me/items/` 👆 🔜 🤚 ❌ 💬 👈 👆 🚫 ✔️ 🥃 ✔. 👆 🔜 💪 🔐 `/status/`.
+
+&amp; 🚥 👆 🖊 ↔ `me` ✋️ 🚫 ↔ `items`, 👆 🔜 💪 🔐 `/users/me/` ✋️ 🚫 `/users/me/items/`.
+
+👈 ⚫️❔ 🔜 🔨 🥉 🥳 🈸 👈 🔄 🔐 1️⃣ 👫 *➡ 🛠️* ⏮️ 🤝 🚚 👩‍💻, ⚓️ 🔛 ❔ 📚 ✔ 👩‍💻 🤝 🈸.
+
+## 🔃 🥉 🥳 🛠️
+
+👉 🖼 👥 ⚙️ Oauth2️⃣ "🔐" 💧.
+
+👉 ☑ 🕐❔ 👥 🚨 👆 👍 🈸, 🎲 ⏮️ 👆 👍 🕸.
+
+↩️ 👥 💪 💙 ⚫️ 📨 `username` &amp; `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` 📤.

docs/em/docs/advanced/settings.md

@@ -0,0 +1,382 @@
+# ⚒ & 🌐 🔢
+
+📚 💼 👆 🈸 💪 💪 🔢 ⚒ ⚖️ 📳, 🖼 ㊙ 🔑, 💽 🎓, 🎓 📧 🐕‍🦺, ♒️.
+
+🏆 👫 ⚒ 🔢 (💪 🔀), 💖 💽 📛. & 📚 💪 🚿, 💖 ㊙.
+
+👉 🤔 ⚫️ ⚠ 🚚 👫 🌐 🔢 👈 ✍ 🈸.
+
+## 🌐 🔢
+
+!!! tip
+    🚥 👆 ⏪ 💭 ⚫️❔ "🌐 🔢" & ❔ ⚙️ 👫, 💭 🆓 🚶 ⏭ 📄 🔛.
+
+<a href="https://en.wikipedia.org/wiki/Environment_variable" class="external-link" target="_blank">🌐 🔢</a> (💭 "🇨🇻 {") 🔢 👈 🖖 🏞 🐍 📟, 🏃‍♂ ⚙️, &amp; 💪 ✍ 👆 🐍 📟 (⚖️ 🎏 📋 👍).
+
+👆 💪 ✍ &amp; ⚙️ 🌐 🔢 🐚, 🍵 💆‍♂ 🐍:
+
+=== "💾, 🇸🇻, 🚪 🎉"
+
+    <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>
+
+=== "🚪 📋"
+
+    <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>
+
+### ✍ 🇨🇻 {🐍
+
+👆 💪 ✍ 🌐 🔢 🏞 🐍, 📶 (⚖️ ⏮️ 🙆 🎏 👩‍🔬), &amp; ⤴️ ✍ 👫 🐍.
+
+🖼 👆 💪 ✔️ 📁 `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>
+
+🌐 🔢 💪 ⚒ 🏞 📟, ✋️ 💪 ✍ 📟, &amp; 🚫 ✔️ 🏪 (💕 `git`) ⏮️ 🎂 📁, ⚫️ ⚠ ⚙️ 👫 📳 ⚖️ ⚒.
+
+👆 💪 ✍ 🌐 🔢 🕴 🎯 📋 👼, 👈 🕴 💪 👈 📋, &amp; 🕴 🚮 📐.
+
+👈, ✍ ⚫️ ▶️️ ⏭ 📋 ⚫️, 🔛 🎏 ⏸:
+
+<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>.
+
+### 🆎 &amp; 🔬
+
+👫 🌐 🔢 💪 🕴 🍵 ✍ 🎻, 👫 🔢 🐍 &amp; ✔️ 🔗 ⏮️ 🎏 📋 &amp; 🎂 ⚙️ (&amp; ⏮️ 🎏 🏃‍♂ ⚙️, 💾, 🚪, 🇸🇻).
+
+👈 ⛓ 👈 🙆 💲 ✍ 🐍 ⚪️➡️ 🌐 🔢 🔜 `str`, &amp; 🙆 🛠️ 🎏 🆎 ⚖️ 🔬 ✔️ 🔨 📟.
+
+## Pydantic `Settings`
+
+👐, Pydantic 🚚 👑 🚙 🍵 👫 ⚒ 👟 ⚪️➡️ 🌐 🔢 ⏮️ <a href="https://pydantic-docs.helpmanual.io/usage/settings/" class="external-link" target="_blank">Pydantic: ⚒ 🧾</a>.
+
+### ✍ `Settings` 🎚
+
+🗄 `BaseSettings` ⚪️➡️ Pydantic &amp; ✍ 🎧-🎓, 📶 🌅 💖 ⏮️ Pydantic 🏷.
+
+🎏 🌌 ⏮️ Pydantic 🏷, 👆 📣 🎓 🔢 ⏮️ 🆎 ✍, &amp; 🎲 🔢 💲.
+
+👆 💪 ⚙️ 🌐 🎏 🔬 ⚒ &amp; 🧰 👆 ⚙️ Pydantic 🏷, 💖 🎏 📊 🆎 &amp; 🌖 🔬 ⏮️ `Field()`.
+
+```Python hl_lines="2  5-8  11"
+{!../../../docs_src/settings/tutorial001.py!}
+```
+
+!!! tip
+    🚥 👆 💚 🕳 ⏩ 📁 &amp; 📋, 🚫 ⚙️ 👉 🖼, ⚙️ 🏁 1️⃣ 🔛.
+
+⤴️, 🕐❔ 👆 ✍ 👐 👈 `Settings` 🎓 (👉 💼, `settings` 🎚), Pydantic 🔜 ✍ 🌐 🔢 💼-😛 🌌,, ↖-💼 🔢 `APP_NAME` 🔜 ✍ 🔢 `app_name`.
+
+⏭ ⚫️ 🔜 🗜 &amp; ✔ 💽. , 🕐❔ 👆 ⚙️ 👈 `settings` 🎚, 👆 🔜 ✔️ 📊 🆎 👆 📣 (✅ `items_per_user` 🔜 `int`).
+
+### ⚙️ `settings`
+
+⤴️ 👆 💪 ⚙️ 🆕 `settings` 🎚 👆 🈸:
+
+```Python hl_lines="18-20"
+{!../../../docs_src/settings/tutorial001.py!}
+```
+
+### 🏃 💽
+
+⏭, 👆 🔜 🏃 💽 🚶‍♀️ 📳 🌐 🔢, 🖼 👆 💪 ⚒ `ADMIN_EMAIL` &amp; `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
+    ⚒ 💗 🇨🇻 {👁 📋 🎏 👫 ⏮️ 🚀, &amp; 🚮 👫 🌐 ⏭ 📋.
+
+&amp; ⤴️ `admin_email` ⚒ 🔜 ⚒ `"deadpool@example.com"`.
+
+`app_name` 🔜 `"ChimichangApp"`.
+
+&amp; `items_per_user` 🔜 🚧 🚮 🔢 💲 `50`.
+
+## ⚒ ➕1️⃣ 🕹
+
+👆 💪 🚮 👈 ⚒ ➕1️⃣ 🕹 📁 👆 👀 [🦏 🈸 - 💗 📁](../tutorial/bigger-applications.md){.internal-link target=_blank}.
+
+🖼, 👆 💪 ✔️ 📁 `config.py` ⏮️:
+
+```Python
+{!../../../docs_src/settings/app01/config.py!}
+```
+
+&amp; ⤴️ ⚙️ ⚫️ 📁 `main.py`:
+
+```Python hl_lines="3  11-13"
+{!../../../docs_src/settings/app01/main.py!}
+```
+
+!!! tip
+    👆 🔜 💪 📁 `__init__.py` 👆 👀 🔛 [🦏 🈸 - 💗 📁](../tutorial/bigger-applications.md){.internal-link target=_blank}.
+
+## ⚒ 🔗
+
+🍾 ⚫️ 5️⃣📆 ⚠ 🚚 ⚒ ⚪️➡️ 🔗, ↩️ ✔️ 🌐 🎚 ⏮️ `settings` 👈 ⚙️ 🌐.
+
+👉 💪 ✴️ ⚠ ⏮️ 🔬, ⚫️ 📶 ⏩ 🔐 🔗 ⏮️ 👆 👍 🛃 ⚒.
+
+### 📁 📁
+
+👟 ⚪️➡️ ⏮️ 🖼, 👆 `config.py` 📁 💪 👀 💖:
+
+```Python hl_lines="10"
+{!../../../docs_src/settings/app02/config.py!}
+```
+
+👀 👈 🔜 👥 🚫 ✍ 🔢 👐 `settings = Settings()`.
+
+### 👑 📱 📁
+
+🔜 👥 ✍ 🔗 👈 📨 🆕 `config.Settings()`.
+
+```Python hl_lines="5  11-12"
+{!../../../docs_src/settings/app02/main.py!}
+```
+
+!!! tip
+    👥 🔜 🔬 `@lru_cache()` 🍖.
+
+    🔜 👆 💪 🤔 `get_settings()` 😐 🔢.
+
+&amp; ⤴️ 👥 💪 🚚 ⚫️ ⚪️➡️ *➡ 🛠️ 🔢* 🔗 &amp; ⚙️ ⚫️ 🙆 👥 💪 ⚫️.
+
+```Python hl_lines="16  18-20"
+{!../../../docs_src/settings/app02/main.py!}
+```
+
+### ⚒ &amp; 🔬
+
+⤴️ ⚫️ 🔜 📶 ⏩ 🚚 🎏 ⚒ 🎚 ⏮️ 🔬 🏗 🔗 🔐 `get_settings`:
+
+```Python hl_lines="9-10  13  21"
+{!../../../docs_src/settings/app02/test_main.py!}
+```
+
+🔗 🔐 👥 ⚒ 🆕 💲 `admin_email` 🕐❔ 🏗 🆕 `Settings` 🎚, &amp; ⤴️ 👥 📨 👈 🆕 🎚.
+
+⤴️ 👥 💪 💯 👈 ⚫️ ⚙️.
+
+## 👂 `.env` 📁
+
+🚥 👆 ✔️ 📚 ⚒ 👈 🎲 🔀 📚, 🎲 🎏 🌐, ⚫️ 5️⃣📆 ⚠ 🚮 👫 🔛 📁 &amp; ⤴️ ✍ 👫 ⚪️➡️ ⚫️ 🚥 👫 🌐 🔢.
+
+👉 💡 ⚠ 🥃 👈 ⚫️ ✔️ 📛, 👫 🌐 🔢 🛎 🥉 📁 `.env`, &amp; 📁 🤙 "🇨🇻".
+
+!!! tip
+    📁 ▶️ ⏮️ ❣ (`.`) 🕵‍♂ 📁 🖥-💖 ⚙️, 💖 💾 &amp; 🇸🇻.
+
+    ✋️ 🇨🇻 📁 🚫 🤙 ✔️ ✔️ 👈 ☑ 📁.
+
+Pydantic ✔️ 🐕‍🦺 👂 ⚪️➡️ 👉 🆎 📁 ⚙️ 🔢 🗃. 👆 💪 ✍ 🌖 <a href="https://pydantic-docs.helpmanual.io/usage/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`
+
+&amp; ⤴️ ℹ 👆 `config.py` ⏮️:
+
+```Python hl_lines="9-10"
+{!../../../docs_src/settings/app03/config.py!}
+```
+
+📥 👥 ✍ 🎓 `Config` 🔘 👆 Pydantic `Settings` 🎓, &amp; ⚒ `env_file` 📁 ⏮️ 🇨🇻 📁 👥 💚 ⚙️.
+
+!!! tip
+     `Config` 🎓 ⚙️ Pydantic 📳. 👆 💪 ✍ 🌖 <a href="https://pydantic-docs.helpmanual.io/usage/model_config/" class="external-link" target="_blank">Pydantic 🏷 📁</a>
+
+### 🏗 `Settings` 🕴 🕐 ⏮️ `lru_cache`
+
+👂 📁 ⚪️➡️ 💾 🛎 ⚠ (🐌) 🛠️, 👆 🎲 💚 ⚫️ 🕴 🕐 &amp; ⤴️ 🏤-⚙️ 🎏 ⚒ 🎚, ↩️ 👂 ⚫️ 🔠 📨.
+
+✋️ 🔠 🕰 👥:
+
+```Python
+Settings()
+```
+
+🆕 `Settings` 🎚 🔜 ✍, &amp; 🏗 ⚫️ 🔜 ✍ `.env` 📁 🔄.
+
+🚥 🔗 🔢 💖:
+
+```Python
+def get_settings():
+    return Settings()
+```
+
+👥 🔜 ✍ 👈 🎚 🔠 📨, &amp; 👥 🔜 👂 `.env` 📁 🔠 📨. 👶 👶
+
+✋️ 👥 ⚙️ `@lru_cache()` 👨‍🎨 🔛 🔝, `Settings` 🎚 🔜 ✍ 🕴 🕐, 🥇 🕰 ⚫️ 🤙. 👶 👶
+
+```Python hl_lines="1  10"
+{!../../../docs_src/settings/app03/main.py!}
+```
+
+⤴️ 🙆 🏁 🤙 `get_settings()` 🔗 ⏭ 📨, ↩️ 🛠️ 🔗 📟 `get_settings()` &amp; 🏗 🆕 `Settings` 🎚, ⚫️ 🔜 📨 🎏 🎚 👈 📨 🔛 🥇 🤙, 🔄 &amp; 🔄.
+
+#### `lru_cache` 📡 ℹ
+
+`@lru_cache()` 🔀 🔢 ⚫️ 🎀 📨 🎏 💲 👈 📨 🥇 🕰, ↩️ 💻 ⚫️ 🔄, 🛠️ 📟 🔢 🔠 🕰.
+
+, 🔢 🔛 ⚫️ 🔜 🛠️ 🕐 🔠 🌀 ❌. &amp; ⤴️ 💲 📨 🔠 👈 🌀 ❌ 🔜 ⚙️ 🔄 &amp; 🔄 🕐❔ 🔢 🤙 ⏮️ ⚫️❔ 🎏 🌀 ❌.
+
+🖼, 🚥 👆 ✔️ 🔢:
+
+```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()` ➡️ 👆 ❎ 👂 🇨🇻 📁 🔄 &amp; 🔄 🔠 📨, ⏪ 🤝 👆 🔐 ⚫️ ⏮️ 🔬.

docs/em/docs/advanced/sub-applications.md

@@ -0,0 +1,73 @@
+# 🎧 🈸 - 🗻
+
+🚥 👆 💪 ✔️ 2️⃣ 🔬 FastAPI 🈸, ⏮️ 👫 👍 🔬 🗄 & 👫 👍 🩺 ⚜, 👆 💪 ✔️ 👑 📱 & "🗻" 1️⃣ (⚖️ 🌅) 🎧-🈸(Ⓜ).
+
+## 🗜 **FastAPI** 🈸
+
+"🗜" ⛓ ❎ 🍕 "🔬" 🈸 🎯 ➡, 👈 ⤴️ ✊ 💅 🚚 🌐 🔽 👈 ➡, ⏮️ _➡ 🛠️_ 📣 👈 🎧-🈸.
+
+### 🔝-🎚 🈸
+
+🥇, ✍ 👑, 🔝-🎚, **FastAPI** 🈸, & 🚮 *➡ 🛠️*:
+
+```Python hl_lines="3  6-8"
+{!../../../docs_src/sub_applications/tutorial001.py!}
+```
+
+### 🎧-🈸
+
+⤴️, ✍ 👆 🎧-🈸, & 🚮 *➡ 🛠️*.
+
+👉 🎧-🈸 ➕1️⃣ 🐩 FastAPI 🈸, ✋️ 👉 1️⃣ 👈 🔜 "🗻":
+
+```Python hl_lines="11  14-16"
+{!../../../docs_src/sub_applications/tutorial001.py!}
+```
+
+### 🗻 🎧-🈸
+
+👆 🔝-🎚 🈸, `app`, 🗻 🎧-🈸, `subapi`.
+
+👉 💼, ⚫️ 🔜 📌 ➡ `/subapi`:
+
+```Python hl_lines="11  19"
+{!../../../docs_src/sub_applications/tutorial001.py!}
+```
+
+### ✅ 🏧 🛠️ 🩺
+
+🔜, 🏃 `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>
+
+&amp; 📂 🩺 <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">
+
+&amp; ⤴️, 📂 🩺 🎧-🈸, <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`.
+
+👈 🌌, 🎧-🈸 🔜 💭 ⚙️ 👈 ➡ 🔡 🩺 🎚.
+
+&amp; 🎧-🈸 💪 ✔️ 🚮 👍 📌 🎧-🈸 &amp; 🌐 🔜 👷 ☑, ↩️ FastAPI 🍵 🌐 👉 `root_path`Ⓜ 🔁.
+
+👆 🔜 💡 🌅 🔃 `root_path` &amp; ❔ ⚙️ ⚫️ 🎯 📄 🔃 [⛅ 🗳](./behind-a-proxy.md){.internal-link target=_blank}.

docs/em/docs/advanced/templates.md

@@ -0,0 +1,77 @@
+# 📄
+
+👆 💪 ⚙️ 🙆 📄 🚒 👆 💚 ⏮️ **FastAPI**.
+
+⚠ ⚒ Jinja2️⃣, 🎏 1️⃣ ⚙️ 🏺 & 🎏 🧰.
+
+📤 🚙 🔗 ⚫️ 💪 👈 👆 💪 ⚙️ 🔗 👆 **FastAPI** 🈸 (🚚 💃).
+
+## ❎ 🔗
+
+❎ `jinja2`:
+
+<div class="termy">
+
+```console
+$ pip install jinja2
+
+---> 100%
+```
+
+</div>
+
+## ⚙️ `Jinja2Templates`
+
+* 🗄 `Jinja2Templates`.
+* ✍ `templates` 🎚 👈 👆 💪 🏤-⚙️ ⏪.
+* 📣 `Request` 🔢 *➡ 🛠️* 👈 🔜 📨 📄.
+* ⚙️ `templates` 👆 ✍ ✍ &amp; 📨 `TemplateResponse`, 🚶‍♀️ `request` 1️⃣ 🔑-💲 👫 Jinja2️⃣ "🔑".
+
+```Python hl_lines="4  11  15-16"
+{!../../../docs_src/templates/tutorial001.py!}
+```
+
+!!! note
+    👀 👈 👆 ✔️ 🚶‍♀️ `request` 🍕 🔑-💲 👫 🔑 Jinja2️⃣. , 👆 ✔️ 📣 ⚫️ 👆 *➡ 🛠️*.
+
+!!! tip
+    📣 `response_class=HTMLResponse` 🩺 🎚 🔜 💪 💭 👈 📨 🔜 🕸.
+
+!!! note "📡 ℹ"
+    👆 💪 ⚙️ `from starlette.templating import Jinja2Templates`.
+
+    **FastAPI** 🚚 🎏 `starlette.templating` `fastapi.templating` 🏪 👆, 👩‍💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃. 🎏 ⏮️ `Request` &amp; `StaticFiles`.
+
+## ✍ 📄
+
+⤴️ 👆 💪 ✍ 📄 `templates/item.html` ⏮️:
+
+```jinja hl_lines="7"
+{!../../../docs_src/templates/templates/item.html!}
+```
+
+⚫️ 🔜 🎦 `id` ✊ ⚪️➡️ "🔑" `dict` 👆 🚶‍♀️:
+
+```Python
+{"request": request, "id": id}
+```
+
+## 📄 &amp; 🎻 📁
+
+&amp; 👆 💪 ⚙️ `url_for()` 🔘 📄, &amp; ⚙️ ⚫️, 🖼, ⏮️ `StaticFiles` 👆 📌.
+
+```jinja hl_lines="4"
+{!../../../docs_src/templates/templates/item.html!}
+```
+
+👉 🖼, ⚫️ 🔜 🔗 🎚 📁 `static/styles.css` ⏮️:
+
+```CSS hl_lines="4"
+{!../../../docs_src/templates/static/styles.css!}
+```
+
+&amp; ↩️ 👆 ⚙️ `StaticFiles`, 👈 🎚 📁 🔜 🍦 🔁 👆 **FastAPI** 🈸 📛 `/static/styles.css`.
+
+## 🌅 ℹ
+
+🌅 ℹ, 🔌 ❔ 💯 📄, ✅ <a href="https://www.starlette.io/templates/" class="external-link" target="_blank">💃 🩺 🔛 📄</a>.

docs/em/docs/advanced/testing-database.md

@@ -0,0 +1,95 @@
+# 🔬 💽
+
+👆 💪 ⚙️ 🎏 🔗 🔐 ⚪️➡️ [🔬 🔗 ⏮️ 🔐](testing-dependencies.md){.internal-link target=_blank} 📉 💽 🔬.
+
+👆 💪 💚 ⚒ 🆙 🎏 💽 🔬, 💾 💽 ⏮️ 💯, 🏤-🥧 ⚫️ ⏮️ 🔬 💽, ♒️.
+
+👑 💭 ⚫️❔ 🎏 👆 👀 👈 ⏮️ 📃.
+
+## 🚮 💯 🗄 📱
+
+➡️ ℹ 🖼 ⚪️➡️ [🗄 (🔗) 💽](../tutorial/sql-databases.md){.internal-link target=_blank} ⚙️ 🔬 💽.
+
+🌐 📱 📟 🎏, 👆 💪 🚶 🔙 👈 📃 ✅ ❔ ⚫️.
+
+🕴 🔀 📥 🆕 🔬 📁.
+
+👆 😐 🔗 `get_db()` 🔜 📨 💽 🎉.
+
+💯, 👆 💪 ⚙️ 🔗 🔐 📨 👆 *🛃* 💽 🎉 ↩️ 1️⃣ 👈 🔜 ⚙️ 🛎.
+
+👉 🖼 👥 🔜 ✍ 🍕 💽 🕴 💯.
+
+## 📁 📊
+
+👥 ✍ 🆕 📁 `sql_app/tests/test_sql_app.py`.
+
+🆕 📁 📊 👀 💖:
+
+``` hl_lines="9-11"
+.
+└── sql_app
+    ├── __init__.py
+    ├── crud.py
+    ├── database.py
+    ├── main.py
+    ├── models.py
+    ├── schemas.py
+    └── tests
+        ├── __init__.py
+        └── test_sql_app.py
+```
+
+## ✍ 🆕 💽 🎉
+
+🥇, 👥 ✍ 🆕 💽 🎉 ⏮️ 🆕 💽.
+
+💯 👥 🔜 ⚙️ 📁 `test.db` ↩️ `sql_app.db`.
+
+✋️ 🎂 🎉 📟 🌅 ⚖️ 🌘 🎏, 👥 📁 ⚫️.
+
+```Python hl_lines="8-13"
+{!../../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!}
+```
+
+!!! tip
+    👆 💪 📉 ❎ 👈 📟 🚮 ⚫️ 🔢 & ⚙️ ⚫️ ⚪️➡️ 👯‍♂️ `database.py` & `tests/test_sql_app.py`.
+
+    🦁 & 🎯 🔛 🎯 🔬 📟, 👥 🖨 ⚫️.
+
+## ✍ 💽
+
+↩️ 🔜 👥 🔜 ⚙️ 🆕 💽 🆕 📁, 👥 💪 ⚒ 💭 👥 ✍ 💽 ⏮️:
+
+```Python
+Base.metadata.create_all(bind=engine)
+```
+
+👈 🛎 🤙 `main.py`, ✋️ ⏸ `main.py` ⚙️ 💽 📁 `sql_app.db`, & 👥 💪 ⚒ 💭 👥 ✍ `test.db` 💯.
+
+👥 🚮 👈 ⏸ 📥, ⏮️ 🆕 📁.
+
+```Python hl_lines="16"
+{!../../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!}
+```
+
+## 🔗 🔐
+
+🔜 👥 ✍ 🔗 🔐 & 🚮 ⚫️ 🔐 👆 📱.
+
+```Python hl_lines="19-24  27"
+{!../../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!}
+```
+
+!!! tip
+    📟 `override_get_db()` 🌖 ⚫️❔ 🎏 `get_db()`, ✋️ `override_get_db()` 👥 ⚙️ `TestingSessionLocal` 🔬 💽 ↩️.
+
+## 💯 📱
+
+⤴️ 👥 💪 💯 📱 🛎.
+
+```Python hl_lines="32-47"
+{!../../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!}
+```
+
+& 🌐 🛠️ 👥 ⚒ 💽 ⏮️ 💯 🔜 `test.db` 💽 ↩️ 👑 `sql_app.db`.

docs/em/docs/advanced/testing-dependencies.md

@@ -0,0 +1,49 @@
+# 🔬 🔗 ⏮️ 🔐
+
+## 🔑 🔗 ⏮️ 🔬
+
+📤 😐 🌐❔ 👆 💪 💚 🔐 🔗 ⏮️ 🔬.
+
+👆 🚫 💚 ⏮️ 🔗 🏃 (🚫 🙆 🎧-🔗 ⚫️ 💪 ✔️).
+
+↩️, 👆 💚 🚚 🎏 🔗 👈 🔜 ⚙️ 🕴 ⏮️ 💯 (🎲 🕴 🎯 💯), & 🔜 🚚 💲 👈 💪 ⚙️ 🌐❔ 💲 ⏮️ 🔗 ⚙️.
+
+### ⚙️ 💼: 🔢 🐕‍🦺
+
+🖼 💪 👈 👆 ✔️ 🔢 🤝 🐕‍🦺 👈 👆 💪 🤙.
+
+👆 📨 ⚫️ 🤝 & ⚫️ 📨 🔓 👩‍💻.
+
+👉 🐕‍🦺 5️⃣📆 🔌 👆 📍 📨, & 🤙 ⚫️ 💪 ✊ ➕ 🕰 🌘 🚥 👆 ✔️ 🔧 🎁 👩‍💻 💯.
+
+👆 🎲 💚 💯 🔢 🐕‍🦺 🕐, ✋️ 🚫 🎯 🤙 ⚫️ 🔠 💯 👈 🏃.
+
+👉 💼, 👆 💪 🔐 🔗 👈 🤙 👈 🐕‍🦺, & ⚙️ 🛃 🔗 👈 📨 🎁 👩‍💻, 🕴 👆 💯.
+
+### ⚙️ `app.dependency_overrides` 🔢
+
+👫 💼, 👆 **FastAPI** 🈸 ✔️ 🔢 `app.dependency_overrides`, ⚫️ 🙅 `dict`.
+
+🔐 🔗 🔬, 👆 🚮 🔑 ⏮️ 🔗 (🔢), & 💲, 👆 🔗 🔐 (➕1️⃣ 🔢).
+
+& ⤴️ **FastAPI** 🔜 🤙 👈 🔐 ↩️ ⏮️ 🔗.
+
+```Python hl_lines="28-29  32"
+{!../../../docs_src/dependency_testing/tutorial001.py!}
+```
+
+!!! tip
+    👆 💪 ⚒ 🔗 🔐 🔗 ⚙️ 🙆 👆 **FastAPI** 🈸.
+
+    ⏮️ 🔗 💪 ⚙️ *➡ 🛠️ 🔢*, *➡ 🛠️ 👨‍🎨* (🕐❔ 👆 🚫 ⚙️ 📨 💲), `.include_router()` 🤙, ♒️.
+
+    FastAPI 🔜 💪 🔐 ⚫️.
+
+⤴️ 👆 💪 ⏲ 👆 🔐 (❎ 👫) ⚒ `app.dependency_overrides` 🛁 `dict`:
+
+```Python
+app.dependency_overrides = {}
+```
+
+!!! tip
+    🚥 👆 💚 🔐 🔗 🕴 ⏮️ 💯, 👆 💪 ⚒ 🔐 ▶️ 💯 (🔘 💯 🔢) & ⏲ ⚫️ 🔚 (🔚 💯 🔢).

docs/em/docs/advanced/testing-events.md

@@ -0,0 +1,7 @@
+# 🔬 🎉: 🕴 - 🤫
+
+🕐❔ 👆 💪 👆 🎉 🐕‍🦺 (`startup` & `shutdown`) 🏃 👆 💯, 👆 💪 ⚙️ `TestClient` ⏮️ `with` 📄:
+
+```Python hl_lines="9-12  20-24"
+{!../../../docs_src/app_testing/tutorial003.py!}
+```

docs/em/docs/advanced/testing-websockets.md

@@ -0,0 +1,12 @@
+# 🔬 *️⃣
+
+👆 💪 ⚙️ 🎏 `TestClient` 💯*️⃣.
+
+👉, 👆 ⚙️ `TestClient` `with` 📄, 🔗*️⃣:
+
+```Python hl_lines="27-31"
+{!../../../docs_src/app_testing/tutorial002.py!}
+```
+
+!!! note
+    🌅 ℹ, ✅ 💃 🧾 <a href="https://www.starlette.io/testclient/#testing-websocket-sessions" class="external-link" target="_blank">🔬 *️⃣ </a>.

docs/em/docs/advanced/using-request-directly.md

@@ -0,0 +1,52 @@
+# ⚙️ 📨 🔗
+
+🆙 🔜, 👆 ✔️ 📣 🍕 📨 👈 👆 💪 ⏮️ 👫 🆎.
+
+✊ 📊 ⚪️➡️:
+
+* ➡ 🔢.
+* 🎚.
+* 🍪.
+* ♒️.
+
+& 🔨, **FastAPI** ⚖ 👈 💽, 🏭 ⚫️ & 🏭 🧾 👆 🛠️ 🔁.
+
+✋️ 📤 ⚠ 🌐❔ 👆 💪 💪 🔐 `Request` 🎚 🔗.
+
+## ℹ 🔃 `Request` 🎚
+
+**FastAPI** 🤙 **💃** 🔘, ⏮️ 🧽 📚 🧰 🔛 🔝, 👆 💪 ⚙️ 💃 <a href="https://www.starlette.io/requests/" class="external-link" target="_blank">`Request`</a> 🎚 🔗 🕐❔ 👆 💪.
+
+⚫️ 🔜 ⛓ 👈 🚥 👆 🤚 📊 ⚪️➡️ `Request` 🎚 🔗 (🖼, ✍ 💪) ⚫️ 🏆 🚫 ✔, 🗜 ⚖️ 📄 (⏮️ 🗄, 🏧 🛠️ 👩‍💻 🔢) FastAPI.
+
+👐 🙆 🎏 🔢 📣 🛎 (🖼, 💪 ⏮️ Pydantic 🏷) 🔜 ✔, 🗜, ✍, ♒️.
+
+✋️ 📤 🎯 💼 🌐❔ ⚫️ ⚠ 🤚 `Request` 🎚.
+
+## ⚙️ `Request` 🎚 🔗
+
+➡️ 🌈 👆 💚 🤚 👩‍💻 📢 📢/🦠 🔘 👆 *➡ 🛠️ 🔢*.
+
+👈 👆 💪 🔐 📨 🔗.
+
+```Python hl_lines="1  7-8"
+{!../../../docs_src/using_request_directly/tutorial001.py!}
+```
+
+📣 *➡ 🛠️ 🔢* 🔢 ⏮️ 🆎 ➖ `Request` **FastAPI** 🔜 💭 🚶‍♀️ `Request` 👈 🔢.
+
+!!! tip
+    🗒 👈 👉 💼, 👥 📣 ➡ 🔢 ⤴️ 📨 🔢.
+
+    , ➡ 🔢 🔜 ⚗, ✔, 🗜 ✔ 🆎 &amp; ✍ ⏮️ 🗄.
+
+    🎏 🌌, 👆 💪 📣 🙆 🎏 🔢 🛎, &amp; ➡, 🤚 `Request` 💁‍♂️.
+
+## `Request` 🧾
+
+👆 💪 ✍ 🌅 ℹ 🔃 <a href="https://www.starlette.io/requests/" class="external-link" target="_blank">`Request` 🎚 🛂 💃 🧾 🕸</a>.
+
+!!! note "📡 ℹ"
+    👆 💪 ⚙️ `from starlette.requests import Request`.
+
+    **FastAPI** 🚚 ⚫️ 🔗 🏪 👆, 👩‍💻. ✋️ ⚫️ 👟 🔗 ⚪️➡️ 💃.

docs/em/docs/advanced/websockets.md

@@ -0,0 +1,184 @@
+#  *️⃣
+
+👆 💪 ⚙️ <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 ⚖️ 📐.
+
+&amp; 🔗 ⚙️ *️⃣ ⏮️ 👆 👩‍💻 👆 🔜 🎲 ⚙️ 👆 🕸 🚙.
+
+⚖️ 👆 💪 ✔️ 🇦🇸 📱 🈸 👈 🔗 ⏮️ 👆 *️⃣ 👩‍💻 🔗, 🇦🇸 📟.
+
+⚖️ 👆 5️⃣📆 ✔️ 🙆 🎏 🌌 🔗 ⏮️ *️⃣ 🔗.
+
+---
+
+✋️ 👉 🖼, 👥 🔜 ⚙️ 📶 🙅 🕸 📄 ⏮️ 🕸, 🌐 🔘 📏 🎻.
+
+👉, ↗️, 🚫 ⚖ &amp; 👆 🚫🔜 ⚙️ ⚫️ 🏭.
+
+🏭 👆 🔜 ✔️ 1️⃣ 🎛 🔛.
+
+✋️ ⚫️ 🙅 🌌 🎯 🔛 💽-🚄 *️⃣ &amp; ✔️ 👷 🖼:
+
+```Python hl_lines="2  6-38  41-43"
+{!../../../docs_src/websockets/tutorial001.py!}
+```
+
+## ✍ `websocket`
+
+👆 **FastAPI** 🈸, ✍ `websocket`:
+
+```Python hl_lines="1  46-47"
+{!../../../docs_src/websockets/tutorial001.py!}
+```
+
+!!! note "📡 ℹ"
+    👆 💪 ⚙️ `from starlette.websockets import WebSocket`.
+
+    **FastAPI** 🚚 🎏 `WebSocket` 🔗 🏪 👆, 👩‍💻. ✋️ ⚫️ 👟 🔗 ⚪️➡️ 💃.
+
+## ⌛ 📧 &amp; 📨 📧
+
+👆 *️⃣ 🛣 👆 💪 `await` 📧 &amp; 📨 📧.
+
+```Python hl_lines="48-52"
+{!../../../docs_src/websockets/tutorial001.py!}
+```
+
+👆 💪 📨 &amp; 📨 💱, ✍, &amp; 🎻 💽.
+
+## 🔄 ⚫️
+
+🚥 👆 📁 📛 `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">
+
+👆 💪 🆎 📧 🔢 📦, &amp; 📨 👫:
+
+<img src="/img/tutorial/websockets/image02.png">
+
+&amp; 👆 **FastAPI** 🈸 ⏮️ *️⃣ 🔜 📨 🔙:
+
+<img src="/img/tutorial/websockets/image03.png">
+
+👆 💪 📨 (&amp; 📨) 📚 📧:
+
+<img src="/img/tutorial/websockets/image04.png">
+
+&amp; 🌐 👫 🔜 ⚙️ 🎏 *️⃣ 🔗.
+
+## ⚙️ `Depends` &amp; 🎏
+
+*️⃣ 🔗 👆 💪 🗄 ⚪️➡️ `fastapi` &amp; ⚙️:
+
+* `Depends`
+* `Security`
+* `Cookie`
+* `Header`
+* `Path`
+* `Query`
+
+👫 👷 🎏 🌌 🎏 FastAPI 🔗/*➡ 🛠️*:
+
+```Python hl_lines="66-77  76-91"
+{!../../../docs_src/websockets/tutorial002.py!}
+```
+
+!!! 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` 🔜 🍵 🔗.
+
+⏮️ 👈 👆 💪 🔗 *️⃣ &amp; ⤴️ 📨 &amp; 📨 📧:
+
+<img src="/img/tutorial/websockets/image05.png">
+
+## 🚚 🔀 &amp; 💗 👩‍💻
+
+🕐❔ *️⃣ 🔗 📪, `await websocket.receive_text()` 🔜 🤚 `WebSocketDisconnect` ⚠, ❔ 👆 💪 ⤴️ ✊ &amp; 🍵 💖 👉 🖼.
+
+```Python hl_lines="81-83"
+{!../../../docs_src/websockets/tutorial003.py!}
+```
+
+🔄 ⚫️ 👅:
+
+* 📂 📱 ⏮️ 📚 🖥 📑.
+* ✍ 📧 ⚪️➡️ 👫.
+* ⤴️ 🔐 1️⃣ 📑.
+
+👈 🔜 🤚 `WebSocketDisconnect` ⚠, &amp; 🌐 🎏 👩‍💻 🔜 📨 📧 💖:
+
+```
+Client #1596980209979 left the chat
+```
+
+!!! tip
+    📱 🔛 ⭐ &amp; 🙅 🖼 🎦 ❔ 🍵 &amp; 📻 📧 📚 *️⃣ 🔗.
+
+    ✋️ ✔️ 🤯 👈, 🌐 🍵 💾, 👁 📇, ⚫️ 🔜 🕴 👷 ⏪ 🛠️ 🏃, &amp; 🔜 🕴 👷 ⏮️ 👁 🛠️.
+
+    🚥 👆 💪 🕳 ⏩ 🛠️ ⏮️ FastAPI ✋️ 👈 🌖 🏋️, 🐕‍🦺 ✳, ✳ ⚖️ 🎏, ✅ <a href="https://github.com/encode/broadcaster" class="external-link" target="_blank">🗜/📻</a>.
+
+## 🌅 ℹ
+
+💡 🌅 🔃 🎛, ✅ 💃 🧾:
+
+* <a href="https://www.starlette.io/websockets/" class="external-link" target="_blank"> `WebSocket` 🎓</a>.
+* <a href="https://www.starlette.io/endpoints/#websocketendpoint" class="external-link" target="_blank">🎓-⚓️ *️⃣ 🚚</a>.