relax.RelaxDSL

Class Translator

lucee.Component
    extended by relax.RelaxDSL.Translator

Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- Translator for RelaxDSL APIs in to OpenAPI Format

Class Attributes:
  • singleton
  •  
  • eol : v4.0.0
  •  
  • deprecated : v3.0.0
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any moduleConfig


    • access = public
    • returntype = any
    • inject = coldbox:setting:relax
    true false
    any SwaggerUtil


    • access = public
    • returntype = any
    • inject = OpenAPIUtil@SwaggerSDK
    true false
    any wirebox


    • access = public
    • returntype = any
    • inject = 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

    moduleConfig

    property any moduleConfig

    Attributes:
    access - public
    required - false
    returntype - any
    inject - coldbox:setting:relax
    serializable - true

    SwaggerUtil

    property any SwaggerUtil

    Attributes:
    access - public
    required - false
    returntype - any
    inject - OpenAPIUtil@SwaggerSDK
    serializable - true

    wirebox

    property any wirebox

    Attributes:
    access - public
    required - false
    returntype - any
    inject - wirebox
    serializable - true

    Method Detail

    getModuleConfig

    public string getModuleConfig()


    getSwaggerUtil

    public string getSwaggerUtil()


    getWirebox

    public string getWirebox()


    onDIComplete

    public any onDIComplete()


    processGlobalExtensions

    private void processGlobalExtensions(any dataCFC, any translation)

    Translate RelaxDSL Coldbox attributes in to OpenAPI extensions

    Parameters:
    dataCFC
    translation

    processPathParameters

    private any processPathParameters(any path, [any resource])

    Processes RelaxDSL resource parameters

    Parameters:
    path
    resource

    processPathSamples

    private any processPathSamples(any path, any resource)

    Processes RelaxDSL samples to the paths

    Parameters:
    path
    resource

    processPathSchemas

    private any processPathSchemas(any path, any resource)

    Processes RelaxDSL resource schemas

    Parameters:
    path
    resource

    setModuleConfig

    public any setModuleConfig(any moduleConfig)

    Parameters:
    moduleConfig

    setSwaggerUtil

    public any setSwaggerUtil(any SwaggerUtil)

    Parameters:
    SwaggerUtil

    setWirebox

    public any setWirebox(any wirebox)

    Parameters:
    wirebox

    translate

    public any translate(any dataCFC)

    Translates a RelaxDSL CFC in to the OpenAPI specification

    Parameters:
    dataCFC

    translateGlobals

    private void translateGlobals(any dataCFC, any translation)

    Translate RelaxDSL global variables in to the OpenAPI specification

    Parameters:
    dataCFC
    translation

    translateMimeTypes

    private void translateMimeTypes(any dataCFC, any translation)

    Translate RelaxDSL mimetype annotations in to full mimetype values

    Parameters:
    dataCFC
    translation

    translatePathKey

    private string translatePathKey([any pattern])

    Translate RelaxDSL Coldbox routes to use OpenAPI placeholders

    Parameters:
    pattern

    translatePathMethods

    private void translatePathMethods(struct path, struct resource, any translation)

    Translate RelaxDSL resource patterns in to OpenAPI path methods

    Parameters:
    path
    resource
    translation

    translatePaths

    private any translatePaths(any dataCFC, any translation)

    Translate RelaxDSL resources in to OpenAPI paths

    Parameters:
    dataCFC
    translation

    translateSecurityDefinitions

    private void translateSecurityDefinitions(any dataCFC, any translation)

    Translate RelaxDSL security headers in to OpenAPI security definitions

    Parameters:
    dataCFC
    translation

    translateURLs

    private void translateURLs(any dataCFC, any translation)

    Translate RelaxDSL entry points in to the OpenAPI specification

    Parameters:
    dataCFC
    translation