An open API service indexing awesome lists of open source software.

https://github.com/timhagn/th-fcc-shorturl

fCC - Apis and Microservices Projects - URL Shortener Microservice
https://github.com/timhagn/th-fcc-shorturl

Last synced: about 2 months ago
JSON representation

fCC - Apis and Microservices Projects - URL Shortener Microservice

Awesome Lists containing this project

README

        

# API Project: URL Shortener Microservice for freeCodeCamp

### User Stories

1. I can POST a URL to `[project_url]/api/shorturl/new` and I will receive a shortened URL in the JSON response. Example : `{"original_url":"www.google.com","short_url":1}`
2. If I pass an invalid URL that doesn't follow the valid `http(s)://www.example.com(/more/routes)` format, the JSON response will contain an error like `{"error":"invalid URL"}`. *HINT*: to be sure that the submitted url points to a valid site you can use the function `dns.lookup(host, cb)` from the `dns` core module.
3. When I visit the shortened URL, it will redirect me to my original link.

#### Creation Example:

POST https://th-fcc-su.glitch.me/api/shorturl/new - body (urlencoded) : url=https://www.google.com

#### Usage:

https://th-fcc-su.glitch.me/api/shorturl/1

#### Will redirect to:

http://forum.freecodecamp.com