Sebastián Ramírez
7 months ago
committed by
GitHub
GitHub
30 changed files with 580 additions and 200 deletions
@ -148,7 +148,7 @@ $ ADMIN_EMAIL="[email protected]" APP_NAME="ChimichangApp" fastapi run main.p |
|||||
|
|
||||
Продолжая предыдущий пример, ваш файл `config.py` может выглядеть так: |
Продолжая предыдущий пример, ваш файл `config.py` может выглядеть так: |
||||
|
|
||||
{* ../../docs_src/settings/app02/config.py hl[10] *} |
{* ../../docs_src/settings/app02_an_py39/config.py hl[10] *} |
||||
|
|
||||
Обратите внимание, что теперь мы не создаем экземпляр по умолчанию `settings = Settings()`. |
Обратите внимание, что теперь мы не создаем экземпляр по умолчанию `settings = Settings()`. |
||||
|
|
||||
@ -174,7 +174,7 @@ $ ADMIN_EMAIL="[email protected]" APP_NAME="ChimichangApp" fastapi run main.p |
|||||
|
|
||||
Далее будет очень просто предоставить другой объект настроек во время тестирования, создав переопределение зависимости для `get_settings`: |
Далее будет очень просто предоставить другой объект настроек во время тестирования, создав переопределение зависимости для `get_settings`: |
||||
|
|
||||
{* ../../docs_src/settings/app02/test_main.py hl[9:10,13,21] *} |
{* ../../docs_src/settings/app02_an_py39/test_main.py hl[9:10,13,21] *} |
||||
|
|
||||
В переопределении зависимости мы задаем новое значение `admin_email` при создании нового объекта `Settings`, а затем возвращаем этот новый объект. |
В переопределении зависимости мы задаем новое значение `admin_email` при создании нового объекта `Settings`, а затем возвращаем этот новый объект. |
||||
|
|
||||
@ -217,7 +217,7 @@ APP_NAME="ChimichangApp" |
|||||
|
|
||||
//// tab | Pydantic v2 |
//// tab | Pydantic v2 |
||||
|
|
||||
{* ../../docs_src/settings/app03_an/config.py hl[9] *} |
{* ../../docs_src/settings/app03_an_py39/config.py hl[9] *} |
||||
|
|
||||
/// tip | Совет |
/// tip | Совет |
||||
|
|
||||
@ -229,7 +229,7 @@ APP_NAME="ChimichangApp" |
|||||
|
|
||||
//// tab | Pydantic v1 |
//// tab | Pydantic v1 |
||||
|
|
||||
{* ../../docs_src/settings/app03_an/config_pv1.py hl[9:10] *} |
{* ../../docs_src/settings/app03_an_py39/config_pv1.py hl[9:10] *} |
||||
|
|
||||
/// tip | Совет |
/// tip | Совет |
||||
|
|
||||
|
|||||
@ -0,0 +1,65 @@ |
|||||
|
# FastAPI Cloud { #fastapi-cloud } |
||||
|
|
||||
|
Вы можете развернуть своё приложение FastAPI в <a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a> одной командой, присоединяйтесь к списку ожидания, если ещё не сделали этого. 🚀 |
||||
|
|
||||
|
## Вход { #login } |
||||
|
|
||||
|
Убедитесь, что у вас уже есть аккаунт **FastAPI Cloud** (мы пригласили вас из списка ожидания 😉). |
||||
|
|
||||
|
Затем выполните вход: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ fastapi login |
||||
|
|
||||
|
You are logged in to FastAPI Cloud 🚀 |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
## Деплой { #deploy } |
||||
|
|
||||
|
Теперь разверните приложение одной командой: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ fastapi deploy |
||||
|
|
||||
|
Deploying to FastAPI Cloud... |
||||
|
|
||||
|
✅ Deployment successful! |
||||
|
|
||||
|
🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
Вот и всё! Теперь вы можете открыть своё приложение по этому URL. ✨ |
||||
|
|
||||
|
## О FastAPI Cloud { #about-fastapi-cloud } |
||||
|
|
||||
|
**<a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>** создан тем же автором и командой, что и **FastAPI**. |
||||
|
|
||||
|
Он упрощает процесс **создания образа**, **развертывания** и **доступа** к API с минимальными усилиями. |
||||
|
|
||||
|
Он переносит тот же **опыт разработчика**, что вы получаете при создании приложений на FastAPI, на их **развертывание** в облаке. 🎉 |
||||
|
|
||||
|
Он также возьмёт на себя большинство вещей, которые требуются при развертывании приложения, например: |
||||
|
|
||||
|
* HTTPS |
||||
|
* Репликация с автоматическим масштабированием на основе запросов |
||||
|
* и т.д. |
||||
|
|
||||
|
FastAPI Cloud — основной спонсор и источник финансирования open source‑проектов «FastAPI и друзья». ✨ |
||||
|
|
||||
|
## Развертывание у других облачных провайдеров { #deploy-to-other-cloud-providers } |
||||
|
|
||||
|
FastAPI — проект с открытым исходным кодом и основан на стандартах. Вы можете развернуть приложения FastAPI у любого облачного провайдера на ваш выбор. |
||||
|
|
||||
|
Следуйте руководствам вашего облачного провайдера, чтобы развернуть приложения FastAPI у них. 🤓 |
||||
|
|
||||
|
## Развертывание на собственном сервере { #deploy-your-own-server } |
||||
|
|
||||
|
Позже в этом руководстве по **развертыванию** я также расскажу все детали — чтобы вы понимали, что происходит, что нужно сделать и как развернуть приложения FastAPI самостоятельно, в том числе на собственных серверах. 🤓 |
||||
@ -0,0 +1,17 @@ |
|||||
|
# Использование старых статус-кодов ошибок аутентификации 403 { #use-old-403-authentication-error-status-codes } |
||||
|
|
||||
|
До версии FastAPI `0.122.0`, когда встроенные утилиты безопасности возвращали ошибку клиенту после неудачной аутентификации, они использовали HTTP статус-код `403 Forbidden`. |
||||
|
|
||||
|
Начиная с версии FastAPI `0.122.0`, используется более подходящий HTTP статус-код `401 Unauthorized`, и в ответе возвращается имеющий смысл HTTP-заголовок `WWW-Authenticate` в соответствии со спецификациями HTTP, <a href="https://datatracker.ietf.org/doc/html/rfc7235#section-3.1" class="external-link" target="_blank">RFC 7235</a>, <a href="https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized" class="external-link" target="_blank">RFC 9110</a>. |
||||
|
|
||||
|
Но если по какой-то причине ваши клиенты зависят от старого поведения, вы можете вернуть его, переопределив метод `make_not_authenticated_error` в ваших Security-классах. |
||||
|
|
||||
|
Например, вы можете создать подкласс `HTTPBearer`, который будет возвращать ошибку `403 Forbidden` вместо стандартной `401 Unauthorized`: |
||||
|
|
||||
|
{* ../../docs_src/authentication_error_status_code/tutorial001_an_py39.py hl[9:13] *} |
||||
|
|
||||
|
/// tip | Совет |
||||
|
|
||||
|
Обратите внимание, что функция возвращает экземпляр исключения, не вызывает его. Выброс выполняется остальным внутренним кодом. |
||||
|
|
||||
|
/// |
||||
@ -1,3 +1,3 @@ |
|||||
# Ресурсы { #resources } |
# Ресурсы { #resources } |
||||
|
|
||||
Дополнительные ресурсы, внешние ссылки, статьи и многое другое. ✈️ |
Дополнительные ресурсы, внешние ссылки и многое другое. ✈️ |
||||
|
|||||
@ -0,0 +1,207 @@ |
|||||
|
# Ref: https://github.com/fastapi/fastapi/discussions/14495 |
||||
|
|
||||
|
from typing import Union |
||||
|
|
||||
|
import pytest |
||||
|
from fastapi import FastAPI |
||||
|
from fastapi.testclient import TestClient |
||||
|
from inline_snapshot import snapshot |
||||
|
from pydantic import BaseModel |
||||
|
from typing_extensions import Annotated |
||||
|
|
||||
|
from .utils import needs_pydanticv2 |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def client_fixture() -> TestClient: |
||||
|
from fastapi import Body |
||||
|
from pydantic import Discriminator, Tag |
||||
|
|
||||
|
class Cat(BaseModel): |
||||
|
pet_type: str = "cat" |
||||
|
meows: int |
||||
|
|
||||
|
class Dog(BaseModel): |
||||
|
pet_type: str = "dog" |
||||
|
barks: float |
||||
|
|
||||
|
def get_pet_type(v): |
||||
|
assert isinstance(v, dict) |
||||
|
return v.get("pet_type", "") |
||||
|
|
||||
|
Pet = Annotated[ |
||||
|
Union[Annotated[Cat, Tag("cat")], Annotated[Dog, Tag("dog")]], |
||||
|
Discriminator(get_pet_type), |
||||
|
] |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
@app.post("/pet/assignment") |
||||
|
async def create_pet_assignment(pet: Pet = Body()): |
||||
|
return pet |
||||
|
|
||||
|
@app.post("/pet/annotated") |
||||
|
async def create_pet_annotated(pet: Annotated[Pet, Body()]): |
||||
|
return pet |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_union_body_discriminator_assignment(client: TestClient) -> None: |
||||
|
response = client.post("/pet/assignment", json={"pet_type": "cat", "meows": 5}) |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == {"pet_type": "cat", "meows": 5} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_union_body_discriminator_annotated(client: TestClient) -> None: |
||||
|
response = client.post("/pet/annotated", json={"pet_type": "dog", "barks": 3.5}) |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == {"pet_type": "dog", "barks": 3.5} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_openapi_schema(client: TestClient) -> None: |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == snapshot( |
||||
|
{ |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/pet/assignment": { |
||||
|
"post": { |
||||
|
"summary": "Create Pet Assignment", |
||||
|
"operationId": "create_pet_assignment_pet_assignment_post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"anyOf": [ |
||||
|
{"$ref": "#/components/schemas/Cat"}, |
||||
|
{"$ref": "#/components/schemas/Dog"}, |
||||
|
], |
||||
|
"title": "Pet", |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
"/pet/annotated": { |
||||
|
"post": { |
||||
|
"summary": "Create Pet Annotated", |
||||
|
"operationId": "create_pet_annotated_pet_annotated_post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"oneOf": [ |
||||
|
{"$ref": "#/components/schemas/Cat"}, |
||||
|
{"$ref": "#/components/schemas/Dog"}, |
||||
|
], |
||||
|
"title": "Pet", |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"Cat": { |
||||
|
"properties": { |
||||
|
"pet_type": { |
||||
|
"type": "string", |
||||
|
"title": "Pet Type", |
||||
|
"default": "cat", |
||||
|
}, |
||||
|
"meows": {"type": "integer", "title": "Meows"}, |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"required": ["meows"], |
||||
|
"title": "Cat", |
||||
|
}, |
||||
|
"Dog": { |
||||
|
"properties": { |
||||
|
"pet_type": { |
||||
|
"type": "string", |
||||
|
"title": "Pet Type", |
||||
|
"default": "dog", |
||||
|
}, |
||||
|
"barks": {"type": "number", "title": "Barks"}, |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"required": ["barks"], |
||||
|
"title": "Dog", |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"items": { |
||||
|
"$ref": "#/components/schemas/ValidationError" |
||||
|
}, |
||||
|
"type": "array", |
||||
|
"title": "Detail", |
||||
|
} |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"title": "HTTPValidationError", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
"type": "array", |
||||
|
"title": "Location", |
||||
|
}, |
||||
|
"msg": {"type": "string", "title": "Message"}, |
||||
|
"type": {"type": "string", "title": "Error Type"}, |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"title": "ValidationError", |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
|
) |
||||
Loading…
Reference in new issue