freeCodeCamp.org-Back-End-Dev-and-APIs/urlshortener
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
680fb45533
urlshortener/README.md
Huyen Nguyen 7fed7e80e7 Fix: App API and freeCodeCamp URLs (#4) 
This PR:
- Changes `thread-paper.hyperdev.space` to `thread-paper.glitch.me`
- Changes `forum.freecodecamp.com` to `freecodecamp.org/forum/`
- Changes `freecodecamp.com` to `freecodecamp.org`
- Closes https://github.com/freeCodeCamp/freeCodeCamp/issues/17550
2019-03-18 19:54:14 +05:30

869 B
Raw Blame History

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:

https://www.freecodecamp.org/forum/