Posted on 07-07-2014
I was exchanging emails with someone regarding API design considerations at their large institutions today, and where they could find healthy patterns for API designs within their industry. As with any API provider, they were concerned with emulating the best API design patterns they could, and evolve the design of their own services. They put it like this:
..."our APIs largely expose our internal mess and legacy design rather than presenting a well thought out, consistent view of the important resources and operations"...
We all want to deploy the best designed API that we possibly can, but with a lack of meaningful API definition formats (until recently), and nowhere to go and search or browse for common API design patterns (something 3Scale and API Evangelist want to fix with API Commons, APIs.json, and APIs.io), it can be difficult to know exactly what is good API design for our respective industries.
It would be nice, if all of the APIs we designed were brand new, perfectly architected to follow best of breed REST patterns, and we had all the time in the world to research and design. In reality, many of the APIs we design will ony act as a facade for some legacy beast of a system, that won't go away anytime soon. We are working to get more places like API Commons and APIs.io available to find the best API design patterns, and you should always look at as many of the APIs in your industry as you can, when designing your APIs, but most importantly, don't be concerned with a perfect interface--right out of the gate.
In reality, we have to just walk a line between the perfect API design, and the ugly legacy IT worlds, we are building these API facades to hide. The sooner we get the first version of the facade up, we can then iterate, and turn our APIs into the mirror image of the designs we ultimately desire—until then it is just smoke and mirrors, smoke and mirrors.
comments powered by Disqus
Winning in the API Economy
|Download as PDF|
Latest Blog Posts
- Why I Am Continuing To Integrate Zapier In My Business Workflow
- Publishing Your APIs To Product Hunt
- Providing Users With Reciprocity Tools So Important Intuit Purchases itDuzzit
- Bing Developer Assistant for Visual Studio Delivers Relevant API Code
- Average Number of APIs Used In A Modern App
- An APIs.json Collection Of API Resources Across Your Public, Partner Or Internal Resources
- One Possible Reboot Of The API Stack
- How Are Dev Shops In Chicago Using APIs? A Talk With Bryson Pouw At Blaze Portfolio
- Every API Provider Should Have A Logo And Branding Page
- What Is An API First Strategy? IT architecture And Catalyst For Engagement
- The Speed Of Federal Government When It Runs On Github
- Swagger, APIs.json, And Review For The New Developer.Trade.gov
- Student, Instructor, Classroom, Class, And Course API Planning At BYU
- Can You Add My API To Your Website Listing?
- Adding Google To List Of API Deployment Companies
- What Is An API First Strategy? Adding Some Dimensions To This New Question
- The Five Month Journey Toward A Stable APIs.json Discovery Format
- How Are Mobile Dev Shops In Chicago Using APIs? A Talk With Dave Devitt At SYDCON
- An API Case Study Format From Google Cloud Platform
- Next Stable Version of APIs.json + APIs.io Is Ready - Are Your APIs Discoverable?
- Expanding API Gateway Connectors Into A World of API Deployment Startups
- Where The Good IPAs Are In Chicago While At API Strategy And Practice In September
- The Blog For Your API Is The Most Important Signals You Can Send
- Public APIs Are Tough When You Are In A Tightly Controlled Industry
- Give Me A URL To Request Then Store My API Keys In My Private Github Repo