raymondshum / fast-api-sandbox

Overview

Sandbox FastAPI server, which runs in a VS Code dev container. Created for educational purposes only.

This is just meant to illustrate a potential method of file organization or project structure for a small team looking to avoid merge conflicts.

What it's missing (as an educational example) is a provider base class or protocol that abstracts the same method call to point at different services.

For example:

• ProviderTelecom -> ProviderSprint -> callHome
• ProviderTelecom -> ProviderAtt -> callHome

Setup

From the root of the project directory:

• Populate the env.sample file with your desired bcrypt hashing algorithm and secret.
• cp env.sample .env

Alembic

Upgrade DB tables:

   alembic revision --autogenerate -m "Initial migration"

fast-api-sandbox's Issues

Implement auth for users

Checklist:

• Hash password for user model
• Protect user routes (can only perform CRUD operations on own USER objects)
• Implement some sort of auth mechanism

Implement redis as cache for active JWT

Replace DB calls with this. Hold a blacklist instead. Expire the entry when the blacklisted token would normally expire.

Implement background task to periodically evict expired tokens

Fix routes

Forgot to update after moving routes:

For example, prefix is /user and route is also /user - so it would end up being /user/user

Implement refresh tokens for JWT

Determine auth mechanism

Blocking: #3

Need to determine how auth works for the user route. IE, are we passing a JWT back to them? Then need to investigate implementation.

Do we need to implement some sort of middleware or callback? Do we need to implement some sort of auth filter analogue?

Move User Routes to it's own Router Module

Implement user logout

Resolve Alembic module not found error

https://stackoverflow.com/questions/57468141/alembic-modulenotfounderror-in-env-py