Contact Us 1-800-596-4880

Designing API Specs and Fragments

logo cloud IDE Cloud IDE

logo desktop IDE Desktop IDE

Open Beta Release: The cloud IDE is in open beta. Any use of Anypoint Code Builder in its beta state is subject to the applicable beta services terms and conditions, available from the IDE.

Use Anypoint Code Builder to create, design, test, and publish new API specifications to Exchange.

The process for designing API specifications is:

For source management options, see SCM for API Design Projects.

Supported OAS and RAML Versions for API Specs

Supported OAS and RAML versions are:

  • OAS 2.0 (JSON)

  • OAS 2.0 (YAML)

  • OAS 3.0 (JSON)

  • OAS 3.0 (YAML)

  • RAML 1.0

  • RAML 0.8

Supported Specification Languages for API Fragments

Create, include, or reference API fragments within your API specification.

Supported API specification languages and syntaxes for API fragments are:

  • OAS 3.0

    • YAML

    • JSON

  • RAML 1.0

    See the RAML 1.0 specification for descriptions of these types:

    • Trait

    • Resource

    • Library

    • Data Type

    • User Documentation

    • Example

  • JSON Schema

Source Control for API Design Projects

Use source control management (SCM) to store and share your design, integration, and implementation projects. Source control options for API design projects depend on how and when you created the project:

  • As of the February 2024 release, design projects that you create from scratch in Anypoint Code Builder with Design an API (see Create a New API Specification Project) or with the command MuleSoft: Design an API no longer spawn a corresponding design project in Design Center or use the Anypoint SCM to store and sync changes.

  • API design projects imported to Anypoint Code Builder from Design Center or created in Anypoint Code Builder before the February 2024 release automatically connect to the Anypoint SCM, which enables you to sync with a corresponding design project in Design Center.

    If you prefer to use your own remote repository, GitHub is one option. To store your API project in a repository on GitHub, without synchronizing with the project in Design Center, see publish you project files to another repository.

For source control options, see Controlling Source Files.