{"id":21038948,"url":"https://github.com/reprezen/rapidml-readyapi-plugin","last_synced_at":"2026-05-18T22:14:52.323Z","repository":{"id":34839420,"uuid":"38829408","full_name":"RepreZen/RapidML-ReadyAPI-Plugin","owner":"RepreZen","description":"RAPID-ML Plugin for Ready! API","archived":false,"fork":false,"pushed_at":"2016-03-30T15:32:20.000Z","size":12953,"stargazers_count":2,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-20T16:32:51.949Z","etag":null,"topics":["openapi","rapid-ml","ready-api","readyapi","rest","smartbear","swagger","tdd","testing"],"latest_commit_sha":null,"homepage":"","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"opentypejs/opentype.js","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RepreZen.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-09T15:38:32.000Z","updated_at":"2019-04-15T19:51:42.000Z","dependencies_parsed_at":"2022-09-15T07:11:15.581Z","dependency_job_id":null,"html_url":"https://github.com/RepreZen/RapidML-ReadyAPI-Plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RepreZen%2FRapidML-ReadyAPI-Plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RepreZen%2FRapidML-ReadyAPI-Plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RepreZen%2FRapidML-ReadyAPI-Plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RepreZen%2FRapidML-ReadyAPI-Plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RepreZen","download_url":"https://codeload.github.com/RepreZen/RapidML-ReadyAPI-Plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243482906,"owners_count":20297903,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi","rapid-ml","ready-api","readyapi","rest","smartbear","swagger","tdd","testing"],"created_at":"2024-11-19T13:36:57.655Z","updated_at":"2026-05-18T22:14:47.286Z","avatar_url":"https://github.com/RepreZen.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":":experimental:\n:imagesdir: ./images\n\n= The RAPID-ML Plugin for Ready! API\n\nThe RAPID-ML Plugin for Ready! API allows SmartBear's\nhttp://smartbear.com/product/ready-api/overview/[Ready! API] testing and virtualization suite to work with\nhttp://rapid-api.org/rapid-ml[RAPID-ML] models created in http://www.reprezen.com[RepreZen API Studio]. With this\nplugin, you can:\n\n* Import RepreZen's native RAPID-ML API models into Ready! API for testing and virtualization.\n\n* Generate an API model in RAPID-ML format from any REST API defined in\n Ready! API, for subsequent editing, documentation, visualization and code\n generation in RepreZen API Studio.\n\n== Download and Install\n\nTo install the plugin to Ready! API:\n\n. Download the plugin JAR file from the\nhttps://github.com/RepreZen/RapidML-ReadyAPI-Plugin/blob/master/jars/RapidML-ReadyAPI-Plugin-1.0-dist.jar[jars page] (click on 'View Raw' to download),\nor \u003c\u003cbuilding-the-plugin,build it yourself\u003e\u003e as described below.\n\n. In Ready! API, click the btn:[Plugins] toolbar button to show the Plugin\nManager.\n\n. Click the btn:[Load plugin from file...] button, and open the plugin JAR file.\nYou should see a message box indicating that the plugin has been installed\nsuccessfully.  Click btn:[OK], then btn:[Close] to dismiss the Plugin Manager.\n\nReady! API is now ready to import and export RepreZen API Studio's native\nhttp://rapid-api.org/rapid-ml[RAPID-ML] format.\n\nNOTE: The export action is available on the _RestResource_, not on the project\nitself.  See \u003c\u003cworking-with-the-plugin,Working with the Plugin\u003e\u003e below for more\ndetails.\n\n== Working with the Plugin\n\n=== Importing a RAPID-ML Model\nNOTE: You can use models from the https://github.com/RepreZen/RapidML-ReadyAPI-Plugin/tree/master/RAPID-ML%20Model%20Examples[RAPID-ML Model Examples] folder\n\nRepreZen API Studio's _Zen Model_ or _RAPID Model_ is an API description in\nRAPID-ML format.  RAPID-ML includes an intuitive, technology-neutral schema\nlanguage to specify message formats, including data structures, enumerations,\ncardinality  constraints, string length, regex and numeric range constraints.\nAPI Studio also includes an example-driven mock service and essential sandbox\ntesting.\n\nWhen your API is ready for  comprehensive, methodical testing, you can import\nyour RAPID-ML model directly into Ready! API for complete functional testing,\nload testing, security testing and API virtualization.\n\n==== Importing a RAPID Model to a New Ready! API Project:\n\nFollow this procedure to create a new Ready! API project, containing your\nimported RAPID model:\n\n. In Ready! API, select menu:File[New Project].\n\n. In the New Project dialog, make sure the *create project from* radio button\nis selected, and select *RAPID-ML Model (REST)* from the drop-down list.  Click\nbtn:[OK] to continue.\n\n. In the *Import RAPID-ML Model* dialog box, enter a name for a new Ready! API\nproject that will contain the imported API.  Click btn:[Browse...] to select\nthe RAPID-ML model.  Click btn:[OK] to continue.\n\n. Choose the location and name for your Ready! API Project file and click\nbtn:[Save].\n\nYour new project will appear on the left, under *Recent* (from the *Start*\nscreen) or in the *Projects* tree (from the *Projects* screen).  Double-click\nthe project name to open its contents, and explore the definitions in Ready!\nAPI.\n\n==== Importing a RAPID Model to an Existing Project\n\nYou can also import a RAPID-ML model into an existing Ready! API project:\n\n. In the *Projects* screen, select the project you want to contain the imported\nRAPID model.\n\n. From the right-click context menu, or from the *Project* menu, choose *Import\nRepreZen / RAPID-ML Model*.\n\n. Click btn:[Browse...] to select the RAPID-ML model.  Click btn:[OK] to\ncontinue.\n\nThe imported model should appear in the project view.\n\n=== Exporting a REST API to RAPID-ML\n\nYou can export any REST API from Ready! API to RAPID-ML, for use in RepreZen API\nStudio:\n\n. Make sure the *Projects* screen is active, with the tree expanded to show the\nREST API you want to export.\n\n. Right-click the API (_not_ the top-level project) and select\n*Export RepreZen / RAPID-ML Model* from the context menu.\n\n. Choose the folder, filename and Base URI for the RAPID-ML model, and click\nbtn:[OK].  You should see a message confirming that your RAPID-ML model has\nbeen exported successfully.\n\n== Building the Plugin\n\nTo build the RAPID-ML Plugin for Ready! API, clone the Git repository, make sure you\nhave maven installed, and run\n\n mvn clean install assembly:single\n\nNOTE: Maven creates two jars.  We recommend using\n`/target/RapidML-ReadyAPI-Plugin-1.0-dist.jar` as it contains all of the\nrequired dependencies.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freprezen%2Frapidml-readyapi-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freprezen%2Frapidml-readyapi-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freprezen%2Frapidml-readyapi-plugin/lists"}