salesforce Dreamforce On-Demand
Contact Us 1-800-596-4880
  1. Homepage
  2. API Manager (2.x)
  3. Configure API Proxies

  4. Build RAML or OAS API Proxies

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 steps:

  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.

  5. 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 Shared Spaces and Private Spaces.

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

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

  6. 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 Asset Versions.

      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 Governing API Instances.

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

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

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

  7. Click Next.

  8. Configure the downstream configuration settings:

    Expand for configuration settings.
    Field Name Description Required Notes

    Protocol

    Specifies whether to use HTTP or HTTPS for the validations.

    Yes

    If you select HTTPS, specify a TLS context for inbound traffic.

    Inbound TLS

    Specifies the TLS context to secure inbound traffic.

    No

    Only available on Mule 4+. If you can’t see a context, ensure that you have the correct permissions. To enable HTTPS in Mule 3 environment, see enable HTTPS in Mule 3x.

    Port

    Specifies the number to use if the displayed port is incorrect.

    Yes

    Base path

    Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash /.

    Yes

    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.

    Request timeout

    Specifies the duration after which a request times out.

    No

    Proxy Version

    Specifies the version of the proxy to use for the endpoint.

    No

    Service Name

    Name of your WSDL service.

    Yes

    Only avaliable for WSDL APIs.

    Service Port

    Port for your WSDL your service.

    Yes

    Only avaliable for WSDL APIs.

    Service Namespace

    Namespace of your WSDL service.

    Yes

    Only avaliable for WSDL APIs.

    Enable Console

    Specifies whether you can expose and test your API specification.

    No

    You can specify a different path in Console Path, for example, /spec/*. Only available if you have an attached API definition. Only available on Mule 3+.

    Validations

    Specifies whether to validate inbound requests against a provided specification.

    No

    Only available if you have an attached API definition. Only available on Mule 3+.

    Strict validations (optional)

    Specifies whether to validate inbound requests against query parameters.

    No

    Only available if you have an attached API definition. Only available on Mule 3+

    User Domain

    Specifies whether to use an API gateway domain.

    No

    If you chose Hybrid as the proxy deployment target previously in the configuration, ensure that you select this option. You must install the API gateway domain in Mule 3.8 and later.

  9. Click Next.

  10. Configure the upstream configuration settings:

    Expand for configuration settings.
    Field Name Description Required Notes

    Upstream URL

    The URL to access for the proxy or the API.

    Yes

    For example, you can use the URL of your API asset in Exchange.

    Outbound TLS

    Specifies the TLS context to secure outbound traffic.

    No

    Only available on Mule 4+. If you can’t see a context, ensure that you have the correct permissions.

  11. Click Next.

  12. Review your selections and edit them if necessary.

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

See Also