The OpenAPI Doctor | WSO2Con Barcelona 2025



AI Summary

Overview

  • Speaker: Quobix, founder of Princess Beef Heavy Industries and engineer at Cisco.
  • Topic: Open API Doctor and principles behind Princess Beef.

Key Principles of Princess Beef

  • Focus on creating open-source software desirable enough for engineers to buy.
  • Strive to make tools that enhance productivity without overwhelming users.
  • Encourage users to adopt tools willingly rather than being forced by companies.
  • Aims for software to provide quick value (zero to value in 10 seconds).

Tools and Technologies

  • Lib Open API: Core compiler for Open API facilitating the development of tooling with low-level and high-level access.
    • Supports concepts like aliases, anchors, line numbers.
  • Open API Validator: Validates HTTP traffic against Open API contracts.
  • Open API Changes: Diffing tool that provides semantic diffs displaying changes in data structure rather than just JSON output.
  • Wiretap: Compliance engine validating HTTP traffic against specs, facilitating mocking capabilities.
  • Vacuum: Fast quality tool designed for real-time linting of Open API definitions with a terminal UI and faster performance than competitors.

Open API Doctor

  • Comprised of three main pillars:
    1. Quality Analysis: Tracks API contract quality and provides recommendations for improvement.
    2. Change Management: Monitors changes to API contracts, highlights breaking changes, and facilitates visualization of differences.
    3. Compliance Validation: Ensures that API implementations are compliant with designed specifications.

Future Development

  • Features to include integration tracking across all changes, testing mocks in real-time, enhanced visualization, and extensibility into other API and schema technologies (e.g., async API, JSON schema).
  • Open to community contributions and discussions for further enhancements.