A modern, production-ready FastAPI project scaffold with a well-organized structure and common features.
- FastAPI framework with modern Python type hints
- SQLAlchemy ORM with PostgreSQL
- JWT authentication
- Pydantic models for request/response validation
- Modular project structure
- Logging middleware
- CORS middleware
- Environment variable configuration
- Database migrations with Alembic
├── app/ # Business logic modules
│ ├── user/ # User module
│ ├── auth/ # Authentication module
│ └── article/ # Article module
├── config/ # Configuration
├── database/ # Database migrations and sessions
├── middleware/ # Middleware components
├── routes/ # API routes
├── .env # Environment variables (create from template below)
├── main.py # Application entry point
└── README.md # This file
Create a .env file in the project root with the following variables:
# Application
APP_NAME=LlamaCTO
APP_ENV=local
APP_DEBUG=true
APP_URL=http://localhost:8000
APP_KEY=your-app-key-here
# Server
SERVER_HOST=0.0.0.0
SERVER_PORT=8000
# Database
DB_CONNECTION=postgresql
DB_HOST=localhost
DB_PORT=5432
DB_DATABASE=llama_fastapi
DB_USERNAME=postgres
DB_PASSWORD=your_password_here
# JWT
JWT_SECRET=your-jwt-secret-key-here-please-change-in-production
JWT_ALGORITHM=HS256
JWT_ACCESS_TOKEN_EXPIRE_MINUTES=30
# Logging
LOG_LEVEL=debug
- Clone the repository
- Create a virtual environment:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
- Install dependencies:
pip install -r requirements.txt
- Create a
.envfile with your environment variables (see template above) - Run the application:
uvicorn main:app --reload
Once the application is running, you can access:
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc
- Follow PEP 8 style guide
- Write tests for new features
- Update documentation as needed
MIT
- All endpoints use the unified prefix:
/v1/xxx, deployed under the domainapi.xxx.com - Example:
https://api.xxx.com/v1/auth/login - Do not use the
/apipath prefix, keep it clean and simple - Recommended endpoint style:
POST /v1/auth/loginPOST /v1/auth/registerGET /v1/user/profilePOST /v1/article/createGET /v1/article/listGET /v1/health
All endpoints return the following structure:
{
"code": 200,
"msg": "success",
"data": { ... }
}code: Business status code, 200 for success, others for errorsmsg: Message descriptiondata: Business data object
{
"code": 400,
"msg": "Email already registered",
"data": null
}- For future versions, use
/v2/xxxdirectly, no need for/apiprefix