Add swagger to generate Domains API documentation

This commit adds swagger as a documentation generator for REST framework as well as
an easy way to test the domains administrative end-points.

Signed-off-by: Francisco Trivino <[email protected]>

src/ipa-tuura/root/settings.py

@@ -46,6 +46,7 @@
     'creds',
     'rest_framework',
     'domains',
+    'rest_framework_swagger',
 ]
 
 MIDDLEWARE = [
@@ -158,3 +159,10 @@
     'WRITABLE_IFACE': 'ipa',
     'WRITABLE_USER': 'admin',
 }
+
+# admin endpoint so that we can handle permissions and required fields only for authenticated users
+#REST_FRAMEWORK = {
+#    'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAuthenticated',)
+#}
+
+REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema' }

src/ipa-tuura/root/urls.py

@@ -18,11 +18,15 @@
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 from django.contrib import admin
-from django.urls import include, path
+from django.urls import include, path, re_path
+from rest_framework_swagger.views import get_swagger_view
+
+schema_view = get_swagger_view(title='Domains API')
 
 urlpatterns = [
     path('admin/', admin.site.urls),
     path('scim/v2/', include('django_scim.urls')),
     path('creds/', include('creds.urls')),
     path('domains/v1/', include('domains.urls')),
+    re_path('domains/doc', schema_view)
 ]