From 680fb45533f65def908a0218b2ff9b3f924f6cca Mon Sep 17 00:00:00 2001 From: shubhneet182 <44540772+shubhneet182@users.noreply.github.com> Date: Tue, 1 Oct 2019 23:36:13 +0530 Subject: [PATCH] Added Node.js documentation +Doc Improvements Adding Node.js documentation link for beginners, fix grammatical error, spacing and highlighting some keywords. --- views/index.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/views/index.html b/views/index.html index 4681b0b..ed7d471 100644 --- a/views/index.html +++ b/views/index.html @@ -14,10 +14,10 @@

API Project: URL Shortener Microservice

User Story:

    -
  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. -
  2. If I pass an invalid URL that doesn't follow the 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. -
  3. When I visit the shortened URL, it will redirect me to my original link.
    4. +
  4. 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}


    5. +
  5. If I pass an invalid URL that doesn't follow the 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. Incase you are new to NodeJs, you can learn about this function from its documentation.(NodeJs Documentation)


    6. +
  6. When I visit the shortened URL, it will redirect me to my original link.

Short URL Creation

@@ -45,4 +45,4 @@ - \ No newline at end of file +