springfox.documentation.staticdocs

Class Swagger2MarkupResultHandler

java.lang.Object

springfox.documentation.staticdocs.Swagger2MarkupResultHandler

All Implemented Interfaces:

org.springframework.test.web.servlet.ResultHandler

public class Swagger2MarkupResultHandler
extends java.lang.Object
implements org.springframework.test.web.servlet.ResultHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Swagger2MarkupResultHandler.Builder

Method Summary

Modifier and Type	Method and Description
void	handle(org.springframework.test.web.servlet.MvcResult result) Apply the action on the given result.
static Swagger2MarkupResultHandler.Builder	outputDirectory(java.lang.String outputDir) Creates a Swagger2MarkupResultHandler.Builder

Methods inherited from class java.lang.Object

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

Method Detail

outputDirectory

public static Swagger2MarkupResultHandler.Builder outputDirectory(java.lang.String outputDir)

Creates a Swagger2MarkupResultHandler.Builder

Parameters:

outputDir - the target folder

Returns:

a Swagger2MarkupResultHandler.Builder

handle

public void handle(org.springframework.test.web.servlet.MvcResult result)
            throws java.lang.Exception

Apply the action on the given result.

Specified by:

handle in interface org.springframework.test.web.servlet.ResultHandler

Parameters:

result - the result of the executed request

Throws:

java.lang.Exception - if a failure occurs