Craft the API documentation developers crave - with the power of OpenAPI!

This hands-on workshop equips you with the skills to build comprehensive and interactive OpenAPI specifications, the industry standard for documenting APIs. No prior OpenAPI experience is required! Whether you're a technical writer seeking to bridge the gap with engineering or an engineer looking to create user-friendly API docs, this workshop will guide you through the entire process, from designing your API to crafting clear and interactive documentation.

Dive Deep into the World of OpenAPI:

- Grasp the core concepts of the OpenAPI Specification (OAS) and its role in API development.

- Master the building blocks of effective documentation: components, schemas, responses, and more. Learn to structure your API description for clarity and maintainability.

- Unlock the power of interactive documentation: Explore how OpenAPI specifications can be leveraged to generate interactive experiences for developers, complete with code examples and testing capabilities.

- Bridge the communication gap: Discover how OpenAPI fosters seamless collaboration between technical writers and engineers throughout the documentation lifecycle.

Attendees of this workshop will build an example open API documentation. In this process , learning best practices for creating schemas, components, parameters and paths to documenting endpoints. They’ll also learn how to optimise Open API specifications for existing documentation, because these files tend to be large most times. Finally , they’ll learn the different tools to deploy the openAPI documentation for public users to have interactive testing experiences with the API.