https://github.com/flexyledger/url-shortener-microservice
https://github.com/flexyledger/url-shortener-microservice
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/flexyledger/url-shortener-microservice
- Owner: flexyledger
- Created: 2018-10-27T09:23:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-27T09:24:20.000Z (over 6 years ago)
- Last Synced: 2024-02-01T21:26:39.218Z (over 1 year ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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 [project_url]/api/shorturl/new - body (urlencoded) : url=https://www.google.com
#### Usage:
[this_project_url]/api/shorturl/3
#### Will redirect to:
http://forum.freecodecamp.com