1. API Definition

Overview

This API provides a URL shortening service where users can generate tiny URLs and be redirected to the original URLs.

Endpoints

1. Create Tiny URL

• Request:

POST /urls
Content-Type: application/json

{
  "originalUrl": "https://example.com"
}

• Response(Success):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "tinyUrl": "https://short.ly/abc123"
}

• Response(Error):
• In case of an invalid request (e.g., missing or malformed originalUrl), the API will return an error response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "tinyUrl": null,
  "error": "Invalid URL format"
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "tinyUrl": null,
  "error": "Server error, please try again later"
}

2. Redirect to Original URL

• Request:

GET /{tinyUrl}

• Response(Success):

HTTP/1.1 301 Moved Permanently
Location: https://example.com

• Response(Error):

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": "Tiny URL not found"
}

2. Sequence Diagram

sequenceDiagram
    participant C as Client
    participant API as API Server
    participant Cache as Cache Server
    participant DB as Database
    
    %% URL Creation Scenario
    rect rgb(240, 240, 240)
    Note over C,DB: URL Creation Scenario
    C->>+API: POST /url (Send original URL)
    API->>API: Validate URL
    API->>API: Generate shortened URL hash
    API->>+DB: Store original URL and shortened URL
    DB-->>-API: Storage complete
    API->>+Cache: Store shortened URL mapping in cache
    Cache-->>-API: Cache storage complete
    API-->>-C: Return generated shortened URL
    end
    
    %% URL Redirect Scenario
    rect rgb(240, 240, 240)
    Note over C,DB: URL Redirect Scenario
    C->>+API: GET /tiny-url-hash
    API->>+Cache: Look up shortened URL
    alt Cache hit
        Cache-->>API: Return original URL
    else Cache miss
        Cache-->>API: Cache Miss
        API->>+DB: Query original URL from DB
        DB-->>-API: Return original URL
        API->>Cache: Update cache
    end
    API-->>-C: 301/302 Redirect (to original URL)
    end

Loading

3. Running the Server Locally

1. Clone the repository:

   git clone https://github.com/devmanta/tiny-url.git
   

2. Navigate to the root directory of the cloned repository:

   cd tiny-url # Example
   

3. Start the server with Docker Compose:

   docker-compose up -d
   

4. To stop the server, run:

   docker-compose down