freifunk-franken
/
monitoring
mirror of https://github.com/FreifunkFranken/fff-monitoring.git
3
0
Fork 0
Code Issues Releases Wiki Activity

Add explanation page for API functions 

Signed-off-by: Adrian Schmutzler <freifunk@adrianschmutzler.de>

Tested-by: Adrian Schmutzler <freifunk@adrianschmutzler.de>
This commit is contained in:
Adrian Schmutzler 2017-08-18 15:50:31 +02:00
parent ff544a4252
commit bd855abd0d
3 changed files with 105 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ffmap/web/application.py
View File

@ -33,6 +33,10 @@ tileurls = {
def index():
return render_template("index.html")
@app.route('/apidoc')
def apidoc():
return render_template("apidoc.html")
@app.route('/map')
def router_map():
return render_template("map.html", tileurls=tileurls)

100
ffmap/web/templates/apidoc.html Normal file
View File

@ -0,0 +1,100 @@
{% extends "bootstrap.html" %}
{% block title %}{{super()}} :: API Guide{% endblock %}
{% block head %}{{super()}}
<style type="text/css">
.jumbotron h1 {
font-size:30px;
font-weight:bold;
margin-top:16px;
margin-bottom:40px;
}
.jumbotron h2 {
font-size:18px;
font-weight:bold;
font-style:italic;
margin:6px 0;
}
.jumbotron p {
font-size:16px;
margin:6px 0;
}
.jumbotron td {
padding:10px 20px;
vertical-align:top;
}
.jumbotron th {
padding:10px 20px;
font-size:18px;
}
.jumbotron .apilink {
font-weight: bold;
font-style: normal;
white-space: pre;
font-family: monospace;
}
.jumbotron .apidesc {
font-weight: normal;
}
.jumbotron .uneven {
background-color:#FFFFFF;
}
</style>
{% endblock %}
{% block content %}
<div class="jumbotron">
<h1>Freifunk Franken Monitoring - API Guide</h1>
<table>
<tr>
<th style="width:240px">Function</th>
<th>Details</th>
</tr>
<tr class="uneven">
<td>
<h2>Nearest router</h2>
</td>
<td>
<p class="apilink">/api/get_nearest_router?lat=&lt;latitude&gt;&amp;lng=&lt;longitude&gt;</p>
<p class="apidesc">Returns JSON file with basic data of router next to coordinates.</p>
</td>
</tr>
<tr>
<td>
<h2>Router by mac address</h2>
</td>
<td>
<p class="apilink">/api/get_router_by_mac/&lt;mac_with_colon_separators&gt;</p>
<p class="apidesc">Redirects to router page.</p>
</td>
</tr>
<tr class="uneven">
<td>
<h2>Nodelist based on FF Ansbach scheme</h2>
</td>
<td>
<p class="apilink">/api/nodelist</p>
<p class="apidesc">Returns JSON file of all routers based on scheme of FF Ansbach (<a href="https://github.com/ffansbach/de-map/blob/master/schema/nodelist-schema-1.0.0.json">GitHub</a>).</p>
<p class="apidesc">This includes the following information: <span style="font-style:italic">Monitoring ID, hostname, Monitoring Link, on/off, clients, last contact and coordinates.</span></p>
</td>
</tr>
<tr>
<td>
<h2>Extended router list</h2>
</td>
<td>
<p class="apilink">/api/routers</p>
<p class="apidesc">Returns JSON file of all routers with the following information: <span style="font-style:italic">Monitoring ID, hostname, MAC address, hood, status, user nickname, hardware, firmware, Monitoring link, clients, last contact, uplink interfaces and coordinates.</span></p>
</td>
</tr>
<tr class="uneven">
<td>
<h2>Wifi Analyzer node list</h2>
</td>
<td>
<p class="apilink">/api/wifianal/&lt;hood&gt;</p>
<p class="apidesc">Returns configuration file (text/plain) for the Wifi Analyzer app (<a href="https://play.google.com/store/apps/details?id=com.farproc.wifi.analyzer&hl=en">PlayStore</a>).</p>
<p class="apidesc">The file contains all routers of the selected &lt;hood&gt;.</p>
</td>
</tr>
</table>
</div>
{% endblock %}

1
ffmap/web/templates/bootstrap.html
View File

@ -38,6 +38,7 @@
(["router_list", "router_info"], "Routers"),
(["user_list", "user_info"], "Users"),
(["global_statistics"], "Statistics"),
(["apidoc"], "API"),
] %}
<li class="{{ "active" if request.endpoint in fkt }}"><a href="{{ url_for(fkt[0]) }}">{{ text }}</a></li>
{%- endfor %}