Skip to content
Technical preview

Technical preview function is in a state that it can be tried. The development is complete, there is documentation and there are samples, tutorials and hands-on labs as appropriate.

The community is looking for feedback on the function before declaring it stable. This feedback may result in changes to the external interfaces.

Open API Monitor Integration Connector

Connector details

Overview

The Open API monitor integration connector connects to an endpoint and extracts the open API specification through the GET {{serverURL}}/v3/api-docs request. It creates a DeployedAPI asset for each API Tag that is known to the server. A new APIOperation is created for each combination of path name and operation (GET, POST, PUT, DELETE).

Figure 1

Figure 1: Operation of the Open API monitor integration connector

Configuration

This connector uses the API Integrator OMIS running in the Integration Daemon.

This is its connection definition to use on the administration commands that configure the Lineage Integrator OMIS.

Connection configuration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
   "connection" : 
                { 
                    "class" : "Connection",
                    "qualifiedName" : "APIMonitorConnection",
                    "connectorType" : 
                    {
                        "class" : "ConnectorType",
                        "connectorProviderClassName" : "org.odpi.openmetadata.adapters.connectors.integration.openapis.OpenAPIMonitorIntegrationProvider"
                    },
                    "endpoint" :
                    {
                        "class" : "Endpoint",
                        "address" : "{{serverURL}}"
                    }
                }
}
  • Replace {{serverURL}} with the network address of the process where the API is hosted (for example, localhost:9443).