This is a java library that accesses the University of Waterloo Open Data API. The official documentation can be found here.
This library was created to remove the overhead of accessing the API and remove the worry about parsing the information.
To get started quickly, include the following to your maven pom to add UWaterlooAPI to your project, which is downloaded through Maven Central.
<dependency>
<groupId>com.endercrest.uwaterlooapi</groupId>
<artifactId>UWaterlooAPI</artifactId>
<version>1.0.1</version>
</dependency>To get started with this library begin by initializing UWaterlooAPI class which contains all API classes. Alternatively, you can initialize individual API's classes as needed.
Here is an example.
public class Start {
public static void main(String[] args){
UWaterlooAPI uWaterlooAPI = new UWaterlooAPI("My-API-Here");
//Get my total api calls with this api key.
int totalCalls = uWaterlooAPI.getApiAPI().getUsage().getData().getTotalCalls();
System.out.println("My Total Calls:" + totalCalls);
//Do Something with the totalCalls
}
}GSON, by Google must be included in the final project as it is required to parse the information.
This library also requires an API key which is distributed by the University of Waterloo (available at https://api.uwaterloo.ca).
Requirements for downloading and compiling: Maven 3 & Git
Start by cloning the repository, and navigating to the working directory.
To compile the project run the command mvn install. This will package
the library and install it into your local maven repository which will make
that specific version available locally.
Any and all contributions are welcome, at this time testing and full documentation is lacking.
If any bugs are found, open a new issue in the bug tracker, and it should be resolved as soon as possible.
- University of Waterloo