URL Shortening Service

Overview

The URL shortening service is used to shorten long URLs. There may be a requirement when we want to avoid sending very long URLs to the user via SMS, WhatsApp etc. This service compresses the URL.

Pre-requisites

Before you proceed with the configuration, make sure the following pre-requisites are met -

1. Prior knowledge of Java/J2EE

2. Prior knowledge of SpringBoot

3. Prior knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.

Key Functionalities

1. Compress long URLs

2. Converted short URLs contain id, which is used by this service to identify and get longer URLs.

Environment Variable	Description
host.name	Host name to append in short URL
db.persistance.enabled	The boolean flag stores the short URL in the database when the flag is set as TRUE.

Deployment Details

• Deploy the latest version of the URL Shortening service

API Details

a) POST /egov-url-shortening/shortener

Receive long URLs and converts them to shorter URLs. Shortened URLs contain URLs to the endpoint mentioned next. When a user clicks on shortened URL, the user is redirected to a long URL.

b) GET /{id}

This shortened URL contains the path to this endpoint. The service uses the id used in the last endpoint to get the long URL. In response, the user is redirected to the long URL.

Reference Docs

Doc Links

Title
Swagger API Contract
URL Shortening Local Setup