fastblog's Introduction

FastBlog

Demo blog API built with FastAPI

Environment

Environment is managed with pipenv. Hence, to install all the required packages specified in the Pipfile, run

pipenv install

To run the server localy, use uvicorn:

uvicorn app.main:app --reload

Tests are written using pytest. Just run

python -m pytest

from the project directory to execute all the tests.

The API works with a fake database, which is just a Python class with no persistency. This FakeDb emulates very bare-bones database:
- Rows inserted using a model class
- Basic functions such as add, get, get_all, delete, and update
The application could have been much shorter if I didn't create an entire fake database module. Instead, I could have used pydantic models exclusively and saved their json representation into a map. However, I felt that in that case the project would be too small and not really representative of real world applications. In this form, on the other hand, it demonstrates how an API would communicate with a SQL database
Normally, I wouldn't be manipulating the blog post data directly in the main.py function, but instead there would be a separate crud module. However, since the FakeDb in database.py behaves pretty much like a crud module, I decided against creating this unnecessary module
In real world some of the main api functions should be async. However, since in this demo we were dealing with a fake database that doesn't even perform any IO operations, async is not necessary

Recommend Projects