---
schema_version: "1"
id: 431ac603828274a81b33f85fa4ee6f1b471edd441a14b213b57a97e5431b428a
title: Adding Dependencies to an API-Specification Project
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/design-center/design-add-api-dependency.md
canonical_url: https://docs.mulesoft.com/design-center/design-add-api-dependency
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 58afb61acc0c4bb0dfdc4807eb5a72f993ba20591c07c4ba807a1a15464bed10
description: MuleSoft Documentation Site
latest: true
---
---
product: Design Center
---

# Adding Dependencies to an API-Specification Project

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

In projects for API specifications or API fragments, you can add dependencies of either RAML
fragments, OAS components, JSON schemas, or rulesets. Because the dependencies are referenced in
Anypoint Exchange, you cannot directly edit them in your projects.

If you export your project or someone downloads your project as RAML from Exchange, the resulting
ZIP file contains the referenced dependencies.

> [!CAUTION] You must not edit the referenced dependencies in an editor other than the API Designer
> editor. If you export your project to work on it in another editor, edit the referenced
> dependencies, and then try to import the project back into the text editor, the import fails.  
> Studio does not support OAS 3.0 fragments.

## Add Dependencies to an API-Specification Project

> [!NOTE] You can add up to **100 dependencies** (Fragments and Rulesets) per project.

To add dependencies to an API-specification project:

1.  In the text editor navigation menu, click the **Exchange dependencies** icon
    (![manage dependency versions design center d96c7](/mulesoft/current/en-us/design-center/_images/manage-dependency-versions-design-center-d96c7.png "Exchange Dependencies icon")).

2.  Click the add icon (+) for the dependency type that you want to add.

3.  To filter the list of dependencies you can:

    - Select an organization

    - Search by keyword

    - Select **Include versions in Development**

4.  Select the dependency versions you want to add:

    - To use a version of a dependency other than latest, select the version for that dependency in
      the **Version** drop-down.

    - To view only the dependencies you’ve selected, click **Show selected only**.

    - You can see the format of the fragment (RAML, OAS, or JSON schema) next to each fragment’s
      name.

5.  Click **Add dependency**.

> [!NOTE] API Designer supports a maximum of 1,000 files for dependencies, with a total file size no
> greater than 300 MB.

## View Dependency Contents

To view the contents of a dependency, click the more options menu icon
(![overflow menu icon](/mulesoft/current/en-us/design-center/_images/overflow-menu-icon.png "Three vertical dots")) for that dependency
and then select **Show in Files** or **Open in Exchange**.

> [!NOTE] If you select **Show in Files**, the **Files** section expands and the dependencies are
> shown in the `exchange_modules` section. The subsections correspond to the URI for the referenced
> dependency, which is its asset identifier, or GAV (group ID, asset ID, and version), in Exchange.

When you are ready to continue work on your API project, click **Files** > API project file name.

## Ruleset Dependencies

If your API has been identified as governed through centralized API governance, a dot or warning
icon appears on the **Exchange dependencies** icon to indicate you need to take action on the
dependencies for this project. Click the **Exchange dependencies** icon to view and follow the
interactive instructions to add rulesets as dependencies to your project.

Even if your projects have not been identified as requiring action, you can proactively check the
conformance of your APIs by adding published rulesets as dependencies to your API project.

If your API fails to conform to the rulesets that your organization validates against, you get an
email notification. You can click **Code in Design Center** to open API Designer, or click **API
Details in Exchange** to be redirected to the API asset Conformance Status page.

1.  If the asset version has an editable branch in API Designer, a pop-up appears where you can see
    the missing rulesets filtered by tags, category, and lifecycle state. To edit those filters,
    click **Edit criteria**. When you are done, click **Add all rulesets**.  
    _Result_: The rulesets are added to your project.

2.  If the asset version doesn’t have an editable branch in API designer, you can either select an
    editable branch of your project or create a new branch from your current version. You can then
    add the missing rulesets to that editable branch. When you have your branch, a pop-up appears
    where you can see the missing ruleset filtered by tags, category, and lifecycle state. To edit
    those filters, click **Edit criteria**. When you are done, click **Add all rulesets**.  
    _Result_: The rulesets are added to your project.

## Improving Ruleset Validation

When you add rulesets as dependencies, the rulesets are automatically validated by default. The
complexity of the API and rulesets might increase the number of diagnostics being computed and
trigger multiple automatic validations.

The validation takes more time if:

- Your API is modularized, has complex recursive types, or has circular references.

- You add multiple ruleset dependencies to an API project.

- You are consuming a significant amount of browser resources.

To improve ruleset validation times:

- Close unnecessary browser tabs or applications.

- Ensure your device is running efficiently and has enough memory and CPU resources.

- Switch to manual validation. This runs a single validation for each ruleset rather than triggering
  multiple automatic validations that might exhaust your available resources.

If the validation process takes too long, a warning message appears informing you that
auto-validation is disabled for that project.

- To change to manual mode, click **Ok**.

- To continue using auto-validation, click **Cancel**. Note that if the auto-validation of rulesets
  still takes too long, you get the warning message again.

You can switch between auto-validation and manual validation in your API project. This changes the
validation setting for that specification only.

To turn on manual validation of your rulesets:

1.  In the **Project Errors** section of the text editor, select the **Governance** tab.

2.  Click the **Governance auto-validation** icon
    (![green governance auto validation](/mulesoft/current/en-us/design-center/_images/green-governance-auto-validation.png "Governance auto-validation"))
    to disable auto-validation.

3.  Click the **Validate for governance** icon
    (![validate for governance](/mulesoft/current/en-us/design-center/_images/validate-for-governance.png "Validate for governance")) to
    enable manual validation.

    This runs a single validation for each ruleset rather than triggering multiple automatic
    validations that might exhaust your available resources.

To enable auto-validation again:

1.  In the **Project Errors** section of the text editor, select the **Governance** tab.

2.  Click the auto-validation icon
    (![red governance auto validation](/mulesoft/current/en-us/design-center/_images/red-governance-auto-validation.png "Governance auto-validation"))
    to enable auto-validation again.

> [!NOTE] If the auto-validation still takes too long, you get the warning message again.

## Fix Governance Conformance Issues

After you add the rulesets as dependencies, you can view the conformance messages in the **Project
Errors** section of the text editor. Use the provided information to fix any conformance issues and
then republish your API specification.

## See Also

- [Finding API Conformance Issues in API Specifications](https://docs.mulesoft.com/api-governance/find-conformance-issues)

- [Create an Asset](https://docs.mulesoft.com/exchange/to-create-an-asset)
