Header Class — fastapi Architecture

Architecture documentation for the Header class in params.py from the fastapi codebase.

Class python FastAPI

Entity Profile

FastAPI→ Header Class — fastapi Architecture

Dependency Diagram

graph TD
  4d6882ff_aa8b_d88c_9032_0d7c216d2cf9["Header"]
  a15334a5_304f_0e4c_dce0_12ffde49a6b7["Param"]
  4d6882ff_aa8b_d88c_9032_0d7c216d2cf9 -->|extends| a15334a5_304f_0e4c_dce0_12ffde49a6b7
  2bb4dd2d_8b8a_6502_751c_38eabb6ae71e["params.py"]
  4d6882ff_aa8b_d88c_9032_0d7c216d2cf9 -->|defined in| 2bb4dd2d_8b8a_6502_751c_38eabb6ae71e
  43c3e821_7a83_539f_09f6_4715687c7bc3["__init__()"]
  4d6882ff_aa8b_d88c_9032_0d7c216d2cf9 -->|method| 43c3e821_7a83_539f_09f6_4715687c7bc3

Relationship Graph

Source Code

fastapi/params.py lines 304–385

class Header(Param):  # type: ignore[misc]
    in_ = ParamTypes.header

    def __init__(
        self,
        default: Any = Undefined,
        *,
        default_factory: Union[Callable[[], Any], None] = _Unset,
        annotation: Optional[Any] = None,
        alias: Optional[str] = None,
        alias_priority: Union[int, None] = _Unset,
        validation_alias: Union[str, AliasPath, AliasChoices, None] = None,
        serialization_alias: Union[str, None] = None,
        convert_underscores: bool = True,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        pattern: Optional[str] = None,
        regex: Annotated[
            Optional[str],
            deprecated(
                "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
            ),
        ] = None,
        discriminator: Union[str, None] = None,
        strict: Union[bool, None] = _Unset,
        multiple_of: Union[float, None] = _Unset,
        allow_inf_nan: Union[bool, None] = _Unset,
        max_digits: Union[int, None] = _Unset,
        decimal_places: Union[int, None] = _Unset,
        examples: Optional[list[Any]] = None,
        example: Annotated[
            Optional[Any],
            deprecated(
                "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
                "although still supported. Use examples instead."
            ),
        ] = _Unset,
        openapi_examples: Optional[dict[str, Example]] = None,
        deprecated: Union[deprecated, str, bool, None] = None,
        include_in_schema: bool = True,
        json_schema_extra: Union[dict[str, Any], None] = None,
        **extra: Any,
    ):
        self.convert_underscores = convert_underscores
        super().__init__(
            default=default,
            default_factory=default_factory,
            annotation=annotation,
            alias=alias,
            alias_priority=alias_priority,
            validation_alias=validation_alias,
            serialization_alias=serialization_alias,
            title=title,
            description=description,
            gt=gt,
            ge=ge,
            lt=lt,
            le=le,
            min_length=min_length,
            max_length=max_length,
            pattern=pattern,
            regex=regex,
            discriminator=discriminator,
            strict=strict,
            multiple_of=multiple_of,
            allow_inf_nan=allow_inf_nan,
            max_digits=max_digits,
            decimal_places=decimal_places,
            deprecated=deprecated,
            example=example,
            examples=examples,
            openapi_examples=openapi_examples,
            include_in_schema=include_in_schema,
            json_schema_extra=json_schema_extra,
            **extra,