feat: adicionando swagger para a API

Dockerfile

@@ -17,6 +17,8 @@ RUN pip install --no-cache-dir -r requirements.txt
 
 # ENV PATH="/.venv/bin:$PATH"
 
+RUN python manage.py collectstatic --noinput
+
 RUN pip install uvicorn
 CMD ["uvicorn", "setup.asgi:application", "--host", "0.0.0.0", "--port", "7860"]
 

endpoint_teste/views.py

@@ -1,9 +1,10 @@
-import tempfile, os, requests
+import tempfile, os
 from rest_framework import viewsets, filters
 from django_filters.rest_framework import DjangoFilterBackend
 from endpoint_teste.models import EndpointTesteModel
 from endpoint_teste.serializer import EndpointTesteSerializer, PDFUploadSerializer
 from setup.environment import default_model
+from drf_spectacular.utils import extend_schema
 
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
@@ -56,6 +57,10 @@ def getTeste(request):
         print('result: ', result)
         return Response(result)
 
+@extend_schema(
+    request=PDFUploadSerializer,
+)
+
 @api_view(["POST"])
 def getPDF(request):
     if request.method == "POST":

setup/settings.py

@@ -45,7 +45,8 @@ INSTALLED_APPS = [
     "rest_framework",
     "django_filters",
     "corsheaders",
-    "endpoint_teste"
+    "endpoint_teste",
+    "drf_spectacular"
 ]
 
 MIDDLEWARE = [
@@ -57,8 +58,11 @@ MIDDLEWARE = [
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware"
 ]
 
+STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
+
 ROOT_URLCONF = "setup.urls"
 
 TEMPLATES = [
@@ -141,6 +145,7 @@ USE_TZ = True
 # https://docs.djangoproject.com/en/4.2/howto/static-files/
 
 STATIC_URL = "static/"
+STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
@@ -149,8 +154,8 @@ DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
 CORS_ORIGIN_WHITELIST = [
     "http://localhost",
-    "luanpoppe-projeto-y-teste-01.hf.space",
-    "*"
+    "https://luanpoppe-projeto-y-teste-01.hf.space",
+    "https://*"
     # "http://localhost:5000",
     # "https://luan-pessoal.vercel.app",
     # "http://localhost:5173",
@@ -158,5 +163,14 @@ CORS_ORIGIN_WHITELIST = [
 
 REST_FRAMEWORK = {
 	'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
-    'PAGE_SIZE': 10
+    'PAGE_SIZE': 10,
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
 }
+
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'Your Project API',
+    'DESCRIPTION': 'Your project description',
+    'VERSION': '1.0.0',
+    'SERVE_INCLUDE_SCHEMA': False,
+    # OTHER SETTINGS
+}

setup/urls.py

@@ -1,6 +1,8 @@
 from django.contrib import admin
 from django.urls import path, include
 from rest_framework import routers
+from drf_spectacular.views import SpectacularSwaggerView, SpectacularAPIView
+
 
 from endpoint_teste.views import EndpointTesteViewSet, getTeste, getPDF
 
@@ -8,8 +10,10 @@ router = routers.DefaultRouter()
 # router.register("endpoint-teste", EndpointTesteViewSet, basename="Basename do endpoint-teste")
 
 urlpatterns = [
+    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
+    path('swagger/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
     path("admin/", admin.site.urls),
     path('', include(router.urls)),
     path("teste", getTeste),
     path('pdf', getPDF, name='upload-pdf')  
-]
+]