09 July 2009 - 3.0 user guide eclipse intellij netbeans maven download nightly forum bugs blog sf.net eviware


Eviware Logo

REST Resources

As described in the REST Services Overview, Resources are available as child items to a REST Service and contain either child resources or methods. Resources are created either when initially creating the REST Service or by selecting the "New Resource" option from the Service/Resource popup. Either way, the following dialog will be displayed:

The dialog has the following options:

  • Resource Name : the name of the resource
  • Resource Path/Endpoint : a path or complete endpoint for the resource
  • Extract Params : select this option to extract parameters/path information from the specified endpoint/path.
  • Parameters : a table containing extracted or manually added parameters.
  • Create Request : option to create a default request for the resource. This also creates a Method in-between the Resource and Request.

The Extract Params button will parse the specified endpoint and try to extract query, matrix and template parameters from it. Also a hostname will be removed and a path components corresponding to the REST Services Base Path and containing Resources' path will be removed. For example specifying

http://search.yahooapis.com/ImageSearchService/V1/imageSearch?appid=YahooDemo&query=Madonna&output=xml

and pressing the Extract button will result in

As you can see, the host has been removed and query parameters have been extracted.

Properties and Actions

The following properties are available at the bottom left for a REST Resource:

  • Name : the name of the resource
  • Description : a short description
  • Path : the path of the resource relative to parent resource/service

Right-clicking a resource shows a popup with the following actions:

  • Show Resource Viewer - opens the Resource Viewer (see below)
  • New Request - prompts to create a new Request for this Resource
  • New Child Resource - prompts to create a new child Resource to this Resource using the above described dialog
  • Clone Resource - prompts to clone this Resource including all Requests and children
  • Rename - prompts to rename the Resource
  • Delete - prompts to delete the Resource
  • Online Help - shows this page in a browser

REST Resource Viewer

The REST Resource View is as follows:

The toolbar at the top contains an action to create a new request for this Resource together with a text field to edit the path of the Resource. The "Resource Parameters" tab contains all parameters for this resource as described in Parameters and Representations


Next: REST Methods