TheLovinator/feedvault.se
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use Django-ninja for API

Browse source
This commit is contained in:
Joakim Hellsén 2024-03-15 20:38:40 +01:00
commit 869a931bda
No known key found for this signature in database
GPG key ID: D196AE66FEBE1DC9
13 changed files with 355 additions and 432 deletions
Download patch file Download diff file Expand all files Collapse all files

160
templates/api.html
View file

@ -1,160 +0,0 @@
{% extends "base.html" %}
{% block content %}
<h2>API Documentation</h2>
<p>
Missing something? <a href="mailto:hello@feedvault.se">Let me know</a>.
</p>
<h2>Get All Feeds</h2>
<p>GET /api/feeds/</p>
<h3>Query Parameters</h3>
<ul>
<li>
<strong>page</strong> (optional): The page number of feeds to retrieve. Defaults to 1 if not specified.
</li>
<li>
<strong>per_page</strong> (optional): The number of feeds per page. Defaults to 1000 if not specified. The maximum value is 1000.
</li>
</ul>
<h3>Headers</h3>
<p>
The following headers are sent with the response:
<ul>
<li>
<strong>X-Page</strong>: The current page number.
</li>
<li>
<strong>X-Page-Count</strong>: The total number of pages.
</li>
<li>
<strong>X-Per-Page</strong>: The number of feeds per page.
</li>
<li>
<strong>X-Total-Count</strong>: The total number of feeds.
</li>
<li>
<strong>X-First-Page</strong>: The page number of the first page.
</li>
<li>
<strong>X-Last-Page</strong>: The page number of the last page.
</li>
</ul>
</p>
<h3>Python example</h3>
<pre>
import requests
page_num = 1
per_page = 1000
url = f'https://feedvault.se/api/feeds/?page={page_num}&per_page={per_page}'
response = requests.get(url)
print(response.json())
</pre>
<h3>Example URL</h3>
<p>
<a href="https://feedvault.se/api/feeds/?page=1&per_page=1000">https://feedvault.se/api/feeds/?page=1&per_page=1000</a>
</p>
<hr>
<h2>Get All Entries</h2>
<p>GET /api/entries/</p>
<h3>Query Parameters</h3>
<ul>
<li>
<strong>page</strong> (optional): The page number of entries to retrieve. Defaults to 1 if not specified.
</li>
<li>
<strong>per_page</strong> (optional): The number of entries per page. Defaults to 1000 if not specified. The maximum value is 1000.
</li>
</ul>
<h3>Headers</h3>
<p>
The following headers are sent with the response:
<ul>
<li>
<strong>X-Page</strong>: The current page number.
</li>
<li>
<strong>X-Page-Count</strong>: The total number of pages.
</li>
<li>
<strong>X-Per-Page</strong>: The number of feeds per page.
</li>
<li>
<strong>X-Total-Count</strong>: The total number of feeds.
</li>
<li>
<strong>X-First-Page</strong>: The page number of the first page.
</li>
<li>
<strong>X-Last-Page</strong>: The page number of the last page.
</li>
</ul>
</p>
<h3>Python example</h3>
<pre>
import requests
page_num = 1
per_page = 1000
url = f'https://feedvault.se/api/entries/?page={page_num}&per_page={per_page}'
response = requests.get(url)
print(response.json())
</pre>
<h3>Example URL</h3>
<p>
<a href="https://feedvault.se/api/entries/?page=1&per_page=1000">https://feedvault.se/api/entries/?page=1&per_page=1000</a>
</p>
<hr>
<h2>Get All Entries for a Feed</h2>
<p>GET /api/feeds/{feed_id}/entries/</p>
<h3>Query Parameters</h3>
<ul>
<li>
<strong>page</strong> (optional): The page number of entries to retrieve. Defaults to 1 if not specified.
</li>
<li>
<strong>per_page</strong> (optional): The number of entries per page. Defaults to 1000 if not specified. The maximum value is 1000.
</li>
</ul>
<h3>Headers</h3>
<p>
The following headers are sent with the response:
<ul>
<li>
<strong>X-Page</strong>: The current page number.
</li>
<li>
<strong>X-Page-Count</strong>: The total number of pages.
</li>
<li>
<strong>X-Per-Page</strong>: The number of feeds per page.
</li>
<li>
<strong>X-Total-Count</strong>: The total number of feeds.
</li>
<li>
<strong>X-First-Page</strong>: The page number of the first page.
</li>
<li>
<strong>X-Last-Page</strong>: The page number of the last page.
</li>
</ul>
</p>
<h3>Python example</h3>
<pre>
import requests
page_num = 1
per_page = 1000
feed_id = 1
url = f'https://feedvault.se/api/feeds/{feed_id}/entries/?page={page_num}&per_page={per_page}'
response = requests.get(url)
print(response.json())
</pre>
<h3>Example URL</h3>
<p>
<a href="https://feedvault.se/api/feeds/1/entries/?page=1&per_page=1000">https://feedvault.se/api/feeds/1/entries/?page=1&per_page=1000</a>
</p>
{% endblock %}

2
templates/base.html
View file

@ -107,7 +107,7 @@
<a href="{% url 'index' %}">Home</a> |
<a href="{% url 'domains' %}">Domains</a> |
<a href="{% url 'feeds' %}">Feeds</a> |
<a href="{% url 'api' %}">API</a>
<a href="{% url 'api_v1:openapi-view' %}">API</a>
</div>
<div class="right">
<a href="https://github.com/TheLovinator1/FeedVault">GitHub</a> |

15
templates/feeds.html
View file

@ -1,14 +1,11 @@
{% extends "base.html" %}
{% block content %}
<h2>Feeds</h2>
<ul>
<h2>Latest Feeds</h2>
{% if feeds %}
{% for feed in feeds %}
<li>{{ feed.feed_url }} - {{ feed.created_at|date }}</li>
<li>
<a href="{% url 'feed' feed.id %}">View</a>
</li>
{% empty %}
<li>No feeds yet.</li>
<a href="{% url 'feed' feed.id %}">{{ feed.feed_url|default:"Unknown Feed" }} →</a>
{% endfor %}
</ul>
{% else %}
<p>No feeds yet. Time to add some!</p>
{% endif %}
{% endblock %}