{* ../../docs_src/background_tasks/tutorial001_py310.py hl[1,13] *}

**FastAPI** 會為你建立 `BackgroundTasks` 物件，並以該參數傳入。

## 建立任務函式 { #create-a-task-function }

建立一個作為背景任務執行的函式。

它只是個可接收參數的一般函式。

它可以是 `async def`，也可以是一般的 `def`，**FastAPI** 都能正確處理。

在此例中，任務函式會寫入檔案（模擬寄送電子郵件）。

由於寫入操作未使用 `async` 與 `await`，因此以一般的 `def` 定義該函式：

{* ../../docs_src/background_tasks/tutorial001_py310.py hl[6:9] *}

{* ../../docs_src/path_params/tutorial001_py310.py hl[6:7] *}

路徑參數 `item_id` 的值會作為引數 `item_id` 傳入你的函式。

所以，如果你執行這個範例並前往 [http://127.0.0.1:8000/items/foo](http://127.0.0.1:8000/items/foo)，你會看到這樣的回應：

```JSON
{"item_id":"foo"}
```

## 具型別的路徑參數 { #path-parameters-with-types }

你可以在函式中使用標準的 Python 型別註記為路徑參數宣告型別：

{* ../../docs_src/path_params/tutorial002_py310.py hl[7] *}

在這個例子裡，`item_id` 被宣告為 `int`。

/// check

## `HTTPException`の使用 { #use-httpexception }

HTTPレスポンスをエラーでクライアントに返すには、`HTTPException`を使用します。

### `HTTPException`のインポート { #import-httpexception }

{* ../../docs_src/handling_errors/tutorial001_py310.py hl[1] *}

### コード内での`HTTPException`の発生 { #raise-an-httpexception-in-your-code }

`HTTPException`は通常のPythonの例外であり、APIに関連するデータを追加したものです。

Pythonの例外なので、`return`ではなく、`raise`です。

Here's how it could look like:

{* ../../docs_src/dependencies/tutorial013_an_py310.py *}

The exit code, the automatic closing of the `Session` in:

{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[19:21] *}

...would be run after the response finishes sending the slow data:

{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[30:38] hl[31:33] *}

# İlk Adımlar { #first-steps }

En sade FastAPI dosyası şu şekilde görünür:

{* ../../docs_src/first_steps/tutorial001_py310.py *}

Yukarıdakini `main.py` adlı bir dosyaya kopyalayın.

Canlı sunucuyu çalıştırın:

<div class="termy">

```console
$ <font color="#4E9A06">fastapi</font> dev

  <span style="background-color:#009485"><font color="#D3D7CF"> FastAPI </font></span>  Starting development server 🚀

///

## 使用 Pydantic 模型的 Header 参数 { #header-parameters-with-a-pydantic-model }

在 **Pydantic 模型**中声明所需的 **header 参数**，然后将参数声明为 `Header` :

{* ../../docs_src/header_param_models/tutorial001_an_py310.py hl[9:14,18] *}

**FastAPI** 将从请求中接收到的 **headers** 中**提取**出**每个字段**的数据，并提供您定义的 Pydantic 模型。

## 查看文档 { #check-the-docs }

您可以在文档 UI 的 `/docs` 中查看所需的 headers：

<div class="screenshot">

簡単な例から始めてみましょう:

{* ../../docs_src/python_types/tutorial001_py310.py *}

このプログラムを呼び出すと、以下が出力されます:

```
John Doe
```

この関数は以下のようなことを行います:

* `first_name` と `last_name` を取得します。
* `title()` を用いて、それぞれの最初の文字を大文字に変換します。
* 真ん中にスペースを入れて<dfn title="1つにまとめます。片方の内容をもう片方の後ろに続けます。">連結</dfn>します。

{* ../../docs_src/python_types/tutorial001_py310.py hl[2] *}

### 編集 { #edit-it }

これはとても簡単なプログラムです。

假設你有一個帶有預設值的 Pydantic 模型，如下所示：

{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *}

### 輸入用模型 { #model-for-input }

如果你把這個模型用作輸入，如下所示：

{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *}

...則 `description` 欄位將不是必填。因為它的預設值是 `None`。

### 文件中的輸入模型 { #input-model-in-docs }

你可以在文件中確認，`description` 欄位沒有紅色星號，表示不是必填：

假设你有一个带有默认值的 Pydantic 模型，例如：

{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *}

### 输入用的模型 { #model-for-input }

如果你像下面这样把该模型用作输入：

{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *}

...那么 `description` 字段将**不是必填项**，因为它的默认值是 `None`。

### 文档中的输入模型 { #input-model-in-docs }

当然，这并不是最优的做法，您不应该在生产环境中使用它。

在生产环境中，您应该选择上述任一选项。

但这是一种专注于 WebSockets 的服务器端并提供一个工作示例的最简单方式：

{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}

## 创建 `websocket` { #create-a-websocket }

在您的 **FastAPI** 应用程序中，创建一个 `websocket`：

{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}

/// note | 技术细节

您也可以使用 `from starlette.websockets import WebSocket`。