OpenAPI for Documentarians

A presentation at APItheDocs in in Amsterdam, Netherlands by Lorna Jane Mitchell

OpenAPI descriptions are an excellent way of having all information about an API in one place, and making that available to many different tools. As a standard, it can be difficult to get started with, and the resulting files are often large and unwieldy. In this session, you’ll get an overview of the structure of OpenAPI descriptions, details on taking advantage of OpenAPI features to create documentation, and some tips on working around common problems. We’ll look at some of the tools available to help you through various stages of the API lifecycle, and how these fit into your documentation workflow. This session is recommended for technical writers, engineers, technical leaders and anyone else wanting to make their APIs a better place for developers.