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.
-
In Anypoint Platform, follow these steps to prepare your API specification:
-
Sign up for Anypoint Platform:
-
Log into Anypoint Platform and click Design Center.
-
Create a new API specification project by clicking Create new in the top-right corner and then clicking New API Specification.
-
In the New API Specification window, specify the name of the project, select I’m comfortable designing it on my own, and select the language of the specification. Then, click Create API.
-
Delete the file that is automatically generated by hovering over its name, clicking the three dots to its right, and selecting Delete.
-
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. -
After importing, test your API to make sure it works as you expect it to.
-
In the top-right corner of the screen, switch on the mocking service.
-
In the file list, select your API specification.
-
In the API summary on the right side of the screen, expand the Resources entry until you see the methods for your resources.
-
Click one of the methods.
-
Review the information about the method.
-
Click Try It.
-
If the endpoint requires parameters, specify values for them.
-
Click Send.
-
The results of the test of the method appear on the right side of the screen under the Send button.
-
-
After your API specification is ready, save it in a git-compatible repository, such as GitHub or Bitbucket.
-
Contact your MuleSoft BD counterpart and follow these steps:
-
Sign the Technology Partner Agreement (provided by your MuleSoft BD counterpart)
-
Ask for an extension to the expiration date of your trial of Anypoint Platform.
-
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.
-
Schedule a short demonstration to help MuleSoft understand your APIs and how they work in Anypoint Platform.
-