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

preview_player
Показать описание
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.
Рекомендации по теме
Комментарии
Автор

This all look nice when you have one service with MVC. What if I have microservices with 1 edge service with zuul, 1 auth service and a bunch of services doing business, how will I get one documentation for customers?

mayboroda
Автор

Thanks for the video. I was trying to follow the steps you mentioned here and run a simple demo application but could not make it run. I am interested to know your pom file structure. Is it possible to share your code?

chinmoychakraborty