mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-15 03:04:27 +08:00
c4de66b81c
* Implement Transport classes * Implement authentication strategy classes * Revamp authentication with Transport and Strategy * Revamp strategy and OAuth so that they can use a callable dependency * Update docstring * Make ErrorCode a proper Enum and cleanup unused OpenAPI utils * Remove useless check * Tweak typing in authenticator * Update docs * Improve logout/destroy token logic * Update docs * Update docs * Update docs and full examples * Apply formatting to examples * Update OAuth doc and examples * Add migration doc * Implement Redis session token * Add Redis Session documentation * RedisSession -> Redis * Fix links in docs
109 lines
3.6 KiB
Markdown
109 lines
3.6 KiB
Markdown
# Overview
|
|
|
|
The schema below shows you how the library is structured and how each part fit together.
|
|
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
FASTAPI_USERS{FastAPIUsers}
|
|
USER_MANAGER{UserManager}
|
|
DATABASE_DEPENDENCY[[get_user_db]]
|
|
USER_MANAGER_DEPENDENCY[[get_user_manager]]
|
|
CURRENT_USER[[current_user]]
|
|
subgraph MODELS[Models]
|
|
direction RL
|
|
USER[User]
|
|
USER_CREATE[UserCreate]
|
|
USER_UPDATE[UserUpdate]
|
|
USER_DB[UserDB]
|
|
end
|
|
subgraph DATABASE[Database adapters]
|
|
direction RL
|
|
SQLALCHEMY[SQLAlchemy]
|
|
MONGODB[MongoDB]
|
|
TORTOISE[Tortoise ORM]
|
|
ORMAR[Ormar]
|
|
end
|
|
subgraph ROUTERS[Routers]
|
|
direction RL
|
|
AUTH[[get_auth_router]]
|
|
OAUTH[[get_oauth_router]]
|
|
REGISTER[[get_register_router]]
|
|
VERIFY[[get_verify_router]]
|
|
RESET[[get_reset_password_router]]
|
|
USERS[[get_users_router]]
|
|
end
|
|
subgraph AUTH_BACKENDS[Authentication]
|
|
direction RL
|
|
subgraph TRANSPORTS[Transports]
|
|
direction RL
|
|
COOKIE[CookieTransport]
|
|
BEARER[BearerTransport]
|
|
end
|
|
subgraph STRATEGIES[Strategies]
|
|
direction RL
|
|
JWT[JWTStrategy]
|
|
end
|
|
AUTH_BACKEND{AuthenticationBackend}
|
|
end
|
|
DATABASE --> DATABASE_DEPENDENCY
|
|
DATABASE_DEPENDENCY --> USER_MANAGER
|
|
|
|
MODELS --> USER_MANAGER
|
|
MODELS --> FASTAPI_USERS
|
|
|
|
USER_MANAGER --> USER_MANAGER_DEPENDENCY
|
|
USER_MANAGER_DEPENDENCY --> FASTAPI_USERS
|
|
|
|
FASTAPI_USERS --> ROUTERS
|
|
|
|
TRANSPORTS --> AUTH_BACKEND
|
|
STRATEGIES --> AUTH_BACKEND
|
|
|
|
AUTH_BACKEND --> AUTH
|
|
AUTH_BACKEND --> OAUTH
|
|
AUTH_BACKEND --> FASTAPI_USERS
|
|
|
|
FASTAPI_USERS --> CURRENT_USER
|
|
```
|
|
|
|
## Models
|
|
|
|
Pydantic models representing the data structure of a user. Base classes are provided with the required fields to make authentication work. You should sub-class each of them and add your own fields there.
|
|
|
|
➡️ [Configure the models](./models.md)
|
|
|
|
## Database adapters
|
|
|
|
FastAPI Users is compatible with various databases and ORM. To build the interface between those database tools and the library, we provide database adapters classes that you need to instantiate and configure.
|
|
|
|
➡️ [I'm using SQLAlchemy](databases/sqlalchemy.md)
|
|
|
|
➡️ [I'm using MongoDB](databases/mongodb.md)
|
|
|
|
➡️ [I'm using Tortoise ORM](databases/tortoise.md)
|
|
|
|
➡️ [I'm using ormar](databases/ormar.md)
|
|
|
|
## Authentication backends
|
|
|
|
Authentication backends define the way users sessions are managed in your app, like access tokens or cookies.
|
|
|
|
They are composed of two parts: a **transport**, which is how the token will be carried over the requests (e.g. cookies, headers...) and a **strategy**, which is how the token will be generated and secured (e.g. a JWT, a token in database...).
|
|
|
|
➡️ [Configure the authentication backends](./authentication/index.md)
|
|
|
|
## `UserManager`
|
|
|
|
The `UserManager` object bears most of the logic of FastAPI Users: registration, verification, password reset... We provide a `BaseUserManager` with this common logic; which you should overload to define how to validate passwords or handle events.
|
|
|
|
This `UserManager` object should be provided through a FastAPI dependency, `get_user_manager`.
|
|
|
|
➡️ [Configure `UserManager`](./user-manager.md)
|
|
|
|
## `FastAPIUsers` and routers
|
|
|
|
Finally, `FastAPIUsers` object is the main class from which you'll be able to generate routers for classic routes like registration or login, but also get the `current_user` dependency factory to inject the authenticated user in your own routes.
|
|
|
|
➡️ [Configure `FastAPIUsers` and routers](./routers/index.md)
|