REST-API Quickstart

Owned by Yatharth Ranjan
Last updated: Mar 08, 2018
1 min read

Requirements -

To run the application do:

  • Edit the radar.yml config file and add the mongoDB configuration (Username and password)
  • Also add information about the Management Portal. More details on configuration at REST-API Configuration
  • Then copy the config folder under any of these paths.
    • /usr/share/conf/radar/rest-api
    • /usr/local/conf/radar/rest-api
  • run ./gradlew build
  • Run the radar-restapi-0.2.0.jar located at build/libs/
  • You can also run the app using the distribution files located at build/distributions/

By default, log messages are redirected to the STDOUT.

The api documentation is located at <your-server-address>:<port>/api/openapi.json

Click here to see documentation of dev deploy instance.