Swagger::SwaggerLoader Class Reference

Used for loading the Swagger definitions. More...

#include <Swagger.qm.dox.h>

Static Public Member Methods
static string	detectSourceEncoding (string str)
	tries to determine the Swagger schema source encoding automatically
static SwaggerSchema	fromFile (string filepath)
	Load Swagger definition from a file. More...
static SwaggerSchema	fromString (string swaggerSpecification, *bool json)
	Load Swagger definition from a string. More...
static SwaggerSchema	fromUrl (string url, *bool json)
	Load Swagger definition from a URL or file path. More...
static hash< auto >	parseSchemaContent (string filepath, string str)
	Load a schema definition from a file. More...
static hash< auto >	parseSchemaSource (string str, string ser)
	parses the source encoding from the given string

Detailed Description

Used for loading the Swagger definitions.

Member Function Documentation

fromFile()

static SwaggerSchema Swagger::SwaggerLoader::fromFile ( string  filepath )

static

Load Swagger definition from a file.

Parameters

filepath

path to the Swagger file

Exceptions

EMPTY-SCHEMA-FILE	Swagger file is empty
JSON-MODULE-MISSING	trying to parse a JSON Swagger specification with the json module unavailable
YAML-MODULE-MISSING	trying to parse a YAML Swagger specification with the yaml module unavailable
XML-MODULE-MISSING	trying to parse an XML Swagger specification with the xml module unavailable

fromString()

static SwaggerSchema Swagger::SwaggerLoader::fromString ( string  swaggerSpecification, *bool  json  )

static

Load Swagger definition from a string.

Parameters

swaggerSpecification	Swagger API specification
json	whether the specification is in JSON or YAML format; if not given the source encoding will be detected automatically

Exceptions

JSON-MODULE-MISSING	trying to parse a JSON Swagger specification with JSON module unavailable
YAML-MODULE-MISSING	trying to parse a YAML Swagger specification with YAML module unavailable

fromUrl()

static SwaggerSchema Swagger::SwaggerLoader::fromUrl ( string  url, *bool  json  )

static

Load Swagger definition from a URL or file path.

Parameters

url	URL to the Swagger file; uses the FileLocationHandler to load the file
json	whether the specification is in JSON or YAML format; if not given the source encoding will be detected automatically

Exceptions

EMPTY-SCHEMA-FILE	Swagger file is empty
JSON-MODULE-MISSING	trying to parse a JSON Swagger specification with the json module unavailable
YAML-MODULE-MISSING	trying to parse a YAML Swagger specification with the yaml module unavailable
XML-MODULE-MISSING	trying to parse an XML Swagger specification with the xml module unavailable

parseSchemaContent()

static hash< auto > Swagger::SwaggerLoader::parseSchemaContent ( string  filepath, string  str  )

static

Load a schema definition from a file.

Parameters

filepath	path to the schema file
str	the file content to parse

Exceptions

EMPTY-SCHEMA-FILE	schema file is empty
JSON-MODULE-MISSING	trying to parse a JSON schema with the json module unavailable
YAML-MODULE-MISSING	trying to parse a YAML schema specification with the yaml module unavailable
XML-MODULE-MISSING	trying to parse an XML schema specification with the xml module unavailable