API Sync

The API Sync feature of Anypoint Studio enables you to:

  • Start designing a RAML, or OAS 2.0 and 3.0 API specification in Studio and synchronize it with Design Center.

  • Pull a published RAML or OAS 2.0 and 3.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 to edit the API specification you imported from Exchange, and push your changes to Design Center.

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

  • Monitor the API versions that you implemented in your project and update your flows based on the latest published version.

  • Pull a RAML or OAS 2.0 and 3.0 API specification from Design Center into Studio, edit the specification offline, and pull the updates back to Design Center.

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

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

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

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

Create an API Specification in Studio

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

  2. Publish it to Exchange.

  3. Import the same API specification from Exchange to your Studio project.
    See Import an API Specification from Exchange for more information.

Import an API Specification from Exchange into a New Mule Project

  1. Create an API specification in Design Center.
    You can either Create an API Specification with the Text Editor in Design Center or Create an API Specification with the Visual API Editor in Design Center.

  2. Publish it to Exchange.
    See Publish an API Specification for more information.

  3. Import the same API specification from Exchange to your Studio project.
    See Import an API Specification from Exchange for more information.

See Update the API Specification in Your Project for instructions on keeping your Studio projects up to date with the latest version of an API specification.

Edit The Imported API Specification in Studio

You can also edit the imported API specification in your project as an API specification project.

  1. Import the API specification from Exchange to your Studio project.

  2. Synchronize it to Design Center,

  3. Publish it to Exchange

  4. Import the new version of your API spec.

Import an API Specification from Design Center into an Editable API Specification Project

  1. Create an API specification in Design Center.
    You can either Create an API Specification with the Text Editor in Design Center or Create an API Specification with the Visual API Editor in Design Center.

  2. Import the same API specification from Design Center to your Studio project.
    See Synchronize API Specifications with Design Center to learn how to do this.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub