Running the Taxonomy

After having cloned the repository and installed the [required software] there are several ways to start the Taxonomy API. From the command line, from an IDE or from a REPL. Starting from the command line uses one of several deps.edn aliases that modifies how the taxonomy starts.

The path to the configuration file can be set using either the environment variable TAXONOMY_CONFIG_PATH or the CLI flag --config <path> or -c <path>.

Starting the Taxonomy

The quickest way to get an interactive server is to just run:

clj -M:dev -m dev

This will start the API using the default configuration in config.edn.

The path to the configuration file can be set using either the environment variable TAXONOMY_CONFIG_PATH or the CLI flag --config <path> or -c <path>. Similarly the port numbers for the REPL and the server can be set. For the repl using TAXONOMY_REPL and -r NNNN or --repl NNNN and for the server using TAXONOMY_PORT and -p NNNN or --port NNNN.

Next step

Then open the following URL in a web browser:

http://localhost:3000/v1/taxonomy/swagger-ui/index.html

Authorize

Authorization is only needed to read unpublished taxonomy versions and for DB write access. To get write access, click the Authorize button, and enter your account code, defined in env/dev/resources/config.edn.

Running a query

curl -X GET --header 'Accept: application/json' 'http://localhost:3000/v1/taxonomy/main/concepts?preferred-label=Danska'