Rswag: Automated API Documentation
summary
Shows how rswag plugs into Rails specs and runs specs to generate an OpenAPI schema, then swaggerize writes swagger.yaml that reflects real responses. Demonstrates that tests execute real HTTP requests and captures real HTTP responses into examples, lets CI fail when docs drift, and drives a Swagger UI that can execute requests, generate mock servers and client code, validate JSON schemas, and handle auth. Practical demo includes adding/removing a field and immediately updating docs.
AI-written summary · about
chapters (6)
- 0:00Start
- 7:50Our Documentation Struggle
- 9:25Criteria for Improvement
- 13:53Example: GET /articles
- 18:54Anatomy of an Rswag Spec
- 28:13Advanced Features
related talks
42mAutomating Empathy: Test Your Docs with Swagger and Apivore
32mThe little schema that could (...but should it?)
39mAPI Development in 2017
32mFast, Testable and SANE APIs
23mIntegrating Web Apps
08mFrom a spreadsheet to a Rails app in 5 minutes
27mUnderstanding Rails test types in RSpec
30mRails Sojourn: One Man's Journey