### Hey API { #hey-api }

Once we have a FastAPI app with the models, we can use Hey API to generate a TypeScript client. The fastest way to do that is via npx.

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

This will generate a TypeScript SDK in `./src/client`.

    processResponse(response, listener)
    listener.assertOpen()
    listener.assertEvent(null, null, "hey")
    listener.assertClose()
  }

  @Test
  fun cancelShortCircuits() {
    server.enqueue(
      MockResponse
        .Builder()
        .body(
          """
          |data: hey
          |
          |
          """.trimMargin(),
        ).setHeader("content-type", "text/event-stream")

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
```

これで TypeScript SDK が `./src/client` に生成されます。

이는 단지 단어와 명칭의 문제입니다. 하지만 이런 단어가 여러분과 팀원이 코드를 어떻게 생각하는지에 영향을 줄 수 있습니다.

예를 들어, 다음 함수를 보세요:

```python
from typing import Optional


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

매개변수 `name`은 `Optional[str]`로 정의되어 있지만, 사실 선택적이지 않습니다. 이 매개변수 없이 함수를 호출할 수 없습니다:

```Python
say_hi()  # 이런, 에러가 발생합니다! 😱
```

        .Builder()
        .body(
          """
          |data: hey
          |
          |
          """.trimMargin(),
        ).setHeader("content-type", "text/event-stream")
        .build(),
    )
    val source = newEventSource()
    assertThat(source.request().url.encodedPath).isEqualTo("/")
    listener.assertOpen()
    listener.assertEvent(null, null, "hey")
    listener.assertClose()
  }

  @RetryingTest(5)

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에 포함된 모델의 동일한 정보가 **클라이언트 코드 생성**에 사용될 수 있습니다.

### 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。

這些資訊都在應用的 **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。