This document provides an overview of API testing and web services protocols. It discusses XML, SOAP, REST, and introduces the tool SoapUI for testing web services. Key points include: 1. XML is used to transport and store data on the web. It has elements, attributes, and syntax rules. XML Namespaces avoid element name conflicts. 2. SOAP is a protocol for accessing web services. It uses XML, includes envelope, header and body elements. WSDL describes SOAP web services operations. 3. REST services use HTTP to manipulate resources via operations like GET, PUT, POST and DELETE. It can output JSON, XML and is language/platform independent. 4.

1. API Testing Class
Room-2
Get Software Services is inviting you to a scheduled Zoom meeting.
Join Zoom Meeting
https://zoom.us/j/8513760096?pwd=Qlh4OVRxaWhqbllLQk80RXE3ekdHdz09
Meeting ID: 851 376 0096
Passcode: getsoft

2. Introduction to Web Services
GETTING STARTED
2

3. What are Web services
3
• A method of communicating between two
devices over a Network
• A software function provided at a network
address over the web with the service always
on

4. More examples
4

5. Protocols
5
• There are multiple protocols and transport
mechanisms for web services- this class will
focus on:
– SOAP
– REST
• Before looking at these web services, we need
a basic understanding of XML and XML
Namespaces

6. XML
6
• XML stands for eXtensible Markup Language
• XML is designed to transport and store data,
not to display data
• XML tags are not predefined
• XML is designed to be self-descriptive
• XML does not DO anything.
– It is just information wrapped in tags
– Need software to send, receive or display it.

7. XML examples
7

8. Another Example
8
Login
is
parent
start tag
end tag

9. XML Syntax Rules
9
• All XML Elements Must Have a Closing Tag
• <p>This is incorrect.
• <p>This is a correct.</p>
• <p></p> & <p /> are also correct
• XML Tags are Case Sensitive
• <Message>This is incorrect</message>
• <message>This is correct</message>
• XML Elements Must be Properly Nested
• <b><i>This is incorrect</b></i>
• <b><i>This is bold correct</i></b>

10. XML Rules (cont)
10
• XML Documents Must Have a Root Element
<root>
<child>
<subchild>.....</subchild>
</child>
</root>
• Only the characters "<" and "&" are strictly
illegal in XML
• <!-- This is a comment -->
• White-space is Preserved in XML

11. Elements and Attributes
11
• Bookstore has an element book
• Book has an attribute – category and
elements: title, author, year, price

12. XML Namespaces
12
• XML
Namespaces
provide a
method to
avoid element
name conflicts
and to provide
for reusability
of elements

13. Why do we care ?
13
• Errors in XML documents will stop your XML
applications
• Many of the errors that we find in testing have
to do with
– Namespace issues
– Schema data types
– Case
– Order
– Whitespaces

14. XPath
14
• XPath (the XML Path language) is a language
for finding information in an XML document
• XPath is a syntax for defining parts of an XML
document
• XPath uses path expressions to navigate in
XML documents
• XPath contains a library of standard functions

15. XPath
15
• XPath (the XML Path language) is a language for finding information in an
XML document
• XPath is a syntax for defining parts of an XML document
• XPath uses path expressions to navigate in XML documents
• XPath contains a library of standard
1. Relative XPath - Partial
2. Absolute XPath - Full

16. XPath examples
16

17. SOAP
17
• SOAP stands for Simple Object Access Protocol
• SOAP is an XML based protocol for accessing
Web Services.
• SOAP is based on XML

18. SOAP
18
• A SOAP message is an ordinary XML document
containing the following elements:

19. SOAP Elements
19

20. Example
20
body
operation name

21. SOAP Syntax Rules
21
• Must be encoded using XML
• Must use a SOAP envelope namespace
– xmlns:soap="http://www.w3.org/2001/12/soap-
envelope"
• Must not contain XML processing instructions

22. SOAP requests defined by WSDL
22
• WSDL stands for Web Services Description
Language
• WSDL is an XML-based language for describing
Web services.
• WSDL is written in XML
• WSDL is also used to locate Web services

23. WSDL Document Structure
23

24. WSDL Example
24

25. Operation Types
25
No output – one way

26. Operation Types
26
• Request <> Response
• One Way
• Solicit < > Response
• Notification

27. REST
27
• REpresentational State Transfer (REST)
• Resources are manipulated using a fixed set of
four operations -create, read, update, delete :
PUT, PATCH ,GET, POST, and DELETE.
– POST creates or updates a new resource, which
can be then deleted by using DELETE.
– GET retrieves the current state of a resource
(read)
– PUT transfers a new state onto a resource
(update).

28. Using PUT & POST
28
• Either PUT or POST can be used to create a
new resource (depends on how your service is defined)
– For example creating a new chapter of MPEP
(Manual of Patent Examining Procedure)
– POST /manual/MPEP/current
– PUT /manual/MPEP/current/d0e55397.xml
• If you want to update an existing document on
the server, then use PUT

29. Examples
29
• URI: uniform resource identifiers (string of
characters to identify resource)
• Customer # 18 info:
– http://www.thomas-
bayer.com/sqlrest/CUSTOMER/18/
• List of invoices
– http://www.thomas-bayer.com/sqlrest/INVOICE/
• List of products
– http://www.thomas-bayer.com/sqlrest/PRODUCT/

30. REST RESPONSES
30
• PRODUCT/30
• INVOICE/14

31. REST > WADL
31
• Sometimes a REST service has documented
information in a WADL
• WADL = Web Application Description
Language
• XML/JSON in format
• Not Standardized

32. Sample WADL
32
URI:

33. Differences
33
• SOAP REQUEST
• SAME AS A REST REQUEST

34. Differences
34
Attribute SOAP REST
Language/Platform Language, platform, and
transport independent
Only http
Environments Works well in distributed
enterprise environments
Requires point-to-point
communication
Standardization Standardized Has some standards
Error handling Built in error-handling None
Format Requires XML Efficient – can use any
format
Speed Slower Fast (no extensive
processing required)

35. SOAP & REST Responses
35
• REST doesn’t have to use XML to provide the
response. REST-based Web services can
output the data in
– Command Separated Value (CSV)
– JavaScript Object Notation (JSON) and
– Really Simple Syndication (RSS)
• Often when you find a REST service, one of
the inputs is the requested format

36. REST Example
36
• http://api.wunderground.com/api/74e36bb7a
98f6a55/conditions/q/CA/San_Francisco.json
• Json Response
• XML response

37. Introduction to SOAPUI
USING SOAPUI
37

38. Introduction to SOAPUI
38
• Create projects
• Add WSDL from sample web service
• Setup up security settings
• Walk through structure of request and response.
• Discuss faults from failed structure vs data errors.
• Request structure
• Request-level properties
• Validating request inputs
• Creating multiple requests
• Response structure
• Working with endpoints

39. Dashboard
39

40. File Menu
40

41. 41

42. WSDL Settings
42

43. Preferences
43

44. Editor Settings
44
Tabbed request/response
Toggle tabs on/off

45. Preferences
45
• Once done with changes,
Save Preferences
can also import preferences

46. Create a New Project
46

47. 47

48. 48

49. Can Create Empty Project
at this point
49

50. Or Add WSDL
http://www.webservicex.com/currencyconvertor.asmx?WSDL
50

51. Project Created
51

52. This Sample has 2 Versions
52

53. SoapUI Parses WSDL
SOAPUI looks for port & operation name(s)
53
Input
Elements
Enums
Response

54. Components
54

55. Endpoints
55
• An endpoint allows you to point to different
environments for testing
• Managing the endpoints can be difficult and
it’s very, very easy to test against the wrong
endpoint
– Manage endpoints within a project
– Manage by maintaining Multiple projects
– Use environments to manage endpoints
– Use workspaces to manage endpoints

56. Endpoints
56

57. A Word About Requests
57

58. Renamed
58

59. A Word about Project Names
59
• Projects get sorted alphabetically
• You can name them anything you want
– Having a version or date included in the project
name can save you lots of time/frustration later
• By default, projects will be saved in My
Documents
• A saved project is an xml file with the format
of project name-soapui-project.xml

60. Setting Passwords
60

61. Submitting a Request from the Form
61

62. Form Request
62
In the form view, you can filter the fields that you want

63. Response
63

64. Exercise
64
• Create a new soap project and add this wsdl
http://www.webservicex.com/currencyconver
tor.asmx?WSDL
• From the form view, select different currency
types from the dropdown and submit the
request
• View the response in different formats

65. Structure of the Request
65

66. Navigating thru the Structure
66

67. Submitting Bad Data
67

68. Overview Results View
68

69. Complex Types
69

70. Faults Structure
70
• Remove one element

71. Fault - Structure
71
• Duplicate first element

72. Fault?
72
• Duplicate the entire complex object

73. Complex Type - Response
73
•Rules for both the request
and response are provided
in the wsdl

74. Quick Navigation
74

75. Operation Properties
75

76. Request Properties
76

77. Create Multiple Requests
77

78. Validate Requests
78

79. Validate Request
79
Double click on error to directly navigate

80. Structural Validation
80

81. Introduction to SOAPUI
BUILDING TEST CASES
81

82. Building Test Cases
82
• Creating Test Suite, Test Cases & Test Steps
• Unit vs. Functional Tests
• Parameterization of Data (Text file, excel,
Database)

83. Hierarchy
83
• Test Suite
– Test Case
• Test Steps
– Soap request
– REST request
– HTTP request
– AMF request
– JDBC request
– Data source/Data Gen
– Manual test
– Mock Response

84. Test Suite
84
• From the Project level you can create an
empty Test Suite

85. Test Suite from Operation Level
85

86. Adding a Request to a Test Case
86

87. Options for Test Case
87

88. Test Suite
88
• Defaults placeholders for Load Tests and
security tests are also added:
• Name is operation name + request name

89. Test Case Window
89

90. Run the Test Case
90

91. Test Case Properties
91
Add properties such as TestCase Description

92. Adding New Test Steps
92
•Click on type
of request
• Or drag and drop
existing request

93. Parameterization of Data
93
• Input data to drive the tests can come from
– Text file
– Excel sheet
– Database
• Can also parameterize the expected outputs

94. DataSource test step
94
• DataSource – reads test data into properties
from some external source
• TestStep – uses the available properties
• DataSource Loop – calls the test step(s) for
each record of data

95. Let’s set up another Test Suite
New Test Suite with Test Case
95

96. Setup Internal Data Source
96

97. Use Properties to add Columns
97

98. Add in Data in Grid
98

99. Add Test Soap Request Test Step
99

100. Map the Inputs to Test Data
100

101. Map the 2nd Input Field to the Data
101

102. Also want to Verify Response
102
• Click Assertions tab under request

103. Add Assertion
103

104. Add XPath Assertion
104

105. Map Expected Result to
Data Source
105

106. Finish Mapping & Save
106

107. Now add the Loop
107

108. Then Run the Test
108
• By default stops on error

109. Double-Click to see Details
109

110. Update Expected Results
110

111. Data Source- Excel
111
• Convert existing data store to EXCEL

112. 112

113. Add Properties Back
113

114. Data Mapping
114
• If data source name and properties are the
same, no need to remap

115. Introduction to SOAPUI
WORKING WITH TEST STEPS
115

116. Protocol Oriented Test Steps
1
1
• SOAP request
• REST request
• JDBC Request

117. Protocol Test Steps
1
1
• All of the requests within a Test Suite have to
come from the same project
• Requests from different protocols can be
loaded into the same project

118. Flow Control-oriented Test Steps
1
1
• Properties
• Delay
• Groovy script intro
• Manual
• GoTo

119. Properties
1
1

120. Transfer Properties
• Once properties are created, use a transfer
properties test step to pass on the information
1
2

121. Transfers Dialog
1
2

122. Transfer to hand off session id
• This property transfer is set up to hand off the
sessionid from the login response to the logout
request
• •
1
2

123. Exercise
• It would be nice to have the application id from the
GetAllBibDataInfo request to pass on to the
GetApplicationInfo request so let’s add in the
application id as a transfer property and add it as
another test step in the test case between
GetAllBibDataInfo and GetApplicationInfo.
• Then add an assertion on the GetApplication info
request to make sure that it is also working correctly.
Since Patent Number is one of the fields in the
response for the GetApplicationInfo, add an
assertion that this matches the original Patent
Number input
10

124. Delay
124

125. Exercise – Delay Step
125
• Add in a Delay Step in the previous exercise
before the Property Transfer step – this will
allow time for the response from
GetAllBibDataInfo to be completed before
transferring the data to GetApplicantInfo is
executed.

126. Manual Test Step
126

127. Executing w/ a Manual Step
127
• If you have any
manual test steps in
your test case/test
suite, you will get a
dialog pop-up that
provides instructions
and requests
information before
moving on to the
next test step

128. Exercise – Manual Step
128
• Add a manual step in the previous exercise before
the DataSource Loop with the following actions and
expected outcome:
• Action: Get up from your chair and walk one time
clockwise around the conference table, returning to
your seat.
• Expected outcome: You feel refreshed and ready to
take on more challenging exercises.
• Run your test suite, recording the actual results and
Pass/Fail status for the manual step

129. Go To
129

130. GoTo XPath
130

131. Data-Oriented Test Steps
131
• Data Source
• Data Source Loop
• Data Sink
• Data Gen

132. Data Sink
132
• Allows you to parse values from your test and
write them to output file
• If you want to use some of the data in the
response of a request, start with a valid
executed response

133. Setting up Data Sync
133

134. Sample Template File
134
• Data Input file with new header for actual
results

135. Create File
135
• If Excel needs to be .xls

136. Create Property for Actual Value
136

137. Select Element
Verify test step order
137

138. After Running
138

139. Data Sink Exercise
139
• Using the currency conversion project and the
previous steps, add a Data Sink to capture the
actual results in your test suite

140. Data Gen
140

141. DataGen Script for Today’s Date
141
${DataGen#today}

142. Template DataGen
142

143. Number DataGen
143

144. List DataGen
144

145. Mode & Shared
145
• Mode
– READ pulls a new value every time it is referenced
– STEP pulls a new value every time DataGen is
called
– Call DataGen prior to use as in the initial state, the
property has no value
• Shared
– For use in load tests – value can be shared across
multiple threads

146. Set up REST project
146
• Can create a REST project by
– Using URI
– Importing WADL
– Discover REST services

147. REST – URI Address
147
http://maps.googleapis.com/maps/api/geocode/xml?address=1600+Amphit
heatre+Parkway,+Mountain+View,+CA&sensor=false

148. Project is Set up
Can create multiple resources at this level
148

149. Request Tab
149
• Includes the fields – you could put in
additional fields in this form as well

150. Parameter Types
150
• QUERY
• TEMPLATE
• HEADER
• MATRIX
• PLAIN

151. Resource or Method Level
151

152. QUERY
152

153. HEADER
153

154. TEMPLATE
154

155. MATRIX
155

156. Exercise
156
• Building the correct URI
• Create a separate REST project for each of the
following URIs and adjust the parameters as
needed to build the correct URI:
• http://www.thomas-
bayer.com/sqlrest/CUSTOMER/18/ (remember that
any number can be used after CUSTOMER)
• http://fqt-tmng-
cms.etc.uspto.gov/trademark/cms/rest/metadata/ca
ses/id;sn=76705762

157. REST Uses Path for
Resource Names
157

158. SOAP/REST
158
• Project
– Service
• Resource
– Method
• Project
– Interface
• Operation
– Request

159. Note the Method Options
159

160. Submit the Request
160

161. Optional parameters
161
• https://spreadsheets.google.com/pub?key=p9
pdwsai2hDMsLkXsoM05KQ&gid=1

162. Exercise
162
• Create new project using REST service -
https://maps.googleapis.com/maps/api/geoco
de/xml?address=1600+Amphitheatre+Parkwa
y,+Mountain+View,+CA&sensor=false
– Change xml > json for different format in response
• Create multiple requests with different
optional input parameters and different
output formats
– Input parameters: language (see previous sheet),
region (2 char country code that would be used in
url such as ca, gb, gr, jp, etc.)

163. Discover REST APIs
163
1
2
3

164. Discover REST API (cnt)
164
4
5
6

165. Discover REST (cnt 2)
165

166. Introduction to SOAPUI
MORE ABOUT ASSERTIONS
166

167. 167

168. Xpath Functions
168

169. Adding Assertions
169
• CONTAINS/NOT CONTAINS
• SOAP/Non SOAP Reqest
• SOAP fault/non-SOAP fault
• Response SLA
• Xpath/Xquery match
• Script
• Security status
• JMS status and timeouts

170. CONTAINS/Not CONTAINS
170
• Contains checks for the existence of some
text in the received response or request
message
• Not Contains - Searches for the non-existence
of a string token in the property value,
supports regular expressions. Applicable to
any property.

171. 171

172. Adding Assertions to Test Step
172
• In the response, we want to verify a successful
response

173. Automatically Populates
173

174. Can also select for Content
matching RegEx
174

175. Exists
175

176. Prepopulates XPath
176

177. SOAP/non SOAP response
177

178. SOAP fault/non-SOAP fault
178

179. Response SLA
179

180. XPath/XQuery match
180

181. Prepopulates
181

182. Script
182

183. Security Status
183

184. What information is sensitive?
184

185. Global Tokens
185

186. WS Addressing/Status
186

187. JMS status & Timeouts
187
• Similar to the SLA Assertions

188. Multiple Content Assertions
188

189. Lots of Assertions!
189
• Just for the first step:
What if we wanted to repeat these for multiple
steps?

190. Assertions at the Test Case Level
190

191. Grouping Assertions
191
• Assertions in a Test Step can be grouped
AND: all Assertions valid = PASS
OR: at least one valid Assertion = PASS

192. Web Services with Attachments
192
• Often times web services have attachments
associated with them
– Files (images)
– cookies

193. Send in Form
193

194. For the TMNG_CMS project
194

195. Run Test Case Test Step
195

196. Let’s Get Groovy
• Groovy Programming Language
• Exercise – writing groovy scripts
• Refactoring
• Exercise – refactoring wsdl
• Web Services with attachments
• Exercise – configure and test web service with attachment

197. Groovy Programming Language
• Language Overview
• Flow control
• SoapUI object model
• Dynamic test management
• Writing logic to verify scripts

198. Language Overview
198
• Groovy is the scripting language used in
SoapUI for controlling tests
• Groovy is also a programming language that
can run stand-alone in a java environment
– Contains some data structures similar to java
• Lists (like java arrays)
• Maps

199. Control structures
199
• Logic branches
• Looping
• If else

200. Groovy Script Usage
200
• Groovy Script TestStep in a TestCase
• Before and after running a TestCase or
TestSuite to initialize or cleanup
• Starting/Stopping MockService
• Initialize/Cleanup Project level
• Dynamic DataSource or DataSync
• Creating dynamic MockResponse content
• Adding Script Assertions

201. Script Editors - Tabs
201

202. Script Editor – Test Suite
202

203. Script Editor - TestCase
203

204. Script Editor – Test Step
204

205. Get & Set Properties
205
• // get properties from testCase, testSuite and project
• def testCaseProperty = testRunner.testCase.getPropertyValue( "MyProp" )
• def testSuiteProperty = testRunner.testCase.testSuite.getPropertyValue("MyProp" )
• def projectProperty = testRunner.testCase.testSuite.project.getPropertyValue(
"MyProp" )
• def globalProperty =
com.eviware.soapui.SoapUI.globalProperties.getPropertyValue( "MyProp" )
• // setting values
• testRunner.testCase.setPropertyValue("MyProp", someValue )
testRunner.testCase.testSuite.setPropertyValue( "MyProp", someValue )
testRunner.testCase.testSuite.project.setPropertyValue( "MyProp",
someValue )
com.eviware.soapui.SoapUI.globalProperties.setPropertyValue( "MyProp",
someValue )

206. Get & Set Settings
206
• import com.eviware.soapui.settings.SSLSettings
• import com.eviware.soapui.SoapUI
• // set SoapUI.settings.setString( SSLSettings.KEYSTORE, pathToKeystore )
SoapUI.settings.setString( SSLSettings.KEYSTORE_PASSWORD,
keystorePassword )
• // get SoapUI.settings.getString( SSLSettings.KEYSTORE, "value to return if
there is no such setting set" )

207. Useful info
207
• Access project name
• testRunner.testCase.testSuite.project.name
• Access test step name
• context.getCurrentStep().getLabel()

208. Data Source
208

209. Data Sync
209

210. Saving Test Step Results
210

211. Groovy Step
211
You can add a Groovy step by right clicking on a test
step and selecting “Insert Step” followed by “Groovy
Script” or by opening the TestCase and clicking on the
star icon.

212. Incrementing a Property
212
Here’s how to increment a property called PatentNum.
• Get the TestCase Property (as a “BigDecimal”)
• Increment the value
• Set the value back into the property
def old = context.testCase.getPropertyValue(“PatentNum") as BigDecimal;
def new = (old+ 1) as String;
context.testCase.setPropertyValue( “PatentNum", new );
Notice how the setPropertyValue differs from the
getPropertyValue

213. Groovy Exercise
213
In this exercise we will:
• Set up a Test Case property
• Read a number in from a text file
• Transfer the number to a property
• Execute a request using the property
• Increment the property
• Store the property back to the text file

214. Assertion with Script
214

215. Auto-Generates Script
215

216. Change to get all nodes
216

217. GroovyUtils
217

218. xmlHolder Methods
218

219. XQuery
219

220. Navigation
220
• // means keep going down levels
• / means go down one level

221. Max or Min
221

222. Count
222

223. ANDs/ORs
223

224. Useful XPath Functions
224

225. WSDL Refactoring
225

226. Connect Old & New
226
• Sometimes the operation names change

227. Map Nodes per Operation
227
• You also have the chance to manually edit

228. XPath Mapping
228

229. Organizing your projects
229
• Setting up a workspace

230. Import Projects
230
• Import projects into the Workspace
•Easily Switch between
workspaces

231. Workspaces
231
• Can only have one workspace open at a time
• Same project can be in two workspaces
• Can have multiple projects loaded into
workspace
• Can’t have separate projects and workspaces
loaded at the same time

232. Environments
232
• Another way to help manage your projects is
to set up environments on the Project level

233. Organizing your projects
233
• Setting up a workspace

234. Import Projects
234
• Import projects into the Workspace
•Easily Switch between
workspaces

235. Workspaces
235
• Can only have one workspace open at a time
• Same project can be in two workspaces
• Can have multiple projects loaded into
workspace
• Can’t have separate projects and workspaces
loaded at the same time

236. Environments
236
• Another way to help manage your projects is
to set up environments on the Project level

237. Add Name
237

238. Change environment specifics
238