org.qore.Swagger
Swagger
qore-lang
doxygen

# Qore Swagger Module Reference 1.0.1

## Swagger module

Swagger Module Introduction

### Swagger Usage

Swagger Client-Side Usage

Swagger Server-Side Usage

### Swagger Module Release Notes

Swagger v1.0.1

Swagger v1.0

## Namespaces

### Namespace List

Swagger

### Namespace Members

All

Variables

## Classes

### Class List

#### Swagger

##### AbstractParameterObject

check

constructor

getDefaultValue

desc

inLoc

name

required

##### BodyParameter

check

constructor

getQoreExample

schema

##### ContactObject

constructor

email

name

url

##### ExternalDocumentationObject

constructor

desc

url

##### HeaderObject

constructor

collectionFormat

defaultVal

desc

format

items

type

##### InfoObject

constructor

contact

desc

license

termsOfService

title

version

##### LicenseObject

constructor

name

url

##### ObjectBase

constructor

constructor

constructor

initialize

vendorExtensions

##### OperationObject

checkMissingParams

constructor

doDefaultParams

error

getExampleRequest

getExampleResponse

getQoreExampleRequest

getQoreExampleResponse

getResponse

parameters

parseRequest

validateRequest

validateResponse

body

consumes

deprec

desc

externalDocs

method

operationId

path

produces

responses

schemes

security

summary

tags

##### OtherParameter

check

constructor

getDefaultValue

getExampleValue

allowEmptyValue

collectionFormat

defaultVal

format

items

ParameterTypes

type

##### ParameterItemsSchemaObject

constructor

collectionFormat

##### PathComponent

add

constructor

constructor

getPathOperationHash

match

name

paths

pfx

pio

wildcard

##### PathItemObject

constructor

getMethods

getOperation

parameters

body

operations

ref

##### PathsObject

constructor

getPathOperationHash

match

paths

##### ResponseObject

constructor

desc

examples

headers

schema

##### ResponsesObject

constructor

defaultResp

responses

##### SchemaBase

check

checkArrayParam

checkIntern

checkIntern

checkIntern

constructor

constructor

getExampleValue

enum

exclusiveMax

exclusiveMin

maximum

maxItems

maxLength

minimum

minItems

minLength

multipleOf

pattern

uniqueItems

##### SchemaObject

allOf

check

checkIntern

constructor

getQoreExample

additionalProperties

defaultVal

desc

discriminator

example

externalDocs

format

items

maxProperties

minProperties

name

properties

readOnly

ReferenceTypes

required

ScalarTypes

title

type

xml

##### ScopesObject

constructor

fields

##### SecuritySchemeObject

constructor

authorizationUrl

desc

flow

inLoc

name

scopes

tokenUrl

type

SwaggerLoader

##### SwaggerSchema

constructor

definitions

getBasePathImpl

getExampleRequestImpl

getExampleResponseImpl

getExternalReference

getPathOperationHashImpl

getQoreExampleRequestImpl

getQoreExampleResponseImpl

getTargetUrlImpl

parameters

parseRequestImpl

parseResponseImpl

processRequestImpl

processResponseImpl

resolveParameter

resolveParameterItemsSchemaObject

resolveResponse

resolveSchemaObject

setBasePathImpl

basePath

compact_serialization

consumes

def_path

externalDocs

host

info

paths

private

produces

responses

schemes

security

securityDefinitions

SwaggerOptions

swaggerSpec

tags

try_import

##### TagObject

constructor

desc

externalDocs

name

##### XmlObject

constructor

attribute

name

ns

prefix

wrapped

Class Index

### Class Hierarchy

#### Swagger::ObjectBase

##### Swagger::AbstractParameterObject

Swagger::BodyParameter

Swagger::OtherParameter

Swagger::ContactObject

Swagger::ExternalDocumentationObject

Swagger::HeaderObject

Swagger::InfoObject

Swagger::LicenseObject

Swagger::OperationObject

Swagger::PathItemObject

Swagger::PathsObject

Swagger::ResponseObject

Swagger::ResponsesObject

##### Swagger::SchemaObject

Swagger::ParameterItemsSchemaObject

Swagger::ScopesObject

Swagger::SecuritySchemeObject

Swagger::SwaggerSchema

Swagger::TagObject

Swagger::XmlObject

Swagger::PathComponent

#### Swagger::SchemaBase

Swagger::HeaderObject

Swagger::OtherParameter

Swagger::SchemaObject

Swagger::SwaggerLoader

### Class Members

#### All

a

b

c

d

e

f

g

h

i

l

m

n

o

p

r

s

t

u

v

w

x

Functions

Variables

tabs.css
tab_a.png
tab_b.png
tab_h.png
tab_s.png
nav_h.png
nav_f.png
bc_s.png
doxygen.png
closed.png
open.png
bdwn.png
sync_on.png
sync_off.png
doxygen.css
jquery.js
dynsections.js
search/search_l.png
search/search_m.png
search/search_r.png
search/close.png
search/mag_sel.png
search/search.css
search/search.js
_swagger_8qm_8dox_8h_source.html
namespace_swagger.html
class_swagger_1_1_abstract_parameter_object.html
class_swagger_1_1_abstract_parameter_object__inherit__graph.png
class_swagger_1_1_abstract_parameter_object-members.html
class_swagger_1_1_body_parameter.html
class_swagger_1_1_body_parameter__inherit__graph.png
class_swagger_1_1_body_parameter-members.html
class_swagger_1_1_contact_object.html
class_swagger_1_1_contact_object__inherit__graph.png
class_swagger_1_1_contact_object-members.html
class_swagger_1_1_external_documentation_object.html
class_swagger_1_1_external_documentation_object__inherit__graph.png
class_swagger_1_1_external_documentation_object-members.html
class_swagger_1_1_header_object.html
class_swagger_1_1_header_object__inherit__graph.png
class_swagger_1_1_header_object-members.html
class_swagger_1_1_info_object.html
class_swagger_1_1_info_object__inherit__graph.png
class_swagger_1_1_info_object-members.html
class_swagger_1_1_license_object.html
class_swagger_1_1_license_object__inherit__graph.png
class_swagger_1_1_license_object-members.html
class_swagger_1_1_object_base.html
class_swagger_1_1_object_base__inherit__graph.png
class_swagger_1_1_object_base-members.html
class_swagger_1_1_operation_object.html
class_swagger_1_1_operation_object__inherit__graph.png
class_swagger_1_1_operation_object-members.html
class_swagger_1_1_other_parameter.html
class_swagger_1_1_other_parameter__inherit__graph.png
class_swagger_1_1_other_parameter-members.html
class_swagger_1_1_parameter_items_schema_object.html
class_swagger_1_1_parameter_items_schema_object__inherit__graph.png
class_swagger_1_1_parameter_items_schema_object-members.html
class_swagger_1_1_path_component.html
class_swagger_1_1_path_component-members.html
class_swagger_1_1_path_item_object.html
class_swagger_1_1_path_item_object__inherit__graph.png
class_swagger_1_1_path_item_object-members.html
class_swagger_1_1_paths_object.html
class_swagger_1_1_paths_object__inherit__graph.png
class_swagger_1_1_paths_object-members.html
class_swagger_1_1_response_object.html
class_swagger_1_1_response_object__inherit__graph.png
class_swagger_1_1_response_object-members.html
class_swagger_1_1_responses_object.html
class_swagger_1_1_responses_object__inherit__graph.png
class_swagger_1_1_responses_object-members.html
class_swagger_1_1_schema_base.html
class_swagger_1_1_schema_base__inherit__graph.png
class_swagger_1_1_schema_base-members.html
class_swagger_1_1_schema_object.html
class_swagger_1_1_schema_object__inherit__graph.png
class_swagger_1_1_schema_object-members.html
class_swagger_1_1_scopes_object.html
class_swagger_1_1_scopes_object__inherit__graph.png
class_swagger_1_1_scopes_object-members.html
class_swagger_1_1_security_scheme_object.html
class_swagger_1_1_security_scheme_object__inherit__graph.png
class_swagger_1_1_security_scheme_object-members.html
class_swagger_1_1_swagger_loader.html
class_swagger_1_1_swagger_loader-members.html
class_swagger_1_1_swagger_schema.html
class_swagger_1_1_swagger_schema__inherit__graph.png
class_swagger_1_1_swagger_schema-members.html
class_swagger_1_1_tag_object.html
class_swagger_1_1_tag_object__inherit__graph.png
class_swagger_1_1_tag_object-members.html
class_swagger_1_1_xml_object.html
class_swagger_1_1_xml_object__inherit__graph.png
class_swagger_1_1_xml_object-members.html
graph_legend.png
graph_legend.html
dir_4e8d938e9ddb5a617c200d5739d1f41a.html
dir_13add0083e006ac756009d5942a24d28.html
index.html
pages.html
namespaces.html
namespacemembers.html
namespacemembers.html
namespacemembers.html
namespacemembers.html
namespacemembers.html
namespacemembers_vars.html
namespacemembers_vars.html
namespacemembers_vars.html
namespacemembers_vars.html
namespacemembers_vars.html
annotated.html
classes.html
hierarchy.html
inherits.html
inherit_graph_0.png
inherit_graph_1.png
inherit_graph_2.png
functions.html
functions_b.html
functions_c.html
functions_d.html
functions_e.html
functions_f.html
functions_g.html
functions_h.html
functions_i.html
functions_l.html
functions_m.html
functions_n.html
functions_o.html
functions_p.html
functions_r.html
functions_s.html
functions_t.html
functions_u.html
functions_v.html
functions_w.html
functions_x.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_func.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html
functions_vars.html