freeCodeCamp.org-Back-End-Dev-and-APIs/urlshortener
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: sync README.md user stories with pr #39311

Browse Source
This commit is contained in:
Kris Koishigawa 2020-09-18 18:07:33 +09:00
parent 80cf6ebb27
commit b6e493db53
1 changed files with 4 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -4,19 +4,7 @@
### 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/
1. You should provide your own project, not the example URL.
2. You can POST a URL to `/api/shorturl/new` and get a JSON response with the property names `original_url` and `short_url` and the expected values for each.
3. When you visit `/api/shorturl/<short_url>`, you will be redirected to the original URL.
4. If you pass an invalid URL that doesn't follow the valid `http://www.example.com` format, the JSON response will contain `{ 'error': 'invalid url' }`.