Over a million developers have joined DZone.

Saving and Versioning API Definitions in Editor Using GitHub Gists

In this article, Kin Lane discusses his friend's new take on a Swagger editor that resembles his dream API sketchbook and portfolio.

· Integration Zone

Build APIs from SQL and NoSQL or Salesforce data sources in seconds. Read the Creating REST APIs white paper, brought to you in partnership with CA Technologies.

My friend Jordan Walsh just released a new take on the Swagger editor that inches closer to my vision of a dream API sketchbook and portfolio. His swagger-gist.io tool allows you to open and save your API definitions to GitHub Gists, allowing you to use the snippet sharing solution to manage your API definitions, and their evolution.

While it isn't my entire vision for an API sketchbook and portfolio, swagger-gist.io's usage of GitHub Gists is a move in the right direction. This is just the first draft of his tool, and it looks like he plans on building in more of the API definition management features I am looking for, leveraging Github Gists as the book in my sketchbook definition. (#Creative!)

I like this model, especially when it comes to collaboration and storytelling around the API design process. I could see offering more sharing features for API definitions within the editor, enabling you to email, Slack, and share throughout an API's life cycle. I can also see more copy and paste opportunities, embedding API definitions using GitHub Gists in blog, knowledge base, and forum posts, grabbing the embed code from within the editor.

I'm curious to see where Jordan takes it. I have lots of ideas, but will just keep an eye on his work. My only critique at the moment is to not couple the functionality too tightly with the word "Swagger," as that is a trademarked product. I recommend relying on "OpenAPI Spec" or, even better, some other way of identifying Gists that contain an OpenAPI Spec definition. 

Cool stuff, Jordan. Keep up the good work.

The Integration Zone is brought to you in partnership with CA Technologies.  Use CA Live API Creator to quickly create complete application backends, with secure APIs and robust application logic, in an easy to use interface.

Topics:
apis ,api definitions ,github ,integration

Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

The best of DZone straight to your inbox.

SEE AN EXAMPLE
Please provide a valid email address.

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.
Subscribe

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}