urlshortener/README.md

22 lines
1.0 KiB
Markdown
Raw Normal View History

2017-02-18 19:57:45 +01:00
# API Project: URL Shortener Microservice for freeCodeCamp
[![Run on Repl.it](https://repl.it/badge/github/freeCodeCamp/boilerplate-project-urlshortener)](https://repl.it/github/freeCodeCamp/boilerplate-project-urlshortener)
2017-02-18 19:57:45 +01:00
### 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 [project_url]/api/shorturl/new - body (urlencoded) : url=https://www.google.com
#### Usage:
[this_project_url]/api/shorturl/3
#### Will redirect to:
https://www.freecodecamp.org/forum/