API Styleguide, the Lord of API Designs
By Arnaud Lauret, November 12, 2017
Join Frodo, Gollum and Gandalf on an epic API design adventure. In this session, based on my own experience defining and sharing API design common practices in my company and based on the API styles guides that I have collected on apistylebook.com, we will discover why we desperately need API style guides and how they can or cannot help us create a smooth API surface for a company.
Very special thanks to Mister Lapin for designing my T-shirt and Kristof Van Tomme for recording the video with my phone.
Abstract
Every company’s API surface grows irremediably. More and more APIs means more and more people designing APIs, therefore keeping a company’s API surface consistent is quite a challenge. Failing this challenge may lead to a less efficient and even be counterproductive.
In this session, based on my own experience defining and sharing API design common practices in my company and based on the API styles guides that I have collected on the API Stylebook, we will discover why we desperately need API style guides, what we can put in them, how to build them and how they can or cannot help us and our fellow API designers to create together a flawless consistent API surface for our company. We will also see how API style guides could be used in the API ecosystem with tools such as the OpenAPI specification and API design tools to ensure that their rules are followed retrospectively and preemptively.
Video
