Documenting Your API Effectively: a Complete Tour of Spring-doc

on YouTube ↗26m

" summary

Covers how to document REST APIs using Spring-doc (the Springdoc OpenAPI tooling for Spring Boot). Explains problems with incomplete or outdated API docs and shows a full tour of features and best practices in Spring-doc to generate accurate OpenAPI/Swagger documentation for Spring applications.

AI-written summary · about

" chapters (17)

1. 0:00Introduction
2. 1:04What is Spring Doc
3. 2:37Automatic docs generation
4. 5:26Basic customization
5. 7:10Documentation groups
6. 9:20Internal vs external docs
7. 10:45Pro docs and sharing
8. 11:51Schema improvements
9. 13:38Error documentation
10. 16:04Error response handling
11. 17:27Custom annotations
12. 19:11Advanced documentation
13. 20:35Swagger alternatives
14. 21:17Adding security
15. 23:04Evolution and maintenance
16. 24:30Integrations and tools
17. 24:51Best practices

" related talks

• 01h 23mDocumenting RESTful APIsAndy Wilkinson · SpringOne2GX 2015
• 57mDocumenting RESTful APIs with Spring REST DocsJennifer Strater · SpringOne Platform 2017
• 35mBringing together OpenAPI 3 and Spring BootBadr Nasslahsen · Spring I/O Bridge 2020
• 50mSpring REST Docs: Documentation From Tests, Not the Other Way AroundYan Ashenkampf · TestDriven Conf 2022
• 44mThe Kung-Fu of Customizing OpenAPIAleksandra Volushkova · Joker 2024
• 50mUsing Spring with OpenAPIDave Syer · SpringOne at VMware Explore 2023 Las Vegas
• 35mDocumenting APIs: new era, same craftJavier Rubio · Write the Docs Berlin 2026
• 38mThe Secret to Brewing up a Good APIDavid Dymko · Open Source Summit + Embedded Linux Conference + OSPOCon 2021