-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3ec5de6
commit 591f05a
Showing
1 changed file
with
5 additions
and
158 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,163 +1,13 @@ | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|
|
||
| # Address Book API in FastAPI (Python) | ||
|
|
||
| The purpose of this repository is to get my hands dirty with FastAPI skills. It would demonstrate various common operations which you perform for any API using FastAPI like Database connections, File uploads, Authentication, Sessions and More. | ||
|
|
||
| # Why Fast API ? | ||
|
|
||
| FastAPI is a modern back-end framework written in Python which can be used as an alternative to other popular Python based frameworks available like Django and Flask. | ||
|
|
||
| ### Reasons you might want to use Fast API: | ||
|
|
||
| * **Fast**: Very high performance, on par with NodeJS and Go (thanks to Starlette and Pydantic). One of the fastest Python frameworks available. | ||
|
|
||
| * **Fast to code**: Increase the speed to develop features by about 200% to 300%. | ||
|
|
||
| * **Fewer bugs**: Reduce about 40% of human (developer) induced errors. | ||
|
|
||
| * **Intuitive**: Great editor support. Completion everywhere. Less time debugging. | ||
|
|
||
| * **Easy to learn (compared to Django and even Flask)**: Designed to be easy to use and learn. Less time reading docs. | ||
|
|
||
| * **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs. | ||
|
|
||
| * **Robust**: Get production-ready code. With automatic interactive documentation. | ||
|
|
||
| * **Standards-based**: Based on (and fully compatible with) the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema. | ||
|
|
||
| ## Models | ||
|
|
||
| At the time of writing this, the API has three models which would be Task, User and Address. Task model is totally unrestricted, anyone can perform CRUD operations on it. User module is for authentication which is token based. Authenticated users can add address and perform CRUD on it. Object level filtering has been applied which would restrict users to perform CRUD operations on addresses which were not created by them. | ||
|
|
||
| ```mermaid | ||
| erDiagram | ||
| TASK { | ||
| int id | ||
| string name | ||
| string description | ||
| } | ||
| USER { | ||
| int id | ||
| string username | ||
| string email | ||
| string password | ||
| } | ||
| ADDRESS { | ||
| int id | ||
| int user_id | ||
| string shipping_address | ||
| string created_at | ||
| } | ||
| ``` | ||
|
|
||
| ## Database | ||
|
|
||
| Postgres is used for the database and Alembic package is used for migrations which means accomodating real time changes in the database. The code sample below demonstates the integration of SQLAlchemy and Postgres in a FastAPI project. | ||
|
|
||
| ``` | ||
| from sqlalchemy import create_engine, MetaData | ||
| from sqlalchemy.ext.declarative import declarative_base | ||
| from sqlalchemy.orm import sessionmaker | ||
| SQLALCHEMY_DATABASE_URL = f"postgresql://postgres:[email protected]/address-book" | ||
| engine = create_engine(SQLALCHEMY_DATABASE_URL) | ||
| SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) | ||
| Base = declarative_base() | ||
| metadata = MetaData() | ||
| def get_db(): | ||
| db = SessionLocal() | ||
| try: | ||
| yield db | ||
| finally: | ||
| db.close() | ||
| ``` | ||
|
|
||
| ## Testing with Pytest | ||
|
|
||
| A separate database is used exclusively for testing, configuration has been put inside a config.py file in the root folder of the project. | ||
|
|
||
| ``` | ||
| DATABASE_USERNAME = 'postgres' | ||
| DATABASE_PASSWORD = 'pass12345' | ||
| DATABASE_HOST = '127.0.0.1' | ||
| DATABASE_NAME = 'address-book' | ||
| TEST_DATABASE_NAME = 'address-book-test' | ||
| ``` | ||
|
|
||
| Code to test the app root end-point. We need to make sure 200 status code is returned when we hit this route. | ||
|
|
||
| ``` | ||
| from fastapi.testclient import TestClient | ||
| from main import app | ||
| client = TestClient(app) | ||
| def test_read_main(): | ||
| response = client.get("/") | ||
| assert response.status_code == 200 | ||
| assert response.json() == {"message": "Hello Address Book API"} | ||
| ``` | ||
|
|
||
| test_db.py | ||
|
|
||
| ``` | ||
| from fastapi.testclient import TestClient | ||
| from sqlalchemy import create_engine | ||
| from sqlalchemy.orm import sessionmaker | ||
| import config | ||
| from db import Base, get_db | ||
| from main import app | ||
| DATABASE_USERNAME = config.DATABASE_USERNAME | ||
| DATABASE_PASSWORD = config.DATABASE_PASSWORD | ||
| DATABASE_HOST = config.DATABASE_HOST | ||
| DATABASE_NAME = config.TEST_DATABASE_NAME | ||
| SQLALCHEMY_DATABASE_URL = f"postgresql://{DATABASE_USERNAME}:{DATABASE_PASSWORD}@{DATABASE_HOST}/{DATABASE_NAME}" | ||
| engine = create_engine(SQLALCHEMY_DATABASE_URL) | ||
| TestingSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) | ||
| Base.metadata.create_all(bind=engine) | ||
| def override_get_db(): | ||
| try: | ||
| db = TestingSessionLocal() | ||
| yield db | ||
| finally: | ||
| db.close() | ||
| app.dependency_overrides[get_db] = override_get_db | ||
| client = TestClient(app) | ||
| def test_create_user(): | ||
| response = client.post( | ||
| "/account/", | ||
| json={"username": "Deadpool", "email": "[email protected]", "password": "chimichangas4life"}, | ||
| ) | ||
| assert response.status_code == 201 | ||
| data = response.json() | ||
| assert data["email"] == "[email protected]" | ||
| ``` | ||
|
|
||
| # Blog App in FastAPI and React | ||
|
|
||
| A simple Blog application written using FastAPI for the back-end and React for the frontend. This would have simple blog application features like authentication, posting contents which would have title and description. More features to be added in the future like file upload to local system, file upload to AWS and more. | ||
|
|
||
| ## Resources | ||
|
|
||
|
|
@@ -173,6 +23,3 @@ Following resources were used for motivation in designing this API. | |
| ## License | ||
|
|
||
| This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details | ||
|
|
||
|
|
||
|
|
||