docs_src - Code Search

docs/em/docs/advanced/response-directly.md

🖼, 👆 🚫🔜 🚮 Pydantic 🏷 `JSONResponse` 🍵 🥇 🏭 ⚫️ `dict` ⏮️ 🌐 📊 🆎 (💖 `datetime`, `UUID`, ♒️) 🗜 🎻-🔗 🆎.

📚 💼, 👆 💪 ⚙️ `jsonable_encoder` 🗜 👆 📊 ⏭ 🚶‍♀️ ⚫️ 📨:

```Python hl_lines="6-7  21-22"
{!../../docs_src/response_directly/tutorial001.py!}
```

/// note | "📡 ℹ"

👆 💪 ⚙️ `from starlette.responses import JSONResponse`.

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 06 20:36:54 UTC 2024

- 2.6K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_advanced_middleware/test_tutorial003.py

from fastapi.responses import PlainTextResponse
from fastapi.testclient import TestClient

from docs_src.advanced_middleware.tutorial003 import app


@app.get("/large")
async def large():
    return PlainTextResponse("x" * 4000, status_code=200)


client = TestClient(app)


def test_middleware():
    response = client.get("/large", headers={"accept-encoding": "gzip"})
    assert response.status_code == 200, response.text

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Thu Jul 09 18:06:12 UTC 2020

- 665 bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_websockets/test_tutorial003.py

from fastapi.testclient import TestClient

from docs_src.websockets.tutorial003 import app, html

client = TestClient(app)


def test_get():
    response = client.get("/")
    assert response.text == html


def test_websocket_handle_disconnection():
    with client.websocket_connect("/ws/1234") as connection, client.websocket_connect(
        "/ws/5678"
    ) as connection_two:
        connection.send_text("Hello from 1234")

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Thu Jul 29 09:26:07 UTC 2021

- 872 bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_custom_request_and_route/test_tutorial002.py

from dirty_equals import IsDict
from fastapi.testclient import TestClient

from docs_src.custom_request_and_route.tutorial002 import app

client = TestClient(app)


def test_endpoint_works():
    response = client.post("/", json=[1, 2, 3])
    assert response.json() == 6


def test_exception_handler_body_access():
    response = client.post("/", json={"numbers": [1, 2, 3]})
    assert response.json() == IsDict(
        {

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Thu Apr 18 19:40:57 UTC 2024

- 1.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/de/docs/advanced/additional-responses.md

Um beispielsweise eine weitere Response mit dem Statuscode `404` und einem Pydantic-Modell `Message` zu deklarieren, können Sie schreiben:

```Python hl_lines="18  22"
{!../../docs_src/additional_responses/tutorial001.py!}
```

/// note | "Hinweis"

Beachten Sie, dass Sie die `JSONResponse` direkt zurückgeben müssen.

///

/// info

Der `model`-Schlüssel ist nicht Teil von OpenAPI.

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 06 20:36:54 UTC 2024

- 9.6K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/additional-responses.md

**FastAPI** will take that model, generate its JSON Schema and include it in the correct place in OpenAPI.

For example, to declare another response with a status code `404` and a Pydantic model `Message`, you can write:

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

/// note

Keep in mind that you have to return the `JSONResponse` directly.

///

/// info

The `model` key is not part of OpenAPI.

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 27 16:07:07 UTC 2024

- 8.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_behind_a_proxy/test_tutorial001.py

from fastapi.testclient import TestClient

from docs_src.behind_a_proxy.tutorial001 import app

client = TestClient(app, root_path="/api/v1")


def test_main():
    response = client.get("/app")
    assert response.status_code == 200
    assert response.json() == {"message": "Hello World", "root_path": "/api/v1"}


def test_openapi():
    response = client.get("/openapi.json")
    assert response.status_code == 200

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Fri Jun 30 18:25:16 UTC 2023

- 1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/zh/docs/advanced/middleware.md

强制所有传入请求必须是 `https` 或 `wss`。

任何传向 `http` 或 `ws` 的请求都会被重定向至安全方案。

```Python hl_lines="2  6"
{!../../docs_src/advanced_middleware/tutorial001.py!}
```

## `TrustedHostMiddleware`

强制所有传入请求都必须正确设置 `Host` 请求头，以防 HTTP 主机头攻击。

```Python hl_lines="2  6-8"
{!../../docs_src/advanced_middleware/tutorial002.py!}
```

支持以下参数：

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 06 20:36:54 UTC 2024

- 3.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/zh/docs/tutorial/security/simple-oauth2.md

接下来，使用 **FastAPI** 工具获取用户名与密码。

### `OAuth2PasswordRequestForm`

首先，导入 `OAuth2PasswordRequestForm`，然后，在 `/token` *路径操作* 中，用 `Depends` 把该类作为依赖项。

```Python hl_lines="4  76"
{!../../docs_src/security/tutorial003.py!}
```

`OAuth2PasswordRequestForm` 是用以下几项内容声明表单请求体的类依赖项：

* `username`
* `password`
* 可选的 `scope` 字段，由多个空格分隔的字符串组成的长字符串
* 可选的 `grant_type`

/// tip | "提示"

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 06 20:36:54 UTC 2024

- 8.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_websockets/test_tutorial001.py

import pytest
from fastapi.testclient import TestClient
from fastapi.websockets import WebSocketDisconnect

from docs_src.websockets.tutorial001 import app

client = TestClient(app)


def test_main():
    response = client.get("/")
    assert response.status_code == 200, response.text
    assert b"<!DOCTYPE html>" in response.content


def test_websocket():
    with pytest.raises(WebSocketDisconnect):

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Fri Jul 10 09:08:19 UTC 2020

- 822 bytes

- Viewed (0)

Search Options