Option enableSwagger

Features

Feature Condition Description
ApiComponentSwagger component.getOption('enableJaxrs').defined and component.getOption('enableSwagger').defined and (new net.democritus.expander.rest.helper.RestApplicationApiHelper()).isMainApiComponent(component) Expands Swagger related features for REST at the component level for main API components.
ApplicationSwagger applicationInstance.application.components. exists(:[ #this.getOption('enableJaxrs').defined and #this.getOption('enableSwagger').defined ]) Expands Swagger related features for REST at the application level.
ComponentSwagger component.getOption('enableJaxrs').defined and component.getOption('enableSwagger').defined Expands Swagger related features for REST at the component level.
DataElementSwagger dataElement.component.getOption('enableJaxrs').defined and dataElement.getOption('includeJaxrsConnector').defined and dataElement.component.getOption('enableSwagger').defined Expands Swagger related features for REST at the data element level.

Expanders

Expander Type Artifact Condition
SwaggerServletExpander Component $component.name;format="firstToUpper"$SwaggerServlet.java component.getOption('enableJaxrs').defined and component.getOption('enableSwagger').defined and (new net.democritus.expander.rest.helper.RestApplicationApiHelper()).isMainApiComponent(component)
SwaggerUiExpander Component $component.name$-swagger.html component.getOption('enableJaxrs').defined and component.getOption('enableSwagger').defined and (new net.democritus.expander.rest.helper.RestApplicationApiHelper()).isMainApiComponent(component)

Expansion Steps

Expansion Step Type Phase Condition
CopySwaggerUiStep ApplicationInstance expansion applicationInstance.application.components. exists(:[ #this.getOption('enableJaxrs').defined and #this.getOption('enableSwagger').defined ])