Requirements
Functional Requirements:
- Create a short URL for a given long URL.
- Return the long URL associated with a given short URL.
Non-Functional Requirements:
- List the key non-functional requirements (eg low latency, scalability, reliability, etc.)...
API Design
Define the APIs expected from the system. This is your chance to analyze and define the read and write paths so that you can come up with the high-level design...
POST /urls
penapi: 3.0.0
info:
title: URL Shortener API
version: 1.0.0
paths:
/urls:
post:
summary: Create short URL
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
originalUrl:
type: string
responses:
'201':
description: URL created successfully
/{shortCode}:
get:
summary: Redirect to original URL
parameters:
- name: shortCode
in: path
required: true
schema:
type: string
responses:
'302':
description: Redirect
High-Level Design
Describe the overall system architecture. Identify the main components needed to solve the problem end-to-end. Use the diagramming tool to create a block diagram.
Detailed Component Design
Deep dive into 2-3 key components. Explain how they work, how they scale, discuss tradeoffs, capacity, and any relevant algorithms or data structures.