API Specification for MuleSoft Connectivity Ecosystem

If you are an independent software vendor (ISV), you can participate in the MuleSoft Connectivity Ecosystem by auto-generating a connector from a REST API specification. These steps explain how to prepare your API specification in Anypoint Platform and how to work with your MuleSoft BD counterpart to do the rest.

  1. In Anypoint Platform, follow these steps to prepare your API specification:

    1. Sign up for Anypoint Platform:

    2. Log into Anypoint Platform and click Design Center.

    3. Create a new API specification project by clicking +Create in the top-right corner and then clicking Create API Specification.

    4. In the New Specification window, specify the name of the project, select Text editor, and select the language of the specification. Then, click Create Specification.

    5. Delete the file that is automatically generated by hovering over its name, clicking the three dots to its right, and selecting Delete.

    6. On the left side of the screen, click the action menu (the three-dot icon) at the top of the file list and select Import. You can import a RAML or .oas file, a .zip file, or a specification that is at a URL.

    7. After importing, test your API to make sure it works as you expect it to.

      1. In the top-right corner of the screen, switch on the mocking service.

      2. In the file list, select your API specification.

      3. In the API summary on the right side of the screen, expand the Resources entry until you see the methods for your resources.

      4. Click one of the methods.

      5. Review the information about the method.

      6. Click Try It.

      7. If the endpoint requires parameters, specify values for them.

      8. Click Send.

    The results of the test of the method appear on the right side of the screen under the Send button.

  2. After your API specification is ready, save it in a git-compatible repository, such as GitHub or Bitbucket.

  3. Contact your MuleSoft BD counterpart and follow these steps:

    1. Sign the Technology Partner Agreement (provided by your MuleSoft BD counterpart)

    2. Ask for an extension to the expiration date of your trial of Anypoint Platform.

    3. Ask for an invitation to the Connectivity Assets Manager tool, a self-service certification tool for connectivity assets, and create a new Anypoint Platform account based on the invitation.

    4. Schedule a short demonstration to help MuleSoft understand your APIs and how they work in Anypoint Platform.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!