The page has moved to: https://github.com/linksmart/service-catalog/wiki/API-Documentation
Follow link above if you are not automatically redirected in 5 seconds.
Service Catalog provides a REST API for service discovery described below:
The following diagram shows the data model of Service Catalog:
The attributes are described below:
Catalog object consists of:
Service object consists of:
Doc object consists of:
Service catalog also supports MQTT for service registration and de-registration.
Service registration is similar to PUT method of REST API. Here, a service uses a pre-configured topic (via config file) for publishing the message.
The will message of the registered service is used to de-register it from the cataog whenever the service disconnects.
For more information on configuration of MQTT topics for service registration and de-registration and examples, see the Configuration page.
Service Catalog announces the service registration status via MQTT using retain messages.
The message topics follow following patterns:
<topicPrefix >/< RFC6339 service name>/<service_id>/alive : (Retained message) The body contains service description of alive service
<topicPrefix >/< RFC6339 service name>/<service_id>/dead : (Not retained message) The body contains service description of the 'dead' service
The retained messages are removed whenever service de-registers.
topicPrefix can be configured via config file.
API version is based on semver. The version is included as a parameter to the MIME type of all HTTP responses: