https://github.com/drex44/url-shortener-microservice

API Project: URL Shortener Microservice for freeCodeCamp
https://github.com/drex44/url-shortener-microservice

expressjs freecodecamp-project mongodb nodejs

Last synced: 3 days ago
JSON representation

API Project: URL Shortener Microservice for freeCodeCamp

• Host: GitHub
• URL: https://github.com/drex44/url-shortener-microservice
• Owner: drex44
• License: mit
• Created: 2018-08-11T06:09:52.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-16T11:02:17.000Z (over 5 years ago)
• Last Synced: 2024-01-16T16:49:50.366Z (10 months ago)
• Topics: expressjs, freecodecamp-project, mongodb, nodejs
• Language: JavaScript
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

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/xarLd

i.e. https://polar-flare.glitch.me/api/shorturl/xarLd

#### Will redirect to:

http://www.freecodecamp.com