Contact Us 1-800-596-4880
  1. Homepage
  2. Exchange

  3. Asset Details

Asset Details

The asset details page provides comprehensive information about an asset. You can view version agnostic information, share the asset with others or publish it on the public portal, download a copy of the asset, view code, manage versions and lifecycle states, add categories and tags, edit the documentation, and test API endpoints.

See Workflow: Publish Assets for more information about performing these functions.

Select an asset in Exchange to view the asset details page:

Asset details

The left navigation bar lists:

  • Additional pages

  • Saved search terms

  • Application names

  • Instances

  • The HTTP functions in the REST specification (for a REST API)

  • Conformance Status

  • Terms and conditions and APIs using this policy (for a policy)

The top asset detail pane provides the following information:

  • Asset name

  • Description

  • Asset type

  • Organization

  • Contact name

  • Contact email

  • Asset creation date

  • Last updated date

  • Version

  • Categories and tags of the asset

  • Lifecycle state

  • Conformance state

  • Share by inviting users to have access

  • For APIs, download specifications and view code

  • Add a new version

For REST APIs, use the API console to create example calls and mock data to test the API. For more information, see Simulate Data in REST APIs

For GraphQL APIs, use the GraphQL console to view GraphQL schemas and write and run queries. For more information, see View GraphQL API Schemas and Run Queries

From the asset details pane, you can collapse and expand metadata such as version, last published, and categories and tags. See version information by clicking View versions. Administrators can use Manage versions to add a new version of the asset, view version details, and delete a version. See Manage Versions for more information.

The documentation page displays the asset documentation. The documentation can be edited by an administrator or the asset owner by clicking Edit documentation.

View REST API Elements in an Asset

View RAML, OAS, or AsyncAPI API specification information, including resources and the methods in each resource, in the left navigation bar.

  1. Click a method button:

    Screenshot - REST API function buttons in left nav bar

  2. Experiment with the API in the right side of a method view.

    This is similar to using a program such as Postman to specify custom HTTP headers and test each API’s method using the API’s endpoint.

  3. To connect the API to one of your applications and use the API to send and receive data, click Request access.

Search API Specification and Pages

The assets details page enables you to find specific information within the pages and API specification of an asset using the CTRL+F or the command+F keyboard shortcut. In Exchange, this enhanced shortcut overrides the native browser shortcut, which only searches for words and phrases on the current page. To quickly find the information you need, use this enhanced shortcut to search the content of every page and the API specification of an asset.

To search pages and the API specification using the enhanced find shortcut:

  1. In the asset details page, press CTRL+F or Command+F.

  2. In the Search content box, enter a search term or phrase.

  3. Click a search result from the list.

  4. Use the arrows to move through all the occurrences of the search term within the search results.

  5. Click the X to close the Search content box.

The enhanced keyboard shortcut looks for terms or phrases in:

  • Pages

    • Home

    • Additional pages

  • Specification

    • Summary

    • Endpoints

    • Documentation

    • Types

    • Security

When you enter a search term or phrase in the search box, the search results box displays the sections within Pages and Specification that contain the search terms entered. Click the search result to open the page with the search term or phrase highlighted. The search result shows the number of search-term matches in each page. Use the arrows to move up or down in the list of search results and to the next page.

For example, enter the term ruleset in the Search content box. From Pages, there are three search results for ruleset in the Home page. Click Home to open the page. Use the arrows to find all of the highlighted instances of ruleset in the Home page.

Example asset details page using CTRL+F or the command+F keyboard shortcut

View Conformance Status

You can view governance conformance status in Exchange for versions of API specifications. The status is one of the following:

  • Conformant: The API specification is conformant to governance rulesets against which it has been validated.

  • Not Conformant: The API specification is not conformant to governance rulesets against which it has been validated.

  • Not Validated: The API specification is not validated against governance rulesets.

Conformance status can be viewed in Exchange as follows:

  • A conformance badge is displayed for a selected version of an API.

  • In the Manage Versions page, a Conformance column shows conformance status for each version of the API.

  • A Conformance Status page appears for all REST APIs and AsyncAPIs. If a selected version of an API has been validated against governance rulesets, the conformance status page gives conformance information and gives options to fix nonconformant versions. The Conformance Status page also shows the filter criteria that resulted in the API being validated against the listed rulesets.

To view conformance status:

  1. Select an API asset that is of a type supported by Anypoint API Governance.

  2. Review the conformance badge.

  3. To view conformance by version, click Manage Versions.

    Review the Conformance column, which shows the governance conformance status for each version.

  4. To view conformance details, select Conformance Status in the navigation bar. From the conformance status page, you can:

    • Select the version of the API that you want to view.

    • For validated APIs, view the lists of centralized governance rulesets and additional rulesets against which the APIs have been validated.

      • If there are more rulesets than are shown on the initial page, click the Show All link to show the full list.

      • Click the external link icon for a ruleset to view that ruleset’s page in Exchange.

    • For nonconformant APIs, click one of the following:

      • Fix in Design Center

        After your API specification opens in Design Center, add the listed rulesets as dependencies and view the conformance messages in the Project Errors section to fix and republish your API specification.
        If the asset is published directly on Exchange without an existing version in the Design Center, a read-only version of the project opens. To fix conformance issues, download the asset from Exchange, then import it to Design Center, and publish it to Exchange with the same ID and a new minor version.

      • See instructions for Anypoint CLI

        Follow the instructions on the page to copy, update, and run the Anypoint CLI commands to add the listed rulesets as dependencies and fix and republish your API specification.

View Governed APIs for a Ruleset

In a ruleset’s Governed APIs page, you can view the list of centrally-governed APIs to which the ruleset applies.

Developers can use the Governed APIs list as follows to help improve the quality of the rulesets and APIs that they develop:

  • When their APIs fail a ruleset, they can see which other APIs successfully conform to the ruleset so that they can fix their APIs.

  • When they search for available rulesets to use for their API, they can see which APIs are conformant to a specific ruleset to evaluate how helpful the ruleset is.

API consumers can use the Governed APIs list when they need to create an API service or application that is conformant to a certain set of standards or rules. They can:

  • Ensure there is a ruleset in Exchange that has the rules they need.

  • See which APIs pass the rules for a ruleset so that they can ensure their application is consuming only the conformant APIs.

Depending on the access you have to the APIs in Exchange, you might see only the APIs that are conformant to the ruleset. This ensures that vulnerabilities are not exposed to consumers who do not have proper access to the APIs. Organization administrators and contributors can see the conformant and non-conformant APIs for their organization.

To view the governed API list for a ruleset:

  1. Select a ruleset asset that is used in an API Governance profile.

  2. Select Governed APIs in the navigation bar to see whether each listed API version passes all the rules in the ruleset.

  3. Select from the filter menus to refine the list of APIs. Default settings are:

    • All APIs

    • Your root organization

    • Any Ruleset Status

  4. To view an API’s Conformance Status details, click the open external link icon (open external link icon).

Test an API with API Notebook

Many APIs have an API notebook for interactive testing.

  1. Click API Notebook in the content page.

  2. Read the description and usage information.

  3. Click Play to test the method in the code example.

  4. Exchange shows the results in real time.

  5. Experiment with the example in the code block to try different parameters and values.

See Also

Permissions Available in Anypoint Platform, Exchange.