Introduction👨✈
When we deal with ReadyAPI, we come across various requests. Such as REST requests, GraphQL requests, Kafka requests, gRPC requests and SOAP requests. In this article, we will learn about SOAP requests and how to work with them in ReadyAPI.
Cool! Are you ready❓
Fine! So let us learn about SOAP requests in ReadyAPI.💫
SOAP Requests in ReadyAPI✅
SOAP requests are requests to SOAP services. The following sections describe how to work with SOAP requests in ReadyAPI.
SOAP Requests🙏
In your SOAP project, find and select the desired request in the "Navigator" panel.
Configure SOAP Request⚙️
Configure the SOAP request using one of the following panels.
XML - Text editor for editing the "XML" content of the request.
Outline - Shows the tree-like structure of the request. In this panel, you can edit only the values of the "XML" nodes.
Form - Provides user-friendly input fields for elements specified in the "WSDL".
Tip 🔗- The "Raw" tab shows the actual content of the last sent request.
Validating XML Message Content☑
To validate the "XML" message content displayed in the request section.
1️⃣Right-click in the "XML" editor tab and select "Validate"(or press Alt+V).
Or you may also click on the double tick icon in the "Form" editor tab.
Note ⚠️- If there is any error, ReadyAPI shows its description below the editor field.
Formatting XML Message Content🦾
You can format the XML message content for easier viewing.
➼For formatting, right-click on the editor field and select "Format XML"(or press Alt+F).
ReadyAPI indents child elements, meaning it "pretty-prints" the XML for easier viewing.
Apply WS-* Specifications🧑🎨
In ReadyAPI, you can add the given below WS-* specifications.
📌WS-Security - ReadyAPI supports WS-Security through incoming and outgoing WSS configurations in which the "truststores" and the "keystores" are used to secure message delivery.
📌WS-Addressing - WS-Addressing is a standard way of including message routing data in SOAP request headers. WS-Addressing is used to guarantee message delivery. When using it, you include the request destination in a SOAP header to always deliver your messages successfully.
📌WS-ReliableMessaging - WS-ReliableMessaging is a standard way of ensuring the delivery of requests to the destination service. It can be used when working with both individual requests and with functional tests. When running a test with a great number of requests, you may want to configure WS-RM for the entire test case.
SOAP Request Properties📋
SOAP request properties define how ReadyAPI handles specific SOAP requests.
SOAP Specific Panels🥷
The "Request Editor" contains several helper panels, such as an "XSD" panel, "Doc" panel, "Table" panel, etc., specific to SOAP requests.
XSD Panel⚡
The XSD(XML Schema Definition) panel shows the current nodes corresponding to the XSD(XML Schema Definition). Instead of displaying simple types like sequences, the complex type that contains them is shown. The title contains the name of the current type if it is available. The schema information for the selected element is shown in the image given below.
Other SOAP-specific panels are given below.
📌Doc Panel⚡- It shows schema annotations for the selected type.
📌Table Panel⚡- It displays the tabular view of siblings and children of the item selected on the "Outline" panel.
Children are shown as table columns, and siblings are shown as table rows.
We hope you understand SOAP requests in ReadyAPI and how to work with them.
306+ registered