FastAPI - Code Search

tests/test_additional_response_extra.py

from fastapi import APIRouter, FastAPI
from fastapi.testclient import TestClient

router = APIRouter()

sub_router = APIRouter()

app = FastAPI()


@sub_router.get("/")
def read_item():
    return {"id": "foo"}


router.include_router(sub_router, prefix="/items")

app.include_router(router)

client = TestClient(app)


def test_path_operation():
    response = client.get("/items/")

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

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

- 1.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_deprecated_openapi_prefix.py

from fastapi import FastAPI, Request
from fastapi.testclient import TestClient

app = FastAPI(openapi_prefix="/api/v1")


@app.get("/app")
def read_main(request: Request):
    return {"message": "Hello World", "root_path": request.scope.get("root_path")}


client = TestClient(app)


def test_main():
    response = client.get("/app")
    assert response.status_code == 200

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

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

- 1.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/handling_errors/tutorial006.py

from fastapi import FastAPI, HTTPException
from fastapi.exception_handlers import (
    http_exception_handler,
    request_validation_exception_handler,
)
from fastapi.exceptions import RequestValidationError
from starlette.exceptions import HTTPException as StarletteHTTPException

app = FastAPI()


@app.exception_handler(StarletteHTTPException)
async def custom_http_exception_handler(request, exc):
    print(f"OMG! An HTTP error!: {repr(exc)}")

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

- Last Modified: Sun Aug 09 11:10:33 UTC 2020

- 928 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial003_py39.py

from fastapi import FastAPI, WebSocket, WebSocketDisconnect
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>
        <h2>Your ID: <span id="ws-id"></span></h2>
        <form action="" onsubmit="sendMessage(event)">
            <input type="text" id="messageText" autocomplete="off"/>

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

- Last Modified: Sat Mar 18 12:29:59 UTC 2023

- 2.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/reference/apirouter.md

# `APIRouter` class

Here's the reference information for the `APIRouter` class, with all its parameters, attributes and methods.

You can import the `APIRouter` class directly from `fastapi`:

```python
from fastapi import APIRouter
```

::: fastapi.APIRouter
    options:
        members:
            - websocket
            - include_router
            - get
            - put
            - post
            - delete

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

- Last Modified: Thu Apr 18 19:53:19 UTC 2024

- 524 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/settings/app03_an_py39/main.py

from functools import lru_cache

from fastapi import Depends, FastAPI
from typing_extensions import Annotated

from . import config

app = FastAPI()


@lru_cache
def get_settings():
    return config.Settings()


@app.get("/info")
async def info(settings: Annotated[config.Settings, Depends(get_settings)]):
    return {
        "app_name": settings.app_name,
        "admin_email": settings.admin_email,

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

- Last Modified: Tue Oct 24 20:26:06 UTC 2023

- 462 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/body/tutorial003.py

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None


app = FastAPI()


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):

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

- Last Modified: Tue Jan 09 14:28:58 UTC 2024

- 362 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/query_params_str_validations/tutorial003_an.py

from typing import Union

from fastapi import FastAPI, Query
from typing_extensions import Annotated

app = FastAPI()


@app.get("/items/")
async def read_items(
    q: Annotated[Union[str, None], Query(min_length=3, max_length=50)] = None,
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})

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

- Last Modified: Tue Mar 26 16:56:53 UTC 2024

- 372 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/extra_models/tutorial004.py

from typing import List

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: str


items = [
    {"name": "Foo", "description": "There comes my hero"},
    {"name": "Red", "description": "It's my aeroplane"},
]


@app.get("/items/", response_model=List[Item])
async def read_items():

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

- Last Modified: Thu Mar 26 19:09:53 UTC 2020

- 381 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/handling_errors/tutorial002.py

from fastapi import FastAPI, HTTPException

app = FastAPI()

items = {"foo": "The Foo Wrestlers"}


@app.get("/items-header/{item_id}")
async def read_item_header(item_id: str):
    if item_id not in items:
        raise HTTPException(
            status_code=404,
            detail="Item not found",
            headers={"X-Error": "There goes my error"},
        )

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

- Last Modified: Thu Mar 26 19:09:53 UTC 2020

- 404 bytes

- Viewed (0)

Search Options