OpenAPI & .NET: You're Doing It Wrong
summary
Argues that teams should write and maintain the OpenAPI YAML as the source of truth instead of relying on Swashbuckle/NSwag generation, store it in Git, and bundle into one file for publishing. Shows using Redoc/Elements to produce static, copyable docs and code samples, a GitHub Actions workflow that generates static docs in GitHub Actions, .NET middleware to serve embedded static OpenAPI, and tooling roadmap: a bundler, analyzers that lint code against spec, test generator (openapi.test) and codegen that produces service stubs.
AI-written summary · about
chapters (17)
- 0:00Introduction
- 1:30What is OpenAPI
- 3:57Misusing OpenAPI in .NET
- 8:13Handcrafted OpenAPI better
- 13:32When to handcraft specs
- 17:10Benefits of handcrafted files
- 20:43OpenAPI structure
- 30:18Live demo of OpenAPI
- 37:08Generating docs from OpenAPI
- 42:44Automating docs with GitHub Actions
- 47:06OpenAPI 4.0 changes
- 51:02OpenAPI tools in .NET
- 53:54Replacing Swashbuckle
- 56:22Validating API implementations against OpenAPI
- 57:46Testing APIs with specs
- 58:51Generating code from specs
- 1:00:19Resources and closing
related talks
46mOpenAPI & .NET: You're Doing It Wrong!
35mDocumenting APIs: new era, same craft
37mAutomation++ - Building an Enterprise API Economy from scratch
27mGetting developers hooked on your API
35mOpenAPI for Documentarians
19mSecure and accelerate APIs' lifecycle with the OpenAPI specification
34mShuffle ball change: Sashay your way to clearer API documentation
40mThe Four Stages of OpenAPI