Go Time: Golang, Software Engineering OpenAPI & API design
Aug 8, 2024
Jamie Tanna, a maintainer of oapi-codegen, joins Kris and Johnny to dive into OpenAPI and API design. They tackle the significance of clear specifications and the challenges surrounding API versioning. Jamie shares insights on the future of oapi-codegen and the hurdles of open-source maintenance, including the need for sustainable support models. The trio blends technical discourse with lighthearted banter, even debating the best utensils for ice cream, adding a fun twist to their informative discussion.
AI Snips
Chapters
Transcript
Episode notes
API Design Upfront
- Design APIs upfront using OpenAPI specs to streamline development.
- This simplifies model generation and reduces boilerplate, allowing focus on integration.
Detecting Accidental Breaking Changes
- Accidental API changes can be caught during code review by observing generated client code diffs.
- Use OpenAPI-aware tools to detect breaking changes between spec versions for better API evolution.
Stripe's Long-Term API Support
- Stripe supports all API versions since 2011, demonstrating commitment but also highlighting the cost of legacy support.
- This anecdote underscores the challenges of long-term API version maintenance.