Change log:

...

Developers working with the dependent project rator-core-api, should likewise be aware that this is a Java 8 application.

Swagger UI

Prerequisites:

  • You have node.js installed, and thereby access to the tool npm (node package manager). If not, install node.js from https://nodejs.org/en/download/ (there is a .msi installer for windows). The installer will most likely automatically add the nodejs folder to the system environment so as to avoid needing to write the full path to the node.js executable.

In a command prompt assert a successfull install by writing "node -v" so as to output the version number.

TODO: Describe the npm and gulp command etc

Now, follow these steps to build the Swagger UI:

  1. Check out the source code (See the Resources paragraph above.)
  2. npm install
  3. gulp
  4. You should see the distribution under the dist folder. Open ./dist/index.html to launch Swagger UI in a browser

...

  1. Retrieve the rator-selfcare-rest-api .war file (either from Jenkins/Nexus, see Resources, or by building the .war yourself, see Build).
  2. Copy the war file to the Tomcat webapps directory and (re-)start the Tomcat application.
  3. Retrieve the swagger-ui dist folder (either from Github, or from our own repositories, see Resources. Or by building the project yourself, see Build).
  4. 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.
  5. In your browser, enter the URL "http://<Swagger server and port>/<base-path>/?url=http://<REST server and port>/<base-path>/api/swagger.json". 
  6. You should now see a list of the resources available on the REST server.

...