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

Add API endpoints

Browse source
This commit is contained in:
Joakim Hellsén 2024-02-23 13:20:06 +01:00
commit 05d7da1f59
5 changed files with 347 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
feeds/urls.py
View file

@ -9,16 +9,26 @@ from .views import APIView, CustomLoginView, CustomLogoutView, ProfileView, Regi
app_name: str = "feeds"
# Normal pages
urlpatterns: list[URLPattern] = [
path(route="", view=views.IndexView.as_view(), name="index"),
path(route="feed/<int:feed_id>/", view=views.FeedView.as_view(), name="feed"),
path(route="feeds/", view=views.FeedsView.as_view(), name="feeds"),
path(route="add", view=views.AddView.as_view(), name="add"),
path(route="upload", view=views.UploadView.as_view(), name="upload"),
path(route="api/", view=APIView.as_view(), name="api"),
path(route="robots.txt", view=cache_page(timeout=60 * 60 * 365)(views.RobotsView.as_view()), name="robots"),
]
# API urls
urlpatterns += [
path(route="api/", view=APIView.as_view(), name="api"),
path(route="api/feeds/", view=views.APIFeedsView.as_view(), name="api_feeds"),
path(route="api/feeds/<int:feed_id>/", view=views.APIFeedView.as_view(), name="api_feeds_id"),
path(route="api/feeds/<int:feed_id>/entries/", view=views.APIFeedEntriesView.as_view(), name="api_feed_entries"),
path(route="api/entries/", view=views.APIEntriesView.as_view(), name="api_entries"),
path(route="api/entries/<int:entry_id>/", view=views.APIEntryView.as_view(), name="api_entries_id"),
]
# Account urls
urlpatterns += [
path(route="accounts/login/", view=CustomLoginView.as_view(), name="login"),

179
feeds/views.py
View file

@ -7,7 +7,9 @@ from django.contrib.auth import login
from django.contrib.auth.forms import AuthenticationForm, UserCreationForm
from django.contrib.auth.views import LoginView, LogoutView, PasswordChangeView
from django.contrib.messages.views import SuccessMessageMixin
from django.http import HttpRequest, HttpResponse
from django.core.paginator import EmptyPage, Page, PageNotAnInteger, Paginator
from django.forms.models import model_to_dict
from django.http import HttpRequest, HttpResponse, JsonResponse
from django.shortcuts import get_object_or_404, render
from django.template import loader
from django.urls import reverse_lazy
@ -270,3 +272,178 @@ class RobotsView(View):
content="""User-agent: *\nDisallow: /add\nDisallow: /upload\nDisallow: /accounts/""",
content_type="text/plain",
)
class APIFeedsView(View):
"""API Feeds view."""
def get(self, request: HttpRequest) -> HttpResponse:
"""Get all feeds with pagination."""
# Retrieve all feeds
feeds_list = Feed.objects.all()
# Pagination settings
page: int = int(request.GET.get("page", 1)) # Get the page number from the query parameters, default to 1
per_page: int = int(request.GET.get("per_page", 1000)) # Number of feeds per page, default to 1000 (max 1000)
# Add a ceiling to the per_page value
max_per_page = 1000
if per_page > max_per_page:
per_page = max_per_page
# Create Paginator instance
paginator = Paginator(feeds_list, per_page)
try:
feeds: Page = paginator.page(page)
except PageNotAnInteger:
# If page is not an integer, deliver first page.
feeds = paginator.page(1)
except EmptyPage:
# If page is out of range (e.g., 9999), deliver last page of results.
feeds = paginator.page(paginator.num_pages)
# Convert feeds to dictionary
feeds_dict = [model_to_dict(feed) for feed in feeds]
# Return the paginated entries as JsonResponse
response = JsonResponse(feeds_dict, safe=False)
# Add pagination headers
response["X-Page"] = feeds.number
response["X-Page-Count"] = paginator.num_pages
response["X-Per-Page"] = per_page
response["X-Total-Count"] = paginator.count
response["X-First-Page"] = 1
response["X-Last-Page"] = paginator.num_pages
# Next and previous page links
if feeds.has_next():
response["X-Next-Page"] = feeds.next_page_number()
if feeds.has_previous():
response["X-Prev-Page"] = feeds.previous_page_number()
return response
class APIFeedView(View):
"""API Feed view."""
def get(self, request: HttpRequest, feed_id: int) -> HttpResponse: # noqa: ARG002
"""Get a single feed."""
feed = get_object_or_404(Feed, id=feed_id)
return JsonResponse(model_to_dict(feed), safe=False)
class APIEntriesView(View):
"""API Entries view."""
def get(self, request: HttpRequest) -> HttpResponse:
"""Get all entries with pagination."""
# Retrieve all entries
entries_list = Entry.objects.all()
# Pagination settings
page: int = int(request.GET.get("page", 1)) # Get the page number from the query parameters, default to 1
per_page: int = int(request.GET.get("per_page", 1000))
# Add a ceiling to the per_page value
max_per_page = 1000
if per_page > max_per_page:
per_page = max_per_page
# Create Paginator instance
paginator = Paginator(entries_list, per_page)
try:
entries: Page = paginator.page(page)
except PageNotAnInteger:
# If page is not an integer, deliver first page.
entries = paginator.page(1)
except EmptyPage:
# If page is out of range (e.g. 9999), deliver last page of results.
entries = paginator.page(paginator.num_pages)
# Convert entries to dictionary
entries_dict = [model_to_dict(entry) for entry in entries]
# Return the paginated entries as JsonResponse
response = JsonResponse(entries_dict, safe=False)
# Add pagination headers
response["X-Page"] = entries.number
response["X-Page-Count"] = paginator.num_pages
response["X-Per-Page"] = per_page
response["X-Total-Count"] = paginator.count
response["X-First-Page"] = 1
response["X-Last-Page"] = paginator.num_pages
# Next and previous page links
if entries.has_next():
response["X-Next-Page"] = entries.next_page_number()
if entries.has_previous():
response["X-Prev-Page"] = entries.previous_page_number()
return response
class APIEntryView(View):
"""API Entry view."""
def get(self, request: HttpRequest, entry_id: int) -> HttpResponse: # noqa: ARG002
"""Get a single entry."""
entry = get_object_or_404(Entry, id=entry_id)
return JsonResponse(model_to_dict(entry), safe=False)
class APIFeedEntriesView(View):
"""API Feed Entries view."""
def get(self, request: HttpRequest, feed_id: int) -> HttpResponse:
"""Get all entries for a single feed with pagination."""
# Retrieve all entries for a single feed
entries_list = Entry.objects.filter(feed_id=feed_id)
# Pagination settings
page: int = int(request.GET.get("page", 1)) # Get the page number from the query parameters, default to 1
per_page: int = int(request.GET.get("per_page", 1000))
# Add a ceiling to the per_page value
max_per_page = 1000
if per_page > max_per_page:
per_page = max_per_page
# Create Paginator instance
paginator = Paginator(entries_list, per_page)
try:
entries: Page = paginator.page(page)
except PageNotAnInteger:
# If page is not an integer, deliver first page.
entries = paginator.page(1)
except EmptyPage:
# If page is out of range (e.g. 9999), deliver last page of results.
entries = paginator.page(paginator.num_pages)
# Convert entries to dictionary
entries_dict = [model_to_dict(entry) for entry in entries]
# Return the paginated entries as JsonResponse
response = JsonResponse(entries_dict, safe=False)
# Add pagination headers
response["X-Page"] = entries.number
response["X-Page-Count"] = paginator.num_pages
response["X-Per-Page"] = per_page
response["X-Total-Count"] = paginator.count
response["X-First-Page"] = 1
response["X-Last-Page"] = paginator.num_pages
# Next and previous page links
if entries.has_next():
response["X-Next-Page"] = entries.next_page_number()
if entries.has_previous():
response["X-Prev-Page"] = entries.previous_page_number()
return response

157
templates/api.html
View file

@ -1,5 +1,160 @@
{% extends "base.html" %}
{% block content %}
<h2>API Documentation</h2>
<p>This is the API documentation.</p>
<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

@ -14,7 +14,7 @@
{% endif %}
<style>
html {
max-width: 70ch;
max-width: 88ch;
padding: calc(1vmin + 0.5rem);
margin-inline: auto;
font-size: clamp(1em, 0.909em + 0.45vmin, 1.25em);

2
templates/feed.html
View file

@ -7,7 +7,7 @@
{% for entry in entries %}
<li>
<a href="{{ entry.link }}">{{ entry.title }}</a>
<p>{{ entry.summary }}</p>
<p>{{ entry.summary|safe }}</p>
</li>
{% endfor %}
</ul>