API Evangelist API Evangelist
API Learnings
APIs
API Governance
API Solutions
API Discovery
API Building Blocks
API Evangelist LLC

API Metadata

The information on the file folder of your API.

The metadata for each individual API includes a unique identifier, name, description, images, and tags, which is meant to describe the business intent and uses cases for an API. Rely on the OpenAPI metadata to describe the technical details of an API, and the contract metadata to outline the business details.

You can think of metadata as what will show in the catalog, directory, or search engine for API resources and capabilities. The metadata helps APIs be discovered, but are also that first impression when business or engineering stakeholders are learning about an API. Metadata is essential to managing API operations at scale, and it requires everyone involved to do their part to contribute and improve.

API metadata should reflect the business reasons why a consumer will care about the digital resources and capabilities being made available. Leave the technical API contract to do the work with engineers, and try to make your API metadata speak to leadership and business stakeholders–speaking to the business problems that each API will solve when used in different applications.