Merge pull request #93 from c3g/swagger_docs

Add swagger view docs
bento-platform · Mar 6, 2020 · 92ecf93 · 92ecf93
2 parents 19ce0c1 + 4253436
commit 92ecf93
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/chord_metadata_service/metadata/settings.py b/chord_metadata_service/metadata/settings.py
@@ -68,6 +68,7 @@
 
     'rest_framework',
     'django_nose',
+    'rest_framework_swagger',
 ]
 
 MIDDLEWARE = [
@@ -165,7 +166,8 @@
         'djangorestframework_camel_case.parser.CamelCaseFormParser',
         'djangorestframework_camel_case.parser.CamelCaseMultiPartParser',
     ),
-    'DEFAULT_PERMISSION_CLASSES': ['chord_metadata_service.chord.permissions.OverrideOrSuperUserOnly']
+    'DEFAULT_PERMISSION_CLASSES': ['chord_metadata_service.chord.permissions.OverrideOrSuperUserOnly'],
+    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
 }
 
 # Password validation

diff --git a/chord_metadata_service/metadata/urls.py b/chord_metadata_service/metadata/urls.py
@@ -18,20 +18,22 @@
 from chord_metadata_service.restapi import api_views, urls as restapi_urls
 from chord_metadata_service.chord import views_ingest, views_search
 from rest_framework.schemas import get_schema_view
+from rest_framework_swagger.views import get_swagger_view
 
 # TODO: django.conf.settings breaks reverse(), how to import properly?
 from .settings import DEBUG
 
+swagger_schema_view = get_swagger_view(title="Metadata Service API")
 
 urlpatterns = [
-    path('', get_schema_view(
+    path('api/schema', get_schema_view(
         title="Metadata Service API",
         description="Metadata Service provides a phenotypic description of an Individual "
         "in the context of biomedical research.",
         version="0.1"
         ),
         name='openapi-schema'),
-
+    path('', swagger_schema_view),
     path('api/', include(restapi_urls)),
     path('service-info', api_views.service_info, name="service-info"),
 

diff --git a/requirements.txt b/requirements.txt
@@ -5,12 +5,14 @@ certifi==2019.11.28
 chardet==3.0.4
 chord-lib==0.5.0
 codecov==2.0.16
+colorama==0.4.3
 coreapi==2.3.3
 coreschema==0.0.4
 coverage==5.0.3
 Django==2.2.10
 django-filter==2.2.0
 django-nose==1.4.6
+django-rest-swagger==2.2.0
 djangorestframework==3.10.3
 djangorestframework-camel-case==1.1.2
 docutils==0.16

diff --git a/setup.py b/setup.py
@@ -32,6 +32,7 @@
         "rdflib-jsonld==0.4.0",
         "requests>=2.23,<3.0",
         "uritemplate>=3.0,<4.0",
+        "django-rest-swagger==2.2.0",
     ],
 
     author=config["package"]["authors"],