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

Contract Metadata

The information on the file folder of your contracts.

The metadata for a contract includes a unique identifier, name, description, images, and tags, which is meant to define the contents and purpose of the API contract, leaving individual APIs and OpenAPIs to define the business and technical details of an API.

Having a standardized unique identifier, a simple and intuitive name, detailed description, relevant image, and a coherent set of tags for a contract help in discovery and management of the business and technical side of API operations–in a single machine readable artifact that can be automated and rendered wherever it is needed.

The contract metadata for an API does not have to be a novel. It shouldn’t be, but it should describe the relationships an API contract defines between API producer and consumer, focusing on the business and technical alignment it brings, and leave the details of the APIs to those definition, providing something that is likely to make sense to leadership and business stakeholders.