Skip to content

task-add-api-instance.adoc

Latest commit

 

History

History
251 lines (198 loc) · 12.1 KB

task-add-api-instance.adoc

File metadata and controls

251 lines (198 loc) · 12.1 KB
Raw

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 Flex Gateway for any APIs that need a flexible and performant API gateway that works with distributed and microservices environments and fits into your CI/CD environments.

Use Flex Gateway to protect MCP servers that need a flexible and performant gateway that works with distributed and microservices environments and fits into your CI/CD environments.

Use Flex Gateway for any A2A servers that need a flexible and performant gateway that works with distributed and microservices environments and fits into your CI/CD environments.

Use Mule Gateway if you have APIs on Mule Runtime that need an API gateway to manage, observe, and secure your APIs.

Use Anypoint Service Mesh to extend Anypoint Platform API Management capabilities to your Istio service mesh through the deployment of a Mule Adapter.

The following diagram shows the server instance’s upstream and downstream configurations. In this configuration, the downstream service is the service making requests that are completed by the upstream server. These terms represent the direction of dependency, not the direction of information.

The server instance is deployed on a gateway between the upstream and downstream configuration

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.

The API instance is deployed on a gateway between the upstream and downstream configuration

  1. Navigate to Anypoint Platform > API Manager.

  2. In API Administration, click Add API and select Add new API.

  3. Select Mule Gateway as your runtime.

  4. Select Deploy a proxy application for Proxy type.

  1. If you selected to deploy a proxy application, select the Target type from the following options:

    • CloudHub 2.0: Select this option if you want to use the Mule runtime hosted by MuleSoft in a container-based cloud infrastructure. The CloudHub 2.0 proxy includes a CPU with 0.1 vCores by default.

      1. Select a space.

        To learn more about spaces, see cloudhub-2::ch2-shared-space-about.adoc and cloudhub-2::ch2-private-space-about.adoc.

      2. In Runtime version:

        1. Select the Runtime Channel.

        2. Select the Version for Mule runtime.

        3. Select the Java version.

      3. Enter a Proxy app name.

    • CloudHub: Select this option if you want to use the Mule runtime hosted on the cloud by MuleSoft. The CloudHub proxy includes a CPU with 0.1 vCores and a memory of 500 MB, by default.

      1. In Runtime version:

        1. Select the Runtime Channel.

        2. Select the Version for Mule runtime.

        3. Select the Java version.

      2. Enter a Proxy app name.

    • Hybrid: Select this option if you want to use a Mule runtime instance running on an on-premises server that is registered in Runtime Manager.

      See Register a server in Runtime Manager for more information.

      1. Select a target from the list or click Add server.

      2. Enter a Proxy app name.

    • Self-managed Server: Select this option if you want to create a JAR file to deploy an API proxy to a Mule runtime instance running on an on-premises server that is not registered in Runtime Manager. For more information, see mule-runtime::mule-deployment-model.adoc.

Deploying an API proxy to a self-managed server in API Manager doesn’t deploy the proxy to your on-premises server. After you deploy the proxy in API Manager, deploy the proxy to your on-premises server: . Download your new API proxy JAR file. . Deploy the JAR file to your on-premises server.

  • Runtime Fabric: Select Runtime Fabric if you want to deploy API Proxies to a Mule runtime engine that is managed on Runtime Fabric. See Deploying API Proxies to Runtime Fabric for more information.

    1. Select a target from the list.

    2. In Runtime version:

      1. Select the Runtime Channel.

      2. Select the Version for Mule runtime.

      3. Select the Java version.

    3. Enter a Proxy app name.

  1. Select Hybrid for Target Type, then select the target server.

  2. Click Next.

  1. 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.

      1. Click the API from the list under Select API. You can search for a specific API if needed.

      2. 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 exchange::asset-versions.adoc.

      3. 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 govern-api-instances.adoc.

    • Click Create new API:

      1. Enter a Name for the new API asset.

  1. Select the Asset type from the following options:

    • REST API: Select this option if you have an OAS API definition file you want to include for your asset.

      Upload an OAS file for your REST API. Versions 2.0.0 and later are the recommended versions for OAS 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.

  2. 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 exchange::asset-versions.adoc.

  3. 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 govern-api-instances.adoc.

    1. Click Next.

  1. 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.

  2. 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 exchange::asset-versions.adoc.

  3. 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 govern-api-instances.adoc.

    1. Click Next.

  1. Select REST API as the Asset type.

  2. Upload either a RAML or OAS file for your REST API.

    Note
    		 Anypoint API Manager supports OpenAPI Specification (OAS) 3.0, with the exception of the callback feature. To work around this issue, handle the callback outside of the Mule runtime engine domain or use an OAS 3.0 specification that does not use callbacks.

  3. 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 exchange::asset-versions.adoc.

  4. 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 govern-api-instances.adoc

    1. Click Next.

  1. Select SOAP API as the Asset type.

  2. Select either Upload a WSDL or Use an external link as the method.

  3. Update the Asset type, API version, and Asset version if needed.

    1. Click Next.

  1. Configure the downstream configuration settings:

    Expand for configuration settings.

  2. Click Next.

  1. Configure the downstream configuration settings:

    Expand for configuration settings.
    Note
    		 To configure an HTTPS Proxy, you must select HTTPS and configure an Inbound TLS context.

  2. Click Next.

  1. Configure the upstream configuration settings:

    Expand for configuration settings.

  2. Click Next.

  1. Review your selections and edit them if necessary.

  2. 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.