Writing comprehensive and guaranteed up-to-date REST API documentation

Published: 13 February 2017
on channel: SpringDeveloper
6,669
87

Recorded at SpringOne Platform 2016.
Speaker: Andreas Evers, Ordina JWorks
Slides: http://www.slideshare.net/SpringCentr...

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.


Watch video Writing comprehensive and guaranteed up-to-date REST API documentation online, duration hours minute second in high quality that is uploaded to the channel SpringDeveloper 13 February 2017. Share the link to the video on social media so that your subscribers and friends will also watch this video. This video clip has been viewed 6,669 times and liked it 87 visitors.