FastAPI Server

A scaffolding project repository for a FastAPI server-side application.

Features

• FastAPI Framework: Modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
• Configuration Management: Environment-specific configuration with support for development, testing, and production environments.
• Database Integration: MySQL database integration with Peewee ORM and connection pooling.
• Redis Integration: Redis client for caching and session management.
• Authentication: JWT-based authentication system.
• Logging: Configurable logging system with file rotation.
• CORS Support: Cross-Origin Resource Sharing (CORS) middleware for handling cross-origin requests.

Project Structure

fastapi-server/
├── config/             # Configuration files
├── controller/         # API controllers
├── database/           # Database models and connector
├── external/           # External service integrations
├── thread_task/        # Background tasks
├── utils/              # Utility functions
├── .gitignore          # Git ignore file
├── LICENSE             # License file
├── Pipfile             # Pipenv dependency file
├── Pipfile.lock        # Pipenv lock file
├── README.md           # This README file
├── api_server.py       # Application entry point
└── app.py              # Application initialization

Getting Started

Prerequisites

• Python 3.11+
• Pipenv
• MySQL
• Redis (optional)

Installation

1. Clone the repository:

   git clone <repository-url>
   cd fastapi-server

2. Install dependencies:

   pipenv install

3. Configure environment variables:

   • Create a .env file in the project root directory with the following variable:

     # Environment configuration
     USE_CONFIG=development
     

   • Create environment-specific configuration files:
     • .env.dev for development environment
     • .env.testing for testing environment
     • .env.prod for production environment

   Example of environment-specific configuration file (e.g., .env.dev):

   # JWT configuration
   JWT_SECRET=dev_jwt_secret_key
   
   # Database configuration
   DATABASE_USER=root
   DATABASE_PASS=dev_password
   DATABASE_HOST=localhost
   DATABASE_PORT=3306
   DATABASE_NAME=dev_db
   DATABASE_CHARSET=utf8mb4
   DATABASE_POOL_SIZE=5
   
   # Redis configuration
   REDIS_URL=redis://localhost:6379/0
   
   # Log configuration
   LOG_FILE_NAME=app.log
   LOG_LEVEL=INFO
   LOG_FILE_SIZE=10485760
   LOG_BACKUP_COUNT=5
   

4. Run the application:

   pipenv run python api_server.py

   You will be prompted to enter a config password for decrypting sensitive information.

Usage

API Endpoints

• GET /api/mock/hello: A simple mock endpoint that returns "Hello World!"

Configuration

The application uses a two-level configuration system:

1. Base configuration (env): Contains only the USE_CONFIG variable to specify which environment configuration to use.
2. Environment-specific configuration: Contains all business-related configuration for each environment.

Supported Environments

• Development: Uses .env.dev file
• Testing: Uses .env.testing file
• Production: Uses .env.prod file

Configuration Files

• .env: Only contains the USE_CONFIG variable to specify the environment.
• .env.dev: Development environment configuration.
• .env.testing: Testing environment configuration.
• .env.prod: Production environment configuration.

Example Configuration

.env file:

# Environment configuration
USE_CONFIG=development

Environment-specific configuration (e.g., .env.dev):

# JWT configuration
JWT_SECRET=dev_jwt_secret_key

# Database configuration
DATABASE_USER=root
DATABASE_PASS=dev_password
DATABASE_HOST=localhost
DATABASE_PORT=3306
DATABASE_NAME=dev_db
DATABASE_CHARSET=utf8mb4
DATABASE_POOL_SIZE=5

# Redis configuration
REDIS_URL=redis://localhost:6379/0

# Log configuration
LOG_FILE_NAME=app.log
LOG_LEVEL=INFO
LOG_FILE_SIZE=10485760
LOG_BACKUP_COUNT=5

Specifying Environment

You can specify the environment by setting the USE_CONFIG environment variable in the .env file, or by passing it as a command-line argument:

USE_CONFIG=production pipenv run python api_server.py

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.