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 supported, 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. 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. If you want to manage the API using Mule 4 or later (recommended), accept the default selection.

      The parameters that you specify differ based on the Mule version you select.

    3. Type in your Implementation URI.

  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.

  7. Click Save.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Give us your feedback!
We want to build the best documentation experience for you!
Help us improve with your feedback.
Take the survey!