Skip to content

Modelling APIs

Figure 1 shows the types of metadata that describes 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 the metadata created through this service.

Figure 2

Figure 2: API open metadata types

If an APIManager is defined, any API created is automatically linked to it using the ServerAssetUse relationship. When an APIOperation is created for the API, the service automatically inserts the Schema relationship, APISchemaType entity and APIOperations relationship in between the DeployedAPI entity and the APIOperation entity.

Any schema attributes created through this interface will 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