FastAPI - Code Search

fastapi/params.py

import warnings
from enum import Enum
from typing import Any, Callable, Dict, List, Optional, Sequence, Union

from fastapi.openapi.models import Example
from pydantic.fields import FieldInfo
from typing_extensions import Annotated, deprecated

from ._compat import PYDANTIC_V2, PYDANTIC_VERSION, Undefined

_Unset: Any = Undefined


class ParamTypes(Enum):
    query = "query"
    header = "header"
    path = "path"

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

- Last Modified: Fri Sep 06 18:06:20 UTC 2024

- 27.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/fr/docs/advanced/path-operation-advanced-configuration.md

## Description avancée de docstring

Vous pouvez limiter le texte utilisé de la docstring d'une *fonction de chemin* qui sera affiché sur OpenAPI.

L'ajout d'un `\f` (un caractère d'échappement "form feed") va permettre à **FastAPI** de tronquer la sortie utilisée pour OpenAPI à ce stade.

Il n'apparaîtra pas dans la documentation, mais d'autres outils (tel que Sphinx) pourront utiliser le reste.

```Python hl_lines="19-29"

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

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

- 8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/ko/docs/tutorial/path-params.md

/// check | "확인"

그저 파이썬 타입 선언을 하기만 하면 **FastAPI**는 자동 대화형 API 문서(Swagger UI)를 제공합니다.

경로 매개변수가 정수형으로 명시된 것을 확인할 수 있습니다.

///

## 표준 기반의 이점, 대체 문서

그리고 생성된 스키마는 <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md" class="external-link" target="_blank">OpenAPI</a> 표준에서 나온 것이기 때문에 호환되는 도구가 많이 있습니다.

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

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

- 9.8K 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

tests/test_dependency_class.py

from typing import AsyncGenerator, Generator

import pytest
from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient

app = FastAPI()


class CallableDependency:
    def __call__(self, value: str) -> str:
        return value


class CallableGenDependency:
    def __call__(self, value: str) -> Generator[str, None, None]:
        yield value


class AsyncCallableDependency:

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

- Last Modified: Sun Aug 09 10:54:05 UTC 2020

- 3.3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/zh/docs/tutorial/response-status-code.md

`201` 表示**已创建**的状态码。

但我们没有必要记住所有代码的含义。

可以使用 `fastapi.status` 中的快捷变量。

```Python hl_lines="1  6"
{!../../docs_src/response_status_code/tutorial002.py!}
```

这只是一种快捷方式，具有相同的数字代码，但它可以使用编辑器的自动补全功能：

<img src="../../../../../../img/tutorial/response-status-code/image02.png">

/// note | "技术细节"

也可以使用 `from starlette import status`。

为了让开发者更方便，**FastAPI** 提供了与 `starlette.status` 完全相同的 `fastapi.status`。但它直接来自于 Starlette。

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

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

- 3.7K 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)

github.com/tiangolo/fastapi

docs_src/app_testing/app_b_an/main.py

from typing import Union

from fastapi import FastAPI, Header, HTTPException
from pydantic import BaseModel
from typing_extensions import Annotated

fake_secret_token = "coneofsilence"

fake_db = {
    "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
    "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
}

app = FastAPI()


class Item(BaseModel):
    id: str
    title: str

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

- Last Modified: Thu Aug 15 22:31:16 UTC 2024

- 1.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/ru/docs/tutorial/request-forms.md

Например, выполните команду `pip install python-multipart`.

///

## Импорт `Form`

Импортируйте `Form` из `fastapi`:

//// tab | Python 3.9+

```Python hl_lines="3"
{!> ../../docs_src/request_forms/tutorial001_an_py39.py!}
```

////

//// tab | Python 3.8+

```Python hl_lines="1"

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

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

- 5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_security_api_key_header.py

from fastapi import Depends, FastAPI, Security
from fastapi.security import APIKeyHeader
from fastapi.testclient import TestClient
from pydantic import BaseModel

app = FastAPI()

api_key = APIKeyHeader(name="key")


class User(BaseModel):
    username: str


def get_current_user(oauth_header: str = Security(api_key)):
    user = User(username=oauth_header)
    return user


@app.get("/users/me")

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

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

- 1.8K bytes

- Viewed (0)

Search Options