API Sync

The API Sync feature of Anypoint Studio enables you to pull a published RAML or OAS 2.0 API specification from Exchange or a private Maven repository, into your Mule application project in Studio to scaffold a new project. API Sync also enables you monitor the API versions that you implemented in your project and update your flows based on the latest published version.

You can use API Sync on more than one API specification to scaffold multiple flows in different Mule configuration files.

API Sync supports importing both RAML and OAS 2.0 specifications.

API Sync comes bundled by default in Studio 7.4.x and later, and requires Mule 4.1.4 and later.

API sync might now work properly if the RAML file exceeds 4,000 lines of text.

Working with API Sync

Using API Sync, you can develop your Mule applications following API Lifecycle development practices:

  1. Create an API specification in Design Center and publish it to Exchange.
    You can either create and publish an API specification by using the visual editor in Design Center or create and publish an API specification by using the Code Editor in Design Center.

  2. Import the same API specification from Exchange to your Studio project.
    See API development in Studio for more information.

It is not possible to create a new API version from Studio and then upload it to Exchange. Change your API specification in Design Center, publish a new version to Exchange, and then update your local Studio implementation using API Sync:

  1. Right click in the project that implements the API for which you want to check for updates.

  2. From the API Specs menu, select the API for which you want to check for updates, and click Update Version.
    If a new version is found, API Sync asks you if you want to regenerate the flows based on the new version.

You can manage the API specifications in your project that are linked to Exchange from the API Project management view by clicking the Manage Mule Project APIs icon (2%) in the top task bar.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub