Skip to content

    OpenAPI Specification

    Reading time: 2 min.Editorially reviewed on:

    Definition

    OpenAPI describes HTTP interfaces in a machine-readable format.

    A vendor-neutral specification for describing HTTP-based APIs in a machine-readable document.

    Simply explained

    A technical datasheet explains which requests an interface accepts and how they are structured.

    Why it matters in practice

    Helps develop and operate digital systems robustly, securely, and maintainably.

    Example from business

    From a validated API description, documentation, tests, and client code are generated.

    Limits and pitfalls

    • Letting description and actual implementation diverge or only documenting security requirements.

    Origin & history

    OpenAPI originated from Swagger and is now further developed under the Linux Foundation.

    Use in mid-sized companies

    • Possible application: From a validated API description, documentation, tests, and client code are generated.

    Frequently asked questions

    What does OpenAPI specification mean?

    A vendor-neutral specification for describing HTTP-based APIs in a machine-readable document.

    Which mistakes should be avoided?

    Letting description and actual implementation diverge or only documenting security requirements.

    Sources

    Source checked on 10.10.2026. Editorial application examples are hypothetical; no proof of real customer results.

    Editorially reviewed on:

    On this page

    Next step

    Put knowledge into practice