Added openapi specs and swagger/redoc ui to api

Author: qoda

README.md

@@ -162,3 +162,6 @@ sudo systemctl enable iot.mqttsubscriber.service
 ### Make a SD Card Backup
 
 Read more here: https://howchoo.com/pi/create-a-backup-image-of-your-raspberry-pi-sd-card-in-mac-osx. this pretty useful as cards can become corrupt if power is cut or the device is not powered down correctly.
+
+## API Documentation
+The API documentation is available at `/api/schema/ui/` (Swagger) and `/api/schema/docs/` (Redoc) when the server is running.

iotserver/settings.py

@@ -32,6 +32,7 @@
     # 3rd party apps
     'corsheaders',
     'django_filters',
+    'drf_spectacular',
     'mapwidgets',
     'rest_framework',
     'rest_framework_gis',
@@ -111,20 +112,6 @@
     },
 ]
 
-REST_FRAMEWORK = {
-    'DEFAULT_AUTHENTICATION_CLASSES': [
-        'rest_framework.authentication.SessionAuthentication',
-        'rest_framework.authentication.TokenAuthentication',
-    ],
-    'DEFAULT_PERMISSION_CLASSES': ['rest_framework.permissions.DjangoModelPermissions'],
-    'DEFAULT_FILTER_BACKENDS': [
-        'django_filters.rest_framework.DjangoFilterBackend',
-        'rest_framework.filters.OrderingFilter',
-    ],
-    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
-    'PAGE_SIZE': 50,
-}
-
 # Internationalization
 # https://docs.djangoproject.com/en/3.1/topics/i18n/
 LANGUAGE_CODE = 'en-us'
@@ -147,6 +134,31 @@
 GDAL_LIBRARY_PATH = os.environ.get('IOTSERVER_GDAL_LIBRARY_PATH', None)
 GEOS_LIBRARY_PATH = os.environ.get('IOTSERVER_GEOS_LIBRARY_PATH', None)
 
+# Django Rest Framework config
+REST_FRAMEWORK = {
+    'DEFAULT_AUTHENTICATION_CLASSES': (
+        'rest_framework.authentication.SessionAuthentication',
+        'rest_framework.authentication.TokenAuthentication',
+    ),
+    'DEFAULT_RENDERER_CLASSES': ('rest_framework.renderers.JSONRenderer',),
+    'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.DjangoModelPermissions',),
+    'DEFAULT_FILTER_BACKENDS': (
+        'django_filters.rest_framework.DjangoFilterBackend',
+        'rest_framework.filters.OrderingFilter',
+    ),
+    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
+    'PAGE_SIZE': 50,
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
+}
+
+# Spectacular settings - OpenAPI 3
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'IoTServer API',
+    'DESCRIPTION': 'Simple IoT Server, Configuration Tool & Dashboard',
+    'VERSION': '0.9.0',
+    'SERVE_INCLUDE_SCHEMA': False,
+}
+
 # MQTT settings
 MQTT = {
     'host': os.environ.get('IOTSERVER_MQTT_HOST', 'localhost'),

iotserver/urls.py

@@ -2,6 +2,11 @@
 from django.conf.urls.static import static
 from django.contrib import admin
 from django.urls import include, path
+from drf_spectacular.views import (
+    SpectacularAPIView,
+    SpectacularRedocView,
+    SpectacularSwaggerView
+)
 from rest_framework import routers
 
 from iotserver.apps.device.api import viewsets as device_viewsets
@@ -33,13 +38,28 @@
     path('admin/', admin.site.urls),
 ]
 
-
 # DRF url patterns
 urlpatterns += [
     path('api/auth/token/', user_viewsets.ObtainAuthTokenUser.as_view()),
     path('api/auth/', include('rest_framework.urls')),
     path('api/', include(router.urls)),
 ]
 
+# DRF spectacular schema
+urlpatterns += [
+    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
+    path('api/schema/ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='ui'),
+    path('api/schema/docs/', SpectacularRedocView.as_view(url_name='schema'), name='docs'),
+]
+
+# from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
+# urlpatterns = [
+#     # YOUR PATTERNS
+#     path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
+#     # Optional UI:
+#     path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
+#     path('api/schema/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
+# ]
+
 # Static files
 urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)