feat(swagger): add drf-yasg to automatically generate swagger in dev env

requirements/dev.txt

@@ -50,4 +50,7 @@ pytest-xdist==1.31.0
 cssselect==1.1.0
 
 # PostgreSQL database adapter for the Python
-psycopg2-binary==2.8.5
+psycopg2-binary==2.8.5
+
+# Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.
+drf-yasg==1.20.0

src/pycontw2016/settings/base.py

@@ -103,7 +103,8 @@
  'sorl.thumbnail',
  'registry',
  'corsheaders',
- 'rest_framework'
+ 'rest_framework',
+ 'drf_yasg',
 )
 
 LOCAL_APPS = (

src/pycontw2016/urls.py

@@ -4,11 +4,28 @@
 from django.conf.urls.static import static
 from django.contrib import admin
 from django.views.i18n import set_language
+from rest_framework import permissions
+from drf_yasg.views import get_schema_view
+from drf_yasg import openapi
 
 from core.views import error_page, flat_page, index
 from users.views import user_dashboard
 
 
+schema_view = get_schema_view(
+ openapi.Info(
+ title="Snippets API",
+ default_version='v1',
+ description="Test description",
+ terms_of_service="https://www.google.com/policies/terms/",
+ contact=openapi.Contact(email="[email protected]"),
+ license=openapi.License(name="BSD License"),
+ ),
+ public=True,
+ permission_classes=(permissions.AllowAny,),
+)
+
+
 urlpatterns = i18n_patterns(
 
  # Add top-level URL patterns here.
@@ -45,3 +62,8 @@
 if settings.DEBUG:
  import debug_toolbar
  urlpatterns += [url(r'^__debug__/', include(debug_toolbar.urls))]
+ urlpatterns += [
+ url(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
+ url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
+ url(r'^redoc/$', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
+ ]