Spring REST Docs

documentation

This item was not updated in last three versions of the Radar. Should it have appeared in one of the more recent editions, there is a good chance it remains pertinent. However, if the item dates back further, its relevance may have diminished and our current evaluation could vary. Regrettably, our capacity to consistently revisit items from past Radar editions is limited.

Mar 2022

Hold

Spring REST Docs auto generates Asciidoctor snippets with the help of Spring MVC Test or RestAssured. So you can be sure that your tests are inline with the documentation.

We now use an Api First approach in conjunction with Open API. We see an active community there and a lot of support with this approach.

Mar 2017

Assess

Spring REST Docs auto generates Asciidoctor snippets with the help of Spring MVC Test or RestAssured. So you can be sure that your tests are inline with the documentation.

At DCX, we use Spring REST Docs to document our Rest Services and Hal Resources. We also use it to auto generate WireMock Stubs, so the consumer of the service can test against the exact API of the service.