|By Mark O'Neill||
|September 5, 2013 06:34 PM EDT||
Let's dig into this a bit. What is an API Catalog, and what is innovative about the API Catalog in the Axway API Server v7.2?
Firstly, an API Catalog is an important part of an API Developer Portal, because it provides a simple way to get a listing of the available APIs, with documentation about how they are used. Swagger is the most common format for documenting APIs. Swagger has becoming something of an industry standard because it provides a simple UI to document APIs. Compared to what went before (UDDI registries to register SOAP services), an API Catalog is much easier to use.
Axway provides a sample API Developer Portal as part of the API Management Solution Pack. The API Management Solution Pack is designed to run on the API Server. In the screenshot below we see the API Catalog in the sample API Developer Portal. Note the swagger look-and-feel:
So what if you want to customize this portal? Unless your company is called "Axway" and you have the same red logo, you're going to want to customize the portal! :-) . How do you do that?
The answer is, as you might guess, through its API. Yes, the API Portal itself has an API (called the "API Portal API"). For example, if I do an HTTP GET on this path, I get back the swagger feed as JSON for an API called "Sample API":
You can see this in action below, returning the raw JSON describing my API:
This was a simple example built quickly, but you can see the power of the API to customize the look and feel of the API Catalog.
Perhaps most importantly, the fact that the API Catalog has its own API (as part of the API Portal API), enables you to easily embed an API Catalog into your existing developer site, just like you might embed any other data feed via an API.
Have fun playing with the API Catalog, and contact Axway with any questions!