-
Notifications
You must be signed in to change notification settings - Fork 4
Overview
TBA-API-V3 is a Java implementation for the API found at https://www.thebluealliance.com/apidocs/v3. There doesn't appear to be any other APIs up yet, so here's the TBA-API-V3.
Project Structure
The API is organized to help you keep track of the plethora of API calls. If you look on the https://www.thebluealliance.com/apidocs/v3, you'll notice that all the API calls begin with /event(s)
, /team(s)
, /district(s)
, /match(s)
, or /status
. Each of these groups of API calls corresponds to a class in the requests
package such as EventRequest
or ```TeamRequest``. These are the fundamental classes that are used to interact with the API.
All of the models in Java form can be found in the package /models
, you'll find three more packages -- /other
, /simple
, and /standard
. ``/standardstores the full models,
/simple``` stores simplified models (according to the new V3 specifications``` and ```/other``` stores various other models that are less frequently used, such as the ```Robot``` model. Most of the packages within ```/other``` should be self explanatory.
Within Utils
you'll find the IO``,
Parser, and
Utilsclass,
IOmanages the
HTTPConnectionwith thebluealliance,
Parserconverts
JSONstrings into the Java models, and
Utilshas various helper methods. If the API contains a bug (which of course it doesn't :)), this will most likely be in
Parser. If you do find a bug, let me know right away at
[email protected]``` and I'll have a fix up for you lickidy split.
Alright, now to the good stuff. The classes in /main
are the most useful