-
-
Notifications
You must be signed in to change notification settings - Fork 1
Configuration
Most of the work is done by you!
The configuration is mostly broken down fairly well in the config.yml file itself.
Value: Integer between 1024-65535
Default: 6548
This part was briefly mentioned in the setup guide. This value can usually be left alone and only needs to be changed when there's an issue.
Value: Any string (no spaces, please)
Default: CHANGE_ME_PLEASE
The auth-key used for private requests. See Making Requests for when to use it.
Value: boolean (true/false)
Default: false
This simply enables some debug logging output. More useful for development than route making.
Sample debug messages:
[01:50:21 INFO]: [JSONRestAPI] Received request: POST /?request=%server_tps_10%&username=ChewLeKitten HTTP/1.1
[01:50:21 INFO]: [JSONRestAPI] Added parameter request with value %server_tps_10%
[01:50:21 INFO]: [JSONRestAPI] Added parameter username with value ChewLeKitten
[01:50:21 INFO]: [JSONRestAPI] Route:
[01:50:24 INFO]: [JSONRestAPI] Received request: POST /?request=%server_tps_10%&username=ChewLeKitten HTTP/1.1
[01:50:24 INFO]: [JSONRestAPI] Added parameter request with value %server_tps_10%
[01:50:24 INFO]: [JSONRestAPI] Added parameter username with value ChewLeKitten
[01:50:24 INFO]: [JSONRestAPI] Route:
[01:50:25 INFO]: [JSONRestAPI] Received request: POST /?request=%server_tps_10%&username=ChewLeKitten HTTP/1.1
[01:50:25 INFO]: [JSONRestAPI] Added parameter request with value %server_tps_10%
[01:50:25 INFO]: [JSONRestAPI] Added parameter username with value ChewLeKitten
[01:50:25 INFO]: [JSONRestAPI] Route:
The main part of the plugin, route setup.
By default, the root route accepts a raw POST value for any info not provided here.
A GET request must not be player-specific, and can for example be to query the players online.
A POST request must have a "username" or "uuid" parameter specified. Auth key is enabled by default for these.