adds documentation api

http_urls.py

@@ -1,4 +1,4 @@
-from django.urls import path, re_path
+from django.urls import path, re_path ,include,URLPattern
 from rest_framework.routers import SimpleRouter
 from buy_and_sell.views.sale_product_views import SaleProductList
 from buy_and_sell.views.constants import ConstantViewSet
@@ -10,7 +10,10 @@
 from buy_and_sell.views.search_view import GlobalSearchList
 from buy_and_sell.views.who_am_i import WhoAmI
 from buy_and_sell.views.picture_views import PictureList
-
+from rest_framework import permissions
+from drf_yasg.views import get_schema_view
+from drf_yasg import openapi
+from drf_yasg.generators import OpenAPISchemaGenerator
 
 app_name = 'buy_and_sell'
 router = SimpleRouter()
@@ -49,6 +52,23 @@
     re_path(r'^search/$', GlobalSearchList.as_view(), name="search"),
     path('who_am_i/', WhoAmI.as_view(), name='who_am_i'),
     path('picture/', PictureList.as_view(), name='product_picture'),
+    path('', include(router.urls)),
+]
+
+schema_view = get_schema_view(
+    openapi.Info(
+        title="Your API",
+        default_version='v1',
+        description="API documentation",
+    ),
+    public=True,
+    permission_classes=(permissions.AllowAny,),
+    patterns=urlpatterns,
+
+)
+urlpatterns += [
+    path('swagger<format>/', schema_view.without_ui(cache_timeout=0), name='schema-json'),
+    path('swagger.json/', schema_view.without_ui(cache_timeout=0), name='schema-json'),
+    path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
 ]
 
-urlpatterns += router.urls

serializers/categories.py

@@ -23,3 +23,4 @@ class Meta:
             'slug',
             'sub_categories'
         )
+        ref_name= "BuyandSellCategory"

serializers/constants.py

@@ -0,0 +1,6 @@
+from rest_framework import serializers
+
+class ConstantSerializer(serializers.Serializer):
+    periodicity = serializers.DictField(child=serializers.CharField())
+
+

serializers/picture.py

@@ -11,3 +11,4 @@ class PictureSerializer(serializers.ModelSerializer):
     class Meta:
         model = Picture
         fields = '__all__'
+        ref_name="picture_serializer"

serializers/search.py

@@ -1,18 +1,17 @@
 from rest_framework import serializers
-
-from buy_and_sell.models import SaleProduct
-from buy_and_sell.models import RequestProduct
+from buy_and_sell.models import SaleProduct, RequestProduct
 from buy_and_sell.serializers.sale_product import SaleProductSerializer
 from buy_and_sell.serializers.request_product import RequestProductSerializer
 
-
 class GlobalSearchSerializer(serializers.ModelSerializer):
     """
     Serializer to serialize the search results
     """
 
     class Meta:
         model = SaleProduct
+        fields = '__all__'
+        ref_name = "GlobalSearchSerializer" 
 
     def to_representation(self, obj):
         if isinstance(obj, SaleProduct):

views/constants.py

@@ -2,7 +2,7 @@
 from rest_framework.response import Response
 from rest_framework.renderers import JSONRenderer
 from buy_and_sell import constants
-
+from buy_and_sell.serializers.constants import ConstantSerializer
 
 class ConstantViewSet(
     mixins.ListModelMixin,
@@ -12,6 +12,7 @@ class ConstantViewSet(
     List view for constants and their codes
     """
     renderer_classes = [JSONRenderer,]
+    serializer_class = ConstantSerializer
 
     def list(self, request):
         """