Skip to content

Modelling APIs

Figure 1 shows the types of metadata that describe an API.

Figure 1

Figure 1: API metadata

The structure of an API specification consist of a number of APIOperations which in turn have optional APIParameterLists for the header, request and response. The details of these payloads are described using SchemaAttributes and SchemaTypes.

Figure 2 shows the open metadata types used to represent this metadata.

Figure 2

Figure 2: API open metadata types

If the APIManager that hosts the API is catalogued, link each DeployedAPI to it using the CapabilityAssetUse relationship. Between the DeployedAPI entity and its APIOperation entities sit the Schema relationship, APISchemaType entity and APIOperations relationship. An integration connector creates these elements through the clients of its integration context - for example, SchemaTypeClient.linkSchema() and SchemaTypeClient.linkAPIOperations() - or by cataloguing from a template that already contains them.

The schema attributes use the APIParameter subtype to allow for find requests that only return schema information for APIs. The schema attributes also use the TypeEmbeddedAttribute classification method for defining the schema type.


Raise an issue or comment below