Spring REST Docs 1.1 Release Notes

New and noteworthy

Support for REST Assured

Support for REST Assured has been added along side the existing support for Spring Test’s MockMvc. Support for REST Assured allows Spring REST Docs to be used to document any API that is accessible via HTTP, not just those that have been implemented using Spring MVC.

Support for Markdown

Spring REST Docs can now be configured to generate Markdown snippets. This can be particularly useful in combination with a Markdown-based documentation library such as Slate.

Support for TestNG and other test frameworks

1.1 introduces ManualRestDocumentation which can be used in any test framework that does not support JUnit rules. ManualRestDocumentation provides two methods, beforeTest and afterTest, that must be called for each test.

Pattern-based header removal

Request and response headers can now be removed from documentation snippets based on matching a regular expression pattern.

Upgrading

Deprecation

RestDocumentation has been deprecated and JUnitRestDocumentation should be used instead.