Contact Free trial Login

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

  1. In API Manager, navigate to Manage API to create your API Instance.
    You can choose to either Creating an API instance by importing from Exchange or Creating an API instance by importing on API Manager.

  2. In Asset Type, select RAML/OAS.

    OpenAPI Specification (OAS) 3.0 is currently not supported in API Manager. You must convert the API to RAML or OAS 2.0 to manage it using API Manager. For converting the specifications to OAS 2.0, you must use third-party tools, such as APImatic.
  3. To configure your API Proxy for this API instance you need to select Endpoint with Proxy in the Managing Type fields.

    1. Select your Proxy Deployment Target from the available deployment targets displayed.

    2. Select the Check this box if you are managing this API in Mule 4 or above check mark.

    3. Type in your Implementation URI.

      proxy deploy raml oas proxy 85634
  4. Click Advanced Options.

  5. 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 version for OAS or RAML specs, since 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.

  6. Select your Scheme and Port number for your API proxy.
    Optionally, you can set up an API Instance label and a Response Timeout.

    proxy deploy raml oas proxy af2f8
  7. Click Save.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub