À titre d'exemple, prenons cette fonction :

```python
from typing import Optional


def say_hi(name: Optional[str]):
    print(f"Hey {name}!")
```

Le paramètre `name` est défini comme `Optional[str]`, mais il n'est pas facultatif, vous ne pouvez pas appeler la fonction sans le paramètre :

```Python
say_hi()  # Oh non, cela lève une erreur ! 😱
```

def say_hi(name: Optional[str]):
    print(f"Hey {name}!")
```

参数 `name` 被定义为 `Optional[str]`，但它并不是“可选”的，你不能不传这个参数就调用函数：

```Python
say_hi()  # 哎呀，这会报错！😱
```

参数 `name` 仍然是必填的（不是“可选”），因为它没有默认值。不过，`name` 接受 `None` 作为取值：

```Python
say_hi(name=None)  # 这样可以，None 是有效的 🎉
```

好消息是，在大多数情况下，你可以直接使用 `|` 来定义类型联合：

```python
def say_hi(name: str | None):
    print(f"Hey {name}!")
```

`Union[SomeType, None]` の方が意味がより明確だと思います。

これは用語や名前付けの話に過ぎませんが、その言葉があなたやチームメイトのコードの捉え方に影響します。

例として次の関数を見てみましょう:

```python
from typing import Optional


def say_hi(name: Optional[str]):
    print(f"Hey {name}!")
```

パラメータ `name` は `Optional[str]` と定義されていますが、任意ではありません。このパラメータなしで関数を呼び出すことはできません:

```Python
say_hi()  # あっ、これはエラーになります！😱
```

这些信息会包含在应用的 **OpenAPI 模式** 中，并显示在 API 文档里。

OpenAPI 中包含的这些模型信息就是用于**生成客户端代码**的基础。

### Hey API { #hey-api }

当我们有了带模型的 FastAPI 应用后，可以使用 Hey API 来生成 TypeScript 客户端。最快的方式是通过 npx：

```sh
npx @hey-api/openapi-ts -i http://localhost:8000/openapi.json -o src/client
```

这会在 `./src/client` 生成一个 TypeScript SDK。

這些資訊都在應用的 **OpenAPI 結構**中，並顯示在 API 文件裡。

同樣包含在 OpenAPI 中的模型資訊，也可以用來**產生用戶端程式碼**。

### Hey API { #hey-api }

當我們有含模型的 FastAPI 應用後，就能用 Hey API 來產生 TypeScript 用戶端。最快的方法是透過 npx：

```sh
npx @hey-api/openapi-ts -i http://localhost:8000/openapi.json -o src/client
```

這會在 `./src/client` 產生一個 TypeScript SDK。

Як приклад, розгляньмо цю функцію:

```python
from typing import Optional


def say_hi(name: Optional[str]):
    print(f"Hey {name}!")
```

Параметр `name` визначено як `Optional[str]`, але він не є необов'язковим, ви не можете викликати функцію без цього параметра:

```Python
say_hi()  # О ні, це викликає помилку! 😱
```

OpenAPI에 포함된 모델의 동일한 정보가 **클라이언트 코드 생성**에 사용될 수 있습니다.

### Hey API { #hey-api }

모델이 포함된 FastAPI 앱이 준비되면, Hey API를 사용해 TypeScript 클라이언트를 생성할 수 있습니다. 가장 빠른 방법은 npx를 사용하는 것입니다.

```sh
npx @hey-api/openapi-ts -i http://localhost:8000/openapi.json -o src/client
```

이 명령은 `./src/client`에 TypeScript SDK를 생성합니다.

Como ejemplo, tomemos esta función:

```python
from typing import Optional


def say_hi(name: Optional[str]):
    print(f"Hey {name}!")
```

El parámetro `name` está definido como `Optional[str]`, pero **no es opcional**, no puedes llamar a la función sin el parámetro:

```Python
say_hi()  # ¡Oh, no, esto lanza un error! 😱
```

As an example, let's take this function:

```python
from typing import Optional


def say_hi(name: Optional[str]):
    print(f"Hey {name}!")
```

The parameter `name` is defined as `Optional[str]`, but it is **not optional**, you cannot call the function without the parameter:

```Python
say_hi()  # Oh, no, this throws an error! 😱
```

def say_hi(name: Optional[str]):
    print(f"Hey {name}!")
```

參數 `name` 被標註為 `Optional[str]`，但它並不是可選的；你不能在沒有該參數的情況下呼叫這個函式：

```Python
say_hi()  # 糟了，這會拋出錯誤！😱
```

參數 `name` 仍是必填（不是可選），因為它沒有預設值。不過，`name` 可以接受 `None` 作為值：

```Python
say_hi(name=None)  # 這可行，None 是有效的 🎉
```

好消息是，多數情況下你可以直接用 `|` 來定義型別聯集：

```python
def say_hi(name: str | None):
    print(f"Hey {name}!")
```