springfox.documentation.staticdocs

Class SwaggerResultHandler.Builder

java.lang.Object

springfox.documentation.staticdocs.SwaggerResultHandler.Builder

Enclosing class:

SwaggerResultHandler

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

Method Summary

Modifier and Type	Method and Description
SwaggerResultHandler	build() Builds SwaggerResultHandler which stores the Swagger response into file the outputDir and fileName.
SwaggerResultHandler.Builder	withFileName(java.lang.String fileName) Specifies the file name which should be used

Methods inherited from class java.lang.Object

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

Method Detail

build

public SwaggerResultHandler build()

Builds SwaggerResultHandler which stores the Swagger response into file the outputDir and fileName.

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)

withFileName

public SwaggerResultHandler.Builder withFileName(java.lang.String fileName)

Specifies the file name which should be used

Parameters:

fileName - the file name

Returns:

the SwaggerResultHandler.Builder