OOAPI Demodata server - just add water to get an working OOAPI endpoint with realistically looking data. This is useful for applications that have to work with an OOAPI endpoint but that do not yet have access to a real endpoint implemented by an educational institution.
When started, OOAPI Demodata server generates random, but realistically looking data. All entities described in the OOAPI specification 4.0 or OOAPI specification 5.0 get generated, including links between entities.
OOAPI Demodata server is implemented in Clojure. There are two ways of building and running it:
Make sure you have Clojure installed and a recent version of Java. You can then run the following command:
clojure -T:build uberjar
This will generate a jar you can run using the following command:
java -jar target/ooapi-demo-data-server.jar
The server is now available on http://localhost:8080.
Alternatively you can use Docker. Build a Docker image by running the following command:
docker build . -t ooapi-demo-data-server:latest
Then run using:
docker run -p 8080:8080 ooapi-demo-data-server:latest
Use the environment variable OOAPI_VERSION to choose which OOAPI version to support. Allowed values are v4 and v5.
Each time the server runs, new random data is generated. To make runs reproducible you can set the seed user for random generation. Use the environment variable SEED to an integer. Reusing the same integer across runs should result in the same data being generated each time.
Chaos mode was added to how well applications can handle malfunctioning OOAPI endpoints. You can set chaos mode as active by setting the environment variable CHAOS to true. When chaos mode is active, requests will be handled using a randomly picked mode. The following modes are available:
normal: The request is handled as it normally would.empty: Returns an empty response.slow: Requests are handled normally, but with a randomly chosen delay between 3 and 63 seconds.
Which modes are active can be chosen by setting the environment variable CHAOS_MODES to a comma-delimited string of modes. This defaults to normal,empty,slow.
If you have found a vulnerability in the code, we would like to hear about it so that we can take appropriate measures as quickly as possible. We are keen to cooperate with you to protect users and systems better. See https://www.surf.nl/.well-known/security.txt for information on how to report vulnerabilities responsibly.