fastapi/docs/en/mkdocs.yml

site_name: FastAPI
site_description: FastAPI framework, high performance, easy to learn, fast to code, ready for production
site_url: https://fastapi.tiangolo.com/
theme:
  variant: classic
  name: material
  custom_dir: overrides
  palette:
  - media: (prefers-color-scheme)
    toggle:
      icon: material/lightbulb-auto
      name: Switch to light mode
  - media: '(prefers-color-scheme: light)'
    scheme: default
    primary: teal
    accent: amber
    toggle:
      icon: material/lightbulb
      name: Switch to dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    primary: teal
    accent: amber
    toggle:
      icon: material/lightbulb-outline
      name: Switch to system preference
  features:
  - content.code.annotate
  - content.code.copy
  - content.footnote.tooltips
  - content.tabs.link
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.instant
  - navigation.instant.prefetch
  - navigation.instant.progress
  - navigation.path
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - search.highlight
  - search.share
  - search.suggest
  - toc.follow
  icon:
    repo: octicons/mark-github-24
  logo: img/icon-white.svg
  favicon: img/favicon.png
  language: en
repo_name: fastapi/fastapi
repo_url: https://github.com/fastapi/fastapi
plugins:
  mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_typingdoc
          show_root_heading: true
          show_if_no_docstring: true
          preload_modules:
          - httpx
          - starlette
          inherited_members: true
          members_order: source
          separate_signature: true
          unwrap_annotated: true
          filters:
          - '!^_'
          merge_init_into_class: true
          docstring_section_style: spacy
          signature_crossrefs: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
nav:
- FastAPI: index.md
- features.md
- "":
  - learn/index.md
  - python-types.md
  - async.md
  - environment-variables.md
  - virtual-environments.md
  - "":
    - tutorial/index.md
    - tutorial/first-steps.md
    - tutorial/path-params.md
    - tutorial/query-params.md
    - tutorial/body.md
    - tutorial/query-params-str-validations.md
    - tutorial/path-params-numeric-validations.md
    - tutorial/query-param-models.md
    - tutorial/body-multiple-params.md
    - tutorial/body-fields.md
    - tutorial/body-nested-models.md
    - tutorial/schema-extra-example.md
    - tutorial/extra-data-types.md
    - tutorial/cookie-params.md
    - tutorial/header-params.md
    - tutorial/cookie-param-models.md
    - tutorial/header-param-models.md
    - tutorial/response-model.md
    - tutorial/extra-models.md
    - tutorial/response-status-code.md
    - tutorial/request-forms.md
    - tutorial/request-form-models.md
    - tutorial/request-files.md
    - tutorial/request-forms-and-files.md
    - tutorial/handling-errors.md
    - tutorial/path-operation-configuration.md
    - tutorial/encoder.md
    - tutorial/body-updates.md
    - "":
      - tutorial/dependencies/index.md
      - tutorial/dependencies/classes-as-dependencies.md
      - tutorial/dependencies/sub-dependencies.md
      - tutorial/dependencies/dependencies-in-path-operation-decorators.md
      - tutorial/dependencies/global-dependencies.md
      - tutorial/dependencies/dependencies-with-yield.md
    - "":
      - tutorial/security/index.md
      - tutorial/security/first-steps.md
      - tutorial/security/get-current-user.md
      - tutorial/security/simple-oauth2.md
      - tutorial/security/oauth2-jwt.md
    - tutorial/middleware.md
    - tutorial/cors.md
    - tutorial/sql-databases.md
    - tutorial/bigger-applications.md
    - tutorial/stream-json-lines.md
    - tutorial/server-sent-events.md
    - tutorial/background-tasks.md
    - tutorial/metadata.md
    - tutorial/static-files.md
    - tutorial/testing.md
    - tutorial/debugging.md
  - "":
    - advanced/index.md
    - advanced/stream-data.md
    - advanced/path-operation-advanced-configuration.md
    - advanced/additional-status-codes.md
    - advanced/response-directly.md
    - advanced/custom-response.md
    - advanced/additional-responses.md
    - advanced/response-cookies.md
    - advanced/response-headers.md
    - advanced/response-change-status-code.md
    - advanced/advanced-dependencies.md
    - "":
      - advanced/security/index.md
      - advanced/security/oauth2-scopes.md
      - advanced/security/http-basic-auth.md
    - advanced/using-request-directly.md
    - advanced/dataclasses.md
    - advanced/middleware.md
    - advanced/sub-applications.md
    - advanced/behind-a-proxy.md
    - advanced/templates.md
    - advanced/websockets.md
    - advanced/events.md
    - advanced/testing-websockets.md
    - advanced/testing-events.md
    - advanced/testing-dependencies.md
    - advanced/async-tests.md
    - advanced/settings.md
    - advanced/openapi-callbacks.md
    - advanced/openapi-webhooks.md
    - advanced/wsgi.md
    - advanced/generate-clients.md
    - advanced/advanced-python-types.md
    - advanced/json-base64-bytes.md
    - advanced/strict-content-type.md
  - fastapi-cli.md
  - editor-support.md
  - "":
    - deployment/index.md
    - deployment/versions.md
    - deployment/fastapicloud.md
    - deployment/https.md
    - deployment/manually.md
    - deployment/concepts.md
    - deployment/cloud.md
    - deployment/server-workers.md
    - deployment/docker.md
  - "":
    - how-to/index.md
    - how-to/general.md
    - how-to/migrate-from-pydantic-v1-to-pydantic-v2.md
    - how-to/graphql.md
    - how-to/custom-request-and-route.md
    - how-to/conditional-openapi.md
    - how-to/extending-openapi.md
    - how-to/separate-openapi-schemas.md
    - how-to/custom-docs-ui-assets.md
    - how-to/configure-swagger-ui.md
    - how-to/testing-database.md
    - how-to/authentication-error-status-code.md
- "":
  - reference/index.md
  - reference/fastapi.md
  - reference/parameters.md
  - reference/status.md
  - reference/uploadfile.md
  - reference/exceptions.md
  - reference/dependencies.md
  - reference/apirouter.md
  - reference/background.md
  - reference/request.md
  - reference/websockets.md
  - reference/httpconnection.md
  - reference/response.md
  - reference/responses.md
  - reference/middleware.md
  - "":
    - reference/openapi/index.md
    - reference/openapi/docs.md
    - reference/openapi/models.md
  - reference/security/index.md
  - reference/encoders.md
  - reference/staticfiles.md
  - reference/templating.md
  - reference/testclient.md
- fastapi-people.md
- "":
  - resources/index.md
  - help-fastapi.md
  - contributing.md
  - translations.md
  - project-generation.md
  - external-links.md
  - newsletter.md
- "":
  - about/index.md
  - alternatives.md
  - history-design-future.md
  - benchmarks.md
  - management.md
- release-notes.md
markdown_extensions:
  zensical.extensions.macros: null
  abbr: null
  attr_list: null
  footnotes: null
  md_in_html: null
  tables: null
  toc:
    permalink: true
  pymdownx.betterem: null
  pymdownx.caret: null
  pymdownx.highlight:
    line_spans: __span
    linenums_style: pymdownx-inline
  pymdownx.inlinehilite: null
  pymdownx.keys: null
  pymdownx.mark: null
  pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format ''
  pymdownx.tilde: null
  pymdownx.blocks.admonition:
    # TODO: remove types section (with custom types) once translations are migrated to
    # not use custom types too
    types:
    # Default types
    - note
    - attention
    - caution
    - danger
    - error
    - tip
    - hint
    - warning
    # Custom types
    - info
    - check
  pymdownx.blocks.details: null
  pymdownx.blocks.tab:
    alternate_style: true
  mdx_include: null
  markdown_include_variants: null
extra:
  social:
  - icon: octicons/mark-github-24
    link: https://github.com/fastapi/fastapi
  - icon: fontawesome/brands/discord
    link: https://discord.gg/VQjSZaeJmf
  - icon: fontawesome/brands/x-twitter
    link: https://x.com/fastapi
  - icon: fontawesome/brands/bluesky
    link: https://bsky.app/profile/fastapi.tiangolo.com
  - icon: fontawesome/brands/linkedin
    link: https://www.linkedin.com/company/fastapi
  alternate:
  - link: /
    name: en - English
  - link: /de/
    name: de - Deutsch
  - link: /es/
    name: es - español
  - link: /fr/
    name: fr - français
  - link: /ja/
    name: ja - 日本語
  - link: /ko/
    name: ko - 한국어
  - link: /pt/
    name: pt - português
  - link: /ru/
    name: ru - русский язык
  - link: /tr/
    name: tr - Türkçe
  - link: /uk/
    name: uk - українська мова
  - link: /zh/
    name: zh - 简体中文
  - link: /zh-hant/
    name: zh-hant - 繁體中文
extra_css:
- css/termynal.css
- css/custom.css
extra_javascript:
- js/termynal.js
- js/custom.js
- js/init_kapa_widget.js
validation:
  unresolved_references: false