Versions Compared

Key

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

Date:

Author:

Version:

Changes:

Completed

Ext.

Int.

Is in Core

Jira Ref.

0.1

Doc. created

Yes/No

x

 

N/A

 

14/04-2016Anders Granau Høfft0.2Sections expandedNox N/ACDRRM-733
11 May 2016Emil Ifrim0.3Database configurationNox N/A 

...

  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.

...

  1. Run table_changes.sql
  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)
     Values
       ('rator-selfcare-web-app', 'ratorselfcare', 'read,write', 'password', 600, 0);

    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)
     Values
       ('your-client-id', 'your-client-secret', 'read-write:api-doc', 'implicit', 
        600, 'true');

 

Verify deployment

In your browser, enter the URL:

...