Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 61 - 70 of 542 for Annotated (0.06 seconds)

  1. docs_src/query_params_str_validations/tutorial012_an_py310.py

    from typing import Annotated
    
    from fastapi import FastAPI, Query
    
    app = FastAPI()
    
    
    @app.get("/items/")
    async def read_items(q: Annotated[list[str], Query()] = ["foo", "bar"]):
        query_items = {"q": q}
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Feb 12 13:19:43 GMT 2026
    - 227 bytes
    - Click Count (0)
  2. fastapi/security/open_id_connect_url.py

        code.
        """
    
        def __init__(
            self,
            *,
            openIdConnectUrl: Annotated[
                str,
                Doc(
                    """
                The OpenID Connect URL.
                """
                ),
            ],
            scheme_name: Annotated[
                str | None,
                Doc(
                    """
                    Security scheme name.
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Mon Mar 16 10:16:48 GMT 2026
    - 3.1K bytes
    - Click Count (0)
  3. fastapi/openapi/docs.py

            ),
        ],
        title: Annotated[
            str,
            Doc(
                """
                The HTML `<title>` content, normally shown in the browser tab.
    
                Read more about it in the
                [FastAPI docs for Custom Docs UI Static Assets](https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/)
                """
            ),
        ],
        swagger_js_url: Annotated[
            str,
            Doc(
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Tue Feb 24 09:28:10 GMT 2026
    - 12.1K bytes
    - Click Count (0)
  4. tests/test_request_params/test_form/test_required_str.py

        return {"p": p}
    
    
    class FormModelRequiredStr(BaseModel):
        p: str
    
    
    @app.post("/model-required-str", operation_id="model_required_str")
    async def read_model_required_str(p: Annotated[FormModelRequiredStr, Form()]):
        return {"p": p.p}
    
    
    @pytest.mark.parametrize(
        "path",
        ["/required-str", "/model-required-str"],
    )
    def test_required_str_schema(path: str):
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sat Dec 27 18:19:10 GMT 2025
    - 10.6K bytes
    - Click Count (0)
  5. fastapi/security/api_key.py

            self,
            *,
            name: Annotated[str, Doc("Header name.")],
            scheme_name: Annotated[
                str | None,
                Doc(
                    """
                    Security scheme name.
    
                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                    """
                ),
            ] = None,
            description: Annotated[
                str | None,
                Doc(
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 15 11:44:39 GMT 2026
    - 9.6K bytes
    - Click Count (1)
  6. fastapi/.agents/skills/fastapi/SKILL.md

    ## Use `Annotated`
    
    Always prefer the `Annotated` style for parameter and dependency declarations.
    
    It keeps the function signatures working in other contexts, respects the types, allows reusability.
    
    ### In Parameter Declarations
    
    Use `Annotated` for parameter declarations, including `Path`, `Query`, `Header`, etc.:
    
    ```python
    from typing import Annotated
    
    from fastapi import FastAPI, Path, Query
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 01 10:05:57 GMT 2026
    - 10.1K bytes
    - Click Count (0)
  7. docs_src/body_fields/tutorial001_an_py310.py

    from typing import Annotated
    
    from fastapi import Body, FastAPI
    from pydantic import BaseModel, Field
    
    app = FastAPI()
    
    
    class Item(BaseModel):
        name: str
        description: str | None = Field(
            default=None, title="The description of the item", max_length=300
        )
        price: float = Field(gt=0, description="The price must be greater than zero")
        tax: float | None = None
    
    
    @app.put("/items/{item_id}")
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sat Mar 18 12:29:59 GMT 2023
    - 563 bytes
    - Click Count (0)
  8. docs_src/security/tutorial001_an_py310.py

    from typing import Annotated
    
    from fastapi import Depends, FastAPI
    from fastapi.security import OAuth2PasswordBearer
    
    app = FastAPI()
    
    oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
    
    
    @app.get("/items/")
    async def read_items(token: Annotated[str, Depends(oauth2_scheme)]):
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Feb 12 13:19:43 GMT 2026
    - 309 bytes
    - Click Count (0)
  9. docs_src/dependencies/tutorial003_an_py310.py

    from typing import Annotated, Any
    
    from fastapi import Depends, FastAPI
    
    app = FastAPI()
    
    
    fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]
    
    
    class CommonQueryParams:
        def __init__(self, q: str | None = None, skip: int = 0, limit: int = 100):
            self.q = q
            self.skip = skip
            self.limit = limit
    
    
    @app.get("/items/")
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sat Mar 18 12:29:59 GMT 2023
    - 655 bytes
    - Click Count (0)
  10. tests/test_request_params/test_header/test_list.py

        return {"p": p}
    
    
    class HeaderModelRequiredListStr(BaseModel):
        p: list[str]
    
    
    @app.get("/model-required-list-str")
    def read_model_required_list_str(p: Annotated[HeaderModelRequiredListStr, Header()]):
        return {"p": p.p}
    
    
    @pytest.mark.parametrize(
        "path",
        ["/required-list-str", "/model-required-list-str"],
    )
    def test_required_list_str_schema(path: str):
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Feb 08 10:18:38 GMT 2026
    - 11.3K bytes
    - Click Count (0)
Back to Top