url-shortener

FastAPI URL Shortener

Application Overview

The main app is built in Python 3.9 using FastAPI and OpenTelemetry.

The storage is managed by a Redis container.

API Endopoints

The endpoints to administrate URLs are as follows:

Endpoint	Method	Description	Input	Output
/url	POST	To create shortened URLs.	The target URL.	The details of the shortened URL.
/info{code}	GET	To get shortened URL info.	The previously genereated code.	The details of the shortened URL.
/{code}	GET	Forward short URL to original URL.
/delete/{code}	DELETE	Delete (deactivate) the shortened URL by its code.

Execution

Requeriments:

• Python 3.9
• Docker Compose
• Postman (optional)

In order to forward from http://short.url to 0.0.0.0, set up the following host in the /etc/hosts file, like in Unix based systems:

## /etc/hosts
# Host Database
#
# localhost is used to configure the loopback interface
# when the system is booting.  Do not change this entry.
##
127.0.0.1       localhost
255.255.255.255 broadcasthost
::1             localhost
0.0.0.0         short.url

Then, run the application using docker compose command:

docker compose up --build --force-recreate

See the API documentation in the Swagger docs site or use the file postman_collection.json to import the Postman collection and test the API out.

Useful links (dockerized apps):

• Grafana
• Jaeger UI
• Prometheus