API Server Installation

Overview

API Server provides read-only REST APIs to search and access PDS data. The APIs are standardized between different PDS nodes. API Server is a Java application based on SpringBoot and Swagger frameworks. IMPORTANT NOTE: The registry API is in alpha version, not ready for production level deployment.

Installation

Step 1: Install Java 11

Only Java 11 is supported. We recommend OpenJDK 11. See this section for installation instructions.

Step 2: Download and extract API Server

Download 0.3.0 release from GitHub. There are ZIP files for Windows and TAR.GZ files for Linux and MacOS.

Extract the archive to any directory, for example, /opt/registry-api-service. Check that registry-api-service-x.y.z.jar and application.properties were extracted.

Step 3: Adjust configuration parameters

Adjust some configuration parameters in application.properties file. For example, API server port and Elasticsearch configuration.

server.port=8080
elasticSearch.host=localhost:9200

Step 4: Start API Server

Open Command Prompt / Terminal / PowerShell.

Go to the folder where you extracted the ZIP or TAR.GZ archive (Step 2). Make sure that correct version of application.properties is in that folder.

Run the following command to start API Server. (NOTE: x.y.z is the release version.)

java -jar registry-api-service-x.y.z.jar

You should see some log messages followed by "Started SpringBootMain in X seconds".

Step 5: Check that API Server has started

Open http://localhost:8080 URL in a web browser. NOTE: If you changed API server port in application.properties, replace 8080 with your value. You should see a page similar to this.

Next steps

You might now want to quickly test your set up or directly operate it with your own data.