Promote an API Schema

As you develop and configure an API schema, you can promote it to the next environment toward production and add it to that environment’s unified schema. Note that youโ€™re promoting the schema configurations only, not the actual underlying source REST APIs.

Promotion enables you to configure an API schema in one environment without repeating that configuration in subsequent environments. Use promotion to move your schema configurations from development to staging and from staging to production.

The steps you take to promote an API through the production cycle vary depending on your needs. For example, imagine that you add and configure an Orders API in your development environment that you now want to promote to staging. The possible promotion scenarios are as follows:

Development Orders API Version Staging Orders API Version Promotion Action Promotion Outcome Version

v3.1.0

None

Anypoint DataGraph promotes the API schema and any of its configuration.

You configure the URL and authentication method.

v3.1.0

v3.1.1

v3.1.0

Anypoint DataGraph automatically updates the asset version of the existing API schema.

You configure the URL and authentication method.

v3.1.1

v3.1.0

v3.1.0

Anypoint DataGraph updates any customizations to the asset version.

v3.1.0

v4.0.0

v3.1.0

Anypoint DataGraph adds both API versions to the target environment, where they coexist.

You configure the URL and authentication method for v4.0.0.

v3.1.0, v4.0.0

Promote an API to Another environment

You can promote API schemas to any environment to which you are permitted access.

Although your APIs must be published in Exchange, they do not need to be Mule applications or be running on Mule runtime engine or in CloudHub to be added to the unified schema.

The schema you promote must not be in conflict with the unified schema in the target environment. If conflicts exist, you must instead manually add the API and resolve those conflicts as you would when adding an API.

Supported authentication methods to access your API from Anypoint DataGraph are listed in the following procedure. Any other authentication methods, such as custom OAuth implementations or short-lived token methods, are not supported. See Supported Authentication Methods for more information.

To promote an API:

  1. Click List of APIs added and select the API that you want to promote.

  2. Click Promote API schema.

  3. From the Target environment list, select the target environment for promotion.

  4. Click Next: Configure URL.

  5. Depending on your promotion scenario, optionally choose one of the following configuration options:

    • If your API is managed by API Manager or if you have added the APIโ€™s instances in Exchange, select Get an existing URL from Anypoint Platform.

    • If you prefer to provide your own implementation URL, select Add a new URL or click Use the URL in API specification.

  6. Click Next: Provide Authentication.

  7. On the Provide authentication page, select the type of authentication on the GET endpoints for the API that you want to add, allowing Anypoint DataGraph to make requests to your API when queried:

    • No Auth: Use if your API is public.

    • Basic Auth: Use if you authenticate to your API using a username and password.

    • Client ID enforcement via headers: Use if you authenticate to your API passing client_id and client_secret headers.

    • Client ID enforcement via query parameters: Use if you authenticate to your API passing client_id and client_secret query params.

    • Custom: Use if you authenticate to your API using custom header parameters and values.

    Any other authentication methods to access your API, such as custom OAuth implementations or short-lived token methods, are not supported.

    See Supported Authentication Methods for more information.

  8. Click Next: Add to unified schema.

Was this article helpful?

๐Ÿ’™ Thanks for your feedback!

Edit on GitHub