Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

From OpenAPI Spec Google Spreadsheet to GitHub Jekyll-Hosted YAML

DZone's Guide to

From OpenAPI Spec Google Spreadsheet to GitHub Jekyll-Hosted YAML

This can provide a way that non-developers can participate in the API design process and apply OpenAPI Specs to other stops along the API lifecycle.

· Integration Zone ·
Free Resource

SnapLogic is the leading self-service enterprise-grade integration platform. Download the 2018 GartnerMagic Quadrant for Enterprise iPaaS or play around on the platform, risk free, for 30 days.

I have been playing around with different ways of using Google Spreadsheet to drive YAML and JSON data to Jekyll data projects hosted as Github repositories. It is an approach I started playing around with in Washington DC, while I was helping data stewards publish government services as JSON-LD. It is something I've been playing around with lately to drive D3.js visualizations and even a comic book. 

There are a couple of things going on here. First, you are managing machine-readable data using Google Spreadsheets and publishing this data as two separate machine readable formats: JSON and YAML. When these formats are combined with the data capabilities of a Jekyll website hosted on GitHub Pages, it opens up some pretty interesting possibilities for using data to fuel some pretty fun things. Plus, there's no back-end needed.

To push this approach forward, I wanted to apply to managing OpenAPI Specs that can be used across the API life cycle. I pulled together a spreadsheet template for managing the details I need for an OpenAPI Spec. Then, I created a GitHub repository, forked my previous spreadsheet to YAML project, and modified it to pull data from a couple of worksheets in the Google Doc and publish as both JSON and YAML OpenAPI Spec

My OpenAPI Spec Google Sheet to YAML for use in a Jekyll project hosted on GitHub is just a prototype. The results don't always validate and I'm playing with different ways to represent and manage the data in the Google Sheet. It is a fun start, though! I am going to keep working on it and probably start a similar project for managing an APIs.json index using Google Sheets. When done right, it might provide another way that non-developers can participate in the API design process and apply OpenAPI Specs to other stops along the API lifecycle like with API documentation, SDK generation, or testing and monitoring.

Download A Buyer's Guide to Application and Data Integration, your one-stop-shop for research, checklists, and explanations for an application and data integration solution.

Topics:
integration ,github ,open api ,google spreadsheet

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

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

{{ parent.tldr }}

{{ parent.urlSource.name }}