Skip to content

OpenBindings Interface Creator

Interface for creating OpenBindings interfaces from binding artifacts. Given a binding specification (e.g., an OpenAPI spec), an interface creator extracts operations, schemas, sources, and bindings into an OBI document.

OBI 0.1.0 v0.1.0 2 operations

Operations

Schemas

FormatInfo object

Information about a supported binding format.

token string required

Format token (e.g., openapi@3.1, asyncapi@3.0, grpc).

description string

Human-readable description of this format.

CreateInterfaceSource object

A binding source to create an interface from.

format string required

Format token for this source.

name string

Key name for this binding source in the output.

location string

Location to fetch content from (path or URL).

content any

Content provided directly.

outputLocation string

Location to reference in the output.

embed boolean

If true, embed content inline in the output.

description string

Human-readable description for this source.

One of: anyany
CreateInterfaceInput object
openbindingsVersion string

Target OpenBindings spec version.

sources CreateInterfaceSource[]

Binding sources to create from.

name string

Interface name override.

version string

Interface contract version override.

description string

Interface description override.

OpenBindingsInterface object

A valid OpenBindings interface document.

Source