res/res/urls.py

   1 # Copyright 2017 ZTE Corporation.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #         http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 from django.conf.urls import include, url
  16 from drf_yasg import openapi
  17 from drf_yasg.views import get_schema_view
  18 from rest_framework import permissions
  19
  20 from res.pub.config.config import REG_TO_MSB_WHEN_START, REG_TO_MSB_REG_URL, REG_TO_MSB_REG_PARAM
  21
  22 swagger_info = openapi.Info(
  23     title="vnfres API",
  24     default_version='v1',
  25     description="""
  26
  27 The `swagger-ui` view can be found [here](/cached/swagger).
  28 The `ReDoc` view can be found [here](/cached/redoc).
  29 The swagger YAML document can be found [here](/cached/swagger.yaml)."""
  30 )
  31
  32 SchemaView = get_schema_view(
  33     validators=['ssv', 'flex'],
  34     public=True,
  35     permission_classes=(permissions.AllowAny,),
  36 )
  37
  38 urlpatterns = [
  39     url(r'^', include('res.samples.urls')),
  40     url(r'^', include('res.swagger.urls')),
  41     url(r'^', include('res.resources.urls')),
  42     url(r'^swagger(?P<format>.json|.yaml)$', SchemaView.without_ui(cache_timeout=0), name='schema-json'),
  43     url(r'^swagger/$', SchemaView.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
  44     url(r'^redoc/$', SchemaView.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
  45     url(r'^cached/swagger(?P<format>.json|.yaml)$', SchemaView.without_ui(cache_timeout=None), name='cschema-json'),
  46     url(r'^cached/swagger/$', SchemaView.with_ui('swagger', cache_timeout=None), name='cschema-swagger-ui'),
  47     url(r'^cached/redoc/$', SchemaView.with_ui('redoc', cache_timeout=None), name='cschema-redoc'),
  48 ]
  49
  50 # regist to MSB when startup
  51 if REG_TO_MSB_WHEN_START:
  52     import json
  53     from res.pub.utils.restcall import req_by_msb
  54     req_by_msb(REG_TO_MSB_REG_URL, "POST", json.JSONEncoder().encode(REG_TO_MSB_REG_PARAM))