Posted on 10-22-2012
Github is a frequently used service in the toolbox of API owners. The most common use of Github is for publishing API SDKs in a variety of languages and platforms. But when it comes to truly being an "open API", some API owners are actually open sourcing their API design using Github.
Open sourcing the design of your API will not be sensible for every provider. Many companies are looking to ensure developers use their API, maintaining an advantage over competitors. However in some cases, open sourcing the design of your API is a way to ensure interoperability between partners or among mutliple companies within a certain business sector.
Simple examples of an API design might be for common systems like blogs, news, links, calendars or other API designs that don't deliver any sort of proprietary offerings. If you are looking to ensure synchronicity between say, the calendar of multiple organizations, developing a single API and open sourcing the design and possibly a version of it in multiple programming languages, might make sense.
With a consistent API design, and code to deploy the API, any organization can download or fork the Github code, deploy the API for themselves--ensuring consistency and interoperability between any deployment. If a single organizations has unique needs, they can extend and commit the code back to Github, allowing the central repository manager to decide if it is a change that should be added to the core offering.
Not all APIs are created equal. Consider the possibility of actually open sourcing your API, the benefits it might bring to others, as well as your organization--they might exceed keeping it closed and proprietary.
This approach to using Github, is by far the truest meaning of the word, "Open API".
comments powered by Disqus
Winning in the API Economy
|Download as PDF|
Latest Blog Posts
- My Discussion Today With 6 Hypermedia Leaders At API-Craft in Detroit
- Getting To Know Jørn Wildt For The API Craft 2014 Detroit Hypermedia Panel
- 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