Merge pull request #1829 from IFRCGo/feat/openapi

Add openapi endpoint

Author: szabozoltan69

deployments/serializers.py

@@ -47,7 +47,7 @@
 )
 
 
-class MiniUserSerializer(ModelSerializer):
+class DeploymentMiniUserSerializer(ModelSerializer):
     class Meta:
         model = User
         fields = (
@@ -365,7 +365,7 @@ class ProjectSerializer(ModelSerializer):
     status_display = serializers.CharField(source='get_status_display', read_only=True)
     visibility_display = serializers.CharField(source='get_visibility_display', read_only=True)
     annual_split_detail = AnnualSplitSerializer(source='annual_splits', many=True, read_only=True)
-    modified_by_detail = MiniUserSerializer(source='modified_by', read_only=True)
+    modified_by_detail = DeploymentMiniUserSerializer(source='modified_by', read_only=True)
 
     @staticmethod
     def get_secondary_sectors_display(obj):
@@ -553,8 +553,8 @@ class EmergencyProjectSerializer(
     NestedCreateMixin,
     ModelSerializer,
 ):
-    created_by_details = MiniUserSerializer(source='created_by', read_only=True)
-    modified_by_details = MiniUserSerializer(source='modified_by', read_only=True)
+    created_by_details = DeploymentMiniUserSerializer(source='created_by', read_only=True)
+    modified_by_details = DeploymentMiniUserSerializer(source='modified_by', read_only=True)
     event_details = MiniEventSerializer(source='event', read_only=True)
     reporting_ns_details = MiniCountrySerializer(source='reporting_ns', read_only=True)
     deployed_eru_details = ERUMiniSerializer(source='deployed_eru', read_only=True)

lang/permissions.py

@@ -16,7 +16,7 @@ def has_permission(self, request, view):
                 hasattr(request, '_request') and request.path[:6] == '/docs/' and \
                 hasattr(view, 'basename') and view.basename == 'language':
             return True
-        return String.has_perm(request.user, view.kwargs['pk'])
+        return String.has_perm(request.user, view.kwargs.get('pk'))
 
     def has_object_permission(self, request, view, obj):
         return self.has_permission(self, request, view)

local_units/serializers.py

@@ -5,7 +5,7 @@
 from api.models import Country
 
 
-class CountrySerializer(ModelSerializer):
+class LocalUnitCountrySerializer(ModelSerializer):
 
     class Meta:
         model = Country
@@ -23,7 +23,7 @@ class Meta:
 
 class LocalUnitSerializer(ModelSerializer):
     location = SerializerMethodField()
-    country = CountrySerializer()
+    country = LocalUnitCountrySerializer()
     type = LocalUnitTypeSerializer()
     class Meta:
         model = LocalUnit

main/exception_handler.py

@@ -14,6 +14,8 @@
     'Please contact an admin to fix this issue.'
 )
 
+logger = logging.getLogger(__name__)
+
 
 def custom_exception_handler(exc, context):
     # Default exception handler
@@ -45,6 +47,11 @@ def custom_exception_handler(exc, context):
                     'non_field_errors': [standard_error_string]
                 },
             }
+            logger.error(
+                '{}.{}'.format(type(exc).__module__, type(exc).__name__),
+                exc_info=True,
+                extra={'request': context.get('request')},
+            )
         response = Response(response_data, status=status.HTTP_500_INTERNAL_SERVER_ERROR)
 
     return response

main/settings.py

@@ -140,6 +140,7 @@
 INSTALLED_APPS = [
     # External App (This app has to defined before django.contrib.admin)
     'modeltranslation',  # https://django-modeltranslation.readthedocs.io/en/latest/installation.html#installed-apps
+    'drf_spectacular',
 
     # Django Apps
     'django.contrib.admin',
@@ -207,7 +208,7 @@
         'rest_framework.renderers.BrowsableAPIRenderer',
         'rest_framework_csv.renderers.PaginatedCSVRenderer',
     ),
-    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
 }
 
 GRAPHENE = {
@@ -558,5 +559,12 @@
 }
 CACHE_MIDDLEWARE_SECONDS = env('CACHE_MIDDLEWARE_SECONDS')  # Planned: 600 for staging, 60 from prod
 
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'IFRC-GO API',
+    'DESCRIPTION': 'IFRC-GO API Documenation',
+    'VERSION': '1.0.0',
+    'SERVE_INCLUDE_SCHEMA': False,
+}
+
 # Need to load this to overwrite modeltranslation module
 import main.translation  # noqa: F401 E402

main/urls.py

@@ -73,7 +73,7 @@
 
 # DRF routes
 from rest_framework import routers
-from rest_framework.documentation import include_docs_urls
+from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
 from api import drf_views as api_views
 from flash_update import views as flash_views
 from per import drf_views as per_views
@@ -230,14 +230,17 @@
     url(r"^api/v2/exportperresults/", per_views.ExportAssessmentToCSVViewset.as_view()),
     url(r"^api/v2/local-unit/(?P<pk>\d+)", LocalUnitDetailAPIView.as_view()),
     url(r"^api/v2/local-unit/", LocalUnitListAPIView.as_view()),
-    url(r"^docs/", include_docs_urls(title="IFRC GO API", public=False)),
     url(r"^tinymce/", include("tinymce.urls")),
     url(r"^$", RedirectView.as_view(url="/admin")),
     # url(r'^', admin.site.urls),
     url(r"^favicon\.ico$", RedirectView.as_view(url="/static/favicon.ico")),
     url(r"^server-error-for-devs", DummyHttpStatusError.as_view()),
     url(r"^exception-error-for-devs", DummyExceptionError.as_view()),
     path("i18n/", include("django.conf.urls.i18n")),
+    # Docs
+    path("docs/", SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
+    path("api-docs/", SpectacularAPIView.as_view(), name='schema'),
+    path("api-docs/swagger-ui/", SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
 ]
 
 if settings.DEBUG:
@@ -248,9 +251,7 @@
             url("__debug__/", include(debug_toolbar.urls)),
             # For django versions before 2.0:
             # url(r'^__debug__/', include(debug_toolbar.urls)),
-        ]
-        + urlpatterns
-        + static.static(
+        ] + urlpatterns + static.static(
             settings.MEDIA_URL,
             view=xframe_options_exempt(serve),
             document_root=settings.MEDIA_ROOT,

per/serializers.py

@@ -142,14 +142,14 @@ class Meta:
         fields = ('id', 'country', 'phase', 'phase_display', 'updated_at')
 
 
-class MiniUserSerializer(serializers.ModelSerializer):
+class PerMiniUserSerializer(serializers.ModelSerializer):
     class Meta:
         model = User
         fields = ('id', 'first_name', 'last_name', 'email')
 
 
 class WorkPlanSerializer(serializers.ModelSerializer):
-    user = MiniUserSerializer()
+    user = PerMiniUserSerializer()
     prioritization_display = serializers.CharField(source='get_prioritization_display', read_only=True)
     status_display = serializers.CharField(source='get_status_display', read_only=True)
 
@@ -165,7 +165,7 @@ class Meta:
 
 
 class OverviewSerializer(serializers.ModelSerializer):
-    user = MiniUserSerializer()
+    user = PerMiniUserSerializer()
     country = RegoCountrySerializer()
     type_of_assessment = AssessmentTypeSerializer()
     included_forms = serializers.CharField(source='get_included_forms', read_only=True)