如果您正在开发**前端**，一个非常有趣的替代方案是 <a href="https://github.com/hey-api/openapi-ts" class="external-link" target="_blank">openapi-ts</a>。

## 生成一个 TypeScript 前端客户端

让我们从一个简单的 FastAPI 应用开始：

{* ../../docs_src/generate_clients/tutorial001_py39.py hl[7:9,12:13,16:17,21] *}

请注意，*路径操作* 定义了他们所用于请求数据和回应数据的模型，所使用的模型是`Item` 和 `ResponseMessage`。

### API 文档

如果您访问API文档，您将看到它具有在请求中发送和在响应中接收数据的**模式(schemas)**：

```Python
images: list[Image]
```

so wie in:

{* ../../docs_src/body_nested_models/tutorial008_py39.py hl[13] *}

## Editor-Unterstützung überall { #editor-support-everywhere }

Und Sie erhalten Editor-Unterstützung überall.

Selbst für Dinge in Listen:

Por exemplo, para declarar um outro retorno com o status code `404` e um modelo do Pydantic chamado `Message`, você pode escrever:

{* ../../docs_src/additional_responses/tutorial001_py39.py hl[18,22] *}

/// note | Nota

Lembre-se que você deve retornar o `JSONResponse` diretamente.

///

/// info | Informação

A chave `model` não é parte do OpenAPI.

{* ../../docs_src/first_steps/tutorial001_py39.py hl[7] *}

This is a Python function.

It will be called by **FastAPI** whenever it receives a request to the URL "`/`" using a `GET` operation.

In this case, it is an `async` function.

---

You could also define it as a normal function instead of `async def`:

{* ../../docs_src/first_steps/tutorial003_py39.py hl[7] *}

/// note

{* ../../docs_src/first_steps/tutorial003_py39.py hl[7] *}

/// note | Hinweis

Wenn Sie den Unterschied nicht kennen, lesen Sie [Async: *„In Eile?“*](../async.md#in-a-hurry){.internal-link target=_blank}.

///

### Schritt 5: den Inhalt zurückgeben { #step-5-return-the-content }

{* ../../docs_src/first_steps/tutorial001_py39.py hl[8] *}

Як тип вкажемо `list`.

Оскільки список є типом, який містить деякі внутрішні типи, ви поміщаєте їх у квадратні дужки:

```Python hl_lines="1"
{!> ../../docs_src/python_types/tutorial006_py39.py!}
```

////

/// info

Ці внутрішні типи в квадратних дужках називаються "параметрами типу".

У цьому випадку, `str` це параметр типу переданий у `List` (або `list` у Python 3.9 і вище).

Então, você pode declarar sua função assim:

{* ../../docs_src/path_params_numeric_validations/tutorial002_py39.py hl[7] *}

Mas tenha em mente que, se você usar `Annotated`, você não terá esse problema, não fará diferença, pois você não está usando valores padrão de parâmetros de função para `Query()` ou `Path()`.

Например, чтобы объявить ещё один ответ со статус-кодом `404` и Pydantic-моделью `Message`, можно написать:

{* ../../docs_src/additional_responses/tutorial001_py39.py hl[18,22] *}

/// note | Примечание

Имейте в виду, что необходимо возвращать `JSONResponse` напрямую.

///

/// info | Информация

Ключ `model` не является частью OpenAPI.

```Python
images: list[Image]
```

como em:

{* ../../docs_src/body_nested_models/tutorial008_py39.py hl[13] *}

## Suporte de editor em todo canto { #editor-support-everywhere }

E você obtém suporte do editor em todos os lugares.

Mesmo para itens dentro de listas:

Así que puedes declarar tu función como:

{* ../../docs_src/path_params_numeric_validations/tutorial002_py39.py hl[7] *}

Pero ten en cuenta que si usas `Annotated`, no tendrás este problema, no importará ya que no estás usando los valores por defecto de los parámetros de la función para `Query()` o `Path()`.