Add api and usage page

2022-11-04 00:03:33 -04:00
parent e96329ac03
commit f4830694d4
6 changed files with 157 additions and 20 deletions
--- a/api-usage.html
+++ b/api-usage.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>API Usage</title>
+  <link rel="stylesheet" href="style.css">
+</head>
+<body>
+  <div class="api-container">
+    <h2>API Usage</h2>
+    <div class="text">
+
+      <p>Parameters</p>
+      <ol>
+        <li>Binary: <code>binary</code></li>
+        <li>Decimal: <code>decimal</code></li>
+        <li>Hexadecimal: <code>hexadecimal</code></li>
+      </ol>
+
+      <p>Usage and Response</p>
+      <ol class="no-dots">
+        <li>GET request to <code>https://dev.nevets.tech/calculator/hexdecbin/api.php?(parameter)=(value)</code></li>
+        <li>API responds with a json string similar to below</li>
+        <pre>
+          {
+            "binary":1101011,
+            "decimal":107,
+            "hexadecimal":"6B"
+          }
+        </pre>
+        <li><b>Reminder: </b>Only use one parameter, more than one will return a 422 error!</li>
+      </ol>
+    </div>
+  </div>
+</body>
+</html>