added swagger ui docs

Author: coderj001

Pipfile

@@ -8,6 +8,9 @@ Django = "*"
 djangorestframework = "*"
 djangorestframework-simplejwt = "*"
 gunicorn = "*"
+drf-yasg = "*"
+whitenoise = "*"
+coreapi = "*"
 
 [dev-packages]
 django_linter = "*"

Pipfile.lock

@@ -0,0 +1 @@
+web: gunicorn TaxManagementSystem.wsgi:application --log-file -

Procfile

@@ -9,8 +9,11 @@
 
 DEBUG = bool(strtobool(os.environ.get('debug')))
 
-ALLOWED_HOSTS = ["*"]
-
+ALLOWED_HOSTS = [
+    "localhost",
+    "127.0.0.1",
+    os.environ.get('host')
+]
 
 INSTALLED_APPS = [
     'django.contrib.admin',
@@ -21,13 +24,15 @@
     'django.contrib.staticfiles',
 
     'rest_framework',
+    'drf_yasg',
 
     # user app
     'user.apps.UserConfig'
 ]
 
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
+    'whitenoise.middleware.WhiteNoiseMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
@@ -129,7 +134,7 @@
 
 LANGUAGE_CODE = 'en-us'
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = 'Asia/Kolkata'
 
 USE_I18N = True
 
@@ -139,6 +144,25 @@
 
 STATIC_URL = '/static/'
 
+STATICFILES_DIRS = (BASE_DIR / 'static', )
+
+STATIC_ROOT = BASE_DIR / 'staticfiles'
+
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
 
 AUTH_USER_MODEL = "user.User"
+
+
+SWAGGER_SETTINGS = {
+    'SECURITY_DEFINITIONS': {
+        'basic': {
+            'type': 'basic'
+        }
+    },
+}
+
+REDOC_SETTINGS = {
+    'LAZY_RENDERING': False,
+}
+
+STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'

TaxManagementSystem/settings.py

@@ -1,7 +1,43 @@
+from django.conf import settings
+from django.conf.urls import url
+from django.conf.urls.static import static
 from django.contrib import admin
-from django.urls import path, include
+from django.urls import include, path
+from drf_yasg import openapi
+from drf_yasg.views import get_schema_view
+from rest_framework import permissions
+
+schema_view = get_schema_view(
+    openapi.Info(
+        title="Tax Management System API",
+        default_version='v1',
+        description="Test description",
+    ),
+    public=True,
+    permission_classes=(permissions.AllowAny,),
+)
+
 
 urlpatterns = [
     path('admin/', admin.site.urls),
     path('api/users/', include('user.urls', namespace='user')),
+    url(
+        r'^swagger(?P<format>\.json|\.yaml)$',
+        schema_view.without_ui(cache_timeout=0),
+        name='schema-json'
+    ),
+    url(
+        r'^swagger/$',
+        schema_view.with_ui('swagger', cache_timeout=0),
+        name='schema-swagger-ui'
+    ),
+    url(
+        r'^redoc/$',
+        schema_view.with_ui('redoc', cache_timeout=0),
+        name='schema-redoc'
+    ),
 ]
+
+if settings.DEBUG:
+    urlpatterns += static(settings.STATIC_URL,
+                          document_root=settings.STATIC_ROOT)

TaxManagementSystem/urls.py

@@ -0,0 +1 @@
+python-3.9.5