OPENAPI-EDI

The REST API spec standard — used to expose canonical EDI APIs.

Definition

OpenAPI 3.1.0 (published 2021) is compatible with JSON Schema 2020-12 by construction. Supports security schemes (OAuth 2.0, OIDC, mTLS), webhooks, server variables, examples. Client SDK generation (TypeScript, Python, Go, Java) via openapi-generator. Mock servers via Prism. Adopted by every modern iPaaS.

Origin

Swagger origin (Tony Tam, 2011). Transferred to Linux Foundation as OpenAPI Initiative in 2015.

Example in context

An openapi.yaml file describing POST /api/v1/orders, Order/OrderLine schemas, security: bearer JWT.

Related terms

• REST — paradigm described by OpenAPI.
• JSON Schema — used by OpenAPI.