A new HTTPie request snippet has been introduced. Similar to the existing curl request snippet, the new snippet contains the HTTPie command for a request. My thanks to Raman Gupta who contributed this new feature.
Snippets can now be created once with some common configuration and then reused. This reduces repetition when documenting common parts on an API, such as
By default, Spring REST Docs will cause your tests to fail if you’ve neglected to document something or if you’ve attempted to document something that doesn’t exist. This is great for detailed API documentation, but can be restrictive when documenting a scenario where you want to focus on a specific part of a request or response. Rather than having to explicitly ignore everything that you don’t want to document, you can now use relaxed snippets for documenting links, request and response fields, and request and path parameters.
We’re hoping to publish a release in a few weeks’ time. Please take the release candidate for a spin and let us know if you find any problems or if you have a suggestion for some last-minute improvements.
If you’d like to learn more about Spring REST Docs and test-driven documentation, I’ll be speaking about it in May at the Spring/IO conference in Barcelona. I’d love to see you there.