Lexicon

Opaque API

Kind: anti-pattern

Layer: Declarative Core

Record: lexicon:opaque-api

Canonical: Lexicon

An API that does not describe itself, so clients must rely on external, out-of-band documentation.

Listed in Lexicon terms, after Implicit Capability and before Opaque Binary/Untyped Structures.

Category

  • Metadata / Self-Description / Declarative Systems

Negated by

  • Self-Describing API

Violates

  • Self-Describing API

Linked from

  • Metadata / Self-Description / Declarative Systems