Adding a Service Mesh API Instance
After you have created an API using Design Center or any other application, you can then manage that API in API Manager by adding an API instance. API instances remain under management until you delete them.
Use Anypoint Service Mesh to extend Anypoint Platform API Management capabilities to your Istio service mesh through the deployment of a Mule Adapter.
There are three options for adding an API instance:
-
Add a new API: Select this option to add a completely new instance of an API.
-
Promote API from environment: Select this option if you have an API instance in a different environment, for instance the sandbox environment, and you want to promote it to the current or production environment.
-
Import API from zip file: Select this option if you have exported an API instance from a different Anypoint Platform instance.
When you are promoting or importing an API instance, you do not have options to alter the configuration. However, when you add a new API instance, you need to the downstream and the upstream configuration settings.
The following diagram shows the relationship of the upstream and downstream configurations settings to your upstream service and the downstream consumer application. In this configuration, the downstream service is the service making API requests that are completed by the upstream service. These terms represent the direction of dependency, not the direction of information. A downstream service could make a POST request where it provides information to the upstream service. However, the downstream service is still dependent on the upstream service to complete the request.
Add a New API
-
Navigate to Anypoint Platform > API Manager.
-
In API Administration, click Add API and select Add new API.
-
Select Service Mesh.
After adding the API on Anypoint Platform, you need to bind it to a service using the Anypoint Service Mesh client. See Methods for Configuring Anypoint Service Mesh for more information. -
Click Next.
-
Select an API from the following options:
-
Click Select API from Exchange if you have an API shared with you through Exchange that you want to manage.
-
Click the API from the list under Select API. You can search for a specific API if needed.
-
Update the Asset type, API version, and Asset version if you are not using the latest version.
For more information about versions in Exchange, see Asset Versions.
-
If you chose a RAML/OAS asset type, view the Conformance Status of the API to ensure the API is conformant. If the Conformance Status is nonconformant, after deployment, view the Governance Report to find and fix the conformance issues. For more information about the Governance Report, see Governing API Instances.
-
-
Click Create new API:
-
Enter a Name for the new API asset.
-
Select the Asset type from the following options:
-
REST API: Select this option if you have a RAML or OAS API definition file you want to include for your asset.
Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support. If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification is translated to RAML.
-
HTTP API: Select this option if you do not have an API definition file you want to include for your asset.
-
SOAP API: Select this option if you have a WSDL API definition file or an external link to the file.
Upload a WSDL file for your SOAP API or add the link to the file.
This option is not available for Flex Gateway runtime at this time.
-
-
Update the Asset type, API version, and Asset version if you are not using the latest version.
For more information about versions in Exchange, see Asset Versions.
-
If you chose a RAML/OAS asset type, view the Conformance Status of the API to ensure the API is conformant. If the Conformance Status is nonconformant, after deployment, view the Governance Report to find and fix the conformance issues. For more information about the Governance Report, see Governing API Instances.
-
-
-
Click Next.
-
Configure the downstream configuration settings:
Field Name Description Required Notes Instance label
Specifies a label for the API.
No
If you have multiple managed instances of the same API, add a label to differentiate each instance from the others.
Advanced Options
Consumer endpoint
Specifies a proxy application’s address for consumers to use for sending requests.
No
Client provider
Specifies a client provider for the API.
Yes
Anypoint Platform acts as the client provider by default. To configure an external client provider, see Client Providers.
-
Click Next.
-
Configure the upstream configuration settings:
Field Name Description Required Notes Upstream URL
The URL to access for the proxy or the API.
No
For example, you can use the URL of your API asset in Exchange.
-
Click Next.
-
Review your selections and edit them if necessary.
-
If you are ready to deploy, click Save & Deploy. Otherwise, you can select Save, to save the API instance and deploy it at a later time.
Promote an API Instance from Another Environment
-
Navigate to Anypoint Platform > API Manager.
-
In API Administration, click Add API and select Promote API from environment.
-
Select the Source Environment.
-
Select the API by entering the name of the API into the search field.
-
Select the API Version.
-
Select the API instance label.
-
Optionally, uncheck any of the Include in Promotion options you want to exclude.
-
Click Promote.
-
Review and update the Runtime & Endpoint Configuration details as needed and click Save.
Import API from Zip File
-
Navigate to Anypoint Platform > API Manager.
-
From API Administration, click Add API and select Import API from zip file.
-
Click Choose file and select your API instance configuration zip file.
-
Click Next.
-
Review and update the API Configuration details as needed and click Save.