Technology Radar TemplateTechnology Radar Template

Spring REST Docs

documentation
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.

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 AOE, 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.