ApiDeclaration Class Reference

Inheritance diagram for ApiDeclaration:

Collaboration diagram for ApiDeclaration:

Public Member Functions
	__init__ (self)
	load (self, api_decl_json, processor, context)
	load_file (self, api_declaration_file, processor)
Public Member Functions inherited from Stringify
	__repr__ (self)

Data Fields
	api_version
	apis
	author
	base_path
	copyright
	has_websocket
	models
	required_fields
	requires_modules
	resource_path
	since
	swagger_version

Static Public Attributes
list	required_fields

Detailed Description

Model class for an API Declaration.

See https://github.com/wordnik/swagger-core/wiki/API-Declaration

Definition at line 599 of file swagger_model.py.

Constructor & Destructor Documentation

__init__()

__init__

(

self

)

Definition at line 610 of file swagger_model.py.

    def __init__(self):
        self.swagger_version = None
        self.author = None
        self.copyright = None
        self.api_version = None
        self.base_path = None
        self.resource_path = None
        self.since = []
        self.apis = []
        self.models = []
 

Member Function Documentation

load()

load	(		self,
			api_decl_json,
			processor,
			context
	)

Loads a resource from a single Swagger resource.json file.

Definition at line 647 of file swagger_model.py.

    def load(self, api_decl_json, processor, context):
        """Loads a resource from a single Swagger resource.json file.
        """
        # If the version doesn't match, all bets are off.
        self.swagger_version = api_decl_json.get('swaggerVersion')
        context = context.next(version=self.swagger_version)
        if not self.swagger_version in SWAGGER_VERSIONS:
            raise SwaggerError(
                "Unsupported Swagger version %s" % self.swagger_version, context)
 
        validate_required_fields(api_decl_json, self.required_fields, context)
 
        self.author = api_decl_json.get('_author')
        self.copyright = api_decl_json.get('_copyright')
        self.api_version = api_decl_json.get('apiVersion')
        self.base_path = api_decl_json.get('basePath')
        self.resource_path = api_decl_json.get('resourcePath')
        self.requires_modules = api_decl_json.get('requiresModules') or []
        since = api_decl_json.get('since') or []
        self.since = ", ".join(since)
        api_json = api_decl_json.get('apis') or []
        self.apis = [
            Api().load(j, processor, context) for j in api_json]
        paths = set()
        for api in self.apis:
            if api.path in paths:
                raise SwaggerError("API with duplicated path: %s" % api.path, context)
            paths.add(api.path)
        self.has_websocket = any(api.has_websocket for api in self.apis)
        models = api_decl_json.get('models').items() or []
        self.models = [Model().load(id, json, processor, context)
                       for (id, json) in models]
        self.models = sorted(self.models, key=lambda m: m.id)
        # Now link all base/extended types
        model_dict = dict((m.id, m) for m in self.models)
        for m in self.models:
            def link_subtype(name):
                res = model_dict.get(name)
                if not res:
                    raise SwaggerError("%s has non-existing subtype %s",
                                       m.id, name)
                res.set_extends_type(m)
                return res;
            if m.subtypes:
                m.set_subtype_types([
                    link_subtype(subtype) for subtype in m.subtypes])
        return self
 
 

References ParsingContext.swagger_version, ApiDeclaration.swagger_version, and ResourceListing.swagger_version.

Referenced by ApiDeclaration.load_file(), and ResourceListing.load_file().

load_file()

load_file	(		self,
			api_declaration_file,
			processor
	)

Definition at line 621 of file swagger_model.py.

    def load_file(self, api_declaration_file, processor):
        context = ParsingContext(None, [api_declaration_file])
        try:
            return self.__load_file(api_declaration_file, processor, context)
        except SwaggerError:
            raise
        except Exception as e:
            print("Error: ", traceback.format_exc(), file=sys.stderr)
            raise SwaggerError(
                "Error loading %s" % api_declaration_file, context, e)
 

References ApiDeclaration.__load_file(), ResourceListing.__load_file(), ApiDeclaration.load(), Api.load(), ResourceApi.load(), ErrorResponse.load(), Model.load(), Operation.load(), Parameter.load(), Property.load(), ResourceListing.load(), SwaggerType.load(), ast_speech_engine.load, ast_sorcery_wizard.load, ast_module_info.load, replace(), and ApiDeclaration.resource_path.

Field Documentation

api_version

api_version

Definition at line 614 of file swagger_model.py.

apis

apis

Definition at line 618 of file swagger_model.py.

author

author

Definition at line 612 of file swagger_model.py.

base_path

base_path

Definition at line 615 of file swagger_model.py.

copyright

copyright

Definition at line 613 of file swagger_model.py.

has_websocket

has_websocket

Definition at line 675 of file swagger_model.py.

models

models

Definition at line 619 of file swagger_model.py.

required_fields [1/2]

list required_fields

static

Initial value:

=  [
        'swaggerVersion', '_author', '_copyright', 'apiVersion', 'basePath',
        'resourcePath', 'apis', 'models'
    ]

Definition at line 605 of file swagger_model.py.

required_fields [2/2]

required_fields

Definition at line 657 of file swagger_model.py.

requires_modules

requires_modules

Definition at line 664 of file swagger_model.py.

resource_path

resource_path

Definition at line 616 of file swagger_model.py.

Referenced by ApiDeclaration.load_file().

since

since

Definition at line 617 of file swagger_model.py.

swagger_version

swagger_version

Definition at line 611 of file swagger_model.py.

Referenced by ParsingContext.__repr__(), ApiDeclaration.load(), ResourceListing.load(), ParsingContext.next_stack(), and ParsingContext.version_less_than().

---

The documentation for this class was generated from the following file:

• swagger_model.py