SOA.json

Building a heterogeneous catalog is one of the main pillar of success with the adoption of micro-services architecture. Having a versatile catalog for all the different types components is key (ie: API, AI models, Daemons, Frontend, etc...). The ability to create a heterogeneous catalog capable to automatically adapt and onboard all kind of different type of components is the way to go. Wether you have Legacy API, Passthrough endpoint, Smart endpoint, Function as a service endpoint, or Newly created API with any framework,  a holistic view of these APIs is a must with the ability to search, document, productize and view analytics.


SOA.json has the following sections:

  • UI meta data
  • Documentation meta data
  • Search meta data
  • Type meta data

SOAJS support the ability to have multiple item in one repository

SOAJS supports single repository with multiple catalog items where each is in a sub folder.

This is an example of repository with 4 folders where each folder contain an item and has its own soa.json

multi
{
	"type":"multi",
	"folders": [
		"example01/",
		"example02/",
		"example03/",
		"hello_world/"
	]
}

Catalog UI control 

You can control where you want the item to appear under what tab, in SOA.json you can specify  ui.main for main tab and ui.sub for sub tab.

UI.main

Catalog TypeDefault Value
soajsConsole
staticStatic
customCustom
configConfig
resourceResource
service

Service

daemonDaemon

UI.sub

SOAJS catalog always has the following sub tabs (All, Favorite), however if you set ui.sub your item will appear under the specified ui.sub tab and All.