Use the integration to explain topology

An integration connects a producer or source to a consumer or destination and records the style of interaction. Its type may be API, event or another pattern. That relationship is distinct from the reusable technical contract it uses.

Let the contract govern payload meaning

For an API, OpenAPI is generally the right authority for endpoint operations, request and response schemas. For events, an explicit event or message contract defines the published facts. The repository should reference a versioned authoritative contract rather than recreating every schema field as informal duplicate text.

Keep the provider distinct from the transport

A business-facing service is the behaviour offered to consumers; an application or component implements it; an interface such as an API exposes it. An API gateway, firewall or function hosting platform is technology participating in delivery. They should not all be classified as independent logical applications.

Support multiple consumers carefully

A reusable event or API may have one provider and several consumers. Producer and consumer relationships can be derived from integration records rather than duplicated in conflicting fields. Controlled identities allow an API or event to be version-pinned while an integration design evolves.

Practical lesson

A trustworthy repository assigns each concept an appropriate authority: topology for integrations, payload for contracts, behaviour for services and implementation for applications or technology. The links between them produce the useful architectural picture.

The MétiArch perspective

This article explains design principles and lessons from developing architecture tooling. Examples are illustrative. A described design approach does not, by itself, indicate that a feature is enabled or generally available in a deployed product.

← Explore all insights