Spring REST Docs: Documentation From Tests, Not the Other Way Around

on YouTube ↗50m

" summary

Shows how to generate API documentation automatically from integration tests using spring-restdocs (and similar tools). Explains the approach of writing tests that produce documentation, contrasts it with generating tests from specs (like Swagger), and discusses trade-offs such as coverage implications.

AI-written summary · about

" chapters (9)

1. 0:00Introduction
2. 7:14Idempotent API
3. 10:03Tests as foundation
4. 19:55Roles of testers and clients
5. 25:38Documentation evolution
6. 31:36Spring REST Docs: core
7. 36:53How the library works
8. 40:26Practical examples
9. 44:39Q&A

" related talks

• 52mTest-driven documentation with Spring REST DocsAndy Wilkinson · Spring I/O 2016
• 57mDocumenting RESTful APIs with Spring REST DocsJennifer Strater · SpringOne Platform 2017
• 01h 23mDocumenting RESTful APIsAndy Wilkinson · SpringOne2GX 2015
• 26mDocumenting Your API Effectively: a Complete Tour of Spring-docHugo Caupert · Voxxed Days Luxembourg 2023
• 51mDocumenting RESTful APIs with Spring REST Docs and RAMLMathias Düsterhöft · Spring I/O 2018
• 41mREST API documentationArtem Kuzvesov · РИТ++ 2017
• 35mDocumenting APIs: new era, same craftJavier Rubio · Write the Docs Berlin 2026
• 33mDocumenting REST APIs with SwaggerDaniel Pozzi · FrOSCon 2015