2017-02-18 19:57:45 +01:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
|
|
|
|
<html>
|
2020-07-22 07:36:06 +02:00
|
|
|
<head>
|
|
|
|
|
<title>URL Shortener</title>
|
2020-09-14 11:24:04 +02:00
|
|
|
<link
|
|
|
|
|
rel="shortcut icon"
|
|
|
|
|
href="https://cdn.hyperdev.com/us-east-1%3A52a203ff-088b-420f-81be-45bf559d01b1%2Ffavicon.ico"
|
|
|
|
|
type="image/x-icon"
|
|
|
|
|
/>
|
2020-07-22 07:36:06 +02:00
|
|
|
<link href="/public/style.css" rel="stylesheet" type="text/css" />
|
|
|
|
|
</head>
|
2017-02-18 19:57:45 +01:00
|
|
|
|
2020-07-22 07:36:06 +02:00
|
|
|
<body>
|
|
|
|
|
<div class="container">
|
|
|
|
|
<h2>API Project: URL Shortener Microservice</h2>
|
|
|
|
|
<h3>User Story:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
<li>
|
2020-09-14 11:34:31 +02:00
|
|
|
I can <code>POST</code> a URL to <code>[project_url]/api/shorturl/new</code> and I will receive a shortened URL in the JSON
|
2020-09-14 11:24:04 +02:00
|
|
|
response.<br />
|
2020-09-14 11:34:31 +02:00
|
|
|
Example: <code>{ "original_url": "www.google.com", "short_url": 1 }</code>
|
2020-09-14 11:24:04 +02:00
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
If I pass an invalid URL that doesn't follow the <code>http(s)://www.example.com(/more/routes)</code> format,
|
|
|
|
|
the JSON response will contain an error like <code>{ "error": "invalid URL" }</code><br />
|
|
|
|
|
HINT: To be sure that the submitted URL points to a valid site, you can use the function
|
|
|
|
|
<code>dns.lookup(host, cb)</code> from the <code>dns</code> core module.
|
2020-07-22 07:36:06 +02:00
|
|
|
</li>
|
|
|
|
|
<li>When I visit the shortened URL, it will redirect me to my original link.</li>
|
|
|
|
|
</ol>
|
2017-02-18 19:57:45 +01:00
|
|
|
|
2020-07-22 07:36:06 +02:00
|
|
|
<h3>Short URL Creation</h3>
|
2020-09-14 11:34:31 +02:00
|
|
|
<p>Example: <code>POST [project_url]/api/shorturl/new</code> - <code>https://www.google.com</code></p>
|
2020-07-22 07:36:06 +02:00
|
|
|
<form action="api/shorturl/new" method="POST">
|
|
|
|
|
<label for="url_input">URL to be shortened</label>
|
|
|
|
|
<input id="url_input" type="text" name="url" value="https://www.freecodecamp.org" />
|
|
|
|
|
<input type="submit" value="POST URL" />
|
|
|
|
|
</form>
|
|
|
|
|
<h3>Example Usage:</h3>
|
|
|
|
|
<a href="https://url-shortener.freecodecamp.repl.co/api/shorturl/3"> [this_project_url]/api/shorturl/3 </a>
|
2017-02-18 19:57:45 +01:00
|
|
|
|
2020-07-22 07:36:06 +02:00
|
|
|
<h3>Will Redirect to:</h3>
|
|
|
|
|
<p>https://forum.freecodecamp.org/</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="footer">
|
2020-09-14 11:34:31 +02:00
|
|
|
<p>By <a href="https://www.freecodecamp.org">freeCodeCamp</a></p>
|
2020-07-22 07:36:06 +02:00
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
