Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
** xref:connected-app-authentication.adoc[]
* xref:about-documenting-an-api.adoc[]
** xref:generating-documentation-with-ai.adoc[]
** xref:to-use-api-notebook.adoc[]
** xref:to-configure-api-settings.adoc[]
* xref:about-portals.adoc[]
** xref:enable-and-disable-a-public-portal.adoc[]
Expand Down
4 changes: 1 addition & 3 deletions modules/ROOT/pages/about-api-use.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,11 @@ Anypoint Exchange provides significant features for API providers to easily publ
Exchange helps API consumers understand API functionality and test features with:

* API console to view API functions. This console appears to the right of a REST API detail screen.
* API Notebook to view API documentation and to test API features.
* Simulate data to an API using the mocking service.
* A mocking service to simulate data to an API.
* GraphQL console to view GraphQL schemas and run queries.

== See Also

* xref:asset-details.adoc#view-rest-api-elements-in-an-asset[View REST API Elements in an Asset]
* xref:asset-details.adoc#test-an-api-with-api-notebook[Test an API with API Notebook]
* xref:ex2-to-simulate-api-data.adoc[]
* xref:view-graphql-api-schemas-and-run-queries.adoc[]
16 changes: 5 additions & 11 deletions modules/ROOT/pages/about-documenting-an-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,13 @@ include::_attributes.adoc[]
endif::[]
:imagesdir: ../assets/images/

Anypoint Exchange lets you create API Notebooks which let you describe each function in your API and provide a test area so that users can experiment with sending different values to the API and receiving output.
Anypoint Exchange helps API providers document and manage APIs. After you publish a REST API in Exchange, use Einstein generative AI to create API documentation. For all other APIs, you can configure whether API instances to be public or private. You can also configure non-managed instances.

After creating your API Notebook you can optionally create an API instance to control whether the notebook is private or public. By setting the notebook's instance to private, others in your organization can review it. When you are ready, you can set the API instance to make the API Notebook public.

NOTE: API Notebooks are independent of the use of an API instance.
If you don't use a base URI in your RAML, or use an API instance, you can use the mocking service to generate test data.

Topics:

* xref:to-use-api-notebook.adoc[To Document an Asset Using API Notebook]
* xref:to-configure-api-settings.adoc[To Configure API Instances]
* xref:generating-documentation-with-ai.adoc[]
* xref:to-configure-api-settings.adoc[]

== See Also

* xref:to-describe-an-asset.adoc[To Describe an Asset]
* xref:generating-documentation-with-ai.adoc[]
* xref:to-describe-an-asset.adoc[]

11 changes: 0 additions & 11 deletions modules/ROOT/pages/asset-details.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,6 @@ include::partial$task-view-conformance-status.adoc[]

include::exchange::partial$task-view-governed-apis-for-rulesets.adoc[]


== Test an API with API Notebook

Many APIs have an API notebook for interactive testing.

. Click *API Notebook* in the content page.
. Read the description and usage information.
. Click *Play* to test the method in the code example.
. Exchange shows the results in real time.
. Experiment with the example in the code block to try different parameters and values.

== See Also

* xref:access-management::permissions-by-product.adoc#exchange[Permissions Available in Anypoint Platform for Exchange]
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Anypoint Exchange is a curated catalog of reusable assets. APIs, API groups, API

image:exchange-landing-page.png["Exchange catalog showing assets provided by MuleSoft"]

Use Exchange to discover, share, incorporate assets and resources into your applications, and view asset usage and engagement metrics. You can create API developer portals, view and test APIs, simulate sending data to APIs by using the mocking service, create assets, and use API Notebooks to describe and test API functions.
Use Exchange to discover, share, incorporate assets and resources into your applications, and view asset usage and engagement metrics. You can create API developer portals, view API documentation and test functions, simulate sending data to APIs by using the mocking service, and create assets.

Exchange assets are accessible from many places, such as Anypoint Studio (connectors, templates, and examples), API Manager (APIs, API groups, and policies), or Runtime Manager (applications). APIs can be published from Design Center to Exchange.
Exchange assets are accessible from many places, such as Anypoint Studio (connectors, templates, and examples), API Manager (APIs, API groups, and policies), or Runtime Manager (applications). APIs can be published from Anypoint Code Builder to Exchange.

Assets in the *Provided by MuleSoft* organization are created by MuleSoft and its partners and certified by MuleSoft. These assets are publicly available to all customers. However, assets that are created by an organization other than *Provided by MuleSoft* and published in that organization's instance of Exchange are private and not visible outside that organization. Customers are responsible for any private assets they publish within their Exchange instance.

Expand Down Expand Up @@ -44,7 +44,7 @@ You can get started either by searching for an existing asset or creating a new
. Select an asset from the search results view.
. Review the description of the asset.

To create assets for APIs, connectors, templates, examples, API Notebooks, and custom assets, log into Exchange. See xref:workflow-sharing-assets.adoc[Workflow: Publish APIs] for more information.
To create assets for APIs, connectors, templates, examples, and custom assets, log into Exchange. See xref:workflow-sharing-assets.adoc[Workflow: Publish APIs] for more information.

== Test APIs

Expand Down
103 changes: 0 additions & 103 deletions modules/ROOT/pages/to-use-api-notebook.adoc

This file was deleted.