When APIs have been registered in API Manager, you can promote them directly from API Manager using its export/import mechanism. You can also use an optional promotion policy configured in Policy Studio (for example, to automate promotion between sandbox APIs and production APIs).
In addition, when APIs have been developed using Policy Studio, you can promote them between environments using the API Gateway mechanism for promotion and deployment of API Gateway configuration.
APIs registered using API Manager can be exported from one API Manager and imported to another API Manager using a file-based package (.json
). This enables APIs to be promoted from a sandbox API group where client applications are developed and tested to the production API group.
For details on how to export a back-end REST API, see Register REST APIs in API Manager.
For details on how to import a previously exported API as a front-end REST API, see Virtualize REST APIs in API Manager.
You can use an optional promotion policy that has already been developed in Policy Studio to automate this process. You can do this by selecting Server Settings > API Promotion in the Policy Studio tree. For more details, see Configure API management settings in Policy Studio.
Note |
|
When you have configured and deployed a promotion policy in Policy Studio, you must also then enable the policy in API Manager. You can do this by selecting Settings > API Manager settings > API REGISTRATION > API promotion via policy. A Promote API option is then added to the Frontend API management menu when you log in again. For more details, see Configure web-based settings in API Manager.
For details of onboarding a client application from sandbox APIs to production APIs, see Deploy sandbox and production APIs.
APIs created with the REST API development wizard in Policy Studio are part of the standard API Gateway configuration. This means that you can promote APIs between environments using the API Gateway mechanism for promotion and deployment of API Gateway configuration (.fed
, .pol
, and .env
). For example, you can use this mechanism to promote APIs from a testing environment to a production environment.
For more details on the API Gateway mechanism for promoting configuration between environments, see the API Gateway Deployment and Promotion Guide. For details of onboarding a client application from sandbox APIs to production APIs, see Deploy sandbox and production APIs.