Managing APIs in federated API management

Managing APIs includes viewing APIs, viewing associated runtimes and its corresponding API versions, viewing APIs in its respective runtime, and highlighting the differences in the API, which is deployed across multiple runtimes.

• View a consolidated list of APIs that are available across different runtimes.
  1. On the Catalog page, click the APIs tab to view the consolidated list of APIs that are available across different runtimes.
• View associated runtimes and multiple versions of an API.
  1. On the Catalog page, click the APIs tab.
  2. To view the list of runtimes and its corresponding API version, expand the API.
     In the Status column, you can verify the status of the API. The following table describes the status conventions.

     Status icon	Description
     	All the APIs in the runtime are active.
     	All the APIs in the runtime are inactive.
     	The APIs in the runtime are either active or inactive.
     	There is no adequate data to compute the status of the APIs.

• Open API in its respective runtime.
  1. On the Catalog page, click the APIs tab.
  2. To open the API in its respective runtime, select the Open in runtime button corresponding to the API.

     To view the APIs associated within the runtime, make sure that the runtime's host field is configured by using the Edit runtime option in the federated API management UI.

     To view the APIs associated with any third-party runtime, make sure that:

     • Runtime's host field is configured either at the time of registration with federated API management or later by using the Edit runtime option in the federated API management UI.
     • API's relativeWebUrl is configured with a deep link that points to the corresponding API details page in the runtime. The relativeWebUrl must be sent along with the API's details by the runtime agent during API publish or synchronization activity. For details, see API Management.
       For example, if the URL for an API is https://example-runtime.eu-west.org/api/catalogs/9447291d-09b7-43c0-bc21-dc7f77c5a1de/096880bc-d9e4-4e46-8e8a-1ec32a056ec1/apis/ff9b5d9e-5cce-4ed2-9a88-3f45dd5117d2, to make the Open in runtime work in federated API management, set the following for a runtime (during runtime registration) and for an API in the agent:

       • Runtime payload. Set the host field to https://example-runtime.eu-west.org
       • API payload. Set the relativeWebUrl to /api/catalogs/9447291d-09b7-43c0-bc21-dc7f77c5a1de/096880bc-d9e4-4e46-8e8a-1ec32a056ec1/apis/ff9b5d9e-5cce-4ed2-9a88-3f45dd5117d2

       If the API is associated with just Developer portal runtimes and not with any other runtimes, then the Open in runtime option is not applicable.

• Highlight the differences in the same API when deployed across different runtimes.
  1. On the Catalog page, click the APIs tab.
  2. Expand the API and select Highlight the differences to compare the same API deployed across different runtimes by API name, version, description, policies, and tags.

     You can view the differences among APIs in different colors. If you want to highlight the difference in a particular category like API name or version, select the corresponding checkbox in the column header.

     In a column, APIs with identical values appear with the same color. For example, consider an API with the API name as Petstore that is present across different runtimes. If you select the Highlight the differences checkbox for API name, APIs with the same API name are highlighted with the same color. If the same API's name is changed to Petstore1 in any of the runtimes, the difference is highlighted with a different color. If the differences exceed 10 (which means there are 10 APIs with 10 different names across 10 runtimes), an error message displays prompting you to correct the differences in the respective runtime. With Highlight the differences, you can easily identify API differences and avoid discrepancies across runtimes.

     Note: As Developer portal runtimes do not support policies, the Policies column corresponding to Developer portal runtime type is shown as N/A. If you select the Highlight the differences checkbox for Policies, APIs with differing policy counts are included in the Differences count, excluding the APIs associated with Developer portal and runtimes.