Project Showcase: API shell
1. Vision & Scope
This API shell is a tool designed to simplify the process of building APIs. It provides a set of pre-built components that can be used to quickly create a robust and secure API. The goal is to make API development more efficient and less error-prone, allowing developers to focus on their core business logic. TDD (Test Driven Development) methodology with Pytest was used when this API which makes it robust.
2. Key Features
- Rate Limiting: Custom middleware using Redis to prevent abuse and manage traffic spikes.
- Secure Authentication: Stateless JWT implementation with Bcrypt password hashing.
- Infrastructure as Code: Fully containerized environment using Docker & Docker Compose.
- Automated Testing: 100% test coverage for core logic using Pytest.
3. Technology Stack
| Layer | Tool/Service |
|---|---|
| Core Framework | Python, FastAPI |
| Validation | Pydantic |
| Testing | Pytest, Pytest-Asyncio |
| Caching & Throttling | Redis (Dockerized) |
| Security | PyJWT (Tokens), Passlib/Bcrypt (Hashing) |
| Infrastructure | Docker, Docker Compose |
4. Architecture
The system follows a modular design pattern, separating concerns between Security (Auth/Limiter), Core Logic, and Data Access.
