Similarity API is a RESTful API wrapper around software similarity services written in Scala. It is intended for use alongside a learning management system (LMS) as a microservice to detect software plagiarism in programming courses. The standalone version of JPlag is currently the only supported service, however the wrapper could be extended to support others in the future.
A MySQL database will need to be set up and configured in src/main/resources/application.conf. These values can also be set by setting the SIMILARITY_DB_URL, SIMILARITY_DB_USER, and SIMILARITY_DB_PASSWORD environment variables. Redis will also need to be installed and running on localhost port 6379.
In order to set up JPlag for use by the wrapper, download a .jar release and place it alongside the wrapper with the file name jplag.jar. Version v2.11.8-SNAPSHOT of JPlag is currently supported.
Using sbt:
sbt runto run the servicesbt ~re-start runto run the service with triggered restarts
The service will be available on http://localhost:4910/.
To create a .jar file with dependencies for distribution, run sbt assembly.