Posted on 03-10-2014
I spent some time developing a hello world product API with Blueprint, RAML And Swagger this last week, and along the way I had several experiences that I think are influential in the API design process. One of these was while I was designing my product API using Apiary.io.
After I had gotten to a certain point in my design, and I wanted to see it in action, so I clicked on the preview button. A panel slid out showing me the interactive documentation my developers will see when it is published, and potentially see how it will work with sample API responses, and code samples in a variety of programming languages.
Just like interactive API documentation has been important in teaching developers about an API interface, it will also assist API providers in understanding their own interface throughout the design process, and be able to better articulate the interface to developers.
A common mistake I see from API deployments is that developers see the world through the lens of their preferred programming language. I’ve seen very PHP centric design patterns, ones that cater to .NET and even APIs that consider only Node.js in their interface design patterns. It is not just the fact that they are thinking only in their programming language that is a problem, its just the fact that they aren't willing see the world through the eyes of their potential developers.
Anything we can do to expand the horizons of API developers during the API design process, helping them see the wider world they are entering into by exposing their API, is a good thing.
comments powered by Disqus
Winning in the API Economy
|Download as PDF|
Latest Blog Posts
- Hypermedia Feels Like We Are Still Learning To Communicate With APIs
- Getting To Know Markus Lanthaler For The API Craft 2014 Detroit Hypermedia Panel
- Getting To Know Kevin Swiber For The API Craft 2014 Detroit Hypermedia Panel
- Getting To Know Steve Klabnik For The API Craft 2014 Detroit Hypermedia Panel
- New Indix API KickStart Program Reduces Costs For Developers
- Getting To Know Mike Kelly For The API Craft 2014 Detroit Hypermedia Panel
- A Shared, Distributed Experience(Metrics) Layer For The API Driven Application Stack
- Showcasing Your API Integrations With Other Platforms
- Increasing The Focus On APIs In Higher Education Is Important
- Getting To Know Mike Amundsen For The API Craft 2014 Detroit Hypermedia Panel
- The New StrongLoop API Server Provides A Look At Future Of API Deployment
- Models For API Driven Startups Built Around Public Data
- Will You Add Me To API Evangelist And How To Spot The Cool Kids
- When I Remix APIs Using Swagger How Do I Deal With Authentication Across Multiple APIs
- It Takes A Team Of Evangelists To Raise An API
- Support For Only Two Creative Commons Licenses In The API Commons
- Machine Readable Terms of Service Didn't Read Applied To APIs Via APIs.json
- API Deployment For Non-Developers Using Zapier, Google Docs, and APISpark
- State of Hypermedia Today @ API Craft In Detroit
- Need A Formal API Standard For Your Government Agency? Fork 18Fs, And Make It Your Own!
- CORS Makes Your API Portable And Remix-able
- Chief Data Officer Needs To Make The Department Of Commerce Developer Portal The Center Of API Economy
- An API Definition As The Truth In The API Contract
- Look At Existing APIs In The Space Before Designing Your Own
- Libraries Hacked: UK Library API, Data And Technology Hacks