Merge pull request func/swagger-13

Func/swagger 13

.gitignore

@@ -3,4 +3,5 @@ __pycache__/
 /node_modules
 .env
 .pytest_cache
-__pycache__
+__pycache__
+schema.yml

README.md

@@ -1,6 +1,5 @@
 # Base de conhecimento TUPAN-BACK
 
-
 ## Ambiente
 
 ### Criar, ativar e instalar as dependencias do ambiente virtual
@@ -21,6 +20,17 @@ cp ./src/.env_sample ./src/.env
 ```
 Logo em seguida altere as variáveis para os valores desejados.
 
+## Swagger
+
+### Gerando o schema para o swagger
+Execute o seguinte comando no terminal para gerar o .yml que será utilizado pelo swagger:
+```
+python ./src/tupan/manage.py spectacular --color --file schema.yml
+```
+
+### Como acessar o swagger
+Rode a aplicação e acesse o endpoint:
+> /api/schema/swagger-ui
 
 ## Testes
 

requirements.txt

@@ -7,3 +7,4 @@ python-dotenv==1.0.1
 sqlparse==0.5.1
 typing_extensions==4.12.2
 tzdata==2024.1
+drf-spectacular

src/tupan/tupan/settings.py

@@ -45,8 +45,20 @@
     'rest_framework',
     'alertas',
     'estacoes'
+    'drf_spectacular',
 ]
 
+REST_FRAMEWORK = {
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
+}
+
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'Tupã API',
+    'DESCRIPTION': '',
+    'VERSION': '1.0.0',
+    'SERVE_INCLUDE_SCHEMA': False,
+}
+
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',

src/tupan/tupan/urls.py

@@ -16,8 +16,13 @@
 """
 from django.contrib import admin
 from django.urls import include, path
+from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
 
 urlpatterns = [
     path('admin/', admin.site.urls),
-    path('', include('estacoes.urls'))
+    path('', include('estacoes.urls')),
+    path('admin/', admin.site.urls),
+    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
+    path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
+    path('api/schema/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
 ]