OpenAPI

OpenAPI is a widely adopted, language-agnostic specification for describing RESTful APIs in a machine-readable format, typically JSON or YAML. It enables developers to define API endpoints, operations, parameters, authentication methods, and data models, fostering a standardized approach to API…

Key facts

First appeared
2011
Category
technology
Problem solved
OpenAPI solves the critical problem of inconsistent, ad-hoc, and manually maintained API documentation, which often leads to miscommunication, integration errors, and slow development cycles between API providers and consumers. It provides a standardized, machine-readable contract that clarifies API capabilities, enabling automated tooling for documentation, client/server code generation, testing, and mocking.
Platforms
Any platform with OpenAPI tooling support (e.g., web browsers for Swagger UI, servers for code generation, development environments)

Related technologies

Notable users

  • Many Fortune 500 companies and startups across all industries
  • Adobe
  • Amazon
  • Microsoft
  • Stripe
  • IBM
  • Netflix
  • Google
  • Salesforce