io.github.robwin.swagger2markup

Class Swagger2MarkupConverter.Builder

java.lang.Object

io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Enclosing class:

Swagger2MarkupConverter

public static class Swagger2MarkupConverter.Builder
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
Swagger2MarkupConverter	build()
Swagger2MarkupConverter.Builder	preProcessSwagger(Consumer<io.swagger.models.Swagger> preProcessor) Customize the Swagger data in any useful way
Swagger2MarkupConverter.Builder	withDefinitionsOrderedBy(OrderBy definitionsOrderedBy) Specifies if the definitions should be ordered by natural ordering or stay as-is.
Swagger2MarkupConverter.Builder	withDescriptions(java.lang.String descriptionsFolderPath) Include hand-written descriptions into the Paths and Definitions document
Swagger2MarkupConverter.Builder	withExamples(java.lang.String examplesFolderPath) Include examples into the Paths document
Swagger2MarkupConverter.Builder	withMarkupLanguage(io.github.robwin.markup.builder.MarkupLanguage markupLanguage) Specifies the markup language which should be used to generate the files
Swagger2MarkupConverter.Builder	withOutputLanguage(Language language) Specifies labels language of output files
Swagger2MarkupConverter.Builder	withPathsGroupedBy(GroupBy pathsGroupedBy) Specifies if the paths should be grouped by tags or stay as-is.
Swagger2MarkupConverter.Builder	withSchemas(java.lang.String schemasFolderPath) Include (JSON, XML) schemas into the Definitions document
Swagger2MarkupConverter.Builder	withSeparatedDefinitions() In addition to the definitions file, also create separate definition files for each model definition.

Methods inherited from class java.lang.Object

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

Method Detail

build

public Swagger2MarkupConverter build()

withMarkupLanguage

public Swagger2MarkupConverter.Builder withMarkupLanguage(io.github.robwin.markup.builder.MarkupLanguage markupLanguage)

Specifies the markup language which should be used to generate the files

Parameters:

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

Returns:

the Swagger2MarkupConverter.Builder

withDescriptions

public Swagger2MarkupConverter.Builder withDescriptions(java.lang.String descriptionsFolderPath)

Include hand-written descriptions into the Paths and Definitions document

Parameters:

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

Returns:

the Swagger2MarkupConverter.Builder

withSeparatedDefinitions

public Swagger2MarkupConverter.Builder withSeparatedDefinitions()

In addition to the definitions file, also create separate definition files for each model definition.

Returns:

the Swagger2MarkupConverter.Builder

withExamples

public Swagger2MarkupConverter.Builder withExamples(java.lang.String examplesFolderPath)

Include examples into the Paths document

Parameters:

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

Returns:

the Swagger2MarkupConverter.Builder

withSchemas

public Swagger2MarkupConverter.Builder withSchemas(java.lang.String schemasFolderPath)

Include (JSON, XML) schemas into the Definitions document

Parameters:

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

Returns:

the Swagger2MarkupConverter.Builder

preProcessSwagger

public Swagger2MarkupConverter.Builder preProcessSwagger(Consumer<io.swagger.models.Swagger> preProcessor)

Customize the Swagger data in any useful way

Parameters:

preProcessor - function object to mutate the swagger object

Returns:

the Swagger2MarkupConverter.Builder

withPathsGroupedBy

public Swagger2MarkupConverter.Builder withPathsGroupedBy(GroupBy pathsGroupedBy)

Specifies if the paths should be grouped by tags or stay as-is.

Parameters:

pathsGroupedBy - the GroupBy enum

Returns:

the Swagger2MarkupConverter.Builder

withDefinitionsOrderedBy

public Swagger2MarkupConverter.Builder withDefinitionsOrderedBy(OrderBy definitionsOrderedBy)

Specifies if the definitions should be ordered by natural ordering or stay as-is.

Parameters:

definitionsOrderedBy - the OrderBy enum

Returns:

the Swagger2MarkupConverter.Builder

withOutputLanguage

public Swagger2MarkupConverter.Builder withOutputLanguage(Language language)

Specifies labels language of output files

Parameters:

language - the enum

Returns:

the Swagger2MarkupConverter.Builder