Build RAML or OAS API Proxies

API Manager 2.x enables you to use a RAML or OAS type of API Proxy, for all your Mule 4 based proxies.

Configuring your RAML or OAS API Proxy

Configure your RAML or OAS API proxy by completing the following tasks:

Select a Proxy Type

  1. In API Manager, click Add API and select Add new API.

  2. Select Mule Gateway as your runtime.

  3. Select Deploy a proxy application for Proxy type.

Select and Configure a Target Type

  1. Select the Target type from the following options:

    • 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. Select the Runtime version.

      2. Enter a Proxy app name.

    • Hybrid: Select Hybrid if you have a Mule runtime running on an on-premises server that you want to use. See Register a server in Runtime Manager for more information.

      If you are running an API with a self-managed server, use the classic API creation flows to manage your API.
      1. Select a target from the list or click Add server.

      2. Enter a Proxy app name.

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

      After adding the API on Anypoint Platform, you will need to bind it to a service using the Anypoint Service Mesh client. See Methods for Configuring Anypoint Service Mesh for more information.
  2. Click Next.

Select an API

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

    • Click Create new API.

      1. Enter a name for the new API asset.

      2. Select REST API as the Asset type.

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

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

Configure Options

  1. Enter your Implementation URI.

  2. Click Advanced Options.

  3. Enter the Port number for your API proxy.

  4. In Proxy Version, select latest.
    This value ensures that your API proxy uses the latest released proxy version.

    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 will be translated to RAML.

  5. If you plan to have HTTPS communications, specify a TLS Context.

  6. Click Next.

Review, Save, and Deploy

  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.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub