Sync Your API Projects with API Sync

With API Sync, you can:

Start designing a RAML, OAS 2.0, or OAS 3.0 API spec in Studio and sync it with API Sync.
Pull a published RAML, OAS 2.0, or OAS 3.0 API spec from Exchange or from a private Maven repository, into your Mule application project in Studio to scaffold a new project.
Edit the API spec you imported from Exchange, and push your changes to MuleSoft VCS.
Scaffold multiple flows in different Mule configuration files by using API Sync on more than one API spec.
Monitor the API versions that you implement in your project and update your flows based on the latest published version.
Pull a RAML, OAS 2.0, or OAS 3.0 API spec from MuleSoft VCS into Studio, edit the spec offline, and push the updates back to MuleSoft VCS.
Develop your Mule applications using API lifecycle development practices.

API Sync supports importing both RAML, OAS 2.0, and OAS 3.0 spec.

API Sync is bundled by default with Studio and requires Mule 4.1.4 or later.

API Sync doesn’t work properly if the RAML file exceeds 4,000 lines of text.

Create an API Spec in Studio

Start a new API spec project in Studio. See Create an API Specification Project in Studio for more information.

Import an API spec from Exchange into a new Mule project or from MuleSoft VCS into an editable API spec project.

See Update the API Specification in Your Project for more information about keeping your Studio projects up to date with the latest version of an API spec.

Edit the imported API spec in your project as an API spec project.