Harnessing BDD Techniques like Example Mapping for Effective API Documentation

A presentation at APIDays Paris in in Paris, France by Frank Kilcommins

For APIs to be good, they need to be useful, useable, and findable. Adding longevity can make them successful. To ensure API longevity and promote adoption, it’s essential to keep focus at the intersection of design, governance, and empathy for the human actors involved.

In this talk, I explore Behavioral-Driven Development (BDD) as an enabler for human-centered and agile API delivery. Humans effectively learn through examples, and the “Example Mapping” technique can aid and embed API governance into the human collaboration of a team or organization. Combining this with the power of API specifications (like OpenAPI) can take living documentation to a new level.



The following resources were mentioned during the presentation or are useful additional information.