springfox.documentation.staticdocs

Class Swagger2MarkupResultHandler.Builder

java.lang.Object

springfox.documentation.staticdocs.Swagger2MarkupResultHandler.Builder

Enclosing class:

Swagger2MarkupResultHandler

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

Method Summary

Modifier and Type	Method and Description
Swagger2MarkupResultHandler	build() Builds Swagger2MarkupResultHandler which converts the Swagger response into Markup and writes into the given outputDir.
Swagger2MarkupResultHandler.Builder	withExamples(java.lang.String examplesFolderPath) Include examples into the Paths document
Swagger2MarkupResultHandler.Builder	withMarkupLanguage(io.github.robwin.markup.builder.MarkupLanguage markupLanguage) Specifies the markup language which should be used to generate the files
Swagger2MarkupResultHandler.Builder	withPathsGroupedBy(io.github.robwin.swagger2markup.GroupBy pathsGroupedBy) Specifies how the paths should be grouped by in in the generated files

Methods inherited from class java.lang.Object

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

Method Detail

build

public Swagger2MarkupResultHandler build()

Builds Swagger2MarkupResultHandler which converts the Swagger response into Markup and writes into the given outputDir.

Returns:

a Mock MVC ResultHandler that will produce the documentation

See Also:

MockMvc.perform(org.springframework.test.web.servlet.RequestBuilder), ResultActions.andDo(org.springframework.test.web.servlet.ResultHandler)

withMarkupLanguage

public Swagger2MarkupResultHandler.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

withPathsGroupedBy

public Swagger2MarkupResultHandler.Builder withPathsGroupedBy(io.github.robwin.swagger2markup.GroupBy pathsGroupedBy)

Specifies how the paths should be grouped by in in the generated files

Parameters:

pathsGroupedBy - the parameter defining how the paths will be grouped in the generated files

Returns:

the Swagger2MarkupConverter.Builder

withExamples

public Swagger2MarkupResultHandler.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