# Opaque API

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

Record: `lexicon:opaque-api`
Kind: anti-pattern
Layer: [Declarative Core](https://banes-lab.com/records/layer/declarative-core.md)
Canonical: https://banes-lab.com/ontology/lexicon#lexicon-opaque-api

Listed in [Lexicon terms](https://banes-lab.com/api/records/lexicon.md), after [Implicit Capability](https://banes-lab.com/records/lexicon/implicit-capability.md) and before [Opaque Binary/Untyped Structures](https://banes-lab.com/records/lexicon/opaque-binary-untyped-structures.md).

## Category

- [Metadata / Self-Description / Declarative Systems](https://banes-lab.com/records/lexicon-category/metadata-self-description-declarative-systems.md)

## Negated by

- [Self-Describing API](https://banes-lab.com/records/architecture/self-describing-api.md)

## Linked from

- [Metadata / Self-Description / Declarative Systems](https://banes-lab.com/ontology/principles/architecture-category-metadata-self-description-declarative-systems.md)
