Movies API

🌍 Overview

The Movies API is a server-side application built with NestJS and TypeScript. It provides endpoints for managing movies, user favorites, authentication, and API keys. The API is designed with modular architecture, robust validation, and secure authentication mechanisms.

⚡ Features

• 🔐 Authentication: Secure login, registration, and token-based authentication.
• 🎬 Movies: Fetch popular, trending, top-rated, and upcoming movies from TMDB.
• 👾 Favorites: Manage user-specific favorite movies.
• 🔑 API Keys: Generate, validate, and manage API keys for external integrations.
• 📚 Swagger Documentation: Interactive API documentation.

🛠️ Tech Stack

The project is built using the following technologies:

• 🚀 TypeScript
• 🦸‍♂️ NestJS
• 🗄️ MongoDB
• 🐳 Docker
• 📚 Swagger

📚 API Documentation

🔐 Auth Endpoints

📍 POST /auth/login

Authenticate a user and return access and refresh tokens.

📥 Request Body

{
  "email": "user@mail.com",
  "password": "secure@pass123"
}

📤 Response

{
  "user": {
    "id": "123",
    "email": "user@mail.com",
    "name": "User"
  },
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

📍 POST /auth/register

Register a new user.

📥 Request Body

{
  "name": "User",
  "email": "user@mail.com",
  "password": "secure@pass123"
}

📤 Response

{
  "user": {
    "id": "123",
    "email": "user@mail.com",
    "name": "User"
  },
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

📍 POST /auth/refresh

Refresh the access token using a refresh token.

📥 Request Body

{
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

📤 Response

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

🎬 Movies Endpoints

📍 GET /movies/popular

Fetch popular movies from TMDB.

• Query Parameters: page (optional): Page number for pagination.

📤 Response

{
  "page": 1,
  "results": [
    {
      "id": 550,
      "title": "Fight Club",
      "overview": "A ticking-time-bomb insomniac...",
      "poster_path": "/poster.jpg",
      "release_date": "1999-10-15",
      "vote_average": 8.4
    }
  ],
  "total_results": 1000,
  "total_pages": 50
}

📍 GET /movies/trending

Fetch trending movies.

• Query Parameters: timeWindow (optional): day or week.

📤 Response

{
  "page": 1,
  "results": [
    {
      "id": 550,
      "title": "Fight Club",
      "overview": "A ticking-time-bomb insomniac...",
      "poster_path": "/poster.jpg",
      "release_date": "1999-10-15",
      "vote_average": 8.4
    }
  ],
  "total_results": 1000,
  "total_pages": 50
}

📍 GET /movies/:id

Fetch detailed information about a movie.

• Path Parameters: id: TMDB Movie ID.

📤 Response

{
  "id": 550,
  "title": "Fight Club",
  "overview": "A ticking-time-bomb insomniac...",
  "poster_path": "/poster.jpg",
  "release_date": "1999-10-15",
  "vote_average": 8.4,
  "genres": [{"id": 18, "name": "Drama"}]
}

👾 Favorites Endpoints

📍 POST /favorites

Add a movie to favorites.

📥 Request Body

{
  "movieId": "550"
}

📤 Response

{
  "id": "123",
  "movieId": "550",
  "title": "Fight Club",
  "description": "A ticking-time-bomb insomniac...",
  "releaseDate": "1999-10-15",
  "tmdbRating": 8.4
}

📍 GET /favorites

Fetch all favorites for the authenticated user.

• Query Parameters: page (optional): Page number for pagination. limit (optional): Number of items per page.

📤 Response

{
  "results": [
    {
      "id": "123",
      "movieId": "550",
      "title": "Fight Club",
      "description": "A ticking-time-bomb insomniac...",
      "releaseDate": "1999-10-15",
      "tmdbRating": 8.4
    }
  ],
  "total": 10,
  "page": 1,
  "limit": 10
}

🔑 API Keys Endpoints

📍 POST /api-keys

Generate a new API key.

📥 Request Body

{
  "description": "Mobile application integration",
  "expiresInDays": 30
}

📤 Response

{
  "id": "123",
  "key": "abcd1234-5678-efgh-ijkl-9876543210mn",
  "description": "Mobile application integration",
  "expiresAt": "2025-12-31T23:59:59Z",
  "createdAt": "2025-07-01T12:00:00Z"
}

📍 GET /api-keys

Fetch all API keys (Admin only).

📤 Response

[
  {
    "id": "123",
    "description": "Mobile application integration",
    "expiresAt": "2025-12-31T23:59:59Z",
    "createdAt": "2025-07-01T12:00:00Z",
    "isActive": true,
    "usageCount": 10
  }
]