feat(swagger): add swagger documentation to project

-add drf-yasg and swagger to packages and requirements
-add swagger urls
-add static files Option for swagger

Author: hamidrabedi

README.md

@@ -18,7 +18,9 @@ This is a django app for scraping data from specified digikala search urls.
 
 `python manage.py runserver`
 
-#API Guide
+# API Guide
+
+**You can use </api/doc> for swagger documentation**
 
  - **URL**
 
@@ -34,9 +36,8 @@ This is a django app for scraping data from specified digikala search urls.
 
 - **Data Params**
 
-	- requierd:
-
-			digikala search url such as:
+	- requierd 
+	  digikala search url such as:
 
 			`category=https://www.digikala.com/search/?q=%D8%B4%DB%8C%D8%A7%D8%A6%D9%88%D9%85%DB%8C`
 
@@ -47,4 +48,4 @@ This is a django app for scraping data from specified digikala search urls.
 
 		`pages=15`
 
-		(default is 5)
+		(default is 5)

kernel/settings/base.py

@@ -31,6 +31,9 @@
                 'django.contrib.auth.context_processors.auth',
                 'django.contrib.messages.context_processors.messages',
             ],
+            'libraries': { # Adding this section should work around the issue.
+                'staticfiles' : 'django.templatetags.static',
+            },
         },
     },
 ]

kernel/settings/packages.py

@@ -12,7 +12,9 @@
     'warehouse'
 ]
 THIRD_PARTY_PACKAGES = [
-    'rest_framework'
+    'rest_framework',
+    'rest_framework_swagger',
+    'drf_yasg'
 ]
 
 INSTALLED_APPS = DEFAULT_APPS + LOCAL_APPS + THIRD_PARTY_PACKAGES
@@ -32,6 +34,7 @@
     # 'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.AcceptHeaderVersioning',
     # 'ALLOWED_VERSIONS': ('1.0',),
     # Pagination
+    'DEFAULT_SCHEMA_CLASS':'rest_framework.schemas.coreapi.AutoSchema',
     'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
     'PAGE_SIZE': 100
 }

requirements.txt

@@ -10,22 +10,32 @@ cffi==1.15.0
 charset-normalizer==2.0.12
 colorama==0.4.4
 constantly==15.1.0
+coreapi==2.3.3
+coreschema==0.0.4
 cryptography==36.0.1
 cssselect==1.1.0
 Django==4.0.3
+django-rest-swagger==2.2.0
 djangorestframework==3.13.1
+drf-yasg==1.20.0
 fake-useragent==0.1.11
 filelock==3.6.0
 h11==0.13.0
 hyperlink==21.0.0
 idna==3.3
 importlib-metadata==4.11.2
 incremental==21.3.0
+inflection==0.5.1
 itemadapter==0.4.0
 itemloaders==1.0.4
+itypes==1.2.0
+Jinja2==3.0.3
 jmespath==0.10.0
 lxml==4.8.0
+MarkupSafe==2.1.0
+openapi-codec==1.3.2
 outcome==1.1.0
+packaging==21.3
 parse==1.19.0
 parsel==1.6.0
 Protego==0.2.1
@@ -35,6 +45,7 @@ pycparser==2.21
 PyDispatcher==2.0.5
 pyee==8.2.2
 pyOpenSSL==22.0.0
+pyparsing==3.0.7
 pyppeteer==1.0.2
 pyquery==1.4.3
 PySocks==1.7.1
@@ -44,9 +55,12 @@ queuelib==1.6.2
 requests==2.27.1
 requests-file==1.5.1
 requests-html==0.10.0
+ruamel.yaml==0.17.21
+ruamel.yaml.clib==0.2.6
 Scrapy==2.6.1
 selenium==4.1.2
 service-identity==21.1.0
+simplejson==3.17.6
 six==1.16.0
 sniffio==1.2.0
 sortedcontainers==2.4.0
@@ -61,6 +75,7 @@ twisted-iocpsupport==1.0.2
 typing_extensions==4.1.1
 tzdata==2021.5
 Unidecode==1.3.3
+uritemplate==4.1.1
 urllib3==1.26.8
 w3lib==1.22.0
 websockets==10.2

warehouse/api/urls.py

@@ -1,9 +1,12 @@
 from django.urls import (
     path, 
+    re_path,
     include
 )
 
 from rest_framework import routers
+from drf_yasg.views import get_schema_view
+from drf_yasg import openapi
 
 from warehouse.api.views import(
     ProductViewSet,
@@ -19,7 +22,22 @@
 router.register(r'colors', ColorViewSet)
 router.register(r'guarantees', GuaranteeViewSet)
 
+schema_view = get_schema_view(
+    openapi.Info(
+        title="Digikala Crawler",
+        default_version="V1",
+        description="API documentation for project",
+        terms_of_service="https://www.google.com/policies/terms/",
+    ),
+    public=True,
+)
+
 urlpatterns = [
     path('', include(router.urls)),
-    path('category/',CategoryView.as_view() )
-]
+    path('category/',CategoryView.as_view()),
+    
+    #for documentation
+    re_path(r'^doc/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
+    
+]
+