Add API document generator, resolves doccano#299, resolves doccano#646

Author: Hironsan

app/api/urls.py

@@ -46,4 +46,4 @@
          RoleMappingDetail.as_view(), name='rolemapping_detail'),
 ]
 
-urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'xml'])
+# urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'xml'])

app/api/views.py

@@ -170,6 +170,7 @@ class DocumentDetail(generics.RetrieveUpdateDestroyAPIView):
 class AnnotationList(generics.ListCreateAPIView):
     pagination_class = None
     permission_classes = [IsAuthenticated & IsInProjectOrAdmin]
+    swagger_schema = None
 
     def get_serializer_class(self):
         project = get_object_or_404(Project, pk=self.kwargs['project_id'])
@@ -197,6 +198,7 @@ def perform_create(self, serializer):
 class AnnotationDetail(generics.RetrieveUpdateDestroyAPIView):
     lookup_url_kwarg = 'annotation_id'
     permission_classes = [IsAuthenticated & (((IsAnnotator | IsAnnotationApprover) & IsOwnAnnotation) | IsProjectAdmin)]
+    swagger_schema = None
 
     def get_serializer_class(self):
         project = get_object_or_404(Project, pk=self.kwargs['project_id'])

app/app/settings.py

@@ -61,6 +61,7 @@
     'polymorphic',
     'webpack_loader',
     'corsheaders',
+    'drf_yasg'
 ]
 
 CLOUD_BROWSER_APACHE_LIBCLOUD_PROVIDER = env('CLOUD_BROWSER_LIBCLOUD_PROVIDER', None)

app/app/urls.py

@@ -15,10 +15,23 @@
 """
 from django.conf import settings
 from django.contrib import admin
-from django.urls import path, include, re_path
+from django.urls import path, include
 from django.contrib.auth.views import PasswordResetView, LogoutView
+from drf_yasg.views import get_schema_view
+from drf_yasg import openapi
+
 from server.views import LoginView
 
+# TODO: adds AnnotationList and AnnotationDetail endpoint.
+schema_view = get_schema_view(
+   openapi.Info(
+      title="doccano API",
+      default_version='v1',
+      description="doccano API description",
+      license=openapi.License(name="MIT License"),
+   ),
+   public=True,
+)
 
 urlpatterns = [
     path('', include('authentification.urls')),
@@ -30,6 +43,7 @@
     path('password_reset/', PasswordResetView.as_view(), name='password_reset'),
     path('api-auth/', include('rest_framework.urls')),
     path('v1/', include('api.urls')),
+    path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
 ]
 
 if 'cloud_browser' in settings.INSTALLED_APPS:

app/requirements.txt

@@ -17,6 +17,7 @@ django-rest-polymorphic==0.1.8
 djangorestframework==3.10
 djangorestframework-csv==2.1.0
 djangorestframework-filters==0.10.2
+drf-yasg==1.17.1
 environs==4.1.0
 djangorestframework-xml==1.4.0
 Faker==0.9.1

requirements.txt

@@ -19,6 +19,7 @@ djangorestframework-csv==2.1.0
 djangorestframework-filters==0.10.2
 environs==4.1.0
 djangorestframework-xml==1.4.0
+drf-yasg==1.17.1
 Faker==0.9.1
 flake8==3.6.0
 furl==2.0.0