https://github.com/davidafsilva/kussx

Kotlin URL Shortener Service built with Vert.x
https://github.com/davidafsilva/kussx

Last synced: 8 days ago
JSON representation

Kotlin URL Shortener Service built with Vert.x

• Host: GitHub
• URL: https://github.com/davidafsilva/kussx
• Owner: davidafsilva
• License: mit
• Created: 2017-10-04T18:04:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-07T11:46:56.000Z (over 7 years ago)
• Last Synced: 2024-11-16T04:41:47.518Z (2 months ago)
• Language: Kotlin
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kussx

A URL Shortener Service project for recreation/demo purposes.

This project has the following technological stack:

* Programming language: [Kotlin](https://kotlinlang.org)

* Server Framework(s) / Application(s): 

  * [Vert.x](http://vertx.io): reactive toolkit for the JVM 

  * [RxJava](https://github.com/ReactiveX/RxJava): asynchronous behavior composition library for the JVM 

  * [Redis](https://redis.io): key-value store

* Deployment: [Docker & Docker-Compose](https://docker.com)

## Rest API

##### `POST /shorten`

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.

##### `GET /:key`

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. 

##### `DELETE /:key`

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.

## Try it out

Simply copy the [docker-compose.yml](https://github.com/davidafsilva/kussx/blob/master/docker-compose.yml) file 

(the image will be pulled from [DockerHub](https://hub.docker.com/r/davidafsilva/kussx/)) 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

Examples rely on the awesome [httpie](https://httpie.org/) HTTP client.

```shell

 $ 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

```