WIP: Added API documentation

cms/djangoapps/contentstore/api/views.py

 """ API v0 views. """
 import base64
 import logging
-import os
-
-from path import Path as path
-from six import text_type
 
+import os
 from django.conf import settings
-from django.contrib.auth import get_user_model
-from django.views.decorators.csrf import csrf_exempt
-
 from django.core.files import File
-from opaque_keys import InvalidKeyError
 from opaque_keys.edx.keys import CourseKey
+from path import Path as path
 from rest_framework import status
 from rest_framework.exceptions import AuthenticationFailed
-from rest_framework.generics import GenericAPIView
 from rest_framework.response import Response
-from user_tasks.models import UserTaskArtifact, UserTaskStatus
-
-from student.auth import has_course_author_access
+from rest_framework.views import APIView
+from six import text_type
+from user_tasks.models import UserTaskStatus
 
 from contentstore.storage import course_import_export_storage
 from contentstore.tasks import CourseImportTask, import_olx
 from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes
+from student.auth import has_course_author_access
 
 log = logging.getLogger(__name__)
 
@@ -42,7 +36,7 @@ class CourseImportExportViewMixin(DeveloperErrorViewMixin):
             raise AuthenticationFailed
 
 
-class CourseImportView(CourseImportExportViewMixin, GenericAPIView):
+class CourseImportView(CourseImportExportViewMixin, APIView):
     """
     **Use Case**
 

cms/envs/common.py

@@ -910,6 +910,7 @@ INSTALLED_APPS = [
     'django.contrib.staticfiles',
     'djcelery',
     'method_override',
+    'rest_framework',
 
     # Common views
     'openedx.core.djangoapps.common_views',

cms/urls.py

@@ -4,6 +4,7 @@ from django.conf.urls.static import static
 from django.contrib.admin import autodiscover as django_autodiscover
 from django.utils.translation import ugettext_lazy as _
 from ratelimitbackend import admin
+from rest_framework.documentation import include_docs_urls
 
 from cms.djangoapps.contentstore.views.organization import OrganizationListView
 
@@ -75,6 +76,7 @@ urlpatterns = patterns(
     # For redirecting to help pages.
     url(r'^help_token/', include('help_tokens.urls')),
     url(r'^api/', include('cms.djangoapps.api.urls', namespace='api')),
+    url(r'^api-docs/', include_docs_urls(title='Studio API', public=True)),
 )
 
 # restful api

lms/djangoapps/support/views/enrollments.py

@@ -10,7 +10,7 @@ from django.utils.decorators import method_decorator
 from django.views.generic import View
 from opaque_keys import InvalidKeyError
 from opaque_keys.edx.keys import CourseKey
-from rest_framework.generics import GenericAPIView
+from rest_framework.views import APIView
 
 from course_modes.models import CourseMode
 from edxmako.shortcuts import render_to_response
@@ -40,7 +40,7 @@ class EnrollmentSupportView(View):
         })
 
 
-class EnrollmentSupportListView(GenericAPIView):
+class EnrollmentSupportListView(APIView):
     """
     Allows viewing and changing learner enrollments by support
     staff.

lms/urls.py

@@ -10,6 +10,7 @@ from django.contrib.admin import autodiscover as django_autodiscover
 from django.utils.translation import ugettext_lazy as _
 from django.views.generic.base import RedirectView
 from ratelimitbackend import admin
+from rest_framework.documentation import include_docs_urls
 
 from courseware.views.index import CoursewareIndex
 from courseware.views.views import CourseTabView, EnrollStaffView, StaticCourseTabView
@@ -119,6 +120,7 @@ urlpatterns = (
 
     url(r'^dashboard/', include('learner_dashboard.urls')),
     url(r'^api/experiments/', include('experiments.urls', namespace='api_experiments')),
+    url(r'^api-docs/', include_docs_urls(title='LMS API', public=False)),
 )
 
 # TODO: This needs to move to a separate urls.py once the student_account and

openedx/core/djangoapps/theming/urls.py

@@ -8,6 +8,8 @@ from .helpers import is_comprehensive_theming_enabled
 from .views import ThemingAdministrationFragmentView
 
 
+urlpatterns = []
+
 if is_comprehensive_theming_enabled():
     urlpatterns = [
         url(

requirements/edx/base.txt

@@ -11,6 +11,7 @@ bleach==1.4
 html5lib==0.999
 boto==2.39.0
 celery==3.1.18
+coreapi==2.3.3
 cryptography==1.5.3
 cssselect==0.9.1
 dealer==2.0.4