Jamie Tanna, a Co-maintainer of OAPI CodeGen, dives into the fascinating world of API design. He shares invaluable insights on building APIs—embracing mistakes and the iterative process. The discussion highlights the importance of flexibility and planning, addressing challenges like pagination and versioning. They advocate for continuous improvement and separating application layers for better functionality. Plus, Jamie humorously introduces the concept of 'unpop' and encourages self-reflection with the idea of creating a 'Manual of Me' for better team understanding.
01:29:23
forum Ask episode
web_stories AI Snips
view_agenda Chapters
auto_awesome Transcript
info_circle Episode notes
question_answer ANECDOTE
Customer ID Redundancy
Ian Wester-Lopshire shared an example of an API requiring a customer ID with every request.
Later, they realized the token already contained customer information, leading to a design flaw they are still addressing.
volunteer_activism ADVICE
Style Guide as Decision-Making
Treat your API's style guide as a decision-making system, not just superficial styling rules.
Documenting your API's ethos helps ensure consistency and guides deviations, making it easier for consumers to understand its structure.
volunteer_activism ADVICE
Building an API Foundation
When designing an API foundation, brainstorm and explore without constraints.
Document everything, whether through writing, diagrams, or conversations, to avoid forgetting crucial design decisions.
Get the Snipd Podcast app to discover more snips from this episode
APIs are built, not born, so how do we go about actually building them? Well, it starts with design. In this episode, Kris and Ian are joined by Jamie Tanna to talk about API design. From creating a theory of your API, through building its foundation, to actively prototyping as you design, the panel discusses what they've learned over the years to design high quality APIs. At the end we have unpopular opinions, but we also have a bonus behind the scenes look at howe we create episodes of this podcast. Make sure to stick around until the end of the episode for that content!
Supporters get access to an extended conversation about API design, where we continue some conversation that were cut short, dig more into how the podcast is made, and you'll get to hear Kris argue against using REST! You can get access by signing up at https://fallthrough.fm/subscribe.
Fallthrough 