RAPID-ML Plugin for Ready! API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
RAPID-ML Model Examples
images
jars
src
.gitignore
README.adoc
pom.xml

README.adoc

The RAPID-ML Plugin for Ready! API

The RAPID-ML Plugin for Ready! API allows SmartBear’s Ready! API testing and virtualization suite to work with RAPID-ML models created in RepreZen API Studio. With this plugin, you can:

  • Import RepreZen’s native RAPID-ML API models into Ready! API for testing and virtualization.

  • Generate an API model in RAPID-ML format from any REST API defined in Ready! API, for subsequent editing, documentation, visualization and code generation in RepreZen API Studio.

Download and Install

To install the plugin to Ready! API:

  1. Download the plugin JAR file from the jars page (click on 'View Raw' to download), or build it yourself as described below.

  2. In Ready! API, click the Plugins toolbar button to show the Plugin Manager.

  3. Click the Load plugin from file…​ button, and open the plugin JAR file. You should see a message box indicating that the plugin has been installed successfully. Click OK, then Close to dismiss the Plugin Manager.

Ready! API is now ready to import and export RepreZen API Studio’s native RAPID-ML format.

Note
The export action is available on the RestResource, not on the project itself. See Working with the Plugin below for more details.

Working with the Plugin

Importing a RAPID-ML Model

Note
You can use models from the RAPID-ML Model Examples folder

RepreZen API Studio’s Zen Model or RAPID Model is an API description in RAPID-ML format. RAPID-ML includes an intuitive, technology-neutral schema language to specify message formats, including data structures, enumerations, cardinality constraints, string length, regex and numeric range constraints. API Studio also includes an example-driven mock service and essential sandbox testing.

When your API is ready for comprehensive, methodical testing, you can import your RAPID-ML model directly into Ready! API for complete functional testing, load testing, security testing and API virtualization.

Importing a RAPID Model to a New Ready! API Project:

Follow this procedure to create a new Ready! API project, containing your imported RAPID model:

  1. In Ready! API, select File  New Project.

  2. In the New Project dialog, make sure the create project from radio button is selected, and select RAPID-ML Model (REST) from the drop-down list. Click OK to continue.

  3. In the Import RAPID-ML Model dialog box, enter a name for a new Ready! API project that will contain the imported API. Click Browse…​ to select the RAPID-ML model. Click OK to continue.

  4. Choose the location and name for your Ready! API Project file and click Save.

Your new project will appear on the left, under Recent (from the Start screen) or in the Projects tree (from the Projects screen). Double-click the project name to open its contents, and explore the definitions in Ready! API.

Importing a RAPID Model to an Existing Project

You can also import a RAPID-ML model into an existing Ready! API project:

  1. In the Projects screen, select the project you want to contain the imported RAPID model.

  2. From the right-click context menu, or from the Project menu, choose Import RepreZen / RAPID-ML Model.

  3. Click Browse…​ to select the RAPID-ML model. Click OK to continue.

The imported model should appear in the project view.

Exporting a REST API to RAPID-ML

You can export any REST API from Ready! API to RAPID-ML, for use in RepreZen API Studio:

  1. Make sure the Projects screen is active, with the tree expanded to show the REST API you want to export.

  2. Right-click the API (not the top-level project) and select Export RepreZen / RAPID-ML Model from the context menu.

  3. Choose the folder, filename and Base URI for the RAPID-ML model, and click OK. You should see a message confirming that your RAPID-ML model has been exported successfully.

Building the Plugin

To build the RAPID-ML Plugin for Ready! API, clone the Git repository, make sure you have maven installed, and run

mvn clean install assembly:single
Note
Maven creates two jars. We recommend using /target/RapidML-ReadyAPI-Plugin-1.0-dist.jar as it contains all of the required dependencies.