Date: | Author: | Version: | Changes: | Completed | Ext. | Int. | Is in Core | Jira Ref. |
|---|---|---|---|---|---|---|---|---|
0.1 | Doc. created | Yes/No | x |
| N/A |
| ||
| 14/04-2016 | Anders Granau Høfft | 0.2 | Sections expanded | No | x | N/A | CDRRM-733 | |
| 11 May 2016 | Emil Ifrim | 0.3 | Database configuration | No | x | N/A | ||
| 20 March 2017 | Emil Ifrim | 0.4 | Redesign Update | No | x | N/A | ||
| 01 April 2018 | Emil Ifrim | 0.5 | Redesign Update | No | x | N/A |
...
- Retrieve the
rator-rest-api.war file (either from Jenkins/Nexus, see Resources, or by building the .war yourself, see Build). - Retrieve the
rator-rest-api-auth.war file (either from Jenkins/Nexus, see Resources, or by building the .war yourself, see Build). - Copy the war files to the Tomcat webapps directory and (re-)start the Tomcat application.
- Retrieve the swagger-ui
distfolder (either from Github, or from our own repositories, see Resources. Or by building the project yourself, see Build). - Copy the dist folder to the Tomcat
webappsdirectory and (re-)start the Tomcat application. You probably want to rename thedistfolder toswagger-ui.- Nb This can be a different Tomcat installation than in step 2, or the same.
- In your browser, enter the URL "http://<Swagger server and port>/<base-path>/?url=http://<REST server and port>/<base-path>/api/swagger.json".
- You should now see a list of the resources available on the REST server.
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
...
- https://bitbucket.org/cdrator/rator-rest-api
- https://bitbucket.org/cdrator/rator-rest-api-auth
- https://bitbucket.org/cdrator/rator-core-api/
- https://svn.cdrator.com/svn/dev/thirdparty/swagger-ui-2.1.1
- https://svn.cdrator.com/svn/dev/thirdparty/swagger-ui-3.20.0-src / deploy/dist
Please notice that the Swagger UI web service is not a Java project, but a collection of HTML, Javascript and CSS.
...
Refer to http://swagger.io/swagger-ui/, or follow the steps below for building locally (in case the default build from github does not suit the needs).
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. Similiarly, Gulp should be installed. See online guides.
...