Files API

A Node.js REST API for managing file uploads, storage, and categorization using AWS S3 and PostgreSQL.

🚀 Features

• File Upload & Storage: Upload files to AWS S3 with automatic URL generation
• File Management: CRUD operations for files with metadata
• Category Management: Organize files by categories
• Database Integration: PostgreSQL with Prisma ORM
• Cloud Storage: AWS S3 integration for scalable file storage
• RESTful API: Clean REST endpoints for all operations

📋 Prerequisites

• Node.js (v14 or higher)
• PostgreSQL database
• AWS S3 bucket
• AWS credentials (Access Key ID and Secret Access Key)

🛠️ Installation

1. Clone the repository

   git clone <repository-url>
   cd Files_API

2. Install dependencies

   npm install

3. Set up environment variables Create a .env file in the root directory:

   # Database Configuration
   DATABASE_URL="postgresql://username:password@localhost:5432/database_name"
   
   # Server Configuration
   PORT=8090
   
   # AWS S3 Configuration
   AWS_ACCESS_KEY=your_aws_access_key_here
   AWS_SECRET_ACCESS_KEY=your_aws_secret_access_key_here
   AWS_REGION=your_aws_region_here
   AWS_S3_BUCKET_NAME=your_bucket_name_here
   
   # Optional: Custom S3 endpoint (for S3-compatible services)
   # AWS_S3_ENDPOINT=https://s3.amazonaws.com
   
   # JWT Configuration (if using authentication)
   JWT_ACCESS_SECRET=your_jwt_access_secret
   JWT_REFRESH_SECRET=your_jwt_refresh_secret
   ACCESS_TOKEN_AGE=15m
   REFRESH_TOKEN_AGE=7d

4. Set up the database

   # Generate Prisma client
   npx prisma generate
   
   # Run database migrations
   npx prisma migrate dev --name init

5. Start the server

   npm start

The server will start on http://localhost:8090

📚 API Endpoints

Files Management

Upload File

POST /files/upload
Content-Type: multipart/form-data

Body:
- file: (file) - The file to upload (PDF only)
- file: (JSON string) - File metadata
  {
    "description": "File description",
    "user_id": "user123",
    "category_id": "cat456"
  }

Note: Only one file per user is allowed. Uploading a new file will replace the existing one.

Get All Files

GET /files/get-all?role=ADMINISTRATOR

Query Parameters:

• role (required): Must be "ADMINISTRATOR" or "PROFESSOR"

Get File by ID

GET /files/get?file_id=file123&role=ADMINISTRATOR

Query Parameters:

• file_id (required): The ID of the file to retrieve
• role (required): Must be "ADMINISTRATOR" or "PROFESSOR"

Get Files by User ID

GET /files/get-user-id?user_id=user123

Query Parameters:

• user_id (required): The ID of the user whose files to retrieve

Update File

PUT /files/update
Content-Type: multipart/form-data

Body:
- file: (file, optional) - New file to replace existing
- file: (JSON string) - Updated file metadata
  {
    "user_id": "user123",
    "description": "Updated description",
    "category_id": "cat789"
  }

Delete File

DELETE /files/delete?user_id=user123&file_id=file123

Query Parameters:

• user_id (required): The ID of the user who owns the file
• file_id (required): The ID of the file to delete

Categories Management

Create Category

POST /category/create
Content-Type: application/json

{
  "category": {
    "name": "Category Name",
    "description": "Category description (optional)"
  },
  "role": "ADMINISTRATOR"
}

Note: Only users with ADMINISTRATOR role can create categories.

Get All Categories

GET /category/get-all

Update Category

PUT /category/update
Content-Type: application/json

{
  "category": {
    "id": "cat123",
    "name": "Updated Category Name",
    "description": "Updated description"
  },
  "role": "ADMINISTRATOR"
}

Note: Only users with ADMINISTRATOR role can update categories.

Delete Category

DELETE /category/delete?id=cat123&role=ADMINISTRATOR

Query Parameters:

• id (required): The ID of the category to delete
• role (required): Must be "ADMINISTRATOR"

Note: Only users with ADMINISTRATOR role can delete categories.

🗄️ Database Schema

Files Table

model Files {
  id          String    @id @default(cuid())
  url         String    @db.VarChar(500)
  description String?   @db.VarChar(255)
  user_id     String    @db.VarChar(255)
  category_id String    @db.VarChar(255)
  created_at  DateTime  @default(now())
  updated_at  DateTime  @updatedAt

  category    Categories  @relation(fields: [category_id], references: [id], onDelete: Cascade)
}

Categories Table

model Categories {
  id          String    @id @default(cuid())
  name        String    @db.VarChar(50)
  description String?   @db.VarChar(255)
  created_at  DateTime  @default(now())
  updated_at  DateTime  @updatedAt

  files Files[]
}

🔧 Configuration

AWS S3 Setup

1. Create an S3 bucket in your AWS account
2. Configure bucket permissions for public read access (if needed)
3. Create IAM user with S3 permissions
4. Get access credentials and add them to your .env file

Database Setup

1. Create PostgreSQL database
2. Update DATABASE_URL in your .env file
3. Run migrations to create tables

📁 Project Structure

Files_API/
├── src/
│   ├── controllers/          # Request handlers
│   │   ├── files/           # File-related controllers
│   │   └── category/        # Category-related controllers
│   ├── services/            # Business logic
│   │   ├── files/           # File services
│   │   └── category/        # Category services
│   ├── routes/              # API routes
│   ├── lib/                 # Utility libraries
│   │   ├── files/           # File handling utilities
│   │   ├── prisma/          # Database connection
│   │   └── errors/          # Error handling
│   └── routes/              # Route definitions
├── prisma/                  # Database schema and migrations
├── index.js                 # Application entry point
└── package.json

🚀 Usage Examples

Upload a File

curl -X POST http://localhost:8090/files/upload \
  -F "file=@document.pdf" \
  -F 'file={"description":"My thesis document","user_id":"user123","category_id":"cat456"}'

Get All Files

curl "http://localhost:8090/files/get-all?role=ADMINISTRATOR"

Get File by ID

curl "http://localhost:8090/files/get?file_id=file123&role=ADMINISTRATOR"

Get Files by User ID

curl "http://localhost:8090/files/get-user-id?user_id=user123"

Update a File

curl -X PUT http://localhost:8090/files/update \
  -F "file=@updated_document.pdf" \
  -F 'file={"user_id":"user123","description":"Updated thesis document","category_id":"cat789"}'

Delete a File

curl -X DELETE "http://localhost:8090/files/delete?user_id=user123&file_id=file123"

Create a Category

curl -X POST http://localhost:8090/category/create \
  -H "Content-Type: application/json" \
  -d '{"category":{"name":"Computer Science","description":"CS related documents"},"role":"ADMINISTRATOR"}'

Get All Categories

curl "http://localhost:8090/category/get-all"

Update a Category

curl -X PUT http://localhost:8090/category/update \
  -H "Content-Type: application/json" \
  -d '{"category":{"id":"cat123","name":"Updated Computer Science","description":"Updated CS documents"},"role":"ADMINISTRATOR"}'

Delete a Category

curl -X DELETE "http://localhost:8090/category/delete?id=cat123&role=ADMINISTRATOR"

🔒 Security Notes

• Environment Variables: Never commit your .env file
• AWS Credentials: Use IAM roles with minimal required permissions
• File Validation: Implement file type and size validation as needed
• Access Control: Add authentication middleware for production use

🐛 Troubleshooting

Common Issues

1. Database Connection Error

   • Check your DATABASE_URL in .env
   • Ensure PostgreSQL is running
   • Run npx prisma generate and npx prisma migrate dev

2. S3 Upload Error

   • Verify AWS credentials in .env
   • Check bucket name and region
   • Ensure bucket permissions are correct

3. Port Already in Use

   • Change PORT in .env file
   • Or kill the process using port 8090

📝 License

This project is licensed under the ISC License.

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request

📞 Support

For support and questions, please open an issue in the repository.