21BPS1465_Backend

This is a file sharing backend system implemented using Go, GORM, and Redis. It supports file uploads, retrieval, sharing, deletion, and search functionality. It also includes rate limiting and caching with Redis.

Table of Contents

• Getting Started
• Docker Setup
• API Endpoints
  • User Routes
  • File Routes
• Rate Limiting
• Caching

Getting Started

To get started with the project, follow these steps:

1. Clone the Repository:

   git clone https://github.com/Sovan22/21BPS1465_Backend.git
   cd 21BPS1465_Backend

2. Install Dependencies: Ensure you have Go and Redis installed. Then, run:

   go mod tidy

3. If not using Docker Remove comment os.Setenv("REDIS_URL", "localhost:6379") in func main of main.go

4. Run the Server:

   go run main.go

Docker Setup

To run the project using Docker and Docker Compose, follow these steps:

1. Ensure Docker and Docker Compose are installed.

2. Clone the Repository

   git clone https://github.com/Sovan22/21BPS1465_Backend.git
   cd 21BPS1465_Backend

3. Build and Run Docker Containers:

   docker-compose up --build

4. Access the Application: The application will be available at http://localhost:8080.

API Endpoints

User Routes

• Register a New User
  • Endpoint: POST /register
  • Description: Registers a new user.
  • Request Body:

    {
      "email": "user@example.com",
      "password": "password123"
    }

  • Responses:
    • 200 OK - Registration successful.
    • 400 Bad Request - Invalid input or email already registered.
    • 500 Internal Server Error - Server error.

• Login
  • Endpoint: POST /login
  • Description: Logs in a user and returns a JWT token.
  • Request Body:

    {
      "email": "user@example.com",
      "password": "password123"
    }

  • Responses:
    • 200 OK - Login successful with token.
    • 401 Unauthorized - Invalid credentials.
    • 500 Internal Server Error - Server error.

File Routes

• Upload File

  • Endpoint: POST /upload
  • Description: Uploads a file.
  • Request Body: Form data with file upload.
  • Responses:
    • 200 OK - File uploaded successfully.
    • 400 Bad Request - Failed to get file from request.
    • 500 Internal Server Error - Failed to save file or metadata.

• Get User Files

  • Endpoint: GET /files
  • Description: Retrieves a list of files uploaded by the authenticated user.
  • Responses:
    • 200 OK - Returns a list of files.
    • 500 Internal Server Error - Failed to retrieve files.

• Share File

  • Endpoint: GET /share/:fileID
  • Description: Generates a shareable link for a file.
  • Query Parameters:
    • fileID - ID of the file to share.
    • expiry - Expiry time for the shareable link (optional) "1h", "30m" ,"1h30m".
  • Responses:
    • 200 OK - Returns the shareable URL.
    • 400 Bad Request - Invalid file ID.
    • 404 Not Found - File not found.
    • 500 Internal Server Error - Server error.

• Delete File

  • Endpoint: GET /delete/:fileID
  • Description: Deletes a file by ID.
  • Query Parameters:
    • fileID - ID of the file to delete.
  • Responses:
    • 200 OK - File deleted successfully.
    • 400 Bad Request - Invalid file ID.
    • 404 Not Found - File not found.
    • 500 Internal Server Error - Failed to delete file.

• Search Files

  • Endpoint: GET /search
  • Description: Searches for files based on name, type, and uploaded date.
  • Query Parameters:
    • name - Partial name of the file.
    • type - Type of the file (e.g., pdf).
    • date - Uploaded date in format YYYY-MM-DD.
    • limit - Number of results to return (optional).
    • offset - Pagination offset (optional).
  • Responses:
    • 200 OK - Returns search results.
    • 400 Bad Request - Invalid date format.
    • 500 Internal Server Error - Failed to search files.

Rate Limiting

To prevent abuse, the API enforces rate limiting:

• Limit: 100 requests per user per minute.

Caching

• File Metadata Caching: Cached using Redis to reduce database load. The cache expires after 5 minutes.