org.springframework.restdocs

Class RestDocumentation

java.lang.Object

org.springframework.restdocs.RestDocumentation

All Implemented Interfaces:

org.junit.rules.TestRule

public class RestDocumentation
extends Object
implements org.junit.rules.TestRule

A JUnit TestRule used to bootstrap the generation of REST documentation from JUnit tests.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
RestDocumentation(String outputDirectory) Creates a new RestDocumentation instance that will generate snippets to the given outputDirectory

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
RestDocumentationContext	beforeOperation() Notification that a RESTful operation that should be documented is about to be performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDocumentation

public RestDocumentation(String outputDirectory)

Creates a new RestDocumentation instance that will generate snippets to the given outputDirectory

Parameters:

outputDirectory - the output directory

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

beforeOperation

public RestDocumentationContext beforeOperation()

Notification that a RESTful operation that should be documented is about to be performed. Returns a RestDocumentationContext for the operation.

Returns:

the context for the operation