Swagger2MarkupConfig (swagger2markup 1.2.0 API)

```
public interface Swagger2MarkupConfig
```
Swagger2Markup configuration interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAnchorPrefix()` Optionally prefix all anchors for uniqueness.
`OrderBy`	`getDefinitionOrderBy()` Specifies definition ordering.
`java.util.Comparator<java.lang.String>`	`getDefinitionOrdering()` Specifies a custom comparator function to order definitions.
`java.lang.String`	`getDefinitionsDocument()` Definitions document name (without extension).
`Swagger2MarkupProperties`	`getExtensionsProperties()` Returns properties for extensions.
`java.util.regex.Pattern`	`getHeaderPattern()` Specifies the regex pattern used for header matching
`java.lang.String`	`getInterDocumentCrossReferencesPrefix()` Inter-document cross-references optional prefix.
`io.github.swagger2markup.markup.builder.LineSeparator`	`getLineSeparator()` Specifies the line separator which should be used.
`io.github.swagger2markup.markup.builder.MarkupLanguage`	`getMarkupLanguage()` Specifies the markup language which should be used to generate the files.
`OrderBy`	`getOperationOrderBy()` Specifies operation ordering.
`java.util.Comparator<PathOperation>`	`getOperationOrdering()` Specifies a custom comparator function to order operations.
`Language`	`getOutputLanguage()` Specifies labels language of output files.
`java.lang.String`	`getOverviewDocument()` Overview document name (without extension).
`java.util.List<PageBreakLocations>`	`getPageBreakLocations()` Returns the list of page break locations
`OrderBy`	`getParameterOrderBy()` Specifies parameter ordering.
`java.util.Comparator<io.swagger.models.parameters.Parameter>`	`getParameterOrdering()` Specifies a custom comparator function to order parameters.
`java.lang.String`	`getPathsDocument()` Paths document name (without extension).
`GroupBy`	`getPathsGroupedBy()` Specifies if the operations should be grouped by tags or stay as-is.
`OrderBy`	`getPropertyOrderBy()` Specifies property ordering.
`java.util.Comparator<java.lang.String>`	`getPropertyOrdering()` Specifies a custom comparator function to order properties.
`OrderBy`	`getResponseOrderBy()` Specifies response ordering.
`java.util.Comparator<java.lang.String>`	`getResponseOrdering()` Specifies a custom comparator function to order responses.
`java.lang.String`	`getSecurityDocument()` Security document name (without extension).
`java.lang.String`	`getSeparatedDefinitionsFolder()` Separated definitions sub-folder name.
`java.lang.String`	`getSeparatedOperationsFolder()` Separated operations sub-folder name.
`io.github.swagger2markup.markup.builder.MarkupLanguage`	`getSwaggerMarkupLanguage()` Specifies the markup language used in Swagger descriptions.
`OrderBy`	`getTagOrderBy()` Specifies tag ordering.
`java.util.Comparator<java.lang.String>`	`getTagOrdering()` Specifies a custom comparator function to order tags.
`boolean`	`isBasePathPrefixEnabled()` Prepend the base path to all paths.
`boolean`	`isFlatBodyEnabled()` Optionally isolate the body parameter, if any, from other parameters.
`boolean`	`isGeneratedExamplesEnabled()` Include generated examples into the documents.
`boolean`	`isInlineSchemaEnabled()` Specifies if inline schemas are detailed
`boolean`	`isInterDocumentCrossReferencesEnabled()` Enable use of inter-document cross-references when needed.
`boolean`	`isPathSecuritySectionEnabled()` Optionally disable the security section for path sections
`boolean`	`isSeparatedDefinitionsEnabled()` In addition to the Definitions file, also create separate definition files for each model definition.
`boolean`	`isSeparatedOperationsEnabled()` In addition to the Paths file, also create separate operation files for each operation.

- Method Detail
  - getMarkupLanguage
```
io.github.swagger2markup.markup.builder.MarkupLanguage getMarkupLanguage()
```
    Specifies the markup language which should be used to generate the files.
  - getSwaggerMarkupLanguage
```
io.github.swagger2markup.markup.builder.MarkupLanguage getSwaggerMarkupLanguage()
```
    Specifies the markup language used in Swagger descriptions.
    By default, MarkupLanguage.MARKDOWN is assumed.
  - isGeneratedExamplesEnabled
```
boolean isGeneratedExamplesEnabled()
```
    Include generated examples into the documents.
  - isBasePathPrefixEnabled
```
boolean isBasePathPrefixEnabled()
```
    Prepend the base path to all paths.
  - isSeparatedDefinitionsEnabled
```
boolean isSeparatedDefinitionsEnabled()
```
    In addition to the Definitions file, also create separate definition files for each model definition.
  - isSeparatedOperationsEnabled
```
boolean isSeparatedOperationsEnabled()
```
    In addition to the Paths file, also create separate operation files for each operation.
  - getPathsGroupedBy
```
GroupBy getPathsGroupedBy()
```
    Specifies if the operations should be grouped by tags or stay as-is.
  - getOutputLanguage
```
Language getOutputLanguage()
```
    Specifies labels language of output files.
  - isInlineSchemaEnabled
```
boolean isInlineSchemaEnabled()
```
    Specifies if inline schemas are detailed
  - getTagOrderBy
```
OrderBy getTagOrderBy()
```
    Specifies tag ordering.
  - getHeaderPattern
```
java.util.regex.Pattern getHeaderPattern()
```
    Specifies the regex pattern used for header matching
  - getTagOrdering
```
java.util.Comparator<java.lang.String> getTagOrdering()
```
    Specifies a custom comparator function to order tags.
  - getOperationOrderBy
```
OrderBy getOperationOrderBy()
```
    Specifies operation ordering.
  - getOperationOrdering
```
java.util.Comparator<PathOperation> getOperationOrdering()
```
    Specifies a custom comparator function to order operations.
  - getDefinitionOrderBy
```
OrderBy getDefinitionOrderBy()
```
    Specifies definition ordering.
  - getDefinitionOrdering
```
java.util.Comparator<java.lang.String> getDefinitionOrdering()
```
    Specifies a custom comparator function to order definitions.
  - getParameterOrderBy
```
OrderBy getParameterOrderBy()
```
    Specifies parameter ordering.
  - getParameterOrdering
```
java.util.Comparator<io.swagger.models.parameters.Parameter> getParameterOrdering()
```
    Specifies a custom comparator function to order parameters.
  - getPropertyOrderBy
```
OrderBy getPropertyOrderBy()
```
    Specifies property ordering.
  - getPropertyOrdering
```
java.util.Comparator<java.lang.String> getPropertyOrdering()
```
    Specifies a custom comparator function to order properties.
  - getResponseOrderBy
```
OrderBy getResponseOrderBy()
```
    Specifies response ordering.
  - getResponseOrdering
```
java.util.Comparator<java.lang.String> getResponseOrdering()
```
    Specifies a custom comparator function to order responses.
  - isInterDocumentCrossReferencesEnabled
```
boolean isInterDocumentCrossReferencesEnabled()
```
    Enable use of inter-document cross-references when needed.
  - getInterDocumentCrossReferencesPrefix
```
java.lang.String getInterDocumentCrossReferencesPrefix()
```
    Inter-document cross-references optional prefix.
  - isFlatBodyEnabled
```
boolean isFlatBodyEnabled()
```
    Optionally isolate the body parameter, if any, from other parameters.
  - isPathSecuritySectionEnabled
```
boolean isPathSecuritySectionEnabled()
```
    Optionally disable the security section for path sections
  - getAnchorPrefix
```
java.lang.String getAnchorPrefix()
```
    Optionally prefix all anchors for uniqueness.
  - getOverviewDocument
```
java.lang.String getOverviewDocument()
```
    Overview document name (without extension).
    
    Returns:
    
    the overview document name (without extension)
  - getPathsDocument
```
java.lang.String getPathsDocument()
```
    Paths document name (without extension).
    
    Returns:
    
    the paths document name (without extension)
  - getDefinitionsDocument
```
java.lang.String getDefinitionsDocument()
```
    Definitions document name (without extension).
    
    Returns:
    
    the definitions document name (without extension)
  - getSecurityDocument
```
java.lang.String getSecurityDocument()
```
    Security document name (without extension).
    
    Returns:
    
    the security document name (without extension)
  - getSeparatedOperationsFolder
```
java.lang.String getSeparatedOperationsFolder()
```
    Separated operations sub-folder name.
    
    Returns:
    
    the operations sub-folder name
  - getSeparatedDefinitionsFolder
```
java.lang.String getSeparatedDefinitionsFolder()
```
    Separated definitions sub-folder name.
    
    Returns:
    
    the definitions sub-folder name
  - getLineSeparator
```
io.github.swagger2markup.markup.builder.LineSeparator getLineSeparator()
```
    Specifies the line separator which should be used.
    
    Returns:
    
    the line separator
  - getExtensionsProperties
```
Swagger2MarkupProperties getExtensionsProperties()
```
    Returns properties for extensions.
    
    Returns:
    
    the extension properties
  - getPageBreakLocations
```
java.util.List<PageBreakLocations> getPageBreakLocations()
```
    Returns the list of page break locations
    
    Returns:
    
    List of PageBreakLocations

Interface Swagger2MarkupConfig

Method Summary

Method Detail

getMarkupLanguage

getSwaggerMarkupLanguage

isGeneratedExamplesEnabled

isBasePathPrefixEnabled

isSeparatedDefinitionsEnabled

isSeparatedOperationsEnabled

getPathsGroupedBy

getOutputLanguage

isInlineSchemaEnabled

getTagOrderBy

getHeaderPattern

getTagOrdering

getOperationOrderBy

getOperationOrdering

getDefinitionOrderBy

getDefinitionOrdering

getParameterOrderBy

getParameterOrdering

getPropertyOrderBy

getPropertyOrdering

getResponseOrderBy

getResponseOrdering

isInterDocumentCrossReferencesEnabled

getInterDocumentCrossReferencesPrefix

isFlatBodyEnabled

isPathSecuritySectionEnabled

getAnchorPrefix

getOverviewDocument

getPathsDocument

getDefinitionsDocument

getSecurityDocument

getSeparatedOperationsFolder

getSeparatedDefinitionsFolder

getLineSeparator

getExtensionsProperties

getPageBreakLocations