Skip to content

Commit aa1fec2

Browse files
Merge pull request #624 from mulesoft/W-22163321-remove-tutorial-and-fix-gaps
W-22163321 remove tutorial and fix gaps
2 parents 0293c44 + a916ad9 commit aa1fec2

25 files changed

Lines changed: 111 additions & 2316 deletions

modules/ROOT/nav.adoc

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,6 @@
1717
// TUTORIALS
1818
* xref:tutorials.adoc[]
1919
20-
** xref:tut-af-amflights-overview.adoc[]
21-
*** xref:tut-af-design-am-flights-api.adoc[]
22-
**** xref:tut-af-design-api-add-request-response-details.adoc[]
23-
**** xref:tut-af-design-api-test-specification.adoc[]
24-
**** xref:tut-af-design-api-publish-api-spec-to-exchange.adoc[]
25-
26-
*** xref:tut-af-integrate-am-flights.adoc[]
27-
**** xref:tut-af-integrate-connect-to-a-db.adoc[]
28-
**** xref:tut-af-integrate-use-dataweave.adoc[]
29-
30-
*** xref:tut-af-implement-am-flights-api.adoc[]
31-
*** xref:tut-af-debug-am-flights.adoc[]
32-
*** xref:tut-af-deploy-am-flights.adoc[]
33-
3420
** xref:tut-local-api-specification.adoc[]
3521

3622
** xref:tut-graphql-implement-api.adoc[]
@@ -85,8 +71,8 @@
8571
** xref:int-configure-components.adoc[]
8672
*** xref:int-configure-components-add.adoc[]
8773
*** xref:int-configure-dw-expressions.adoc[]
88-
*** xref:int-configure-components-check-connection.adoc[]
8974
*** xref:int-configure-components-import-connector-exchange.adoc[]
75+
*** xref:int-configure-components-check-connection.adoc[]
9076
*** xref:int-configure-components-open-from-xml.adoc[]
9177
** xref:int-create-secure-configs.adoc[]
9278
** xref:int-trigger-flows.adoc[]

modules/ROOT/pages/des-create-api-fragments.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Creating and Using API Spec Fragments
22
:page-deployment-options: cloud-ide, desktop-ide
3-
:page-aliases: des-add-examples-to-specs.adoc
3+
:page-aliases: des-add-examples-to-specs.adoc, add-request-response-details.adoc, tut-af-design-api-add-request-response-details.adoc
44

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

@@ -41,7 +41,7 @@ Before adding fragments:
4141
* xref:start-acb.adoc[Set up and access the web or desktop IDE].
4242
* Understand the basics of designing API specifications.
4343
+
44-
See the xref:tutorials.adoc[] for details.
44+
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].
4545
* Have some familiarity with xref:access-management::business-groups.adoc[business groups].
4646
+
4747
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[].
@@ -504,5 +504,6 @@ channels:
504504
== See Also
505505

506506
* xref:des-publish-api-spec-to-exchange.adoc[]
507-
* xref:tut-af-design-api-add-request-response-details.adoc[] Tutorial
507+
* xref:des-create-api-specs.adoc#test-spec[Test Your API Spec Using the Mocking Service]
508+
* xref:des-create-api-fragments.adoc#add-fragment-to-project[Add the API fragment from Exchange]
508509
* xref:des-delete-api-projects.adoc[]

modules/ROOT/pages/des-create-api-specs.adoc

Lines changed: 68 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
= Creating and Importing API Specifications
22
:page-deployment-options: cloud-ide, desktop-ide
3-
:page-aliases: des-test-api-specs.adoc
3+
: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
44

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

77
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).
88

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

11-
* <<design-new-api-spec, Create an API spec project from the IDE>>
11+
* <<design-new-api-spec, Create an API spec project from the IDE>> (example uses OAS 3.0 (YAML))
12+
* <<create-raml-rest-api-spec, Create an API spec project using RAML 1.0>>
1213
* <<import-spec, Import an API spec from MuleSoft VCS>>
1314
1415
. <<open-output-panel, Track progress in the output panel>>.
1516
. <<review-spec-console, Review your spec in the API console>>.
1617
. <<test-spec, Test your spec using the mocking service>>.
1718

18-
Use the <<example-oas-api-spec,`oas-example`>> API spec to explore the functionality of Anypoint Code Builder.
19+
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.
1920

2021

2122
== Before You Begin
2223

2324
* xref:start-acb.adoc[Set up and access the web or desktop IDE].
2425
* Understand the basics of designing API specs.
2526
+
26-
See the xref:tutorials.adoc[] for details.
27+
See xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment] for a suggested order of topics.
2728
* Have some familiarity with xref:access-management::business-groups.adoc[business groups].
2829
+
2930
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[].
@@ -79,6 +80,67 @@ image::des-oas-create.png[New OAS 3.0 (YAML) API project]
7980
+
8081
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.
8182

83+
[[create-raml-rest-api-spec]]
84+
== Create a REST API Specification Using RAML 1.0
85+
86+
To create a REST API specification project that uses RAML 1.0:
87+
88+
// Open the ACB IDE
89+
include::partial$acb-reusable-steps.adoc[tags="open-ide"]
90+
+
91+
image::anypoint-code-builder-view.png["Anypoint Code Builder icon highlighted in the activity bar"]
92+
. From *Create*, click *Design an API*:
93+
+
94+
image::design-api-1.png["*Design an API* link highlighted in the *Create* section"]
95+
96+
. Complete the *API Specification* form:
97+
+
98+
[%header,cols="20a,60a"]
99+
|===
100+
| Field Name | Field Value
101+
102+
| *Project Name* | Unique name for your project.
103+
104+
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.
105+
106+
include::partial$acb-reusable-steps.adoc[tags=no-project-name-reuse]
107+
| *Project Location* | Your home directory or another directory you create.
108+
109+
See xref:start-add-folders.adoc[].
110+
111+
include::partial$acb-reusable-steps.adoc[tags=proj-directory-warn]
112+
| *API Type* | *REST API*
113+
114+
| *API Specification Language* | *RAML 1.0* +
115+
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].
116+
|===
117+
. Click *Create Project*.
118+
+
119+
If prompted, trust the authors of the files in the folder.
120+
+
121+
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`).
122+
. Continue designing your RAML spec in the Editor view.
123+
+
124+
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.
125+
+
126+
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[].
127+
+
128+
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.
129+
130+
.Optional starter RAML for a `/items` resource
131+
[%collapsible]
132+
====
133+
[source,raml,linenums]
134+
----
135+
#%RAML 1.0
136+
title: Example Items API
137+
138+
/items:
139+
get:
140+
description: List items
141+
----
142+
====
143+
82144
[[import-spec]]
83145
== Import an API Specification from MuleSoft VCS
84146

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

286348

287349
* xref:start-acb.adoc[]
288-
* xref:tutorials.adoc[]
350+
* xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment]
289351
* xref:access-management::business-groups.adoc[]
290352
* xref:start-discover-ui.adoc#use-autocomplete[Use Auto-Complete in the Editors]
291-
* xref:tut-af-design-am-flights-api.adoc[] Tutorial
353+
* xref:des-create-api-fragments.adoc[]
292354
* xref:des-delete-api-projects.adoc[]
293355
* xref:start-workspaces.adoc[]

modules/ROOT/pages/des-publish-api-spec-to-exchange.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Publishing API Projects to Exchange
22
:page-deployment-options: cloud-ide, desktop-ide
3+
:page-aliases: publish-api-spec-to-exchange.adoc, tut-af-design-api-publish-api-spec-to-exchange.adoc
34

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

modules/ROOT/pages/imp-implement-api-specs.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= Implementing OAS, RAML, AsyncAPI, and GraphQL APIs
22
:page-deployment-options: cloud-ide, desktop-ide
3+
:page-aliases: ui-tut-implement.adoc, implement-api-specification.adoc, implement-an-api-specification.adoc, tut-af-implement-am-flights-api.adoc
34

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

modules/ROOT/pages/imp-implementing-apis.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The methods for implementing APIs using Anypoint Code Builder are:
2020
// TODO: Include a link to gRPC Connector docs.
2121
* 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.
2222
23-
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[].
23+
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].
2424

2525
== Source Control for Implementation Projects
2626

modules/ROOT/pages/int-configure-components.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Configuring Components
22
:page-deployment-options: cloud-ide, desktop-ide
3-
:page-aliases: int-work-with-code-snippets.adoc, work-with-code-snippets.adoc, create-xml-snippets.adoc
3+
: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
44
:open-config-xml: In the Explorer, open the configuration XML file for your project:
55

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

modules/ROOT/pages/int-configure-dw-expressions.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
= Using DataWeave Expressions and Transformations in Anypoint Code Builder
2-
:page-aliases: int-use-dw-to-transform-data.adoc, int-address-dw-errors.adoc, int-import-dw-libraries.adoc
2+
: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
33

4-
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.
4+
5+
6+
DataWeave is the MuleSoft programming language for data transformation and for defining expressions.
7+
8+
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.
59

610
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"]
711

@@ -589,4 +593,6 @@ When complete, Anypoint Code Builder shows a message that the dependency was suc
589593
* xref:int-debug-mule-apps.adoc[]
590594
* xref:troubleshoot-dataweave.adoc[]
591595
* xref:int-create-integrations.adoc#add-components[Add a Component to Your Project]
596+
* xref:imp-implement-api-specs.adoc[]
597+
* xref:des-publish-api-spec-to-exchange.adoc#locate-api[Locate Your API in Exchange]
592598
* xref:acb-reference.adoc[]

modules/ROOT/pages/int-create-integrations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Creating Integrations
22
:page-deployment-options: cloud-ide, desktop-ide
3-
:page-aliases: int-create-basic-integrations.adoc
3+
:page-aliases: int-create-basic-integrations.adoc, ui-tut-integrate.adoc, create-basic-integration.adoc, develop-integration.adoc, tut-af-integrate-am-flights.adoc
44

55

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

modules/ROOT/pages/int-debug-mule-apps.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Debugging Mule Applications
22
:page-deployment-options: cloud-ide, desktop-ide
3-
:page-aliases: debug-add-breakpoint.adoc, debug-add-components.adoc, debug-run-debug-sessions.adoc, debug-a-mule-application.adoc, debugging-mule-apps.adoc
3+
: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
44

55

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

5757
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>>.
5858

59-
6059
[[add-breakpoint]]
6160
== Add a Breakpoint
6261

0 commit comments

Comments
 (0)