Page Comparison

...

The reason behind this structure is to allow versioning of the projects. 

The document also describes how to deploy the third-party documentation service called Swagger UI. This is not required for the REST service to work, but provides useful documentation.

...

1. Retrieve the rator-rest-api .war file (either from Jenkins/Nexus, see Resources, or by building the .war yourself, see Build).
2. Retrieve the rator-rest-api-auth.war file (either from Jenkins/Nexus, see Resources, or by building the .war yourself, see Build).
3. Copy the war files to the Tomcat webapps directory and (re-)start the Tomcat application.
4. Retrieve the swagger-ui dist folder (either from Github, or from our own repositories, see Resources. Or by building the project yourself, see Build).
5. Copy the dist folder to the Tomcat webapps directory and (re-)start the Tomcat application. You probably want to rename the dist folder to swagger-ui. 
   1. Nb This can be a different Tomcat installation than in step 2, or the same.
6. In your browser, enter the URL "http://<Swagger server and port>/<base-path>/?url=http://<REST server and port>/<base-path>/api/swagger.json". 
7. You should now see a list of the resources available on the REST server.

8. In order to access secure resources through swagger-ui, one additional parameter must be configured in the Properties.txt file:
    

   Code Block
   language sql title oauth2 selfcare client
   rest.api.accessTokenUri=http://<host>:<port/<auth-app-context>/oauth/token #example: http://10.45.1.81:8081/rator-rest-api-auth/oauth/token

   
   

...