Add REST API pagination and mke REST API optional (#43)

* Implement Rest API pagination

* REST API must be enabled in settings

* Report REST API status in the admin site settings page
This commit is contained in:
2025-01-16 22:53:19 +01:00
committed by GitHub
parent d237129c99
commit db79a02c85
10 changed files with 61 additions and 27 deletions

View File

@@ -32,9 +32,6 @@ urlpatterns = [
path("tinymce/upload_image", UploadImage.as_view(), name="upload_image"),
path("portal/", include("portal.urls")),
path("admin/", admin.site.urls),
path("api/v1/consist/", include("consist.urls")),
path("api/v1/roster/", include("roster.urls")),
path("api/v1/bookshelf/", include("bookshelf.urls")),
] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
# Enable the "/dcc" routing only if the "driver" app is active
@@ -43,30 +40,37 @@ if apps.is_installed("driver"):
path("api/v1/dcc/", include("driver.urls")),
]
if settings.DEBUG:
from django.views.generic import TemplateView
from rest_framework.schemas import get_schema_view
if settings.REST_ENABLED:
urlpatterns += [
path(
"swagger/",
TemplateView.as_view(
template_name="swagger.html",
extra_context={"schema_url": "openapi-schema"},
),
name="swagger",
),
path(
"openapi",
get_schema_view(
title="RAM - Railroad Assets Manager",
description="RAM API",
version="1.0.0",
),
name="openapi-schema",
),
path("api/v1/consist/", include("consist.urls")),
path("api/v1/roster/", include("roster.urls")),
path("api/v1/bookshelf/", include("bookshelf.urls")),
]
if settings.DEBUG:
if apps.is_installed("debug_toolbar"):
urlpatterns += [
path("__debug__/", include("debug_toolbar.urls")),
]
if settings.REST_ENABLED:
from django.views.generic import TemplateView
from rest_framework.schemas import get_schema_view
urlpatterns += [
path(
"swagger/",
TemplateView.as_view(
template_name="swagger.html",
extra_context={"schema_url": "openapi-schema"},
),
name="swagger",
),
path(
"openapi",
get_schema_view(
title="RAM - Railroad Assets Manager",
description="RAM API",
version="1.0.0",
),
name="openapi-schema",
),
]