Mirrors/wireguard_webadmin
1
0
Fork 0
mirror of https://github.com/eduardogsilva/wireguard_webadmin.git synced 2026-02-19 19:26:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Enhance API documentation: format example output and add curl command examples

Browse Source
This commit is contained in:
Eduardo Silva
2026-02-11 17:47:34 -03:00
parent d3c02a46c8
commit bd1dddbaab
2 changed files with 25 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
api_v2/views.py
View File

@@ -1,3 +1,4 @@
import json
import uuid as uuid_lib
from django.contrib import messages
@@ -116,6 +117,23 @@ def view_api_docs(request):
doc_data = view_func.api_doc.copy()
doc_data['url_pattern'] = str(pattern.pattern)
doc_data['name'] = pattern.name
# Convert examples to curl commands
if 'examples' in doc_data:
curl_examples = {}
for key, example in doc_data['examples'].items():
method = example.get('method', 'POST')
body = example.get('json', {})
url = f"https://your-server/api/v2/{doc_data['url_pattern']}"
curl_cmd = f"curl -X {method} {url} \\\n"
curl_cmd += " -H 'token: <YOUR_API_TOKEN>' \\\n"
curl_cmd += " -H 'Content-Type: application/json' \\\n"
curl_cmd += f" -d '{json.dumps(body, indent=4)}'"
curl_examples[key] = curl_cmd
doc_data['examples'] = curl_examples
docs.append(doc_data)
context = {

11
templates/api_v2/api_documentation.html
View File

@@ -67,7 +67,10 @@
<td>
{{ param.description }}
{% if param.example %}
<br><small class="text-muted">{% trans 'Example' %}: {{ param.example }}</small>
<br>
<small class="text-muted">
{% trans 'Example' %}: {{ param.example }}
</small>
{% endif %}
</td>
</tr>
@@ -112,7 +115,7 @@
<div class="card bg-light mb-2">
<div class="card-body p-2">
<strong>{{ key }}</strong>
<pre class="mb-0"><code>{{ example|pprint }}</code></pre>
<pre class="mb-0"><code>{{ example }}</code></pre>
</div>
</div>
{% endfor %}
@@ -128,7 +131,7 @@
</div>
<script>
document.addEventListener("DOMContentLoaded", function () {
document.addEventListener("DOMContentLoaded", function ( ) {
// Function to toggle icon class on collapse events
function setupIconToggle(collapseId, iconSelector) {
$('#' + collapseId).on('show.bs.collapse', function () {
@@ -141,7 +144,7 @@
}
// Setup for all collapsible elements
$('.collapse').each(function () {
$('.collapse').each(function () {
var id = $(this).attr('id');
setupIconToggle(id, '.fa-chevron-right, .fa-chevron-down');
});