From 182e1d4eac6c11f86fc41caa684cd2f9f2e1a8e4 Mon Sep 17 00:00:00 2001 From: "ying.yunlong" Date: Thu, 25 Jan 2018 10:00:45 +0800 Subject: [PATCH] Add vfc-vnflcm auto-swagger settings Change-Id: Ia113d9e1e1e02ebdcf85debf515f1018105a43e7 Issue-ID: VFC-682 Signed-off-by: ying.yunlong --- lcm/lcm/settings.py | 7 +++++++ lcm/lcm/swagger/urls.py | 26 ++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/lcm/lcm/settings.py b/lcm/lcm/settings.py index 988740ea..3d084a09 100644 --- a/lcm/lcm/settings.py +++ b/lcm/lcm/settings.py @@ -94,6 +94,13 @@ TEMPLATES = [ }, ] +SWAGGER_SETTINGS = { + 'LOGIN_URL': '/admin/login', + 'LOGOUT_URL': '/admin/logout', + + 'DEFAULT_INFO': 'lcm.swagger.urls.swagger_info' +} + DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', diff --git a/lcm/lcm/swagger/urls.py b/lcm/lcm/swagger/urls.py index 1b290a01..242a5ec8 100644 --- a/lcm/lcm/swagger/urls.py +++ b/lcm/lcm/swagger/urls.py @@ -13,8 +13,34 @@ # limitations under the License. from django.conf.urls import url +from drf_yasg import openapi +from drf_yasg.views import get_schema_view +from rest_framework import permissions + from lcm.swagger import views +swagger_info = openapi.Info( + title="vnflcm API", + default_version='v1', + description=""" + +The `swagger-ui` view can be found [here](/cached/swagger). +The `ReDoc` view can be found [here](/cached/redoc). +The swagger YAML document can be found [here](/cached/swagger.yaml).""" +) + +SchemaView = get_schema_view( + validators=['ssv', 'flex'], + public=True, + permission_classes=(permissions.AllowAny,), +) + urlpatterns = [ url(r'^api/vnflcm/v1/swagger.json$', views.SwaggerView.as_view()), + url(r'^swagger(?P.json|.yaml)$', SchemaView.without_ui(cache_timeout=0), name='schema-json'), + url(r'^swagger/$', SchemaView.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'), + url(r'^redoc/$', SchemaView.with_ui('redoc', cache_timeout=0), name='schema-redoc'), + url(r'^cached/swagger(?P.json|.yaml)$', SchemaView.without_ui(cache_timeout=None), name='cschema-json'), + url(r'^cached/swagger/$', SchemaView.with_ui('swagger', cache_timeout=None), name='cschema-swagger-ui'), + url(r'^cached/redoc/$', SchemaView.with_ui('redoc', cache_timeout=None), name='cschema-redoc'), ] -- 2.16.6