Added API Documentation

This commit is contained in:
Timothy Rogers 2021-08-31 17:46:50 -04:00
parent 040acb45ac
commit 2c314f44ba

71
content/api.md Normal file
View file

@ -0,0 +1,71 @@
---
title: "Projects"
menu:
main:
weight: 30
---
# API Reference
{{< rawhtml >}}
<div class="container">
<div class="accordion" id="accordionExample">
<div class="card">
<div class="card-header" id="headingOne">
<h2 class="mb-0">
<button class="btn btn-link btn-block text-left" type="button" data-toggle="collapse" data-target="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
LastFM - For NeosVR
</button>
</h2>
</div>
<div id="collapseOne" class="collapse show" aria-labelledby="headingOne" data-parent="#accordionExample">
<div class="card-body">
<strong>URI:</strong> <code>https://api.hack13.dev/lastfm/?username=<i>your-lastfm-username</i></code>
<br />
<strong>Example Response:</strong>
<pre><code>
All The Things,Gaullin,https://www.last.fm/music/Gaullin/_/All+The+Things,true
</code></pre>
<strong>Response Breakdown:</strong>
<pre><code>
<i>Song Name</i>,<i>Artist Name</i>,<i>LastFM Song Page Link</i>,<i>Now Playing</i>
</code></pre>
<ul>
<li>Song Name <span class="badge badge-info">String</span></li>
<li>Artist Name <span class="badge badge-info">String</span></li>
<li>Song <span class="badge badge-info">String/URL</span></li>
<li>Song Name <span class="badge badge-info">Bool</span></li>
</ul>
</div>
</div>
</div>
<div class="card">
<div class="card-header" id="headingTwo">
<h2 class="mb-0">
<button class="btn btn-link btn-block text-left collapsed" type="button" data-toggle="collapse" data-target="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
Coming Soon ...
</button>
</h2>
</div>
<div id="collapseTwo" class="collapse" aria-labelledby="headingTwo" data-parent="#accordionExample">
<div class="card-body">
Nothing here yet...
</div>
</div>
</div>
<div class="card">
<div class="card-header" id="headingThree">
<h2 class="mb-0">
<button class="btn btn-link btn-block text-left collapsed" type="button" data-toggle="collapse" data-target="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
Coming Soon ...
</button>
</h2>
</div>
<div id="collapseThree" class="collapse" aria-labelledby="headingThree" data-parent="#accordionExample">
<div class="card-body">
Nothing here yet...
</div>
</div>
</div>
</div>
</div>
{{< /rawhtml >}}