Spring REST Docs
The Spring REST Docs project helps you document RESTful services. It combines handwritten documentation written with Asciidoctor and autogenerated snippets produced with Spring MVC Test.
This is quite a different approach of other RESTful API documenting tools, such as Swagger, which separate the API documents from the API implementation. Usually, API designers write the API documents during the API design phase and then developers implement the API according to the API designs in the documents. One of the main drawbacks is that you will have to always remember to keep the document up-to-date with the latest implementation. Otherwise, developers of the API clients will see a non-working API, which causes confusion.
Spring ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access