Posted on 08-22-2014
I stumbled across a cool resource out of Heroku today, their HTTP API design guide, which intends to direct practices for API design on the Heroku API platform.
Heroku’s goals around APIs design are, "consistency and focusing on business logic while avoiding design bikeshedding”. They put out the guide to drive consistent aPI design practices at Heroku, but are also interested in sharing with the wider API community.
I think API design best practices are something every API provider should have, and publish publicly (on Github). I think it is ok to even fork, and modify existing guides like Heroku’s or maybe from 18F out of federal government. This most important thing is that you have a guide that can guide your team, or other teams within your organization.
Now that I’m seeing more of these, I will start flagging, and aggregating them so we can browse and continue learn the API design practices from the leading API providers out there.
comments powered by Disqus
Winning in the API Economy
|Download as PDF|
Latest Blog Posts
- Swagger Visualization Layer Using D3.js
- Establishing Common Dictionaries That Industries Can Use In Their API Design
- Top 5 Most Popular Themes On API Evangelist In 2014
- Query Parameter Determining Which Fields Are Queried For API Call
- Now Our Development Environment Is Now Containerized And Scalable Like Our Production Environment
- Guest Post: Let Our Sponsors Blow A Little Smoke Up Your Ass
- API Discovery Continues Its Move Into The IDE With Eclipse Che
- Evolving Beyond Just Resources Towards A More Experience Based API Design
- Another View of The API vs. Data Download Model
- If You Have A Publicly Available Mobile App You Have a Public API