"""
    API key authentication using a query parameter.

    This defines the name of the query parameter that should be provided in the request
    with the API key and integrates that into the OpenAPI documentation. It extracts
    the key value sent in the query parameter automatically and provides it as the
    dependency result. But it doesn't define how to send that API key to the client.

    ## Usage

///

## Adicione informações extras { #add-extra-information }

Você pode declarar informação extra em `Field`, `Query`, `Body`, etc. E isso será incluído no JSON Schema gerado.

Você irá aprender mais sobre adicionar informações extras posteriormente nessa documentação, quando estiver aprendendo a declarar exemplos.

/// warning | Atenção

# Додаткові моделі { #extra-models }

Продовжуючи попередній приклад, часто потрібно мати більше ніж одну пов’язану модель.

Особливо це стосується моделей користувача, тому що:

* **вхідна модель** повинна мати пароль.
* **вихідна модель** не повинна містити пароль.
* **модель бази даних**, ймовірно, повинна містити хеш пароля.

/// danger | Обережно

# Types de données supplémentaires { #extra-data-types }

Jusqu'à présent, vous avez utilisé des types de données courants, comme :

* `int`
* `float`
* `str`
* `bool`

Mais vous pouvez aussi utiliser des types de données plus complexes.

Et vous bénéficierez toujours des mêmes fonctionnalités que jusqu'à présent :

* Excellente prise en charge dans l'éditeur.
* Conversion des données à partir des requêtes entrantes.

Вы можете объявлять примеры данных, которые ваше приложение может получать.

Вот несколько способов, как это сделать.

## Дополнительные данные JSON Schema в моделях Pydantic { #extra-json-schema-data-in-pydantic-models }

Вы можете объявить `examples` для модели Pydantic, которые будут добавлены в сгенерированную JSON Schema.

{* ../../docs_src/schema_extra_example/tutorial001_py310.py hl[13:24] *}

# 宣告請求範例資料 { #declare-request-example-data }

你可以宣告你的應用程式可接收資料的 examples。

以下有數種方式可達成。

## Pydantic 模型中的額外 JSON Schema 資料 { #extra-json-schema-data-in-pydantic-models }

你可以為 Pydantic 模型宣告 `examples`，它們會加入到產生出的 JSON Schema 中。

{* ../../docs_src/schema_extra_example/tutorial001_py310.py hl[13:24] *}

這些額外資訊會原封不動加入該模型輸出的 JSON Schema，並且會用在 API 文件裡。

 * Negotiation Protocol) authentication. It contains the username extracted from the
 * SPNEGO authentication process, typically from a Kerberos ticket.
 */
public class SpnegoCredential implements LoginCredential, FessCredential {

    /** The username extracted from SPNEGO authentication. */
    private final String username;

    /**

# Extramodelle { #extra-models }

Im Anschluss an das vorherige Beispiel ist es üblich, mehr als ein zusammenhängendes Modell zu haben.

Dies gilt insbesondere für Benutzermodelle, denn:

* Das **Eingabemodell** muss ein Passwort enthalten können.
* Das **Ausgabemodell** sollte kein Passwort haben.
* Das **Datenbankmodell** müsste wahrscheinlich ein gehashtes Passwort haben.

/// danger | Gefahr

# 追加のモデル { #extra-models }

先ほどの例に続き、複数の関連モデルを持つことは一般的です。

これはユーザーモデルの場合は特にそうです。なぜなら:

* **入力モデル** にはパスワードが必要です。
* **出力モデル**はパスワードをもつべきではありません。
* **データベースモデル**はおそらくハッシュ化されたパスワードが必要になるでしょう。

/// danger | 警告

ユーザーの平文のパスワードは絶対に保存しないでください。常に検証できる「安全なハッシュ」を保存してください。

知らない方は、[セキュリティの章](security/simple-oauth2.md#password-hashing)で「パスワードハッシュ」とは何かを学ぶことができます。

///

## 複数のモデル { #multiple-models }

# Дополнительные модели { #extra-models }

В продолжение прошлого примера будет уже обычным делом иметь несколько связанных между собой моделей.

Это особенно применимо в случае моделей пользователя, потому что:

* **Модель для ввода** должна иметь возможность содержать пароль.
* **Модель для вывода** не должна содержать пароль.
* **Модель для базы данных**, возможно, должна содержать хэшированный пароль.

/// danger | Внимание