SDN Controller Programming Guide

16
JAX-RS annotations and Javadoc are already written when implementing RESTful Web Services,
and they are re-used to to generate an interactive API documentation.
Rsdoc Extension
The HP VAN SDN Controller SDK offers a method to extend the Rsdoc to include applications
specific RESTful Web Services (As the example illustrated in Figure 11). Since JAX-RS annotations
and Javadoc are already written when implementing RESTful Web Services, in order to enable an
application to extend the RSdoc is relatively easy and automatic: a few configuration files need to
be updated. See Creating RSdoc on page 160 for an example.
Rsdoc Live Reference
To access the HP VAN SDN Controller’s Rsdoc (including extensions by applications):
1. Open a browser at https://[SDN_CONTROLLER_ADDRESS]:8443/api (As illustrated in Figure 10).
2. Get an authentication token by entering the following authentication JSON document:
{"login":{"user":"sdn","password":"skyline","domain":"sdn"}} (as illustrated in Figure 12).
NOTE
Use the correct password if it was changed following instructions from Authentication Configuration on
page 7.