What Happens When You Publish an API?
When you publish an API to Mediator or API-Portal, keep the following in mind:
CentraSite automatically validates the API's run-time policy (or policies) to ensure that:
Any action that appears in a single policy multiple times is allowed to appear multiple times.
All action dependencies are properly met.
CentraSite will inform you of any violation, and you will need to correct the violations before publishing the virtual API to API-Portal. For more information about dependencies and which actions can be included multiple times in a single policy, see Run-Time Governance with CentraSite .
You must make modifications to published APIs in CentraSite. If you need to modify an API that is already published to the Mediator or API-Portal, you must modify it in CentraSite and then republish it. The Mediator or API-Portal does not monitor CentraSite for updates to published APIs. If you make changes to an API's properties, for example, you must manually republish the API to put those changes into effect.
You cannot make changes to a run-time policy while it is active. To make changes to a policy after it has been switched to the active state you must switch the policy to the “Suspended” state (to deactivate it), update the policy and then switch it back to the “Productive” state (to reactivate it).
When you publish a virtual API to Mediator, CentraSite generates a VSD. When you publish a virtual API to the Mediator gateway, CentraSite generates an XML document called a virtual service definition (VSD). The VSD defines the virtual API for Mediator, and contains all the run-time policies and resources required to publish the virtual API to Mediator.
When you publish an API to API-Portal, CentraSite generates API metadata. When you publish an API to the API-Portal, CentraSite generates a zip package. The zip package defines the API metadata for API-Portal, and contains all the resources and methods required to use the API in the API-Portal.
You should not manually edit the endpoint information for APIs. When you publish a virtual API to the Mediator gateway, CentraSite automatically updates the API's CentraSite endpoint to its Mediator endpoint. You can view the Mediator endpoint on the virtual API's detail page in CentraSite. Because the endpoint information for virtual APIs is generated and updated by CentraSite, unlike when managing native APIs, you should not manually add endpoints to a virtual API. Instead, allow CentraSite to generate and manage the endpoints for the virtual APIs that you publish.
When you publish an API to the API-Portal, CentraSite automatically updates the API's CentraSite endpoint to the API-Portal endpoint. You can view the API-Portal's endpoint on the API's detail page in CentraSite. Because the endpoint information for an API is generated and updated by CentraSite, you should not manually edit the endpoint information for the API.
If publishing fails, the status is set to “Failed” and the failure is logged. If the Mediator or API-Portal encounters a problem publishing or republishing an API, it sets the API's Publish Status to “Failed” and sends a message to CentraSite describing the problem. This failure is also logged to the Mediator or API-Portal. In this case, it is up to the CentraSite or API-Portal administrator to take corrective action and republish the API manually from CentraSite.
However, you can publish multiple virtualized services in a single native service, in order to make the service available over multiple transports and/or security mechanisms. For details on managing endpoints, see Getting Started with CentraSite .
If the reason for the failure is that the Mediator or API-Portal instance is unavailable, and then you restart the Mediator or API-Portal instance, it loads all information about any previously published APIs.
