# 使用指南 - 範例集

在這裡，你將會看到**不同主題**的範例或「如何使用」的指南。

大多數這些想法都是**獨立**的，在大多數情況下，你只需要研究那些直接適用於**你的專案**的東西。

如果有些東西看起來很有趣且對你的專案很有用的話再去讀它，否則你可能可以跳過它們。

/// tip

如果你想要以結構化的方式**學習 FastAPI**（推薦），請前往[教學 - 使用者指南](../tutorial/index.md){.internal-link target=_blank}逐章閱讀。

# Generate CONTRIBUTORS.md: contributors.sh

# Tip for finding duplicates (besides scanning the output of CONTRIBUTORS.md for name
# duplicates that aren't also email duplicates): scan the output of:
#   git log --format='%aE - %aN' | sort -uf
#
# For explanation on this file format: man git-shortlog

Anand Babu (AB) Periasamy <******@****.***> Anand Babu (AB) Periasamy <******@****.***>
Anand Babu (AB) Periasamy <******@****.***> <******@****.***>

👉 💪 ⚙️ ⏩ ⌨ 🚥 👆 ✔️ 🕴 1️⃣ Pydantic 🏷 & 💚 ❎ 💽 ⚪️➡️ 🔢.

/// tip

✋️ ⚫️ 👍 ⚙️ 💭 🔛, ⚙️ 💗 🎓, ↩️ 👫 🔢.

👉 ↩️ 🎻 🔗 🏗 👆 📱 🗄 (& 🩺) 🔜 1️⃣ 🏁 🏷, 🚥 👆 ⚙️ `response_model_include` ⚖️ `response_model_exclude` 🚫 🔢.

👉 ✔ `response_model_by_alias` 👈 👷 ➡.

///

{* ../../docs_src/response_model/tutorial005.py hl[31,37] *}

/// tip

❕ `{"name", "description"}` ✍ `set` ⏮️ 📚 2️⃣ 💲.

///

## Упорядковуйте параметри, як Вам потрібно

/// tip | Підказка

Це, мабуть, не настільки важливо або необхідно, якщо Ви використовуєте `Annotated`.

///

Припустимо, Ви хочете оголосити параметр запиту `q`  як обов’язковий `str`.

{* ../../docs_src/async_tests/test_main.py hl[7] *}

/// tip | 팁

테스트 함수가 이제 `TestClient`를 사용할 때처럼 단순히 `def`가 아니라 `async def`로 작성된 점에 주목해주세요.

///

그 다음에  `AsyncClient` 로 앱을 만들고 비동기 요청을 `await` 키워드로 보낼 수 있습니다:

{* ../../docs_src/async_tests/test_main.py hl[9:12] *}

위의 코드는:

```Python
response = client.get('/')
```

`TestClient` 에 요청을 보내던 것과 동일합니다.

/// tip | 팁

You should do it after adding all your *path operations*.

{* ../../docs_src/path_operation_advanced_configuration/tutorial002.py hl[2, 12:21, 24] *}

/// tip

If you manually call `app.openapi()`, you should update the `operationId`s before that.

///

/// warning

If you do this, you have to make sure each one of your *path operation functions* has a unique name.

/// info | Дополнительная информация

<a href="https://docs.python.org/3/library/enum.html" class="external-link" target="_blank">Перечисления (enum) доступны в Python</a> начиная с версии 3.4.

///

/// tip | Подсказка

Если интересно, то "AlexNet", "ResNet" и "LeNet" - это названия <abbr title="Технически, это архитектуры моделей глубокого обучения">моделей</abbr> машинного обучения.

///

Heutzutage ist es nicht sehr populär und wird kaum verwendet.

OAuth2 spezifiziert nicht, wie die Kommunikation verschlüsselt werden soll, sondern erwartet, dass Ihre Anwendung mit HTTPS bereitgestellt wird.

/// tip | Tipp

Im Abschnitt über **Deployment** erfahren Sie, wie Sie HTTPS mithilfe von Traefik und Let's Encrypt kostenlos einrichten.

///

## OpenID Connect

Veamos cómo hacer uso de una subclase personalizada de `Request` para descomprimir requests gzip.

Y una subclase de `APIRoute` para usar esa clase de request personalizada.

### Crear una clase personalizada `GzipRequest`

/// tip | Consejo

Este es un ejemplo sencillo para demostrar cómo funciona. Si necesitas soporte para Gzip, puedes usar el [`GzipMiddleware`](../advanced/middleware.md#gzipmiddleware){.internal-link target=_blank} proporcionado.

///

It is not very popular or used nowadays.

OAuth2 doesn't specify how to encrypt the communication, it expects you to have your application served with HTTPS.

/// tip

In the section about **deployment** you will see how to set up HTTPS for free, using Traefik and Let's Encrypt.

///

## OpenID Connect { #openid-connect }