Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darinelguillen/fastapi-secure-api
A lightweight FastAPI skeleton for building secure, scalable REST APIs. Includes JWT-based authentication, Google Drive integration using OAuth2, and modular, clean architecture for rapid development.
https://github.com/darinelguillen/fastapi-secure-api
api asynchronous-programming backend crud fastapi google-drive jwt oauth2 python3 rest-api scalable-architecture skeleton skeleton-application uvicorn
Last synced: 5 days ago
JSON representation
A lightweight FastAPI skeleton for building secure, scalable REST APIs. Includes JWT-based authentication, Google Drive integration using OAuth2, and modular, clean architecture for rapid development.
- Host: GitHub
- URL: https://github.com/darinelguillen/fastapi-secure-api
- Owner: DarinelGuillen
- Created: 2024-11-25T19:41:51.000Z (27 days ago)
- Default Branch: main
- Last Pushed: 2024-12-03T19:49:48.000Z (19 days ago)
- Last Synced: 2024-12-03T20:33:56.583Z (19 days ago)
- Topics: api, asynchronous-programming, backend, crud, fastapi, google-drive, jwt, oauth2, python3, rest-api, scalable-architecture, skeleton, skeleton-application, uvicorn
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Project Documentation
## Overview
This API is built with **FastAPI** to manage authentication and perform operations with Google Drive. It includes login functionality, file listing from Google Drive, and uses JWT tokens for secure authentication.
---
## Requirements
- Python 3.11
- FastAPI
- Uvicorn
- Python-dotenv
- Google-auth libraries
---
## Installation
1. **Clone the Repository**:
```bash
git clone https://github.com/your-repo-name.git
cd api_project
```
2. **Create a Virtual Environment**:
```bash
python3.11 -m venv venv
.\venv\Scripts\Activate
```
3. **Install Dependencies**:
```bash
pip install -r requirements.txt
```
Or manually:
```bash
pip install fastapi uvicorn python-dotenv google-auth google-auth-oauthlib google-api-python-client
```
4. **Set Up Environment Variables**:
Create a `.env` file in the root directory with the following:
```
GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret
SECRET_KEY=your-secret-key
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=30
```
---
## Run the Application
Start the server using Uvicorn:
```bash
.\venv\Scripts\Activate
uvicorn app.main:app --reload
```
The API will be accessible at `http://localhost:8000`.
---
## Features
### Authentication
- **Login Endpoint**: `/auth/login`
- Accepts `username` and `password` using `OAuth2PasswordRequestForm`.
- Returns a JWT token.
### Google Drive Integration
- **Authorize**: `/drive/authorize`
- Redirects the user to the Google authentication page.
- **Callback**: `/drive/oauth2callback`
- Handles the OAuth2 callback.
- **List Files**: `/drive/files`
- Lists the user’s Google Drive files.
### Example Endpoint
- `/hello`: Returns a simple JSON response: `{"message": "Hello World"}`.
---
## Project Structure
```
api_project/
├── app/
│ ├── main.py # Entry point for the API
│ ├── core/
│ │ ├── config.py # Configuration and environment variables
│ │ ├── security.py # Security-related utilities
│ ├── models/
│ │ ├── user.py # User models
│ ├── routers/
│ │ ├── auth.py # Authentication routes
│ │ ├── drive.py # Google Drive routes
│ ├── schemas/
│ │ ├── user.py # Data validation for users
│ │ ├── drive.py # Data validation for Drive operations
│ ├── services/
│ │ ├── auth.py # Token generation and verification
│ │ ├── google_drive.py # Google Drive API interactions
│ ├── utils/
│ │ ├── helpers.py # Helper utilities
```
---
## Testing
- Access Swagger UI documentation: [http://localhost:8000/docs](http://localhost:8000/docs)
- Use ReDoc for API visualization: [http://localhost:8000/redoc](http://localhost:8000/redoc)