A URL Shortener Service project for recreation/demo purposes.

This project has the following technological stack:

• Programming language: Kotlin
• Server Framework(s) / Application(s):
  • Vert.x: reactive toolkit for the JVM
  • RxJava: asynchronous behavior composition library for the JVM
  • Redis: key-value store
• Deployment: Docker & Docker-Compose

Accepts an application/json payload in the body that shall contain a field named url with the value containing the url that shall be shortened.

Replies with a 200 OK status and a application/json payload with a single field named key with the key that shall be used as a shortcut for the provided url, if everything went OK, otherwise a 500 Internal Server Error is returned.

Replies with either a 404 Not Found if the provided key is not found or with 307 Temporary Redirect with the actual url in the Location header.

Deletes the entry associated with the given key. Replies with a 200 OK if everything goes smoothly, otherwise a 500 Internal Server Error is returned.

Simply copy the docker-compose.yml file (the image will be pulled from DockerHub) and run docker-compose up. The Rest API shall be available at port 80.

You can also clone the repository, ./gradlew build and use the docker-compose.yml file to target the local Dockerfile instead of the (remote) image.

Examples rely on the awesome httpie HTTP client.

 $ http http://localhost/test
HTTP/1.1 404 Not Found
Content-Length: 9
Not Found

 $ http post http://localhost/shorten url=https://youtube.com
HTTP/1.1 200 OK
Content-Length: 12
{"key":"Dl"}

 $ http http://localhost/Dl
HTTP/1.1 307 Temporary Redirect
Content-Length: 0
Location: https://youtube.com

 $ http delete http://localhost/Dl
HTTP/1.1 200 OK
Content-Length: 0