lucee.Componentrelax.RelaxDSL.Translator
Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- Translator for RelaxDSL APIs in to OpenAPI Format
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
moduleConfig
|
true
|
false
|
|
any
|
SwaggerUtil
|
true
|
false
|
|
any
|
wirebox
|
true
|
false
|
Method Summary | |
---|---|
string
|
getModuleConfig()
|
string
|
getSwaggerUtil()
|
string
|
getWirebox()
|
any
|
onDIComplete()
|
private void
|
processGlobalExtensions(any dataCFC, any translation)
Translate RelaxDSL Coldbox attributes in to OpenAPI extensions. |
private any
|
processPathParameters(any path, [any resource])
Processes RelaxDSL resource parameters. |
private any
|
processPathSamples(any path, any resource)
Processes RelaxDSL samples to the paths. |
private any
|
processPathSchemas(any path, any resource)
Processes RelaxDSL resource schemas. |
any
|
setModuleConfig(any moduleConfig)
|
any
|
setSwaggerUtil(any SwaggerUtil)
|
any
|
setWirebox(any wirebox)
|
any
|
translate(any dataCFC)
Translates a RelaxDSL CFC in to the OpenAPI specification. |
private void
|
translateGlobals(any dataCFC, any translation)
Translate RelaxDSL global variables in to the OpenAPI specification. |
private void
|
translateMimeTypes(any dataCFC, any translation)
Translate RelaxDSL mimetype annotations in to full mimetype values. |
private string
|
translatePathKey([any pattern])
Translate RelaxDSL Coldbox routes to use OpenAPI placeholders. |
private void
|
translatePathMethods(struct path, struct resource, any translation)
Translate RelaxDSL resource patterns in to OpenAPI path methods. |
private any
|
translatePaths(any dataCFC, any translation)
Translate RelaxDSL resources in to OpenAPI paths. |
private void
|
translateSecurityDefinitions(any dataCFC, any translation)
Translate RelaxDSL security headers in to OpenAPI security definitions. |
private void
|
translateURLs(any dataCFC, any translation)
Translate RelaxDSL entry points in to the OpenAPI specification. |
Methods inherited from class lucee.Component |
---|
None |
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- coldbox:setting:relaxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- OpenAPIUtil@SwaggerSDKserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- wireboxserializable
- trueMethod Detail |
---|
Translate RelaxDSL Coldbox attributes in to OpenAPI extensions
dataCFC
translation
Processes RelaxDSL resource parameters
path
resource
Processes RelaxDSL samples to the paths
path
resource
Processes RelaxDSL resource schemas
path
resource
moduleConfig
SwaggerUtil
wirebox
Translates a RelaxDSL CFC in to the OpenAPI specification
dataCFC
Translate RelaxDSL global variables in to the OpenAPI specification
dataCFC
translation
Translate RelaxDSL mimetype annotations in to full mimetype values
dataCFC
translation
Translate RelaxDSL Coldbox routes to use OpenAPI placeholders
pattern
Translate RelaxDSL resource patterns in to OpenAPI path methods
path
resource
translation
Translate RelaxDSL resources in to OpenAPI paths
dataCFC
translation
Translate RelaxDSL security headers in to OpenAPI security definitions
dataCFC
translation
Translate RelaxDSL entry points in to the OpenAPI specification
dataCFC
translation