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

A New Minimum Viable Documentation (MVD) Jekyll Template for APIs

DZone's Guide to

A New Minimum Viable Documentation (MVD) Jekyll Template for APIs

Learn about a new minimum viable documentation (MVD) template for APIs, based on OpenAPI, to use with the Jekyll content management system.

· Integration Zone ·
Free Resource

Learn more about how to Prevent Slow or Broken APIs From Affecting Your Bottom Line.

I am a big fan of Jekyll, the static content management system (CMS). All of API Evangelist runs as hundreds of little Jekyll driven Github repositories, in a sort of microservices concert, allowing me to orchestrate my research, data, and the stories I tell across all of my projects. I recommend that API providers launch their API portals using Jekyll, whether you choose to run on GitHub or anywhere else using the light-weight portable solution. I have several Jekyll templates I use to fork and turn into new API portals, providing me with a robust toolbox for making APIs more usable.

My friend and collaborator James Higginbotham (@launchany) has launched a new minimum viable documentation (MVD) template for APIs, providing API providers with everything they need out of the gate when it comes to a presence for their API. The MVD solution provides you with a place for your getting started, workflows, code samples, reference material, with OpenAPI as the heartbeat–providing you with everything you need when it comes to API documentation. It all is an open source package available on GitHub, allowing any API provider to fork and quickly change the content and look and feel to match your needs. Which in my opinion, is the way ALL API documentation solutions should be. None of us should be reinventing the wheel when it comes to our API portals, there are too many good examples out there to follow.

I know that Jekyll is intimidating for many folks. I’m currently dealing with this on several fronts, but trust me when I say that Jekyll will become one of the most important tools in your API toolbox. It takes a bit to learn the structure of Jekyll, and get over some of the quirks of learning to program using Liquid, but once you do, it will open up a whole new world for you. It is much more than just a static content management system (CMS). For me, it’s most significant strength has become as a data management system (DMS)??, with OpenAPI as the heart. I use Jekyll (and GitHub) for managing all my OpenAPI definitions, JSON and YAML files, and increasingly publishing my data sets in this way instead of relying on server-side technology. If you are looking for a new solution when it comes to your API portal, I recommend taking a look at what James is up to.

Learn about the Five Steps to API Monitoring Success with Runscope

Topics:
api ,integration ,jekyll ,documentation ,openapi

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

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

{{ parent.tldr }}

{{ parent.urlSource.name }}