Creating an API Instance by Uploading an API Definition

You can create a new API instance by uploading an API definition from your computer.
Your newly uploaded API definition would then be available in Exchange.

  1. Log in to your Anypoint platform, and click API Manager.

  2. In the API Administration tab, select Manage API and Create New API.

    create new api task 76f47

  3. Use the Name field to enter the name for your API definition asset.

  4. Use the Asset Types drop-down menu to select the type of API definition.

    • REST-API OAS

    • SOAP-API WSDL

    • HTTP API

      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.

  5. In the File Upload field, click Choose file and select an API definition file from your drive to upload.

    • If you want to upload a REST API - OAS asset type, you should upload a .json or .yaml file.

    • If you want to upload a SOAP API - WSDL asset type, you should upload a .wsdl or .xml file.

      You can upload your API definition compressed in a ZIP file. When uploading a ZIP file, make sure it contains at least one main file in the root directory, and select the main file using the Main File field.

      Additionally, you can click the Advanced click, to edit the GroupId, AssetId and Version of the asset you are uploading.

  6. Click Continue.
    This uploads your API definition to Exchange and takes you to the Endpoint configuration screen.
    Learn how to configure the endpoint for your API instance following the instructions in the Configuring an API instance Endpoint on API Manager section.

  7. After configuring your endpoint, click Save.

See Also

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub