Jan Vollmer
6 months ago
committed by
GitHub
GitHub
13 changed files with 1561 additions and 4 deletions
@ -0,0 +1,96 @@ |
|||
# 고급 미들웨어 |
|||
|
|||
메인 튜토리얼에서 [Custom Middleware](../tutorial/middleware.md){.internal-link target=_blank}를 응용프로그램에 추가하는 방법을 읽으셨습니다. |
|||
|
|||
그리고 [CORS with the `CORSMiddleware`](){.internal-link target=_blank}하는 방법도 보셨습니다. |
|||
|
|||
이 섹션에서는 다른 미들웨어들을 사용하는 방법을 알아보겠습니다. |
|||
|
|||
## ASGI 미들웨어 추가하기 |
|||
|
|||
**FastAPI**는 Starlette을 기반으로 하고 있으며, <abbr title="Asynchronous Server Gateway Interface">ASGI</abbr> 사양을 구현하므로 ASGI 미들웨어를 사용할 수 있습니다. |
|||
|
|||
미들웨어가 FastAPI나 Starlette용으로 만들어지지 않아도 ASGI 사양을 준수하는 한 동작할 수 있습니다. |
|||
|
|||
일반적으로 ASGI 미들웨어는 첫 번째 인수로 ASGI 앱을 받는 클래스들입니다. |
|||
|
|||
따라서 타사 ASGI 미들웨어 문서에서 일반적으로 다음과 같이 사용하도록 안내할 것입니다. |
|||
|
|||
```Python |
|||
from unicorn import UnicornMiddleware |
|||
|
|||
app = SomeASGIApp() |
|||
|
|||
new_app = UnicornMiddleware(app, some_config="rainbow") |
|||
``` |
|||
|
|||
하지만 내부 미들웨어가 서버 오류를 처리하고 사용자 정의 예외 처리기가 제대로 작동하도록 하는 더 간단한 방법을 제공하는 FastAPI(실제로는 Starlette)가 있습니다. |
|||
|
|||
이를 위해 `app.add_middleware()`를 사용합니다(CORS의 예에서와 같이). |
|||
|
|||
```Python |
|||
from fastapi import FastAPI |
|||
from unicorn import UnicornMiddleware |
|||
|
|||
app = FastAPI() |
|||
|
|||
app.add_middleware(UnicornMiddleware, some_config="rainbow") |
|||
``` |
|||
|
|||
`app.add_middleware()`는 첫 번째 인수로 미들웨어 클래스와 미들웨어에 전달할 추가 인수를 받습니다. |
|||
|
|||
## 통합 미들웨어 |
|||
|
|||
**FastAPI**에는 일반적인 사용 사례를 위한 여러 미들웨어가 포함되어 있으며, 사용 방법은 다음에서 살펴보겠습니다. |
|||
|
|||
/// note | 기술 세부 사항 |
|||
|
|||
다음 예제에서는 `from starlette.middleware.something import SomethingMiddleware`를 사용할 수도 있습니다. |
|||
|
|||
**FastAPI**는 개발자의 편의를 위해 `fastapi.middleware`에 여러 미들웨어를 제공합니다. 그러나 사용 가능한 대부분의 미들웨어는 Starlette에서 직접 제공합니다. |
|||
|
|||
/// |
|||
|
|||
## `HTTPSRedirectMiddleware` |
|||
|
|||
들어오는 모든 요청이 `https` 또는 `wss`여야 합니다. |
|||
|
|||
`http` 또는 `ws`로 들어오는 모든 요청은 대신 보안 체계로 리디렉션됩니다. |
|||
|
|||
{* ../../docs_src/advanced_middleware/tutorial001.py hl[2,6] *} |
|||
|
|||
## `TrustedHostMiddleware` |
|||
|
|||
HTTP 호스트 헤더 공격을 방지하기 위해 모든 수신 요청에 올바르게 설정된 `Host` 헤더를 갖도록 강제합니다. |
|||
|
|||
{* ../../docs_src/advanced_middleware/tutorial002.py hl[2,6:8] *} |
|||
|
|||
다음 인수가 지원됩니다: |
|||
|
|||
* `allowed_hosts` - 호스트 이름으로 허용해야 하는 도메인 이름 목록입니다. 일치하는 하위 도메인에 대해 `*.example.com`과 같은 와일드카드 도메인이 지원됩니다. 모든 호스트 이름을 허용하려면 `allowed_hosts=[“*”]`를 사용하거나 미들웨어를 생략하세요. |
|||
|
|||
수신 요청의 유효성이 올바르게 확인되지 않으면 `400`이라는 응답이 전송됩니다. |
|||
|
|||
## `GZipMiddleware` |
|||
|
|||
`Accept-Encoding` 헤더에 `“gzip”`이 포함된 모든 요청에 대해 GZip 응답을 처리합니다. |
|||
|
|||
미들웨어는 표준 응답과 스트리밍 응답을 모두 처리합니다. |
|||
|
|||
{* ../../docs_src/advanced_middleware/tutorial003.py hl[2,6] *} |
|||
|
|||
지원되는 인수는 다음과 같습니다: |
|||
|
|||
* `minimum_size` - 이 최소 크기(바이트)보다 작은 응답은 GZip하지 않습니다. 기본값은 `500`입니다. |
|||
* `compresslevel` - GZip 압축 중에 사용됩니다. 1에서 9 사이의 정수입니다. 기본값은 `9`입니다. 값이 낮을수록 압축 속도는 빨라지지만 파일 크기는 커지고, 값이 높을수록 압축 속도는 느려지지만 파일 크기는 작아집니다. |
|||
|
|||
## 기타 미들웨어 |
|||
|
|||
다른 많은 ASGI 미들웨어가 있습니다. |
|||
|
|||
예를 들어: |
|||
|
|||
<a href=“https://github.com/encode/uvicorn/blob/master/uvicorn/middleware/proxy_headers.py” class=“external-link” target=“_blank”>유비콘의 `ProxyHeadersMiddleware`></a> |
|||
<a href=“https://github.com/florimondmanca/msgpack-asgi” class=“external-link” target=“_blank”>MessagePack</a> |
|||
|
|||
사용 가능한 다른 미들웨어를 확인하려면 <a href=“https://www.starlette.io/middleware/” class=“external-link” target=“_blank”>스타렛의 미들웨어 문서</a> 및 <a href=“https://github.com/florimondmanca/awesome-asgi” class=“external-link” target=“_blank”>ASGI Awesome List</a>를 참조하세요. |
|||
@ -0,0 +1,53 @@ |
|||
# 테스트 의존성 오버라이드 |
|||
|
|||
## 테스트 중 의존성 오버라이드하기 |
|||
|
|||
테스트를 진행하다 보면 의존성을 오버라이드해야 하는 경우가 있습니다. |
|||
|
|||
원래 의존성을 실행하고 싶지 않을 수도 있습니다(또는 그 의존성이 가지고 있는 하위 의존성까지도 실행되지 않길 원할 수 있습니다). |
|||
|
|||
대신, 테스트 동안(특정 테스트에서만) 사용될 다른 의존성을 제공하고, 원래 의존성이 사용되던 곳에서 사용할 수 있는 값을 제공하기를 원할 수 있습니다. |
|||
|
|||
### 사용 사례: 외부 서비스 |
|||
|
|||
예를 들어, 외부 인증 제공자를 호출해야 하는 경우를 생각해봅시다. |
|||
|
|||
토큰을 보내면 인증된 사용자를 반환합니다. |
|||
|
|||
제공자는 요청당 요금을 부과할 수 있으며, 테스트를 위해 고정된 모의 사용자가 있는 경우보다 호출하는 데 시간이 더 걸릴 수 있습니다. |
|||
|
|||
외부 제공자를 한 번만 테스트하고 싶을 수도 있지만 테스트를 실행할 때마다 반드시 호출할 필요는 없습니다. |
|||
|
|||
이 경우 해당 공급자를 호출하는 종속성을 오버라이드하고 테스트에 대해서만 모의 사용자를 반환하는 사용자 지정 종속성을 사용할 수 있습니다. |
|||
|
|||
### `app.dependency_overrides` 속성 사용하기 |
|||
|
|||
이런 경우를 위해 **FastAPI** 응용 프로그램에는 `app.dependency_overrides`라는 속성이 있습니다. 이는 간단한 `dict`입니다. |
|||
|
|||
테스트를 위해 의존성을 오버라이드하려면, 원래 의존성(함수)을 키로 설정하고 오버라이드할 의존성(다른 함수)을 값으로 설정합니다. |
|||
|
|||
그럼 **FastAPI**는 원래 의존성 대신 오버라이드된 의존성을 호출합니다. |
|||
|
|||
{* ../../docs_src/dependency_testing/tutorial001_an_py310.py hl[26:27,30] *} |
|||
|
|||
/// tip | 팁 |
|||
|
|||
**FastAPI** 애플리케이션 어디에서든 사용된 의존성에 대해 오버라이드를 설정할 수 있습니다. |
|||
|
|||
원래 의존성은 *경로 동작 함수*, *경로 동작 데코레이터*(반환값을 사용하지 않는 경우), `.include_router()` 호출 등에서 사용될 수 있습니다. |
|||
|
|||
FastAPI는 여전히 이를 오버라이드할 수 있습니다. |
|||
|
|||
/// |
|||
|
|||
그런 다음, `app.dependency_overrides`를 빈 `dict`로 설정하여 오버라이드를 재설정(제거)할 수 있습니다: |
|||
|
|||
```python |
|||
app.dependency_overrides = {} |
|||
``` |
|||
|
|||
/// tip | 팁 |
|||
|
|||
특정 테스트에서만 의존성을 오버라이드하고 싶다면, 테스트 시작 시(테스트 함수 내부) 오버라이드를 설정하고 테스트 종료 시(테스트 함수 끝부분) 재설정하면 됩니다. |
|||
|
|||
/// |
|||
@ -0,0 +1,186 @@ |
|||
# WebSockets |
|||
|
|||
여러분은 **FastAPI**에서 <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API" class="external-link" target="_blank">WebSockets</a>를 사용할 수 있습니다. |
|||
|
|||
## `WebSockets` 설치 |
|||
|
|||
[가상 환경](../virtual-environments.md){.internal-link target=_blank)를 생성하고 활성화한 다음, `websockets`를 설치하세요: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ pip install websockets |
|||
|
|||
---> 100% |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
## WebSockets 클라이언트 |
|||
|
|||
### 프로덕션 환경에서 |
|||
|
|||
여러분의 프로덕션 시스템에서는 React, Vue.js 또는 Angular와 같은 최신 프레임워크로 생성된 프런트엔드를 사용하고 있을 가능성이 높습니다. |
|||
|
|||
백엔드와 WebSockets을 사용해 통신하려면 아마도 프런트엔드의 유틸리티를 사용할 것입니다. |
|||
|
|||
또는 네이티브 코드로 WebSocket 백엔드와 직접 통신하는 네이티브 모바일 응용 프로그램을 가질 수도 있습니다. |
|||
|
|||
혹은 WebSocket 엔드포인트와 통신할 수 있는 다른 방법이 있을 수도 있습니다. |
|||
|
|||
--- |
|||
|
|||
하지만 이번 예제에서는 일부 자바스크립트를 포함한 간단한 HTML 문서를 사용하겠습니다. 모든 것을 긴 문자열 안에 넣습니다. |
|||
|
|||
물론, 이는 최적의 방법이 아니며 프로덕션 환경에서는 사용하지 않을 것입니다. |
|||
|
|||
프로덕션 환경에서는 위에서 설명한 옵션 중 하나를 사용하는 것이 좋습니다. |
|||
|
|||
그러나 이는 WebSockets의 서버 측에 집중하고 동작하는 예제를 제공하는 가장 간단한 방법입니다: |
|||
|
|||
{* ../../docs_src/websockets/tutorial001.py hl[2,6:38,41:43] *} |
|||
|
|||
## `websocket` 생성하기 |
|||
|
|||
**FastAPI** 응용 프로그램에서 `websocket`을 생성합니다: |
|||
|
|||
{* ../../docs_src/websockets/tutorial001.py hl[1,46:47] *} |
|||
|
|||
/// note | 기술적 세부사항 |
|||
|
|||
`from starlette.websockets import WebSocket`을 사용할 수도 있습니다. |
|||
|
|||
**FastAPI**는 개발자를 위한 편의를 위해 동일한 `WebSocket`을 직접 제공합니다. 하지만 이는 Starlette에서 가져옵니다. |
|||
|
|||
/// |
|||
|
|||
## 메시지를 대기하고 전송하기 |
|||
|
|||
WebSocket 경로에서 메시지를 대기(`await`)하고 전송할 수 있습니다. |
|||
|
|||
{* ../../docs_src/websockets/tutorial001.py hl[48:52] *} |
|||
|
|||
여러분은 이진 데이터, 텍스트, JSON 데이터를 받을 수 있고 전송할 수 있습니다. |
|||
|
|||
## 시도해보기 |
|||
|
|||
파일 이름이 `main.py`라고 가정하고 응용 프로그램을 실행합니다: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ fastapi dev main.py |
|||
|
|||
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
브라우저에서 <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000</a>을 열어보세요. |
|||
|
|||
간단한 페이지가 나타날 것입니다: |
|||
|
|||
<img src="/img/tutorial/websockets/image01.png"> |
|||
|
|||
입력창에 메시지를 입력하고 전송할 수 있습니다: |
|||
|
|||
<img src="/img/tutorial/websockets/image02.png"> |
|||
|
|||
**FastAPI** WebSocket 응용 프로그램이 응답을 돌려줄 것입니다: |
|||
|
|||
<img src="/img/tutorial/websockets/image03.png"> |
|||
|
|||
여러 메시지를 전송(그리고 수신)할 수 있습니다: |
|||
|
|||
<img src="/img/tutorial/websockets/image04.png"> |
|||
|
|||
모든 메시지는 동일한 WebSocket 연결을 사용합니다. |
|||
|
|||
## `Depends` 및 기타 사용하기 |
|||
|
|||
WebSocket 엔드포인트에서 `fastapi`에서 다음을 가져와 사용할 수 있습니다: |
|||
|
|||
* `Depends` |
|||
* `Security` |
|||
* `Cookie` |
|||
* `Header` |
|||
* `Path` |
|||
* `Query` |
|||
|
|||
이들은 다른 FastAPI 엔드포인트/*경로 작동*과 동일하게 동작합니다: |
|||
|
|||
{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *} |
|||
|
|||
/// info | 정보 |
|||
|
|||
WebSocket에서는 `HTTPException`을 발생시키는 것이 적합하지 않습니다. 대신 `WebSocketException`을 발생시킵니다. |
|||
|
|||
명세서에 정의된 <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1" class="external-link" target="_blank">유효한 코드</a>를 사용하여 종료 코드를 설정할 수 있습니다. |
|||
|
|||
/// |
|||
|
|||
### 종속성을 가진 WebSockets 테스트 |
|||
|
|||
파일 이름이 `main.py`라고 가정하고 응용 프로그램을 실행합니다: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ fastapi dev main.py |
|||
|
|||
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
브라우저에서 <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000</a>을 열어보세요. |
|||
|
|||
다음과 같은 값을 설정할 수 있습니다: |
|||
|
|||
* 경로에 사용된 "Item ID". |
|||
* 쿼리 매개변수로 사용된 "Token". |
|||
|
|||
/// tip | 팁 |
|||
|
|||
쿼리 `token`은 종속성에 의해 처리됩니다. |
|||
|
|||
/// |
|||
|
|||
이제 WebSocket에 연결하고 메시지를 전송 및 수신할 수 있습니다: |
|||
|
|||
<img src="/img/tutorial/websockets/image05.png"> |
|||
|
|||
## 연결 해제 및 다중 클라이언트 처리 |
|||
|
|||
WebSocket 연결이 닫히면, `await websocket.receive_text()`가 `WebSocketDisconnect` 예외를 발생시킵니다. 이를 잡아 처리할 수 있습니다: |
|||
|
|||
{* ../../docs_src/websockets/tutorial003_py39.py hl[79:81] *} |
|||
|
|||
테스트해보기: |
|||
|
|||
* 여러 브라우저 탭에서 앱을 엽니다. |
|||
* 각 탭에서 메시지를 작성합니다. |
|||
* 한 탭을 닫아보세요. |
|||
|
|||
`WebSocketDisconnect` 예외가 발생하며, 다른 모든 클라이언트가 다음과 같은 메시지를 수신합니다: |
|||
|
|||
``` |
|||
Client #1596980209979 left the chat |
|||
``` |
|||
|
|||
/// tip | 팁 |
|||
|
|||
위 응용 프로그램은 여러 WebSocket 연결에 메시지를 브로드캐스트하는 방법을 보여주는 간단한 예제입니다. |
|||
|
|||
그러나 모든 것을 메모리의 단일 리스트로 처리하므로, 프로세스가 실행 중인 동안만 동작하며 단일 프로세스에서만 작동합니다. |
|||
|
|||
FastAPI와 쉽게 통합할 수 있으면서 더 견고하고 Redis, PostgreSQL 등을 지원하는 도구를 찾고 있다면, <a href="https://github.com/encode/broadcaster" class="external-link" target="_blank">encode/broadcaster</a>를 확인하세요. |
|||
|
|||
/// |
|||
|
|||
## 추가 정보 |
|||
|
|||
다음 옵션에 대한 자세한 내용을 보려면 Starlette의 문서를 확인하세요: |
|||
|
|||
* <a href="https://www.starlette.io/websockets/" class="external-link" target="_blank">`WebSocket` 클래스</a>. |
|||
* <a href="https://www.starlette.io/endpoints/#websocketendpoint" class="external-link" target="_blank">클래스 기반 WebSocket 처리</a>. |
|||
@ -0,0 +1,55 @@ |
|||
# OpenAPI 웹훅(Webhooks) |
|||
|
|||
API **사용자**에게 특정 **이벤트**가 발생할 때 *그들*의 앱(시스템)에 요청을 보내 **알림**을 전달할 수 있다는 것을 알리고 싶은 경우가 있습니다. |
|||
|
|||
즉, 일반적으로 사용자가 API에 요청을 보내는 것과는 반대로, **API**(또는 앱)가 **사용자의 시스템**(그들의 API나 앱)으로 **요청을 보내는** 상황을 의미합니다. |
|||
|
|||
이를 흔히 **웹훅(Webhook)**이라고 부릅니다. |
|||
|
|||
## 웹훅 스텝 |
|||
|
|||
**코드에서** 웹훅으로 보낼 메시지, 즉 요청의 **바디(body)**를 정의하는 것이 일반적인 프로세스입니다. |
|||
|
|||
앱에서 해당 요청이나 이벤트를 전송할 **시점**을 정의합니다. |
|||
|
|||
**사용자**는 앱이 해당 요청을 보낼 **URL**을 정의합니다. (예: 웹 대시보드에서 설정) |
|||
|
|||
웹훅의 URL을 등록하는 방법과 이러한 요청을 실제로 전송하는 코드에 대한 모든 로직은 여러분에게 달려 있습니다. 원하는대로 **고유의 코드**를 작성하면 됩니다. |
|||
|
|||
## **FastAPI**와 OpenAPI로 웹훅 문서화하기 |
|||
|
|||
**FastAPI**를 사용하여 OpenAPI와 함께 웹훅의 이름, 앱이 보낼 수 있는 HTTP 작업 유형(예: `POST`, `PUT` 등), 그리고 보낼 요청의 **바디**를 정의할 수 있습니다. |
|||
|
|||
이를 통해 사용자가 **웹훅** 요청을 수신할 **API 구현**을 훨씬 쉽게 할 수 있으며, 경우에 따라 사용자 API 코드의 일부를 자동 생성할 수도 있습니다. |
|||
|
|||
/// info |
|||
|
|||
웹훅은 OpenAPI 3.1.0 이상에서 지원되며, FastAPI `0.99.0` 이상 버전에서 사용할 수 있습니다. |
|||
|
|||
/// |
|||
|
|||
## 웹훅이 포함된 앱 만들기 |
|||
|
|||
**FastAPI** 애플리케이션을 만들 때, `webhooks` 속성을 사용하여 *웹훅*을 정의할 수 있습니다. 이는 `@app.webhooks.post()`와 같은 방식으로 *경로(path) 작업*을 정의하는 것과 비슷합니다. |
|||
|
|||
{* ../../docs_src/openapi_webhooks/tutorial001.py hl[9:13,36:53] *} |
|||
|
|||
이렇게 정의한 웹훅은 **OpenAPI** 스키마와 자동 **문서화 UI**에 표시됩니다. |
|||
|
|||
/// info |
|||
|
|||
`app.webhooks` 객체는 사실 `APIRouter`일 뿐이며, 여러 파일로 앱을 구성할 때 사용하는 것과 동일한 타입입니다. |
|||
|
|||
/// |
|||
|
|||
웹훅에서는 실제 **경로(path)** (예: `/items/`)를 선언하지 않는 점에 유의해야 합니다. 여기서 전달하는 텍스트는 **식별자**로, 웹훅의 이름(이벤트 이름)입니다. 예를 들어, `@app.webhooks.post("new-subscription")`에서 웹훅 이름은 `new-subscription`입니다. |
|||
|
|||
이는 실제 **URL 경로**는 **사용자**가 다른 방법(예: 웹 대시보드)을 통해 지정하도록 기대되기 때문입니다. |
|||
|
|||
### 문서 확인하기 |
|||
|
|||
이제 앱을 시작하고 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>로 이동해 봅시다. |
|||
|
|||
문서에서 기존 *경로 작업*뿐만 아니라 **웹훅**도 표시된 것을 확인할 수 있습니다: |
|||
|
|||
<img src="/img/tutorial/openapi-webhooks/image01.png"> |
|||
@ -0,0 +1,357 @@ |
|||
# Modelo de resposta - Tipo de retorno |
|||
|
|||
Você pode declarar o tipo usado para a resposta anotando o **tipo de retorno** *da função de operação de rota*. |
|||
|
|||
Você pode usar **anotações de tipo** da mesma forma que usaria para dados de entrada em **parâmetros** de função, você pode usar modelos Pydantic, listas, dicionários, valores escalares como inteiros, booleanos, etc. |
|||
|
|||
{* ../../docs_src/response_model/tutorial001_01_py310.py hl[16,21] *} |
|||
|
|||
O FastAPI usará este tipo de retorno para: |
|||
|
|||
* **Validar** os dados retornados. |
|||
* Se os dados forem inválidos (por exemplo, se estiver faltando um campo), significa que o código do *seu* aplicativo está quebrado, não retornando o que deveria, e retornará um erro de servidor em vez de retornar dados incorretos. Dessa forma, você e seus clientes podem ter certeza de que receberão os dados e o formato de dados esperados. |
|||
* Adicionar um **Esquema JSON** para a resposta, na *operação de rota* do OpenAPI. |
|||
* Isso será usado pela **documentação automática**. |
|||
* Também será usado por ferramentas de geração automática de código do cliente. |
|||
|
|||
Mas o mais importante: |
|||
|
|||
* Ele **limitará e filtrará** os dados de saída para o que está definido no tipo de retorno. |
|||
* Isso é particularmente importante para a **segurança**, veremos mais sobre isso abaixo. |
|||
|
|||
## Parâmetro `response_model` |
|||
|
|||
Existem alguns casos em que você precisa ou deseja retornar alguns dados que não são exatamente o que o tipo declara. |
|||
|
|||
Por exemplo, você pode querer **retornar um dicionário** ou um objeto de banco de dados, mas **declará-lo como um modelo Pydantic**. Dessa forma, o modelo Pydantic faria toda a documentação de dados, validação, etc. para o objeto que você retornou (por exemplo, um dicionário ou objeto de banco de dados). |
|||
|
|||
Se você adicionasse a anotação do tipo de retorno, ferramentas e editores reclamariam com um erro (correto) informando que sua função está retornando um tipo (por exemplo, um dict) diferente do que você declarou (por exemplo, um modelo Pydantic). |
|||
|
|||
Nesses casos, você pode usar o parâmetro `response_model` do *decorador de operação de rota* em vez do tipo de retorno. |
|||
|
|||
Você pode usar o parâmetro `response_model` em qualquer uma das *operações de rota*: |
|||
|
|||
* `@app.get()` |
|||
* `@app.post()` |
|||
* `@app.put()` |
|||
* `@app.delete()` |
|||
* etc. |
|||
|
|||
{* ../../docs_src/response_model/tutorial001_py310.py hl[17,22,24:27] *} |
|||
|
|||
/// note | Nota |
|||
|
|||
Observe que `response_model` é um parâmetro do método "decorator" (`get`, `post`, etc). Não da sua *função de operação de rota*, como todos os parâmetros e corpo. |
|||
|
|||
/// |
|||
|
|||
`response_model` recebe o mesmo tipo que você declararia para um campo de modelo Pydantic, então, pode ser um modelo Pydantic, mas também pode ser, por exemplo, uma `lista` de modelos Pydantic, como `List[Item]`. |
|||
|
|||
O FastAPI usará este `response_model` para fazer toda a documentação de dados, validação, etc. e também para **converter e filtrar os dados de saída** para sua declaração de tipo. |
|||
|
|||
/// tip | Dica |
|||
|
|||
Se você tiver verificações de tipo rigorosas em seu editor, mypy, etc, você pode declarar o tipo de retorno da função como `Any`. |
|||
|
|||
Dessa forma, você diz ao editor que está retornando qualquer coisa intencionalmente. Mas o FastAPI ainda fará a documentação de dados, validação, filtragem, etc. com o `response_model`. |
|||
|
|||
/// |
|||
|
|||
### Prioridade `response_model` |
|||
|
|||
Se você declarar tanto um tipo de retorno quanto um `response_model`, o `response_model` terá prioridade e será usado pelo FastAPI. |
|||
|
|||
Dessa forma, você pode adicionar anotações de tipo corretas às suas funções, mesmo quando estiver retornando um tipo diferente do modelo de resposta, para ser usado pelo editor e ferramentas como mypy. E ainda assim você pode fazer com que o FastAPI faça a validação de dados, documentação, etc. usando o `response_model`. |
|||
|
|||
Você também pode usar `response_model=None` para desabilitar a criação de um modelo de resposta para essa *operação de rota*, você pode precisar fazer isso se estiver adicionando anotações de tipo para coisas que não são campos Pydantic válidos, você verá um exemplo disso em uma das seções abaixo. |
|||
|
|||
## Retorna os mesmos dados de entrada |
|||
|
|||
Aqui estamos declarando um modelo `UserIn`, ele conterá uma senha em texto simples: |
|||
|
|||
{* ../../docs_src/response_model/tutorial002_py310.py hl[7,9] *} |
|||
|
|||
/// info | Informação |
|||
|
|||
Para usar `EmailStr`, primeiro instale <a href="https://github.com/JoshData/python-email-validator" class="external-link" target="_blank">`email-validator`</a>. |
|||
|
|||
Certifique-se de criar um [ambiente virtual](../virtual-environments.md){.internal-link target=_blank}, ative-o e instale-o, por exemplo: |
|||
|
|||
```console |
|||
$ pip install email-validator |
|||
``` |
|||
|
|||
ou com: |
|||
|
|||
```console |
|||
$ pip install "pydantic[email]" |
|||
``` |
|||
|
|||
/// |
|||
|
|||
E estamos usando este modelo para declarar nossa entrada e o mesmo modelo para declarar nossa saída: |
|||
|
|||
{* ../../docs_src/response_model/tutorial002_py310.py hl[16] *} |
|||
|
|||
Agora, sempre que um navegador estiver criando um usuário com uma senha, a API retornará a mesma senha na resposta. |
|||
|
|||
Neste caso, pode não ser um problema, porque é o mesmo usuário enviando a senha. |
|||
|
|||
Mas se usarmos o mesmo modelo para outra *operação de rota*, poderíamos estar enviando as senhas dos nossos usuários para todos os clientes. |
|||
|
|||
/// danger | Perigo |
|||
|
|||
Nunca armazene a senha simples de um usuário ou envie-a em uma resposta como esta, a menos que você saiba todas as ressalvas e saiba o que está fazendo. |
|||
|
|||
/// |
|||
|
|||
## Adicionar um modelo de saída |
|||
|
|||
Podemos, em vez disso, criar um modelo de entrada com a senha em texto simples e um modelo de saída sem ela: |
|||
|
|||
{* ../../docs_src/response_model/tutorial003_py310.py hl[9,11,16] *} |
|||
|
|||
Aqui, embora nossa *função de operação de rota* esteja retornando o mesmo usuário de entrada que contém a senha: |
|||
|
|||
{* ../../docs_src/response_model/tutorial003_py310.py hl[24] *} |
|||
|
|||
...declaramos o `response_model` como nosso modelo `UserOut`, que não inclui a senha: |
|||
|
|||
{* ../../docs_src/response_model/tutorial003_py310.py hl[22] *} |
|||
|
|||
Então, **FastAPI** cuidará de filtrar todos os dados que não são declarados no modelo de saída (usando Pydantic). |
|||
|
|||
### `response_model` ou Tipo de Retorno |
|||
|
|||
Neste caso, como os dois modelos são diferentes, se anotássemos o tipo de retorno da função como `UserOut`, o editor e as ferramentas reclamariam que estamos retornando um tipo inválido, pois são classes diferentes. |
|||
|
|||
É por isso que neste exemplo temos que declará-lo no parâmetro `response_model`. |
|||
|
|||
...mas continue lendo abaixo para ver como superar isso. |
|||
|
|||
## Tipo de Retorno e Filtragem de Dados |
|||
|
|||
Vamos continuar do exemplo anterior. Queríamos **anotar a função com um tipo**, mas queríamos poder retornar da função algo que realmente incluísse **mais dados**. |
|||
|
|||
Queremos que o FastAPI continue **filtrando** os dados usando o modelo de resposta. Para que, embora a função retorne mais dados, a resposta inclua apenas os campos declarados no modelo de resposta. |
|||
|
|||
No exemplo anterior, como as classes eram diferentes, tivemos que usar o parâmetro `response_model`. Mas isso também significa que não temos suporte do editor e das ferramentas verificando o tipo de retorno da função. |
|||
|
|||
Mas na maioria dos casos em que precisamos fazer algo assim, queremos que o modelo apenas **filtre/remova** alguns dados como neste exemplo. |
|||
|
|||
E nesses casos, podemos usar classes e herança para aproveitar as **anotações de tipo** de função para obter melhor suporte no editor e nas ferramentas, e ainda obter a **filtragem de dados** FastAPI. |
|||
|
|||
{* ../../docs_src/response_model/tutorial003_01_py310.py hl[7:10,13:14,18] *} |
|||
|
|||
Com isso, temos suporte de ferramentas, de editores e mypy, pois este código está correto em termos de tipos, mas também obtemos a filtragem de dados do FastAPI. |
|||
|
|||
Como isso funciona? Vamos verificar. 🤓 |
|||
|
|||
### Anotações de tipo e ferramentas |
|||
|
|||
Primeiro, vamos ver como editores, mypy e outras ferramentas veriam isso. |
|||
|
|||
`BaseUser` tem os campos base. Então `UserIn` herda de `BaseUser` e adiciona o campo `password`, então, ele incluirá todos os campos de ambos os modelos. |
|||
|
|||
Anotamos o tipo de retorno da função como `BaseUser`, mas na verdade estamos retornando uma instância `UserIn`. |
|||
|
|||
O editor, mypy e outras ferramentas não reclamarão disso porque, em termos de digitação, `UserIn` é uma subclasse de `BaseUser`, o que significa que é um tipo *válido* quando o que é esperado é qualquer coisa que seja um `BaseUser`. |
|||
|
|||
### Filtragem de dados FastAPI |
|||
|
|||
Agora, para FastAPI, ele verá o tipo de retorno e garantirá que o que você retornar inclua **apenas** os campos que são declarados no tipo. |
|||
|
|||
O FastAPI faz várias coisas internamente com o Pydantic para garantir que essas mesmas regras de herança de classe não sejam usadas para a filtragem de dados retornados, caso contrário, você pode acabar retornando muito mais dados do que o esperado. |
|||
|
|||
Dessa forma, você pode obter o melhor dos dois mundos: anotações de tipo com **suporte a ferramentas** e **filtragem de dados**. |
|||
|
|||
## Veja na documentação |
|||
|
|||
Quando você vê a documentação automática, pode verificar se o modelo de entrada e o modelo de saída terão seus próprios esquemas JSON: |
|||
|
|||
<img src="/img/tutorial/response-model/image01.png"> |
|||
|
|||
E ambos os modelos serão usados para a documentação interativa da API: |
|||
|
|||
<img src="/img/tutorial/response-model/image02.png"> |
|||
|
|||
## Outras anotações de tipo de retorno |
|||
|
|||
Pode haver casos em que você retorna algo que não é um campo Pydantic válido e anota na função, apenas para obter o suporte fornecido pelas ferramentas (o editor, mypy, etc). |
|||
|
|||
### Retornar uma resposta diretamente |
|||
|
|||
O caso mais comum seria [retornar uma resposta diretamente, conforme explicado posteriormente na documentação avançada](../advanced/response-directly.md){.internal-link target=_blank}. |
|||
|
|||
{* ../../docs_src/response_model/tutorial003_02.py hl[8,10:11] *} |
|||
|
|||
Este caso simples é tratado automaticamente pelo FastAPI porque a anotação do tipo de retorno é a classe (ou uma subclasse de) `Response`. |
|||
|
|||
E as ferramentas também ficarão felizes porque `RedirectResponse` e `JSONResponse` são subclasses de `Response`, então a anotação de tipo está correta. |
|||
|
|||
### Anotar uma subclasse de resposta |
|||
|
|||
Você também pode usar uma subclasse de `Response` na anotação de tipo: |
|||
|
|||
{* ../../docs_src/response_model/tutorial003_03.py hl[8:9] *} |
|||
|
|||
Isso também funcionará porque `RedirectResponse` é uma subclasse de `Response`, e o FastAPI tratará automaticamente este caso simples. |
|||
|
|||
### Anotações de Tipo de Retorno Inválido |
|||
|
|||
Mas quando você retorna algum outro objeto arbitrário que não é um tipo Pydantic válido (por exemplo, um objeto de banco de dados) e você o anota dessa forma na função, o FastAPI tentará criar um modelo de resposta Pydantic a partir dessa anotação de tipo e falhará. |
|||
|
|||
O mesmo aconteceria se você tivesse algo como uma <abbr title='Uma união entre vários tipos significa "qualquer um desses tipos".'>união</abbr> entre tipos diferentes onde um ou mais deles não são tipos Pydantic válidos, por exemplo, isso falharia 💥: |
|||
|
|||
{* ../../docs_src/response_model/tutorial003_04_py310.py hl[8] *} |
|||
|
|||
... isso falha porque a anotação de tipo não é um tipo Pydantic e não é apenas uma única classe ou subclasse `Response`, é uma união (qualquer uma das duas) entre um `Response` e um `dict`. |
|||
|
|||
### Desabilitar modelo de resposta |
|||
|
|||
Continuando com o exemplo acima, você pode não querer ter a validação de dados padrão, documentação, filtragem, etc. que é realizada pelo FastAPI. |
|||
|
|||
Mas você pode querer manter a anotação do tipo de retorno na função para obter o suporte de ferramentas como editores e verificadores de tipo (por exemplo, mypy). |
|||
|
|||
Neste caso, você pode desabilitar a geração do modelo de resposta definindo `response_model=None`: |
|||
|
|||
{* ../../docs_src/response_model/tutorial003_05_py310.py hl[7] *} |
|||
|
|||
Isso fará com que o FastAPI pule a geração do modelo de resposta e, dessa forma, você pode ter quaisquer anotações de tipo de retorno que precisar sem afetar seu aplicativo FastAPI. 🤓 |
|||
|
|||
## Parâmetros de codificação do modelo de resposta |
|||
|
|||
Seu modelo de resposta pode ter valores padrão, como: |
|||
|
|||
{* ../../docs_src/response_model/tutorial004_py310.py hl[9,11:12] *} |
|||
|
|||
* `description: Union[str, None] = None` (ou `str | None = None` no Python 3.10) tem um padrão de `None`. |
|||
* `tax: float = 10.5` tem um padrão de `10.5`. |
|||
* `tags: List[str] = []` tem um padrão de uma lista vazia: `[]`. |
|||
|
|||
mas você pode querer omiti-los do resultado se eles não foram realmente armazenados. |
|||
|
|||
Por exemplo, se você tem modelos com muitos atributos opcionais em um banco de dados NoSQL, mas não quer enviar respostas JSON muito longas cheias de valores padrão. |
|||
|
|||
### Usar o parâmetro `response_model_exclude_unset` |
|||
|
|||
Você pode definir o parâmetro `response_model_exclude_unset=True` do *decorador de operação de rota* : |
|||
|
|||
{* ../../docs_src/response_model/tutorial004_py310.py hl[22] *} |
|||
|
|||
e esses valores padrão não serão incluídos na resposta, apenas os valores realmente definidos. |
|||
|
|||
Então, se você enviar uma solicitação para essa *operação de rota* para o item com ID `foo`, a resposta (sem incluir valores padrão) será: |
|||
|
|||
```JSON |
|||
{ |
|||
"name": "Foo", |
|||
"price": 50.2 |
|||
} |
|||
``` |
|||
|
|||
/// info | Informação |
|||
|
|||
No Pydantic v1, o método era chamado `.dict()`, ele foi descontinuado (mas ainda suportado) no Pydantic v2 e renomeado para `.model_dump()`. |
|||
|
|||
Os exemplos aqui usam `.dict()` para compatibilidade com Pydantic v1, mas você deve usar `.model_dump()` em vez disso se puder usar Pydantic v2. |
|||
|
|||
/// |
|||
|
|||
/// info | Informação |
|||
|
|||
O FastAPI usa `.dict()` do modelo Pydantic com <a href="https://docs.pydantic.dev/1.10/usage/exporting_models/#modeldict" class="external-link" target="_blank">seu parâmetro `exclude_unset`</a> para chegar a isso. |
|||
|
|||
/// |
|||
|
|||
/// info | Informação |
|||
|
|||
Você também pode usar: |
|||
|
|||
* `response_model_exclude_defaults=True` |
|||
* `response_model_exclude_none=True` |
|||
|
|||
conforme descrito na <a href="https://docs.pydantic.dev/1.10/usage/exporting_models/#modeldict" class="external-link" target="_blank">documentação do Pydantic</a> para `exclude_defaults` e `exclude_none`. |
|||
|
|||
/// |
|||
|
|||
#### Dados com valores para campos com padrões |
|||
|
|||
Mas se seus dados tiverem valores para os campos do modelo com valores padrões, como o item com ID `bar`: |
|||
|
|||
```Python hl_lines="3 5" |
|||
{ |
|||
"name": "Bar", |
|||
"description": "The bartenders", |
|||
"price": 62, |
|||
"tax": 20.2 |
|||
} |
|||
``` |
|||
|
|||
eles serão incluídos na resposta. |
|||
|
|||
#### Dados com os mesmos valores que os padrões |
|||
|
|||
Se os dados tiverem os mesmos valores que os padrões, como o item com ID `baz`: |
|||
|
|||
```Python hl_lines="3 5-6" |
|||
{ |
|||
"name": "Baz", |
|||
"description": None, |
|||
"price": 50.2, |
|||
"tax": 10.5, |
|||
"tags": [] |
|||
} |
|||
``` |
|||
|
|||
O FastAPI é inteligente o suficiente (na verdade, o Pydantic é inteligente o suficiente) para perceber que, embora `description`, `tax` e `tags` tenham os mesmos valores que os padrões, eles foram definidos explicitamente (em vez de retirados dos padrões). |
|||
|
|||
Portanto, eles serão incluídos na resposta JSON. |
|||
|
|||
/// tip | Dica |
|||
|
|||
Observe que os valores padrão podem ser qualquer coisa, não apenas `None`. |
|||
|
|||
Eles podem ser uma lista (`[]`), um `float` de `10.5`, etc. |
|||
|
|||
/// |
|||
|
|||
### `response_model_include` e `response_model_exclude` |
|||
|
|||
Você também pode usar os parâmetros `response_model_include` e `response_model_exclude` do *decorador de operação de rota*. |
|||
|
|||
Eles pegam um `set` de `str` com o nome dos atributos para incluir (omitindo o resto) ou para excluir (incluindo o resto). |
|||
|
|||
Isso pode ser usado como um atalho rápido se você tiver apenas um modelo Pydantic e quiser remover alguns dados da saída. |
|||
|
|||
/// tip | Dica |
|||
|
|||
Mas ainda é recomendado usar as ideias acima, usando várias classes, em vez desses parâmetros. |
|||
|
|||
Isso ocorre porque o Schema JSON gerado no OpenAPI do seu aplicativo (e a documentação) ainda será o único para o modelo completo, mesmo que você use `response_model_include` ou `response_model_exclude` para omitir alguns atributos. |
|||
|
|||
Isso também se aplica ao `response_model_by_alias` que funciona de forma semelhante. |
|||
|
|||
/// |
|||
|
|||
{* ../../docs_src/response_model/tutorial005_py310.py hl[29,35] *} |
|||
|
|||
/// tip | Dica |
|||
|
|||
A sintaxe `{"nome", "descrição"}` cria um `conjunto` com esses dois valores. |
|||
|
|||
É equivalente a `set(["nome", "descrição"])`. |
|||
|
|||
/// |
|||
|
|||
#### Usando `list`s em vez de `set`s |
|||
|
|||
Se você esquecer de usar um `set` e usar uma `lista` ou `tupla` em vez disso, o FastAPI ainda o converterá em um `set` e funcionará corretamente: |
|||
|
|||
{* ../../docs_src/response_model/tutorial006_py310.py hl[29,35] *} |
|||
|
|||
## Recapitulação |
|||
|
|||
Use o parâmetro `response_model` do *decorador de operação de rota* para definir modelos de resposta e, especialmente, para garantir que dados privados sejam filtrados. |
|||
|
|||
Use `response_model_exclude_unset` para retornar apenas os valores definidos explicitamente. |
|||
@ -0,0 +1,196 @@ |
|||
# Модели Query-Параметров |
|||
|
|||
Если у вас есть группа связанных **query-параметров**, то вы можете объединить их в одну **Pydantic-модель**. |
|||
|
|||
Это позволит вам **переиспользовать модель** в **разных местах**, устанавливать валидаторы и метаданные, в том числе для сразу всех параметров, в одном месте. 😎 |
|||
|
|||
/// note | Заметка |
|||
|
|||
Этот функционал доступен с версии `0.115.0`. 🤓 |
|||
|
|||
/// |
|||
|
|||
## Pydantic-Модель для Query-Параметров |
|||
|
|||
Объявите нужные **query-параметры** в **Pydantic-модели**, а после аннотируйте параметр как `Query`: |
|||
|
|||
//// tab | Python 3.10+ |
|||
|
|||
```Python hl_lines="9-13 17" |
|||
{!> ../../docs_src/query_param_models/tutorial001_an_py310.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.9+ |
|||
|
|||
```Python hl_lines="8-12 16" |
|||
{!> ../../docs_src/query_param_models/tutorial001_an_py39.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.8+ |
|||
|
|||
```Python hl_lines="10-14 18" |
|||
{!> ../../docs_src/query_param_models/tutorial001_an.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.10+ без Annotated |
|||
|
|||
/// tip | Совет |
|||
|
|||
При возможности используйте версию с `Annotated`. |
|||
|
|||
/// |
|||
|
|||
```Python hl_lines="9-13 17" |
|||
{!> ../../docs_src/query_param_models/tutorial001_py310.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.9+ без Annotated |
|||
|
|||
/// tip | Совет |
|||
|
|||
При возможности используйте версию с `Annotated`. |
|||
|
|||
/// |
|||
|
|||
```Python hl_lines="8-12 16" |
|||
{!> ../../docs_src/query_param_models/tutorial001_py39.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.8+ без Annotated |
|||
|
|||
/// tip | Совет |
|||
|
|||
При возможности используйте версию с `Annotated`. |
|||
|
|||
/// |
|||
|
|||
```Python hl_lines="9-13 17" |
|||
{!> ../../docs_src/query_param_models/tutorial001_py310.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
**FastAPI извлечёт** данные соответствующие **каждому полю модели** из **query-параметров** запроса и выдаст вам объявленную Pydantic-модель заполненную ими. |
|||
|
|||
## Проверьте Сгенерированную Документацию |
|||
|
|||
Вы можете посмотреть query-параметры в графическом интерфейсе сгенерированной документации по пути `/docs`: |
|||
|
|||
<div class="screenshot"> |
|||
<img src="/img/tutorial/query-param-models/image01.png"> |
|||
</div> |
|||
|
|||
## Запретить Дополнительные Query-Параметры |
|||
|
|||
В некоторых случаях (не особо часто встречающихся) вам может понадобиться **ограничить** query-параметры, которые вы хотите получить. |
|||
|
|||
Вы можете сконфигурировать Pydantic-модель так, чтобы запретить (`forbid`) все дополнительные (`extra`) поля. |
|||
|
|||
//// tab | Python 3.10+ |
|||
|
|||
```Python hl_lines="10" |
|||
{!> ../../docs_src/query_param_models/tutorial002_an_py310.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.9+ |
|||
|
|||
```Python hl_lines="9" |
|||
{!> ../../docs_src/query_param_models/tutorial002_an_py39.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.8+ |
|||
|
|||
```Python hl_lines="11" |
|||
{!> ../../docs_src/query_param_models/tutorial002_an.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.10+ без Annotated |
|||
|
|||
/// tip | Совет |
|||
|
|||
При возможности используйте версию с `Annotated`. |
|||
|
|||
/// |
|||
|
|||
```Python hl_lines="10" |
|||
{!> ../../docs_src/query_param_models/tutorial002_py310.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.9+ без Annotated |
|||
|
|||
/// tip | Совет |
|||
|
|||
При возможности используйте версию с `Annotated`. |
|||
|
|||
/// |
|||
|
|||
```Python hl_lines="9" |
|||
{!> ../../docs_src/query_param_models/tutorial002_py39.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
//// tab | Python 3.8+ без Annotated |
|||
|
|||
/// tip | Совет |
|||
|
|||
При возможности используйте версию с `Annotated`. |
|||
|
|||
/// |
|||
|
|||
```Python hl_lines="11" |
|||
{!> ../../docs_src/query_param_models/tutorial002.py!} |
|||
``` |
|||
|
|||
//// |
|||
|
|||
Если клиент попробует отправить **дополнительные** данные в **query-параметрах**, то в ответ он получит **ошибку**. |
|||
|
|||
Например, если клиент попытается отправить query-параметр `tool` с значением `plumbus`, в виде: |
|||
|
|||
```http |
|||
https://example.com/items/?limit=10&tool=plumbus |
|||
``` |
|||
|
|||
То в ответ он получит **ошибку**, сообщающую ему, что query-параметр `tool` не разрешен: |
|||
|
|||
```json |
|||
{ |
|||
"detail": [ |
|||
{ |
|||
"type": "extra_forbidden", |
|||
"loc": ["query", "tool"], |
|||
"msg": "Extra inputs are not permitted", |
|||
"input": "plumbus" |
|||
} |
|||
] |
|||
} |
|||
``` |
|||
|
|||
## Заключение |
|||
|
|||
Вы можете использовать **Pydantic-модели** для объявления **query-параметров** в **FastAPI**. 😎 |
|||
|
|||
/// tip | Совет |
|||
|
|||
Спойлер: вы также можете использовать Pydantic-модели для группировки кук (cookies) и заголовков (headers), но об этом вы прочитаете позже. 🤫 |
|||
|
|||
/// |
|||
@ -0,0 +1,442 @@ |
|||
# 並行與 async / await |
|||
|
|||
有關*路徑操作函式*的 `async def` 語法的細節與非同步 (asynchronous) 程式碼、並行 (concurrency) 與平行 (parallelism) 的一些背景知識。 |
|||
|
|||
## 趕時間嗎? |
|||
|
|||
<abbr title="too long; didn't read（文長慎入）"><strong>TL;DR:</strong></abbr> |
|||
|
|||
如果你正在使用要求你以 `await` 語法呼叫的第三方函式庫，例如： |
|||
|
|||
```Python |
|||
results = await some_library() |
|||
``` |
|||
|
|||
然後，使用 `async def` 宣告你的*路徑操作函式*： |
|||
|
|||
|
|||
```Python hl_lines="2" |
|||
@app.get('/') |
|||
async def read_results(): |
|||
results = await some_library() |
|||
return results |
|||
``` |
|||
|
|||
/// note | 注意 |
|||
|
|||
你只能在 `async def` 建立的函式內使用 `await`。 |
|||
|
|||
/// |
|||
|
|||
--- |
|||
|
|||
如果你使用的是第三方函式庫並且它需要與某些外部資源（例如資料庫、API、檔案系統等）進行通訊，但不支援 `await`（目前大多數資料庫函式庫都是這樣），在這種情況下，你可以像平常一樣使用 `def` 宣告*路徑操作函式*，如下所示： |
|||
|
|||
```Python hl_lines="2" |
|||
@app.get('/') |
|||
def results(): |
|||
results = some_library() |
|||
return results |
|||
``` |
|||
|
|||
--- |
|||
|
|||
如果你的應用程式不需要與外部資源進行任何通訊並等待其回應，請使用 `async def`。 |
|||
|
|||
--- |
|||
|
|||
如果你不確定該用哪個，直接用 `def` 就好。 |
|||
|
|||
--- |
|||
|
|||
**注意**：你可以在*路徑操作函式*中混合使用 `def` 和 `async def` ，並使用最適合你需求的方式來定義每個函式。FastAPI 會幫你做正確的處理。 |
|||
|
|||
無論如何，在上述哪種情況下，FastAPI 仍將以非同步方式運行，並且速度非常快。 |
|||
|
|||
但透過遵循上述步驟，它將能進行一些效能最佳化。 |
|||
|
|||
## 技術細節 |
|||
|
|||
現代版本的 Python 支援使用 **「協程」** 的 **`async` 和 `await`** 語法來寫 **「非同步程式碼」**。 |
|||
|
|||
接下來我們逐一介紹： |
|||
|
|||
* **非同步程式碼** |
|||
* **`async` 和 `await`** |
|||
* **協程** |
|||
|
|||
## 非同步程式碼 |
|||
|
|||
非同步程式碼僅意味著程式語言 💬 有辦法告訴電腦/程式 🤖 在程式碼中的某個點，它 🤖 需要等待某些事情完成。讓我們假設這些事情被稱為「慢速檔案」📝。 |
|||
|
|||
因此，在等待「慢速檔案」📝 完成的這段時間，電腦可以去處理一些其他工作。 |
|||
|
|||
接著程式 🤖 會在有空檔時回來查看是否有等待的工作已經完成，並執行必要的後續操作。 |
|||
|
|||
接下來，它 🤖 完成第一個工作（例如我們的「慢速檔案」📝）並繼續執行相關的所有操作。 |
|||
這個「等待其他事情」通常指的是一些相對較慢的（與處理器和 RAM 記憶體的速度相比）的 <abbr title="Input and Output">I/O</abbr> 操作，比如說： |
|||
|
|||
* 透過網路傳送來自用戶端的資料 |
|||
* 從網路接收來自用戶端的資料 |
|||
* 從磁碟讀取檔案內容 |
|||
* 將內容寫入磁碟 |
|||
* 遠端 API 操作 |
|||
* 資料庫操作 |
|||
* 資料庫查詢 |
|||
* 等等 |
|||
|
|||
由於大部分的執行時間都消耗在等待 <abbr title="輸入與輸出">I/O</abbr> 操作上，因此這些操作被稱為 "I/O 密集型" 操作。 |
|||
|
|||
之所以稱為「非同步」，是因為電腦/程式不需要與那些耗時的任務「同步」，等待任務完成的精確時間，然後才能取得結果並繼續工作。 |
|||
|
|||
相反地，非同步系統在任務完成後，可以讓任務稍微等一下（幾微秒），等待電腦/程式完成手頭上的其他工作，然後再回來取得結果繼續進行。 |
|||
|
|||
相對於「非同步」（asynchronous），「同步」（synchronous）也常被稱作「順序性」（sequential），因為電腦/程式會依序執行所有步驟，即便這些步驟涉及等待，才會切換到其他任務。 |
|||
|
|||
### 並行與漢堡 |
|||
|
|||
上述非同步程式碼的概念有時也被稱為「並行」，它不同於「平行」。 |
|||
|
|||
並行和平行都與 "不同的事情或多或少同時發生" 有關。 |
|||
|
|||
但並行和平行之間的細節是完全不同的。 |
|||
|
|||
為了理解差異，請想像以下有關漢堡的故事： |
|||
|
|||
### 並行漢堡 |
|||
|
|||
你和你的戀人去速食店，排隊等候時，收銀員正在幫排在你前面的人點餐。😍 |
|||
|
|||
<img src="/img/async/concurrent-burgers/concurrent-burgers-01.png" class="illustration"> |
|||
|
|||
輪到你了，你給你與你的戀人點了兩個豪華漢堡。🍔🍔 |
|||
|
|||
<img src="/img/async/concurrent-burgers/concurrent-burgers-02.png" class="illustration"> |
|||
|
|||
收銀員通知廚房準備你的漢堡（儘管他們還在為前面其他顧客準備食物）。 |
|||
|
|||
<img src="/img/async/concurrent-burgers/concurrent-burgers-03.png" class="illustration"> |
|||
|
|||
之後你完成付款。💸 |
|||
|
|||
收銀員給你一個號碼牌。 |
|||
|
|||
<img src="/img/async/concurrent-burgers/concurrent-burgers-04.png" class="illustration"> |
|||
|
|||
在等待漢堡的同時，你可以與戀人選一張桌子，然後坐下來聊很長一段時間（因為漢堡十分豪華，準備特別費工。） |
|||
|
|||
這段時間，你還能欣賞你的戀人有多麼的可愛、聰明與迷人。✨😍✨ |
|||
|
|||
<img src="/img/async/concurrent-burgers/concurrent-burgers-05.png" class="illustration"> |
|||
|
|||
當你和戀人邊聊天邊等待時，你會不時地查看櫃檯上的顯示的號碼，確認是否已經輪到你了。 |
|||
|
|||
然後在某個時刻，終於輪到你了。你走到櫃檯，拿了漢堡，然後回到桌子上。 |
|||
|
|||
<img src="/img/async/concurrent-burgers/concurrent-burgers-06.png" class="illustration"> |
|||
|
|||
你和戀人享用這頓大餐，整個過程十分開心✨ |
|||
|
|||
<img src="/img/async/concurrent-burgers/concurrent-burgers-07.png" class="illustration"> |
|||
|
|||
/// info |
|||
|
|||
漂亮的插畫來自 <a href="https://www.instagram.com/ketrinadrawsalot" class="external-link" target="_blank">Ketrina Thompson</a>. 🎨 |
|||
|
|||
/// |
|||
|
|||
--- |
|||
|
|||
想像你是故事中的電腦或程式 🤖。 |
|||
|
|||
當你排隊時，你在放空😴，等待輪到你，沒有做任何「生產性」的事情。但這沒關係，因為收銀員只是接單（而不是準備食物），所以排隊速度很快。 |
|||
|
|||
然後，當輪到你時，你開始做真正「有生產力」的工作，處理菜單，決定你想要什麼，替戀人選擇餐點，付款，確認你給了正確的帳單或信用卡，檢查你是否被正確收費，確認訂單中的項目是否正確等等。 |
|||
|
|||
但是，即使你還沒有拿到漢堡，你與收銀員的工作已經「暫停」了 ⏸，因為你必須等待 🕙 漢堡準備好。 |
|||
|
|||
但當你離開櫃檯，坐到桌子旁，拿著屬於你的號碼等待時，你可以把注意力 🔀 轉移到戀人身上，並開始「工作」⏯ 🤓——也就是和戀人調情 😍。這時你又開始做一些非常「有生產力」的事情。 |
|||
|
|||
接著，收銀員 💁 將你的號碼顯示在櫃檯螢幕上，並告訴你「漢堡已經做好了」。但你不會瘋狂地立刻跳起來，因為顯示的號碼變成了你的。你知道沒有人會搶走你的漢堡，因為你有自己的號碼，他們也有他們的號碼。 |
|||
|
|||
所以你會等戀人講完故事（完成當前的工作 ⏯/正在進行的任務 🤓），然後微笑著溫柔地說你要去拿漢堡了 ⏸。 |
|||
|
|||
然後你走向櫃檯 🔀，回到已經完成的最初任務 ⏯，拿起漢堡，說聲謝謝，並帶回桌上。這就結束了與櫃檯的互動步驟/任務 ⏹，接下來會產生一個新的任務，「吃漢堡」 🔀 ⏯，而先前的「拿漢堡」任務已經完成了 ⏹。 |
|||
|
|||
### 平行漢堡 |
|||
|
|||
現在，讓我們來想像這裡不是「並行漢堡」，而是「平行漢堡」。 |
|||
|
|||
你和戀人一起去吃平行的速食餐。 |
|||
|
|||
你們站在隊伍中，前面有幾位（假設有 8 位）既是收銀員又是廚師的員工，他們同時接單並準備餐點。 |
|||
|
|||
所有排在你前面的人都在等著他們的漢堡準備好後才會離開櫃檯，因為每位收銀員在接完單後，馬上會去準備漢堡，然後才回來處理下一個訂單。 |
|||
|
|||
<img src="/img/async/parallel-burgers/parallel-burgers-01.png" class="illustration"> |
|||
|
|||
終於輪到你了，你為你和你的戀人點了兩個非常豪華的漢堡。 |
|||
|
|||
你付款了 💸。 |
|||
|
|||
<img src="/img/async/parallel-burgers/parallel-burgers-02.png" class="illustration"> |
|||
|
|||
收銀員走進廚房準備食物。 |
|||
|
|||
你站在櫃檯前等待 🕙，以免其他人先拿走你的漢堡，因為這裡沒有號碼牌系統。 |
|||
|
|||
<img src="/img/async/parallel-burgers/parallel-burgers-03.png" class="illustration"> |
|||
|
|||
由於你和戀人都忙著不讓別人搶走你的漢堡，等漢堡準備好時，你根本無法專心和戀人互動。😞 |
|||
|
|||
這是「同步」(synchronous)工作，你和收銀員/廚師 👨🍳 是「同步化」的。你必須等到 🕙 收銀員/廚師 👨🍳 完成漢堡並交給你的那一刻，否則別人可能會拿走你的餐點。 |
|||
|
|||
<img src="/img/async/parallel-burgers/parallel-burgers-04.png" class="illustration"> |
|||
|
|||
最終，經過長時間的等待 🕙，收銀員/廚師 👨🍳 拿著漢堡回來了。 |
|||
|
|||
<img src="/img/async/parallel-burgers/parallel-burgers-05.png" class="illustration"> |
|||
|
|||
你拿著漢堡，和你的戀人回到餐桌。 |
|||
|
|||
你們僅僅是吃完漢堡，然後就結束了。⏹ |
|||
|
|||
<img src="/img/async/parallel-burgers/parallel-burgers-06.png" class="illustration"> |
|||
|
|||
整個過程中沒有太多的談情說愛，因為大部分時間 🕙 都花在櫃檯前等待。😞 |
|||
|
|||
/// info |
|||
|
|||
漂亮的插畫來自 <a href="https://www.instagram.com/ketrinadrawsalot" class="external-link" target="_blank">Ketrina Thompson</a>. 🎨 |
|||
|
|||
/// |
|||
|
|||
--- |
|||
|
|||
在這個平行漢堡的情境下，你是一個程式 🤖 且有兩個處理器（你和戀人），兩者都在等待 🕙 並專注於等待櫃檯上的餐點 🕙，等待的時間非常長。 |
|||
|
|||
這家速食店有 8 個處理器（收銀員/廚師）。而並行漢堡店可能只有 2 個處理器（一位收銀員和一位廚師）。 |
|||
|
|||
儘管如此，最終的體驗並不是最理想的。😞 |
|||
|
|||
--- |
|||
|
|||
這是與漢堡類似的故事。🍔 |
|||
|
|||
一個更「現實」的例子，想像一間銀行。 |
|||
|
|||
直到最近，大多數銀行都有多位出納員 👨💼👨💼👨💼👨💼，以及一條長長的隊伍 🕙🕙🕙🕙🕙🕙🕙🕙。 |
|||
|
|||
所有的出納員都在一個接一個地滿足每位客戶的所有需求 👨💼⏯。 |
|||
|
|||
你必須長時間排隊 🕙，不然就會失去機會。 |
|||
|
|||
所以，你不會想帶你的戀人 😍 一起去銀行辦事 🏦。 |
|||
|
|||
### 漢堡結論 |
|||
|
|||
在「和戀人一起吃速食漢堡」的這個場景中，由於有大量的等待 🕙，使用並行系統 ⏸🔀⏯ 更有意義。 |
|||
|
|||
這也是大多數 Web 應用的情況。 |
|||
|
|||
許多用戶正在使用你的應用程式，而你的伺服器則在等待 🕙 這些用戶不那麼穩定的網路來傳送請求。 |
|||
|
|||
接著，再次等待 🕙 回應。 |
|||
|
|||
這種「等待」 🕙 通常以微秒來衡量，但累加起來，最終還是花費了很多等待時間。 |
|||
|
|||
這就是為什麼對於 Web API 來說，使用非同步程式碼 ⏸🔀⏯ 是非常有意義的。 |
|||
|
|||
這種類型的非同步性正是 NodeJS 成功的原因（儘管 NodeJS 不是平行的），這也是 Go 語言作為程式語言的一個強大優勢。 |
|||
|
|||
這與 **FastAPI** 所能提供的性能水平相同。 |
|||
|
|||
你可以同時利用並行性和平行性，進一步提升效能，這比大多數已測試的 NodeJS 框架都更快，並且與 Go 語言相當，而 Go 是一種更接近 C 的編譯語言（<a href="https://www.techempower.com/benchmarks/#section=data-r17&hw=ph&test=query&l=zijmkf-1" class="external-link" target="_blank">感謝 Starlette</a>）。 |
|||
|
|||
### 並行比平行更好嗎？ |
|||
|
|||
不是的！這不是故事的本意。 |
|||
|
|||
並行與平行不同。並行在某些 **特定** 的需要大量等待的情境下表現更好。正因如此，並行在 Web 應用程式開發中通常比平行更有優勢。但並不是所有情境都如此。 |
|||
|
|||
因此，為了平衡報導，想像下面這個短故事 |
|||
|
|||
> 你需要打掃一間又大又髒的房子。 |
|||
|
|||
*是的，這就是全部的故事。* |
|||
|
|||
--- |
|||
|
|||
這裡沒有任何需要等待 🕙 的地方，只需要在房子的多個地方進行大量的工作。 |
|||
|
|||
你可以像漢堡的例子那樣輪流進行，先打掃客廳，再打掃廚房，但由於你不需要等待 🕙 任何事情，只需要持續地打掃，輪流並不會影響任何結果。 |
|||
|
|||
無論輪流執行與否（並行），你都需要相同的工時完成任務，同時需要執行相同工作量。 |
|||
|
|||
但是，在這種情境下，如果你可以邀請8位前收銀員/廚師（現在是清潔工）來幫忙，每個人（加上你）負責房子的某個區域，這樣你就可以 **平行** 地更快完成工作。 |
|||
|
|||
在這個場景中，每個清潔工（包括你）都是一個處理器，完成工作的一部分。 |
|||
|
|||
由於大多數的執行時間都花在實際的工作上（而不是等待），而電腦中的工作由 <abbr title="Central Processing Unit">CPU</abbr> 完成，因此這些問題被稱為「CPU 密集型」。 |
|||
|
|||
--- |
|||
|
|||
常見的 CPU 密集型操作範例包括那些需要進行複雜數學計算的任務。 |
|||
|
|||
例如： |
|||
|
|||
* **音訊**或**圖像處理**； |
|||
* **電腦視覺**：一張圖片由數百萬個像素組成，每個像素有 3 個值/顏色，處理這些像素通常需要同時進行大量計算； |
|||
* **機器學習**: 通常需要大量的「矩陣」和「向量」運算。想像一個包含數字的巨大電子表格，並所有的數字同時相乘; |
|||
* **深度學習**: 這是機器學習的子領域，同樣適用。只不過這不僅僅是一張數字表格，而是大量的數據集合，並且在很多情況下，你會使用特殊的處理器來構建或使用這些模型。 |
|||
|
|||
### 並行 + 平行: Web + 機器學習 |
|||
|
|||
使用 **FastAPI**，你可以利用並行的優勢，這在 Web 開發中非常常見（這也是 NodeJS 的最大吸引力）。 |
|||
|
|||
但你也可以利用平行與多行程 (multiprocessing)（讓多個行程同時運行） 的優勢來處理機器學習系統中的 **CPU 密集型**工作。 |
|||
|
|||
這一點，再加上 Python 是 **資料科學**、機器學習，尤其是深度學習的主要語言，讓 **FastAPI** 成為資料科學/機器學習 Web API 和應用程式（以及許多其他應用程式）的絕佳選擇。 |
|||
|
|||
想了解如何在生產環境中實現這種平行性，請參見 [部屬](deployment/index.md){.internal-link target=_blank}。 |
|||
|
|||
## `async` 和 `await` |
|||
|
|||
現代 Python 版本提供一種非常直觀的方式定義非同步程式碼。這使得它看起來就像正常的「順序」程式碼，並在適當的時機「等待」。 |
|||
|
|||
當某個操作需要等待才能回傳結果，並且支援這些新的 Python 特性時，你可以像這樣編寫程式碼： |
|||
|
|||
```Python |
|||
burgers = await get_burgers(2) |
|||
``` |
|||
|
|||
這裡的關鍵是 `await`。它告訴 Python 必須等待 ⏸ `get_burgers(2)` 完成它的工作 🕙， 然後將結果儲存在 `burgers` 中。如此，Python 就可以在此期間去處理其他事情 🔀 ⏯ （例如接收另一個請求）。 |
|||
|
|||
要讓 `await` 運作，它必須位於支持非同步功能的函式內。為此，只需使用 `async def` 宣告函式： |
|||
|
|||
```Python hl_lines="1" |
|||
async def get_burgers(number: int): |
|||
# Do some asynchronous stuff to create the burgers |
|||
return burgers |
|||
``` |
|||
|
|||
...而不是 `def`: |
|||
|
|||
```Python hl_lines="2" |
|||
# This is not asynchronous |
|||
def get_sequential_burgers(number: int): |
|||
# Do some sequential stuff to create the burgers |
|||
return burgers |
|||
``` |
|||
|
|||
使用 `async def`，Python Python 知道在該函式內需要注意 `await`，並且它可以「暫停」 ⏸ 執行該函式，然後執行其他任務 🔀 後回來。 |
|||
|
|||
當你想要呼叫 `async def` 函式時，必須使用「await」。因此，這樣寫將無法運行： |
|||
|
|||
```Python |
|||
# This won't work, because get_burgers was defined with: async def |
|||
burgers = get_burgers(2) |
|||
``` |
|||
|
|||
--- |
|||
|
|||
如果你正在使用某個函式庫，它告訴你可以使用 `await` 呼叫它，那麼你需要用 `async def` 定義*路徑操作函式*，如： |
|||
|
|||
```Python hl_lines="2-3" |
|||
@app.get('/burgers') |
|||
async def read_burgers(): |
|||
burgers = await get_burgers(2) |
|||
return burgers |
|||
``` |
|||
|
|||
### 更多技術細節 |
|||
|
|||
你可能已經注意到，`await` 只能在 `async def` 定義的函式內使用。 |
|||
|
|||
但同時，使用 `async def` 定義的函式本身也必須被「等待」。所以，帶有 `async def` 函式只能在其他使用 `async def` 定義的函式內呼叫。 |
|||
|
|||
那麼，這就像「先有雞還是先有蛋」的問題，要如何呼叫第一個 `async` 函式呢？ |
|||
|
|||
如果你使用 FastAPI，無需擔心這個問題，因為「第一個」函式將是你的*路徑操作函式*，FastAPI 會知道如何正確處理這個問題。 |
|||
|
|||
但如果你想在沒有 FastAPI 的情況下使用 `async` / `await`，你也可以這樣做。 |
|||
|
|||
### 編寫自己的非同步程式碼 |
|||
|
|||
Starlette （和 **FastAPI**） 是基於 <a href="https://anyio.readthedocs.io/en/stable/" class="external-link" target="_blank">AnyIO</a> 實作的，這使得它們與 Python 標準函式庫相容 <a href="https://docs.python.org/3/library/asyncio-task.html" class="external-link" target="_blank">asyncio</a> 和 <a href="https://trio.readthedocs.io/en/stable/" class="external-link" target="_blank">Trio</a>。 |
|||
|
|||
特別是，你可以直接使用 <a href="https://anyio.readthedocs.io/en/stable/" class="external-link" target="_blank">AnyIO</a> 來處理更複雜的並行使用案例，這些案例需要你在自己的程式碼中使用更高階的模式。 |
|||
|
|||
即使你不使用 **FastAPI**，你也可以使用 <a href="https://anyio.readthedocs.io/en/stable/" class="external-link" target="_blank">AnyIO</a> 來撰寫自己的非同步應用程式，並獲得高相容性及一些好處（例如結構化並行）。 |
|||
|
|||
### 其他形式的非同步程式碼 |
|||
|
|||
使用 `async` 和 `await` 的風格在語言中相對較新。 |
|||
|
|||
但它使處理異步程式碼變得更加容易。 |
|||
|
|||
相同的語法（或幾乎相同的語法）最近也被包含在現代 JavaScript（無論是瀏覽器還是 NodeJS）中。 |
|||
|
|||
但在此之前，處理異步程式碼要更加複雜和困難。 |
|||
|
|||
在較舊的 Python 版本中，你可能會使用多執行緒或 <a href="https://www.gevent.org/" class="external-link" target="_blank">Gevent</a>。但這些程式碼要更難以理解、調試和思考。 |
|||
|
|||
在較舊的 NodeJS / 瀏覽器 JavaScript 中，你會使用「回呼」，這可能會導致<a href="http://callbackhell.com/" class="external-link" target="_blank">回呼地獄</a>。 |
|||
|
|||
## 協程 |
|||
|
|||
**協程** 只是 `async def` 函式所回傳的非常特殊的事物名稱。Python 知道它是一個類似函式的東西，可以啟動它，並且在某個時刻它會結束，但它也可能在內部暫停 ⏸，只要遇到 `await`。 |
|||
|
|||
這種使用 `async` 和 `await` 的非同步程式碼功能通常被概括為「協程」。這與 Go 語言的主要特性「Goroutines」相似。 |
|||
|
|||
## 結論 |
|||
|
|||
讓我們再次回顧之前的句子： |
|||
|
|||
> 現代版本的 Python 支持使用 **"協程"** 的 **`async` 和 `await`** 語法來寫 **"非同步程式碼"**。 |
|||
|
|||
現在應該能明白其含意了。✨ |
|||
|
|||
這些就是驅動 FastAPI（通過 Starlette）運作的原理，也讓它擁有如此驚人的效能。 |
|||
|
|||
## 非常技術性的細節 |
|||
|
|||
/// warning |
|||
|
|||
你大概可以跳過這段。 |
|||
|
|||
這裡是有關 FastAPI 內部技術細節。 |
|||
|
|||
如果你有相當多的技術背景（例如協程、執行緒、阻塞等），並且對 FastAPI 如何處理 `async def` 與常規 `def` 感到好奇，請繼續閱讀。 |
|||
|
|||
/// |
|||
|
|||
### 路徑操作函数 |
|||
|
|||
當你使用 `def` 而不是 `async def` 宣告*路徑操作函式*時，該函式會在外部的執行緒池（threadpool）中執行，然後等待結果，而不是直接呼叫（因為這樣會阻塞伺服器）。 |
|||
|
|||
如果你來自於其他不以這種方式運作的非同步框架，而且你習慣於使用普通的 `def` 定義僅進行簡單計算的*路徑操作函式*，目的是獲得微小的性能增益（大約 100 奈秒），請注意，在 FastAPI 中，效果會完全相反。在這些情況下，最好使用 `async def`除非你的*路徑操作函式*執行阻塞的 <abbr title="輸入/輸出：磁碟讀寫或網路通訊">I/O</abbr> 的程式碼。 |
|||
|
|||
不過，在這兩種情況下，**FastAPI** [仍然很快](index.md#_11){.internal-link target=_blank}至少與你之前的框架相當（或者更快）。 |
|||
|
|||
### 依賴項(Dependencies) |
|||
|
|||
同樣適用於[依賴項](tutorial/dependencies/index.md){.internal-link target=_blank}。如果依賴項是一個標準的 `def` 函式，而不是 `async def`，那麼它在外部的執行緒池被運行。 |
|||
|
|||
### 子依賴項 |
|||
|
|||
你可以擁有多個相互依賴的依賴項和[子依賴項](tutorial/dependencies/sub-dependencies.md){.internal-link target=_blank} （作為函式定義的參數），其中一些可能是用 `async def` 宣告，也可能是用 `def` 宣告。它們仍然可以正常運作，用 `def` 定義的那些將會在外部的執行緒中呼叫（來自執行緒池），而不是被「等待」。 |
|||
|
|||
### 其他輔助函式 |
|||
|
|||
你可以直接呼叫任何使用 `def` 或 `async def` 建立的其他輔助函式，FastAPI 不會影響你呼叫它們的方式。 |
|||
|
|||
這與 FastAPI 為你呼叫*路徑操作函式*和依賴項的邏輯有所不同。 |
|||
|
|||
如果你的輔助函式是用 `def` 宣告的，它將會被直接呼叫（按照你在程式碼中撰寫的方式），而不是在執行緒池中。如果該函式是用 `async def` 宣告，那麼你在呼叫時應該使用 `await` 等待其結果。 |
|||
|
|||
--- |
|||
|
|||
再一次強調，這些都是非常技術性的細節，如果你特地在尋找這些資訊，這些內容可能會對你有幫助。 |
|||
|
|||
否則，只需遵循上面提到的指引即可：<a href="#_1">趕時間嗎?</a>. |
|||
@ -0,0 +1,68 @@ |
|||
# 查詢參數模型 |
|||
|
|||
如果你有一組具有相關性的**查詢參數**，你可以建立一個 **Pydantic 模型**來聲明它們。 |
|||
|
|||
這將允許你在**多個地方**去**重複使用模型**，並且一次性為所有參數聲明驗證和元資料 (metadata)。😎 |
|||
|
|||
/// note |
|||
|
|||
FastAPI 從 `0.115.0` 版本開始支援這個特性。🤓 |
|||
|
|||
/// |
|||
|
|||
## 使用 Pydantic 模型的查詢參數 |
|||
|
|||
在一個 **Pydantic 模型**中聲明你需要的**查詢參數**，然後將參數聲明為 `Query`： |
|||
|
|||
{* ../../docs_src/query_param_models/tutorial001_an_py310.py hl[9:13,17] *} |
|||
|
|||
**FastAPI** 將會從請求的**查詢參數**中**提取**出**每個欄位**的資料，並將其提供給你定義的 Pydantic 模型。 |
|||
|
|||
## 查看文件 |
|||
|
|||
你可以在 `/docs` 頁面的 UI 中查看查詢參數： |
|||
|
|||
<div class="screenshot"> |
|||
<img src="/img/tutorial/query-param-models/image01.png"> |
|||
</div> |
|||
|
|||
## 禁止額外的查詢參數 |
|||
|
|||
在一些特殊的使用場景中（可能不是很常見），你可能希望**限制**你要收到的查詢參數。 |
|||
|
|||
你可以使用 Pydantic 的模型設定來 `forbid`（禁止）任何 `extra`（額外）欄位： |
|||
|
|||
{* ../../docs_src/query_param_models/tutorial002_an_py310.py hl[10] *} |
|||
|
|||
如果客戶端嘗試在**查詢參數**中發送一些**額外的**資料，他們將會收到一個**錯誤**回應。 |
|||
|
|||
例如，如果客戶端嘗試發送一個值為 `plumbus` 的 `tool` 查詢參數，如： |
|||
|
|||
```http |
|||
https://example.com/items/?limit=10&tool=plumbus |
|||
``` |
|||
|
|||
他們將收到一個**錯誤**回應，告訴他們查詢參數 `tool` 是不允許的： |
|||
|
|||
```json |
|||
{ |
|||
"detail": [ |
|||
{ |
|||
"type": "extra_forbidden", |
|||
"loc": ["query", "tool"], |
|||
"msg": "Extra inputs are not permitted", |
|||
"input": "plumbus" |
|||
} |
|||
] |
|||
} |
|||
``` |
|||
|
|||
## 總結 |
|||
|
|||
你可以使用 **Pydantic 模型**在 **FastAPI** 中聲明**查詢參數**。😎 |
|||
|
|||
/// tip |
|||
|
|||
劇透警告：你也可以使用 Pydantic 模型來聲明 cookie 和 headers，但你將在本教學的後面部分閱讀到這部分內容。🤫 |
|||
|
|||
/// |
|||
@ -0,0 +1,68 @@ |
|||
# 查询参数模型 |
|||
|
|||
如果你有一组具有相关性的**查询参数**，你可以创建一个 **Pydantic 模型**来声明它们。 |
|||
|
|||
这将允许你在**多个地方**去**复用模型**，并且一次性为所有参数声明验证和元数据。😎 |
|||
|
|||
/// note |
|||
|
|||
FastAPI 从 `0.115.0` 版本开始支持这个特性。🤓 |
|||
|
|||
/// |
|||
|
|||
## 使用 Pydantic 模型的查询参数 |
|||
|
|||
在一个 **Pydantic 模型**中声明你需要的**查询参数**，然后将参数声明为 `Query`： |
|||
|
|||
{* ../../docs_src/query_param_models/tutorial001_an_py310.py hl[9:13,17] *} |
|||
|
|||
**FastAPI** 将会从请求的**查询参数**中**提取**出**每个字段**的数据，并将其提供给你定义的 Pydantic 模型。 |
|||
|
|||
## 查看文档 |
|||
|
|||
你可以在 `/docs` 页面的 UI 中查看查询参数： |
|||
|
|||
<div class="screenshot"> |
|||
<img src="/img/tutorial/query-param-models/image01.png"> |
|||
</div> |
|||
|
|||
## 禁止额外的查询参数 |
|||
|
|||
在一些特殊的使用场景中（可能不是很常见），你可能希望**限制**你要接收的查询参数。 |
|||
|
|||
你可以使用 Pydantic 的模型配置来 `forbid`（意为禁止 —— 译者注）任何 `extra`（意为额外的 —— 译者注）字段： |
|||
|
|||
{* ../../docs_src/query_param_models/tutorial002_an_py310.py hl[10] *} |
|||
|
|||
假设有一个客户端尝试在**查询参数**中发送一些**额外的**数据，它将会收到一个**错误**响应。 |
|||
|
|||
例如，如果客户端尝试发送一个值为 `plumbus` 的 `tool` 查询参数，如： |
|||
|
|||
```http |
|||
https://example.com/items/?limit=10&tool=plumbus |
|||
``` |
|||
|
|||
他们将收到一个**错误**响应，告诉他们查询参数 `tool` 是不允许的： |
|||
|
|||
```json |
|||
{ |
|||
"detail": [ |
|||
{ |
|||
"type": "extra_forbidden", |
|||
"loc": ["query", "tool"], |
|||
"msg": "Extra inputs are not permitted", |
|||
"input": "plumbus" |
|||
} |
|||
] |
|||
} |
|||
``` |
|||
|
|||
## 总结 |
|||
|
|||
你可以使用 **Pydantic 模型**在 **FastAPI** 中声明**查询参数**。😎 |
|||
|
|||
/// tip |
|||
|
|||
剧透警告：你也可以使用 Pydantic 模型来声明 cookie 和 headers，但你将在本教程的后面部分阅读到这部分内容。🤫 |
|||
|
|||
/// |
|||
Loading…
Reference in new issue