## `examples` no JSON Schema - OpenAPI { #examples-in-json-schema-openapi }

Ao usar qualquer um de:

* `Path()`
* `Query()`
* `Header()`
* `Cookie()`
* `Body()`
* `Form()`
* `File()`

você também pode declarar um grupo de `examples` com informações adicionais que serão adicionadas aos seus **JSON Schemas** dentro do **OpenAPI**.

    /** The key of the configuration. e.g. true */
    String COOKIE_SEARCH_PARAMETER_http_only = "cookie.search.parameter.http_only";

    /** The key of the configuration. e.g.  */
    String COOKIE_SEARCH_PARAMETER_SECURE = "cookie.search.parameter.secure";

    /** The key of the configuration. e.g. 60 */
    String COOKIE_SEARCH_PARAMETER_max_age = "cookie.search.parameter.max_age";

/// check | 启发 **FastAPI**：

寻找获得卓越性能的方法。

与 Hug（Hug 基于 Falcon）一起，启发 **FastAPI** 在函数中声明一个 `response` 参数。尽管在 FastAPI 中它是可选的，主要用于设置 headers、cookies 和可选的状态码。

///

### [Molten](https://moltenframework.com/) { #molten }

我在构建 **FastAPI** 的早期阶段发现了 Molten。它有不少相似的想法：

* 基于 Python 类型提示。
* 从这些类型获得校验与文档。
* 依赖注入系统。

# 直接使用 Request { #using-the-request-directly }

到目前為止，你都是用對應的型別來宣告你需要的請求各部分。

例如從以下來源取得資料：

- 路徑中的參數。
- 標頭。
- Cookies。
- 等等。

這麼做時，FastAPI 會自動驗證並轉換這些資料，還會為你的 API 產生文件。

但有些情況你可能需要直接存取 `Request` 物件。

## 關於 `Request` 物件的細節 { #details-about-the-request-object }

由於 FastAPI 底層其實是 Starlette，再加上一層工具，因此在需要時你可以直接使用 Starlette 的 [`Request`](https://www.starlette.dev/requests/) 物件。

{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}

## JSON Schema에서의 `examples` - OpenAPI { #examples-in-json-schema-openapi }

다음 중 하나를 사용할 때:

* `Path()`
* `Query()`
* `Header()`
* `Cookie()`
* `Body()`
* `Form()`
* `File()`

**OpenAPI** 안의 **JSON 스키마**에 추가될 부가적인 정보를 포함한 `examples` 모음을 선언할 수도 있습니다.

### `examples`를 포함한 `Body` { #body-with-examples }

```

## Resumen { #summary }

Puedes usar **modelos de Pydantic** para declarar **parámetros query** en **FastAPI**. 😎

/// tip | Consejo

Alerta de spoiler: también puedes usar modelos de Pydantic para declarar cookies y headers, pero leerás sobre eso más adelante en el tutorial. 🤫

{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}

## `examples` in JSON Schema - OpenAPI { #examples-in-json-schema-openapi }

When using any of:

* `Path()`
* `Query()`
* `Header()`
* `Cookie()`
* `Body()`
* `Form()`
* `File()`

you can also declare a group of `examples` with additional information that will be added to their **JSON Schemas** inside of **OpenAPI**.

但那只會允許某些類型的通訊，凡是涉及憑證（credentials）的都會被排除：例如 Cookie、Authorization 標頭（像 Bearer Token 會用到的）等。

因此，為了讓一切正常運作，最好明確指定被允許的來源。

## 使用 `CORSMiddleware` { #use-corsmiddleware }

你可以在 **FastAPI** 應用程式中使用 `CORSMiddleware` 來設定：

* 匯入 `CORSMiddleware`。
* 建立允許的來源清單（字串）。
* 將它加入到你的 **FastAPI** 應用程式做為「中介軟體（middleware）」。

你也可以指定你的後端是否允許：

* 憑證（credentials，例如 Authorization 標頭、Cookie 等）。
* 特定的 HTTP 方法（如 `POST`、`PUT`），或使用萬用字元 `"*"` 表示全部。

from ._compat import (
    Undefined,
)
from .datastructures import _Unset


class ParamTypes(Enum):
    query = "query"
    header = "header"
    path = "path"
    cookie = "cookie"


class Param(FieldInfo):  # type: ignore[misc]
    in_: ParamTypes

    def __init__(
        self,
        default: Any = Undefined,
        *,

```

## Zusammenfassung { #summary }

Sie können **Pydantic-Modelle** verwenden, um **Query-Parameter** in **FastAPI** zu deklarieren. 😎

/// tip | Tipp

Spoiler-Alarm: Sie können auch Pydantic-Modelle verwenden, um Cookies und Header zu deklarieren, aber darüber werden Sie später im Tutorial lesen. 🤫