init() — fastapi Function Reference

Architecture documentation for the __init__() function in api_key.py from the fastapi codebase.

Function python Security Schemes

Entity Profile

Security→ Schemes→ __init__() — fastapi Function Reference

Dependency Diagram

graph TD
  77841233_17c1_33cd_0da9_bee86f06d880["__init__()"]
  f01173ae_dbd6_605b_f92e_0035a743c419["APIKeyBase"]
  77841233_17c1_33cd_0da9_bee86f06d880 -->|defined in| f01173ae_dbd6_605b_f92e_0035a743c419
  style 77841233_17c1_33cd_0da9_bee86f06d880 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/security/api_key.py lines 12–27

    def __init__(
        self,
        location: APIKeyIn,
        name: str,
        description: Union[str, None],
        scheme_name: Union[str, None],
        auto_error: bool,
    ):
        self.auto_error = auto_error

        self.model: APIKey = APIKey(
            **{"in": location},
            name=name,
            description=description,
        )
        self.scheme_name = scheme_name or self.__class__.__name__