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

Prototype API Design Guide Builder Developed on Top of API Stylebook

DZone's Guide to

Prototype API Design Guide Builder Developed on Top of API Stylebook

I just developed the self-contained editor and viewer and am looking to add autocomplete suggestions based on other guides in the API Stylebook.

· Integration Zone
Free Resource

Modernize your application architectures with microservices and APIs with best practices from this free virtual summit series. Brought to you in partnership with CA Technologies.

I was pretty happy when my friend Arnaud Lauret developed the API Stylebook. I want to see his work expand and grow into something that will someday contain hundreds or thousands of API design guides. To help contribute to his work, I took the YAML core of the design topics he's aggregated and began developing an API design guide builder that runs 100% on Github, allowing anyone to fork and use to build their own API Stylebook on top of Arnaud's work.

Currently, I have two screens for API design guide builder:

  • Editor: Allows for the editing of the YAML API Design Stylebook stored in the GitHub repository.
  • View: Allows you to view the API Design Stylebook stored in the GitHub repository.

I'm a big fan of this approach to developing little machine readable (YAML and JSON) micro tools that are simply HTML, CSS, and JavaScript with a data core. In this scenario, Arnaud's design topics act as the machine-readable YAML core. I just developed the self-contained editor and viewer, allowing anyone to fork and use to manage their own API design guide.

This is just a prototype. I am just getting started. I am looking to add autocomplete suggestions based on the other API design guides that Arnaud has aggregated in his API Stylebook. I am adding this and some other features to the GitHub issues for the project. If you have any feedback or suggestions feel free to submit an issue to the GitHub repository. 

My objective here is to allow anyone to quickly fork and build their own corporate or project API design guide, built on top of the existing best practices out there. I envision a future where each company, organization, institution, and agency have their own API design guide, building on the best approaches available. Arnaud can continue to aggregate and merge the best practices (using GitHub) out there, and API providers can keep forking and building on top of the best practices of the APIs they look up to across the landscape (another feature I want to add).

I really like what Arnaud has done with the API Stylebook. It reflects my own building block approach across my 70+ API research projects, where I'm looking distil down what is happening across each stop along the API life cycle. I will be forking the API Stylebook design topics and API design guides they have indexed and adding to my own API design research. I am having fun building on top of his work and look forward to what other folks build on top of it as well.

The Integration Zone is proudly sponsored by CA Technologies. Learn from expert microservices and API presentations at the Modernizing Application Architectures Virtual Summit Series.

Topics:
integration ,api design ,yaml ,api stylebook

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

Opinions expressed by DZone contributors are their own.

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

{{ parent.tldr }}

{{ parent.urlSource.name }}