Package org.springframework.restdocs

Interface RestDocumentationContext

public interface RestDocumentationContext
RestDocumentationContext encapsulates the context in which the documentation of a RESTful API is being performed.
Author:
Andy Wilkinson

  • Method Summary

    Modifier and Type
    Method
    Description
    File
    getOutputDirectory()
    Returns the output directory to which generated snippets should be written.
    int
    getStepCount()
    Returns the current step count.
    Class<?>
    getTestClass()
    Returns the class whose tests are currently executing.
    String
    getTestMethodName()
    Returns the name of the test method that is currently executing.

  • Method Details

    • getTestClass

      Class<?> getTestClass()
      Returns the class whose tests are currently executing.
      Returns:
      the test class

    • getTestMethodName

      String getTestMethodName()
      Returns the name of the test method that is currently executing.
      Returns:
      the name of the test method

    • getStepCount

      int getStepCount()
      Returns the current step count.
      Returns:
      the current step count

    • getOutputDirectory

      File getOutputDirectory()
      Returns the output directory to which generated snippets should be written.
      Returns:
      the output directory