puppy-api-docs
Version:
Genernate material api docs from your comments.
23 lines • 3.17 kB
HTML
<html><head><title>Documentation</title><link rel="stylesheet"href="https://cdnjs.cloudflare.com/ajax/libs/materialize/1.0.0/css/materialize.min.css"><link rel="stylesheet"href="css/doc_page.css"><script src="https://cdnjs.cloudflare.com/ajax/libs/materialize/1.0.0/js/materialize.min.js"></script></head><body><div class="container"><div class="group-title">Authentication</div><ul class="doc-group collapsible"><li><div class="collapsible-header"><span class="header-title">Login</span><span class="header-path">(/login)</span></div><div class="doc-item collapsible-body"><p class="heading"id="Login-POST-/login">Login</p><p><pre class="method">(POST)</pre></p><p>Login with email and password for consumers and admins.</p><p class="url-path">/login</p><p class="sub-heading">Request</p><pre class="json-code">{
"data": {
"email": "User's email",
"password": "User's Password"
}
}</pre><p class="sub-heading">Response</p><pre class="json-code">{
"status": 200,
"message": "Help message depending on success",
"success": false
}</pre><p class="sub-heading">Request Headers</p><table><tr><th>Name</th><th>Description</th></tr><tr><td>Content-Type</td><td>application/json</td></tr></table><p class="sub-heading">Response Headers</p><table><tr><th>Name</th><th>Description</th></tr><tr><td>token</td><td>session token</td></tr></table></div></li><li><div class="collapsible-header"><span class="header-title">Login 2nd</span><span class="header-path">(/loginAlternate)</span></div><div class="doc-item collapsible-body"><p class="heading"id="Login 2nd-POST-/loginAlternate">Login 2nd</p><p><pre class="method">(POST)</pre></p><p>If /login doesn't work. Use this end point.</p><p class="url-path">/loginAlternate</p></div></li></ul><div class="group-title">API's</div><ul class="doc-group collapsible"><li><div class="collapsible-header"><span class="header-title">Get todo list</span><span class="header-path">(/todolist)</span></div><div class="doc-item collapsible-body"><p class="heading"id="Get todo list-GET-/todolist">Get todo list</p><p><pre class="method">(GET)</pre></p><p>Login with email and password for consumers and admins.</p><p class="url-path">/todolist</p><p class="sub-heading">Request</p><pre class="json-code">{
"data": {
"email": "User's email",
"password": "User's Password"
}
}</pre><p class="sub-heading">Response</p><pre class="json-code">{
"status": 200,
"message": "Help message depending on success",
"success": true
}</pre><p class="sub-heading">Request Headers</p><table><tr><th>Name</th><th>Description</th></tr><tr><td>token</td><td>token provided in login response</td></tr></table></div></li></ul></div><script>// Initialize Materializecss collapsilbe
document.addEventListener('DOMContentLoaded', function () {
var elems = document.querySelectorAll('.collapsible');
var instances = M.Collapsible.init(elems);
});</script></body></html>