Spring REST Docs support

This plugin supports the developer writing Spring REST Docs.

Spring REST Docs allows the developer to write API documentation using information recorded from test cases. These ensure that the examples in the documentation work with the current version of the code.

When running the tests, Sprig REST Docs creates a folder generated-snippets with the recorded examples.

Pre-Requisites

You need to upgrade to version 0.30.3 or later of the plugin. This feature is currently only available in the preview-releases of the plugin.

Detection of Spring REST Docs

The plugin will auto-detect Spring REST Docs by the folder generated-snippets that for Gradle builds is created in the build folder or for Maven builds created in the target folder. The current file being edited must be in a folder in or below the Gradle build.gradle or Maven pom.xml file.

Support provided by the plugin

(work in progress)