cifraHQ Enterprise
Glossary

OpenAPI 3.0 platform

Open standard for describing HTTP APIs in YAML/JSON, enabling client generation, mocks, and interactive documentation.

Definition

Detail

OpenAPI (formerly Swagger) is the de facto standard for specifying REST APIs. An OpenAPI 3.0 spec describes endpoints, parameters, request/response schemas, examples, and authentication rules in one declarative file. From it you generate clients in any language, mocks for testing, and documentation portals. cifraHQ Enterprise publishes an OpenAPI 3.0 that is exactly the contract its own frontend consumes — not a hand-documented subset. This means any integrating client has capability parity with the native UI: if the portal can do it, your integration can too. Spec changes follow explicit semantic versioning in the path (/v1, /v2) with six-month deprecation announcements.

How does cifraHQ model OpenAPI 3.0?

Let’s schedule a 45-minute technical session with your team to see it in product.

Schedule session