JUnit, RESTDocs, Asciidoctor and Maven to document your APIs
summary
Shows a concrete pipeline that turns JUnit + MockMvc tests and Spring REST Docs into live site docs: Maven Site + asciidoctor renders source-adjacent Asciidoc, includes actual pom snippets and diagrams, and deploys via wagon-ssh to docs.nemesis.io; a custom JUnit run listener collects test snippets into rest-docs-metadata.json so the docs show curl/http examples, tabs and dependency tables for 120 modules, and the build runs in Jenkins or locally with asciidoctor+maven site. The system is implemented and running.
AI-written summary · about
chapters (9)
- 0:00Introduction to API documentation
- 6:35Documentation challenges in large projects
- 10:12Maven and Asciidoctor setup
- 17:23Why Asciidoctor over Markdown
- 20:44Dynamic module documentation
- 29:46Breadcrumbs and navigation
- 32:41Spring Boot properties documentation
- 35:12REST API testing with Spring RESTDocs
- 41:46Future improvements and Q&A
related talks
52mTest-driven documentation with Spring REST Docs
57mDocumenting RESTful APIs with Spring REST Docs
01h 23mDocumenting RESTful APIs
46mAsciidoctor: because writing docs does not have to suck
41mStop making fool of yourself about documentation
51mDocumenting RESTful APIs with Spring REST Docs and RAML
31mCreating a documentation site for users with AsciiDoc and Antora
51mGetting started with Asciidoctor