A simplistic and thoroughly commented example to get you up and moving with minimal fuss. There's a SlowAPI rate-limiting example you can trim out if you don't need it.
Clone, start docker, and run:
docker-compose build && docker-compose up
Then open up the Swagger UI via localhost/docs
There are only three VERY simple endpoints in this example.
/the root just returns 'Ready.' if it did in fact start okay./addnametakes a string 'name' and sticks it into the DB along with a generated UUID./getnameswill spit out everything in that table.
NOTE the DB is not persisted outside of its container so if you destroy/rebuild the container, that data is gone. If you don't want that, you'll need to mount a volume for it.
DB This example uses postgres but I also tested it against mysql and sqlite3.
SERVER FastAPI on uvicorn, see requirements.txt for libraries you'll need. Runs on port 80.
I'm using 3.11 in this example, but since FastAPI has a dependency on wheel, you might find that your IDE (looking at you VSCode) will always be unhappy with FastAPI; this is because - I've learned - the maintainers of wheel deprioritize Windows. (Personally, I don't blame them, but it is a factor.) Since the app itself runs dockerized, it will work. You just have to deal with the red squigglies.
- fastapi run on uvicorn with hot-reload.
- slowapi with a simplistic example of rate-limiting
- sqlalchemy ORM with:
- a test model that creates an associated table in the db if it doesn't exist.
- bare minimum setup to get python and the db talking
- pydantic for the SQLAlchemy to FastAPI communication. (I learned about SQLModel later.)