Skip to content
This repository was archived by the owner on Sep 19, 2024. It is now read-only.

Refactored API playground #2

Open
mmarcon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refactored API playground #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,35 @@
</head>
<body>
<div class="container mt-1">
<section class="content">
<main class="content">
<h1>Welcome to the Quotes APIs!</h1>
<p>The available resources are:</p>
<uL>
<li class="mb-3"><code>/random</code>: returns a random quote.<br><a class="btn btn-primary" href="/random">Try it!</a></li>
<li><code>/search?q=&lt;query&gt;</code>: searches for quotes that matech a certain string (with fuzzy matching).<br><a class="btn btn-primary" href="/search?q=friend">Try it!</a></li>
</uL>
</section>
<h2>API Resources</h2>
<section>
<h3><code>/random</code></h3>
<p>
The <code>/random</code> endpoint returns a random quote from our database.
</p>
<h4>Parameters</h4>
<p>This endpoint does not take any parameter.</p>
<p>
<a class="btn btn-primary" href="/random">Try it!</a>
</p>
</section>
<hr>
<section>
<h3><code>/search</code></h3>
<p>
The <code>/search</code> endpoint is used to search our database for quotes that match a certain string (with fuzzy matching).
</p>
<h4>Parameters</h4>
<ul>
<li><code>q</code>: the string to search.</li>
</ul>
<p>
<a class="btn btn-primary" href="/search?q=friend">Try it!</a>
</p>
</section>
</main>
</div>
</body>
</html>