It is considered a good practice to store tests and test projects in source control. This way, you can easily work on your tests along with your teammates, share your test cases, revert changes, and so on.
ReadyAPI includes built-in support for Git repositories. This allows you to upload your test project files to and retrieve them from a Git repository directly from within the ReadyAPI UI without using any third-party tool.
ReadyAPI supports Git repositories located in repository-hosting systems like GitHub, GitLab, or Bitbucket, as well as Git repositories that reside on servers in your local network.
To work with most Git providers, you need an account. ReadyAPI provides an account manager for Git accounts: you can add your Git account in ReadyAPI and then use it in any of your projects.
To open the Git account manager, click 
Preferences and select the Git tab. This will open the Git preferences page where you can add and edit Git accounts:
 |
To add an account, select Connect (or Add Account if you already have an account of that type):
 |
If you use GitHub Enterprise, click the Connect or Add Account button next to GitHub Enterprise. The dialog will appear:
Option | Description |
|---|---|
Enterprise server address | The address of your GitHub Enterprise server. |
Token | A generated token that will be used to connect your account with ReadyAPI. Tip: If you don't have a token, click Generate Token, and you will be guided through the token generation process in GitHub Enterprise. |
If you use another Git provider or a local Git server, select Git.
In the dialog that ensues, select the protocol (HTTP or SSH) you use to connect to the repository and specify the connection settings:
Option | Description |
|---|---|
Username | Your username on the Git server. |
Password | Your password on the Git server. NoteSome servers, for example, GitHub or Azure DevOps Git, require a personal access token to authenticate. In this case, specify the token instead of the password in this field. |
Option | Description |
|---|---|
Profile name | The profile name that will be used in ReadyAPI. |
SSH key path | A fully-qualified path to the SSH key on your computer. |
Passphrase | The passphrase you used when generating the SSH key. |
If you use Bitbucket Cloud, click the Connect or Add Account button next to Bitbucket Cloud.
You will be guided through the Bitbucket Cloud OAuth process. You will have to enter your credentials, pass two-factor authentication if it is enabled for your account, and give the ReadyAPI OAuth app access to your account.
 |
If you use Bitbucket Data Center or Bitbucket Server, click the Connect or Add Account button next to Bitbucket Data Center / Server. The dialog will appear:
Option | Description | |
|---|---|---|
Enterprise server address | The address of your Bitbucket Data Center or Bitbucket Server. | |
Token | A generated token that will be used to connect your account with ReadyAPI. TipIf you don't have a token, click Generate Token, and you will be guided through the token generation process in your Bitbucket Data Center or Bitbucket Server. ImportantThe repository permissions for the account must be set to the admin level:
|
If you use GitLab Self-Managed, click the Connect or Add Account button next to GitLab Enterprise. The dialog will appear:
Option | Description | |
|---|---|---|
Enterprise server address | The address of your GitLab Self-Managed server. | |
Token | A generated token that will be used to connect your account with ReadyAPI. TipIf you don't have a token, click Generate Token, and you will be guided through the token generation process in your GitLab Self-Managed server. ImportantMake sure you set the following scopes for the generated access token:
|
If you already have a Git account added to ReadyAPI, but you want to edit it, click Edit Account:
 |
To test if your account can connect to the server or repository, select Test Connection.
Note
The connection test will always be successful for public Git repositories because you can always connect to them, even without credentials. However, you will not be able to perform some actions like push if you are not authorized.
To work with your project in Git, you should first connect it to a Git repository. To do that:
Double-click the project in the Navigator panel to open the project editor, and click the Configure Git button in the editor toolbar:
— or —
Click
on the main toolbar and select Connect to Remote Repository:
To work with Git in ReadyAPI, you should convert your project into a composite project. These projects store test cases and other data as separate files instead of a single XML file. Click Continue to do that:
If your project was not saved, ReadyAPI shows the Save project dialog. Select the location where you want to save the project, enter the project name and click Save.
In the Choose Account dialog, select an account you will use to connect to a repository or add a new one if you haven't configured any Git accounts yet.
Alternatively, if you just want to initialize a local Git repo that doesn't require credentials, select Create in the New Local Repo section. This will initialize a repo in the project folder.
For GitHub, Bitbucket, and GitLab accounts, select the repository to which you want to connect. You can search for it in the list or input the URL and click Select.
Tip
To see details about a repo, click
.
For Git accounts: enter the URL of the repository and click Select:
Now, your project is connected to the Git repository, and you can commit and push your changes.
When using Git for version control, each ReadyAPI project should have its own Git repository. To support Git adoption, ReadyAPI projects transition from a single monolithic project file to a composite project structure. This approach improves modularity and maintainability, making it easier for teams to collaborate.
If you have a repo containing multiple ReadyAPI/SoapUI project files and want to adopt Git, consider one of the following approaches:
Single Git Repository: Merge all projects into one, convert it into a composite project, and initialize a Git repository. This results in a single Git repo.
Multiple Git Repositories: Create a separate Git repository for each project, convert each project to a composite format, and maintain them independently.
Choose the approach that best aligns with your application's architecture and team structure.
Once your ReadyAPI project is structured appropriately in Git, we recommend enabling the following settings to improve Git compatibility:
in the Preferences > WSDL dialog box, and
in the Preferences > UI dialog box.
These settings make your ReadyAPI project files more compatible with Git’s auto-merge feature, reducing conflicts when merging changes. To learn more, see Merging Changes.
ReadyAPI provides an easy way to clone a ReadyAPI project stored in a remote Git repository and import it into ReadyAPI. To do that:
Select File > Clone Project from Git from the main menu:
In the Choose Account dialog, select an account you will use to connect to a repository or add a new one if you haven't configured any Git accounts yet.
Alternatively, if you just want to import a local Git repo that doesn't require credentials, select Import in the Import a local repo section and select the repo folder.
For GitHub, Bitbucket and GitLab accounts: select the repository you want to clone. You can search for it in the list or input the URL and click Select.
Tip
To see details about a repo, click
.For Git accounts: enter the URL of the repository and click Select:
Now, you can work with the cloned project and commit and push your changes to the remote repository.
Note
ReadyAPI automatically adjusts the settings.xml (or any auto-updated file) based on factors like version changes. For example, if a project created on 3.49 is cloned to 3.50, ReadyAPI detects and switches the settings accordingly, altering the settings.xml file. However, subsequent commits won't trigger this behavior unless the project is pulled onto a different machine with a different ReadyAPI version.
Please refer to the Required Settings in ReadyAPI to Optimize Git Integration section to learn more about setting up Git integration correctly for optimal use.
You can also learn more about this behaviour in Troubleshooting.
To disconnect a project from the Git repository:
Click
on the main toolbar.Click
and select Disconnect Account:
Note
The local repository in your project folder will remain, and you will be able to reconnect anytime.
ReadyAPI offers a number of commands to perform typical operations on the project files. You can perform them from the Git panel or from the main menu or context menu:
 |
 |
 |
Once your project is in the repository, you use the Git panel or menu commands to work with it. For more information, see the following topics:
Commit Changes to Git Repository
Pushing Changes to Git Repository
When collaborating on an API in ReadyAPI with multiple QA engineers, you need to:
Review the configurations outlined in the linked pages. They are essential for optimizing your experience with Git, particularly when merging changes. To enable merging your changes automatically, ensure you configure the required settings.
Refer to the ReadyAPI Settings for Effective Git Collaboration section for proper setup and tips to avoid conflicts.
See Troubleshooting.