Introduction to OpenAPI: Understanding and Using OpenAPI in Practice

OPEN API initiative logo
apidays PARIS logo

Teaser

OpenAPI has become essential for the design, documentation, and seamless integration of APIs, providing a standardized description language that enhances collaboration. This course covers the core principles and practical use of OpenAPI, empowering you to explore, create, and integrate OpenAPI descriptions confidently in your design, development, management, and governance workflows.

Date: December 2, 2024 |Duration: 1 day
Location: apidays Paris 2024 conference at CNIT Forest – 2 Pl. de la Défense, 92092 Puteaux, France
Pricing: 799 EUR (30% discount for OAI members)

Bio

Thomas Bayer is the CEO of predic8, a Germany-based software consultancy specializing in APIs and integration. He leads the team behind Membrane, an open-source API gateway with native OpenAPI support. On YouTube, Thomas shares his expertise and insights on software architecture and APIs. In his free time, he enjoys photography, learning languages, and collecting tools.

Who's it for?

Who's it for?

This workshop is designed for business analysts, product owners, and product managers. But API designers, developers, and software architects will also find value in participating. No programming skills are required, and the session includes no coding exercises; just a basic understanding of APIs is needed.

What you will learn

What you will learn

  • Grasp the structure and components of OpenAPI documents
  • Understand how to use OpenAPI for testing and collaboration
  • Be able to read and interpret OpenAPI documents
  • Gain insights into OpenAPI-driven collaboration for API processes
  • Learn how to create OpenAPI descriptions from scratch
  • Discover helpful OpenAPI tools, such as generators, linters, and bundlers
  • Review and assess OpenAPI documents from developers, suppliers and partners effectively
  • Create OpenAPI descriptions that delight developers and foster seamless collaboration

Contents

Fundamentals

  • What you need to know about HTTP
  • Anatomy of an API call
  • JSON and YAML basics or refresher
  • Introduction to API descriptions and their value
  • Overview of OpenAPI

Practical OpenAPI

  • Describing data structures with JSON Schema
  • Using an OpenAPI editor
  • Endpoints, parameters, and content
  • Organizing OpenAPI documents effectively
  • Making the most of API documentation
  • Versioning APIs with OpenAPI

OpenAPI Tools

  • Ensuring API description quality
  • Enforcing style guides and security standards

OpenAPI-Based Workflows

  • Code-first vs. contract-first approaches
  • API design workflows centered around OpenAPI
  • Key roles and collaboration methods

Join the Workshop

Attendees will receive a paper and a digital certificate that’s awarded by APImasters and OAI.

Badge OpenAPI Certification

Certification:
Introduction to OpenAPI:
Understanding and Using OpenAPI in Practice by Thomas Bayer