mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-10-31 09:28:45 +08:00
72aa68c462
* Use a generic Protocol model for User instead of Pydantic
* Remove UserDB Pydantic schema
* Harmonize schema variable naming to avoid confusions
* Revamp OAuth account model management
* Revamp AccessToken DB strategy to adopt generic model approach
* Make ID a generic instead of forcing UUIDs
* Improve generic typing
* Improve Strategy typing
* Tweak base DB typing
* Don't set Pydantic schemas on FastAPIUsers class: pass it directly on router creation
* Add IntegerIdMixin and export related classes
* Start to revamp doc for V10
* Revamp OAuth documentation
* Fix code highlights
* Write the 9.x.x ➡️ 10.x.x migration doc
* Fix pyproject.toml
46 lines
2.1 KiB
Markdown
46 lines
2.1 KiB
Markdown
# Routers
|
|
|
|
We're almost there! The last step is to configure the `FastAPIUsers` object that will wire the user manager, the authentication classes and let us generate the actual **API routes**.
|
|
|
|
## Configure `FastAPIUsers`
|
|
|
|
Configure `FastAPIUsers` object with the elements we defined before. More precisely:
|
|
|
|
* `get_user_manager`: Dependency callable getter to inject the
|
|
user manager class instance. See [UserManager](../user-manager.md).
|
|
* `auth_backends`: List of authentication backends. See [Authentication](../authentication/index.md).
|
|
|
|
```py
|
|
import uuid
|
|
|
|
from fastapi_users import FastAPIUsers
|
|
|
|
from .db import User
|
|
|
|
fastapi_users = FastAPIUsers[User, uuid.UUID](
|
|
get_user_manager,
|
|
[auth_backend],
|
|
)
|
|
```
|
|
|
|
!!! note "Typing: User and ID generic types are expected"
|
|
You can see that we define two generic types when instantiating:
|
|
|
|
* `User`, which is the user model we defined in the database part
|
|
* The ID, which should correspond to the type of ID you use on your model. Here, we chose UUID, but it can be anything, like an integer or a MongoDB ObjectID.
|
|
|
|
It'll help you to have **good type-checking and auto-completion**.
|
|
|
|
## Available routers
|
|
|
|
This helper class will let you generate useful routers to setup the authentication system. Each of them is **optional**, so you can pick only the one that you are interested in! Here are the routers provided:
|
|
|
|
* [Auth router](./auth.md): Provides `/login` and `/logout` routes for a given [authentication backend](../authentication/index.md).
|
|
* [Register router](./register.md): Provides `/register` routes to allow a user to create a new account.
|
|
* [Reset password router](./reset.md): Provides `/forgot-password` and `/reset-password` routes to allow a user to reset its password.
|
|
* [Verify router](./verify.md): Provides `/request-verify-token` and `/verify` routes to manage user e-mail verification.
|
|
* [Users router](./users.md): Provides routes to manage users.
|
|
* [OAuth router](../oauth.md): Provides routes to perform an OAuth authentication against a service provider (like Google or Facebook).
|
|
|
|
You should check out each of them to understand how to use them.
|