Skip to content

Commit ab00267

Browse files
author
Johanna Hemminger
committed
Could these be the last broken links
1 parent 4b38919 commit ab00267

2 files changed

Lines changed: 40 additions & 38 deletions

File tree

content/en/docs/refguide/modeling/integration/web-services/published-web-services/expose-a-web-service.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
title: "Expose a Web Service"
3-
url: /howto/integration/expose-a-web-service/
3+
url: /refguide/integration/expose-a-web-service/
44
category: "Integration"
55
weight: 12
66
description: "Describes how Mendix supports exposing the functionality and data of your app using web services."
77
tags: ["web service", "expose", "integration", "studio pro"]
8+
aliases:
9+
- /howto/integration/expose-a-web-service/
810
---
911

1012
## 1 Introduction
@@ -30,7 +32,7 @@ This how-to was written based on Studio Pro 5.20. All the images, names, and ste
3032

3133
1. Create the following **Customer** entity in your domain model (for details on how to create an entity, see [Configuring a Domain Model](/refguide/configuring-a-domain-model/)):
3234

33-
{{< figure src="/attachments/howto/integration/expose-a-web-service/8945665.png" >}}
35+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/8945665.png" >}}
3436

3537
2. Create overview and detail pages to manage objects of the **Customer** type (for details on how to create overview and detail pages, see [How to Create Your First Two Overview and Detail Pages](/howto/front-end/create-your-first-two-overview-and-detail-pages/).
3638
3. Create a menu item to access the customer overview page (for details on how to create menu items, see [Setting Up Navigation](/refguide/setting-up-the-navigation-structure/).
@@ -42,24 +44,24 @@ To create a published web service, follow these steps:
4244

4345
1. Right-click the module in which you want to store the published web service and select **Add** > **Published services** > **Published web service**:
4446

45-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581715.png" >}}
47+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581715.png" >}}
4648

4749
2. In the **Add Published Web Service** window, enter *CustomerWebservice* for the **Name** and then click **OK**:
4850

49-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581728.png" >}}
51+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581728.png" >}}
5052

5153
3. You should now see the **Published Web Service** properties window. Take note of the following tab details:
5254
* On the **Operations** tab, you can see the available operations of the web service (currently the list is empty, so we'll add an operation in section [Publishing a Microflow](#publish-a-microflow)):
5355

54-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581713.png" >}}
56+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581713.png" >}}
5557

5658
* On the **Settings** tab, you can configure the other settings. Do change them before publishing your web service, especially the **Target namespace** (for details on these settings, see [Published Web Service](/refguide/published-web-service/) in the *Studio Pro Guide*):
5759

58-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581712.png" >}}
60+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581712.png" >}}
5961

6062
* On the **Documentation** tab, you can change the documentation:
6163

62-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581710.png" >}}
64+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581710.png" >}}
6365

6466
4. Click **OK.**
6567

@@ -70,41 +72,41 @@ To create the functionality to expose, follow these steps:
7072
1. Create a microflow that retrieves and returns a list of customers from the database (for details on how to create a microflow, see [Triggering a Microflow From a Menu Item](/refguide/triggering-microflow-from-menu-item/)).
7173
2. To make the microflow more exciting, add two input parameters to dynamically set the range settings of the retrieve action. Configure the range options of the retrieve action like this:
7274

73-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581709.png" >}}
75+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581709.png" >}}
7476

7577
Reference this microflow:
7678

77-
{{< figure src="/attachments/howto/integration/expose-a-web-service/model.jpg" >}}
79+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/model.jpg" >}}
7880

7981
## 6 Publishing a Microflow{#publish-a-microflow}
8082

8183
To publish a microflow, follow these steps:
8284

8385
1. Right-click somewhere in the background of the microflow and select **Publish as Web service operation**:
8486

85-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581708.png" >}}
87+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581708.png" >}}
8688

8789
2. Locate the web service created in [Creating a Published Web Service](#create-published-web-service) and click **Select**:
8890

89-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581723.png" >}}
91+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581723.png" >}}
9092

9193
3. You should now see the **Operation Operation** properties editor. Take note of the following tab details:
9294

9395
* On the **General** tab, you can change the **Name** and **Documentation**:
9496

95-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581705.png" >}}
97+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581705.png" >}}
9698

9799
* On the **Parameters** tab, you can mark the input parameters as **Optional** and **Nillable**:
98100

99-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581707.png" >}}
101+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581707.png" >}}
100102

101103
* On the **Return type** tab you can configure the return type:
102104

103-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581706.png" >}}
105+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581706.png" >}}
104106

105107
4. Click **Select...** to select which attributes and associations of the return object **Customer** you want to expose:
106108

107-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581704.png" >}}
109+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581704.png" >}}
108110

109111
5. Select the members you want to expose and click **OK**. Only the selected members will be returned by the web service.
110112
6. Click **OK** to save the operation.
@@ -121,7 +123,7 @@ To get a WSDL, follow these steps:
121123
* If you run the application in a Free App environment, the application URL should look like this: `https://myfirstapp.mendixcloud.com/index.html`
122124
3. In both of the above cases, you can replace `/index.html` with `/ws-doc/` to open the web service documentation page:
123125

124-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581703.png" >}}
126+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581703.png" >}}
125127

126128
You should see the name of your web service in the list.
127129
4. Click the "WSDL schema" URL to open the WSDL. This WSDL can be given to others so that they can interact with your web service.
@@ -133,11 +135,11 @@ To change the user authentication, follow these steps:
133135
1. Double-click the published web service in the **App Explorer** to open it.
134136
2. In the **Published Web Service** properties window, open the **Settings** tab. Because **No Authentication** is set, currently users of the web service do not need to authenticate:
135137

136-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581702.png" >}}
138+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581702.png" >}}
137139

138140
3. Change **Authentication** to **Username and password**:
139141

140-
{{< figure src="/attachments/howto/integration/expose-a-web-service/18581701.png" >}}
142+
{{< figure src="/attachments/refguide/modeling/integration/expose-a-web-service/18581701.png" >}}
141143

142144
4. Click **OK** and re-run the application. Users now need to authenticate before they can use the web service.
143145

content/en/docs/refguide9/modeling/integration/web-services/testing-web-services-using-soapui.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ In [How to Expose a Web Service](/refguide9/integration/expose-a-web-service/) y
4242
2. Open the app you created in [How to Expose a Web Service](/refguide9/integration/expose-a-web-service/).
4343
3. Create a **Microflow** that creates a customer and returns a Boolean.
4444

45-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/model1.jpg" >}}
45+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/model1.jpg" >}}
4646

4747
4. Create a **Microflow** that deletes a customer and returns a Boolean.
4848

49-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/model2.jpg" >}}
49+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/model2.jpg" >}}
5050

5151
5. Publish both microflows as web service operation of the **CustomerWebservice** as described in chapter 4 of [How to Expose a Web Service](/refguide9/integration/expose-a-web-service/).
5252

@@ -56,39 +56,39 @@ In this chapter you will create a new SOAP project.
5656

5757
1. Open **SoapUI**.
5858
2. Press **CTRL+N** to create a new SOAP project.
59-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580339.png" >}}
59+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580339.png" >}}
6060
3. Run the app locally in Studio Pro.
6161
4. Go to `http://localhost:8080/ws-doc/`.
62-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580314.png" >}}
62+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580314.png" >}}
6363
5. Enter the URL of the WSDL schema in the **Initial WSDL** field in SoapUI.
6464
The **Project Name** field will automatically be filled with the name of the webservice following by *?wsdl*.
65-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580334.png" >}}
65+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580334.png" >}}
6666
6. Click**OK**. This will create a new SOAP project in SoapUI.
67-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580313.png" >}}
67+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580313.png" >}}
6868

6969
## 5 Building a TestSuite, TestCase, and TestStep
7070

7171
In this chapter you will build a testsuite. A testsuite contains one or more testcases. Every testcase contains one ore more teststeps.
7272

7373
1. In SoapUI, press **CTRL+T** to create a new TestSuite.
74-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580332.png" >}}
74+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580332.png" >}}
7575
2. Click **OK**.
7676
3. Select TestSuite 1 and press **CTRL+N** to create a new TestCase.
77-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580331.png" >}}
77+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580331.png" >}}
7878
4. Click **OK**.
7979
5. Expand TestSuite 1 and TestCase 1.
8080
6. Right-click **Test Steps(0)** and select **SOAP Request**.
81-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580312.png" >}}
81+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580312.png" >}}
8282
7. Enter *Retrieve Customers* in the name field.
83-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580329.png" >}}
83+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580329.png" >}}
8484
8. Click **OK**.
8585
9. Select **CustomerWebserviceSoap -> GetCustomers**.
86-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580328.png" >}}
86+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580328.png" >}}
8787
10. Click **OK**.
88-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580327.png" >}}
88+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580327.png" >}}
8989
11. Click **OK**.
9090
12. Open SOAP request **Retrieve Customers**.
91-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580326.png" >}}
91+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580326.png" >}}
9292
13. Change the follow value:
9393

9494
```java
@@ -143,15 +143,15 @@ In this chapter you will build a testsuite. A testsuite contains one or more tes
143143
Assertions are used to validate the message received by a TestStep during execution, usually by comparing parts of the message (or the entire message) to some expected value. In this chapter you will create an assertion that validates the number of customers.
144144

145145
1. Click **Assertions (1)**.
146-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580307.png" >}}
146+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580307.png" >}}
147147
In chapter 3 step 9 the *Add SOAP Response Assertion* checkbox was checked. That is the first assertion you see in the list, *SOAP Response - VALID*.
148148
2. Click the add assertion icon.
149-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580324.png" >}}
149+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580324.png" >}}
150150
3. Click **Property Content**.
151151
4. Click **XPath Match**.
152152
5. Enter *count(//Customer)* in the XPath Expression field.
153153
6. In step 1.4 of the previous how-to you have added some data. Enter the number of created customers in the **Expected Result** field. In this example four customers were created.
154-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580323.png" >}}
154+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580323.png" >}}
155155
7. Click **Save**.
156156

157157
## 7 Extending Your Test Case
@@ -182,12 +182,12 @@ In this chapter you will extend your test case with multiple test steps and asse
182182
```
183183

184184
3. Add a **Contains Assertion** and enter *true* in the content field.
185-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580322.png" >}}
185+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580322.png" >}}
186186
4. Right-click test step **Retrieve Customers**.
187187
5. Select **Clone TestStep**.
188188

189189
6. Change **TestStep Name** to *Retrieve Customers 2*.
190-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580320.png" >}}
190+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580320.png" >}}
191191
7. Click **OK**.
192192
8. Open teststep **Retrieve Customers 2**.
193193
9. Click **Assertions (2)**.
@@ -216,9 +216,9 @@ In this chapter you will extend your test case with multiple test steps and asse
216216
In this chapter you will learn how to run the testcase you created in previous chapters.
217217

218218
1. Open testcase **TestCase 1**.
219-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580310.png" >}}
219+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580310.png" >}}
220220
2. Click the run this testcase icon.
221-
{{< figure src="/attachments/refguide9/modeling/integration/testing/testing-web-services-using-soapui/18580309.png" >}}
221+
{{< figure src="/attachments/refguide9/modeling/integration/testing-web-services-using-soapui/18580309.png" >}}
222222

223223
Congratulations! You have just created your first automated test with SoapUI.
224224

0 commit comments

Comments
 (0)