Skip to content
Merged
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
16 changes: 1 addition & 15 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,6 @@
// TUTORIALS
* xref:tutorials.adoc[]

** xref:tut-af-amflights-overview.adoc[]
*** xref:tut-af-design-am-flights-api.adoc[]
**** xref:tut-af-design-api-add-request-response-details.adoc[]
**** xref:tut-af-design-api-test-specification.adoc[]
**** xref:tut-af-design-api-publish-api-spec-to-exchange.adoc[]

*** xref:tut-af-integrate-am-flights.adoc[]
**** xref:tut-af-integrate-connect-to-a-db.adoc[]
**** xref:tut-af-integrate-use-dataweave.adoc[]

*** xref:tut-af-implement-am-flights-api.adoc[]
*** xref:tut-af-debug-am-flights.adoc[]
*** xref:tut-af-deploy-am-flights.adoc[]

** xref:tut-local-api-specification.adoc[]

** xref:tut-graphql-implement-api.adoc[]
Expand Down Expand Up @@ -85,8 +71,8 @@
** xref:int-configure-components.adoc[]
*** xref:int-configure-components-add.adoc[]
*** xref:int-configure-dw-expressions.adoc[]
*** xref:int-configure-components-check-connection.adoc[]
*** xref:int-configure-components-import-connector-exchange.adoc[]
*** xref:int-configure-components-check-connection.adoc[]
*** xref:int-configure-components-open-from-xml.adoc[]
** xref:int-create-secure-configs.adoc[]
** xref:int-trigger-flows.adoc[]
Expand Down
7 changes: 4 additions & 3 deletions modules/ROOT/pages/des-create-api-fragments.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Creating and Using API Spec Fragments
:page-deployment-options: cloud-ide, desktop-ide
:page-aliases: des-add-examples-to-specs.adoc
:page-aliases: des-add-examples-to-specs.adoc, add-request-response-details.adoc, tut-af-design-api-add-request-response-details.adoc

include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]

Expand Down Expand Up @@ -41,7 +41,7 @@ Before adding fragments:
* xref:start-acb.adoc[Set up and access the web or desktop IDE].
* Understand the basics of designing API specifications.
+
See the xref:tutorials.adoc[] for details.
To see where adding fragments fits in the journey from API design through deployment, see xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment in Mule].
* Have some familiarity with xref:access-management::business-groups.adoc[business groups].
+
When you publish your API fragment to Exchange from Anypoint Code Builder, the IDE requests the name of the business group. See xref:access-management::business-groups.adoc[].
Expand Down Expand Up @@ -504,5 +504,6 @@ channels:
== See Also

* xref:des-publish-api-spec-to-exchange.adoc[]
* xref:tut-af-design-api-add-request-response-details.adoc[] Tutorial
* xref:des-create-api-specs.adoc#test-spec[Test Your API Spec Using the Mocking Service]
* xref:des-create-api-fragments.adoc#add-fragment-to-project[Add the API fragment from Exchange]
* xref:des-delete-api-projects.adoc[]
74 changes: 68 additions & 6 deletions modules/ROOT/pages/des-create-api-specs.adoc
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
= Creating and Importing API Specifications
:page-deployment-options: cloud-ide, desktop-ide
:page-aliases: des-test-api-specs.adoc
:page-aliases: des-test-api-specs.adoc, ui-tut-design.adoc, tut-af-design-api-specification-from-scratch.adoc, design-api-specification.adoc, test-api-specification.adoc, tut-af-design-am-flights-api.adoc, tut-af-design-api-test-specification.adoc

include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]

Use Anypoint Code Builder to create, import, and test API specs before publishing to Anypoint Exchange. You can start a new spec from the IDE or import an existing spec from MuleSoft Version Control System (VCS).

. Create a API spec project in Anypoint Code Builder from the IDE or by importing the spec from MuleSoft VCS:

* <<design-new-api-spec, Create an API spec project from the IDE>>
* <<design-new-api-spec, Create an API spec project from the IDE>> (example uses OAS 3.0 (YAML))
* <<create-raml-rest-api-spec, Create an API spec project using RAML 1.0>>
* <<import-spec, Import an API spec from MuleSoft VCS>>

. <<open-output-panel, Track progress in the output panel>>.
. <<review-spec-console, Review your spec in the API console>>.
. <<test-spec, Test your spec using the mocking service>>.

Use the <<example-oas-api-spec,`oas-example`>> API spec to explore the functionality of Anypoint Code Builder.
Use the <<example-oas-api-spec,`oas-example`>> API spec to explore the functionality of Anypoint Code Builder with OAS, or see <<create-raml-rest-api-spec, Create a REST API Specification Using RAML 1.0>> for a RAML-first project.


== Before You Begin

* xref:start-acb.adoc[Set up and access the web or desktop IDE].
* Understand the basics of designing API specs.
+
See the xref:tutorials.adoc[] for details.
See xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment] for a suggested order of topics.
* Have some familiarity with xref:access-management::business-groups.adoc[business groups].
+
When you publish your API spec to Exchange from Anypoint Code Builder, the IDE requests the name of the business group. See xref:access-management::business-groups.adoc[].
Expand Down Expand Up @@ -79,6 +80,67 @@ image::des-oas-create.png[New OAS 3.0 (YAML) API project]
+
As you enter elements, use xref:start-discover-ui.adoc#auto-complete[auto-complete] (or press Ctrl+Space) to display available options within the context.

[[create-raml-rest-api-spec]]
== Create a REST API Specification Using RAML 1.0

To create a REST API specification project that uses RAML 1.0:

// Open the ACB IDE
include::partial$acb-reusable-steps.adoc[tags="open-ide"]
+
image::anypoint-code-builder-view.png["Anypoint Code Builder icon highlighted in the activity bar"]
. From *Create*, click *Design an API*:
+
image::design-api-1.png["*Design an API* link highlighted in the *Create* section"]

. Complete the *API Specification* form:
+
[%header,cols="20a,60a"]
|===
| Field Name | Field Value

| *Project Name* | Unique name for your project.

This name is used as the API spec title in Exchange, as the name of the spec file, and as the name of the project's root directory.

include::partial$acb-reusable-steps.adoc[tags=no-project-name-reuse]
| *Project Location* | Your home directory or another directory you create.

See xref:start-add-folders.adoc[].

include::partial$acb-reusable-steps.adoc[tags=proj-directory-warn]
| *API Type* | *REST API*

| *API Specification Language* | *RAML 1.0* +
Anypoint Code Builder also supports *RAML 0.8* and OAS formats. For the full list, see xref:des-designing-api-specs.adoc#supported-spec-languages[Supported OAS and RAML Versions].
|===
. Click *Create Project*.
+
If prompted, trust the authors of the files in the folder.
+
When the project is ready for editing, the API project opens your root RAML file in the Editor view. The file name matches the project name you provided (for example, `my-inventory-api.raml`).
. Continue designing your RAML spec in the Editor view.
+
Use xref:start-discover-ui.adoc#auto-complete[auto-complete] (Ctrl+Space or Cmd+Space) to add resources, methods, traits, and other RAML constructs in context.
+
To add reusable data types and examples from Anypoint Exchange, add fragment dependencies to the project and reference them with `!include` directives in RAML. For step-by-step procedures, see xref:des-create-api-fragments.adoc[].
+
When you want to try requests against your examples, <<review-spec-console, open the API Console>> and <<test-spec, use the mocking service>> the same way you do for OAS projects.

.Optional starter RAML for a `/items` resource
[%collapsible]
====
[source,raml,linenums]
----
#%RAML 1.0
title: Example Items API

/items:
get:
description: List items
----
====

[[import-spec]]
== Import an API Specification from MuleSoft VCS

Expand Down Expand Up @@ -285,9 +347,9 @@ If you created an OAS 3.0 (YAML) project, you can replace the initial spec with


* xref:start-acb.adoc[]
* xref:tutorials.adoc[]
* xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment]
* xref:access-management::business-groups.adoc[]
* xref:start-discover-ui.adoc#use-autocomplete[Use Auto-Complete in the Editors]
* xref:tut-af-design-am-flights-api.adoc[] Tutorial
* xref:des-create-api-fragments.adoc[]
* xref:des-delete-api-projects.adoc[]
* xref:start-workspaces.adoc[]
1 change: 1 addition & 0 deletions modules/ROOT/pages/des-publish-api-spec-to-exchange.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Publishing API Projects to Exchange
:page-deployment-options: cloud-ide, desktop-ide
:page-aliases: publish-api-spec-to-exchange.adoc, tut-af-design-api-publish-api-spec-to-exchange.adoc

include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]

Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/imp-implement-api-specs.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Implementing OAS, RAML, AsyncAPI, and GraphQL APIs
:page-deployment-options: cloud-ide, desktop-ide
:page-aliases: ui-tut-implement.adoc, implement-api-specification.adoc, implement-an-api-specification.adoc, tut-af-implement-am-flights-api.adoc

include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/imp-implementing-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The methods for implementing APIs using Anypoint Code Builder are:
// TODO: Include a link to gRPC Connector docs.
* xref:imp-implement-local-apis.adoc[Scaffold an API] into an implementation project without first publishing it to Anypoint Exchange, enabling iterative design and implementation.

After scaffolding an API specification into an interface, you are ready to develop, test, and deploy your Mule app as described in xref:int-developing-integrations.adoc[]. To understand how an integration project can implement an API specification, see the tutorial xref:tut-af-implement-am-flights-api.adoc[].
After scaffolding an API specification into an interface, you are ready to develop, test, and deploy your Mule app as described in xref:int-developing-integrations.adoc[]. For the ordered topics from API design through deployment, see xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment].
Comment thread
Cristian-Venticinque marked this conversation as resolved.

== Source Control for Implementation Projects

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/int-configure-components.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Configuring Components
:page-deployment-options: cloud-ide, desktop-ide
:page-aliases: int-work-with-code-snippets.adoc, work-with-code-snippets.adoc, create-xml-snippets.adoc
:page-aliases: int-work-with-code-snippets.adoc, work-with-code-snippets.adoc, create-xml-snippets.adoc, connect-to-a-db.adoc, tut-af-integrate-connect-to-a-db.adoc
:open-config-xml: In the Explorer, open the configuration XML file for your project:

include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
Expand Down
10 changes: 8 additions & 2 deletions modules/ROOT/pages/int-configure-dw-expressions.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
= Using DataWeave Expressions and Transformations in Anypoint Code Builder
:page-aliases: int-use-dw-to-transform-data.adoc, int-address-dw-errors.adoc, int-import-dw-libraries.adoc
:page-aliases: int-use-dw-to-transform-data.adoc, int-address-dw-errors.adoc, int-import-dw-libraries.adoc, use-dataweave.adoc, tut-af-integrate-use-dataweave.adoc

DataWeave is the MuleSoft programming language for data transformation and for defining expressions. Use DataWeave to process Mule event data, such as `payload`, `attributes`, and `vars`, in connector operations and other components. Develop DataWeave expressions and transformations in your Mule applications using the *Expression Field*, *Expression Builder*, or *Transformation Builder*, or by editing the configuration XML. Generate DataWeave transformations with AI help by providing input and output sample data, metadata, or both. AI-powered auto mapping provides comprehensive error feedback for GenAI actions, including authorization, metadata, and request limits, ensuring a more reliable and guided mapping experience.


DataWeave is the MuleSoft programming language for data transformation and for defining expressions.

Use DataWeave to process Mule event data, such as `payload`, `attributes`, and `vars`, in connector operations and other components. Develop DataWeave expressions and transformations in your Mule applications using the *Expression Field*, *Expression Builder*, or *Transformation Builder*, or by editing the configuration XML. Generate DataWeave transformations with AI help by providing input and output sample data, metadata, or both. AI-powered auto mapping provides comprehensive error feedback for GenAI actions, including authorization, metadata, and request limits, ensuring a more reliable and guided mapping experience.

image::int-dw-transform-ui.png["A configuration panel showing three numbered callouts: 1) fx button for Expression Field, 2) Expression Builder button, and 3) Transformation Builder button"]

Expand Down Expand Up @@ -589,4 +593,6 @@ When complete, Anypoint Code Builder shows a message that the dependency was suc
* xref:int-debug-mule-apps.adoc[]
* xref:troubleshoot-dataweave.adoc[]
* xref:int-create-integrations.adoc#add-components[Add a Component to Your Project]
* xref:imp-implement-api-specs.adoc[]
* xref:des-publish-api-spec-to-exchange.adoc#locate-api[Locate Your API in Exchange]
* xref:acb-reference.adoc[]
2 changes: 1 addition & 1 deletion modules/ROOT/pages/int-create-integrations.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Creating Integrations
:page-deployment-options: cloud-ide, desktop-ide
:page-aliases: int-create-basic-integrations.adoc
:page-aliases: int-create-basic-integrations.adoc, ui-tut-integrate.adoc, create-basic-integration.adoc, develop-integration.adoc, tut-af-integrate-am-flights.adoc


include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/pages/int-debug-mule-apps.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Debugging Mule Applications
:page-deployment-options: cloud-ide, desktop-ide
:page-aliases: debug-add-breakpoint.adoc, debug-add-components.adoc, debug-run-debug-sessions.adoc, debug-a-mule-application.adoc, debugging-mule-apps.adoc
:page-aliases: debug-add-breakpoint.adoc, debug-add-components.adoc, debug-add-logger-set-variables.adoc, debug-run-debug-sessions.adoc, debug-a-mule-application.adoc, debugging-mule-apps.adoc, tut-af-debug-am-flights.adoc


include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
Expand Down Expand Up @@ -56,7 +56,6 @@ Keyboard shortcut: Cmd+Shift+d (Mac) or Ctrl+Shift+d (Windows)

Open the *Debug Console* tab in the panel area to <<evaluate-dw-debug-console,evaluate DataWeave>> while execution is paused. See <<evaluate-dw-while-debugging>>.


[[add-breakpoint]]
== Add a Breakpoint

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/int-deploy-mule-apps.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Deploying Mule Apps to CloudHub and CloudHub 2.0
:page-deployment-options: cloud-ide, desktop-ide
:page-aliases: deploy-a-mule-application-to-cloudhub.adoc
:page-aliases: deploy-a-mule-application-to-cloudhub.adoc, tut-af-deploy-am-flights.adoc

include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/int-trigger-flows.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A *Scheduler*, a *Flow Ref*, or any connector trigger or message source can init
* Complete xref:start-acb.adoc[] for your IDE.
* Make sure an integration or implementation project with an HTTP Listener (`<http:listener/>`) is available from the cloud or desktop IDE.
+
To create a project, see xref:int-create-integrations.adoc[] or xref:imp-implementing-apis.adoc[], or follow the procedures in the tutorial xref:tut-af-amflights-overview.adoc[].
To create a project, see xref:int-create-integrations.adoc[] or xref:imp-implementing-apis.adoc[], or follow xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment].

[[trigger-urls]]
== URLs for Triggering a Flow from an HTTP Listener
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/start-workspaces.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ image::imp-local-api-open-workspace.png["A multi-root workspace in Explorer view

You can ask MuleSoft Vibes to switch workspaces using natural language prompts, such as:

* "Open my American Flights workspace"
* "Open my Orders API workspace"
* "Switch to the `<YourWorkspaceName>` workspace"

[[close-workspace]]
Expand Down
51 changes: 0 additions & 51 deletions modules/ROOT/pages/tut-af-amflights-overview.adoc

This file was deleted.

Loading