SDN Controller Programming Guide

163

<goals>

</goals>

</execution>

</executions>

</plugin>

...

</plugins>

</build>

</project>

Build and install the application as described Building Application on page 115 and Installing

Application on page 116. RSdoc is now accessible as illustrated in Figure 54.

Figure 54 Sample Application RSdoc

If for some reason you don’t want a RESTful web service (method annotated with a REST verb:

@GET, @POST, @PUT, @DELETE) to appear in the RSdoc - maybe because it is not ready for

consumption or because it is meant to be used internally by a sideway API (see Controller-

Controller Communication via REST (Sideways APIs) on page 157) 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)