API Design

https://is1-ssl.mzstatic.com/image/thumb/Podcasts116/v4/d7/2c/0a/d72c0a26-e3a3-862d-a05d-99e24242526c/mza_18247067547956144321.jpg/600x600bb.jpg

The Alan Barr Show

Alan Barr

39 episodes

4 days ago

I'm passionate about software, software testing, and writing. The intersection of metacognition, organization, and technology.

Technology

RSS

All content for The Alan Barr Show is the property of Alan Barr and is served directly from their servers with no modification, redirects, or rehosting. The podcast is not affiliated with or endorsed by Podjoint in any way.

I'm passionate about software, software testing, and writing. The intersection of metacognition, organization, and technology.

Technology

https://d3t3ozftmdmh3i.cloudfront.net/production/podcast_uploaded_nologo400/13555969/13555969-1622990435180-2b76f6323cd42.jpg

API Design

The Alan Barr Show

41 minutes 59 seconds

3 years ago

API Design

In this episode, I review a few books on API Design. The Design of Web APIs by Arnaud Lauret the API Handyman, Irresistible APIs by Kirsten Hunter, and API Design Patterns by JJ Geewax. I also brainfart may refer to Kirsten Hunter as Kirsten Stewart so just ignore that.

Act 1 - What is the goal of the API?

API Goal Canvas - Who - What - How - Inputs - Outputs - Goals

Alan's Digital Garden if the Manning link doesn't work in the future.

Act 2 - What makes a “good” API?

Act 3 - RESTful HTTP Guidance and Support

Summary

Define the goals and metrics of the API via design discussions and the API Goal Canvas and get feedback.
A good API is fit for purpose, consistent, and expressive.
RESTful HTTP Guidance and Supporting your API is more than the implementation. Support, Examples, Tutorials, workflows. etc.