SoapUI is the world's leading testing tool for API testing. See the SoapUI website to learn more. By downloading our software, you agree to our license and privacy policy.

Table of content

• Structure and submodules
• Build and run
  • Prerequisites
  • Get the source code for the first time
  • Build
  • Run
  • Get the latest changes
• Contribute
  • IDE support
    • IntelliJ IDEA
    • Eclipse
• Documentation
• Advanced Functionality
• Additional resources

Structure and submodules

• soapui - The core module that creates the soapui.jar file.
• soapui-system-test - Integration and system tests for SoapUI.
• soapui-installer - Creates SoapUI distributions, such as installers and archives.
• soapui-maven-plugin – A Maven plugin used to run SoapUI in a Continuous integration environment (such as Jenkins).
• soapui-maven-plugin-tester - A test pom.xml file used to test the soapui-maven-plugin.

Build and run

Prerequisites

• OpenJDK 17
• Maven (version 3.6.3 or later)
• Git (version 1.8 or later)

Get the source code for the first time

To get the source code, run git clone https://github.com/SmartBear/soapui.git in the folder where you want to clone the root folder of the SoapUI project.

Build

• To build a SoapUI project, run mvn clean install in the root folder.
• To build an individual submodule, run mvn clean install in the root folder of the submodule you want to build.

Run

To run SoapUI after it has been built, execute mvn exec:java in the root folder of the soapui submodule.

Get the latest changes

To get the latest source code changes, clone the project by running git pull in the root directory of the SoapUI project or in the root directory of the submodule you want to update.

Contribute

If you want to take a more active part in improving SoapUI, go to SoapUI Developer's Corner for more information.

IDE support

As SoapUI is using a standard Maven 3 setup, building and running SoapUI from an IDE is usually very straight forward, as long as the IDE has good Maven support.

IntelliJ IDEA

Open project

1. Clone the project.
2. In the main menu, select File > Open.
3. Enter the path to the root folder of the SoapUI project.
4. Run mvn compile to generate necessary source files automatically.

Run SoapUI

After you have created the IDEA project, navigate to the com.eviware.soapui.SoapUI class, right-click and select Run.

Get the latest changes

Right-click on the root folder in the Project panel and select Git > Repository > Pull.

Tip

To get the code style settings used by the SoapUI team, select File > Import Settings and import the intellij-codestyle.jar file located in the root folder of the SoapUI project.

Eclipse

Open project

1. Clone the project
2. In the main menu, select File > Import.
3. In the Import dialog, select Maven > Existing Maven projects and click Next.
4. In the Root directory, enter the path to the root folder of the SoapUI project and click Finish.

Run SoapUI

After you have created the Eclipse project, navigate to the com.eviware.soapui.SoapUI class, right-click it and select Run as > Java application.

Get the latest changes

1. Right-click on the root folder in the Package explorer panel.
2. Select Team > Pull.

Documentation

To generate documentation (JavaDoc), run mvn javadoc:javadoc in the root folder of the submodule you want to create documentation for. The documentation will be located in the target/site/javadoc folder after the Maven command is executed successfully.

You can also get the latest information on SoapUI classes and methods here.

Advanced Functionality

SoapUI Open Source offers basic functionality for API testing. For additional features, such as data-driven testing, coverage testing, groovy script debugging and others, try SoapUI Pro.

Additional resources

• SoapUI community - SmartBear's SoapUI Open Source community for discussing and participating in all things SoapUI.
• SoapUI Groovy examples - This is a collection of SoapUI projects and Groovy scripts used to demonstrate the Groovy scripting capabilities in SoapUI.
• Extending SoapUI
• Custom factories
• Integrating with SoapUI
• Mastering SoapUI - Master the art of testing and automating your SOA using SoapUI