Reference Guide

consumption or because it is meant to be used internally by a sideway API (see Controller-
Controller Communication via REST (Sideways APIs) on page 190) it may be annotated with
@RsDocIgnore as illustrated in the following listing.
RsDocIgnore Annotation:
package com.hp.hm.rs;
import com.hp.api.rsdoc.RsDocIgnore;
...
@Path("mypath")
public class MyResource extends ControllerResource {
@GET
@Path("internal")
@Produces(MediaType.APPLICATION_JSON)
@RsDocIgnore
public Response internalMethod() {
...
}
}
Trying the REST API with RSdoc
At this point try the REST API using the RSdoc, which is the preferred method. Follow the steps from
Rsdoc Live Reference on page 17 to open Rsdoc and authenticate, and then try the sample
application’s REST API as illustrated in Figure 57. Modify SwitchManager to return some fake data
in the getAll method and try GET switches from the RSdoc.
196