There has been a growing trend among API teams to better standardize their API design process.
For many, the effort to standardize API design starts as an internal exercise to make sure that everyone involved in designing, developing, and testing APIs are on the same page. Design guidelines may be published internally as a PDF or on an internal Wiki for everyone to reference, and processes are put in place to make sure teams are following the design guidelines.
But many companies take this a step further and publish these guidelines publicly as a reference for developers working with their APIs, and anyone else that wants to learn from their experience.
Arnaud Lauret (better known as the API Handyman) is the creator of API Stylebook, an online resource dedicated to helping API developers solve their API design challenges by learning from organizations that have effectively implemented a process for standardize API design. Arnaud has reviewed style guides from organizations across a wide variety of industries, including Cisco, Google, Paypal, Microsoft, and others, and compiles his findings in one easy-to-navigate resource.
I recently had the chance to speak to Arnaud about how API Stylebook came to be, and to get his advice for organizations that are starting the journey of setting up API design guidelines of their own.
As Arnaud explains, creating internal style guidelines is the just the beginning of the process. Read our full interview below to find out what comes next, and what lessons Arnaud has learned from his work on API Stylebook. [Read more…]