diff --git a/index.html b/index.html index e2de8c2..254162b 100644 --- a/index.html +++ b/index.html @@ -8,14 +8,35 @@
-
+

Welcome to the Quotes APIs!

-

The available resources are:

-
    -
  • /random: returns a random quote.
    Try it!
  • -
  • /search?q=<query>: searches for quotes that matech a certain string (with fuzzy matching).
    Try it!
  • -
-
+

API Resources

+
+

/random

+

+ The /random endpoint returns a random quote from our database. +

+

Parameters

+

This endpoint does not take any parameter.

+

+ Try it! +

+
+
+
+

/search

+

+ The /search endpoint is used to search our database for quotes that match a certain string (with fuzzy matching). +

+

Parameters

+ +

+ Try it! +

+
+
\ No newline at end of file