io.github.robwin.swagger2markup.config

Class Swagger2MarkupConfig

java.lang.Object

io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

public class Swagger2MarkupConfig
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Swagger2MarkupConfig(io.swagger.models.Swagger swagger, io.github.robwin.markup.builder.MarkupLanguage markupLanguage, java.lang.String examplesFolderPath, java.lang.String schemasFolderPath, java.lang.String descriptionsFolderPath, boolean separatedDefinitions, GroupBy pathsGroupedBy, OrderBy definitionsOrderedBy, Language outputLanguage)

Method Summary

Methods

Modifier and Type	Method and Description
OrderBy	getDefinitionsOrderedBy()
java.lang.String	getDescriptionsFolderPath()
java.lang.String	getExamplesFolderPath()
io.github.robwin.markup.builder.MarkupLanguage	getMarkupLanguage()
Language	getOutputLanguage()
GroupBy	getPathsGroupedBy()
java.lang.String	getSchemasFolderPath()
io.swagger.models.Swagger	getSwagger()
boolean	isSeparatedDefinitions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Swagger2MarkupConfig

public Swagger2MarkupConfig(io.swagger.models.Swagger swagger,
                    io.github.robwin.markup.builder.MarkupLanguage markupLanguage,
                    java.lang.String examplesFolderPath,
                    java.lang.String schemasFolderPath,
                    java.lang.String descriptionsFolderPath,
                    boolean separatedDefinitions,
                    GroupBy pathsGroupedBy,
                    OrderBy definitionsOrderedBy,
                    Language outputLanguage)

Parameters:

swagger - the Swagger source

markupLanguage - the markup language which is used to generate the files

examplesFolderPath - examplesFolderPath the path to the folder where the example documents reside

schemasFolderPath - the path to the folder where the schema documents reside

descriptionsFolderPath - the path to the folder where the description documents reside

separatedDefinitions - specified if in addition to the definitions file, also separate definition files for each model definition should be created

pathsGroupedBy - specifies if the paths should be grouped by tags or stay as-is

definitionsOrderedBy - specifies if the definitions should be ordered by natural ordering or stay as-is

outputLanguage - specifies language of labels in output files

Method Detail

getSwagger

public io.swagger.models.Swagger getSwagger()

getMarkupLanguage

public io.github.robwin.markup.builder.MarkupLanguage getMarkupLanguage()

getExamplesFolderPath

public java.lang.String getExamplesFolderPath()

getSchemasFolderPath

public java.lang.String getSchemasFolderPath()

getDescriptionsFolderPath

public java.lang.String getDescriptionsFolderPath()

isSeparatedDefinitions

public boolean isSeparatedDefinitions()

getPathsGroupedBy

public GroupBy getPathsGroupedBy()

getDefinitionsOrderedBy

public OrderBy getDefinitionsOrderedBy()

getOutputLanguage

public Language getOutputLanguage()