Versions Compared

Old Version 67

changes.mady.by.user Søren Duusgaard (Deactivated)

Saved on

compared with

New Version 68

changes.mady.by.user Emil Ifrim

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Date:

Author:

Version:

Changes:

Completed

Ext.

Int.

Is in Core

Jira Ref.

05 April 2016

tpl

0.1

Doc. created

No

x

 

N/A

 

14 April 2016Anders GranauHøfft0.2Sections expandedNox N/ACDRRM-733
11 May 2016Emil Ifrim0.3Database configurationNox N/A 
20 March 2017Emil Ifrim0.4Redesign UpdateNox N/A 
01 April 2018Emil Ifrim0.5Redesign UpdateNox N/A 
15 January 2019SD0.6Download pdf-file     

...

  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
    languagesql
    titleoauth2 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


...

Database Setup

  1. Run table_changes.sql that can be found in the project (rator-rest-api)

  2. Configure REST api clients - who is allowed to get security tokens in order to access resources that require authentication/authorization. Here are some examples:

    Code Block
    languagesql
    titleoauth2 selfcare client
    Insert into OAUTH_CLIENT_DETAILS
   (CLIENT_ID, CLIENT_SECRET, SCOPE, AUTHORIZED_GRANT_TYPES, ACCESS_TOKEN_VALIDITY, REFRESH_TOKEN_VALIDITY, AUTHORITIES)
 Values
   ('rator-selfcare-web-app', 'ratorselfcare', 'read,write', 'password', 600, 0, 'ACCESS_BRAND_brandKey'); --replace brandKey with a valid brand in the setup

    Note: Swagger-ui client should only be used in development environments!

    Code Block
    titleoauth2 swagger-ui client
    Insert into OAUTH_CLIENT_DETAILS
   (CLIENT_ID, CLIENT_SECRET, SCOPE, AUTHORIZED_GRANT_TYPES, ACCESS_TOKEN_VALIDITY, AUTOAPPROVE, AUTHORITIES)
 Values
   ('your-client-id', 'your-client-secret', 'read-write:api-doc', 'password,operator_password,client_credentials', 
    600, 'true', 'ACCESS_BRAND_brandKey'); --replace brandKey with a valid brand in the setup

...