Intel Mashery I/O Docs Plugin for Ready! API

IOdocs-readyapi-plugin

A plugin for Ready! API that allows you to import I/O Docs definitions into Ready! API and generate test suites and virtual APIs.

Installation

Install the plugin via the integrated Plugin Repository available via the Plugin Manager in Ready! API 1.X

Usage

There are two parts to this plugin – one designed to help people consume APIs that have an existing I/O Docs definition and one designed for API providers who want to generate I/O Docs for an existing API.
 


To import I/O Docs into Ready! API:

Use one of these options to import I/O Docs:

  1. Select “New” on the Projects tab and choose "Create empty project”

  2. Right-click on a project name and choose “Import from IO Docs”

  3. In either case, you will be prompted for the location of the I/O Docs definition.



 

  1. Browse to the definition and click OK. Ready! API automatically generates a test suite based on the contents of the I/O Docs definition. Now you can easily:

  • create a virtualized version of the API for sandboxing/simulation purposes
  • send ad-hoc requests to the API to explore its functionality
  • create functional tests of the API which you can further use to create Load Tests, Security Tests and API Monitors
  1. You can also use the plugin to get any necessary access tokens via the Authentication window. (this example shows a Swagger API that has been converted to I/O Docs by reading the Swagger into Ready! API and choosing to export as I/O Docs.)







To export I/O Docs using an API from inside Ready! API:

  1. After you have finished testing and are ready to make your API available on the Intel Mashery API Management portal, you can use the Intel Mashery I/O Docs plugin to easily generate your I/O Docs definition. Just right-click on the existing project inside Ready! API and choose “Export to I/O Docs”.

  2. A dialog box displays asking for basic information about your I/O Docs definition. Select the API you want to use for the I/O Docs definition (there could be multiple APIs in a Ready! API project). You will then have to specify a target folder and a filename.

  3. When you build an I/O Docs definition, you not only define the resources used by the API but you also have the ability to group them. After you specify a folder and filename, you’ll be prompted to create your resource groups and choose the resources to include in each group.


  4. When you finish adding resources and click OK, Ready! API will generate the I/O Doc definition for you in the target folder.