org.springframework.restdocs

Class RestDocumentationExtension

java.lang.Object

org.springframework.restdocs.RestDocumentationExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver, RestDocumentationContextProvider

public class RestDocumentationExtension
extends java.lang.Object
implements org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback, RestDocumentationContextProvider, org.junit.jupiter.api.extension.ParameterResolver

A JUnit Jupiter Extension used to automatically manage the RestDocumentationContext.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
RestDocumentationExtension()

Method Summary

Modifier and Type	Method and Description
void	afterEach(org.junit.jupiter.api.extension.TestExtensionContext context)
void	beforeEach(org.junit.jupiter.api.extension.TestExtensionContext context)
RestDocumentationContext	beforeOperation() Returns a RestDocumentationContext for the operation that is about to be performed.
java.lang.Object	resolve(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
boolean	supports(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDocumentationExtension

public RestDocumentationExtension()

Method Detail

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.TestExtensionContext context)
                throws java.lang.Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

java.lang.Exception

afterEach

public void afterEach(org.junit.jupiter.api.extension.TestExtensionContext context)
               throws java.lang.Exception

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

java.lang.Exception

beforeOperation

public RestDocumentationContext beforeOperation()

Description copied from interface: RestDocumentationContextProvider

Returns a RestDocumentationContext for the operation that is about to be performed.

Specified by:

beforeOperation in interface RestDocumentationContextProvider

Returns:

the context for the operation

supports

public boolean supports(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                        org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

supports in interface org.junit.jupiter.api.extension.ParameterResolver

resolve

public java.lang.Object resolve(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

resolve in interface org.junit.jupiter.api.extension.ParameterResolver