SpringOne Platform 2016 Replay: Writing comprehensive and guaranteed up-to-date REST API documentation
Recorded at SpringOne Platform 2016.
Speaker: Andreas Evers, Ordina JWorks
RESTful APIs are eating the world, yet all too often the documentation can cause indigestion for the APIs’ developers and their users. Developers have to deal with annotation overload, repetition, and an unpleasant writing environment. Users are then left with documentation that’s inaccurate and difficult to use. It doesn’t have to be this way.
This talk will introduce Spring REST Docs and its test-driven approach to RESTful API documentation. We’ll look at how it combines the power of Asciidoctor and your integration tests to produce documentation that’s accurate and easy-to-read, while keeping your code DRY and free from annotation overload. We’ll also look at some of the features that are new in Spring REST Docs 1.1, including support for REST Assured and Markdown.