public class Swagger2MarkupConfigBuilder
extends java.lang.Object
| Constructor and Description |
|---|
Swagger2MarkupConfigBuilder() |
Swagger2MarkupConfigBuilder(org.apache.commons.configuration2.Configuration configuration) |
Swagger2MarkupConfigBuilder(java.util.Map<java.lang.String,java.lang.String> map) |
Swagger2MarkupConfigBuilder(java.util.Properties properties) |
| Modifier and Type | Method and Description |
|---|---|
Swagger2MarkupConfig |
build()
Builds the Swagger2MarkupConfig.
|
Swagger2MarkupConfigBuilder |
withAnchorPrefix(java.lang.String anchorPrefix)
Optionally prefix all anchors for uniqueness.
|
Swagger2MarkupConfigBuilder |
withBasePathPrefix()
Prepend the base path to all paths.
|
Swagger2MarkupConfigBuilder |
withDefinitionOrdering(java.util.Comparator<java.lang.String> definitionOrdering)
Specifies a custom comparator function to order definitions.
|
Swagger2MarkupConfigBuilder |
withDefinitionOrdering(OrderBy orderBy)
Specifies definition ordering.
|
Swagger2MarkupConfigBuilder |
withFlatBody()
Optionally isolate the body parameter, if any, from other parameters.
|
Swagger2MarkupConfigBuilder |
withGeneratedExamples()
Include generated examples into the documents.
|
Swagger2MarkupConfigBuilder |
withHeaderRegex(java.lang.String headerRegex)
Specifies the regex pattern to use for grouping paths.
|
Swagger2MarkupConfigBuilder |
withInterDocumentCrossReferences()
Enable use of inter-document cross-references when needed.
|
Swagger2MarkupConfigBuilder |
withInterDocumentCrossReferences(java.lang.String prefix)
Enable use of inter-document cross-references when needed.
|
Swagger2MarkupConfigBuilder |
withLineSeparator(io.github.swagger2markup.markup.builder.LineSeparator lineSeparator)
Specifies the line separator which should be used.
|
Swagger2MarkupConfigBuilder |
withMarkupLanguage(io.github.swagger2markup.markup.builder.MarkupLanguage markupLanguage)
Specifies the markup language which should be used to generate the files.
|
Swagger2MarkupConfigBuilder |
withOperationOrdering(java.util.Comparator<PathOperation> operationOrdering)
Specifies a custom comparator function to order operations.
|
Swagger2MarkupConfigBuilder |
withOperationOrdering(OrderBy orderBy)
Specifies operation ordering.
|
Swagger2MarkupConfigBuilder |
withoutInlineSchema()
Disable inline schema support.
|
Swagger2MarkupConfigBuilder |
withoutPathSecuritySection()
Optionally disable the security section for path sections
|
Swagger2MarkupConfigBuilder |
withOutputLanguage(Language language)
Specifies labels language of output files.
|
Swagger2MarkupConfigBuilder |
withPageBreaks(java.util.List<PageBreakLocations> locations)
Set the page break locations
|
Swagger2MarkupConfigBuilder |
withParameterOrdering(java.util.Comparator<io.swagger.models.parameters.Parameter> parameterOrdering)
Specifies a custom comparator function to order parameters.
|
Swagger2MarkupConfigBuilder |
withParameterOrdering(OrderBy orderBy)
Specifies parameter ordering.
|
Swagger2MarkupConfigBuilder |
withPathsGroupedBy(GroupBy pathsGroupedBy)
Specifies if the paths should be grouped by tags or stay as-is.
|
Swagger2MarkupConfigBuilder |
withPropertyOrdering(java.util.Comparator<java.lang.String> propertyOrdering)
Specifies a custom comparator function to order properties.
|
Swagger2MarkupConfigBuilder |
withPropertyOrdering(OrderBy orderBy)
Specifies property ordering.
|
Swagger2MarkupConfigBuilder |
withResponseOrdering(java.util.Comparator<java.lang.String> responseOrdering)
Specifies a custom comparator function to order responses.
|
Swagger2MarkupConfigBuilder |
withResponseOrdering(OrderBy orderBy)
Specifies response ordering.
|
Swagger2MarkupConfigBuilder |
withSeparatedDefinitions()
In addition to the Definitions file, also create separate definition files for each model definition.
|
Swagger2MarkupConfigBuilder |
withSeparatedOperations()
In addition to the Paths file, also create separate operation files for each operation.
|
Swagger2MarkupConfigBuilder |
withSwaggerMarkupLanguage(io.github.swagger2markup.markup.builder.MarkupLanguage swaggerMarkupLanguage)
Specifies the markup language used in Swagger descriptions.
|
Swagger2MarkupConfigBuilder |
withTagOrdering(java.util.Comparator<java.lang.String> tagOrdering)
Specifies a custom comparator function to order tags.
|
Swagger2MarkupConfigBuilder |
withTagOrdering(OrderBy orderBy)
Specifies tag ordering.
|
public Swagger2MarkupConfigBuilder()
public Swagger2MarkupConfigBuilder(java.util.Properties properties)
public Swagger2MarkupConfigBuilder(java.util.Map<java.lang.String,java.lang.String> map)
public Swagger2MarkupConfigBuilder(org.apache.commons.configuration2.Configuration configuration)
public Swagger2MarkupConfig build()
public Swagger2MarkupConfigBuilder withMarkupLanguage(io.github.swagger2markup.markup.builder.MarkupLanguage markupLanguage)
markupLanguage - the markup language which is used to generate the filespublic Swagger2MarkupConfigBuilder withSwaggerMarkupLanguage(io.github.swagger2markup.markup.builder.MarkupLanguage swaggerMarkupLanguage)
swaggerMarkupLanguage - the markup language used in Swagger descriptionspublic Swagger2MarkupConfigBuilder withGeneratedExamples()
public Swagger2MarkupConfigBuilder withSeparatedDefinitions()
public Swagger2MarkupConfigBuilder withSeparatedOperations()
public Swagger2MarkupConfigBuilder withPathsGroupedBy(GroupBy pathsGroupedBy)
pathsGroupedBy - the GroupBy enumpublic Swagger2MarkupConfigBuilder withHeaderRegex(java.lang.String headerRegex)
headerRegex - regex pattern string containing one capture groupjava.util.regex.PatternSyntaxException - when pattern cannot be compiledpublic Swagger2MarkupConfigBuilder withOutputLanguage(Language language)
language - the enumpublic Swagger2MarkupConfigBuilder withoutInlineSchema()
public Swagger2MarkupConfigBuilder withTagOrdering(OrderBy orderBy)
OrderBy.NATURAL.withTagOrdering(Comparator) to set a custom ordering.orderBy - tag orderingpublic Swagger2MarkupConfigBuilder withTagOrdering(java.util.Comparator<java.lang.String> tagOrdering)
tagOrdering - tag orderingpublic Swagger2MarkupConfigBuilder withOperationOrdering(OrderBy orderBy)
OrderBy.AS_IS.withOperationOrdering(Comparator) to set a custom ordering.orderBy - operation orderingpublic Swagger2MarkupConfigBuilder withOperationOrdering(java.util.Comparator<PathOperation> operationOrdering)
operationOrdering - operation orderingpublic Swagger2MarkupConfigBuilder withDefinitionOrdering(OrderBy orderBy)
OrderBy.NATURAL.withDefinitionOrdering(Comparator) to set a custom ordering.orderBy - definition orderingpublic Swagger2MarkupConfigBuilder withDefinitionOrdering(java.util.Comparator<java.lang.String> definitionOrdering)
definitionOrdering - definition orderingpublic Swagger2MarkupConfigBuilder withParameterOrdering(OrderBy orderBy)
OrderBy.NATURAL.withParameterOrdering(Comparator) to set a custom ordering.orderBy - parameter orderingpublic Swagger2MarkupConfigBuilder withParameterOrdering(java.util.Comparator<io.swagger.models.parameters.Parameter> parameterOrdering)
parameterOrdering - parameter orderingpublic Swagger2MarkupConfigBuilder withPropertyOrdering(OrderBy orderBy)
OrderBy.NATURAL.withPropertyOrdering(Comparator) to set a custom ordering.orderBy - property orderingpublic Swagger2MarkupConfigBuilder withPropertyOrdering(java.util.Comparator<java.lang.String> propertyOrdering)
propertyOrdering - property orderingpublic Swagger2MarkupConfigBuilder withResponseOrdering(OrderBy orderBy)
OrderBy.NATURAL.withResponseOrdering(Comparator) to set a custom ordering.orderBy - response orderingpublic Swagger2MarkupConfigBuilder withResponseOrdering(java.util.Comparator<java.lang.String> responseOrdering)
responseOrdering - response orderingpublic Swagger2MarkupConfigBuilder withInterDocumentCrossReferences(java.lang.String prefix)
prefix - Prefix to document in all inter-document cross-references.public Swagger2MarkupConfigBuilder withInterDocumentCrossReferences()
public Swagger2MarkupConfigBuilder withFlatBody()
public Swagger2MarkupConfigBuilder withoutPathSecuritySection()
public Swagger2MarkupConfigBuilder withBasePathPrefix()
public Swagger2MarkupConfigBuilder withAnchorPrefix(java.lang.String anchorPrefix)
anchorPrefix - anchor prefix.public Swagger2MarkupConfigBuilder withPageBreaks(java.util.List<PageBreakLocations> locations)
locations - List of locations to create new pagespublic Swagger2MarkupConfigBuilder withLineSeparator(io.github.swagger2markup.markup.builder.LineSeparator lineSeparator)
lineSeparator - the lineSeparator