Common Request Settings
In this area, choose the request method and specify the data to compose the request URI from.
|HTTP method||In this drop-down list, specify the request method. The available options are:|
|Host/port||In this text box, type the URL address of the host where the target Web service is deployed and the port it listens to. By default, the port number is 80. If another port is used, specify it explicitly in the format <host URL>:<port number>.|
|Path||In this drop-down list, specify the relative path to the target method.|
|Item||Tooltip and shortcut||Description|
|Submit request||Click this button to submit the generated test request to the server.|
|Update resource paths from code||Click this button to synchronize the contents of the Path drop-down list with the @Path annotations.|
|Close||Close the REST Client tool window.|
|Help||Show this page.|
The server response code and the content length are shown in the upper-right corner of the REST Client tool window.
Request Parameters Tab
Use this tab to specify the parameters to be passed to the service in the generated test request either through the query string for GET requests or through the request body for other request types. Also configure interaction between the client side and the Web service by specifying the format of data that the service and the client accept.
In this pane, specify the technical data included in the request header.
These data are passed through header fields and define the format of the input parameters (accept field),
the response format (content-type field),
the caching mechanism (cache-control field), etc.
The set of fields and their values should comply with the Web service API. In other words, the specified input format should be exactly the one expected by the Web service as well as the expected response format should be exactly the one that the service returns.
For accept, content-type, and some other fields IntelliJ IDEA provides a list of suggested values. Choose the relevant format type from the Value drop-down list.
|Query string parameters||
In this pane, specify the parameters to be passed to the target method through a query string inside the URL. This approach is used for requests of the type GET.
By default, the pane shows an empty list with one line. To add a parameter, type its name and value in the corresponding fields.
As soon as you complete one parameter definition, a new empty line is added automatically.
The set of parameters and their types should comply with the Web service API, in particular, they should be exactly the same as the input parameters of the target method.
The pane is disabled when the GET request method is selected.
In this pane, specify the input parameters to be passed to the target method inside a request message body.
|Configure HTTP Proxy||Click this link to specify proxy server settings in the dialog box that opens.|
Use this tab to view responses from the Web service. By default, responses are shown in the plain text form. Use the icons of the tab to have them displayed in the editor in the HTML, XML, and JSON formats.
|View as HTML||Click this button to open a new tab in the main editor window and display there the response as HTML.|
|View as XML||Click this button to open a new tab in the main editor window and display there the server response as XML.|
|View as JSON||Click this button to open a new tab in the main editor window and display there the server response as JSON.|
|Open in browser||Click this button to view the response in your default Web browser.|
Response Headers Tab
The tab shows the technical data provided in the headers of Web service responses.