README.md 1 KB
Newer Older
1 2
Nesstar REST API
================
3 4 5 6 7 8 9

This is a REST implementation of (most of) the Nesstar API using Dropwizard.

Getting Started
---------------

1. Run `mvn package` to build everything
10
1. Copy the `config.yaml.example` to `config.yaml` and edit it to add your own server URI, logon credentials and some configuration options like interval of clean cache.
11
1. Run `java -jar target/nesstar_rest_api-0.4.1.jar server config.yaml`
12 13 14

Note: The name of the JAR file may change. See the `target` folder.
If you want to require users of your API to log in, delete the username and password lines from the config file.
15

Kjetil Thuen's avatar
Kjetil Thuen committed
16
The server will start up on port 8080 by default.
17 18

The port can be changed by adding a paramater to the java command like
Kjetil Thuen's avatar
Kjetil Thuen committed
19 20
this:

21
    java -Ddw.http.port=3000 -jar target/nesstar_rest_api-0.4.1.jar server config.yaml
22 23 24 25

Alernatively. A port can be set in the config.yaml file by adding a section like
this:

Kjetil Thuen's avatar
Kjetil Thuen committed
26
    http:
27
       port: 3000
Kjetil Thuen's avatar
Kjetil Thuen committed
28 29


Kjetil Thuen's avatar
Kjetil Thuen committed
30
Documentation: https://gitlab.nsd.uib.no/nesstar/nesstar-rest-api/wikis/home