https://github.com/allwelldotdev/restapis_fastapi

Learning FastAPI with Mastering REST APIs with FastAPI by Jose Salvatierra Fuentes..
https://github.com/allwelldotdev/restapis_fastapi

fastapi logging pytest python

Last synced: about 1 month ago
JSON representation

Learning FastAPI with Mastering REST APIs with FastAPI by Jose Salvatierra Fuentes..

• Host: GitHub
• URL: https://github.com/allwelldotdev/restapis_fastapi
• Owner: allwelldotdev
• Created: 2025-03-31T07:38:21.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-11-23T13:18:20.000Z (7 months ago)
• Last Synced: 2025-11-23T15:13:41.794Z (7 months ago)
• Topics: fastapi, logging, pytest, python
• Language: Python
• Size: 873 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Building a Minimal Asynchronous Social Media REST API with FastAPI & TDD (Test Driven Development)

*(Updated for v0.2)*

Built a minimal Social Media API with REST architecture as a project to deepen my understanding of FastAPI & Python. `socials_api` is a minimal Social Media API with the following functions:

- User Posts

- User Comments

Using Swagger UI, you can access the API docs at the `/docs` endpoint (as seen below).

![API docs from Swagger UI](./assets/doc_imgs/v0.2_api_docs.png)

## Code Functionality *(Updated in v0.2)*

1. **SQLite SQL Database:** Transitioned from a dictionary-based data storage system to using an SQLite database for persisten data storage and retrieval.

2. **Switch to DB for deduplication of Primary Keys for Post & Comment ID Values:** No need for custom algorithm to keep the ID values deduplicated. Using DB Primary Keys, ID values auto-increment and remain unique.

3. **More Endpoints:** Added "Get Posts With Comments" endpoint and updated the return schema for posts and comments to match their database model.

## TDD (Test Driven Development)

To ensure TDD (Test Driven Development), I used the popular Python testing framework `pytest` to write FastAPI unit tests for the codebase. All 24 tests pass! You can find tests code in `./v0.2/socials_api/tests/` directory.

![v0.2 tests with pytest](./assets/doc_imgs/v0.2_tests.png)

## Code use

An exhibit of API calls to display what the API can do. Testing using Postman API Client:

1. Create Post

![v0.2 API 'create post' example](./assets/doc_imgs/v0.2_create_post.png)

2. Post Comments

![v0.2 API 'post comments' example](./assets/doc_imgs/v0.2_post_comment.png)

3. Get All Comments

![v0.2 API 'get all comments' example](./assets/doc_imgs/v0.2_get_all_comments.png)

4. Delete Post By Id

![v0.2 API 'delete post by id' example](./assets/doc_imgs/v0.2_delete_post_by_id.png)

## Run code locally...

To run the codebase appropriately locally, read the following instructions:

- Clone/Fork the repo to local.

- Start FastAPI web server:

  ```bash

  cd restapi_fastapi # make sure you are in the project root directory

  uvicorn --app-dir v0.2 socials_api.main:app --reload

  ```

- Connect to web server using a web browser client or Postman API Client. Go to `localhost/docs` or `localhost:8000/docs`.

- Manually test API endpoints. To find available API endpoints, use Swagger UI API docs by visiting `/docs` endpoint on web browser client.

- Run unit tests on codebase (using `pytest`):

  ```bash

  cd restapi_fastapi # make sure you are in the project root directory

  pytest -v v0.2/socials_api

  ```