Skip to content

getting-started.md

Latest commit

 

History

History
72 lines (52 loc) · 2.53 KB

getting-started.md

File metadata and controls

72 lines (52 loc) · 2.53 KB
Raw

Getting Started

SOAPEasy is a fast, lightweight desktop SOAP client for macOS, Windows and Linux. This guide gets you from download to your first request in a couple of minutes.

Requirements

  • macOS, Windows, or Linux.
  • No Java install needed — the app bundles its own runtime.

Install

Download the installer for your OS from the Releases page.

macOS (.dmg)

  1. Open the .dmg and drag SOAPEasy into Applications.

  2. First launch only: the build isn't signed with an Apple Developer ID yet, so Gatekeeper warns. Open it once via right-click → Open, or:

    xattr -dr com.apple.quarantine /Applications/SOAPEasy.app

Windows (.msi)

  1. Run the .msi installer.
  2. SmartScreen may warn on an unsigned installer: More info → Run anyway. SOAPEasy then appears in the Start menu.

Linux (.deb / .rpm)

sudo apt install ./SOAPEasy_*.deb     # Debian / Ubuntu
sudo dnf install ./soapeasy-*.rpm     # Fedora / RHEL

First run

When SOAPEasy opens you'll see an empty workspace. To load your first API:

  1. File → Load SOAP API… (⌘O), or the + API button in the Projects panel.
  2. Paste a WSDL URL (e.g. https://example.com/service?wsdl) and confirm.
  3. SOAPEasy parses the WSDL, resolves its XSD schemas, and lists the operations under Open APIs.
  4. Click an operation — SOAPEasy generates a sample request from the schema.
  5. Set the Endpoint if it differs from the WSDL, then press Send (⌘↩).

The response appears below, pretty-printed and syntax-highlighted. You can validate it against the XSD, save it as an example, or copy it.

Where things are

  • Activity bar (left edge, VS Code-style) — each icon toggles a sidebar section: Open APIs (cube), Projects (folder) and Test Suites (flask). Stack the ones you want, or turn all off to collapse the panel.
  • Open APIs — the APIs you have open and their operations. Clicking an operation opens it in its own tab.
  • Projects — your saved requests, organized in folders.
  • Tabs (top) — each open request or test suite.
  • Logs panel (⌘J) — HTTP wire log and the App channel (what the engine does under the hood). Logs also persist to disk — Help → Open logs folder.

Next steps