utils/test/testapi/opnfv_testapi/tornado_swagger/views.py

   1 ##############################################################################
   2 # Copyright (c) 2016 ZTE Corporation
   3 # feng.xiaowei@zte.com.cn
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9 import inspect
  10 import json
  11
  12 import tornado.template
  13 import tornado.web
  14
  15 from opnfv_testapi.tornado_swagger import settings
  16
  17
  18 def json_dumps(obj, pretty=False):
  19     return json.dumps(obj,
  20                       sort_keys=True,
  21                       indent=4,
  22                       separators=(',', ': ')) if pretty else json.dumps(obj)
  23
  24
  25 class SwaggerUIHandler(tornado.web.RequestHandler):
  26     def initialize(self, **kwargs):
  27         self.static_path = kwargs.get('static_path')
  28         self.base_url = kwargs.get('base_url')
  29
  30     def get_template_path(self):
  31         return self.static_path
  32
  33     def get(self):
  34         resource_url = self.reverse_url(settings.RESOURCE_LISTING_NAME)
  35         discovery_url = self.base_url + resource_url
  36         self.render('swagger/index.html', discovery_url=discovery_url)
  37
  38
  39 class SwaggerResourcesHandler(tornado.web.RequestHandler):
  40     def initialize(self, **kwargs):
  41         self.api_version = kwargs.get('api_version')
  42         self.swagger_version = kwargs.get('swagger_version')
  43         self.base_url = kwargs.get('base_url')
  44         self.exclude_namespaces = kwargs.get('exclude_namespaces')
  45
  46     def get(self):
  47         self.set_header('content-type', 'application/json')
  48         resources = {
  49             'apiVersion': self.api_version,
  50             'swaggerVersion': self.swagger_version,
  51             'basePath': self.base_url,
  52             'apis': [{
  53                 'path': self.reverse_url(settings.API_DECLARATION_NAME),
  54                 'description': 'Restful APIs Specification'
  55             }]
  56         }
  57
  58         self.finish(json_dumps(resources, self.get_arguments('pretty')))
  59
  60
  61 class SwaggerApiHandler(tornado.web.RequestHandler):
  62     def initialize(self, **kwargs):
  63         self.api_version = kwargs.get('api_version')
  64         self.swagger_version = kwargs.get('swagger_version')
  65         self.base_url = kwargs.get('base_url')
  66
  67     def get(self):
  68         self.set_header('content-type', 'application/json')
  69         apis = self.find_api(self.application.handlers)
  70         if apis is None:
  71             raise tornado.web.HTTPError(404)
  72
  73         specs = {
  74             'apiVersion': self.api_version,
  75             'swaggerVersion': self.swagger_version,
  76             'basePath': self.base_url,
  77             'resourcePath': '/',
  78             'produces': ["application/json"],
  79             'apis': [self.__get_api_spec__(path, spec, operations)
  80                      for path, spec, operations in apis],
  81             'models': self.__get_models_spec(settings.models)
  82         }
  83         self.finish(json_dumps(specs, self.get_arguments('pretty')))
  84
  85     def __get_models_spec(self, models):
  86         models_spec = {}
  87         for model in models:
  88             models_spec.setdefault(model.id, self.__get_model_spec(model))
  89         return models_spec
  90
  91     @staticmethod
  92     def __get_model_spec(model):
  93         return {
  94             'description': model.summary,
  95             'id': model.id,
  96             'notes': model.notes,
  97             'properties': model.properties,
  98             'required': model.required
  99         }
 100
 101     @staticmethod
 102     def __get_api_spec__(path, spec, operations):
 103         return {
 104             'path': path,
 105             'description': spec.handler_class.__doc__,
 106             'operations': [{
 107                 'httpMethod': api.func.__name__.upper(),
 108                 'nickname': api.nickname,
 109                 'parameters': api.params.values(),
 110                 'summary': api.summary,
 111                 'notes': api.notes,
 112                 'responseClass': api.responseClass,
 113                 'responseMessages': api.responseMessages,
 114             } for api in operations]
 115         }
 116
 117     @staticmethod
 118     def find_api(host_handlers):
 119         def get_path(url, args):
 120             return url % tuple(['{%s}' % arg for arg in args])
 121
 122         def get_operations(cls):
 123             return [member.rest_api
 124                     for (_, member) in inspect.getmembers(cls)
 125                     if hasattr(member, 'rest_api')]
 126
 127         for host, handlers in host_handlers:
 128             for spec in handlers:
 129                 for (_, mbr) in inspect.getmembers(spec.handler_class):
 130                     if inspect.ismethod(mbr) and hasattr(mbr, 'rest_api'):
 131                         path = get_path(spec._path, mbr.rest_api.func_args)
 132                         operations = get_operations(spec.handler_class)
 133                         yield path, spec, operations
 134                         break