lucee.Componentswagger-sdk.OpenAPI.Parser
Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- Open API Parser
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
baseDocumentPath
|
true
|
false
|
|
any
|
DocumentObject
|
true
|
false
|
|
any
|
jLoader
|
true
|
false
|
|
any
|
schemaType
|
true
|
false
|
|
any
|
Utils
|
true
|
false
|
|
any
|
Wirebox
|
true
|
false
|
Constructor Summary | |
---|---|
init([string APIDocPath])
Constructor. |
Method Summary | |
---|---|
private any
|
fetchDocumentReference(string $ref)
Fetches a document $ref object. |
string
|
getBaseDocumentPath()
|
string
|
getDocumentObject()
|
any
|
getInternalXPath(string XPath)
Retrieves the value from a nested struc when given an XPath argument. |
string
|
getJLoader()
|
any
|
getNormalizedDocument()
Convenience method to return the fully normalize document. |
string
|
getSchemaType()
|
string
|
getUtils()
|
string
|
getWirebox()
|
private any
|
loadAsLinkedHashMap(string JSONData)
Loads a linked hash map from a JSON file. |
any
|
parse(struct APIDoc, string XPath='')
Parses an API Document recursively. |
any
|
parseDocumentReferences(any DocItem)
Parses API Document $ref notations recursively. |
any
|
setBaseDocumentPath(any baseDocumentPath)
|
any
|
setDocumentObject(any DocumentObject)
|
any
|
setJLoader(any jLoader)
|
any
|
setSchemaType(any schemaType)
|
any
|
setUtils(any Utils)
|
any
|
setWirebox(any Wirebox)
|
private any
|
throwInvalidJSONException(string InvalidContent)
Multi-use error throw. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
APIDocPath
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- loader@cbjavaloaderserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- OpenAPIUtil@SwaggerSDKserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- wireboxserializable
- trueMethod Detail |
---|
Fetches a document $ref object
$ref
Retrieves the value from a nested struc when given an XPath argument
XPath
Convenience method to return the fully normalize document
Loads a linked hash map from a JSON file
JSONData
Parses an API Document recursively
APIDoc
XPath
Parses API Document $ref notations recursively
DocItem
baseDocumentPath
DocumentObject
jLoader
schemaType
Utils
Wirebox
Multi-use error throw
InvalidContent