Documenting REST APIs with Swagger

on YouTube ↗33m

" summary

Demonstrates using Swagger to generate a JSON API specification from code annotations and then generate SDKs and an interactive Swagger UI. Shows concrete workflows for Java (Maven plugin producing a static spec inside an uber‑jar), PHP and mustache‑templated code generation, plus features like parameter filters, OAuth and API-key support, and practical pitfalls such as enum handling, config issues, quirks of generated code and some unresolved bugs.

AI-written summary · about

" chapters (8)

1. 0:00Introduction
2. 2:40Swagger UI demo
3. 7:22Swagger spec basics
4. 10:16Code annotations workflow
5. 18:27Maven plugin build
6. 21:53Swagger UI customization
7. 24:44Swagger limitations solutions
8. 27:10Alternatives and conclusion

" related talks

• 01h 23mDocumenting RESTful APIsAndy Wilkinson · SpringOne2GX 2015
• 27mGetting developers hooked on your APINicolas Garnier · Codemotion Amsterdam 2016
• 50mUsing Spring with OpenAPIDave Syer · SpringOne at VMware Explore 2023 Las Vegas
• 57mDocumenting RESTful APIs with Spring REST DocsJennifer Strater · SpringOne Platform 2017
• 14mReal-World Enterprise REST API DesignLaurent Bovet · Voxxed Days Zurich 2017
• 19mSecure and accelerate APIs' lifecycle with the OpenAPI specificationArnaud Lauret · Nordic APIs Platform Summit 2016
• 35mDocumenting APIs: new era, same craftJavier Rubio · Write the Docs Berlin 2026
• 21mLet there be docs!Svyatoslav Kryukov · Friendly.rb 2023